Share via


DictField.helpDefined Method

Returns the value of the help property for the field.

Syntax

public str helpDefined()

Run On

Called

Return Value

Type: str
The value of the help property for the field.

Remarks

Unlike the help method, the helpDefined method does not return the Help text of the extended data type if the field is based on an extended data type and has no Help text defined for it.

Examples

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

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

See Also

DictField Class

DictField.help Method