Export (0) Print
Expand All
Expand Minimize

ParameterTextType Enumeration

Specifies parameter information for the method tip window.

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

public enum ParameterTextType

Member nameDescription
PTT_DECLARATIONFull declaration as it appears in signature (that is, "Long MyVariable" or "MyVariable As Long").
PTT_DESCRIPTIONDescription (gets its own line, and is prefixed with NAME: (bolded)).
PTT_NAMEParameter name only (that is, "MyVariable").

The value of GetParameterText can return null for any value except DECLARATION, or NAME if DESCRIPTION is not null. If a parameter description is returned to the view when it calls GetParameterText and specifies a value of PTT_DESCRIPTION, then the view will subsequently call GetParameterText and specify a value of PTT_NAME. The view then displays the name and description information in the following format:

  • Name: Description

COM Signature

From textmgr.idl:

© 2015 Microsoft