CheckEdit.EditValue Property

Gets or sets the edit value.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v25.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Browsable(false)]
[DefaultValue(false)]
public override object EditValue { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue(False)>
Public Overrides Property EditValue As Object

Property Value

Type	Default	Description
Object	false	The edit value.

Remarks

CheckEdit maps each check state to a specific edit value:

Check State	Edit Value
Checked	true
Unchecked	false
Indeterminate	null

When the check state changes, EditValue is set to the corresponding value.

Custom Edit Value

Use the following properties to map custom values and their text representations to check states:

• CheckEdit.Proeprties.ValueUnchecked / DisplayValueUnchecked
• CheckEdit.Properties.ValueChecked / DisplayValueChecked
• CheckEdit.Properties.ValueGrayed / DisplayValueGrayed

The following code snippet implements the following:

• Maps custom string values to checked and unchecked states
• Displays the edit value when the check state changes

C#

checkEdit1.Properties.ValueChecked = "On";
checkEdit1.Properties.ValueUnchecked = "Off";
checkEdit1.CheckedChanged += CheckEdit1_CheckedChanged;

void CheckEdit1_CheckedChanged(object sender, EventArgs e) {
    var editor = (CheckEdit)sender;
    XtraMessageBox.Show(string.Format("CheckEdit Value: {0}", editor.EditValue));
}

VB.NET

CheckEdit1.Properties.ValueChecked = "On"
CheckEdit1.Properties.ValueUnchecked = "Off"
AddHandler CheckEdit1.CheckedChanged, AddressOf CheckEdit1_CheckedChanged

Private Sub CheckEdit1_CheckedChanged(ByVal sender As Object, ByVal e As EventArgs)
    Dim editor = CType(sender, CheckEdit)
    XtraMessageBox.Show(String.Format("CheckEdit Value: {0}", editor.EditValue))
End Sub

Tip

For runtime Check State ⇄ Edit Value conversion, handle the following events:

• QueryCheckStateByValue
• QueryValueByCheckState

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EditValue property.

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#

winforms-scheduler-sync-with-outlook/CS/SyncWithOutlook/SyncronizationOptionForm.cs#L29

private void SyncronizationOptionForm_Load(object sender, EventArgs e) {
    checkEditAllowCreateOutllok.EditValue = SyncronizationOptionForm.AllowCreateAppointmentInOutlook;
    checkEditAllowCreateScheduler.EditValue = SyncronizationOptionForm.AllowCreateAppointmentInScheduler;

winforms-popup-container-edit-with-default-ok-button/CS/MainForm.cs#L27

{
    popupContainerEditOKButtonForTest.Properties.ShowOkButton = (bool)checkEditShowOk.EditValue;
    Control currentPopupWindow = (popupContainerEditOKButtonForTest as IPopupControl).PopupWindow;

winforms-rich-text-editor-retain-original-image-uri-in-html-document/CS/Form1.cs#L20

richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, null));
embedImagesCheck.EditValue = true;
richEditControl1.ContentChanged += new EventHandler(richEditControl1_ContentChanged);

VB.NET

winforms-scheduler-sync-with-outlook/VB/SyncWithOutlook/SyncronizationOptionForm.vb#L31

Private Sub SyncronizationOptionForm_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    checkEditAllowCreateOutllok.EditValue = SyncronizationOptionForm.AllowCreateAppointmentInOutlook
    checkEditAllowCreateScheduler.EditValue = SyncronizationOptionForm.AllowCreateAppointmentInScheduler

winforms-popup-container-edit-with-default-ok-button/VB/MainForm.vb#L21

Private Sub checkEditShowOk_Properties_EditValueChanged(ByVal sender As Object, ByVal e As EventArgs)
    popupContainerEditOKButtonForTest.Properties.ShowOkButton = CBool(checkEditShowOk.EditValue)
    Dim currentPopupWindow As Control = TryCast(popupContainerEditOKButtonForTest, IPopupControl).PopupWindow

winforms-rich-text-editor-retain-original-image-uri-in-html-document/VB/Form1.vb#L16

richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromUri(imageUri, Nothing))
embedImagesCheck.EditValue = True
AddHandler richEditControl1.ContentChanged, AddressOf richEditControl1_ContentChanged