SPWebTemplate.IsRootWebOnly Property

Gets a value that indicates whether the site definition configuration or Web template is applicable to only the root site in the site collection.

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 IsRootWebOnly As Boolean
    Get
'Usage
Dim instance As SPWebTemplate
Dim value As Boolean

value = instance.IsRootWebOnly
[ClientCallableAttribute]
public bool IsRootWebOnly { get; }

Property Value

Type: System.Boolean
true if the template or configuration applies only to root sites; otherwise, false. The default is false.

Remarks

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

If the SPWebTemplate represents a Web template, this property always returns false.

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