This topic has not yet been rated - Rate this topic

SPFeatureDefinition.Scope Property

SharePoint 2010

Windows SharePoint Services 3

Gets the scope of this Feature.

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

Syntax

Copy

public SPFeatureScope Scope { get; }

Property Value

Type: Microsoft.SharePoint.SPFeatureScope
An SPFeatureScope value that specifies server farm, Web application, site collection, or Web site as the scope.

Exceptions

Exception	Condition
ArgumentException	Property is null.

Remarks

While a Web site Feature is scoped at the individual Web site level, a site collection Feature contains items that apply to the site collection as a whole (for example, content types that are shared across the site collection), as well as items that can be activated per site. Elements that can have either site collection or site scope include list definitions (templates and instances), modules (file sets), and item content type behaviors (per-item custom menu options and per-item events).

Reference

SPFeatureDefinition Class

SPFeatureDefinition Members

Microsoft.SharePoint.Administration Namespace

Other Resources

Activation Dependencies and Scope

Element Types

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ

Not to be confused with the SPFeatureDefinitionScope enum

...which is used to differentiate Farm vs. Sandboxed feature definitions when activating a feature at the Site or Web level.

SPFeatureCollection.Add:
http://msdn.microsoft.com/en-us/library/ee549179(office.14).aspx

SPFeatureDefinition:
http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.spfeaturedefinitionscope(office.14).aspx

History

3/2/2010
Stephen Schwink