Partager via


WebTemplate Members

Include Protected Members
Include Inherited Members

Specifies a site definition or a site template that is used to instantiate a site.

The WebTemplate type exposes the following members.

Constructors

  Name Description
Public method WebTemplate

Top

Properties

  Name Description
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property Description Gets a value that specifies the description for the site definition configuration or site template.
Public property DisplayCategory Gets a value that specifies the display name for the category that this site definition configuration or site template is a part of.
Public property Id Gets a value that specifies the unique identifier for the site definition configuration or the site template.
Public property ImageUrl Gets a value that specifies the URI for the image that is associated with the site definition configuration or site template.
Public property IsHidden Gets a value that specifies whether the site definition configuration is displayed in the user interface for creating new sites.
Public property IsRootWebOnly Gets a value that specifies whether the site definition configuration or site template can only be applied to the top-level site in the site collection.
Public property IsSubWebOnly Gets a value that specifies whether the site definition configuration or site template can only be applied to subsites created within the site collection.
Public property Lcid Gets a value that specifies the LCID for the site definition configuration or site template.
Public property Name Gets a value that specifies the name for the site definition configuration or site template.
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 ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property Title Gets a value that specifies the display name for the site definition configuration or site template.

Top

Methods

  Name Description
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 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.)
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 ClientObject.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 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 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.)

Top

See Also

Reference

WebTemplate Class

Microsoft.SharePoint.Client Namespace