SharePointCommandAttribute Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Indicates that a method is a SharePoint command.
Inheritance Hierarchy
System.Object
System.Attribute
Microsoft.VisualStudio.SharePoint.Commands.SharePointCommandAttribute
Namespace: Microsoft.VisualStudio.SharePoint.Commands
Assembly: Microsoft.VisualStudio.SharePoint.Commands (in Microsoft.VisualStudio.SharePoint.Commands.dll)
Syntax
'Declaration
<AttributeUsageAttribute(AttributeTargets.Method, Inherited := False, AllowMultiple := False)> _
Public NotInheritable Class SharePointCommandAttribute _
Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Method, Inherited = false, AllowMultiple = false)]
public sealed class SharePointCommandAttribute : Attribute
The SharePointCommandAttribute type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SharePointCommandAttribute() | Initializes a new instance of the SharePointCommandAttribute class. |
|
SharePointCommandAttribute(String) | Initializes a new instance of the SharePointCommandAttribute class with the specified command ID. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CommandId | Gets the ID of the command. |
|
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
|
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
|
Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
_Attribute.GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
|
_Attribute.GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
|
_Attribute.GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
|
_Attribute.Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
Top
Remarks
Apply this attribute to a method that you want to designate a SharePoint command. A SharePoint command is a method that can be used to call APIs in the SharePoint server object model from an extension for the SharePoint tools in Visual Studio. For more information, see Calling into the SharePoint Object Models and How to: Create a SharePoint Command.
Examples
Calling into the SharePoint Object Models
How to: Create a SharePoint Command
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.