Function

a!richTextHeader( text, size, link, linkStyle, showWhen )

Displays heading-styled text within a rich text component.

See also: Rich text style guidance

Parameters

Name	Keyword	Types	Description
Text	text	Text or Styled Text	Array of text to display as a rich text item.
Size	size	Text	Determines the text size. Valid values: "ICON" (default), "TINY", "GALLERY", "SMALL", "MEDIUM", and "LARGE".
Link	link	Link	Link to apply to the text. Create links with: a!authorizationLink() a!documentDownloadLink() a!dynamicLink() a!newsEntryLink() a!processTaskLink() a!recordLink() a!reportLink() a!startProcessLink() a!submitLink() a!userRecordLink() a!safeLink()
Link Style	linkStyle	Text	Determines how the link is underlined. Valid values: "INLINE" (default), "STANDALONE".
Visibility	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.

Usage considerations

Using the text and link parameters

• If text is null or contains an empty array, no text is displayed.
• If link is null, the text is not displayed as a link.

Header text and grids

• While rich text components can be placed inside a grid layout, header styles are not supported within a grid layout.

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Use the interactive editor below to test out your code:

Related Patterns

The following patterns include usage of the Header Text Component.

• Comments Patterns (Comments, Looping): Use this pattern when displaying a chronological list of messages from different users, such as comments on a topic or notes on a case.

• Grid with Selection Pattern (Grids): This pattern is an example of good UX design for a grid that allows users to select items and easily view their selections when there are multiple pages of data. It also provides information on a common save behavior.

• Inline Survey (Radio Buttons, Checkboxes, Buttons): Use this pattern to create a clean and easy to navigate survey.

• Percentage of Online Sales (Records, Reports, Formatting): This pattern illustrates how to calculate the percent of sales generated from online orders and display it in a gauge component.

• User List Pattern (Looping): The user list pattern retrieves all the users in a specified group and displays them in a single column.

• Year-Over-Year Report (Charts, Reports, Formatting): This is a feature-rich, interactive report for sales and profits by products over select periods of time.