Rich Text Image

On This Page

SAIL Design System guidance available for Rich Text

Enhance readability and comprehension on your interface by using rich text formatting to visually differentiate text.

Function

a!richTextImage( image, showWhen )

Displays an icon-sized image within a rich text display component. To show icons within rich text, see Rich Text Icon.

See also: Rich text style guidance

Parameters

Name	Keyword	Types	Description
Image	image	Image	Required image to display in the node, created with a!documentImage(),a!userImage(), and a!webImage().
Show When	showWhen	Boolean	Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Examples

To experiment with examples, copy and paste the expression into an interface object.

Inline icons

a!richTextDisplayField(
  labelPosition: "COLLAPSED",
  value: {
    "Happy Face ",
    a!richTextImage(
      image: a!documentImage(
        document: a!iconIndicator(
          icon: "FACE_HAPPY"
        )
      )
    ),
    "Indifferent Face ",
    a!richTextImage(
      image: a!documentImage(
        document: a!iconIndicator(
          icon: "FACE_INDIFFERENT"
        )
      )
    ),
    "Sad Face ",
    a!richTextImage(
      image: a!documentImage(
        document: a!iconIndicator(
          icon: "FACE_SAD"
        )
      )
    )
  }
)

Displays the following:

screenshot of icons in embedded in a line of text

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Interfaces	Compatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.
Process Autoscaling	Incompatible	Cannot be used in autoscaled processes.
Event Consumer Filter Conditions	Compatible	Can be used in filter conditions.
Event Consumer Event Handlers	Compatible	Can be used in event handler expressions.

The following recipes include usage of the Rich Text Image.

Refresh Until a Background Action Completes (Auto-Refresh):
Use a refresh interval to display the results of a background action automatically.

Feedback

Was this page helpful?