PageContext class
Objeto de contexto de página de SharePoint.
Comentarios
El contexto de la página proporciona definiciones estándar de objetos comunes de SharePoint que deben compartirse entre la aplicación del lado cliente, los elementos web y otros componentes. Normalmente los datos se obtienen mediante consultas de REST cuando se navega a una página nueva, pero también pueden precargarse mediante el servidor web o rellenarse desde la caché de una aplicación personalizada.
Constructores
| (constructor)(service |
Construye una nueva instancia de la |
Propiedades
| aad |
Información contextual para comunicarse con Azure Active Directory. Si la página actual no tiene un inquilino de Azure Active Directory asociado, esta propiedad no estará definida. |
| culture |
Proporciona información de referencia cultural del usuario actual de la aplicación. Esta clase se usa principalmente con la |
| is |
Devuelve si |
| legacy |
Objeto que proporciona propiedades clásicas de SharePoint que pueden ser necesarias para determinados scripts heredados. |
| list | Información contextual para la lista de SharePoint que hospeda la página. Si no hay ninguna lista asociada a la página actual, esta propiedad será indefinida. |
| list |
Información contextual para el elemento de lista de SharePoint que hospeda la página. Si no hay ningún elemento de lista asociado a la página actual, esta propiedad será indefinida. |
| page | Expone información asociada a la página web de SharePoint que se está mostrando actualmente. |
| service |
Clave de servicio de PageContext. |
| site | Información contextual de la colección de sitios de SharePoint ("SPSite") que hospeda la página. |
| user | Proporciona información contextual para el usuario de SharePoint que obtiene acceso a la página. Esta clase se usa principalmente con la |
| web | Información contextual del sitio de SharePoint ("SPWeb") que hospeda la página. |
Detalles del constructor
(constructor)(serviceScope)
Construye una nueva instancia de la PageContext clase
constructor(serviceScope: ServiceScope);Parámetros
- serviceScope
- ServiceScope
Detalles de las propiedades
aadInfo
Información contextual para comunicarse con Azure Active Directory. Si la página actual no tiene un inquilino de Azure Active Directory asociado, esta propiedad no estará definida.
get aadInfo(): AzureActiveDirectoryInfo | undefined;Valor de propiedad
AzureActiveDirectoryInfo | undefined
cultureInfo
Proporciona información de referencia cultural del usuario actual de la aplicación. Esta clase se usa principalmente con la PageContext clase .
get cultureInfo(): CultureInfo;Valor de propiedad
isInitialized
Devuelve si PageContext se ha inicializado .
get isInitialized(): boolean;Valor de propiedad
boolean
legacyPageContext
Objeto que proporciona propiedades clásicas de SharePoint que pueden ser necesarias para determinados scripts heredados.
get legacyPageContext(): any;Valor de propiedad
any
Comentarios
Esta propiedad se proporciona para facilitar la migración de código heredado. Devuelve un objeto JavaScript cuyo contenido es similar a la _spPageContextInfo variable de ventana de las páginas clásicas. El contenido de esta variable puede cambiar en versiones futuras de SharePoint. Por este motivo, se recomienda que los nuevos proyectos usen las API de TypeScript SharePoint Framework en su lugar, ya que están totalmente documentadas y proporcionan garantías de compatibilidad confiables con versiones anteriores.
NOTA: Si cierta funcionalidad se expone en legacyPageContext pero no parece tener una API de TypeScript adecuada, presente un problema en GitHub. La intención es que ninguna aplicación moderna tenga que depender del legacyPageContext objeto .
list
Información contextual para la lista de SharePoint que hospeda la página. Si no hay ninguna lista asociada a la página actual, esta propiedad será indefinida.
get list(): SPList | undefined;Valor de propiedad
SPList | undefined
listItem
Información contextual para el elemento de lista de SharePoint que hospeda la página. Si no hay ningún elemento de lista asociado a la página actual, esta propiedad será indefinida.
get listItem(): SPListItem | undefined;Valor de propiedad
SPListItem | undefined
page
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Expone información asociada a la página web de SharePoint que se está mostrando actualmente.
get page(): Page;Valor de propiedad
serviceKey
Clave de servicio de PageContext.
static readonly serviceKey: ServiceKey<PageContext>;Valor de propiedad
site
Información contextual de la colección de sitios de SharePoint ("SPSite") que hospeda la página.
get site(): SPSite;Valor de propiedad
user
Proporciona información contextual para el usuario de SharePoint que obtiene acceso a la página. Esta clase se usa principalmente con la PageContext clase .
get user(): SPUser;Valor de propiedad
web
Información contextual del sitio de SharePoint ("SPWeb") que hospeda la página.
get web(): SPWeb;