Share via


DictType.help Method

Provides the Help text that is displayed for an extended data type or a specified array element, or for the extended data type that an extended data type extends.

Syntax

public str help([int arrayIndex, boolean useInterfaceLanguage])

Run On

Called

Parameters

  • arrayIndex
    Type: int
  • useInterfaceLanguage
    Type: boolean
    A Boolean value that indicates whether the user interface language is used for the Help text; optional.

Return Value

Type: str
A string value for the Help text that is displayed for the extended data type, or for an array element if the arrayEntry value is provided. The Help text corresponds to the Help Text property for an extended data type or array element in the Microsoft Dynamics AX Application Object Tree (AOT).
When an extended data type does not have Help text, the method returns the Help text that is defined for the extended data type that the extended data type extends.

See Also

DictType Class

DictType.helpDefined Method