Check Box Control

Description

The Check Box control displays text along with a box that can display three states: unchecked, checked and indeterminate. The text in the Check Box control can be manually defined or bound to a data source.

The three states of the Check Box control

Properties Common to Most Controls

For more information about the properties listed below, see Properties Common to Most Controls.

For more information regarding each of the property groups, see the Control Reference.

Actions

Text

Type: String

Can be configured in the Properties or Expressions panel.

Sets the text to appear in the print template control.

The value of the Text property can be set in a few different ways:

  • Double-click the control to start entering text.
  • Select the control and then enter text into the Text property.
  • Drag a field from the Field List onto the print template to automatically populate the Text property.

Check State

Type: CheckState

Can be configured in the Properties or Expressions panel.

Specifies the state of the control. Options include:

  • Checked: The control is checked.
  • Indeterminate: The control is indeterminate.
  • Unchecked: The control is unchecked.

The three states of the Check Box control

Glyph Options: Custom Glyphs

Glyphs are the images used for the check boxes. A custom image can be set for each check state.

When no custom glyph image is specified, the control displays a glyph image specified by the Glyph Style property.

Images are resized based upon the configurations in the Size property.

Glyph Options: Alignment

Specifies the glyph alignment within the control.

Alignment options include:

  • Near: Sets the check box on the left side of the text. This is the default position.
  • Center: Centers the check box within the control
  • Far: Sets the check box on the right side of the text.

Glyph Options: Size

Specifies the height and width of the check box in pixels.

Glyph Options: Style

Sets the glyph using a pre-configured styles.

Options include the following:

Examples of each of the Glyph Styles available

Appearance

Glyph Options: Custom Glyphs

Glyphs are the images used for the check boxes. A custom image can be set for each check state.

When no custom glyph image is specified, the control displays a glyph image specified by the Glyph Style property.

Images are resized based upon the configurations in the Size property.

Glyph Options: Alignment

Specifies the glyph alignment within the control.

Alignment options include:

  • Near: Sets the check box on the left side of the text. This is the default position.
  • Center: Centers the check box within the control
  • Far: Sets the check box on the right side of the text.

Glyph Options: Size

Specifies the height and width of the check box in pixels.

Glyph Options: Style

Sets the glyph using a pre-configured styles.

Options include the following:

Examples of each of the Glyph Styles available

Text Alignment

Can be configured in the Properties or Expressions panel.

Specifies the alignment of the print item's text.

Text Trimming

Type: StringTrimming

Can be configured in the Properties or Expressions panel.

Sets the trimming mode applied to text when all text cannot fit into the size of the control.

Options include:

  • None: Text is not trimmed.
  • Character: Text is trimmed to the nearest character.
  • Ellipsis Character: Text is trimmed to the nearest character and an ellipsis is inserted at the end of the trimmed line.
  • Ellipsis Path: Center is removed from trimmed lines and replaced by an ellipsis.
  • Ellipsis Word: Text is trimmed to the nearest word, and an ellipsis is inserted at the end of a trimmed line.
  • Word: Text is trimmed to the nearest word.

This property is overridden if Word Wrap is set to True.

 

Behavior

Anchor Vertically

Sets the location of the control in relation to the parent container. When the parent container changes size, the control may move or resize to maintain its position.

The options for vertically anchoring include:

  • None: The control's size and location are not affected when the container size changes.
  • Top: The distance between the top of the control and the top of the container remains fixed when the container size changes.
  • Bottom: The distance between the bottom of the control and the bottom of the container remains fixed when the container size changes.
  • Both: The distance from the top and bottom of the control from the top and bottom of the container remains fixed when the container size changes. This means that control is resized to maintain these fixed distances.

Anchor Horizontally

Sets the location of the control in relation to the parent container. When the parent container changes size, the control may move or resize to maintain its position.

The options for horizontally anchoring include:

  • None: When the parent container changes size, the control's size and location are not affected when the container size changes.
  • Left: The distance between the left edge of the control and the left side of the container remains fixed when the container size changes.
  • Right: The distance between the right edge of the control and the right side of the container remains fixed when the container size changes.
  • Both: The distance from the left and right edges of the control from the left and right sides of the container remains fixed when the container size changes. This means that control is resized to maintain these fixed distances.

Word Wrap

Type: Boolean

Determines how text is rendered when it does not completely fit into the bounds of the control. When enabled, text will start a new line once it meets the right side of the control. Otherwise, the text is displayed on a single line.

Enabled by default.

Data

Check State

Type: CheckState

Can be configured in the Properties or Expressions panel.

Specifies the state of the control. Options include:

  • Checked: The control is checked.
  • Indeterminate: The control is indeterminate.
  • Unchecked: The control is unchecked.

The three states of the Check Box control

Checked

Type: Boolean

Specifies the state of the check box. When checked, this property sets the Checked State to Checked. When unchecked, this property sets the Checked State to Unchecked.

Text

Type: String

Can be configured in the Properties or Expressions panel.

Sets the text to appear in the print template control.

The value of the Text property can be set in a few different ways:

  • Double-click the control to start entering text.
  • Select the control and then enter text into the Text property.
  • Drag a field from the Field List onto the print template to automatically populate the Text property.

Text Format String

The Text Format String Editor provides the ability to apply formatting to data. You can select one of the pre-built formats or create your own.

The Text Format String Editor cannot format values that have been manually entered into a control.

For more information, see the help regarding the Format String Editor and Format Specifiers.

Printing

Right to Left

Specifies the layout of the content within a print item.

The options include:

  • Inherit: The item inherits the printing configuration set at the parent level. This is the default.
  • Yes: The content is aligned to the right.
  • No: The content is aligned to the left.

Modifying this setting will change the side that the check box appears on.

Related Tutorials

Refer to the following resources for additional help on implementing this control:

© 2020 VertiGIS North America Ltd. All Rights Reserved.

Documentation Version 5.7