MapElement Class Properties

In this section, the MapElement class properties are presented in alphabetical order.

Page Element Types

The MapElement class supports each of the 18 element types that can be added to a MAP page:

  • Action sheet

  • Check box

  • Container

  • Flip toggle

  • HTML area

  • Image/static text

  • Input field

  • List view

  • Mobile grid

  • Push button

  • Radio button

  • Select box

  • Select menu

  • Sidebar

  • Slider

  • Static text

  • Table

  • URL

Some properties (such as, ClassName, Style, Theme, ElementType, and so on) apply to all elements, while many others apply to a specific element type only. Therefore, use care to ensure that the property is applicable to the element you are manipulating. Otherwise, a PeopleCode runtime error similar to the following can occur:

Property prop_name not Applicable for Element ID element_ID

If necessary, use the ElementType property to identify the type of element you are manipulating. See ElementType.

Description

Note: This property applies to list view elements only.

Use this property to set or return a String representing the alternative text (alt text) for a list view item. You define alternative text for images for accessibility purposes.

This property is read/write.

Description

Note: This property applies to action sheet elements only.

Use this property to set or return a Boolean representing whether to include a Close button on the action sheet.

This property is read/write.

Description

Note: This property applies to all element types.

Use this property to return a String representing the system-generated AJAX URL for this element.

This property is read-only.

Description

Note: This property applies to push button elements only.

Use this property to set or return a Boolean value indicating whether to use the defined alternate URL instead of the button’s standard URL. Use this property when you want to dynamically change the element’s mapped URL due to a form factor change.

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return an Integer representing the orientation of a button group.

The values can be one of the following constants:

  • %MAP_BG_Vertical

  • %MAP_BG_Horizontal

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return an Integer representing the jQuery Mobile icon to appear on this button.

The values can be one of the following constants:

  • %MAP_Icon_Alert

  • %MAP_Icon_D

  • %MAP_Icon_L

  • %MAP_Icon_R

  • %MAP_Icon_U

  • %MAP_Icon_Back

  • %MAP_Icon_Check

  • %MAP_Icon_Delete

  • %MAP_Icon_Forward

  • %MAP_Icon_Gear

  • %MAP_Icon_Grid

  • %MAP_Icon_Home

  • %MAP_Icon_Info

  • %MAP_Icon_Minus

  • %MAP_Icon_Plus

  • %MAP_Icon_Refresh

  • %MAP_Icon_Search

  • %MAP_Icon_Star

  • %MAP_Icon_Bars

  • %MAP_Icon_Edit

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return an Integer indicating the position of the button’s icon. The default value is %MAP_Icon_Loc_Left.

The values can be one of the following constants:

  • %MAP_Icon_Loc_Left

  • %MAP_Icon_Loc_Bottom

  • %MAP_Icon_Loc_None — No text.

  • %MAP_Icon_Loc_Right

  • %MAP_Icon_Loc_Top

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return a Boolean value indicating whether the button is to be generated as an in-line button. For in-line buttons, the width of the button is determined by the text and icon displayed on the button. For non-in-line buttons, the width is the full width of the screen.

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return an Integer representing the location of the button with respect to the title. This property applies to buttons defined within the header container only.

The values can be one of the following constants:

  • %MAP_Btn_Loc_Right

  • %MAP_Btn_Loc_Left

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return a Boolean value indicating whether to display a compact version of the button.

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return a Boolean value indicating whether to remove the rounded corners from the button. Buttons are displayed with rounded corners by default. When this property is set to True, the button is displayed with rectangular corners.

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return a Boolean value indicating whether to remove the shadow from the button’s icon. Icons are displayed on buttons with shadows by default.

This property is read/write.

Description

Note: This property applies to push button elements only.

Use this property to set or return a Boolean value indicating whether to remove the button’s shadow. Buttons are displayed with shadows by default.

This property is read/write.

Description

Note: This property applies to all element types.

Use this property to set or return a String representing the class for the label for this element. This property corresponds to the Class Name field in the Layout grid. See Using the Layout Grid for more information.

Note: Use the ContClassName property to set or return the class for the data for this element.

This property is read/write.

Description

Note: This property applies to the following element types only:

Check box: Applies to the element’s div wrapper.

Container: Applies to the container’s image (if defined).

Image/static text: Applies to the image.

Input field: Applies to the input data.

List view: Applies to the list view’s image (if defined).

Push button: Applies to the button’s image (if defined).

Radio button: Applies to the element’s div wrapper.

Static text: Applies to the text (data) itself.

URL: Applies to the URL’s image (if defined).

Use this property to set or return a String representing the class name for the data for this element. This property corresponds to the Class field on the page element’s properties page.

Note: Use the ClassName property to set or return the class for the label for this element.

This property is read/write.

Description

Note: This property applies to container elements only.

Use this property to set or return a Boolean value indicating whether this container element acts as a popup.

This property is read/write.

Description

Note: This property applies to container elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the button used to pop up the container.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to container elements only.

Use this property to set or return an Integer representing the position of the Close button only if the container element has been configured as a popup and if the Close button has been enabled.

The values can be one of the following constants:

  • %MAP_Cont_BtnPopupPos_Left

  • %MAP_Cont_BtnPopupPos_Right

This property is read/write.

Description

Note: This property applies to container elements only.

Use this property to set or return an Integer representing the jQuery Mobile icon to appear on this button.

The values can be one of the following constants:

  • %MAP_Icon_Alert

  • %MAP_Icon_D

  • %MAP_Icon_L

  • %MAP_Icon_R

  • %MAP_Icon_U

  • %MAP_Icon_Back

  • %MAP_Icon_Check

  • %MAP_Icon_Delete

  • %MAP_Icon_Forward

  • %MAP_Icon_Gear

  • %MAP_Icon_Grid

  • %MAP_Icon_Home

  • %MAP_Icon_Info

  • %MAP_Icon_Minus

  • %MAP_Icon_Plus

  • %MAP_Icon_Refresh

  • %MAP_Icon_Search

  • %MAP_Icon_Star

  • %MAP_Icon_Bars

  • %MAP_Icon_Edit

This property is read/write.

Description

Note: This property applies to container elements only.

Use this property to set or return an Integer indicating the position of the button’s icon. The default value is %MAP_Icon_Loc_Left.

The values can be one of the following constants:

  • %MAP_Icon_Loc_Left

  • %MAP_Icon_Loc_Bottom

  • %MAP_Icon_Loc_None — No text.

  • %MAP_Icon_Loc_Right

  • %MAP_Icon_Loc_Top

This property is read/write.

Description

Note: This property applies to container elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the overlay layer for the container’s popup.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to container elements only.

Use this property to set or return an Integer representing the location of the popup window.

The values can be one of the following constants:

  • %MAP_Cont_PopupPos_Window

  • %MAP_Cont_PopupPos_Origin

This property is read/write.

Description

Note: This property applies to container elements only.

Use this property to set or return an Integer representing the control used to activate the popup: button or link.

The values can be one of the following constants:

  • %MAP_Cont_PopupType_Button

  • %MAP_Cont_PopupType_Link

This property is read/write.

Description

Note: This property applies to the following element types only: check boxes, flip toggles, input fields, push buttons, radio buttons, select boxes, select menus, and sliders.

Use this property to set or return an Integer representing state for this element.

The values can be one of the following constants:

  • %MAP_Disable — In addition to being read-only, the element cannot be used in any way. For example, it cannot be selected, highlighted, submitted, copied, and so on.

  • %MAP_Enable — The element is enabled for normal interaction.

  • %MAP_DisplayOnly — The element is read-only; no changes can be made.

This property is read/write.

Use the Style property to hide an element.

Description

Note: This property applies to the following element types only:

Check box: Applies to the element’s div wrapper.

Container: Applies to the container’s image (if defined).

Image/static text: Applies to the image.

Input field: Applies to the input data.

List view: Applies to the list view’s image (if defined).

Push button: Applies to the button’s image (if defined).

Radio button: Applies to the element’s div wrapper.

Static text: Applies to the text (data) itself.

URL: Applies to the URL’s image (if defined).

Use this property to set or return a String representing the style for the data for this element. This property corresponds to the Style field on the page element’s properties page.

Note: Use the Style property to set or return the style for the label for this element.

This property is read/write.

Description

Note: This property applies to the following element types only:

Check box: Applies to the element’s div wrapper.

Container: Applies to the container’s image (if defined).

Image/static text: Applies to the image.

Input field: Applies to the input data.

List view: Applies to the list view’s image (if defined).

Push button: Applies to the button’s image (if defined).

Radio button: Applies to the element’s div wrapper.

Static text: Applies to the text (data) itself.

URL: Applies to the URL’s image (if defined).

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the data for this element. This property corresponds to the Theme field on the page element’s properties page.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Note: Use the Theme property to set or return the theme for the label for this element.

Description

Note: This property applies to URL elements only.

Use this property to set or return an Integer representing the position of the close button for a URL element designated to open as a dialog.

The values can be one of the following constants:

  • %MAP_Dialog_Close_Left

  • %MAP_Dialog_Close_Right

  • %MAP_Dialog_Close_None

This property is read/write.

Description

Note: This property applies to URL elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the overlay layer for a URL element designated to open as a dialog.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to all element types.

Use this property to return an Integer representing the type of the current element.

Specify this value as one of the following constants:

  • %MAP_Element_ActionSheet

  • %MAP_Element_Button

  • %MAP_Element_CheckBox

  • %MAP_Element_Container

  • %MAP_Element_FlipToggle

  • %MAP_Element_HTMLArea

  • %MAP_Element_ImageStaticText

  • %MAP_Element_Input

  • %MAP_Element_Listview

  • %MAP_Element_MobileGrid

  • %MAP_Element_Radio

  • %MAP_Element_SelectBox

  • %MAP_Element_SelectMenu

  • %MAP_Element_SideBar

  • %MAP_Element_Slider

  • %MAP_Element_StaticText

  • %MAP_Element_Table

  • %MAP_Element_URL

This property is read-only.

Example

You can use the ElementType property to determine the type of the current element:

If &Element.ElementType = %MAP_Element_Button Then
   /* Manipulate the push button's properties */
   ...
End-If;

Description

Use this property to set or return a String representing the class name for the for the field container for this grid element.

This property is read/write.

Description

Use this property to set or return a String representing the style for the for the field container for this grid element.

This property is read/write.

Description

Note: This property applies to header and footer elements only.

Use this property to set or return a Boolean value indicating whether the header or footer element remains fixed in position in the display window. While the user scrolls through content, the header or footer element remains affixed on top and the page content scrolls underneath.

This property is read/write.

Description

Note: This property applies to flip toggle elements only.

Use this property to set or return a Boolean value indicating whether highlight the fill of the toggle track.

This property is read/write.

Description

Note: This property applies to flip toggle elements only.

Use this property to set or return a Boolean value indicating whether to display a compact version of the flip toggle.

This property is read/write.

Description

Note: This property applies to flip toggle elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the toggle switch’s track.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to header and footer elements only.

Use this property to set or return a Boolean value indicating whether the header or footer element is to disappear (and then reappear) when the page is clicked, allowing the page content to be displayed using the full screen. Common scenarios for viewing page content on the full screen include photo and video viewers. To allow the page content to be displayed on the full screen, set FixedDisplayFormat to True and set this property to True.

This property is read/write.

Description

Important! Grid elements have not been implemented in this release. This property is not currently used.

Note: This property applies to grid elements only.

Use this property to set or return an Integer.

This property is read/write.

Description

Use this property to set or return a String representing the class name for the for this grid row.

This property is read/write.

Description

Use this property to set or return a String representing the style for the for this grid row.

This property is read/write.

Description

Important! Grid elements have not been implemented in this release. This property is not currently used.

Note: This property applies to grid elements only.

Use this property to set or return a Integer representing ...

This property is read/write.

Description

Note: This property applies to groups only.

Use this property to set or return a String representing the label for a group of elements. You can group together certain element types (for example, push buttons, check boxes, select menus, and others) to achieve specific behaviors.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a Boolean value indicating whether to hide the split button if it has been enabled for this list view element.

This property is read/write.

Description

Note: This property applies to push button and URL elements only.

Use this property to set or return a String representing the name of the override image for the element.

This property is read/write.

Description

Note: This property applies to input field elements only.

Use this property to set or return a Boolean value indicating whether to display a compact version of the input field.

This property is read/write.

Description

Note: This property applies to input field elements only.

Use this property to set or return a Boolean value indicating whether this input field is required.

This property is read/write.

Description

Note: This property applies to all element types.

Use this property to return a String representing the element’s ID.

This property is read-only.

Description

Note: This property applies to all element types.

Use this property to set or return a String representing the user-visible label that is displayed on the element.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a Boolean value indicating whether to use the defined alternate URL instead of the list view’s standard URL. Use this property when you want to dynamically change the element’s mapped URL due to a form factor change.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a Boolean value indicating whether a collapsible list view is initially collapsed.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a Boolean value indicating whether a list view is collapsible.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the count bubble for the list view element.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return an Integer representing the location of the divider between rows in the list view.

The values can be one of the following constants:

  • %MAP_LV_Divider_Above

  • %MAP_LV_Divider_Below

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a String that is the concatenation of the message set number and message number. Use the | character to separate the message set number from the message number.

This property is read/write.

Example

To set a message catalog entry as the list view divider:

&Element.ListViewDividerMsgCat = "158|300";

Description

Note: This property applies to list view elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the filter for the list view element.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the header for the list view element.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a Boolean value indicating whether to display the list as inset from the full page width. When the value of this property is False, the list displays the full width of the page.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return an Integer representing the jQuery Mobile icon to appear on the split button for this list view element.

The values can be one of the following constants:

  • %MAP_Icon_Alert

  • %MAP_Icon_D

  • %MAP_Icon_L

  • %MAP_Icon_R

  • %MAP_Icon_U

  • %MAP_Icon_Back

  • %MAP_Icon_Check

  • %MAP_Icon_Delete

  • %MAP_Icon_Forward

  • %MAP_Icon_Gear

  • %MAP_Icon_Grid

  • %MAP_Icon_Home

  • %MAP_Icon_Info

  • %MAP_Icon_Minus

  • %MAP_Icon_Plus

  • %MAP_Icon_Refresh

  • %MAP_Icon_Search

  • %MAP_Icon_Star

  • %MAP_Icon_Bars

  • %MAP_Icon_Edit

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the split button for this list view element.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return an Integer representing indicating the type of list view: ordered or unordered.

The values can be one of the following constants:

  • %MAP_LV_Ordered

  • %MAP_LV_UnOrdered

This property is read/write.

Description

Note: This property applies to list view elements only.

Use this property to set or return a String representing the JavaScript function to be called by the list view instead of invoking a URL.

This property is read/write.

Description

Note: This property applies to select menu elements only.

Use this property to set or return an Integer representing the jQuery Mobile icon to appear on the button for a select menu.

The values can be one of the following constants:

  • %MAP_Icon_Alert

  • %MAP_Icon_D

  • %MAP_Icon_L

  • %MAP_Icon_R

  • %MAP_Icon_U

  • %MAP_Icon_Back

  • %MAP_Icon_Check

  • %MAP_Icon_Delete

  • %MAP_Icon_Forward

  • %MAP_Icon_Gear

  • %MAP_Icon_Grid

  • %MAP_Icon_Home

  • %MAP_Icon_Info

  • %MAP_Icon_Minus

  • %MAP_Icon_Plus

  • %MAP_Icon_Refresh

  • %MAP_Icon_Search

  • %MAP_Icon_Star

  • %MAP_Icon_Bars

  • %MAP_Icon_Edit

This property is read/write.

Description

Note: This property applies to select menu elements only.

Use this property to set or return an Integer indicating the position of the button’s icon. The default value is %MAP_Icon_Loc_Left.

The values can be one of the following constants:

  • %MAP_Icon_Loc_Left

  • %MAP_Icon_Loc_Bottom

  • %MAP_Icon_Loc_None — No text.

  • %MAP_Icon_Loc_Right

  • %MAP_Icon_Loc_Top

This property is read/write.

Description

Note: This property applies to select menu elements only.

Use this property to set or return a Boolean value indicating whether to display the select menu’s button as if it were an in-line element; the button’s width is determined by the text displayed on the button.

This property is read/write.

Description

Note: This property applies to select menu elements only.

Use this property to set or return a Boolean value indicating whether to display the select menu’s button as a compact version.

This property is read/write.

Description

Note: This property applies to select menu elements only.

Use this property to set or return a Boolean value indicating whether to allow multiple selections from the select menu.

This property is read/write.

Description

Note: This property applies to select menu elements only.

Use this property to set or return a Boolean value indicating whether to display the select menu in an alternative user interface rather than relying on the native select element of the mobile browser.

Note: In the Layout Designer, this check box provides additional options: Multiple check box, Placeholder Text fields, and Optional Label fields.

This property is read/write.

Description

Note: This property applies to select menu elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the overlay layer for the select menu.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to select menu elements only.

Use this property to set or return a Boolean value indicating whether to remove the rounded corners from the button for the select menu. Buttons are displayed with rounded corners by default. When this property is set to True, the button is displayed with rectangular corners.

This property is read/write.

Description

Use this property to set or return a Boolean value indicating whether to remove the shadow from the select menu’s button. Buttons are displayed with shadows by default.

This property is read/write.

Description

Use the NoCustomContainer property to set or return a boolean value indicating whether the contents of the parent container should be used and not the contents of the custom container.

This property is read/write.

Description

Important! Grid elements have not been implemented in this release. This property is not currently used.

Note: This property applies to grid elements only.

Use this property to set or return a Boolean value.

This property is read/write.

Description

Important! Grid elements have not been implemented in this release. This property is not currently used.

Note: This property applies to grid elements only.

Use this property to set or return a Boolean value.

This property is read/write.

Description

Important! Grid elements have not been implemented in this release. This property is not currently used.

Note: This property applies to grid elements only.

Use this property to set or return a Boolean value.

This property is read/write.

Description

Important! Grid elements have not been implemented in this release. This property is not currently used.

Note: This property applies to grid elements only.

Use this property to set or return a Boolean value.

This property is read/write.

Description

Important! Grid elements have not been implemented in this release. This property is not currently used.

Note: This property applies to grid elements only.

Use this property to set or return a Boolean value.

This property is read/write.

Description

Important! Grid elements have not been implemented in this release. This property is not currently used.

Note: This property applies to grid elements only.

Use this property to set or return a Boolean value.

This property is read/write.

Description

Note: This property applies to all element types.

Use this property to specify additional plug-in attributes for the element.

This property is read/write.

Example

For the case in which a JavaScript program adds new behavior to current jQuery Mobile widgets or to core functionality, you can add appropriate attributes through this property. For example:

&Element.PlugIn = 'data-rel="back"'

Description

Use the PreSelected property to set or return a string value representing the name of the item in a menu or select box that is to be pre-selected.

This property is read/write.

Description

Use this property to dynamically update the layout container for this element as a String value.

This property is read/write.

Description

Use the RefLayoutContHidden property to set or return a Boolean value indicating whether the layout container for this element is hidden or displayed.

This property is read/write.

Description

Use the RefLayoutHidden property to set or return a boolean value indicating whether to not render the referenced layout for the element.

This property is read/write.

Description

Use this property to set or return a String representing the label displayed after the row count when the row count has been enabled for a table or list view element. If this property is not set, the default value of "Rows" is used.

This property is read/write.

Description

Note: This property applies to push button elements only.

For a push button defined with a button type of Save, use this property to set or return a Boolean value indicating whether to suppress the pop-up message indicating save results.

This property is read/write.

Description

Note: This property applies to push button elements only.

For a push button defined with a button type of Save, use this property to set or return a Boolean value indicating whether to redirect to another page (or update the same page) instead of displaying the pop-up message indicating save results.

This property is read/write.

Description

Note: This property applies to URL elements only.

Use this property to set or return a Boolean value indicating whether the URL is constructed from a REST provider service operation or layout if applicable (secure REST target location defined).

This property is read/write.

Description

Note: This property applies to sidebar elements only.

Use this property to set or return a Boolean value indicating whether animation for the sidebar is off.

This property is read/write.

Description

Note: This property applies to sidebar elements only.

Use this property to set or return an Integer representing how to animate the sidebar with respect to the page.

The values can be one of the following constants:

Constant Value

Description

%MAP_Display_Reveal

The sidebar sits under the page and is revealed as the page slides away.

Note: %MAP_Display_Reveal is the default value.

%MAP_Display_Overlay

The sidebar appears on top of the page contents.

%MAP_Display_Push

The sidebar and page are both animated at the same time.

This property is read/write.

Description

Note: This property applies to sidebar elements only.

Use this property to set or return a Boolean value indicating whether to turn off the swipe-to-close behavior. By default, swiping left or right or pressing the Esc key will close the sidebar.

This property is read/write.

Description

Note: This property applies to sidebar elements only.

Use this property to set or return a Boolean value indicating whether to prevent closing the sidebar by clicking outside the sidebar. By default, sidebars can also be closed by clicking outside the sidebar in the page contents.

This property is read/write.

Description

Note: This property applies to sidebar elements only.

Use this property to set or return a Boolean value indicating whether to display the sidebar no matter how far down the page the user has scrolled.

This property is read/write.

Description

Note: This property applies to sidebar elements only.

Use this property to set or return a Boolean value indicating whether to display the sidebar on the right side of the screen. The default position of the sidebar is on the left side of the screen.

This property is read/write.

Description

Note: This property applies to slider elements only.

Use this property to set or return an Integer representing the default value for the slider.

This property is read/write.

Description

Note: This property applies to slider elements only.

Use this property to set or return a Boolean value indicating whether to disable the slider so that users cannot interact with it.

This property is read/write.

Description

Note: This property applies to slider elements only.

Use this property to set or return a Boolean value indicating whether to highlight the slider track to the left of the handle.

This property is read/write.

Description

Note: This property applies to slider elements only.

Use this property to set or return an Integer representing maximum value for the slider.

This property is read/write.

Description

Note: This property applies to slider elements only.

Use this property to set or return a Boolean value indicating whether to display a compact version of the slider.

This property is read/write.

Description

Note: This property applies to slider elements only.

Use this property to set or return an Integer representing the minimum value for the slider.

This property is read/write.

Description

Note: This property applies to slider elements only.

Use this property to set or return an Integer representing the step increment for the slider.

This property is read/write.

Description

Note: This property applies to slider elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the track for the slider.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to all element types.

Use this property to set or return a String representing the style for the label for this element. This property corresponds to the Style field in the Layout grid. See Using the Layout Grid for more information.

Note: Use the ContStyle property to set or return the style for the data for this element.

This property is read/write.

Example

For example, use the Style property to hide both the label and the data for an element so that the element is not displayed on the MAP page:

&Element.Style = "display:none";

Description

Use the SubContainer property to set or return the name of the subcontainer for this element as a string value.

This property is read/write.

Description

Use the SubPage property to set or return the index for the subpage for this element as an integer value.

This property is read/write.

Description

Note: This property applies to table element (column) elements only.

Use this property to set or return a Boolean value indicating whether this table column is hidden from display regardless of table size or column priority.

This property is read/write.

Description

Note: This property applies to table elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the Columns... popup for this table.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to table elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the Columns... button for the table.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to table elements only.

Use this property to set or return a Boolean value indicating whether to hide less important (lower priority) table columns at narrow screen widths. When this property is set to True, the Columns... button is displayed to allow the user to select which columns to be displayed.

This property is read/write.

Description

Note: This property applies to table elements only.

Use this property to set or return a Boolean value indicating whether to allow the MAP application developer to add customizations through CSS or media queries.

This property is read/write.

Description

Use this property to set or return a String representing the class name for the for this table row.

This property is read/write.

Description

Use this property to set or return a String representing the style for the for this table row.

This property is read/write.

Description

Note: This property applies to table elements only.

Use this property to set or return a Boolean value indicating whether to shade alternate rows in the table.

This property is read/write.

Description

Note: This property applies to image/static text and static text elements only.

Use this property to set or return an Integer from 1–6 representing the text size. The integer values correspond to HTML heading tags (h1, h2, h3, ... h6).

This property is read/write.

Description

Note: This property applies to all elements.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the label for this element. This property corresponds to the Theme field in the Layout grid. See Using the Layout Grid for more information.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Note: Use the ContTheme property to set or return the theme for the data for this element.

Description

Note: This property applies to list view elements only.

Use this property to set or return a String representing the jQuery Mobile swatch assigned to the divider for this list view.

Specify the value as one of the following constants:

Constant Value

Swatch Description

Color (in the Default Theme)

%MAP_Theme_a

Highest level of visual priority.

Black

%MAP_Theme_b

Secondary level of visual priority.

Blue

%MAP_Theme_c

Baseline level (default swatch).

Gray

%MAP_Theme_d

Alternate secondary level.

Gray

%MAP_Theme_e

Accent swatch.

Yellow

For more information on the default JQuery Mobile theme and its color swatches, see “Themes” in Understanding Layout Template Container Terms and Concepts.

This property is read/write.

Description

Note: This property applies to URL elements only.

Use this property to set or return a Boolean value indicating whether to use the defined alternative URL instead of the URL element’s standard URL. Use this property when you want to dynamically change the element’s mapped URL due to a form factor change.

This property is read/write.

Description

Note: This property applies to URL elements only.

Use this property to set or return a Boolean value indicating whether to access the new page through an HTTP POST operation. By default an external page is called though an HTTP GET operation. If the data to be passed as arguments needs to be secure, set the URLPost property to True to make the request through an HTTP POST.

This property is read/write.

Description

Note: This property applies to URL elements only.

Use this property to set or return a Boolean value indicating whether to open the new page in the same window.

Note: Ensure that the new page has an appropriate back action so that the user can return to your MAP application.

This property is read/write.

Description

Note: This property applies to URL elements only.

Use this property to return an Integer representing the type defined for this URL element.

The values can be one of the following:

  • %MAP_URL

  • %MAP_LAYOUT

  • %MAP_REST

  • %MAP_Internal

  • %MAP_External

This property is read-only.