You are here: User interface > User interface rules > Harness and section forms > Autocomplete Properties - General tab

Autocomplete Properties — General tab

Click the Gear icon Gear icon in the layout containing the Autocomplete control (pxAutocomplete) to display the Properties panel, and then select the General tab to define the source of values for the Autocomplete.

Field

Description

Property

Press the down arrow to select a property, the value of which will be set by the option selected from the Autocomplete at run time.

You can configure a list of options for the Autocomplete in the List Source area and specify from the list defined on the property or from a clipboard page, data page, or report definition.

If the set of possible values is provided by a property using the Table Type field , specify a Single Value mode property that has a Table Type other than None.

For Single Value properties in the Applies to class (or higher) of the current rule, you can drag a property name, from the list of properties visible in the Application Explorer, into the layout. If the container that holds this field has a non-blank Using Page value, you can drag a Single Value property from within that embedded page property.

Click the Open icon to review the property (if the reference is to an existing property in the Applies To class of this rule or a parent of that class). If the property is not found, the New dialog box for the property form appears.

You can reference properties on any page identified on the Pages & Classes tab, using the normal notation pagename.propertyname for pages other than the page corresponding to the Applies To class of the rule.

If this field is in a cell of a section that includes parameter declarations on the Parameters tab, you can enter the notation param.NAME here, to use a parameter value for the field, where NAME identifies a string parameter. Make sure that the NAME parameter is declared on the Parameters tab, and that your application provides a non-blank value for the parameter value in all possible situations where the section appears. See Sections — Completing the Parameter tab.

Label Select Use property default to use the name of the property as the default label for the control. Unselect to enter a custom label.
Default value

Optional. Enter a constant value for the property value, a property reference, or an expression, to be used only when the user form or flow action form appears in read-write mode rather than read-only mode.

Click the Gear icon Gear icon to start the Expression Builder.

Choose a default value that speeds data entry. When the system renders a harness or section in read-only mode (for example because the read-write mode requires a privilege that the current user does not hold), the default value does not appear, because data entry is not permitted.

Visibility Select to determine when the property value is to appear. Always is the default. (If this setting is not applicable, the cell contents are blank.)
  • Choose Always, If Not Blank, or If Not Zero to have the field appear or be hidden based on the property value at the time this area of the user form (section or flow action) is first presented or refreshed. This condition is checked only once.
  • Choose Other Condition to make the visibility depend on a when condition rule or a Java expression.

Check the Reserve space when hidden check box, if it appears, to have a blank area appear in the section when the paragraph is hidden.

Caution: Do not make an input field invisible if your application expects user input on the field. When a user submits an HTML form, an input field that is not visible is not included in the HTTP details.

Disable

Select to disable the text input:

  • Never: never disabled
  • Always: always disabled
  • Condition (expression): the text input is disabled under the specified condition. In the field that displays, select a condition or click the Gear icon to open the Condition Builder. You can define a simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.
  • Condition (when): the text input is disabled under the specified condition. In the field that displays, select a when rule. Click the Open icon to create a new when condition or review an existing when condition.
Required Appears only for fields in cells on flow actions and sections. Select to require that when the form appears at runtime in read-write mode, users cannot successfully submit the form if the field is blank.
Selecting Required marks the label for this field with an orange asterisk when the flow action form appears in read-write mode. (The asterisk also appears if the Label control's Value For field is not blank and the Label control's Required box is checked.)
For sections, checking this box enables client-side format validation when this section is part of a harness form that has the Enable Client Side Validation box selected on the HTML tab. At runtime, users who leave this field blank and submit the form are notified immediately that the field is required; the form is not transmitted to the server.
List Source
Type

Select one of the following as the source for the autocomplete list:

  • As defined on property— This enables specifying a table type with a list of values (for example, a local list such as for state names and abbreviations). See Property form - General tab - Completing the Table fields
  • Data page— specify the data page in the Data Page field.
  • Clipboard page— specify the clipboard page in the Source field.
  • Report definition— specify the class in the Applies To field and then select the Report Definition.

Additional fields appear once you have selected as the source a clipboard page, data page, or report definition. These fields allow you to select the property with which to populate the autocomplete list, and configure the search results.

When the source is a clipboard page, data page, or a report definition, you can categorize items within the autocomplete list. When an autocomplete list is bound to a data page or report definition that accepts parameters and the parameter value uses a property reference, the autocomplete list automatically refreshes with new items whenever the property value changes. No additional configuration is required. This can be used to set up cascading autocomplete or any combination of controls.

Data Page

Displays when the List Source Type is a Data page.

Press the down arrow to select the data page that you want to use as the source of the autocomplete values.

If the data page has parameters, you can pass parameter values to the data page. Press the down arrow in the Value field to specify the value that you want to pass to the data page. Using parameters, you can filter the results that are returned to the autocomplete from the data page. For example, if a data page contains the values of work objects W-001 to W-9999, by passing a parameter value, you can filter the results and populate the autocomplete only with those work objects beginning with W-1.

Clipboard page

Displays when the List Source Type is a Clipboard page.

Required. Press the down arrow to select the clipboard page that you want to use as the source of the autocomplete values. Identify the page on the Pages & Classes tab. See How to complete a Pages & Classes tab.

Applies To

Displays when the List Source Type is a Report definition.

Required. Specify the Applies To class of the report definition.

Report Definition

Displays when the List Source Type is a Report definition.

Required. Press the down arrow to select the report definition that is the source of values for the autocomplete list.

If the report definition has parameters, you can pass parameter values to the report definition. Press the down arrow in the Value field to specify the value that you want to pass to the report definition. Using parameters, you can filter the results that are returned to the autocomplete from the report definition. For example, if a report definition contains the values of work objects W-001 to W-9999, by passing a parameter value, you can filter the results and populate the autocomplete only with those work objects beginning with W-1.

Max results displayed Optional. Set a limit to the number of results the autocomplete control returns as it tries to find a match for the text entered.
Min search characters Optional. Set the minimum number of characters that must be entered to cause autocomplete to create a list of possible matches.
Highlight match Checked by default. This option causes autocomplete to highlight the search string in each place it occurs in the results display.
Match start of string Check the check box to compare the search string only with the start of each string in the data, and not include in the results items where the string occurred not at the start of the string. When this is selected, entering "Presi", for example, could return a list of possible matches including "President" but not including "Vice President".

 

Related topics

Harness and Section forms - Adding a Autocomplete control
Autocomplete control - Presentation tab
Actions tab