XRCheckBox Class

Displays True/False or Checked/Unchecked/Indeterminate values in a report

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

[DefaultBindableProperty("CheckState")]
public class XRCheckBox :
    XRFieldEmbeddableControl,
    IEditOptionsContainer

VB.NET

<DefaultBindableProperty("CheckState")>
Public Class XRCheckBox
    Inherits XRFieldEmbeddableControl
    Implements IEditOptionsContainer

Remarks

You can add this control by dragging the XRCheckBox item from the DX:18.2: Report Controls Toolbox tab onto the report.

Use one of the following properties to set the checkbox’s state:

• XRCheckBox.Checked - indicates whether the check box is selected (displays a check mark) or not (is empty).

• XRCheckBox.CheckState - specifies one of the following checkbox states:

  Unchecked

  Checked

  Indeterminate

The XRControl.Text property specifies the checkbox’s caption. You can double-click the checkbox to invoke its in-place editor and type the desired text.

You can bind the XRCheckBox.CheckState property to a data field obtained from the data source. Click the control’s smart tag, expand the Expression drop-down list for the CheckState property and select the required data field.

See the Check Box topic for more information.

Example

The following code creates an XRCheckBox object, and sets some of its properties.

C#

using DevExpress.XtraReports.UI;
// ...

public XRCheckBox CreateXRCheckBox()
{
    // Create an XRCheckBox object.
    XRCheckBox xrCheckBox1 = new XRCheckBox();

    // Bind the CheckState property to the UnitsInStock data field.
    // Change the control's text depending on the UnitsInStock data field value.
    xrCheckBox1.ExpressionBindings.AddRange(new ExpressionBinding[] {
    new ExpressionBinding("BeforePrint", "CheckState", "Iif([UnitsInStock]>=1,\'Checked\', \'Unchecked\')"),
    new ExpressionBinding("BeforePrint", "Text", 
                          "Iif([UnitsInStock]>0,\'Units in Stock: \' + [UnitsInStock], \'None\')")});

    // Set the control's size.
    xrCheckBox1.SizeF = new SizeF(150F, 20F);

    return xrCheckBox1;
}

VB.NET

Imports DevExpress.XtraReports.UI
' ...

Public Function CreateXRCheckBox() As XRCheckBox
    ' Create an XRCheckBox object.
    Dim xrCheckBox1 As New XRCheckBox()

    ' Bind the CheckState property to the UnitsInStock data field.
    ' Change the control's text depending on the UnitsInStock data field value.
    xrCheckBox1.ExpressionBindings.AddRange(New ExpressionBinding() {
    New ExpressionBinding("BeforePrint", "CheckState", "Iif([UnitsInStock]>=1,'Checked', 'Unchecked')"),
    New ExpressionBinding("BeforePrint", "Text",
                          "Iif([UnitsInStock]>0,'Units in Stock: ' + [UnitsInStock], 'None')")})

    ' Set the control's size.
    xrCheckBox1.SizeF = New SizeF(150.0F, 20.0F)

    Return xrCheckBox1
End Function

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the XRCheckBox class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-implement-a-custom-authorization-service-t488888/CS/AuthorizationService/Reports/CategoriesReport.cs#L36

private XRLabel xrLabel12;
private XRCheckBox xrCheckBox1;
private XRLabel xrLabel11;

VB.NET

Reporting_how-to-implement-a-custom-authorization-service-t488888/VB/AuthorizationService/Reports/CategoriesReport.vb#L38

Private xrLabel12 As XRLabel
Private xrCheckBox1 As XRCheckBox
Private xrLabel11 As XRLabel

Implements

IComponent

IDisposable

IEnumerable

IBrickOwner

IScriptable

DevExpress.Utils.Serializing.Helpers.IXtraSupportDeserializeCollectionItem

DevExpress.Utils.Serializing.IXtraSerializable

Inheritance

Object

MarshalByRefObject

Component

XRControl

XRFieldEmbeddableControl

XRCheckBox