DataViewBrowseObjectProvider.CreateBrowseObject Method

Article
10/03/2012

Retrieves a browse object for a data view node, given the specified node's item ID.

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

Syntax

'Declaration
Public Overridable Function CreateBrowseObject ( _
    itemId As Integer, _
    autoBrowseObj As Object _
) As Object

public virtual Object CreateBrowseObject(
    int itemId,
    Object autoBrowseObj
)

public:
virtual Object^ CreateBrowseObject(
    int itemId, 
    Object^ autoBrowseObj
)

abstract CreateBrowseObject : 
        itemId:int * 
        autoBrowseObj:Object -> Object  
override CreateBrowseObject : 
        itemId:int * 
        autoBrowseObj:Object -> Object

public function CreateBrowseObject(
    itemId : int, 
    autoBrowseObj : Object
) : Object

Parameters

itemId
Type: System.Int32

An item ID specifying a node for which to create a custom browse object.

autoBrowseObj
Type: System.Object

A browse object automatically generated with information in the data view support XML, or nulla null reference (Nothing in Visual Basic) if the XML indicates that no such browse object should be generated. This allows an implementation of this method to specify most settings in XML and then provide only minor modification to the set of properties, rather than necessitating building the object from the beginning.

Return Value

Type: System.Object
An object representing the browse object for the specified node.

Implements

IVsDataViewBrowseObjectProvider.CreateBrowseObject(Int32, Object)

Remarks

Notes to Inheritors

The base implementation returns the autoBrowseObj parameter. The derived class should override this method.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via