Web members

Represents a Microsoft SharePoint Foundation Web site.

The Web type exposes the following members.

Constructors

	Name	Description
	Web	Initializes a new instance of the Web object.

Top

Properties

	Name	Description
	Alerts
	AllowAutomaticASPXPageIndexing
	AllowCreateDeclarativeWorkflowForCurrentUser
	AllowDesignerForCurrentUser	Gets a value that specifies whether the current user is allowed to use a designer application to customize this site.
	AllowMasterPageEditingForCurrentUser	Gets a value that specifies whether the current user is allowed to edit the master page.
	AllowRevertFromTemplateForCurrentUser	Gets a value that specifies whether the current user is allowed to revert the site to a default site template.
	AllowRssFeeds	Gets a value that specifies whether the site allows RSS feeds.
	AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser
	AllowSavePublishDeclarativeWorkflowForCurrentUser
	AllProperties	Gets a collection of metadata for the Web site.
	AlternateCssUrl
	AppInstanceId	The instance Id of the App Instance that this website represents.
	AppTiles
	AssociatedMemberGroup	Gets the users who have been given contribute permissions to the website.
	AssociatedOwnerGroup	Gets or sets the associated owner groups of the website.
	AssociatedVisitorGroup	Gets or sets the associated visitor group of the website.
	Author
	AvailableContentTypes	Gets the collection of all content types that apply to the current scope, including those of the current Web site, as well as any parent Web sites.
	AvailableFields	Gets a value that specifies the collection of all fields available for the current scope, including those of the current site, as well as any parent sites.
	CommentsOnSitePagesDisabled
	Configuration	Gets either the identifier (ID) of the site definition configuration that was used to create the site, or the ID of the site definition configuration from which the site template used to create the site was derived.
	ContainsConfidentialInfo
	ContentTypes	Gets the collection of content types for the Web site.
	Context	Returns the context that is associated with the client object. (Inherited from ClientObject.)
	Created	Gets a value that specifies when the site was created.
	CurrentChangeToken
	CurrentUser	Gets the current user of the site.
	CustomMasterUrl	Gets or sets the URL for a custom master page file to apply to the website.
	DataLeakagePreventionStatusInfo
	Description	Gets or sets the description for the site.
	DescriptionResource
	DesignerDownloadUrlForCurrentUser
	DesignPackageId
	DisableAppViews
	DisableFlows
	DocumentLibraryCalloutOfficeWebAppPreviewersDisabled	Determines if the Document Library Callout's WAC previewers are enabled or not.
	EffectiveBasePermissions	Gets a value that specifies the effective permissions that are assigned to the current user.
	EnableMinimalDownload	Gets or sets a Boolean value that specifies whether the Web site should use Minimal Download Strategy.
	EventReceivers	Gets the collection of event receiver definitions that are currently available on the website.
	ExcludeFromOfflineClient
	Features	Gets a value that specifies the collection of features that are currently activated in the site.
	Fields	Gets the collection of field objects that represents all the fields in the Web site.
	FirstUniqueAncestorSecurableObject	Gets the object where role assignments for this object are defined. (Inherited from SecurableObject.)
	Folders	Gets the collection of all first-level folders in the website.
	HasUniqueRoleAssignments	Gets a value that specifies whether the role assignments are uniquely defined for this securable object or inherited from a parent securable object. (Inherited from SecurableObject.)
	HorizontalQuickLaunch
	Id	Gets a value that specifies the site identifier for the site.
	IsMultilingual
	Language	Gets a value that specifies the LCID for the language that is used on the site.
	LastItemModifiedDate	Gets a value that specifies when an item was last modified in the site.
	LastItemUserModifiedDate
	Lists	Gets the collection of all lists that are contained in the website available to the current user based on the current user’s permissions.
	ListTemplates	Gets a value that specifies the collection of list definitions and list templates available for creating lists on the site.
	MasterUrl	Gets or sets the URL of the master page that is used for the website.
	MembersCanShare
	Navigation	Gets a value that specifies the navigation structure on the site, including the Quick Launch area and the top navigation bar.
	NoCrawl
	NotificationsInOneDriveForBusinessEnabled
	NotificationsInSharePointEnabled
	ObjectData	Gets the object data for the current client object. (Inherited from ClientObject.)
	ObjectVersion	Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	OverwriteTranslationsOnChange
	ParentWeb	Gets the parent website of the specified website.
	Path	Tracks how a client object is created in the ClientRuntimeContext class so that the object can be recreated on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	PreviewFeaturesEnabled
	PushNotificationSubscribers	Specifies the collection of push notification subscribers for the site, and cannot be NULL.
	QuickLaunchEnabled	Gets or sets a value that specifies whether the Quick Launch area is enabled on the site.
	RecycleBin	Gets the recycle bin of the website.
	RecycleBinEnabled	Gets or sets a value that specifies whether the Recycle Bin is enabled.
	RegionalSettings	Gets the regional settings that are currently implemented on the website.
	RequestAccessEmail
	ResourcePath
	RoleAssignments	Gets the role assignments for the securable object. (Inherited from SecurableObject.)
	RoleDefinitions	Gets the collection of role definitions for the website.
	RootFolder	Gets the root folder for the website.
	SaveSiteAsTemplateEnabled	Gets or sets a Boolean value that specifies whether the Web site can be saved as a site template.
	ServerObjectIsNull	Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
	ServerRelativePath
	ServerRelativeUrl	Gets or sets the server-relative URL for the Web site.
	ShowUrlStructureForCurrentUser	Gets a value that specifies whether the current user is able to view the file system structure of this site.
	SiteCollectionAppCatalog
	SiteGroups	Gets the collection of groups for the site collection.
	SiteLogoDescription
	SiteLogoUrl
	SiteUserInfoList	Gets the UserInfo list of the site collection that contains the website.
	SiteUsers	Gets the collection of all users that belong to the site collection.
	SupportedUILanguageIds	Specifies the language code identifiers (LCIDs) of the languages that are enabled for the site.
	SyndicationEnabled	Gets or sets a value that specifies whether the RSS feeds are enabled on the site.
	Tag	Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
	TenantAppCatalog
	TenantTagPolicyEnabled
	ThemedCssFolderUrl
	ThemeInfo	The theming information for this website. This includes information like colors, fonts, border radii sizes, and so on.
	ThirdPartyMdmEnabled
	Title	Gets or sets the title for the website.
	TitleResource
	TreeViewEnabled	Gets or sets value that specifies whether the tree view is enabled on the site.
	TypedObject	Gets the object with the correct type information returned from the server. (Inherited from ClientObject.)
	UIVersion	Gets or sets the user interface (UI) version of the Web site.
	UIVersionConfigurationEnabled	Gets or sets a value that specifies whether the settings UI for visual upgrade is shown or hidden.
	Url	Gets the absolute URL for the website.
	UserCustomActions	Gets a value that specifies the collection of user custom actions for the site.
	Webs	Gets a Web site collection object that represents all Web sites immediately beneath the Web site, excluding children of those Web sites.
	WebTemplate	Gets the name of the site definition or site template that was used to create the site.
	WorkflowAssociations	Gets a value that specifies the collection of all workflow associations for the site.
	WorkflowTemplates	Gets a value that specifies the collection of workflow templates associated with the site.

Top

Methods

	Name	Description
	AddSupportedUILanguage
	ApplyTheme	Applies a theme with the specified components to this site.
	ApplyWebTemplate	Applies the specified site definition or site template to the website that has no template applied to it.
	BreakRoleInheritance	Creates unique role assignments for the securable object. (Inherited from SecurableObject.)
	CheckUninitializedProperty	Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
	CreateAnonymousLink	Create an anonymous link which can be used to access a document without needing to authenticate.
	CreateAnonymousLinkWithExpiration	Create an anonymous link which can be used to access a document without needing to authenticate.
	CreateDefaultAssociatedGroups
	CreateOrganizationSharingLink
	CustomFromJson	Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	DefaultDocumentLibrary
	DefaultDocumentLibraryUrl
	DeleteAllAnonymousLinksForObject	Removes all existing anonymous links for an object.
	DeleteAnonymousLinkForObject
	DeleteObject	Deletes the website.
	DestroyOrganizationSharingLink
	DoesPushNotificationSubscriberExist	Returns a Boolean value that indicates whether the push notification subscriber exists for the current user with the given device app instance identifier.
	DoesUserHavePermissions	Returns whether the current user has the given set of permissions.
	EnsureUser	Checks whether the specified logon name belongs to a valid user of the website, and if the logon name does not already exist, adds it to the website.
	ForwardObjectLink	Share an object in SharePoint such as a list item, or site with no Acl changes, even when you do not have permission to share and can't send an access request. Use this method to send the link of the object to site members who already has permission to view the object.
	FromJson	Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	GetAppBdcCatalog	Returns the Business Data Connectivity (BDC) MetadataCatalog for an application that gives access to the external content types defined in the BDC metadata model packaged by the application.
	GetAppBdcCatalogForAppInstance	Returns the Business Data Connectivity (BDC) MetadataCatalog for an application that gives access to the external content types defined in the BDC metadata model packaged by the application. This method should be called on the Web object where the application is installed.
	GetAppInstanceById	Retrieves an AppInstance installed on this site.
	GetAppInstancesByProductId	Retrieves all AppInstance objects installed on this site that are instances of the specified App.
	GetAvailableWebTemplates	Returns a collection of site templates available for the site.
	GetCatalog	Returns the list template gallery, site template gallery, or Web Part gallery for the site.
	GetChanges	Returns the collection of all changes from the change log that have occurred within the scope of the site, based on the specified query.
	GetDocumentAndMediaLibraries
	GetDocumentLibraries
	GetEntity	Specifies the external content type with the specified namespace and name in the context of the current site. This method is used as the entry point to create, read, update, and delete (CRUD) operations against an Entity.
	GetFileByGuestUrl
	GetFileByGuestUrlEnsureAccess
	GetFileById	This API element is only supported by SharePoint Online.
	GetFileByLinkingUrl
	GetFileByServerRelativePath
	GetFileByServerRelativeUrl	Returns the file object located at the specified server-relative URL.
	GetFileByUrl
	GetFileByWOPIFrameUrl
	GetFolderById
	GetFolderByServerRelativePath
	GetFolderByServerRelativeUrl	Returns the folder object located at the specified server-relative URL.
	GetList
	GetListItem
	GetListItemByResourceId
	GetListItemUsingPath
	GetListUsingPath
	GetObjectSharingSettings	Given a path to an object in SharePoint, this will generate a sharing settings object which contains necessary information for rendering sharing information.
	GetOnePageContextAsStream
	GetPushNotificationSubscriber	Specifies the push notification subscriber over the site for the specified device app instance identifier.
	GetPushNotificationSubscribersByArgs	Queries for the push notification subscribers for the site with the specified set of custom arguments.The passed value is compared against the subscribers’ custom arguments in the store and exact matches are returned as a collection. Null or empty custom arguments return subscribers without any filtering. If no match is found, an empty collection is returned.
	GetPushNotificationSubscribersByUser	Queries for the push notification subscribers for the site for the specified user.
	GetRecycleBinItems
	GetRecycleBinItemsByQueryInfo
	GetSharingLinkData
	GetSharingLinkKind
	GetStorageEntity
	GetSubwebsForCurrentUser	Returns the collection of child sites of the current site based on the specified query.
	GetUserById	Returns the user corresponding to the specified member identifier for the current site.
	GetUserEffectivePermissions	Gets the effective permissions that the specified user has within the current application scope.
	GetViewFromPath
	GetViewFromUrl
	GetWebUrlFromPageUrl
	IncrementSiteClientTag
	InitNonPropertyFieldFromJson	Initializes a non-property field of the client object based on JavaScript Object Notation (JSON) data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	InitOnePropertyFromJson	(Overrides SecurableObject.InitOnePropertyFromJson(String, JsonReader).)
	IsObjectPropertyInstantiated	Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
	IsPropertyAvailable	Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
	LoadAndInstallApp	Uploads and installs an app package to this site.
	LoadAndInstallAppInSpecifiedLocale	Uploads and installs an App package, in a specified locale.
	LoadApp	Uploads an App package and creates an instance from it.
	LoadExpandoFields	Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	MapToIcon	Returns the name of the image file for the icon that is used to represent the specified file.
	RefreshLoad	Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
	RegisterPushNotificationSubscriber	Return a GUID, and registers the push notification subscriber for the site. If the registration already exists, the service token is updated with the new value.
	RemoveFromParentCollection	Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
	RemoveStorageEntity
	RemoveSupportedUILanguage
	ResetRoleInheritance	When implemented in a derived class, removes local role assignments so that role assignments, for all descendant objects, are re-inherited from the parent object. (Inherited from SecurableObject.)
	Retrieve()	Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	Retrieve([])	Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
	SetStorageEntity
	ShareObject
	ToString	(Inherited from Object.)
	UnregisterPushNotificationSubscriber	Returns a GUID, and unregisters the push notification subscriber from the site.
	UnshareObject	Removes Sharing permissions on an object.
	Update	Updates the database with changes that are made to the Web site.
	UpdateClientObjectPropertyType	Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
	WebUrlFromFolderUrlDirect	Get web's full url from folder url.
	WebUrlFromPageUrlDirect

Top

See also

Reference

Web class

Microsoft.SharePoint.Client namespace