EditSheet Configuration

  • Article

The XML data-island identified by the MetaXML container attribute contains the configuration information used by the EditSheet 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.

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

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

XML Structure

<editsheets>
  <editsheet>
    <globalexpanded title>
      <name>Editsheet name goes here<name>
      <key>Access key for editsheet goes here</key>
    </global>
    <templatefieldsregister>
      <![CDATA[
        HTML template goes here
      ]]>
    </template>
    <fields>
      <booleanbrowse browsereadonly default disabled hideid onbrowse onchange onerror readonly
        <browsetooltip>Tooltip for browse button</browsetooltip>
        <name>Name of field in left-hand column</name>
        <label>Checkbox label</label>
        <tooltip>Tooltip for left-hand column label</tooltip>
      </boolean>
      <datebrowse browsereadonly default disabled firstday          hide id max min onbrowse onchange onerror          onrequire onvalid readonly required
        <browsetooltip>Tooltip for browse button</browsetooltip>
        <format>Date format to use</format>
        <error>Name of field in left-hand column</error>
        <name>Column heading name</name>
        <prompt>Empty control prompt</prompt>
        <tooltip>Tooltip for left-hand column label</tooltip>
      </date>
      <numericbrowse browsereadonly default disabled hide id             max min onbrowse onchange onerror onrequire             onvalid readonly required subtype
        <browsetooltip>Tooltip for browse button</browsetooltip>
        <format>Number format to use</format>
        <error>Validation error message</error>
        <name>Name of field in left-hand column</name>
        <prompt>Empty control prompt</prompt>
        <tooltip>Tooltip for left-hand column label</tooltip>
      </numeric>
      <selectbrowse browsereadonly default disabled hide id            onbrowse onchange onerror onvalid readonly
        <browsetooltip>Tooltip for browse button</browsetooltip>
        <name>Name of field in left-hand column</name>
        <prompt>Empty control prompt</prompt>
        <tooltip>Tooltip for left-hand column label</tooltip>
        <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
        <browsetooltip>Tooltip for browse button</browsetooltip>
        <charmask>Validation character mask</charmask>
        <error>Validation error message</error>
        <name>Name of field in left-hand column</name>
        <prompt>Empty control prompt</prompt>
        <tooltip>Tooltip for left-hand column label</tooltip>
      </text>
      <timebrowse browsereadonly default disabled hideid max min onbrowse onchange onerror          onrequire onvalid readonly required
        <browsetooltip>Tooltip for browse button</browsetooltip>
        <error>Validation error message</error>
        <name>Name of field in left-hand column</name>
        <prompt>Empty control prompt</prompt>
        <tooltip>Tooltip for left-hand column label</tooltip>
      </time>
    </fields>
  </editsheet>
  <editsheet>
    another editsheet specification goes here
  </editsheet>
</editsheets>

editsheets

This optional element is used to contain multiple editsheet elements, if present. Otherwise a single editsheet element is used.

Parent Element

None (document root).

Required Child Elements

editsheet

(at least one is required, but normally two or more are present)

Optional Child Elements

None.

Data

None.

Attributes

None.

Return to XML Structure

editsheet

This required element contains the configuration information for a single EditSheet HTC.

Parent Elements

None (document root), editsheets
(can be one or the other)

Required Child Elements

global, fields

Optional Child Elements

template

Data

None.

Attributes

None.

Remarks

It can be used as the sole child of the XML data-island when a single EditSheet HTC is being used, or can occur within the editsheets element when configured as one of several EditSheet HTCs.

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

Return to XML Structure

global

This required element specifies global information about the display of an EditSheet HTC.

Parent Element

editsheet

Required Child Elements

name, key

(Required in some circumstances)

Optional Child Elements

name, key

(Optional in some circumstances)

Data

None.

Attributes

Attribute Description
expanded Specifies whether the EditSheet HTC is initially displayed as open or closed.

Optional.

Legal values: "yes" and "no". A value of "yes" causes the EditSheet HTC to initially display as open.

Default value: "no".

The value of this attribute is irrelevant if the title attribute is set to "no".
title Controls whether the EditSheet HTC is shown with a title bar containing the expand/collapse control and its name.

Optional.

Legal values: "yes" and "no". A value of "no" suppresses the display of the title bar.

Default value: "yes".

If the title attribute is set to "no", then the expanded attribute is automatically set to "yes". Also, if the title attribute is set to "no", then the name and key (sub) elements need not be specified.

Return to XML Structure

name

This element, which is required in some circumstances, provides the name of the EditSheet HTC.

Parent Element

global

Required Child Elements

None.

Optional Child Elements

None.

Data

The name of the editsheet.

Attributes

None.

Remarks

This name is sometimes called the group name.

This name is typically displayed in the title bar. This behavior can be suppressed by setting the title attribute to "no"; in this case this element is not required. If the title attribute of the containing global element is not set to "no", this element is required.

If the specific EditSheet name contains any HTML formatting directives, proper escaping must be used. For example, the string &lt; must be used for the "<" character, the string &gt; must be used for the ">" character, and the string &amp; must be used for the "&" character.

Return to XML Structure

key

This element, which is required in some circumstances, specifies a character that serves as the accessibility key associated with the EditSheet HTC.

Parent Element

global

Required Child Elements

None.

Optional Child Elements

None.

Data

The accessibility key, as indicated in the editsheet name with underlining.

Attributes

None.

Remarks

If the title attribute of the containing global element is not set to "no", this element is required.

The accessibility key for the EditSheet HTC must specify the same character identified with underlining in the EditSheet name, if any.

For example, if the EditSheet name is specified such that the user sees the string "Department", the character "d" must appear between the <key> and </key> tags.

Return to XML Structure

template

This optional element contains an HTML template for the EditSheet HTC that can contain sub-instances of Commerce Server Business Desk HTCs within it, often EditSheet and EditField HTCs.

Parent Element

editsheet

Required Child Elements

None.

Optional Child Elements

None.

Data

An HTML template expressed as character data (CDATA).

Attributes

Attribute Description
fields Specifies a space-delimited list of the IDs of any contained EditField HTCs that should be loaded using the same data and meta-data as the parent EditSheet HTC.

Optional.

Legal values: Valid IDs of contained EditField HTCs, separated by spaces.

Default value: None.

When the EditSheet HTC creates the template, it will attach the correct behavior for those EditField HTCs and also enable their OnChange, OnValid, and OnRequire events to be passed to the outer EditSheet HTC.

These EditField HTCs should not have the CLASS attribute value "EditField" set on their DIV element.
register Specifies a space-delimited list of the IDs of any contained HTCs that should have their OnChange, OnValid, and OnRequire events passed to the outer EditSheet HTC.

Optional.

Legal values: Valid IDs of contained HTCs, separated by spaces.

Default value: None.

Standard HTML input elements can also be registered so that their OnChange events will be passed to the outer EditSheet HTC. However, it is important to remember that HTML radio and check box type input elements do not fire the OnChange event.

Remarks

The register attribute is used to allow OnChange and OnRequire events generated by these sub-controls to be passed to the outer EditSheet HTC.

The fields attribute is used to create EditField HTCs for elements within the template without requiring that the EditField HTCs load their own meta-data.

Passing the OnRequire event to the outer EditSheet HTC allows the icon indicating required data to be displayed for templated sub-controls.

Passing the OnValid event to the outer EditSheet HTC allows the icon that indicates data is not valid to be displayed for templated sub-controls.

Passing the OnChange event to the outer EditSheet HTC allows proper tracking of whether changes have been made.

The following example illustrates how to create a template that contains an EditSheet HTC, an EditField HTC, and a check box as sub-controls. Note how the IDs of the EditSheet and EditField HTCs are specified in the fields and register attributes of the template element:

  <template fields="esSubControl2" register="esSubControl1">
    <![CDATA[
      <DIV ID='esSubControl1'
           CLASS='editSheet'
           MetaXML='esMeta1'
           DataXML='esData'>
        <H3 ALIGN="center">Loading Property Group...</H3>
      </DIV>
      <B>File Name 5:</B>
      <DIV ID='esSubControl2'
           STYLE='WIDTH:300px'
           MetaXML='esMeta1'
           DataXML='esData'>
        <H3 ALIGN="center">Loading Property...</H3>
      </DIV>
      <INPUT type="checkbox" id=checkbox1 name=checkbox1>
      <LABEL FOR=checkbox1>additional HTML controls</LABEL>
    ]]>
  </template>

Return to XML Structure

fields

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

Parent Element

editsheet

Required Child Elements

None.

Optional Child Elements

boolean, date, numeric, select, text, time

Data

None.

Attributes

None.

Remarks

When the template element is not present, elements defined within the fields element are displayed as rows in the EditSheet HTC, in the order in which they appear within the fields element. For example, the first element defines the top row and the last element defines the bottom row.

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 child elements of the fields element in the EditSheet HTC can include additional child elements, namely the name and tooltip elements. 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 field in an EditSheet HTC containing a Boolean value.

Parent Element

fields

Required Child Elements

None.

Optional Child Elements

browsetooltip, label, name, tooltip

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.

Return to XML Structure

date

This optional element provides configuration and validation information about a particular field in an EditSheet HTC containing a date value.

Parent Element

fields

Required Child Elements

None.

Optional Child Elements

browsetooltip, error, format, name, prompt, tooltip

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)

Return to XML Structure

numeric

This optional element provides configuration and validation information about a particular field in an EditSheet HTC containing a numeric value.

Parent Element

fields

Required Child Elements

None.

Optional Child Elements

browsetooltip, error, format, name, prompt, tooltip

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.

Return to XML Structure

select

This optional element provides configuration and validation information about a particular field in an EditSheet HTC containing a fixed set of choices.

Parent Element

fields

Required Child Elements

select (at least one, but generally two or more)

Optional Child Elements

browsetooltip, name, prompt, tooltip

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.

Return to XML Structure

text

This optional element provides configuration and validation information about a particular field in an EditSheet HTC containing a text value.

Parent Element

fields

Required Child Elements

name

Optional Child Elements

browsetooltip, charmask, error, prompt, tooltip

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.

Return to XML Structure

time

This optional element provides configuration and validation information about a particular field in an EditSheet HTC containing a time value.

Parent Element

fields

Required Child Elements

None.

Optional Child Elements

browsetooltip, error, name, prompt, tooltip

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.

Remarks

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

Return to XML Structure

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

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

Return to XML Structure


All rights reserved.