Share via


ISharePointProjectItem Interface

Definition

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

public interface class ISharePointProjectItem : Microsoft::VisualStudio::SharePoint::ISharePointProjectMember, Microsoft::VisualStudio::SharePoint::ISharePointProjectStartupItem, System::ComponentModel::INotifyPropertyChanged
public interface ISharePointProjectItem : Microsoft.VisualStudio.SharePoint.ISharePointProjectMember, Microsoft.VisualStudio.SharePoint.ISharePointProjectStartupItem, System.ComponentModel.INotifyPropertyChanged
type ISharePointProjectItem = interface
    interface ISharePointProjectMember
    interface IAnnotatedObject
    interface INotifyObjectDisposing
    interface INotifyObjectDisposed
    interface INotifyPropertyChanged
    interface ISharePointProjectStartupItem
Public Interface ISharePointProjectItem
Implements INotifyPropertyChanged, ISharePointProjectMember, ISharePointProjectStartupItem
Derived
Implements

Remarks

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

Properties

Annotations

Gets an instance IAnnotationDictionary to associate custom data with the object implementing the IAnnotatedObject interface.

(Inherited from IAnnotatedObject)
DefaultFile

Get or sets the file that is launched when a SharePoint project item node in Solution Explorer is activated.

ExtensionData

Gets the information that enables project item extensions to persist custom data across Visual Studio sessions.

FeatureActivationDependencies

Gets the activation dependencies that are added to the feature that includes this Sharepoint Project Item.

FeatureProperties

Gets the key/value pairs that are added to the feature that includes this SharePoint Project Item.

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.

Files

Gets a collection of all files in the project under the SharePoint project item folder node and its subfolders.

FullPath

Gets the full source path of the project member file or directory.

(Inherited from ISharePointProjectMember)
Icon

Gets the icon for the project member node displayed in Solution Explorer.

(Inherited from ISharePointProjectMember)
Id

Gets a globally unique identifier for this instance of the SharePoint project item.

IsDisposed

Gets whether the an object is disposed.

(Inherited from INotifyObjectDisposed)
IsDisposing

Gets whether an object is disposing.

(Inherited from INotifyObjectDisposing)
IsExpanded

Gets or sets whether that node is expanded in Solution Explorer.

(Inherited from ISharePointProjectMember)
Name

Gets the name of the project member node displayed in Solution Explorer.

(Inherited from ISharePointProjectMember)
Project

Gets a reference to the containing project.

(Inherited from ISharePointProjectMember)
ProjectItemType

Gets a reference to the object representing the SharePoint project item type.

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.

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.

RelativePath

Gets the unique location of the item within the project directory.

(Inherited from ISharePointProjectStartupItem)
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.

StartupUrl

Gets the URL to launch when the item is started.

(Inherited from ISharePointProjectStartupItem)
VirtualFiles

Gets the collection includes virtual files. Virtual files do not have to exist at design time. At packaging time MSBuild tasks need to ensure the file is present for the packaging to suceed.

Methods

CollapseChildItems()

Ensures that all child items of this ISharePointProjectMember are collapsed in Solution Explorer.

(Inherited from ISharePointProjectMember)

Events

Disposed

Occurs when an object is disposed.

(Inherited from INotifyObjectDisposed)
Disposing

Occurs when an object is being disposed.

(Inherited from INotifyObjectDisposing)
NameChanged

Occurs when the name of the project member node is changed.

(Inherited from ISharePointProjectMember)
Open

Occurs when a SharePoint project item folder opens.

Applies to