Web members

Represents a Microsoft SharePoint Foundation Web site.

The Web type exposes the following members.

  Name Description
Public method Web Initializes a new instance of the Web object.
Top

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

  Name Description
Public method AddSupportedUILanguage
Public method ApplyTheme Applies a theme with the specified components to this site.
Public method ApplyWebTemplate Applies the specified site definition or site template to the website that has no template applied to it.
Public method BreakRoleInheritance Creates unique role assignments for the securable object. (Inherited from SecurableObject.)
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method Static member CreateAnonymousLink Create an anonymous link which can be used to access a document without needing to authenticate.
Public method Static member CreateAnonymousLinkWithExpiration Create an anonymous link which can be used to access a document without needing to authenticate.
Public method CreateDefaultAssociatedGroups
Public method Static member CreateOrganizationSharingLink
Public method 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.)
Public method DefaultDocumentLibrary
Public method Static member DeleteAllAnonymousLinksForObject Removes all existing anonymous links for an object.
Public method Static member DeleteAnonymousLinkForObject
Public method DeleteObject Deletes the website.
Public method Static member DestroyOrganizationSharingLink
Public method DoesPushNotificationSubscriberExist Returns a Boolean value that indicates whether the push notification subscriber exists for the current user with the given device app instance identifier.
Public method DoesUserHavePermissions Returns whether the current user has the given set of permissions.
Public method 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.
Public method Static member 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.
Public method 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.)
Public method 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.
Public method 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.
Public method GetAppInstanceById Retrieves an AppInstance installed on this site.
Public method GetAppInstancesByProductId Retrieves all AppInstance objects installed on this site that are instances of the specified App.
Public method GetAvailableWebTemplates Returns a collection of site templates available for the site.
Public method GetCatalog Returns the list template gallery, site template gallery, or Web Part gallery for the site.
Public method 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.
Public method Static member GetDocumentAndMediaLibraries
Public method Static member GetDocumentLibraries
Public method 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.
Public method GetFileByGuestUrl
Public method GetFileByGuestUrlEnsureAccess
Public method GetFileById This API element is only supported by SharePoint Online.
Public method GetFileByLinkingUrl
Public method GetFileByServerRelativePath
Public method GetFileByServerRelativeUrl Returns the file object located at the specified server-relative URL.
Public method GetFileByUrl
Public method GetFileByWOPIFrameUrl
Public method GetFolderById
Public method GetFolderByServerRelativePath
Public method GetFolderByServerRelativeUrl Returns the folder object located at the specified server-relative URL.
Public method GetList
Public method GetListItem
Public method GetListItemByResourceId
Public method GetListItemUsingPath
Public method GetListUsingPath
Public method Static member GetObjectSharingSettings Given a path to an object in SharePoint, this will generate a sharing settings object which contains necessary information for rendering sharing information.
Public method GetOnePageContextAsStream
Public method GetPushNotificationSubscriber Specifies the push notification subscriber over the site for the specified device app instance identifier.
Public method 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.
Public method GetPushNotificationSubscribersByUser Queries for the push notification subscribers for the site for the specified user.
Public method GetRecycleBinItems
Public method GetRecycleBinItemsByQueryInfo
Public method GetSharingLinkData
Public method Static member GetSharingLinkKind
Public method GetStorageEntity
Public method GetSubwebsForCurrentUser Returns the collection of child sites of the current site based on the specified query.
Public method GetUserById Returns the user corresponding to the specified member identifier for the current site.
Public method GetUserEffectivePermissions Gets the effective permissions that the specified user has within the current application scope.
Public method GetViewFromPath
Public method GetViewFromUrl
Public method Static member GetWebUrlFromPageUrl
Public method IncrementSiteClientTag
Protected method 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.)
Protected method InitOnePropertyFromJson (Overrides SecurableObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Public method LoadAndInstallApp Uploads and installs an app package to this site.
Public method LoadAndInstallAppInSpecifiedLocale Uploads and installs an App package, in a specified locale.
Public method LoadApp Uploads an App package and creates an instance from it.
Protected method LoadExpandoFields Initializes the extended properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method MapToIcon Returns the name of the image file for the icon that is used to represent the specified file.
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Public method 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.
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method RemoveStorageEntity
Public method RemoveSupportedUILanguage
Public method 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.)
Public method 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.)
Public method 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.)
Public method SetStorageEntity
Public method Static member ShareObject
Public method ToString (Inherited from Object.)
Public method UnregisterPushNotificationSubscriber Returns a GUID, and unregisters the push notification subscriber from the site.
Public method Static member UnshareObject Removes Sharing permissions on an object.
Public method Update Updates the database with changes that are made to the Web site.
Protected method UpdateClientObjectPropertyType Updates the client object property's value to have correct type by using the type information returned from the server. (Inherited from ClientObject.)
Public method Static member WebUrlFromFolderUrlDirect Get web's full url from folder url.
Public method Static member WebUrlFromPageUrlDirect
Top
Show: