IVsObjectList.FillDescription Method

  • Article

Asks the list item to provide description text to be used in the object browser.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function FillDescription ( _
    index As UInteger, _
    grfOptions As UInteger, _
    pobDesc As IVsObjectBrowserDescription2 _
) As Integer

int FillDescription(
    uint index,
    uint grfOptions,
    IVsObjectBrowserDescription2 pobDesc
)

int FillDescription(
    [InAttribute] unsigned int index, 
    [InAttribute] unsigned int grfOptions, 
    [InAttribute] IVsObjectBrowserDescription2^ pobDesc
)

abstract FillDescription : 
        index:uint32 * 
        grfOptions:uint32 * 
        pobDesc:IVsObjectBrowserDescription2 -> int

function FillDescription(
    index : uint, 
    grfOptions : uint, 
    pobDesc : IVsObjectBrowserDescription2
) : int

Parameters

  • index
    Type: System.UInt32

    [in] Specifies the index of the list item of interest.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsObjectList::FillDescription(
   [in] ULONG Index,
   [in] VSOBJDESCOPTIONS grfOptions,
   [in] IVsObjectBrowserDescription2 *pobDesc
);

When an object is selected in the Object Browser, a description of the object appears in the lower pane (Description Pane) of the window. The description text is built through a series of calls to AddDescriptionText3. The environment will call FillDescription for the index item of interest. The call passes in an IVsObjectBrowserDescription3 interface. This is similar to an IStream interface in that you repeatedly call AddDescriptionText3 to write your description as a series of elements. The elements are identified with the VSOBDESCRIPTIONSECTION enumeration.

The environment can specify, through grfOptions, that you should return the fully qualified name of the Index item.

This method also used as an alternate means of providing tool tip text on the item's icon in the code browsing tools. In this scenario the environment will initially call GetTipText on the Index item. If you return E_NOTIMPL or fail the call, the environment then calls FillDescription with grfOptions set to ODO_TOOLTIPDESC | ODO_USEFULLNAME.

.NET Framework Security

See Also

Reference

IVsObjectList Interface

Microsoft.VisualStudio.Shell.Interop Namespace