Check Box

<< Click to Display Table of Contents >>

Navigation:  User Interface Reference > Report Designer > Report Designer for WinForms > Report Designer Reference > Report Controls >

Check Box

Interface Elements for Desktop > Report Designer > Report Designer for WinForms > Report Designer Reference > Report Controls > Check Box

The Check Box control is intended to display True/False or Checked/Unchecked/Indeterminate states in a report, by displaying (or not) a check mark, which can be accompanied by a text description.

img8503

In the Property Grid, the Check Box control's properties are divided into the following groups.

ExpandedCollapsed Appearance

Background Color

Specifies the background color for the control. This option is also available in the Formatting Toolbar (img8441).

Borders, Border Color, Border Dash Style and Border Width

Specify border settings for the control.

Font

Specifies the font settings for the control. Some of these settings are available in the Formatting Toolbar.

Foreground Color

Specifies the text color for the control. This option is also available in the Formatting Toolbar (img8440).

Formatting Rules

Invokes the Formatting Rules Editor allowing you to choose which rules should be applied to the control during report generation, and define the precedence of the applied rules. To learn more on this, refer to Conditionally Change a Control's Appearance.

Padding

Specifies indent values which are used to render the contents of a Check Box.

Style Priority

Allows you to define the priority of various style elements (such as background color, border color, etc.). For more information on style inheritance, refer to Understanding Style Concepts.

Styles

This property allows you to define odd and even styles for the control, as well as to assign an existing style to the control (or a newly created one). For more information on style inheritance, refer to Understanding Style Concepts.

Text Alignment

Allows you to change the alignment of the control's text. This option is also available in the Formatting Toolbar.

Text Trimming

Specifies the string trimming mode of the control's text.

ExpandedCollapsed Behavior

Anchor Horizontally

Specifies the horizontal anchoring style of the control, so that after page rendering it stays attached to the left control, right control, or both. This property defines how a report control is resized to maintain the distance to the left and right edges of its container control.

Anchor Vertically

Specifies the vertical anchoring style of the control, so that after page rendering it stays attached to the top control, bottom control, or both. The property setting is useful for data-bound Check Boxes located between upper and lower controls, which are allowed to resize depending on their contents.

Can Publish

Specifies whether or not a report control is displayed in a printed or exported document.

Keep Together

Specifies whether the contents of a Check Box can be horizontally split across pages. In other words, if a Check Box occupies more space than remains on the page, this property specifies whether this Check Box should be split between the current page and the next, or whether it will be printed entirely on the next page. This property is in effect only when a Check Box's content does not fit on the current page. If it does not fit on the next page either, then the Check Box will be split despite this property's value.

Scripts

This property contains events, which you can handle with the required scripts. For more information on scripting, refer to Handle Events via Scripts.

Visible

Specifies whether the control should be visible in print preview.

Word Wrap

When this property is set to Yes, text entered into a Check Box is wrapped to the next line if it doesn't fit the line.

ExpandedCollapsed Data

(Data Bindings)

If the current report is bound to data, this property allows you to bind some of the control's properties (Bookmark, Check State, Navigation URL, Tag and Text) to a data field obtained from the report's data source, and to apply a format string to it. For more information on this, refer to Displaying Values from a Database (Binding Report Elements to Data).

Check State

This property allows you to quickly specify the Checked/Unchecked/Indeterminate state of a Check Box (the Indeterminate state is displayed as a grayed out checked box.) Note that if you only want to use Checked and Unchecked states, you may use the Checked property, instead.

Checked

This property allows you to define whether a Check Box is checked or not.

Tag

This property allows you to add some additional information to the control; for example its id, by which it can then be accessible via scripts.

If the current report has a data source, the Tag property can be bound to a data field obtained from the data source. To do this, expand the (Data Bindings) property and in the Tag.Binding drop-down selector, select the required data field.

Text

Allows you to define a line of static text to be displayed. Note that when a Check Box is selected in the designer, you may simply start typing the text, and it will be automatically entered into the in-place editor.

img8287

If the current report has a data source, the Text property can be bound to a data field obtained from the data source. To do this, expand the (Data Bindings) property, and in the Text.Binding drop-down selector, select the required data field. For more information on this, refer to Displaying Values from a Database (Binding Report Elements to Data).

Xlsx Format String

Specifies the native XLSX format string for the control's content, which is to be preserved when the report is being exported to XLSX. This format string is independent from the general value formatting.

ExpandedCollapsed Design

(Name)

Determines a control's name, by which it can be accessed in the Report Explorer, Property Grid or via scripts.

ExpandedCollapsed Layout

Location

Specifies the control's location, in report measurement units.

Size

Specifies the control's size, in report measurement units.

Snap Line Margin

Specifies the margin (in report measurement units), which is to be preserved around the control when it is aligned using Snap Lines, or when other controls are aligned next to it.

ExpandedCollapsed Navigation

Bookmark and Parent Bookmark

These properties are intended for the creation of a hierarchical structure within a report called a document map. For an explanation and help, refer to Add Bookmarks.

If the current report has a data source, the Bookmark property can be bound to a data field obtained from the data source. To do this, expand the (Data Bindings) property and in the Bookmark.Binding drop-down selector, select the required data field.

Navigation URL and Navigation Target

Use the Navigation URL property to specify a URL for web browser navigation when a user clicks a Check Box. The web browser displays a page in a window or a frame as specified by the Navigation Target property. Note that a URL should have an appropriate prefix (e.g. "http://"). You can create cross-references within the report by assigning the name of the target control to the Navigation URL property, and setting the Navigation Target property to "_self". For more information, refer to Create Hyperlinks.

If the current report has a data source, the Navigation URL property can be bound to a data field obtained from the data source. To do this, expand the (Data Bindings) property and in the Navigation URL.Binding drop-down selector, select the required data field.

Copyright (c) 1998-2016 Developer Express Inc. All rights reserved.

Send Feedback on this topic to DevExpress.