DynamicTable Configuration

  • Article

The XML data-island identified by the MetaXML container attribute contains the configuration information used by the DynamicTable HTML component (HTC).

For more information about how an XML document can be included on a page (creating an XML data-island), see XML Data-Islands.

The structure of this data-island is shown below, with links to more detailed explanations of each element. Element attributes are shown in italic and without the values that are normally associated with them. Required elements and attributes are shown in bold; optional elements and attributes are not in bold.

Ee784891.note(en-US,CS.10).gif Note

  • The XML elements and attributes in the MetaXML data-island for the DynamicTable HTC must be expressed in lowercase letters.

XML Structure

<dynamictable>
  <globalremovebutton keycol newbutton overx          required sortbykey uniquekey />
  <fields>
    <booleanbrowse browsereadonly default disabled hideid onbrowse onchange onerror readonly width
      <browsetooltip>Tooltip for browse button</browsetooltip>
      <name>Column heading name</name>
      <label>Checkbox label</label>
    </boolean>
    <datebrowse browsereadonly default disabled firstday          hide id max min onbrowse onchange onerror          onrequire onvalid readonly required width
      <browsetooltip>Tooltip for browse button</browsetooltip>
      <format>Date format to use</format>
      <error>Validation error message</error>
      <name>Column heading name</name>
      <prompt>Empty control prompt</prompt>
    </date>
    <numericbrowse browsereadonly default disabled hide id             max min onbrowse onchange onerror onrequire             onvalid readonly required subtypewidth
      <browsetooltip>Tooltip for browse button</browsetooltip>
      <format>Number format to use</format>
      <error>Validation error message</error>
      <name>Column heading name</name>
      <prompt>Empty control prompt</prompt>
    </numeric>
    <selectbrowse browsereadonly default disabled hide id            onbrowse onchange onerror onvalid readonly width
      <browsetooltip>Tooltip for browse button</browsetooltip>
      <name>Column heading name</name>
      <prompt>Empty control prompt</prompt>
      <selectid>
        <optionvalue>Item display name</option>
      </select>
      ...
      <selectid>
        <optionvalue>Item display name</option>
      </select>
    </select>
    <textbrowse browsereadonly default disabled hide id          maxlen minlen onbrowse onchange onerror onrequire          onvalid readonly required subtype width
      <browsetooltip>Tooltip for browse button</browsetooltip>
      <charmask>Validation character mask</charmask>
      <error>Validation error message</error>
      <name>Column heading name</name>
      <prompt>Empty control prompt</prompt>
    </text>
    <timebrowse browsereadonly default disabled hideid max min onbrowse onchange onerror          onrequire onvalid readonly required width
      <browsetooltip>Tooltip for browse button</browsetooltip>
      <error>Validation error message</error>
      <name>Column heading name</name>
      <prompt>Empty control prompt</prompt>
    </time>
  </fields>
</dynamictable>

dynamictable

This required element serves as the container for the DynamicTable configuration data that identifies it as intended for use with a DynamicTable HTC.

Parent Element

None (document root).

Required Child Elements

global, fields

Optional Child Elements

None.

Data

None.

Attributes

None.

Return to XML Structure

global

This required element provides configuration information that affects the general behavior of the DynamicTable HTC.

Parent Element

dynamictable

Required Child Elements

None.

Optional Child Elements

None.

Data

None.

Attributes

Attribute Description
removebutton Specifies whether the Remove button will be displayed.

Optional.

Legal values: "yes" and "no".

Default value: "yes".

If the value is "no", the Remove button will not be displayed.
keycol Specifies the ID of the field that will be used as the record key for sorting, unique key checks, and so forth.

Required.

Each field type for which sorting is allowed (numeric and text types only) has the required attribute id; this attribute must be set to one of those id values.
newbutton Specifies whether the New button will be displayed.

Optional.

Legal values: "yes" and "no".

Default value: "yes".

If the value is "no", the New button will not be displayed.
overx Controls the display of the last row in the table.

Optional.

Legal values: "yes" and "no".

Default value: "no".

If the value is "yes", the last row in the table is manipulated after each sort operation based on the value in the field specified by the keycol attribute. If the value of this field in the last row is "–1", the field is displayed as "Over X", where "X" is the value in the same field, one row above. If the value of this field in the last row is not "-1", a new row is inserted with "Over X" text in that field and all other fields being empty.

In the case where there are no rows, a row is inserted with "Over 0" displayed in the key column.

For more information about the OverX feature of the DynamicTable HTC, see OverX Feature.
required Specifies whether the table can be empty, and controls the display of the "required" icon.

Optional.

Legal values: "yes" and "no".

Default value: "no".

If the value is "yes", the table cannot be empty.
sortbykey Specifies whether the table is re-sorted according to the values in the field specified by the keycol attribute when the Done button is pressed.

Optional.

Legal values: "yes" and "no".

Default value: "no".

If the value is "yes", the re-sorting is performed.
uniquekey Specifies whether the uniqueness of values in the key column should be enforced.

Optional.

Legal values: "yes" and "no".

Default value: "no".

If the value is "yes", uniqueness validation is performed.

Return to XML Structure

fields

This required element contains the elements that specify the fields to be displayed in the DynamicTable HTC.

Parent Element

dynamictable

Required Child Elements

None.

Optional Child Elements

boolean, date, numeric, select, text, time

Data

None.

Attributes

None.

Remarks

The fields element must contain at least one child element, though in general it will contain several such elements, corresponding to a DynamicTable HTC with several columns.

Child elements within the fields element are displayed as columns in the DynamicTable HTC. The field specified as the key is always displayed as the first column; all other fields are displayed in the order in which they appear within the fields element.

The child elements of the fields element are essentially the same as the elements that can be defined as child elements of the editfield element in the configuration data for the EditField HTC. The primary difference is that sometimes there are some additional attributes that can be defined for the child elements when they occur within the context of the DynamicTable HTC. For information about shared attributes, see Shared EditField Attributes.

Return to XML Structure

boolean

This optional element provides configuration and validation information about a particular column in a DynamicTable HTC containing Boolean values.

Parent Element

fields

Required Child Elements

name

Optional Child Elements

browsetooltip, label

Data

None.

Attributes

Attribute Description
id, browse, browsereadonly, default, disabled, hide, onbrowse, onchange, onerror, readonly The id attribute is required. All others are optional.

For more information about these attributes, see Shared EditField Attributes.
width Specifies an initial width for the column corresponding to this element, expressed as a percentage of the total width.

Optional.

Legal values: Integers between 0 and 100.

Default value: Total width divided by the number of displayed columns.

Return to XML Structure

date

This optional element provides configuration and validation information about a particular column in a DynamicTable HTC containing date values.

Parent Element

fields

Required Child Elements

name

Optional Child Elements

browsetooltip, error, format, prompt

Data

None.

Attributes

Attribute Description
id, browse, browsereadonly, default, disabled, hide, max, min, onbrowse, onchange, onerror, onrequire, onvalid, readonly, required The id attribute is required. All others are optional.

For more information about these attributes, see Shared EditField Attributes.
firstday Specifies the day of the week that is considered to be the first day of the week.

Optional.

Legal values: Integers between 0 (Sunday) and 6 (Saturday), inclusive.

Default value: 0 (Sunday)
width Specifies an initial width for the column corresponding to this element, expressed as a percentage of the total width.

Optional.

Legal values: Integers between 0 and 100.

Default value: Total width divided by the number of displayed columns.

Return to XML Structure

numeric

This optional element provides configuration and validation information about a particular column in a DynamicTable HTC containing numeric values.

Parent Element

fields

Required Child Elements

name

Optional Child Elements

browsetooltip, error, format, prompt

Data

None.

Attributes

Attribute Description
id, browse, browsereadonly, default, disabled, hide, max, min, onbrowse, onchange, onerror, onrequire, onvalid, readonly, required, subtype The id attribute is required. All others are optional.

For more information about these attributes, see Shared EditField Attributes.
width Specifies an initial width for the column corresponding to this element, expressed as a percentage of the total width.

Optional.

Legal values: Integers between 0 and 100.

Default value: Total width divided by the number of displayed columns.

Return to XML Structure

select

This optional element provides configuration and validation information about a particular column in a DynamicTable HTC containing a fixed set of choices.

Parent Element

fields

Required Child Elements

name, select

Optional Child Elements

browsetooltip, prompt

Data

None.

Attributes

Attribute Description
id, browse, browsereadonly, default, disabled, hide, onbrowse, onchange, onerror, onvalid, readonly The id attribute is required. All others are optional.

For more information about these attributes, see Shared EditField Attributes.
width Specifies an initial width for the column corresponding to this element, expressed as a percentage of the total width.

Optional.

Legal values: Integers between 0 and 100.

Default value: Total width divided by the number of displayed columns.

Return to XML Structure

text

This optional element provides configuration and validation information about a particular column in a DynamicTable HTC containing text values.

Parent Element

fields

Required Child Elements

name

Optional Child Elements

browsetooltip, charmask, error, prompt

Data

None.

Attributes

Attribute Description
id, browse, browsereadonly, default, disabled, hide, maxlen, minlen, onbrowse, onchange, onerror, onrequire, onvalid, readonly, required, subtype The id attribute is required. All others are optional.

For more information about these attributes, see Shared EditField Attributes.
width Specifies an initial width for the column corresponding to this element, expressed as a percentage of the total width.

Optional.

Legal values: Integers between 0 and 100.

Default value: Total width divided by the number of displayed columns.

Return to XML Structure

time

This optional element provides configuration and validation information about a particular column in a DynamicTable HTC containing time values.

Parent Element

fields

Required Child Elements

name

Optional Child Elements

browsetooltip, error, prompt

Data

None.

Attributes

Attribute Description
id, browse, browsereadonly, default, disabled, hide, max, min, onbrowse, onchange, onerror, onrequire, onvalid, readonly, required The id attribute is required. All others are optional.

For more information about these attributes, see Shared EditField Attributes.
width Specifies an initial width for the column corresponding to this element, expressed as a percentage of the total width.

Optional.

Legal values: Integers between 0 and 100.

Default value: Total width divided by the number of displayed columns.

Remarks

The format of fields associated with the time element is fixed. Hours and minutes are displayed in 24-hour format, separated by the colon character (":"). Seconds are not supported.

Return to XML Structure

browsetooltip, charmask, error, format, label, name, prompt, select, option

These nine elements are used to qualify or extend the behavior of one or more of the EditField elements of various data types, embedded within the DynamicTable HTC. For more information, see Shared EditField Child Elements.

Return to XML Structure


All rights reserved.