Share via


DataViewCommandProvider Class

Provides the ability to implement commands, specifically custom commands, for nodes in a data view.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.Framework.DataSiteableObject<IVsDataViewHierarchy>
    Microsoft.VisualStudio.Data.Framework.DataViewCommandProvider

Namespace:  Microsoft.VisualStudio.Data.Framework
Assembly:  Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class DataViewCommandProvider _
    Inherits DataSiteableObject(Of IVsDataViewHierarchy) _
    Implements IVsDataViewCommandProvider, IVsDataSupportObject(Of IVsDataViewCommandProvider)
[CLSCompliantAttribute(false)]
public class DataViewCommandProvider : DataSiteableObject<IVsDataViewHierarchy>, 
    IVsDataViewCommandProvider, IVsDataSupportObject<IVsDataViewCommandProvider>
[CLSCompliantAttribute(false)]
public ref class DataViewCommandProvider : public DataSiteableObject<IVsDataViewHierarchy^>, 
    IVsDataViewCommandProvider, IVsDataSupportObject<IVsDataViewCommandProvider^>
[<CLSCompliantAttribute(false)>]
type DataViewCommandProvider =  
    class
        inherit DataSiteableObject<IVsDataViewHierarchy>
        interface IVsDataViewCommandProvider
        interface IVsDataSupportObject<IVsDataViewCommandProvider>
    end
public class DataViewCommandProvider extends DataSiteableObject<IVsDataViewHierarchy> implements IVsDataViewCommandProvider, IVsDataSupportObject<IVsDataViewCommandProvider>

The DataViewCommandProvider type exposes the following members.

Constructors

  Name Description
Public method DataViewCommandProvider Initializes a new instance of the DataViewBrowseObjectProvider class.

Top

Properties

  Name Description
Public property Site Gets or sets the object site. (Inherited from DataSiteableObject<T>.)

Top

Methods

  Name Description
Public method CreateCommand(Int32, CommandID) Creates a menu command for a Server Explorer menu item.
Protected method CreateCommand(Int32, CommandID, array<Object[]) Creates a menu command for a Server Explorer menu item containing the specified parameters.
Public method CreateSelectionCommand(CommandID) Creates a selection menu command for multiple nodes in Server Explorer.
Protected method CreateSelectionCommand(CommandID, array<Object[]) Creates a selection menu command for multiple nodes in Server Explorer.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnSiteChanged Raises the SiteChanged event. (Inherited from DataSiteableObject<T>.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateCommandStatus(MenuCommand) Updates the status of the specified menu command.
Protected method UpdateCommandStatus(MenuCommand, array<Object[]) Updates the status of the specified menu command.

Top

Events

  Name Description
Public event SiteChanged Occurs when the Site property is changed. (Inherited from DataSiteableObject<T>.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IVsDataSupportObject<IVsDataViewCommandProvider>.Invoke Invokes the specified command.

Top

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.

See Also

Reference

Microsoft.VisualStudio.Data.Framework Namespace