Web Element (DeploymentManifest)

Article
06/29/2022

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Represents an instance of a SharePoint Foundation website (SPWeb) object. A website is one of the top-level SharePoint Foundation objects.

Definition

DECLARATION
<xs:element name="Web" type="SPWeb" />

USAGE
<SPObject>
    <Web>
                <Properties />
                <EventReceivers />
        <xs:attribute name="Id" />
        <xs:attribute name="ParentId" />
        <xs:attribute name="Name" />
        <xs:attribute name="Title" />
        <xs:attribute name="Locale" />
        <xs:attribute name="Language" />
        <xs:attribute name="IsRootWeb" />
        <xs:attribute name="ServerRelativeUrl" />
        <xs:attribute name="CurrencyLocaleId" />
        <xs:attribute name="RegionalSettingsLocaleId" />
        <xs:attribute name="RequestAccessEmail" />
        <xs:attribute name="TimeZoneId" />
        <xs:attribute name="Time24" />
        <xs:attribute name="CalendarType" />
        <xs:attribute name="AdjustHijriDays" />
        <xs:attribute name="Collation" />
        <xs:attribute name="AlternateCalendarType" />
        <xs:attribute name="ShowWeeks" />
        <xs:attribute name="FirstWeekOfYear" />
        <xs:attribute name="WorkDays" />
        <xs:attribute name="WorkDayStartHour" />
        <xs:attribute name="WorkDayEndHour" />
        <xs:attribute name="FirstDayOfWeek" />
        <xs:attribute name="Description" />
        <xs:attribute name="AlternateHeader" />
        <xs:attribute name="Author" />
        <xs:attribute name="Configuration" />
        <xs:attribute name="HasUniqueRoleAssignments" />
        <xs:attribute name="HasUniqueRoleDefinitions" />
        <xs:attribute name="Created" />
        <xs:attribute name="ThemeComposite" />
        <xs:attribute name="WebTemplate" />
        <xs:attribute name="AnonymousState" />
        <xs:attribute name="RootFolderId" />
        <xs:attribute name="SystemCatalogsIncluded" />
        <xs:attribute name="WelcomePageUrl" />
        <xs:attribute name="AlternateCssUrl" />
        <xs:attribute name="CustomizedCssFiles" />
        <xs:attribute name="CustomJSUrl" />
        <xs:attribute name="IncludeSupportingFolders" />
        <xs:attribute name="SecurityProvider" />
        <xs:attribute name="MasterUrl" />
        <xs:attribute name="CustomMasterUrl" />
        <xs:attribute name="SiteLogoUrl" />
        <xs:attribute name="SiteLogoDescription" />
        <xs:attribute name="UseSharedNavigation" />
<!-- Flags -->
        <xs:attribute name="PresenceEnabled" />
        <xs:attribute name="SyndicationEnabled" />
        <xs:attribute name="QuickLaunchEnabled" />
        <xs:attribute name="TreeViewEnabled" />
        <xs:attribute name="ParserEnabled" />
        <xs:attribute name="Provisioned" />
    </Web>
</SPObject>

Type

SPWeb

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Type	Description
AdjustHijriDays	xs:int	Optional. Specifies the number of days to extend or reduce the current month in Hijri calendars.
AlternateCalendarType	xs:short	Optional. Specifies an integer representing an alternative calendar type. For a table of calendar type values, see CalendarType.
AlternateCssUrl	xs:string	Optional. Specifies the URL for an alternative cascading style sheet (CSS) to use for the website.
AlternateHeader	xs:string	Optional. Specifies the URL for an alternative .aspx page to use for rendering the top navigation area on SharePoint pages.
AnonymousState	AnonymousState Simple Type (DeploymentManifest)	Optional. Specifies the level of access available to anonymous users on the website.
Author	xs:string	Optional. Represents the user who created the website.
CalendarType	xs:int	Optional. Specifies an integer representing the default calendar type.
Collation	xs:int	Optional. Integer value specifying the collation used on the site. For more information, see Collation.
Configuration	xs:int	Optional. Specifies the ID of the configuration in the site definition that was used to create the site; or, specifies the ID of the configuration in the site definition from which the site template used to create the site was derived.
Created	xs:dateTime	Optional. Specifies the date and time that the site was created.
CurrencyLocaleId	xs:int	Optional. Specifies the locale ID (LCID) used to represent currency values in the website.
CustomizedCssFiles	xs:string	Optional.Specifies custom cascading style sheet (.css) files.
CustomJSUrl	xs:string	Optional. Specifies the URL to custom JScript files.
CustomMasterUrl	xs:string	Optional. Specifies the URL for the custom master page file to apply to the website.
Description	xs:string	Optional. Provides the description for the site.
FirstDayOfWeek	xs:long	Optional. Integer that specifies the first day of the week used in the calendars on the server.
FirstWeekOfYear	xs:short	Optional. Integer that specifies the first week of the year used in the calendars on the server.
HasUniqueRoleAssignments	xs:boolean	Optional. Specifies whether the role assignments are uniquely defined for the website, or inherited from a parent website. The value is true if the website has unique role assignments.
HasUniqueRoleDefinitions	xs:boolean	Optional. Specifies whether the role definitions are uniquely defined for this website, or inherited from a parent website. The value is true if the website has unique role definitions.
Id	Guid Simple Type (DeploymentManifest)	Required. Unique identifier for the site.
IncludeSupportingFolders	xs:boolean	Optional. Specifies whether supporting folders are included in enumerations of files or folders. The value is true if supporting files are included.
IsRootWeb	xs:boolean	Required. Specifies whether the site is the top-level website of the site collection. The value is true if the site is the top-level site.
Language	xs:long	Required. Specifies the LCID for the language used on the site. For a table of LCID values, see Language.
Locale	xs:string	Required. Specifies the locale for the website.
MasterUrl	xs:string	Optional. Specifies the URL of the master page used for the website.
Name	xs:string	Required. Specifies the name of the website.
ParentId	xs:string	Required. Specifies the ID of the parent website for the site.
ParserEnabled	xs:boolean	Optional. Flag specifying whether parsing is enabled for the website. The value is true if parsing is enabled.
PresenceEnabled	xs:boolean	Optional. Flag specifying whether inline presence information is enabled on the website. The value is true if inline presence is enabled.
Provisioned	xs:boolean	Optional. Flag specifying whether the website has been provisioned. The value is true if the website has been provisioned.
QuickLaunchEnabled	xs:boolean	Optional. Flag specifying whether the Quick Launch area is enabled on the website. The value is true if Quick Launch is enabled.
RegionalSettingsLocaleId	xs:long	Optional. Provides an integer value specifying regional locale.
RequestAccessEmail	xs:string	Optional. Specifies the email address to which requests for access to the website are sent.
RootFolderId	Guid Simple Type (DeploymentManifest)	Optional. Unique identifier of the root folder for the website.
SecurityProvider	Guid Simple Type (DeploymentManifest)	Optional.
ServerRelativeUrl	xs:string	Required. Specifies the server-relative URL for the website.
ShowWeeks	xs:boolean	Optional. Specifies whether to show weeks on the calendar on the website. The value is true if the weeks are shown.
SiteLogoDescription	xs:string	Optional. Provides a description of the website logo.
SiteLogoUrl	xs:string	Optional. Specifies the server-relative URL of the website logo.
SyndicationEnabled	xs:boolean	Optional. Flag specifying whether syndication is enabled in the website. The value is true if syndication is enabled.
SystemCatalogsIncluded	xs:boolean	Optional. Specifies whether system catalog files are included in the export package. The value is true if the system catalogs are included.
ThemeComposite	xs:string	Optional. Provides the name of the theme and the URL to the CSS that is applied to the website.
Time24	xs:boolean	Optional. Specifies whether to use a 24-hour time format to represent the hours of the day.
TimeZoneId	xs:int	Optional. Specifies the identifier of the time zone that is used on the server. For more information, see SPTimeZone.
Title	xs:string	Required. Specifies the title for the website.
TreeViewEnabled	xs:boolean	Optional. Flag specifying whether the SharePoint TreeView feature is enabled in the left navigational area of the website pages. The value is true if TreeView is enabled.
UseSharedNavigation	xs:boolean	Optional.
WebTemplate	xs:string	Optional. Specifies the name of the site definition that was used to create the site, or the name of the site definition from which the site template that was used to create the site was derived.
WelcomePageUrl	xs:string	Optional. URL of the website welcome page.
WorkDayEndHour	xs:short	Optional. Specifies the default hour at which the work day ends on the calendar in use on the server.
WorkDays	xs:short	Optional. Specifies the default work days on the calendar in use on the server.
WorkDayStartHour	xs:short	Optional. Specifies the default hour at which the work day starts on the calendar in use on the server.

Child elements

Parent elements

SPObject Element (DeploymentManifest)