Configuration Schema
EDIT Element
See Also  Send comments on this topic.
Configuration Schema : EDIT Element

Glossary Item Box

Description

Used to define an Edit control in a form.

Diagram

EDIT Element

Overview

EDIT
Used to define an Edit control in a form.
height required xs:int
The height of the text box.
width required xs:int
The width of the text box.
x required xs:int
The x coordinate of the upper left corner of the text box.
y required xs:int
The y coordinate of the upper left corner of the text box
alignment optional Restriction of xs:string
The alignment of the text box's text.
autoincrement optional Restriction of xs:string
Specifies whether the value of the text box's bound field will automatically increment when a new feature is added.
autoincrementstep optional Restriction of xs:int
Specifies the autoincrement step value.
backgroundcolor optional
The background color to use for the text box. If not specified, this value is inherited from the page's backgroundcolor attribute.
border optional Restriction of xs:string
Specifies whether the text box has a border.
color optional
The color to use for the text box's text. If not specified, this value is inherited from the page's color attribute.
defaultvalue optional xs:string
A simple expression that specifies the default value of the text box.
field optional xs:string
The field of the shapefile's DBF table that is linked to the text box.
font optional
The font to use for the text box's text. If not specified, this value is inherited from the page's font attribute.
fontsize optional Restriction of xs:int
The font size to use for the text box's text. If not specified, this value is inherited from the page's fontsize attribute.
fontstyle optional Restriction of xs:string
The font style to use for the text box's text. If not specified, this value is inherited from the page's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").
group optional Restriction of xs:string
Specifies whether the text box starts a new group of controls.
hscroll optional Restriction of xs:string
Specifies if the text box should have a horizontal scroll bar.
lowercase optional Restriction of xs:string
Specifies if the characters displayed in the text box are all lowercase.
maxvalue optional xs:string
Specifies the maximum value allowed for the control. This can be a numeric or text value.
minvalue optional xs:string
Specifies the minimum value allowed for the control. This can be a numeric or text value.
multiline optional Restriction of xs:string
Specifies if the text box contains multiple lines of text.
name optional xs:string
Name of the Edit control. Used to reference the control in scripts.
onchange optional
Specify the script to run when this event occurs.
onkillfocus optional
Specify the script to run when this event occurs.
onsetfocus optional
Specify the script to run when this event occurs.
onvalidate optional
Specify the script to run when this event occurs.
password optional Restriction of xs:string
Specifies if the characters displayed in the text box are replaced by asterisks (*).
readonly optional Restriction of xs:string
Specifies whether the text box's value can be modified by the user.
required optional Restriction of xs:string
Specifies if the user must enter some text in the text box.
sip optional Restriction of xs:string
Specifies if the SIP (soft input panel) is displayed on pen devices when the text box gets the focus.
tabstop optional Restriction of xs:string
Specifies whether the TAB key can be used to move the focus to the text box.
uppercase optional Restriction of xs:string
Specifies if the characters displayed in the text box are all uppercase.
vscroll optional Restriction of xs:string
Specifies if the text box should have a vertical scroll bar.

Attributes

NameTypeUseDefaultFixedDescription
heightxs:intrequired  The height of the text box.
widthxs:intrequired  The width of the text box.
xxs:intrequired  The x coordinate of the upper left corner of the text box.
yxs:intrequired  The y coordinate of the upper left corner of the text box
alignmentRestriction of xs:stringoptionalleft The alignment of the text box's text.
autoincrementRestriction of xs:stringoptional  Specifies whether the value of the text box's bound field will automatically increment when a new feature is added.
autoincrementstepRestriction of xs:intoptional1 Specifies the autoincrement step value.
backgroundcolor optional  The background color to use for the text box. If not specified, this value is inherited from the page's backgroundcolor attribute.
borderRestriction of xs:stringoptionaltrue Specifies whether the text box has a border.
color optional  The color to use for the text box's text. If not specified, this value is inherited from the page's color attribute.
defaultvaluexs:stringoptional  A simple expression that specifies the default value of the text box.
fieldxs:stringoptional  The field of the shapefile's DBF table that is linked to the text box.
font optional  The font to use for the text box's text. If not specified, this value is inherited from the page's font attribute.
fontsizeRestriction of xs:intoptional  The font size to use for the text box's text. If not specified, this value is inherited from the page's fontsize attribute.
fontstyleRestriction of xs:stringoptionalregular The font style to use for the text box's text. If not specified, this value is inherited from the page's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").
groupRestriction of xs:stringoptionalfalse Specifies whether the text box starts a new group of controls.
hscrollRestriction of xs:stringoptionalfalse Specifies if the text box should have a horizontal scroll bar.
lowercaseRestriction of xs:stringoptionalfalse Specifies if the characters displayed in the text box are all lowercase.
maxvaluexs:stringoptional  Specifies the maximum value allowed for the control. This can be a numeric or text value.
minvaluexs:stringoptional  Specifies the minimum value allowed for the control. This can be a numeric or text value.
multilineRestriction of xs:stringoptionalfalse Specifies if the text box contains multiple lines of text.
namexs:stringoptional  Name of the Edit control. Used to reference the control in scripts.
onchange optional  Specify the script to run when this event occurs.
onkillfocus optional  Specify the script to run when this event occurs.
onsetfocus optional  Specify the script to run when this event occurs.
onvalidate optional  Specify the script to run when this event occurs.
passwordRestriction of xs:stringoptionalfalse Specifies if the characters displayed in the text box are replaced by asterisks (*).
readonlyRestriction of xs:stringoptionalfalse Specifies whether the text box's value can be modified by the user.
requiredRestriction of xs:stringoptionalfalse Specifies if the user must enter some text in the text box.
sipRestriction of xs:stringoptionalauto Specifies if the SIP (soft input panel) is displayed on pen devices when the text box gets the focus.
tabstopRestriction of xs:stringoptionaltrue Specifies whether the TAB key can be used to move the focus to the text box.
uppercaseRestriction of xs:stringoptionalfalse Specifies if the characters displayed in the text box are all uppercase.
vscrollRestriction of xs:stringoptionalfalse Specifies if the text box should have a vertical scroll bar.

Examples

Restrictions

The following attributes can only be used in edit and identify forms. They cannot be used in general forms:; field; required; The autoincrement and autoincrementstep attributes can only be used for bound EDIT controls.

Source

<xs:element name="EDIT" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Used to define an Edit control in a form.</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:attribute use="required" name="height" type="xs:int">
      <xs:annotation>
        <xs:documentation>The height of the text box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute use="required" name="width" type="xs:int">
      <xs:annotation>
        <xs:documentation>The width of the text box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="x" type="xs:int" use="required">
      <xs:annotation>
        <xs:documentation>The x coordinate of the upper left corner of the text box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="y" type="xs:int" use="required">
      <xs:annotation>
        <xs:documentation>The y coordinate of the upper left corner of the text box</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="left" name="alignment">
      <xs:annotation>
        <xs:documentation>The alignment of the text box's text.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="left" />
          <xs:enumeration value="center" />
          <xs:enumeration value="right" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="autoincrement">
      <xs:annotation>
        <xs:documentation>Specifies whether the value of the text box's bound field will automatically increment when a new feature is added.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="autoincrementstep" default="1">
      <xs:annotation>
        <xs:documentation>Specifies the autoincrement step value.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="1" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="backgroundcolor">
      <xs:annotation>
        <xs:documentation>The background color to use for the text box. If not specified, this value is inherited from the page's backgroundcolor attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="true" name="border">
      <xs:annotation>
        <xs:documentation>Specifies whether the text box has a border.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="color">
      <xs:annotation>
        <xs:documentation>The color to use for the text box's text. If not specified, this value is inherited from the page's color attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="defaultvalue" type="xs:string">
      <xs:annotation>
        <xs:documentation>A simple expression that specifies the default value of the text box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="field" type="xs:string">
      <xs:annotation>
        <xs:documentation>The field of the shapefile's DBF table that is linked to the text box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="font">
      <xs:annotation>
        <xs:documentation>The font to use for the text box's text. If not specified, this value is inherited from the page's font attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="fontsize">
      <xs:annotation>
        <xs:documentation>The font size to use for the text box's text. If not specified, this value is inherited from the page's fontsize attribute.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:int">
          <xs:minInclusive value="1" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="regular" name="fontstyle">
      <xs:annotation>
        <xs:documentation>The font style to use for the text box's text. If not specified, this value is inherited from the page's fontstyle attribute. If the value is not regular, it can be any combination of other values, expressed as a comma delimited list (for example, fontstyle="bold,underline").</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="regular" />
          <xs:enumeration value="bold" />
          <xs:enumeration value="italic" />
          <xs:enumeration value="underline" />
          <xs:enumeration value="strikeout" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="false" name="group">
      <xs:annotation>
        <xs:documentation>Specifies whether the text box starts a new group of controls.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="hscroll" default="false">
      <xs:annotation>
        <xs:documentation>Specifies if the text box should have a horizontal scroll bar.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="lowercase" default="false">
      <xs:annotation>
        <xs:documentation>Specifies if the characters displayed in the text box are all lowercase.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="maxvalue" type="xs:string">
      <xs:annotation>
        <xs:documentation>Specifies the maximum value allowed for the control. This can be a numeric or text value.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="minvalue" type="xs:string">
      <xs:annotation>
        <xs:documentation>Specifies the minimum value allowed for the control. This can be a numeric or text value.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="multiline" default="false">
      <xs:annotation>
        <xs:documentation>Specifies if the text box contains multiple lines of text.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="name" type="xs:string">
      <xs:annotation>
        <xs:documentation>Name of the Edit control. Used to reference the control in scripts.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onchange">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onkillfocus">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onsetfocus">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onvalidate">
      <xs:annotation>
        <xs:documentation>Specify the script to run when this event occurs.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="password" default="false">
      <xs:annotation>
        <xs:documentation>Specifies if the characters displayed in the text box are replaced by asterisks (*).</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="false" name="readonly">
      <xs:annotation>
        <xs:documentation>Specifies whether the text box's value can be modified by the user.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="false" name="required">
      <xs:annotation>
        <xs:documentation>Specifies if the user must enter some text in the text box.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="auto" name="sip">
      <xs:annotation>
        <xs:documentation>Specifies if the SIP (soft input panel) is displayed on pen devices when the text box gets the focus.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
          <xs:enumeration value="auto" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute default="true" name="tabstop">
      <xs:annotation>
        <xs:documentation>Specifies whether the TAB key can be used to move the focus to the text box.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="uppercase" default="false">
      <xs:annotation>
        <xs:documentation>Specifies if the characters displayed in the text box are all uppercase.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="vscroll" default="false">
      <xs:annotation>
        <xs:documentation>Specifies if the text box should have a vertical scroll bar.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:enumeration value="true" />
          <xs:enumeration value="false" />
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also

© 2013 All Rights Reserved.