PageContext class

Пакет:

@microsoft/sp-page-context

Объект контекста страницы SharePoint.

Комментарии

Контекст страницы предоставляет стандартные определения для общих объектов SharePoint, к которым нужно предоставить общий доступ для клиентского приложения, веб-частей и других компонентов. Обычно данные получают с помощью запросов REST при переходе к новой странице, но они могут быть также предварительно загружены веб-сервером или заполнены при помощи кэша пользовательского приложения.

Конструкторы

(constructor)(serviceScope)

Создает новый экземпляр PageContext класса

Свойства

aadInfo	Контекстные сведения для взаимодействия с Azure Active Directory. Если на текущей странице нет связанного клиента Azure Active Directory, это свойство будет не определено.
cultureInfo	Он предоставляет информацию о языке и региональных параметрах для текущего пользователя приложения. Этот класс в основном используется с классом PageContext .
isInitialized	Возвращает значение , указывающее, инициализировано PageContext ли объект .
legacyPageContext	Объект, предоставляющий классические свойства SharePoint, которые могут потребоваться определенным устаревшим скриптам.
list	Контекстная информация для списка SharePoint, в котором размещена страница. При отсутствии списка, связанного с текущей страницей, это свойство будет неопределенным.
listItem	Контекстная информация для элемента списка SharePoint, в котором размещена страница. При отсутствии элемента списка, связанного с текущей страницей, это свойство будет неопределенным.
page	Предоставляет сведения, связанные с отображаемой веб-страницей SharePoint.
serviceKey	Ключ службы для PageContext.
site	Контекстные сведения для семейства веб-сайтов SharePoint ("SPSite"), в котором размещается страница.
user	Предоставляет контекстную информацию для пользователя SharePoint, получающего доступ к странице. Этот класс в основном используется с классом PageContext .
web	Контекстные сведения для сайта SharePoint (SPWeb), на котором размещена страница.

Сведения о конструкторе

(constructor)(serviceScope)

Создает новый экземпляр PageContext класса

constructor(serviceScope: ServiceScope);

Параметры

serviceScope

ServiceScope

Сведения о свойстве

aadInfo

Контекстные сведения для взаимодействия с Azure Active Directory. Если на текущей странице нет связанного клиента Azure Active Directory, это свойство будет не определено.

get aadInfo(): AzureActiveDirectoryInfo | undefined;

Значение свойства

AzureActiveDirectoryInfo | undefined

cultureInfo

Он предоставляет информацию о языке и региональных параметрах для текущего пользователя приложения. Этот класс в основном используется с классом PageContext .

get cultureInfo(): CultureInfo;

Значение свойства

CultureInfo

isInitialized

Возвращает значение , указывающее, инициализировано PageContext ли объект .

get isInitialized(): boolean;

Значение свойства

boolean

legacyPageContext

Объект, предоставляющий классические свойства SharePoint, которые могут потребоваться определенным устаревшим скриптам.

get legacyPageContext(): any;

Значение свойства

any

Комментарии

Это свойство упрощает перенос устаревшего кода. Он возвращает объект JavaScript, содержимое которого похоже на _spPageContextInfo переменную окна из классических страниц. Содержимое этой переменной может быть изменено в будущих выпусках SharePoint. По этой причине новым проектам рекомендуется использовать API TypeScript SharePoint Framework, так как они полностью документированы и обеспечивают надежные гарантии обратной совместимости.

ПРИМЕЧАНИЕ. Если некоторые функции предоставляются в legacyPageContext , но, как представляется, не имеют правильного API TypeScript, отправьте сообщение о проблеме на GitHub. Цель заключается в том, что современному приложению не нужно полагаться на legacyPageContext объект .

list

Контекстная информация для списка SharePoint, в котором размещена страница. При отсутствии списка, связанного с текущей страницей, это свойство будет неопределенным.

get list(): SPList | undefined;

Значение свойства

SPList | undefined

listItem

Контекстная информация для элемента списка SharePoint, в котором размещена страница. При отсутствии элемента списка, связанного с текущей страницей, это свойство будет неопределенным.

get listItem(): SPListItem | undefined;

Значение свойства

SPListItem | undefined

page

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Предоставляет сведения, связанные с отображаемой веб-страницей SharePoint.

get page(): Page;

Значение свойства

Page

serviceKey

Ключ службы для PageContext.

static readonly serviceKey: ServiceKey<PageContext>;

Значение свойства

ServiceKey<PageContext>

site

Контекстные сведения для семейства веб-сайтов SharePoint ("SPSite"), в котором размещается страница.

get site(): SPSite;

Значение свойства

SPSite

user

Предоставляет контекстную информацию для пользователя SharePoint, получающего доступ к странице. Этот класс в основном используется с классом PageContext .

get user(): SPUser;

Значение свойства

SPUser

web

Контекстные сведения для сайта SharePoint (SPWeb), на котором размещена страница.

get web(): SPWeb;

Значение свойства

SPWeb