ParameterTextType Enum

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies parameter information for the method tip window.

public enum class ParameterTextType

public enum class ParameterTextType

enum ParameterTextType

public enum ParameterTextType

type ParameterTextType =

Public Enum ParameterTextType

Inheritance: Enum
ParameterTextType

Fields

PTT_DECLARATION	0	Full declaration as it appears in signature (that is, "Long MyVariable" or "MyVariable As Long").
PTT_DESCRIPTION	2	Description (gets its own line, and is prefixed with NAME: (bolded)).
PTT_NAME	1	Parameter name only (that is, "MyVariable").

Remarks

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:

Applies to