DataViewDocumentProvider Class

Article
10/02/2013

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
	DataViewDocumentProvider	Initializes a new instance of the DataViewDocumentProvider class.

Top

Properties

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

Top

Methods

	Name	Description
	CanOpen	Indicates whether a document can be opened for the specified node in the data view and for the given logical view.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	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.
	GetContext	Retrieves the service provider representing the context of the current document in the data view.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetMoniker	Retrieves the document moniker for the specified node in the data view.
	GetPriority	Gets the priority level of the specified document within the data view hierarchy.
	GetSaveName	Gets the name of the specified document for use when saving the document.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSupported	Indicates whether a document is supported for the specified node in the data view.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnSiteChanged	Raises the SiteChanged event. (Inherited from DataSiteableObject<T>.)
	Open	Opens the specified document in the given logical view. The document may be populated with existing data and may be hidden.
	ShowMoniker	Indicates whether the document moniker is to be displayed on the specified document.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	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.

Share via