SPFeatureDefinition members
Contains the base definition of a feature, including its name, ID, scope, and version.
The SPFeatureDefinition type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SPFeatureDefinition | This member is reserved for internal use and is not intended to be used directly from your code. |
Top
Properties
Name | Description | |
---|---|---|
ActivateOnDefault | Gets a value that specifies whether the Feature is activated upon installation by default. | |
ActivateOnSiteMaster | ||
ActivationDependencies | Gets the collection of Features on which activation of this Feature depends. | |
AlwaysForceInstall | Gets a value that indicates whether the force flag is set to true by default during installation. | |
AutoActivateInCentralAdmin | Gets a value that specifies whether the Feature is activated on the central administrative Web site, site collection, or Web application upon installation. | |
CompatibilityLevel | Gets the integer that represents the compatibility level for a definition of a feature. | |
DefaultResourceFile | Gets a partial name of a file that contains localized resources used by this Feature. | |
DeploymentLocked | (Inherited from SPPersistedObject.) | |
DisplayName | Gets the folder name for the Feature. (Overrides SPPersistedObject.DisplayName.) | |
Farm | Gets the server farm where the object resides. (Inherited from SPPersistedObject.) | |
Hidden | Gets a value that indicates whether the Feature is hidden within the Microsoft SharePoint Foundation user interface. | |
Id | Gets or sets the Guid that is associated with the object. | |
Name | Gets or sets the name that identifies a specific SPFeature object. | |
Parent | Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.) | |
Properties | Gets a standardized property bag object that contains per-Feature settings that are specified in the Feature definition. | |
ReceiverAssembly | Gets the strong name of the assembly that handles events for this Feature. | |
ReceiverClass | Gets the fully qualified, case-sensitive name of the class that handles events for this Feature. | |
RequireResources | Gets the Boolean value that specifies whether this feature is associated with localized resources. | |
RootDirectory | Gets the full local path to the root folder of the Feature. | |
Scope | Gets the scope of this Feature. | |
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. | |
Status | Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.) | |
TypeName | Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.) | |
UIVersion | Gets the version of the user interface in which this feature should be listed. | |
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) | |
UpgradeReceiverAssembly | Gets the solution-relative path of the assembly that contains the UpgradeReceiverClass object. | |
UpgradeReceiverClass | Gets the name of the class implementing the feature's upgrade callbacks. | |
Version | Gets the current version of this Feature. | |
WasCreated | Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.) |
Top
Methods
Name | Description | |
---|---|---|
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.) | |
Delete | Removes the SPFeature object from the collection and the server farm. (Overrides SPPersistedObject.Delete().) | |
Equals | Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.) | |
Finalize | (Inherited from Object.) | |
GetChild<T>() | Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.) | |
GetChild<T>(String) | Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.) | |
GetDescription | Returns the description of the Feature. | |
GetElementDefinitions | Returns the collection of element definitions contained within the Feature definition. | |
GetFeatureIdAndScope | Returns the identifier and scope of the Feature based on a string that specifies the location of its feature.xml file. | |
GetFile | Gets the stream of the file for the specified file in the SPFeature object. | |
GetHashCode | Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.) | |
GetImageAltText | Gets a localized alternate text title for the feature image. | |
GetImageUrl | Returns the path to an image file that provides an icon for this Feature. | |
GetObjectData | Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.) | |
GetTitle | Returns the title of the Feature. | |
GetType | (Inherited from Object.) | |
GetXmlDefinition | Returns the XmlNode object that represents the Feature definition. | |
HasAdditionalUpdateAccess | Override this method to allow more users to update the object. (Inherited from SPPersistedObject.) | |
LegacyUpdate | (Inherited from SPPersistedObject.) | |
MemberwiseClone | (Inherited from Object.) | |
OnDeserialization | Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.) | |
OnPostCreate | (Inherited from SPPersistedObject.) | |
OnPreCreate | (Inherited from SPPersistedObject.) | |
Provision | Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.) | |
RunWithConcurrencyRetries | (Inherited from SPPersistedObject.) | |
SupportsLanguage | Returns a Boolean value that indicates whether the Microsoft SharePoint Foundation deployment supports the language of the specified culture. | |
ToString | Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.) | |
Uncache | Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.) | |
Unprovision | Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.) | |
Update() | Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.) | |
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.) | |
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) | |
UpdateWithNoObjectCallbackCheck | (Inherited from SPPersistedObject.) | |
Validate | Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.) |
Top