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)
Syntax
'Declaration
Public Enumeration VSOBDESCRIPTIONSECTION
public enum VSOBDESCRIPTIONSECTION
public enum class VSOBDESCRIPTIONSECTION
type VSOBDESCRIPTIONSECTION
public enum VSOBDESCRIPTIONSECTION
Members
| Member name | Description | |
|---|---|---|
| OBDS_MISC | Specifies that the text is miscellaneous text added to the description. | |
| OBDS_NAME | Specifies that the text is the name of the object. | |
| OBDS_PARAM | Specifies that the text is a function parameter. | |
| OBDS_TYPE | Specifies that the text describes the object's or parameter's type. | |
| OBDS_ATTRIBUTE | Specifies that the text is a COM/ .NET attribute. | |
| OBDS_ENDDECL | Specifies the end of the declaration portion of the description text. | |
| OBDS_COMMA | Specifies that a comma is to be inserted. | |
| OBDS_ENABLEHELP | Call AddDescriptionText ( nulla null reference (Nothing in Visual Basic), OBDS_ENABLEHELP, null) to enable help on the list item. This will cause your ShowHelp method to be called when the user presses F1. | |
| OBDS_ENABLEGOTOSOURCE | Obsolete. Do not use. | |
| OBDS_NOTIFYONLY | Obsolete. Do not use. | |
| OBDS_ENDDECLEXPECTHTML | 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 |
nulla null reference (Nothing in Visual Basic) |
MyFunction |
OBDS_NAME |
nulla null reference (Nothing in Visual Basic) |
( |
OBDS_MISC |
nulla null reference (Nothing in Visual Basic) |
CSTRING & |
OBDS_TYPE |
VSOBJECTINFO for CSTRING |
string |
OBDS_PARAM |
nulla null reference (Nothing in Visual Basic) |
BOOL |
OBDS_TYPE |
nulla null reference (Nothing in Visual Basic) |
fMyFlag |
OBDS_PARAM |
nulla null reference (Nothing in Visual Basic) |
MYTYPE |
OBDS_TYPE |
VSOBJECTINFO for MYTYPE |
mtValue |
OBDS_PARAM |
nulla null reference (Nothing in Visual Basic) |
) |
OBDS_MISC |
nulla null reference (Nothing in Visual Basic) |
nulla null reference (Nothing in Visual Basic) |
OBDS_ENDDECL |
nulla null reference (Nothing in Visual Basic) |
\n Member of |
OBDS_MISC |
nulla null reference (Nothing in Visual Basic) |
Namespace1 |
OBDS_NAME |
VSOBJECTINFO for Namespace1 |
. |
OBDS_MISC |
nulla null reference (Nothing in Visual Basic) |
CMyClass |
OBDS_NAME |
VSOBJECTINFO for CMyClass |
\n |
OBDS_MISC |
nulla null reference (Nothing in Visual Basic) |
==== This is a great function === |
OBDS_MISC |
nulla null reference (Nothing in Visual Basic) |
COM Signature
From vsshell.idl: