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

Glossary Item Box

Description

Used to define a CheckBox control in a form.

Diagram

CHECKBOX Element

Overview

CHECKBOX
Used to define a CheckBox control in a form.
height required xs:int
The height of the check box.
width required xs:int
The width of the check box.
x required xs:int
The x coordinate of the upper left corner of the check box.
y required xs:int
The y coordinate of the upper left corner of the check box
alignment optional Restriction of xs:string
The alignment of the check box's text.
backgroundcolor optional
The background color to use for the check box. If not specified, this value is inherited from the page's backgroundcolor attribute.
border optional Restriction of xs:string
Specifies whether the check box has a border.
caption optional xs:string
The caption displayed to the right of the check box.
color optional
The color to use for the check 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 check box.
field optional xs:string
The field of the shapefile's DBF table that is linked to the check box.
font optional
The font to use for the check 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 check 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 check 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 check box starts a new group of controls.
name optional xs:string
Name of the CheckBox control. Used to reference the control in scripts.
onclick 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.
readonly optional Restriction of xs:string
Specifies whether the check 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 check box.
tabstop optional Restriction of xs:string
Specifies whether the TAB key can be used to move the focus to the check box.

Attributes

NameTypeUseDefaultFixedDescription
heightxs:intrequired  The height of the check box.
widthxs:intrequired  The width of the check box.
xxs:intrequired  The x coordinate of the upper left corner of the check box.
yxs:intrequired  The y coordinate of the upper left corner of the check box
alignmentRestriction of xs:stringoptionalleft The alignment of the check box's text.
backgroundcolor optional  The background color to use for the check box. If not specified, this value is inherited from the page's backgroundcolor attribute.
borderRestriction of xs:stringoptionalfalse Specifies whether the check box has a border.
captionxs:stringoptional  The caption displayed to the right of the check box.
color optional  The color to use for the check 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 check box.
fieldxs:stringoptional  The field of the shapefile's DBF table that is linked to the check box.
font optional  The font to use for the check 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 check 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 check 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 check box starts a new group of controls.
namexs:stringoptional  Name of the CheckBox control. Used to reference the control in scripts.
onclick 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.
readonlyRestriction of xs:stringoptionalfalse Specifies whether the check box's value can be modified by the user.
requiredRestriction of xs:stringoptionalfalse Specifies if the user must enter some text in the check box.
tabstopRestriction of xs:stringoptionaltrue Specifies whether the TAB key can be used to move the focus to the check box.

Examples

Used to define a CheckBox control in a form.

Restrictions

The following attributes can only be used in edit and identify forms. They cannot be used in general forms:; field; required

Source

<xs:element name="CHECKBOX" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>Used to define a CheckBox 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 check box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute use="required" name="width" type="xs:int">
      <xs:annotation>
        <xs:documentation>The width of the check 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 check 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 check box</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="left" name="alignment">
      <xs:annotation>
        <xs:documentation>The alignment of the check 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="backgroundcolor">
      <xs:annotation>
        <xs:documentation>The background color to use for the check box. If not specified, this value is inherited from the page's backgroundcolor attribute.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute default="false" name="border">
      <xs:annotation>
        <xs:documentation>Specifies whether the check 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="caption" type="xs:string">
      <xs:annotation>
        <xs:documentation>The caption displayed to the right of the check box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="color">
      <xs:annotation>
        <xs:documentation>The color to use for the check 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 check 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 check box.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="font">
      <xs:annotation>
        <xs:documentation>The font to use for the check 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 check 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 check 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 check 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="name" type="xs:string">
      <xs:annotation>
        <xs:documentation>Name of the CheckBox control. Used to reference the control in scripts.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="onclick">
      <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="readonly" default="false">
      <xs:annotation>
        <xs:documentation>Specifies whether the check 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 check 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="true" name="tabstop">
      <xs:annotation>
        <xs:documentation>Specifies whether the TAB key can be used to move the focus to the check 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:complexType>
</xs:element>

See Also

© 2013 All Rights Reserved.