DataViewBrowseObjectProvider Class

  • Article

Allows you to retrieve a specialized browse object for a specified node in a given data view.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.ObjectWithSite
    Microsoft.VisualStudio.Data.DataViewBrowseObjectProvider

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

Syntax

'Declaration
Public Class DataViewBrowseObjectProvider _
    Inherits ObjectWithSite

public class DataViewBrowseObjectProvider : ObjectWithSite

public ref class DataViewBrowseObjectProvider : public ObjectWithSite

type DataViewBrowseObjectProvider =  
    class
        inherit ObjectWithSite
    end

public class DataViewBrowseObjectProvider extends ObjectWithSite

The DataViewBrowseObjectProvider type exposes the following members.

Constructors

  Name Description
Public method DataViewBrowseObjectProvider Class constructor. Instantiates a new instance of the DataViewBrowseObjectProvider class.

Top

Properties

  Name Description
Protected property DataViewHierarchyAccessor Retrieves a DataViewHierarchyAccessor object instance, which provides managed accessors for the IVsHierarchy object that implements the data view hierarchy.
Public property Site Retrieves or sets the object site. (Inherited from ObjectWithSite.)

Top

Methods

  Name Description
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 GetBrowseObject Retrieves a special browse object for a data view node, given the specified node's item ID.
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 ObjectWithSite.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event SiteChanged Event that is raised when the Site property is changed. (Inherited from ObjectWithSite.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate 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.)
Explicit interface implemetationPrivate method IObjectWithSite.SetSite Provides the site's pointer to the site object. (Inherited from ObjectWithSite.)

Top

Remarks

Classes derived from DataViewBrowseObjectProvider should implement the GetBrowseObject method by using the pointer back to the hierarchy in order to contextualize the specified itemId; then, you can use any auto-generated browse object as a base for more specialized browse objects.

The base class implementation simply returns the value of the auto-generate browse object.

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 Namespace

ObjectWithSite