VSOBDESCRIPTIONSECTION Enum

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public enum class VSOBDESCRIPTIONSECTION

public enum class VSOBDESCRIPTIONSECTION

enum VSOBDESCRIPTIONSECTION

public enum VSOBDESCRIPTIONSECTION

type VSOBDESCRIPTIONSECTION = 

Public Enum VSOBDESCRIPTIONSECTION

Inheritance

Enum

VSOBDESCRIPTIONSECTION

Fields

Name	Value	Description
OBDS_MISC	0	Specifies that the text is miscellaneous text added to the description.
OBDS_NAME	1	Specifies that the text is the name of the object.
OBDS_PARAM	2	Specifies that the text is a function parameter.
OBDS_TYPE	3	Specifies that the text describes the object's or parameter's type.
OBDS_ATTRIBUTE	4	Specifies that the text is a COM/ .NET attribute.
OBDS_ENDDECL	5	Specifies the end of the declaration portion of the description text.
OBDS_COMMA	6	Specifies that a comma is to be inserted.
OBDS_ENABLEHELP	7	Call AddDescriptionText(String, VSOBDESCRIPTIONSECTION, VSOBJECTINFO[]) ( null, OBDS_ENABLEHELP, null) to enable help on the list item. This will cause your ShowHelp(UInt32) method to be called when the user presses F1.
OBDS_ENABLEGOTOSOURCE	8	Obsolete. Do not use.
OBDS_NOTIFYONLY	9	Obsolete. Do not use.
OBDS_ENDDECLEXPECTHTML	10	Obsolete. Do not use.

Remarks

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	null
MyFunction	OBDS_NAME	null
(	OBDS_MISC	null
CSTRING &	OBDS_TYPE	VSOBJECTINFO for CSTRING
string	OBDS_PARAM	null
BOOL	OBDS_TYPE	null
fMyFlag	OBDS_PARAM	null
MYTYPE	OBDS_TYPE	VSOBJECTINFO for MYTYPE
mtValue	OBDS_PARAM	null
)	OBDS_MISC	null
null	OBDS_ENDDECL	null
\n Member of	OBDS_MISC	null
Namespace1	OBDS_NAME	VSOBJECTINFO for Namespace1
.	OBDS_MISC	null
CMyClass	OBDS_NAME	VSOBJECTINFO for CMyClass
\n	OBDS_MISC	null
==== This is a great function ===	OBDS_MISC	null

COM Signature

From vsshell.idl: