RepositoryItemToggleSwitch.ValueOn Property

Gets or sets the custom ToggleSwitch edit value associated with the “checked” editor state.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(true)]
[DXCategory("Behavior")]
public object ValueOn { get; set; }

VB.NET

<DXCategory("Behavior")>
<DefaultValue(True)>
Public Property ValueOn As Object

Property Value

Type	Default	Description
Object	true	An Object that is the custom ToggleSwitch edit value associated with the “checked” editor state.

Remarks

By default, toggling a ToggleSwitch editor on or off switches the value of its EditValue property between true and false respectively. If you need to assign custom values for these states, utilize the RepositoryItemToggleSwitch.ValueOn and RepositoryItemToggleSwitch.ValueOff properties.

To retrieve a value associated with a specific editor state, call the RepositoryItemToggleSwitch.GetValueByState method. Vice versa, to get an editor state associated with a specific value, call the RepositoryItemToggleSwitch.GetStateByValue method.

C#

toggleSwitch1.Properties.ValueOff = "Disabled";
toggleSwitch1.Properties.ValueOn = "Enabled";
var a = toggleSwitch1.Properties.GetValueByState(false); // returns "Disabled"
var b = toggleSwitch1.Properties.GetStateByValue("Enabled"); // returns true
var c = toggleSwitch1.Properties.GetStateByValue("Activated"); // returns false

VB.NET

toggleSwitch1.Properties.ValueOff = "Disabled"
toggleSwitch1.Properties.ValueOn = "Enabled"
Dim a = toggleSwitch1.Properties.GetValueByState(False) ' returns "Disabled"
Dim b = toggleSwitch1.Properties.GetStateByValue("Enabled") ' returns true
Dim c = toggleSwitch1.Properties.GetStateByValue("Activated") ' returns false