DataViewCommandHandler Class
Provides the ability to implement commands, specifically custom commands, for nodes in a data view.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Data.ObjectWithSite
Microsoft.VisualStudio.Data.DataViewCommandHandler
Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)
Syntax
'Declaration
Public Class DataViewCommandHandler _
Inherits ObjectWithSite
public class DataViewCommandHandler : ObjectWithSite
public ref class DataViewCommandHandler : public ObjectWithSite
type DataViewCommandHandler =
class
inherit ObjectWithSite
end
public class DataViewCommandHandler extends ObjectWithSite
The DataViewCommandHandler type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
DataViewCommandHandler | Class constructor. Instantiates a new instance of the DataViewCommandHandler class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
DataViewHierarchyAccessor | Retrieves a DataViewHierarchyAccessor object instance, which provides managed accessors to the IVsHierarchy object that implements the data view hierarchy. |
.gif "Public property") |
Site | Retrieves or sets the object site. (Inherited from ObjectWithSite.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
ExecuteCommand(Int32, OleCommand, OleCommandExecutionOption, Object) | Causes the specified command to execute. |
|
ExecuteCommand(array<Int32[], OleCommand, OleCommandExecutionOption, Object) | Causes the specified command to execute on multiple items. |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetCommandStatus | Retrieves the status of the commands executing on the specified items. |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnSiteChanged | Raises the SiteChanged event. (Inherited from ObjectWithSite.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
SiteChanged | Event that is raised when the Site property is changed. (Inherited from ObjectWithSite.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IObjectWithSite.GetSite | Retrieves the last site set using the IObjectWithSite.SetSite method. In cases where there is no known site, the object returns an exception. (Inherited from ObjectWithSite.) |
|
IObjectWithSite.SetSite | Provides the site's pointer to the site object. (Inherited from ObjectWithSite.) |
Top
Remarks
Implement this object in cases where a data provider has custom commands, or wishes to implement their own version of common commands. Without this class a data provider can only reference native command handler implementations.
When a data provider executes a command, it may want to trigger updates in the data view—for example, by adding, renaming, moving, refreshing, or deleting various object nodes. In order to notify the data view of such changes, a data provider should use methods on the DataViewHierarchyAccessor class provided as a property on this class.
Classes derived from this one should implement the GetCommandStatus method by using the protected DataViewHierarchyAccessor class to contextualize the specified itemIds, and then implement the ExecuteCommand method to actually execute the commands that were indicated as supported.
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.