Share via


DataViewDocumentProvider Class

Provides the ability to open a document, get a document moniker, and perform other actions pertaining to a document in the Visual Studio Sever Explorer.

This API is not CLS-compliant. 

Inheritance Hierarchy

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

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

Syntax

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

The DataViewDocumentProvider type exposes the following members.

Constructors

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

Top

Properties

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

Top

Methods

  Name Description
Public method CanOpen Indicates whether a document can be opened for the specified node in the data view and for the given logical view.
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 FindNode Searches for a node in the data view that corresponds to the specified document moniker. Optionally, searches child nodes that have not been expanded yet.
Public method GetContext Retrieves the service provider representing the context of the current document in the data view.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetMoniker Retrieves the document moniker for the specified node in the data view.
Public method GetPriority Gets the priority level of the specified document within the data view hierarchy.
Public method GetSaveName Gets the name of the specified document for use when saving the document.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsSupported Indicates whether a document is supported for the specified node in the data view.
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 Open Opens the specified document in the given logical view. The document may be populated with existing data and may be hidden.
Public method ShowMoniker Indicates whether the document moniker is to be displayed on the specified document.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

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

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