Share via

ISharePointProjectItem Interface

  • Article

Represents an instance of a SharePoint project item, implemented by the SharePoint project system.

Namespace:  Microsoft.VisualStudio.SharePoint
Assembly:  Microsoft.VisualStudio.SharePoint (in Microsoft.VisualStudio.SharePoint.dll)

Syntax

'Declaration
Public Interface ISharePointProjectItem _
    Inherits ISharePointProjectMember, IAnnotatedObject, INotifyObjectDisposing, INotifyObjectDisposed,  _
    INotifyPropertyChanged, ISharePointProjectStartupItem

public interface ISharePointProjectItem : ISharePointProjectMember, 
    IAnnotatedObject, INotifyObjectDisposing, INotifyObjectDisposed, INotifyPropertyChanged, ISharePointProjectStartupItem

The ISharePointProjectItem type exposes the following members.

Properties

  Name Description
Public property Annotations Gets an instance IAnnotationDictionary to associate custom data with the object implementing the IAnnotatedObject interface. (Inherited from IAnnotatedObject.)
Public property DefaultFile Get or sets the file that is launched when a SharePoint project item node in Solution Explorer is activated. (That is, when it is clicked or the ENTER key pressed).
Public property ExtensionData Gets information that enables project item extensions to persist custom data across Visual Studio sessions.
Public property FeatureProperties Gets the key/value pairs that are added to the feature that includes this SharePoint Project Item.
Public property FeatureReceiver Gets a feature receiver, if the SharePoint project item requires it. At package time, this feature receiver is added to the feature that includes this SharePoint project item.
Public property Files Gets a collection of all files in the project under the SharePoint project item folder node and its subfolders.
Public property FullPath Gets the full source path of the project member file or directory. (Inherited from ISharePointProjectMember.)
Public property Icon Gets the icon for the project member node displayed in Solution Explorer. (Inherited from ISharePointProjectMember.)
Public property Id Gets a unique Id for this instance of the SharePoint project item.
Public property IsDisposed Gets whether the an object is disposed. (Inherited from INotifyObjectDisposed.)
Public property IsDisposing Gets whether an object is disposing. (Inherited from INotifyObjectDisposing.)
Public property IsExpanded Gets or sets whether that node is expanded in Solution Explorer. (Inherited from ISharePointProjectMember.)
Public property Name Gets the name of the project member node displayed in Solution Explorer. (Inherited from ISharePointProjectMember.)
Public property Project Gets a reference to the containing project. (Inherited from ISharePointProjectMember.)
Public property ProjectItemType Gets a reference to the object representing the SharePoint project item type.
Public property ProjectOutputReferences Get the collection of project output references belonging to this project item. Referenced projects are built and their primary outputs are packaged along with the project item.
Public property ProjectUserFileData Gets an IDictionary object that you can use to get or set name/value pairs that are saved in a project user file, such as files with a .csproj.user or .vbproj.user extension.
Public property RelativePath Gets the unique location of the item within the project directory. (Inherited from ISharePointProjectStartupItem.)
Public property SafeControlEntries Get a collection of safe control entries that must be deployed along with this SharePoint project item when it is deployed. These entries are added to the package that references the SharePoint project item.
Public property StartupUrl Gets the URL to launch when the item is started. (Inherited from ISharePointProjectStartupItem.)

Top

Methods

  Name Description
Public method CollapseChildItems Ensures that all child items of this ISharePointProjectMember are collapsed in Solution Explorer. (Inherited from ISharePointProjectMember.)

Top

Events

  Name Description
Public event Disposed Occurs when an object is disposed. (Inherited from INotifyObjectDisposed.)
Public event Disposing Occurs when an object is being disposed. (Inherited from INotifyObjectDisposing.)
Public event NameChanged Occurs when the name of the project member node is changed. (Inherited from ISharePointProjectMember.)
Public event Open Occurs when a SharePoint project item folder opens.
Public event PropertyChanged Occurs when a property value changes. (Inherited from INotifyPropertyChanged.)

Top

Remarks

Any folder in a SharePoint project that contains a project item file is assumed to be a SharePoint project item node.

See Also

Reference

Microsoft.VisualStudio.SharePoint Namespace