DataViewBrowseObjectProvider Class

Article
10/03/2012

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

This API is not CLS-compliant.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class DataViewBrowseObjectProvider _
    Inherits DataSiteableObject(Of IVsDataViewHierarchy) _
    Implements IVsDataViewBrowseObjectProvider

[CLSCompliantAttribute(false)]
public class DataViewBrowseObjectProvider : DataSiteableObject<IVsDataViewHierarchy>, 
    IVsDataViewBrowseObjectProvider

[CLSCompliantAttribute(false)]
public ref class DataViewBrowseObjectProvider : public DataSiteableObject<IVsDataViewHierarchy^>, 
    IVsDataViewBrowseObjectProvider

[<CLSCompliantAttribute(false)>]
type DataViewBrowseObjectProvider =  
    class 
        inherit DataSiteableObject<IVsDataViewHierarchy>
        interface IVsDataViewBrowseObjectProvider 
    end

public class DataViewBrowseObjectProvider extends DataSiteableObject<IVsDataViewHierarchy> implements IVsDataViewBrowseObjectProvider

The DataViewBrowseObjectProvider type exposes the following members.

Constructors

	Name	Description
	DataViewBrowseObjectProvider	Initializes a new instance of the DataViewBrowseObjectProvider class.

Top

Properties

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

Top

Methods

	Name	Description
	CreateBrowseObject	Retrieves a browse object for a data view node, given the specified node's item ID.
	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.)
	GetHashCode	Serves as a hash function for a particular type. (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.)
	OnBrowseObjectChanged	Raises the BrowseObjectChanged event.
	OnSiteChanged	Raises the SiteChanged event. (Inherited from DataSiteableObject<T>.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	BrowseObjectChanged	Occurs when the browse object is changed.
	SiteChanged	Occurs when the Site property is changed. (Inherited from DataSiteableObject<T>.)

Top

Remarks

Classes derived from DataViewBrowseObjectProvider should implement the CreateBrowseObject method by using the pointer back to the hierarchy in order to contextualize the specified itemId. If you do this, 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-generated 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.

Share via