HTML Viewer control

Use this control to add an HTML Viewer that enables users to view the HTML created using the HTML Editor.

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

To place an HTML Viewer on a form, click HTML Viewer and then click the form.
Be sure to put the name of the database field or variable that you want to associate with this control into the Input property.

Warning: Keep in mind that text you copy and paste from other sources may contain formatting tags, even if it looks like plain text.

Property	Usage
Accessible Description	Specify a component description for use with accessibility software. (Optional) Note: This function is only supported by the Web client. If no description is present, the Web client defaults to looking for a nearby label to use for the name of the component. For buttons, check boxes, or radio buttons, the Web client will use the component’s text. Accessibility software can query the Web client to get this information, and use it to present it to the user in a variety of ways. For example, when a component gets focus, speech simulation software will say the name and the type of component, based on the settings in the Accessible Name and Accessible Description fields.
Height	Specify the height of the object in alignment grid units.
HTML-Generating Script	A Javascript function that generates the content for the HTML Viewer. For example, open the form "configurationItem" in Forms Designer. On the "CI Changes" notebook page there is an HTML Viewer which has "configurationManagement.getPendingChanges" for that property. To see this function, type SL in the command line, and then type configurationManagement in the Name field. Click Search, and then scroll down. You will see the "getPendingChanges" function.
Input	Specify the database field or variable to associate with this control.
Name	Specify a unique identifier for the object on the screen. (Optional) This name is used by external applications, such as RAD, to dynamically change the properties of the object.
Tab Stop	Specify the tab sort order for this field. By default, the TAB key navigates the focus on a form from top to bottom and left to right. Objects that have a non-zero Tab Stop are visited first, in ascending order. For a button, file, radio button or check box, you will almost always use the default of 0.
Use client styling	Select this option to display an HTML snippet. The viewer will display the text respecting the font, font size, margins and background color set in the client. A fully defined HTML document may not display correctly. Note: Mark the checkbox for Service Catalog. Clear the checkbox to display a fully defined HTML document. A fully defined HTML document contains <html><head></head><body></body></html>. If the input does not contain any HTML formatting it will display plain text. Note: Clear the checkbox for Knowledge Management.
Visible	Select this option to make the object visible on the form. Clear the check box to hide the object from view on the form.
Visible Condition	Specify an expression to override the Visible property when that expression evaluates to true.
Width	Specify the width of the object in alignment grid units.
X	Specify the object’s horizontal position based on the left edge of the object.
Y	Specify the object’s vertical position based on the top edge of the object.
Frameborder	Specify whether a border is displayed around the HTML viewer. If you do not specify anything or enter 1, a border is displayed. If you enter 0, there is no border.
Standards Mode	Select this option if you want the web browser to render the HTML document in Standards Mode. When this option is selected, a DOCTYPE is added to the beginning of the document.

Property

Usage

Accessible Description

Specify a component description for use with accessibility software. (Optional)

Note: This function is only supported by the Web client.

If no description is present, the Web client defaults to looking for a nearby label to use for the name of the component. For buttons, check boxes, or radio buttons, the Web client will use the component’s text. Accessibility software can query the Web client to get this information, and use it to present it to the user in a variety of ways. For example, when a component gets focus, speech simulation software will say the name and the type of component, based on the settings in the Accessible Name and Accessible Description fields.

Height

Specify the height of the object in alignment grid units.

HTML-Generating Script

A Javascript function that generates the content for the HTML Viewer. For example, open the form "configurationItem" in Forms Designer. On the "CI Changes" notebook page there is an HTML Viewer which has "configurationManagement.getPendingChanges" for that property. To see this function, type SL in the command line, and then type configurationManagement in the Name field. Click Search, and then scroll down. You will see the "getPendingChanges" function.

Input

Specify the database field or variable to associate with this control.

Name

Specify a unique identifier for the object on the screen. (Optional)

This name is used by external applications, such as RAD, to dynamically change the properties of the object.

Tab Stop

Specify the tab sort order for this field. By default, the TAB key navigates the focus on a form from top to bottom and left to right. Objects that have a non-zero Tab Stop are visited first, in ascending order. For a button, file, radio button or check box, you will almost always use the default of 0.

Use client styling

Select this option to display an HTML snippet.
The viewer will display the text respecting the font, font size, margins and background color set in the client. A fully defined HTML document may not display correctly.

Note: Mark the checkbox for Service Catalog.

Clear the checkbox to display a fully defined HTML document. A fully defined HTML document contains <html><head></head><body></body></html>. If the input does not contain any HTML formatting it will display plain text.

Note: Clear the checkbox for Knowledge Management.

Visible

Select this option to make the object visible on the form. Clear the check box to hide the object from view on the form.

Visible Condition

Specify an expression to override the Visible property when that expression evaluates to true.

Width

Specify the width of the object in alignment grid units.

Specify the object’s horizontal position based on the left edge of the object.

Specify the object’s vertical position based on the top edge of the object.

Frameborder

Specify whether a border is displayed around the HTML viewer. If you do not specify anything or enter 1, a border is displayed. If you enter 0, there is no border.

Standards Mode

Select this option if you want the web browser to render the HTML document in Standards Mode. When this option is selected, a DOCTYPE is added to the beginning of the document.

Related concepts

Related tasks

Related references