Partilhar via


SPWebTemplate.Description Property

Gets the description for the site definition configuration or Web template.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
<ClientCallableAttribute> _
Public ReadOnly Property Description As String
    Get
'Usage
Dim instance As SPWebTemplate
Dim value As String

value = instance.Description
[ClientCallableAttribute]
public string Description { get; }

Property Value

Type: System.String
A String that contains the description.

Remarks

If the SPWebTemplate represents a site definition configuration, this property corresponds to the Description attribute of a Configuration element in a WebTemp*.xml file. (See Understanding WebTemp*.xml Files for more information.)

If the SPWebTemplate represents a Web template, this property corresponds to the Description attribute of a WebTemplate element in an elements.xml file contained in the .wsp file that stores the Web template.

See Also

Reference

SPWebTemplate Class

SPWebTemplate Members

Microsoft.SharePoint Namespace

Other Resources

Understanding WebTemp*.xml Files

Collaborative Application Markup Language (CAML)

Web Templates

Site Definitions and Configurations