XRCheckBox.CheckState Property

OBSOLETE

This property is now obsolete. Use the CheckBoxState property instead.

Bindable. Gets or sets the current state of the XRCheckBox object.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

[Browsable(false)]
[Obsolete("This property is now obsolete. Use the CheckBoxState property instead.")]
public CheckState CheckState { get; set; }

VB.NET

<Browsable(False)>
<Obsolete("This property is now obsolete. Use the CheckBoxState property instead.")>
Public Property CheckState As CheckState

Property Value

Type	Default	Description
CheckState	Unchecked	A CheckState enumeration value which determines the state of a checkbox.

Remarks

If this property is set to the Checked value the check box displays a check mark.

If this property is set to the Unchecked value the check box is empty.

If this property is set to the Indeterminate value and the XRCheckBox.Checked property is set to true the check box displays a shaded check mark.

Example

The code sample below illustrates how to create an XRCheckBox control for a report.

C#

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

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

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

    // Set the control 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()

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

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

    Return xrCheckBox1
End Function