Microsoft.VisualStudio.SharePoint Namespace

  • Article

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

The Microsoft.VisualStudio.SharePoint namespace contains types you can use to extend the SharePoint project system in Visual Studio. For more information about using the types in this namespace, see Extending the SharePoint Project System.

Although most of the types in this namespace are interfaces, only the following interfaces are intended to be implemented in your code:

Classes

  Class Description
Public class ClassNameChangedEventArgs Provides data for an event raised when the name of a class is changed.
Public class ClassNameChangingEventArgs Provides data for an event raised when the name of a class is about to be changed.
Public class DeploymentEventArgs Provides data for the DeploymentStarted and DeploymentCompleted events.
Public class DeploymentPathChangedEventArgs Provides data for the DeploymentPathChanged event.
Public class DeploymentStepCanceledEventArgs Represents the event argument class used for the DeploymentStepCanceled event.
Public class DeploymentStepCompletedEventArgs Provides data for the DeploymentStepCompleted event.
Public class DeploymentStepFailedEventArgs Represents the event argument class used for the DeploymentStepFailed event.
Public class DeploymentStepStartedEventArgs Provides data for the DeploymentStepStarted event.
Public class DeploymentTypeChangedEventArgs Provides data for the DeploymentTypeChanged event.
Public class HighTrustCreationInformation Provides information for creating a web project as part of a high trust app.
Public class MenuItemEventArgs Represents the event arguments class for the Click event.
Public class NameChangedEventArgs Represents the event arguments class for the NameChanged event.
Public class NamespaceNameChangedEventArgs Provides data for an event raised when the name of a namespace has been changed.
Public class NamespaceNameChangingEventArgs Provides data for an event raised when the name of a namespace is about to be changed.
Public class SharePointCommandCanceledException The exception that is raised when a SharePoint command is canceled by user.
Public class SharePointCommandException The exception that is thrown when a SharePoint command fails.
Public class SharePointConnectionDisabledException The exception that is raised when SharePoint connection is disabled.
Public class SharePointConnectionException The exception that is thrown when an attempt to connect to the local SharePoint site fails.
Public class SharePointProjectEventArgs Provides data for events related to SharePoint projects.
Public class SharePointProjectItemEventArgs Provides data for events related to SharePoint project items.
Public class SharePointProjectItemFileEventArgs Provides data for events related to SharePoint project item files.
Public class SharePointProjectItemIconAttribute Specifies the icon to display in Solution Explorer for a custom project item type.
Public class SharePointProjectItemMenuItemsRequestedEventArgs Provides data for the ProjectItemMenuItemsRequested event.
Public class SharePointProjectItemOpenEventArgs Provides data for the Open event.
Public class SharePointProjectItemPropertiesRequestedEventArgs Provides data for the ProjectItemPropertiesRequested event.
Public class SharePointProjectItemStartupUrlRequestedEventArgs Provides data for the ProjectItemStartupUrlRequested event.
Public class SharePointProjectItemTypeAttribute Specifies the ID of a project item type that is being defined, or the ID of a project item type that is being extended.
Public class SharePointProjectMenuItemsRequestedEventArgs Provides data for the ProjectMenuItemsRequested event.
Public class SharePointProjectPropertiesRequestedEventArgs Provides data for the ProjectPropertiesRequested event.
Public class WebProjectCreationInformation

Interfaces

  Interface Description
Public interface IAnnotatedObject Represents the IAnnotationDictionary, which enables association of custom data with the object implementing this interface.
Public interface IAnnotationDictionary Represents a dictionary of custom data objects that you can associate with certain objects in the SharePoint tools object model.
Public interface ICodeRefactoringEvents Provides events that notify about the occurrence of a refactoring operation.
Public interface IDeployableFile Provides the base interface for all files that can be packaged into the WSP file and deployed to SharePoint. These files share a set of deployment-related properties.
Public interface IFeatureReceiver Represents a feature receiver in SharePoint.
Public interface IMappedFolder Represents a folder in a SharePoint project that is mapped to a location in SharePoint.
Public interface IMappedFolderCollection Represents a collection of mapped folders in a SharePoint project.
Public interface IMenuItem Represents a menu item that can be added to a context menu for ISharePointProjectItem or IExplorerNode.
Public interface IMenuItemCollection Represents a collection of menu items that are added dynamically in the ProjectItemMenuItemsRequested event handler.
Public interface INotifyObjectDisposed A class implementing this interface notifies you when an object is disposed.
Public interface INotifyObjectDisposing A class implementing this interface notifies you when an object is being disposed.
Public interface IObservableModelElement Represents a DSL model element that exposes property changing/changed events.
Public interface IPropertySourceCollection Represents a collection of property source objects that appear in the Properties window.
Public interface ISafeControlEntry Represents a safe control entry that is added to SharePoint's web.config file when it is deployed.
Public interface ISafeControlEntryCollection Represents a collection of safe control entries.
Public interface ISharePointAppSettings Represents the settings of application for SharePoint or application for Office.
Public interface ISharePointCollection<T> Represents a read-only collection of items. It provides no public methods to modify content of the collection. It is used as a base type for a number of collections in SharePoint project model. These collections are typically changed internally and events can be used to monitor for these changes.
Public interface ISharePointConnection Provides methods you can use to execute SharePoint commands that call into the SharePoint server object model from an extension of the SharePoint tools in Visual Studio.
Public interface ISharePointProject Represents the SharePoint project.
Public interface ISharePointProjectCollection A collection of all SharePoint projects in the Visual Studio solution.
Public interface ISharePointProjectEvents Defines the events relevant to ISharePointProject objects. The implementing object defines the context on which these events occur.
Public interface ISharePointProjectExtension Represents an extension for SharePoint projects.
Public interface ISharePointProjectFeature Provides information about features.
Public interface ISharePointProjectFeatureCollection A collection of all SharePoint features defined in the SharePoint project.
Public interface ISharePointProjectFeatureResourceFile Represents a resource file for the feature.
Public interface ISharePointProjectFeatureResourceFileCollection Represents the collection of resource files for a feature.
Public interface ISharePointProjectItem Represents an instance of a SharePoint project item, implemented by the SharePoint project system.
Public interface ISharePointProjectItemCollection Represents a collection of SharePoint project items.
Public interface ISharePointProjectItemEvents Defines the events relevant to ISharePointProjectItem objects.
Public interface ISharePointProjectItemFile Represents a file in the SharePoint project system.
Public interface ISharePointProjectItemFileCollection Represents a collection of files in a SharePoint project item.
Public interface ISharePointProjectItemFileEvents Defines the events relating to ISharePointProjectItemFile objects.
Public interface ISharePointProjectItemType Represents a type of a SharePoint project item. It enables users to associate custom data with a type because it inherits from the IAnnotatedObject interface.
Public interface ISharePointProjectItemTypeDefinition Helps define the type of a SharePoint project item.
Public interface ISharePointProjectItemTypeExtension Represents an extension for a particular type of SharePoint project item.
Public interface ISharePointProjectItemTypeProvider Provides the definition of a custom SharePoint project item type.
Public interface ISharePointProjectItemVirtualFile Represents a file in the SharePoint project system.
Public interface ISharePointProjectItemVirtualFileCollection Represents the collection of files in a SharePoint project item.
Public interface ISharePointProjectLogger Represents the SharePoint logging service, which enables SharePoint project extensions to log messages into the Output window and Error List, depending on the specified LogCategory.
Public interface ISharePointProjectMember Represents a member of a SharePoint project.
Public interface ISharePointProjectMemberReference Specifies a reference to an item in a SharePoint project.
Public interface ISharePointProjectMemberReferenceCollection Represents a collection of SharePoint project item references.
Public interface ISharePointProjectMemberReferenceResolver Specifies an API that resolves references between SharePoint project items and the items themselves.
Public interface ISharePointProjectOutputReference Represents the primary output of a referenced Visual Studio project.
Public interface ISharePointProjectOutputReferenceCollection Represents a collection of project output references belonging to a project item.
Public interface ISharePointProjectPackage The SharePoint package associated with the SharePoint project.
Public interface ISharePointProjectService Represents the SharePoint project service, a root object for the SharePoint project object model.
Public interface ISharePointProjectStartupItem Represents items that can be set as the startup item of an ISharePointProject.

Enumerations

  Enumeration Description
Public enumeration AssemblyDeploymentTarget Specifies where the output assembly of the project will be deployed.
Public enumeration DeploymentType Specifies the type of deployment to be performed on a file.
Public enumeration LogCategory Specifies where messages written by using the SharePoint log service appear in the Output window and Error List window.
Public enumeration MappedFolderType Specifies the type of a mapped folder in a SharePoint project.
Public enumeration SharePointAuthenticationMode
Public enumeration SharePointProjectMode Specifies the mode for the SharePoint project.
Public enumeration SupportedAssemblyDeploymentTargets An enumeration that represents all of the supported assembly deployment targets for a specified SharePoint project item.
Public enumeration SupportedDeploymentScopes Specifies the deployment scopes in which a SharePoint project item can be activated in SharePoint.
Public enumeration SupportedTrustLevels Enumeration values that specify the trust level in SharePoint supported by the SharePoint project item.
Public enumeration WebProjectType