Class

RadToggleSwitch

Initializes a new instance of the RadToggleSwitch class.

Declaration

public RadToggleSwitch()

Gets or sets a value indicating whether to use animation when changing its state.

Declaration

public bool AllowAnimation { get; set; }

Property Value

Gets or sets the animation frames.

Declaration

public int AnimationFrames { get; set; }

Property Value

Gets or sets the animation interval.

Declaration

public int AnimationInterval { get; set; }

Property Value

Gets the default size of the RadToggleSwitch control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets the width and height of a rectangle centered on the point the mouse button was pressed, within which a drag operation will not begin. This property is used to differentiate the Drag and Click mouse operations. If the end user drags the mouse less pixels than the value of this property and releases the mouse button, the operation will be considered as a mouse click.

Declaration

public int DragSize { get; set; }

Property Value

Gets or sets a value indicating whether the UI Automation functionality is enabled or disabled for this control.

Declaration

public override bool EnableUIAutomation { get; set; }

Property Value

Overrides RadControl.EnableUIAutomation

Implements ISupportRootUIAutomation.EnableUIAutomation

Gets or sets the Font of the control. This actually the Font property of the root element.

Declaration

public override Font Font { get; set; }

Property Value

Overrides RadControl.Font

Gets a value indicating whether the control is currently animating.

Declaration

[Browsable(false)]
public bool IsAnimating { get; }

Property Value

Gets the off element of RadToggleSwitch.

Declaration

public ToggleSwitchPartElement OffElement { get; }

Property Value

Gets or sets the text displayed when the state is Off.

Declaration

public string OffText { get; set; }

Property Value

Gets the on element of RadToggleSwitch.

Declaration

public ToggleSwitchPartElement OnElement { get; }

Property Value

Gets or sets the text displayed when the state is On.

Declaration

public string OnText { get; set; }

Property Value

Gets or sets a value indicating whether the value could be changed.

Declaration

public bool ReadOnly { get; set; }

Property Value

Determines how far the switch needs to be dragged before it snaps to the opposite side.

Declaration

public double SwitchElasticity { get; set; }

Property Value

Gets the thumb of RadToggleSwitch.

Declaration

public ToggleSwitchThumbElement Thumb { get; }

Property Value

Gets or sets width of the thumb.

Declaration

[VsbBrowsable(true)]
public int ThumbTickness { get; set; }

Property Value

Determines how ToggleSwitch button should handle mouse click and drag.

Declaration

public ToggleStateMode ToggleStateMode { get; set; }

Property Value

Gets the instance of RadToggleSwitchElement wrapped by this control. RadToggleSwitchElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadToggleSwitch.

Declaration

[Browsable(false)]
public RadToggleSwitchElement ToggleSwitchElement { get; }

Property Value

Gets or sets the value.

Declaration

public bool Value { get; set; }

Property Value

Creates and initializes the child elements of the toggle switch control.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Determines which keys are input keys for the control, enabling arrow key navigation.

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides RadControl.IsInputKey(Keys)

Handles the GotFocus event by focusing the toggle switch element.

Declaration

protected override void OnGotFocus(EventArgs e)

Parameters

Overrides RadControl.OnGotFocus(EventArgs)

Handles the Load event by enabling pan gesture support for the control.

Declaration

protected override void OnLoad(Size desiredSize)

Parameters

Overrides RadControl.OnLoad(Size)

Resets the background color theme overrides.

Declaration

protected override void ResetBackColorThemeOverrides()

Overrides RadControl.ResetBackColorThemeOverrides()

Resets the foreground color theme overrides.

Declaration

protected override void ResetForeColorThemeOverrides()

Overrides RadControl.ResetForeColorThemeOverrides()

Applies background color theme overrides to all available visual states.

Declaration

protected override void SetBackColorThemeOverrides()

Overrides RadControl.SetBackColorThemeOverrides()

Applies foreground color theme overrides to all available visual states.

Declaration

protected override void SetForeColorThemeOverrides()

Overrides RadControl.SetForeColorThemeOverrides()

Sets the value of RadToggleSwitch.

Declaration

public void SetToggleState(bool newValue)

Parameters

Sets the value of RadToggleSwitch.

Declaration

public void SetToggleState(bool newValue, bool animate)

Parameters

Toggles the value of RadToggleSwitch

Declaration

public void Toggle()

Toggles the value of RadToggleSwitch

Declaration

public void Toggle(bool animate)

Parameters

Processes Windows messages, handling UI Automation messages and other control-specific messages.

Declaration

protected override void WndProc(ref Message m)

Parameters

Overrides RadControl.WndProc(ref Message)

Occurs when the animation finishes.

Declaration

public event AnimationFinishedEventHandler AnimationFinished

Event Value

Occurs when the animation starts.

Declaration

public event AnimationStartedEventHandler AnimationStarted

Event Value

Occurs when the Value has changed.

Declaration

public event EventHandler ValueChanged

Event Value

Occurs when the Value is about to change. Cancelable.

Declaration

public event ValueChangingEventHandler ValueChanging

Event Value