Web Members

Include Protected Members
Include Inherited Members

Represents a Microsoft SharePoint Foundation Web site.

The Web type exposes the following members.

Constructors

  Name Description
Public method Web

Top

Properties

  Name Description
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 AllProperties Gets a collection of metadata for the Web site.
Public property AssociatedMemberGroup
Public property AssociatedOwnerGroup
Public property AssociatedVisitorGroup
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 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 CurrentUser Gets the current user of the site.
Public property Description Gets or sets the description for the site.
Public property EffectiveBasePermissions Gets a value that specifies the effective permissions that are assigned to the current user.
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 Folders Gets the collection of all first-level folders in the Web site.
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 Id Gets a value that specifies the site identifier for the site.
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 Lists Gets the collection of all lists that are contained in the Web site 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 Navigation Gets a value that specifies the navigation structure on the site, including the Quick Launch area and the top navigation bar.
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 Path Tracks how a client object is created in the ClientRuntimeContext class, so that the object can be re-created 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 QuickLaunchEnabled Gets or sets a value that specifies whether the Quick Launch area is enabled on the site.
Public property RecycleBinEnabled Gets or sets a value that specifies whether the Recycle Bin is enabled.
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 Web site.
Public property RootFolder Gets the root folder for the Web site.
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
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 SiteUserInfoList Gets the UserInfo list of the site collection that contains the Web 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 Title Gets or sets the title for the Web site.
Public property TreeViewEnabled Gets or sets value that specifies whether the tree view is enabled on the site.
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 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 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

Methods

  Name Description
Public method ApplyWebTemplate
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 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 DeleteObject Deletes the Web site.
Public method DoesUserHavePermissions Returns whether the current user has the given set of permissions.
Public method EnsureUser
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 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 GetFileByServerRelativeUrl Returns the file object located at the specified server-relative URL.
Public method GetFolderByServerRelativeUrl Returns the folder object located at the specified server-relative URL.
Public method GetSubwebsForCurrentUser Returns the collection of child sites of the current site based on the specified query.
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on 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.)
Protected method LoadExpandoFields When overridden in a derived class, initializes the extended properties associated with the client object. (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.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method ResetRoleInheritance Resets the role inheritance for the securable object and inherits role assignments from the parent securable 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 ToString (Inherited from Object.)
Public method Update Updates the database with changes that are made to the Web site.
Public methodStatic member WebUrlFromPageUrlDirect

Top

See Also

Reference

Web Class

Microsoft.SharePoint.Client Namespace