CheckBoxGlyphs.Checked Property

A custom glyph image for the Checked checkbox state.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

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

Declaration

C#

[DefaultValue(null)]
public ImageSource Checked { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property Checked As ImageSource

Property Value

Type	Default	Description
ImageSource	*null*	A custom glyph image

Remarks

The code sample below illustrates how to create a checkbox with custom glyphs.

C#

using DevExpress.XtraReports.UI;
using DevExpress.XtraPrinting.Drawing;
// ...
public XRCheckBox CreateXRCheckBox() {
    // Create an XRCheckBox object.
    XRCheckBox xrCheckBox1 = new XRCheckBox();

    // Set the glyph size
    xrCheckBox1.GlyphOptions.Size = new SizeF(18, 18);
    // Set the glyph style
    xrCheckBox1.GlyphOptions.Style = DevExpress.XtraPrinting.GlyphStyle.Thumb;
    // Align the glyph to the right
    xrCheckBox1.GlyphOptions.Alignment = DevExpress.Utils.HorzAlignment.Far;

    // Add a glyph image for the Checked state
    xrCheckBox1.GlyphOptions.CustomGlyphs[CheckState.Checked] = ImageSource.FromFile(".\\checkbox-checked.svg");
    // Add a glyph image for the Unchecked state
    xrCheckBox1.GlyphOptions.CustomGlyphs[CheckState.Unchecked] = ImageSource.FromFile(".\\checkbox-unchecked.svg");
    // Add a glyph image for the Indeterminate state
    xrCheckBox1.GlyphOptions.CustomGlyphs[CheckState.Indeterminate] = ImageSource.FromFile(".\\checkbox-indeterminate.svg");

    return xrCheckBox1;
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraPrinting.Drawing
' ...
Public Function CreateXRCheckBox() As XRCheckBox
    ' Create an XRCheckBox object.
    Dim xrCheckBox1 As New XRCheckBox()

    ' Set the glyph size
    xrCheckBox1.GlyphOptions.Size = New SizeF(18, 18)
    ' Set the glyph style
    xrCheckBox1.GlyphOptions.Style = DevExpress.XtraPrinting.GlyphStyle.Thumb
    ' Align the glyph to the right
    xrCheckBox1.GlyphOptions.Alignment = DevExpress.Utils.HorzAlignment.Far

    ' Add a glyph image for the Checked state
    xrCheckBox1.GlyphOptions.CustomGlyphs(CheckState.Checked) = ImageSource.FromFile(".\checkbox-checked.svg")
    ' Add a glyph image for the Unchecked state
    xrCheckBox1.GlyphOptions.CustomGlyphs(CheckState.Unchecked) = ImageSource.FromFile(".\checkbox-unchecked.svg")
    ' Add a glyph image for the Indeterminate state
    xrCheckBox1.GlyphOptions.CustomGlyphs(CheckState.Indeterminate) = ImageSource.FromFile(".\checkbox-indeterminate.svg")

    Return xrCheckBox1
End Function