ISharePointProjectItemDeploymentContext Interface
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Represents the deployment context of a specific project item.
Namespace: Microsoft.VisualStudio.SharePoint.Deployment
Assembly: Microsoft.VisualStudio.SharePoint (in Microsoft.VisualStudio.SharePoint.dll)
Syntax
'Declaration
Public Interface ISharePointProjectItemDeploymentContext _
Inherits IDeploymentContext, IAnnotatedObject
public interface ISharePointProjectItemDeploymentContext : IDeploymentContext,
IAnnotatedObject
The ISharePointProjectItemDeploymentContext type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Annotations | Gets an instance IAnnotationDictionary to associate custom data with the object implementing the IAnnotatedObject interface. (Inherited from IAnnotatedObject.) |
|
Feature | Gets the primary feature associated with the project item. |
|
FeatureScope | Gets a value representing the scope at which the project item's feature is being deployed. |
|
IsCanceled | Gets whether the deployment was canceled by the user. (Inherited from IDeploymentContext.) |
|
IsDeploying | Gets whether the project is being deployed. (Inherited from IDeploymentContext.) |
|
IsRetracting | Gets whether the project is being retracted. (Inherited from IDeploymentContext.) |
|
Logger | Gets the access to the project logger. (Inherited from IDeploymentContext.) |
|
Project | Gets the access to the current project that is being deployed or retracted. (Inherited from IDeploymentContext.) |
|
ProjectItem | Gets the project item being deployed. |
|
StartMode | Gets the access to the start mode the reason why deployment was initiated. (Inherited from IDeploymentContext.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
SiteCollectionUrl | Returns the canonical URL of the Microsoft.SharePoint.SPSite that the project is connected to, according to SharePoint. (Inherited from IDeploymentContext.) |
|
SiteUrl | Returns the canonical URL of the Microsoft.SharePoint.SPWeb that the project is connected to, according to SharePoint. (Inherited from IDeploymentContext.) |
|
WebApplicationUrl | Returns the root URL of the SPWebApplication. (Inherited from IDeploymentContext.) |
Top
Remarks
Use ISharePointProjectItemDeploymentContext objects to determine the location of the deployed project item and its files on the server. Visual Studio passes ISharePointProjectItemDeploymentContext objects to the event handlers for the DeploymentStepStarted, DeploymentStepCompleted, and ProjectItemStartupUrlRequested events.