IFeature Interface
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Represents the definition of a feature within the SharePoint project system.
Namespace: Microsoft.VisualStudio.SharePoint.Features
Assembly: Microsoft.VisualStudio.SharePoint (in Microsoft.VisualStudio.SharePoint.dll)
Syntax
'Declaration
Public Interface IFeature _
Inherits IFeatureManifest, IObservableModelElement
public interface IFeature : IFeatureManifest,
IObservableModelElement
The IFeature type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ActivateOnDefault | Gets or sets whether the feature is activated during installation. (Inherited from IFeatureManifest.) |
|
ActivationDependencies | Gets a list of features on which activation of the current feature depends. (Inherited from IFeatureManifest.) |
|
AlwaysForceInstall | Gets or sets whether the feature should be installed by force, even if the feature is already installed. (Inherited from IFeatureManifest.) |
|
AutoActivateInCentralAdmin | Gets or sets whether the feature is activated by default for administrators. (Inherited from IFeatureManifest.) |
|
Creator | Gets or sets the name of the developer who created the feature. (Inherited from IFeatureManifest.) |
|
DefaultResourceFile | Gets or sets the central resource file for retrieving feature resources. (Inherited from IFeatureManifest.) |
|
DeploymentPath | Gets or sets the path in the package where the feature is deployed. |
|
Description | Gets or sets a description of what the feature does. (Inherited from IFeatureManifest.) |
|
Elements | Gets a list of feature element definition and support files. (Inherited from IFeatureManifest.) |
|
FeatureId | Gets or sets the SharePoint ID of the feature. (Inherited from IFeatureManifest.) |
|
ImageAltText | Gets or sets text for an image associated with the feature. (Inherited from IFeatureManifest.) |
|
ImageUrl | Gets or sets the relative URL of the image associated with the feature. (Inherited from IFeatureManifest.) |
|
IsDesignerEnabled | Gets whether the designer for the feature is enabled. |
|
IsHidden | Gets or sets whether the feature is visible in the list of available features to activate. (Inherited from IFeatureManifest.) |
|
ProjectItems | Gets the list of project items deployed with the feature. |
|
Properties | Gets a list of default values for feature properties. (Inherited from IFeatureManifest.) |
|
ReceiverAssembly | Gets or sets the fully-qualified name of the assembly that contains the event receiver for the feature. (Inherited from IFeatureManifest.) |
|
ReceiverClass | Gets or sets the class name of the event receiver for the feature. (Inherited from IFeatureManifest.) |
|
RequireResources | Gets or sets whether SharePoint checks for resources for a particular language and culture. (Inherited from IFeatureManifest.) |
|
Scope | Gets or sets the context in which a feature is activated. (Inherited from IFeatureManifest.) |
|
SolutionId | Gets or sets the ID of the SharePoint server where the feature will be installed. This property is used for infrastructural purposes only and should not be used. (Inherited from IFeatureManifest.) |
|
Title | Gets or sets the title of the feature, up to 255 characters. (Inherited from IFeatureManifest.) |
|
UIVersion | Gets or sets a string that indicates the compatible version of the site. (Inherited from IFeatureManifest.) |
|
UpgradeActions | Gets a list of actions to execute when upgrading the current feature. (Inherited from IFeatureManifest.) |
|
UpgradeActionsReceiverAssembly | Gets or sets the fully-qualified name of the assembly that contains the feature event receiver handling custom upgrade actions. (Inherited from IFeatureManifest.) |
|
UpgradeActionsReceiverClass | Gets or sets the class name of the feature event receiver handling custom upgrade actions. (Inherited from IFeatureManifest.) |
|
Version | Gets or sets a System.Version-compliant representation of the version of the feature. This value can be up to four numbers separated by decimals. (Inherited from IFeatureManifest.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PropertyChanged | Occurs when a DSL model element has changed. (Inherited from IObservableModelElement.) |
|
PropertyChanging | Occurs when a DSL model element is being changed. (Inherited from IObservableModelElement.) |
Top