VSOBDESCRIPTIONSECTION Enumeration
TOC
Collapse the table of content
Expand the table of content
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

VSOBDESCRIPTIONSECTION Enumeration

Specifies the element of an object browser item description text string.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

public enum VSOBDESCRIPTIONSECTION
public enum VSOBDESCRIPTIONSECTION
public enum VSOBDESCRIPTIONSECTION

 Member nameDescription
OBDS_ATTRIBUTESpecifies that the text is a COM/ .NET attribute. 
OBDS_COMMASpecifies that a comma is to be inserted. 
OBDS_ENABLEGOTOSOURCEObsolete. Do not use. 
OBDS_ENABLEHELPCall AddDescriptionText ( a null reference (Nothing in Visual Basic), OBDS_ENABLEHELP,a null reference (Nothing in Visual Basic)) to enable help on the list item. This will cause your ShowHelp method to be called when the user presses F1
OBDS_ENDDECLSpecifies the end of the declaration portion of the description text. 
OBDS_ENDDECLEXPECTHTMLObsolete. Do not use. 
OBDS_MISCSpecifies that the text is miscellaneous text added to the description. 
OBDS_NAMESpecifies that the text is the name of the object. 
OBDS_NOTIFYONLYObsolete. Do not use. 
OBDS_PARAMSpecifies that the text is a function parameter. 
OBDS_TYPESpecifies that the text describes the object's or parameter's type. 

When an object is selected in the object browser, a description of the object appears in the lower pane of the window. The description text is built through a series of calls to AddDescriptionText. The environment will call your FillDescription method for the object list item of interest. The call passes in an IVsObjectBrowserDescription2 interface. You make multiple calls to the methods in the passed in interface to build up the various sections of the description text. The sections are identified with elements of the VSOBDESCRIPTIONSECTION enumeration. The environment takes care of formatting the text based on the description section.

If an item is listed in the description pane as:

int MyFunction ( CSTRING &string, BOOLfMyFlag, MYTYPEmtValue )

   Member of Namespace1.CMyClass

   ==== This is a great function ===

The following relationships apply:

Description text

VSOBDESCRIPTIONSECTION element

Hyper Jump Specified

int

OBDS_TYPE

a null reference (Nothing in Visual Basic)

MyFunction

OBDS_NAME

a null reference (Nothing in Visual Basic)

(

OBDS_MISC

a null reference (Nothing in Visual Basic)

CSTRING &

OBDS_TYPE

VSOBJECTINFO for CSTRING

string

OBDS_PARAM

a null reference (Nothing in Visual Basic)

BOOL

OBDS_TYPE

a null reference (Nothing in Visual Basic)

fMyFlag

OBDS_PARAM

a null reference (Nothing in Visual Basic)

MYTYPE

OBDS_TYPE

VSOBJECTINFO for MYTYPE

mtValue

OBDS_PARAM

a null reference (Nothing in Visual Basic)

)

OBDS_MISC

a null reference (Nothing in Visual Basic)

a null reference (Nothing in Visual Basic)

OBDS_ENDDECL

a null reference (Nothing in Visual Basic)

\n  Member of

OBDS_MISC

a null reference (Nothing in Visual Basic)

Namespace1

OBDS_NAME

VSOBJECTINFO for Namespace1

.

OBDS_MISC

a null reference (Nothing in Visual Basic)

CMyClass

OBDS_NAME

VSOBJECTINFO for CMyClass

\n

OBDS_MISC

a null reference (Nothing in Visual Basic)

==== This is a great function ===

OBDS_MISC

a null reference (Nothing in Visual Basic)

COM Signature

From vsshell.idl:

Show:
© 2016 Microsoft