RichText Object

Here are the object's settings as they appear on the "double-click" Properties dialog.

There are three tabs on the Properties dialog:

Settings

Attributes

Script

Settings Tab

Object

Text:

The Rich Text (RTF format) you want to display in the RichText object.

Bold

Make the text bolded.

Italic

Make the text italic.

Underline

Underline the text.

Bullets

Make the text bulleted.

Font

The font that you want to use for the text. Click the select button to choose a different font.

Font color

The color you want to use for the text.

Font size

The font size to use for the text.

Edit font

Open the Font dialog where you can edit all of the font settings.

Paragraph

Opens the Paragraph dialog where you can specify the indentation and alignment of the paragraph text.

Load RTF file

Opens a browse dialog where you can select a Rich Text (RTF) file to load into the object.

Scrollbars

Vertical scrollbar

Include a vertical scroll bar for the text if the amount of text to be displayed exceeds the vertical visible area. If unchecked, and text exceeding the area will be cut off.

Horizontal scrollbar

Include a horizontal scroll bar for the text if the amount of text to be displayed exceeds the horizontal visible area. If unchecked, any text exceeding the horizontal area will wrap to the next line.

Background Style

Solid

The background color for the object. You can click the select button to bring up a color chooser.

Tip: Clicking the "More Colors..." button on the color menu allows you to choose either a standard color/custom color, or use the eyedropper to pick a color from somewhere within the AutoPlay application window.

Transparent

Make the background of the object transparent.

Special

Border mode:

The type of border to display around the object. Choose from:

None

Don't display any border around the object.

Sunken

The object will have a "sunken" appearance on the page or dialog.

Read order:

The order the text will display when typed into the object. Choose from:

Standard

Display the text normally, from left to right.

Right to Left

If the shell language is Hebrew, Arabic, or another language that supports reading-order alignment, the text is displayed using right-to-left reading-order properties. For other languages, this style is ignored.

Read-only

Make the text in the object read-only so the user cannot type into it. This means the user can copy the text, but cannot modify it.

Auto-detect URL

Automatically detect URLs in the object text. This means URLs will be shown as hyperlinks and will fire the RichText object's On Link event when they are clicked on.

Show context menu

Show a right-click context menu in the object with features such as "Cut," "Copy" and "Paste."

Attributes Tab

Identification

Object name:

The name that is used to identify this object.

State

Enabled

Enable the object so it responds to user interaction. When an object is disabled, it will not respond to any mouse overs or clicks and will not perform any actions until it is enabled.

Note: You can use the RichText.SetEnabled action to enable this object.

Visible

Set the object's initial visibility (whether it's visible when the page or dialog is displayed).

Note: You can use the RichText.SetVisible action to make the object visible or invisible at run time.

Auto-Resize

Left

If checked, the left side of the object will move when the application is resized. If unchecked, the left side of the object will not move.

Right

If checked, the right side of the object will move when the application is resized. If unchecked, the right side of the object will not move.

Top

If checked, the top of the object will move when the application is resized. If unchecked, the top of the object will not move.

Bottom

If checked, the bottom of the object will move when the application is resized. If unchecked, the bottom of the object will not move.

Position

Left:

The distance in pixels from the left edge of the object to the left edge of the page or dialog.

Tip: You can also change the position of an object by dragging it or using the arrow keys.

Top:

The distance in pixels from the top edge of the object to the top edge of the page or dialog.

Width:

The width of the object in pixels.

Tip: You can also resize an object by dragging one of the resize handles on its bounding box.

Height:

The height of the object in pixels.

Restore Original

Sets the object's size back to the original values (not available for the RichText object.)

Feedback

Tooltip:

A short string of text that will appear after the mouse hovers over this object for a moment.

Tip: You can choose from several tooltip styles for all tooltips in your project, Standard, Balloon and Extended. This setting can be found on the Appearance tab of the Project > Settings.

Tip: If you want a newline in your tooltip text, use "\r\n". For example, for an Extended tooltip, "My First Line\r\nMy Second Line|My Title". Newlines are not supported in the Title text for Balloon or Extended styles.

Tip: If you want a "&" character in the text, you must enter "&&&".

Spelling

Check the spelling of the tooltip text.

Cursor:

The mouse pointer that will be used while the mouse is over this object (not available for the RichText object.)

Script Tab

You can use the action editor on this tab to edit the script of actions that will be performed on each of this object's events.

This object supports the following events:

On Key

The actions that will be performed whenever the richtext object has focus and the user presses a key.

The following event variables are automatically set whenever this event is triggered:

e_Key

(number) The virtual key code of the key that was pressed.

e_Modifiers

(table) A table containing three boolean values that describe which modifier keys were held down while the key was pressed. A modifier key is a key that can be held down while another key is pressed, to "modify" it.

There are three true/false values in the table, one for each type of modifier key on the keyboard: shift, ctrl, and alt. You can access these values as e_Modifiers.shift, e_Modifiers.ctrl, and e_Modifiers.alt.

On Focus

The actions that will be performed whenever the richtext object is given focus. For example, it will be given focus if the user clicks inside the object.

On Link

The actions that will be performed when the user clicks on a link in the richtext object.

Note: To use this event, you must have the Auto-detect URL feature enabled.

The following event variables are automatically set whenever this event is triggered:

e_Min

(number) The 1-based character index where the link's text begins.

e_Max

(number) The 1-based character index where the link's text ends.

e_Link

(string) The text of the link that was clicked.

On Selection Changed

The actions that will be performed when the selection changes in the richtext object.

The following event variables are automatically set whenever this event is triggered:

e_Min

(number) The 1-based character index of the start of the selection.

e_Max

(number) The 1-based character index of the end of the selection.