You are here: User interface > User interface rules > Harness and section forms > Rich Text Editor Properties - General tab

Rich Text Editor control Properties — General tab

Click the View properties icon in the layout containing the rich text editor control (pxRichTextEditor) to display the Properties panel, then select the General tab.

Field

Description

Property

Press the down arrow to select a property, the value of which will be set by the rich text editor.

For Single Value properties in the Applies to class (or higher) of the current rule, you can drag a property name into the cell from the list of properties visible in the Application Explorer. If the container that holds this field has a non-blank Using Page value, you can drag a Single Value property from within that embedded page property.

Click the Open icon to review the property (if the reference is to an existing property in the Applies To class of this rule or a parent of that class). If the property is not found, the New dialog box for the property form appears.

You can reference properties on any page identified on the Pages & Classes tab, using the normal notation pagename.propertyname for pages other than the page corresponding to the Applies To class of the rule.

If this field is in a cell of a section that includes parameter declarations on the Parameters tab, you can enter the notation param.NAME here to use a parameter value for the field, where NAME identifies a string parameter. Make sure that the NAME parameter is declared on the Parameters tab, and that your application provides a non-blank value for the parameter value in all possible situations where the section appears. See Sections — Completing the Parameter tab.

Default value

Optional. Enter a constant value for the property value, a property reference, or an expression, to be used only when the user form or flow action form appears in read-write mode rather than read-only mode.

Choose a default value that speeds data entry. When the system renders a harness or section in read-only mode (for example because the read-write mode requires a privilege that the current user does not hold), the default value does not appear, because data entry is not permitted.

Visibility

Select one of the following to determine when the control appears:

  • Always, If Not Blank, or If Not Zero to have the field appear or be hidden based on the property value at the time this area of the user form (section or flow action) is first presented or refreshed. This condition is checked only once.
    • Choose Always,This condition is checked only once.
    • Choose Other Condition to make the visibility depend on a when condition rule or a Java expression.
  • Condition (expression) or Condition (when rule) to make the visibility depend on a when condition rule, a Boolean expression evaluated only once, or a test evaluated repeatedly upon JavaScript events.
Condition

If you selected Other Condition in the Visibility field, complete this field.

  • The When Name key part of a when condition rule. Click the Open icon to review or create the rule.
  • Expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.

As a best practice, use the Condition Builder to edit this field. Click the Open condition builder icon to open the tool. See Using the Condition Builder to configure dynamic UI actions.

Required Appears only for fields in cells on flow actions and sections. Select to require that when the form appears at runtime in read-write mode, users cannot successfully submit the form if the field is blank.
Selecting Required marks the label for this field with an orange asterisk when the flow action form appears in read-write mode. (The asterisk also appears if the Label control's Value For field is not blank and the Label control's Required box is checked.)
For sections, checking this box enables client-side format validation when this section is part of a harness form that has the Enable Client Side Validation box selected on the HTML tab. At runtime, users who leave this field blank and submit the form are notified immediately that the field is required; the form is not transmitted to the server.
Use line-break for new line (not recomended) Enable this option to allow the use of the line break (<br/>) instead of the auto-paragraph (<p></p>). For new rich text editors, the auto-paragraph is the default, and the check box is clear. For existing rich text editors, this should be checked by default. Using the auto-paragraph is the best practice and using the line break is not recommended.
Toolbar Options

Select check boxes, as desired, to display options in the rich text editor toolbar at runtime:

  • Increase/decrease indent
  • Undo/Redo
  • Copy/Paste
  • Alignment
  • Spell Checking
  • Maximize
  • Table
  • Image

These options appear only after you save the section when you preview or run it.