InstructionalText Property
Version: Available or changed with runtime version 1.0.
Sets the string used for instructions in the UI.
Applies to
- Page
- Request Page
- Page Field
- Page Group
Parameters
Locked
Type: Boolean
If true the InstructionalText is locked and should not be translated.
Comment
Type: Text
Descriptive text for the InstructionalText, for example, with regards to translation.
MaxLength
Type: Integer
Sets the maximum length of the specific InstructionalText.
Remarks
The default is an empty string, which means there are no instructions. According to the user assistance model for Business Central, apps are expected to apply instructional text, also called placeholder text, to setup guides and similar pages.
Note
The InstructionalText property can be applied to Text, BigText, Guid, and Code data type fields.
The following example illustrates how you can apply placeholder text in an app:
InstructionalText = 'Add an entity from your list of contacts. The entity can be a person or a company.';
Or, with the parameters:
InstructionalText = 'Add an entity from your list of contacts. The entity can be a person or a company.', Locked = true, Comment = 'Keep like this, do not translate.', MaxLength = 100;
The InstructionalText property on a page field should provide an example value or a short summary of the field's purpose to guide the user towards entering the expected value.