DictField.help Method [AX 2012]

Returns the Help text that is displayed for the field.

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

Run On

Called

Parameters

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

Return Value

Type: str
The Help text or inherited Help text for the field.

If no Help text is defined for the field, this method returns the Help text for the extended data type that is used for the field, if applicable. If an array entry is specified, this method returns the Help text for the array element.

The following example shows retrieval of the Help text for the field.

DictField df; 
 
df = new DictField(tablenum(CustTable), fieldnum(CustTable, AccountNum)); 
 
if (df) 
{ 
 
    print df.help(); 
}

Community Additions

ADD
Show: