ParameterTextType Enum

Definition

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
ParameterTextType

Fields

Name Value Description
PTT_DECLARATION 0

Full declaration as it appears in signature (that is, "Long MyVariable" or "MyVariable As Long").

PTT_NAME 1

Parameter name only (that is, "MyVariable").

PTT_DESCRIPTION 2

Description (gets its own line, and is prefixed with NAME: (bolded)).

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