SPWeb class

Paquet:

@microsoft/sp-page-context

Cette classe est principalement utilisée avec la PageContext classe . Il fournit des informations contextuelles pour le site SharePoint (« SPWeb ») qui héberge la page.

Remarques

Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la SPWeb classe.

Propriétés

absoluteUrl	Retourne l’URL absolue de ce SPWeb. Exemple : "https://example.com/sites/PubSite/SubWeb"
description	Retourne la description du SPWeb actuel.
firstDayOfWeek	Retourne le paramètre régional du premier jour de la semaine du web ou non défini s’il n’a pas été défini.
id	GUID qui identifie le SPWeb sur le serveur.
isAppWeb	Retourne true si ce SPWeb est le site web conteneur pour un SPApp.
language	Retourne l’identificateur de paramètres régionaux (LCID) pour la langue par défaut du site web.
languageName	Renvoie le nom de la langue par défaut du site web.
logoUrl	Renvoie l’URL absolue du logo du site web.
permissions	Retourne l’objet SPPermission qui représente le jeu d’autorisations dont dispose l’utilisateur actuel pour interagir avec le web.
serverRelativeUrl	Retourne l’URL relative du serveur pour ce SPWeb.
templateName	Retourne la chaîne représentant l’identificateur numérique de la définition de site ou du modèle de site utilisé pour créer le site.
timeZoneInfo	Retourne les paramètres de fuseau horaire régional du web ou non définis s’ils n’ont pas été définis.
title	Retourne le titre du SPWeb actuel.

Détails de la propriété

absoluteUrl

Retourne l’URL absolue de ce SPWeb. Exemple : "https://example.com/sites/PubSite/SubWeb"

readonly absoluteUrl: string;

Valeur de propriété

string

description

Retourne la description du SPWeb actuel.

readonly description: string;

Valeur de propriété

string

firstDayOfWeek

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne le paramètre régional du premier jour de la semaine du web ou non défini s’il n’a pas été défini.

readonly firstDayOfWeek: SPDayOfWeek | undefined;

Valeur de propriété

SPDayOfWeek | undefined

id

GUID qui identifie le SPWeb sur le serveur.

readonly id: Guid;

Valeur de propriété

Guid

isAppWeb

Retourne true si ce SPWeb est le site web conteneur pour un SPApp.

readonly isAppWeb: boolean;

Valeur de propriété

boolean

language

Retourne l’identificateur de paramètres régionaux (LCID) pour la langue par défaut du site web.

readonly language: number;

Valeur de propriété

number

Remarques

Exemple : 1033 représente l’identificateur de paramètres régionaux pour en-US.

languageName

Renvoie le nom de la langue par défaut du site web.

readonly languageName: string;

Valeur de propriété

string

Remarques

Exemple : en-US représente la langue anglaise dans les paramètres régionaux américains.

logoUrl

Renvoie l’URL absolue du logo du site web.

readonly logoUrl: string;

Valeur de propriété

string

Remarques

Exemple: https://example.com/sites/PubSite/SubWeb/logo.jpg

permissions

Retourne l’objet SPPermission qui représente le jeu d’autorisations dont dispose l’utilisateur actuel pour interagir avec le web.

readonly permissions: SPPermission;

Valeur de propriété

SPPermission

serverRelativeUrl

Retourne l’URL relative du serveur pour ce SPWeb.

readonly serverRelativeUrl: string;

Valeur de propriété

string

Remarques

Exemple : "/sites/PubSite/SubWeb"

templateName

Retourne la chaîne représentant l’identificateur numérique de la définition de site ou du modèle de site utilisé pour créer le site.

readonly templateName: string;

Valeur de propriété

string

Remarques

Exemple : "1" représente le modèle de site d’équipe lors de la création d’un site sur SharePoint.

timeZoneInfo

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Retourne les paramètres de fuseau horaire régional du web ou non définis s’ils n’ont pas été définis.

readonly timeZoneInfo: SPTimeZone | undefined;

Valeur de propriété

SPTimeZone | undefined

title

Retourne le titre du SPWeb actuel.

readonly title: string;

Valeur de propriété

string