SPFeatureDefinition members

Contains the base definition of a feature, including its name, ID, scope, and version.

The SPFeatureDefinition type exposes the following members.


  Name Description
Public method SPFeatureDefinition This member is reserved for internal use and is not intended to be used directly from your code.



  Name Description
Public property ActivateOnDefault Gets a value that specifies whether the Feature is activated upon installation by default.
Public property ActivateOnSiteMaster
Public property ActivationDependencies Gets the collection of Features on which activation of this Feature depends.
Public property AlwaysForceInstall Gets a value that indicates whether the force flag is set to true by default during installation.
Public property AutoActivateInCentralAdmin Gets a value that specifies whether the Feature is activated on the central administrative Web site, site collection, or Web application upon installation.
Public property CompatibilityLevel Gets the integer that represents the compatibility level for a definition of a feature.
Public property DefaultResourceFile Gets a partial name of a file that contains localized resources used by this Feature.
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property DisplayName Gets the folder name for the Feature. (Overrides SPPersistedObject.DisplayName.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Hidden Gets a value that indicates whether the Feature is hidden within the Microsoft SharePoint Foundation user interface.
Public property Id Gets or sets the Guid that is associated with the object.
Public property Name Gets or sets the name that identifies a specific SPFeature object.
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets a standardized property bag object that contains per-Feature settings that are specified in the Feature definition.
Public property ReceiverAssembly Gets the strong name of the assembly that handles events for this Feature.
Public property ReceiverClass Gets the fully qualified, case-sensitive name of the class that handles events for this Feature.
Public property RequireResources Gets the Boolean value that specifies whether this feature is associated with localized resources.
Public property RootDirectory Gets the full local path to the root folder of the Feature.
Public property Scope Gets the scope of this Feature.
Public property SolutionId Gets the identifier of the solution used to deploy this Feature, or Empty if the Feature was added directly through a command-line operation or through the object model.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UIVersion Gets the version of the user interface in which this feature should be listed.
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property UpgradeReceiverAssembly Gets the solution-relative path of the assembly that contains the UpgradeReceiverClass object.
Public property UpgradeReceiverClass Gets the name of the class implementing the feature's upgrade callbacks.
Public property Version Gets the current version of this Feature.
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)



  Name Description
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method Delete Removes the SPFeature object from the collection and the server farm. (Overrides SPPersistedObject.Delete().)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetDescription Returns the description of the Feature.
Public method GetElementDefinitions Returns the collection of element definitions contained within the Feature definition.
Public methodStatic member GetFeatureIdAndScope Returns the identifier and scope of the Feature based on a string that specifies the location of its feature.xml file.
Public method GetFile Gets the stream of the file for the specified file in the SPFeature object.
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetImageAltText Gets a localized alternate text title for the feature image.
Public method GetImageUrl Returns the path to an image file that provides an icon for this Feature.
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetTitle Returns the title of the Feature.
Public method GetType (Inherited from Object.)
Public method GetXmlDefinition Returns the XmlNode object that represents the Feature definition.
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method SupportsLanguage Returns a Boolean value that indicates whether the Microsoft SharePoint Foundation deployment supports the language of the specified culture.
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)


See also


SPFeatureDefinition class

Microsoft.SharePoint.Administration namespace