Guide Properties view

In the Guide Properties view, specify properties for a Guide, and for each section and panel in a Guide. Different properties appear depending on what you select in the Guide Tree view or editor. Guides, sections, panels, and fields all have different properties.

Binding items in the Data Model view

In the Guide Properties view, you can bind several properties to an item in the Data Model view. These properties have a binding icon next to the property name. You can bind a property to data such as titles, captions, or Help instead of retyping it in the property. Binding data items also enables you to use rules that you added in the Data Model view or to provide data based on user input.

To bind a property to an item in the Data Model view, drag the item from the Data Model view onto a binding icon in the Guide Properties view.

When a property has a binding, the binding icon becomes active .

Note: When the Guide is based on an XDP form, do not use the ID property in the Data Model view for bindings.

Selecting Guide and panel layouts

You can select a layout for each Guide. Guide layouts specify the type of navigation control that the Guide uses. Guide layouts also specify the placement of the navigation hierarchy, Guide Help text, and data entry regions within the Guide.

You can select a layout for each data entry panel in your Guide. The panel layouts control how the controls flow on a single data entry panel.

Use repeater layouts to display repeating data inside a single panel. For example, to display the data for a data collection, which typically have more than one instance, you can use a RepeaterTab, RepeaterAccordion, RepeaterGrid. In the Guide Properties view, in the Repeat Based On property, select the collection that is the data provider for the repeating data.

Select a Guide layout

  1. In the Guide Tree view, select the Guide container.

  2. If the Guide Properties view is not displayed, click Window > Show View > Guide Properties.

  3. In the Guide Properties view, select a layout from the Guide Layout list.

Note: You can create custom Guide layouts in Flash® Builder™ and import the layouts into your Guide. You must have Flex SDK 3.4.1 installed to create a custom Guide layout.

Select a panel layout

  1. In the Guide Tree view, select a Panel.

  2. If the Guide Properties view is not displayed, click Window > Show View > Guide Properties.

  3. In the Guide Properties view, select a panel layout from the Layout list.

Note: You can create custom panel layouts in Flash Builder and import the layouts into your Guide. You must have Flex SDK 3.4.1 installed to create custom panel layouts.

Guide properties

In the Guide Properties view, specify properties that affect the entire Guide, such as the effects and transitions, the submit method, and any Guide Help.

Note: Guide fillers submit their data, either electronically or by paper copy, according to the submission method defined for the Guide.

When you select a Guide in the Guide Tree view, the Guide Properties view displays several Guide-level properties:

Guide title:
The name of the Guide.

Guide extensions:
(Optional) Specifies compiled Flex Library project SWC files that contain custom Guide components, such as Guide layouts, panel layouts, or controls. You can add multiple SWC files to each Guide. For more information about using Guide extensions, see Customizing Guides Using Flash Builder .

Guide layout:
Specifies the layout to associate with the Guide. You can customize the Guide layouts or create your own. The source code is provided in the Guides SDK.

For information about creating custom Guide layouts, see Creating Guide Layouts .

Several Guide layouts are available:

Button Bar:
Uses a new button for each section you create in the Guide Tree view. When a Guide filler clicks a button, the first panel within that section is displayed with the current panel name as the title. The Button Bar Guide layout is designed to handle sections that contain only one panel. If a section has more than one panel, Guide fillers must use navigation controls, such as Previous and Next buttons, to navigate between panels.

Cobalt Bar:
Uses a new button for each section you create in the Guide tree. When a Guide filler clicks a button, the first panel within that section is displayed with the current panel name as the title. By default, the Cobalt Bar Guide layout is designed to handle sections that contain only one panel. If a section has more than one panel, Guide fillers must use navigation controls such as Previous and Next buttons to navigate between panels.

Cobalt Standard:
(Default) Displays the first two levels of the Guide tree. Each section name within the Guide tree appears as a label in the navigator. When selected, the section expands to display the contained panel names. This Guide layout is designed to handle sections that contain more panels. However, the visible area for each panel is smaller than for other Guide layouts. The Cobalt Standard layout also uses the Help center panel to display both Guide-level and panel-level Help in the same centralized region of the layout.

Cobalt Tree:
Displays all active sections and panels, including nested sections, based on the Guide tree that you create in the Guide Tree view. The sections and panels are displayed in a tree structure, and Guide fillers can expand and collapse sections to show or hide panel information. This Guide layout is designed to display the Guide tree exactly as it appears in the Guide Tree view. It is the only Guide layout that displays nested sections in the navigation panel. It also uses the Help center panel to display both Guide-level and panel-level Help in the same part of the Guide layout.

Left Accordion:
Displays the first two levels of the Guide tree that is created in the Guide Tree view. Each section name within the Guide tree is displayed as a label for each accordion pane. When selected, each accordion pane expands to display entries for each of the first level of active panels within the section. This Guide layout is designed to handle sections that contain more panels, but the visible area for each panel is smaller.

Left Multilevel:
Displays all active sections and panels, including nested sections, based on the Guide tree that is created in the Guide Tree view. The sections and panels are displayed as a tree structure, and Guide fillers can expand and collapse sections to show or hide panel information. This Guide layout is designed to display the Guide tree exactly as it appears in the Guide Tree view.

Workspace:
Uses two nested tab navigators to display active sections and panels that are based on the Guide tree. This Guide layout is designed to display content in a way that visually complements Adobe® LiveCycle® Workspace 9. However, all Guide layouts are displayed in Workspace.

Use default stylesheet
Uses the default style sheet that is included with LiveCycle for the Guide layout. When you deselect this option, the Guide Style option is available.

Guide style:
Specifies the SWF file that contains the compiled CSS file to associate with the Guide. The Guides SDK includes a sample style sheet. This option is available only if you deselect Use Default Stylesheet. For information about creating Guide styles, see Creating Custom Style Sheets .

Advanced Guide Layout Properties :
Displays the Advanced Properties dialog box. The dialog box lists additional properties that are available for the selected Guide layout, and includes properties for custom layouts. Select the properties that you want to add to the Guide Properties view for the current Guide layout. When selected, a property is set to its default value. The selected properties appear in the Advanced Properties section. Configure the properties as required.

For information about the advanced properties, see the ActionScript 3.0 Reference for the Adobe Flash Platform .

Advanced properties

Displays the properties selected on the Advanced Properties dialog box. Configure the properties as required.

The advanced properties include the following properties from the wrapper class in the ga.controls package in the Guides API:

interactivePdfLoad
This property is available when you select the Include Interactive PDF option. Controls the timing and sequence for loading an interactive PDF that is included with a Guide. The default value is Demand. Select this property from the Advanced Properties only when you need to change the value. The following are the valid values for this property:
Demand
(Default) The interactive PDF file is loaded only when the Guide filler clicks the icon in the Guide. Use this option when viewing the PDF file is optional. Loading the PDF file can slow down Flash Player. Loading demand limits the impact to users who choose to see the PDF file.

Start
The interactive PDF file is loaded and displayed when the Guide is rendered. Use this option to display the PDF file automatically, such as when the PDF file is the main data entry source. Include text on the first Guide panel to indicate that there could be a delay before the PDF file is rendered.

Background
The interactive PDF file is loaded in the background when the Guide is rendered. The Guide filler clicks the icon to display the PDF file. Use this option when it takes a long time to load the PDF file, or when most Guide fillers need to view the PDF file. You can use this option with the interactivePdfBackgroundLoadDelay property.

interactivePdfBackgroundLoadDelay
This property is available when you select the Include Interactive PDF option. Controls the delay time for generating the interactive PDF file, when used with the interactivePdfLoad property set to Background. The default value is 5000 ms (5 seconds).

pdfLoadErrorMessage
Holds the error message string that is displayed when the Guide times out trying to communicate with the PDF document.

pdfRequiredFallbackUrl
Holds an optional process URL where the data is submitted when SubmitFromInteractivePDF is used and the PDF document cannot be loaded. A post is sent to the server URL and the Guide is replaced with the returned content.

includeNavigationMinWidth
Indicates the minimum width required to display the navigation panel.

includeNavigationMinHeight
Indicates the minimum height required to display the navigation panel.

For information about the other advanced properties, see the ActionScript 3.0 Reference for the Adobe Flash Platform .

Start-up / transition effects

Specifies start-up effects and panel transitions.

Start-up effect:
Specifies the visual effect to use when a Guide is opened in a browser. To set the speed of the effect, use the associated slider.
Note: If you select a Wipe start-up effect and use an image in a text object or a caption, define a policy file. Otherwise, an ActionScript error occurs when previewing the Guide.

Panel transition:
Specifies the visual effect to use when the Guide filler navigates through the panels. To set the speed of the panel transition, use the associated slider.
Note: Panel transitions do not work correctly with Firefox. By default, when a Guide displays in Firefox, panel transitions are disabled to allow users to correctly transition between Guide panels.

Preview data

Sample data:
Specifies the sample data XML file to use when previewing a Guide. The sample data is not used when displaying a Guide as part of a process.

Document-style presentation

Specifies whether to include a read-only document with a Guide. For example, the read-only document can be a document of record or an informational document. It also specifies the LiveCycle service that renders the document from the Guide data.

When you include a document with your Guide, an icon appears in the Guide layout. Guide fillers click the icon to switch between the Guide and the document when viewing and entering data.

For more information about including a read-only document with a Guide, see Including documents with a Guide .

None:
A document is not included with the Guide.

Generate document using default service:
Specifies that the default LiveCycle service renders the document from the Guide data. When you select this option, the Service URL displays the URL for the default service.

Generate document using custom service:
Specifies the custom LiveCycle service that renders the document from the Guide data.

Service URL:
Specifies the location of the LiveCycle service that renders the document. The service URL can be literal text or it can be bound to a property in the Data Model view. Use a relative URL. If you specify a document source, the service URL must end with an equal sign (=), as illustrated in the following example:

/rest/services/myApplication/CustomRenderDOR?lcAsset=

Document source:
Specifies the location of the XDP or PDF file that data is merged into when the read-only document is rendered. If the Guide is based on an XDP form, the name of the XDP form is used.
Important: If you change the document source, save and check-in the Guide before previewing.

Run validations before requesting document:
Specifies that validations are run when the Guide filler clicks the icon to view the read-only document. The Guide filler must enter valid data in the required fields before the document is generated. If validations fail, the document is not displayed. For example, you can use this option to generate a document that the user must complete, print, and then sign.

Interactive PDF

Specifies whether to include an interactive PDF document with a Guide. These options are available only if the Guide is based on an XDP form. These options are not available if the XDP form uses an application model (FML).

Include interactive PDF:
Specifies that an interactive PDF document is included with the Guide. Guide fillers click the icon in the Guide layout to switch between the Guide and the interactive PDF document when viewing and entering data. When you select this option, you can select interactivePdfLoad or interactivePDFBackgroundLoadDelay from the Advanced Properties.

Run validations before switching to PDF:
Specifies that validations are run when the Guide filler clicks the icon to view the PDF document. The Guide filler must enter valid data in the required fields before the interactive PDF document is generated. The PDF document appears only if there are no validation errors.

When to validate

Enforce required fields, validations, and constraints
Specifies when the Guide filler must complete the required fields:
on submit
Specifies that the Guide filler must complete the required fields when attempting to submit all Guide data.

on panel exit:
Specifies that the Guide filler must complete the required fields when navigating between panels.

Where to submit from

Submit From:
Specifies where the Guide data is submitted from. To submit the data, the Guide filler clicks a submit button. A Guide can run in several different environments, such as within Workspace or in a browser. If left blank, the default is Guide.
You can select one of the following Submit From options:
Guide
(Default) Data submission depends on where the Guide is running. If the Guide is running in a browser, the submit button appears in the navigation button area, where the Next and Previous buttons appear. Typically it appears on the last visible panel in the Guide. When the Guide runs in Workspace, no submit button appears on the Guide, and the data is submitted from a button on the Workspace chrome.

Interactive PDF
Submits the data from an interactive PDF document. This option is available when the Guide is based on an XDP form that includes an interactive PDF form. When you select this option, a Submit From PDF button appears in the navigation button area. Clicking this button switches the view to the interactive PDF document, which must include a Submit button. The Submit From PDF button appears in all environments where the Guide can run, such as Workspace or a browser. No other submit button appears in the navigation button area of the Guide or in the Workspace chrome.

User Button
Submits the data from a button that you add to a panel in the Guide. This submit button appears in all environments where the Guide can run. No other submit button appears in the navigation button area of the Guide or in the Workspace chrome.
Note: In Guides based on XDP or PDF forms, Email Submit Buttons are not supported.

Host:
Specifies that data is submitted from the application that is hosting the Guide, such as Workspace. The submit button appears on the Workspace chrome, under the Guide. There is no submit button in the navigation button area of the Guide.

Guide Help

Specifies the Help contents that appear in the Guide container. You can format the text and add links to the contents.

Select font type:
Displays the font name for the selected text.

Select font size:
Displays the font size for the selected text.

Bold:
Applies or removes bold formatting to selected text.

Italic:
Applies or removes italic formatting to selected text.

Underline:
Applies or removes underline formatting to selected text.

Color:
Applies a color to the selected text. You can select a color from the color picker or type the hexadecimal value for the color.

Left align:
Aligns text to the left.

Center align:
Aligns text to the center.

Right align:
Aligns text to the right.

Spread justify:
Justifies the text.

Bullets:
Creates a bulleted list.

Remove rich content settings while retaining the text:
Removes RTF but preserves the text. It also removes any image that may have been associated with the field.

Link to:
Specifies the URL for a link. The URL can use an absolute or a relative path. When the Guide filler clicks a link, the linked content appears in a separate browser window.

Show/Hide image settings:
Shows or hides the following image settings:

Image:
Specifies the URL for an image file. You can specify a URL to an image, or you can select an image file that is in your application. To remove the URL for an image, click the Remove button .

  • Position: Specifies the image position.

  • Width: Specifies the image width.

  • Horizontal pad: Specifies horizontal padding for the image.

  • Height: Specifies the image height.

  • Vertical pad: Specifies vertical padding for the image.

  • Scaling: When selected, maintains the aspect ratio.

Help video:
Specifies the URL for a video file. Help videos must be in FLV file format. Help videos work only with the Cobalt Standard and Cobalt Tree Guide layouts. Select a video file that is in your application. To remove the URL for a Help video, click the Remove button .

Section properties

When you select a section in the Guide Tree view, the Guide Properties view displays section-level properties that you can specify:

Section title:
The name of the section.

Repeat based on:
Specifies the entity collection in the Data Model view that causes the section to repeat.

Panel properties

In the Guide Properties view, specify properties such as the effects and transitions, the submit method, and any panel Help.

When you select a panel in the Guide Tree view, the Guide Properties view displays several panel-level properties that you can specify:

Panel title:
The name of the panel.

Repeating label:
Specifies the label that is used for a repeating panel layout.

Layout:
Specifies the layout to associate with the panel. Use repeater layouts to display repeating data inside a single panel. For example, to display the data for a data collection, which typically has more than one instance, you can use a RepeaterTab, RepeaterAccordion, or RepeaterGrid.

For information about creating a custom panel layout, see Creating Panel Layouts .

To include a document with a Guide, you must also set the corresponding Document-style presentation or Interactive PDF properties for the Guide. (See Including documents with a Guide and Guide properties .)

Several panel layouts are available:

Display Document
Displays a read-only document of record when the Guide filler navigates to the panel.

Display PDF
Displays an interactive PDF document when the Guide filler navigates to the panel. Only Guides based on an XDP form can display an interactive PDF document.

Model Viewer:
A panel layout that you can add to any Guide to inspect the XML data object model and the data model. (See Using the Model Viewer layout to debug a Guide .)

Multi Column:
Has up to four columns. Controls flow from top to bottom in each column and then from left to right to the next column.

Nested Panels:
Nests the selected panel under a radio button or a check box when the Guide filler selects a button or check box. The panel disappears when the button or check box is deselected. Displays a panel based on the display rules of the original panel and automatically hides the panels from the navigation panel. To use the Nested Panels layout, perform the following steps:

  • Define a set of Boolean values in the model. Create the Boolean values either as explicit Boolean properties in the Data Model perspective, as rules, or as selection lists.

  • Drag the Boolean value onto the display rule of the panel that the Nested Panels layout displays.

  • Drag the Boolean value onto the panel. The position of the Boolean value on the panel dictates the display position of the nested panel. It is displayed as a check box or radio button. When the Guide filler selects the check box or radio button, the panel appears under the radio button. When the check box or radio button is deselected, the panel is hidden.

  • You can drag multiple check boxes or radio buttons onto the layout this way. Each check box or radio button controls a single panel.

Note: The Nested Panels layout is an application of nested panels for a particular use case. You can achieve the same functionality with a one-column layout and a nested panel. Drag the Boolean values onto a one-column layout. Add a nested panel and set it to display when the Guide filler selects the check box or radio button.

One Column:
The default layout that is applied when you add a panel. The controls flow from the top to the bottom of the column.

Pie Chart - Horizontal:
Organizes the Guide tree into four distinct areas:

  • Header: A two-column list of controls whose data is not part of the pie chart.

  • Entry Pane: An optional one-column list of controls whose data is included in the pie chart.

  • Chart Pane: S hows the data from the controls that are added to the Guide tree.

  • Trailer: An additional control that occurs after charts in the Guide tree.

Repeater Accordion:
Displays repeating information by using an accordion. One accordion button is available for each repeating instance. Repeater Accordions include Repeater First Column, Repeater Second Column, and Trailer areas.

Repeater Grid:
Displays repeating information in a grid. Repeater Grids do not support headers or footers. A grid has one column for each item in the panel. The captions for the repeating fields are used as column headings. Repeater Grids include Repeater First Column, Repeater Second Column, and Trailer areas.

Repeater Tab:
Displays repeating fields by using tabs. One tab is available for each repeating instance. Repeater Tabs include Repeater First Column, Repeater Second Column, and Trailer areas.

Three Columns:
Has three columns. The controls flow from left to right and are distributed equally among the three columns. The controls are positioned in this order: first column, second column, third column, first column, second column, third column, and so on.

Two Columns:
Has two columns. The controls flow from left to right and are distributed equally between the two columns. The controls are positioned in this order: first column, second column, first column, second column, and so on.

Variable Column:
Allows you to create layouts that can vary the number of columns of each row of items. On the editor, place items either to the right of another item or below another item. If you place an item to the right of another item, it is marked with “keep with previous” 'true'. If you place the item below another item, it is marked with “keep with previous” 'false'.

This layout supports the concept of an alignment area. Items in the same alignment area align both horizontally (columns align) and vertically (rows align). Each alignment area aligns independently. When you drag an item into the last alignment area of the layout, another alignment area is automatically created. To not have items to align with columns above, create a different alignment area. Creating an alignment area allows items to span the preceding rows. For example, an address field can span the length of the first and last name fields in the preceding row.

The Variable Column layout also supports percentage widths. The percentage width setting of the first item in each column of an alignment area controls the percentage width of that column for that alignment area. One alignment area can have a percentage column width of 25% and 25% for the first two columns, followed by another alignment area with a column width of 50%. Using these percentage widths allows items in the first column of the second alignment area to span both columns of the first alignment area. You can also use fixed widths to achieve the spanning effect.

Advanced Layout Properties :
Displays the Advanced Properties dialog box. The dialog box lists additional properties that are available for the selected panel Layout, and includes properties for custom layouts. Select the properties that you want to add to the Guide Properties view for the current panel. The selected properties appear in the Advanced Properties section below. Configure the properties as required.

For information about the advanced properties, see the ActionScript 3.0 Reference for the Adobe Flash Platform .

Display panel full size
Displays the panel in full size by hiding the navigation and Help panels.

Repeat based on:
Specifies the collection in the Data Model view that provides the repeating data.

Repeating label:
Specifies the label for the repeating data.

Default caption width (in pixels):
Specifies the default caption width for all fields in the selected panel. If the caption exceeds the specified width, the text wraps. By default, captions do not wrap. If no value is specified, all field captions do not wrap in the Guide. You can override the default caption width when you edit the field properties.

Advanced properties

Displays the properties selected on the Advanced Properties dialog box. Configure the properties as required.

For information about the advanced properties, see the ActionScript 3.0 Reference for the Adobe Flash Platform .

Note: Setting a rotation value removes captions from the Guide. When a Rotation value is set, the Guide filler cannot enter data in the control. When the control type is a drop-down list or a list box, setting a Rotation value also removes the list items from the Guide.

Display rules

Specifies the following display rules for the panel:

Displayed:
Specifies whether the panel is displayed in the Guide. Selecting this option displays the panel. When you bind an item in the Data Model view, specify the condition that determines when the panel appears in the Guide.

Read-only:
Specifies that Guide fillers cannot edit fields on the current panel. When you bind an item in the Data Model view, specify the condition that determines when the fields on a panel are read-only.

Required:
Specifies that Guide fillers are required to fill all fields on the current panel. When you bind an item in the Data Model view, specify the condition that determines when the panel items are required.
Panel Help:
Specifies the Help contents that appear in the selected panel. You can format the text and add links and videos to the contents.

Specifies the Help contents that appear in the selected panel. You can format the text and add links and videos to the contents.

Select font type:
Displays the font name for the selected text.

Select font size:
Displays the font size for the selected text.

Bold:
Applies or removes bold formatting to selected text.

Italic:
Applies or removes italic formatting to selected text.

Underline:
Applies or removes underline formatting to selected text.

Color:
Applies a color to the selected text. You can select a color from the color picker or type the hexadecimal value for the color.

Left align:
Aligns text to the left.

Center align:
Aligns text to the center.

Right align:
Aligns text to the right.

Spread justify:
Justifies the text.

Bullets:
Creates a bulleted list.

Remove rich content settings while retaining the text:
Removes RTF but preserves the text. It also removes any image that may have been associated with the field.

Link to:
Specifies the URL for a link. The URL can use an absolute or a relative path. When the Guide filler clicks a link, the linked content appears in a separate browser window.

Show/Hide image settings:
Shows or hides the following image settings:

Image:
Specifies the URL for an image file. You can specify a URL to an image, or you can select an image file that is in your application. To remove the URL for an image, click the Remove button .

  • Position: Specifies the image position.

  • Width: Specifies the image width.

  • Horizontal pad: Specifies horizontal padding for the image.

  • Height: Specifies the image height.

  • Vertical pad: Specifies vertical padding for the image.

  • Scaling: When selected, maintains the aspect ratio.

Help video:
Specifies the URL for a video file. Help videos must be in FLV file format. Help videos work only with the Cobalt Standard and Cobalt Tree Guide layouts. Select a video file that is in your application. To remove the URL for a Help video, click the Remove button .

Field, button, and nested panel properties

In the Guide Properties view, specify properties such as the effects and transitions, the submit method, and any Help.

The same properties are displayed for fields, buttons, and nested panels.

When you select a field in the Guide Tree view or the editor, the Guide Properties view displays several properties that you can edit:

Data source:
Displays the path to the entity in the data model. The binding icon indicates the binding state.

Caption

You can specify the following properties for the field caption:

Text:
Specifies the caption text. The caption text cannot be blank. You can edit the text and add rich text formatting (RTF).
Select font type:
Displays the font name for the selected text.

Select font size:
Displays the font size for the selected text.

Bold:
Applies or removes bold formatting to selected text.

Italic:
Applies or removes italic formatting to selected text.

Underline:
Applies or removes underline formatting to selected text.

Color:
Applies a color to the selected text. You can select a color from the color picker or type the hexadecimal value for the color.

Left align:
Aligns text to the left.

Center align:
Aligns text to the center.

Right align:
Aligns text to the right.

Spread justify:
Justifies the text.

Bullets:
Creates a bulleted list.

Remove rich content settings while retaining the text:
Removes RTF but preserves the text. It also removes any image that may have been associated with the field.

Link to:
Specifies the URL for a link. The URL can use an absolute or a relative path. When the Guide filler clicks a link, the linked content appears in a separate browser window.

Show/Hide image settings:
Shows or hides the following image settings:
  • Image: Specifies the URL for an image file. You can specify a URL to an image, or you can select an image file that is in your application. To remove the URL for an image, click the Remove button .

    • Position: Specifies the image position.

    • Width: Specifies the image width.

    • Horizontal pad: Specifies horizontal padding for the image.

    • Height: Specifies the image height.

    • Vertical pad: Specifies vertical padding for the image.

    • Scaling: When selected, maintains the aspect ratio.

Position:
Specifies where the caption is located relative to the field. Select one of the following caption positions:

  • Left: Specifies that the caption appears on the left of the field.

  • Right: Specifies that the caption appears on the right of the field.

  • Top: Specifies that the caption appears on the top of the field.

  • Bottom: Specifies that the caption appears on the bottom of the field.

  • None: No caption appears.

Style:
Specifies the style for the field caption. The style options come from the Guide Style that you specify for the Guide. (See Guide properties .)

You can create or modify caption styles in the CSS file associated with the selected Guide layout. The CSS files are located in the Guides (system) application. For information about modifying the CSS file, see Guide CSS Styles .

Width (in pixels):
Specifies the caption width. Overrides the default Caption Width setting in the panel properties.
If your field caption includes both text and an image, ensure that you set the caption width to display the image and text appropriately at run time.

Control Type

Specifies properties for the control type. Different properties are available for different control types.

Display as:
Sets the run-time appearance for the selected field to a specific control type. For example, if the control is defined in the model as a button, you can set it to appear as a check box at run time.
Note: List objects must have a Data Source, which means they must be bound to an item in the data model.

Style:
Specifies the style for the control type. The style options come from the Guide Style that you specify for the Guide. (See Guide properties .)

Width (in pixels or %):
Specifies the width of the selected field. Leaving this property blank sets the field width to the default value. To accommodate multiple lines, adjust the width.

Height (in pixels):
Specifies the height of the selected field. This property is available only when the field allows multiple lines. Leaving this property blank sets the field height to the default value.

List source:
Specifies the item in the Data Model view that is the source for a list. The list source can be a collection in the model or the listOfItems value in a selection list that you add. This option is available only when the control type is Check Box List, Drop Down List, List Box, Radio Button List, or Static List.

Object flow:
Specifies whether the list objects flow horizontally or vertically. This option is available only when the control type is Check Box List or Radio Button List.

Minimum:
specifies the minimum value. This option is available only when the control type is Horizontal Slider, Numeric Stepper, or Vertical Slider.

Maximum:
Specifies the maximum value.This option is available only when the control type is Horizontal Slider, Numeric Stepper, or Vertical Slider.

Nested panel:
Specifies the panel to use as the nested panel. This option is available only when the control type is Nested Panel.

Step size:
specifies the size. This option is available only when the control type is Numeric Stepper.

Display format:
Specifies the format for displaying the data. This option is available only when the control type is Text Input or Text Input Symbol.

Comb length:
Specifies the length. This option is available only when the control type is Text Input Comb.

Edit mask:
Specifies a mask for the data. This option is available only when the control type is Text Input or Text Input Mask.

Prefix symbol:
specifies a prefix for the data. This option is available only when the control type is Text Input Symbol.

Suffix symbol:
Specifies a suffix for the data. This option is available only when the control type is Text Input Symbol.

Advanced Control Properties :
Displays the Advanced Properties dialog box. The dialog box lists additional properties that are available for the selected control, and includes properties for custom controls. Select the properties that you want to add to the Guide Properties view for the current control. The selected properties appear in the Advanced Properties section below. Configure the properties as required.

Advanced properties

Displays the properties selected on the Advanced Properties dialog box. Configure the properties as required.

For information about the advanced properties, see the ActionScript 3.0 Reference for the Adobe Flash Platform .

Some advanced properties may negatively affect the behavior of some fields in a Guide.

When a Rotation value is set, the Guide filler cannot enter data in the control. When the control type is a drop-down list or a list box, setting a Rotation value also removes the list items from the Guide.

When the Enabled property is unchecked, the Guide filler cannot enter data. Only the following control types support the Enabled property: Text Area, Text Input, Text Input Comb, Text Input Mask, and Text Input Symbol.

Display Rules

Specifies the following display rules for the field:

Displayed:
Specifies whether the field is displayed in the Guide. If the Guide is based on an application model, selecting this option displays the field. If the Guide is based on a form, selecting this option uses the field’s presence property to determine visibility. When this option is not selected, the presence property is ignored and the field does not appear in the Guide.

When you bind a property in the Data Model view, specify the condition that determines when the field appears in the Guide. If the Guide is based on an XDP form and the resulting value is true, the field’s presence property determines visibility. When the resulting value is false, the field’s presence property is ignored and the field does not appear in the Guide.

Read-only:
Specifies that the current field is read-only and Guide fillers cannot edit it. When you bind a property in the Data Model view, specify the condition that determines when the field is read-only. If the model or the panel that contains the field is set to read-only, this option is unavailable.

Required:
Specifies that Guide fillers are required to fill the current field. When you bind a property in the Data Model view, specify the condition that determines when the field is required. If the model or the panel that contains the field is set to required, this option is unavailable.
Important: By default, all objects set to display as radio buttons are automatically assigned a value of false at run time. If you select the Required display rule for the radio button, the automatic value satisfies the rule, even if a user makes no selection. To ensure that users make valid radio button selections, it is recommended that you add the appropriate constraint to the corresponding model.

(See Data Modeling with Adobe LiveCycle Data Services .)

Events

Specifies when events execute. Events are associated with each control type and can trigger a property to recalculate the associated expression.

If a property from the model has the DisableAutoReCalc property set, the expression executes only if it is associated with an event on a control. However, there are situations where an expression that automatically recalculates also must be associated with an event. For example, if an expression returns the current stock price for the associated stock symbol, you can retrigger it even though the symbol has not changed.

onEnter: Refresh data:
Executes the onEnter event when the specified item in the Data Model view gains focus.

onExit: Refresh data:
Executes the onExit event when the specified field loses focus. The onExit event executes even if the content of the field has not changed.

onChange: Refresh data:
Executes the onChange event when the value of the specified field changes and loses focus. It does not execute on every keystroke in an editor field.

onActivate: Refresh data:
Executes the onActivate event when a field, such as a Button or a List, is activated. With mouse operations, this action is equivalent to a double-click . However, both a double-click and a keyboard action, such as pressing the Space key, triggers the event.

Field Help

Specifies the Help contents that appears for the selected field. You can format the text and add links to the contents.

If your field Help contains both images and text, set both the image width and height to a maximum of 200 pixels to avoid cropping the Help text.
Select font type:
Displays the font name for the selected text.

Select font size:
Displays the font size for the selected text.

Bold:
Applies or removes bold formatting to selected text.

Italic:
Applies or removes italic formatting to selected text.

Underline:
Applies or removes underline formatting to selected text.

Color:
Applies a color to the selected text. You can select a color from the color picker or type the hexadecimal value for the color.

Left align:
Aligns text to the left.

Center align:
Aligns text to the center.

Right align:
Aligns text to the right.

Spread justify:
Justifies the text.

Bullets:
Creates a bulleted list.

Remove rich content settings while retaining the text:
Removes RTF but preserves the text. It also removes any image that may have been associated with the field.

Link to:
Specifies the URL for a link. The URL can use an absolute or a relative path. When the Guide filler clicks a link, the linked content appears in a separate browser window.

Show/Hide image settings:
Shows or hides the following image settings:

Image:
Specifies the URL for an image file. You can specify a URL to an image, or you can select an image file that is in your application. To remove the URL for an image, click the Remove button .

  • Position: Specifies the image position.

  • Width: Specifies the image width.

  • Horizontal pad: Specifies horizontal padding for the image.

  • Height: Specifies the image height.

  • Vertical pad: Specifies vertical padding for the image.

  • Scaling: When selected, maintains the aspect ratio.

Entity properties

In the Guide Properties view, specify properties for entities, such as data retrieval conditions and where returned data is copied.

To display the properties for an entity, in the Data Model view, right-click the entity and select Properties. The properties appear in the Guide Properties view.

The Guide Properties view displays several properties for the entity:

Name:
Specifies the name of the entity.

Service:
Displays the name of the service that is associated with the entity.

Function:
Displays the name of the function that is associated with the service.

Returns:
Displays the data that the service returns.

Retrieve data

Specifies when the service returns the data:

Any time a parameter value changes and the When condition is satisfied:
The service returns the data when a parameter value changes and the When condition is satisfied. Bind the When condition to an item in the Data Model view. If a user event triggers the service, this condition is ignored.

Only when triggered by an event:
An event triggers the service.
Copy to:
Specifies an entity in the model where the returned data is copied.

Specifies an entity in the model where the returned data is copied.

Parameters:

The parameters are available when you add a data object, usually a service, that has input parameters. The parameters include the name of the parameter, as named in the service. Set the value to a literal string or a hard-coded value, or bind it to another property in the Data Model view.

Xml data:
Specifies the XML data file for the parameter.

Text properties

In the editor, use the Text button to add text to a panel. In the Guide Properties view, specify properties such as text, formatting, and the width and height of the panel text area.

When you select panel text in the Guide Tree view or the editor, the Guide Properties view displays several properties:

To display the text properties, in the editor, click the text. The properties appear in the Guide Properties view.

The Guide Properties view displays several properties for the text:

Text:
Specifies the text that appears in the panel.
Select font type:
Displays the font name for the selected text.

Select font size:
Displays the font size for the selected text.

Bold:
Applies or removes bold formatting to selected text.

Italic:
Applies or removes italic formatting to selected text.

Underline:
Applies or removes underline formatting to selected text.

Color:
Applies a color to the selected text. You can select a color from the color picker or type the hexadecimal value for the color.

Left align:
Aligns text to the left.

Center align:
Aligns text to the center.

Right align:
Aligns text to the right.

Spread justify:
Justifies the text.

Bullets:
Creates a bulleted list.

Remove rich content settings while retaining the text:
Removes RTF but preserves the text. It also removes any image that may have been associated with the field.

Link to:
Specifies the URL for a link. The URL can use an absolute or a relative path. When the Guide filler clicks a link, the linked content appears in a separate browser window.

Show/Hide image settings:
Shows or hides the following image settings:

Image:
Specifies the URL for an image file. You can specify a URL to an image, or you can select an image file that is in your application. To remove the URL for an image, click the Remove button .

  • Position: Specifies the image position.

  • Width: Specifies the image width.

  • Horizontal pad: Specifies horizontal padding for the image.

  • Height: Specifies the image height.

  • Vertical pad: Specifies vertical padding for the image.

  • Scaling: When selected, maintains the aspect ratio.

Displayed:
specifies whether the text is displayed in the Guide. To display the text based on a condition, bind an item in the Data Model view, such as a rule that you added.

Width:
Specifies the width of the text area.

Height:
Specifies the height of the text area.

Selection list properties

In the Guide Properties view, specify properties for selection lists, such as selection list items and data-retrieval conditions.

Note: If you configure a list to update dynamically at run time, when something happens to change the list of selected items, the value in the list is reset to the first item. The Guide filler must select a new value from the new list.

To display the properties, in the Data Model view, right-click the selection list and select Properties. The properties appear in the Guide Properties view.

The Guide Properties view displays several properties for the selection list:

Name:
Specifies the name of the selection list.

List:
Specifies the list items in the selection list. For each list item, bind an item in the Data Model view or type the value.

Initial selection:
Specifies the default value for the selection list.

Retrieve data
Specifies when the service returns the data:
Any time a parameter value changes and the When condition is satisfied:
The service returns the data when a parameter value changes and the When condition is satisfied. Bind the When condition to an item in the Data Model view. If a user event triggers the service, this condition is ignored.

Only when triggered by an event:
An event triggers the service.

Copy to:
Specifies another selection list where the data returned from the current selection list is copied. The data source for the target selection list must be a data model object. The data model object holds the value selected at runtime.

Input properties

In the Guide Properties view, specify the name and the default value for the input.

To display the properties, in the Data Model view, right-click the input and select Properties. The properties appear in the Guide Properties view.

The Guide Properties view displays properties for inputs:

Name:
Specifies the name of the input.

Default value:
Specifies a default value for the input.

Rule properties

In the Guide Properties view, specify properties for rules, such as the name and conditions.

To display the properties, in the Data Model view, right-click the rule and select Properties. The properties appear in the Guide Properties view.

The Guide Properties view displays several properties for rules:

Rule name:
Specifies the name of the rule.
True when any condition is met
The rule is true when any condition is met, like a logical OR.

True when all conditions are met
The rule is true when all conditions are met, like a logical AND.

Conditions: When:
Specifies the conditions for the rule. You can create several conditions for each rule. Some conditions are either true or false; however, for other conditions, you must specify the value. Bind an item in the Data Model view and then select the condition that is tested.

Binding properties

In the Guide Properties view, specify properties for Bindings, such as x.

To display the properties, in the Data Model view, right-click the binding and select Properties. The properties appear in the Guide Properties view.

The Guide Properties view displays several properties for Bindings:

Binding name:
Specifies the name of the binding. The name appears in the Data Model view.

Source:
Specifies the item in the Data Model view that data is retrieved from.

Copy to:
Lists the items in the Data Model view. Select the item in the Data Model view where you can copy the retrieved data.

Perform copy: When:
Specifies when the data is copied. The data is copied when the item that is bound in the Data Model view satisfies the specified condition.

// Ethnio survey code removed