PageContext class
O objeto de contexto de página do SharePoint.
Comentários
O contexto da página fornece definições padrão para objetos comuns do SharePoint que precisam ser compartilhados entre o aplicativo cliente, Web Parts e outros componentes. Os dados geralmente são buscados via consultas REST quando você navega para uma nova página, mas eles também podem ser pré-carregados por servidor Web ou preenchidos de um cache de aplicativo personalizado.
Construtores
| (constructor)(service |
Constrói uma nova instância da |
Propriedades
| aad |
Informações contextuais para se comunicar com o Azure Active Directory. Se a página atual não tiver um locatário associado do Azure Active Directory, essa propriedade será indefinida. |
| culture |
Ela fornece informações de cultura para o usuário atual do aplicativo. Essa classe é usada principalmente com a |
| is |
Retorna se o |
| legacy |
Um objeto que fornece propriedades clássicas do SharePoint que podem ser exigidas por determinados scripts herdados. |
| list | Informações contextuais para lista do SharePoint que hospeda a página. Se não houver nenhuma lista associada à página atual, essa propriedade será indefinida. |
| list |
Informações contextuais do item de lista do SharePoint que hospeda a página. Se não houver nenhum item de lista associado à página atual, essa propriedade será indefinida. |
| service |
A chave de serviço de PageContext. |
| site | Informações contextuais para a coleção de sites do SharePoint ("SPSite") que está hospedando a página. |
| user | Ele fornece informações contextuais para o usuário do SharePoint que acessa a página. Essa classe é usada principalmente com a |
| web | Informações contextuais para o site do SharePoint ("SPWeb") que está hospedando a página. |
Detalhes do construtor
(constructor)(serviceScope)
Constrói uma nova instância da PageContext classe
constructor(serviceScope: ServiceScope);Parâmetros
- serviceScope
- ServiceScope
Detalhes da propriedade
aadInfo
Informações contextuais para se comunicar com o Azure Active Directory. Se a página atual não tiver um locatário associado do Azure Active Directory, essa propriedade será indefinida.
get aadInfo(): AzureActiveDirectoryInfo | undefined;Valor da propriedade
@microsoft/sp-page-context!AzureActiveDirectoryInfo:class | undefined
cultureInfo
Ela fornece informações de cultura para o usuário atual do aplicativo. Essa classe é usada principalmente com a PageContext classe.
get cultureInfo(): CultureInfo;Valor da propriedade
isInitialized
Retorna se o PageContext foi inicializado.
get isInitialized(): boolean;Valor da propriedade
boolean
legacyPageContext
Um objeto que fornece propriedades clássicas do SharePoint que podem ser exigidas por determinados scripts herdados.
get legacyPageContext(): any;Valor da propriedade
any
Comentários
Essa propriedade é fornecida para facilitar a migração de código herdado. Ele retorna um objeto JavaScript cujo conteúdo é semelhante à variável de janela de _spPageContextInfo páginas clássicas. O conteúdo dessa variável pode ser alterado nas futuras versões do SharePoint. Por esse motivo, novos projetos são incentivados a usar as APIs typeScript Estrutura do SharePoint, pois são totalmente documentados e fornecem garantias confiáveis de compatibilidade com versões anteriores.
OBSERVAÇÃO: se determinada funcionalidade for exposta no legacyPageContext mas não parecer ter uma API TypeScript adequada, registre um problema no GitHub. A intenção é que nenhum aplicativo moderno precise confiar no legacyPageContext objeto.
list
Informações contextuais para lista do SharePoint que hospeda a página. Se não houver nenhuma lista associada à página atual, essa propriedade será indefinida.
get list(): SPList | undefined;Valor da propriedade
SPList | undefined
listItem
Informações contextuais do item de lista do SharePoint que hospeda a página. Se não houver nenhum item de lista associado à página atual, essa propriedade será indefinida.
get listItem(): SPListItem | undefined;Valor da propriedade
SPListItem | undefined
serviceKey
A chave de serviço de PageContext.
static readonly serviceKey: ServiceKey<PageContext>;Valor da propriedade
site
Informações contextuais para a coleção de sites do SharePoint ("SPSite") que está hospedando a página.
get site(): SPSite;Valor da propriedade
user
Ele fornece informações contextuais para o usuário do SharePoint que acessa a página. Essa classe é usada principalmente com a PageContext classe.
get user(): SPUser;Valor da propriedade
web
Informações contextuais para o site do SharePoint ("SPWeb") que está hospedando a página.
get web(): SPWeb;