Partager via


MethodTextType Enum

Definition

Identifies different portions of the method tip to provide information on.

public enum class MethodTextType
public enum class MethodTextType
enum MethodTextType
public enum MethodTextType
type MethodTextType = 
Public Enum MethodTextType
Inheritance
MethodTextType

Fields

Name Value Description
MTT_TYPEPREFIX 0

Return type that is provided before the variable name in code. For example, the "Long" type in Visual C++, which is written as "Long MyVariable" in code.

MTT_TYPEPOSTFIX 1

Return type that is provided after the variable name in code. For example, the "Long" type in Visual Basic, which is written as "MyVariable AsLong" in code.

MTT_NAME 2

Method name.

MTT_DESCRIPTION 3

Description of method, which is provided its own line.

MTT_OPENBRACKET 4

Open bracket delimiter. Default value is a left parenthesis. To show nothing in the bracket location, return an empty string in GetMethodText(Int32, MethodTextType).

MTT_CLOSEBRACKET 5

Closed bracket delimiter. Default value is a right parenthesis. To show nothing in the bracket location, return an empty string in GetMethodText(Int32, MethodTextType).

MTT_DELIMITER 6

Parameter delimiter. default is ", ". You must specify the space if you want it included in your delimiter string.

Remarks

The view calls GetMethodText with both MTT_TYPEPREFIX and MTT_TYPEPOSTFIX. Return E_FAIL or E_NOTIMPL for the option that you do not implement. GetMethodText can return null for any of MethodTextType values except MTT_NAME. Any values that are null or an empty string, in the case of MTT_OPENBRACKET and MTT_CLOSEBRACKET, are not displayed. The return format is as follows: [TYPEPREFIX] [NAME] ( <parameters> ) [TYPEPOSTFIX] [DESCRIPTION].

COM Signature

From textmgr.idl:

Applies to