GetFieldHelpText
Description
Returns the Help Text information for a given field in a record type.
In HCL Compass Designer, for any given field, you can right-click the field name and select Field Properties. You can use the GetFieldHelpText method to retrieve the contents found on the Help Text tab.
The return value is a String containing the content on the Help Text tab. If there is no Help Text content, the method returns an empty string.
Syntax
VBScript
entitydef.GetFieldHelpText field_name
Perl
$entitydef->GetFieldHelpText(field_name);
- Identifier
- Description
- entitydef
- An EntityDef object corresponding to a record type in a schema.
- field_name
- A String that identifies a valid field name in the EntityDef.
- Return value
- Returns a String containing the field Help Text found in the Field Properties in the Designer.