Class

RadToggleSwitchElement

Declaration

public RadToggleSwitchElement()

Identifies the IsOn dependency property.

Declaration

public static RadProperty IsOnProperty

Field Value

Identifies the ThumbOffset dependency property.

Declaration

public static RadProperty ThumbOffsetProperty

Field Value

Identifies the ThumbTickness dependency property.

Declaration

public static RadProperty ThumbTicknessProperty

Field Value

Gets or sets a value indicating whether animation effects are used when the toggle switch changes state.

Declaration

public bool AllowAnimation { get; set; }

Property Value

Gets or sets the total number of animation frames used during state transitions.

Declaration

public int AnimationFrames { get; set; }

Property Value

Gets or sets the time interval in milliseconds between animation frames during state transitions.

Declaration

public int AnimationInterval { get; set; }

Property Value

Gets or sets the size of the drag threshold area that determines when a mouse operation is considered a drag versus a click.

Declaration

public int DragSize { get; set; }

Property Value

Gets a value indicating whether the toggle switch is currently performing an animation transition.

Declaration

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

Property Value

Gets a value indicating whether the toggle switch is currently in the "On" state.

Declaration

public bool IsOn { get; }

Property Value

Gets the visual element that represents the "Off" state of the toggle switch.

Declaration

public ToggleSwitchPartElement OffElement { get; protected set; }

Property Value

Gets or sets the text displayed on the toggle switch when it is in the "Off" state.

Declaration

public string OffText { get; set; }

Property Value

Gets the visual element that represents the "On" state of the toggle switch.

Declaration

public ToggleSwitchPartElement OnElement { get; protected set; }

Property Value

Gets or sets the text displayed on the toggle switch when it is in the "On" state.

Declaration

public string OnText { get; set; }

Property Value

Gets or sets a value indicating whether the toggle switch value can be modified by user interaction.

Declaration

public bool ReadOnly { get; set; }

Property Value

Gets or sets the elasticity factor that determines how far the thumb must be dragged before the switch changes state.

Declaration

public double SwitchElasticity { get; set; }

Property Value

Gets the movable thumb element that indicates the current state of the toggle switch.

Declaration

public ToggleSwitchThumbElement Thumb { get; protected set; }

Property Value

Gets or sets the horizontal offset position of the thumb element within the toggle switch.

Declaration

public int ThumbOffset { get; set; }

Property Value

Gets or sets the width of the thumb element in pixels.

Declaration

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

Property Value

Gets or sets the mode that determines how the toggle switch responds to mouse interactions such as clicks and drag operations.

Declaration

public ToggleStateMode ToggleStateMode { get; set; }

Property Value

Gets or sets the boolean value representing the current state of the toggle switch.

Declaration

public bool Value { get; set; }

Property Value

Arranges the child elements within the specified final size bounds.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

Cancels the currently running animation.

Declaration

public void CancelAnimation()

Creates and initializes the child elements that make up the toggle switch visual structure.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates and returns a new instance of a toggle switch part element.

Declaration

protected virtual ToggleSwitchPartElement CreatePartElement()

Returns

Creates and returns a new instance of the thumb element used for user interaction.

Declaration

protected virtual ToggleSwitchThumbElement CreateThumbElement()

Returns

Releases the managed resources used by the RadToggleSwitchElement.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Declaration

protected override RectangleF GetClientRectangle(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.GetClientRectangle(SizeF)

Calculates the clipping rectangle for this element, taking into account border thickness and padding.

Declaration

protected override RectangleF GetClipRect()

Returns

Overrides LightVisualElement.GetClipRect()

Initializes the default field values for the RadToggleSwitchElement.

Declaration

protected override void InitializeFields()

Overrides LightVisualElement.InitializeFields()

Declaration

protected virtual void OnAnimationFinished(AnimationStatusEventArgs e)

Parameters

Declaration

protected virtual void OnAnimationStarted(AnimationStatusEventArgs e)

Parameters

Raises the KeyDown event.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadItem.OnKeyDown(KeyEventArgs)

Called when a mouse button is pressed down over the item.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

Called when the mouse moves over the item, handling highlight and border highlight effects.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides LightVisualElement.OnMouseMove(MouseEventArgs)

Called when a mouse button is released over the item.

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseUp(MouseEventArgs)

Declaration

protected virtual void OnValueChanged()

Declaration

protected virtual void OnValueChanging(ValueChangingEventArgs e)

Parameters

Renders the border of the element using the specified graphics context, rotation angle, and scaling factor.

Declaration

protected override void PaintBorder(IGraphics graphics, float angle, SizeF scale)

Parameters

Overrides UIItemBase.PaintBorder(IGraphics, float, SizeF)

Declaration

protected virtual void ProcessAnimation()

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

Occurs when an animation transition completes.

Declaration

public event AnimationFinishedEventHandler AnimationFinished

Event Value

Occurs when an animation transition starts.

Declaration

public event AnimationStartedEventHandler AnimationStarted

Event Value

Occurs after the value of the toggle switch has changed.

Declaration

public event EventHandler ValueChanged

Event Value

Occurs before the value of the toggle switch changes and allows the change to be cancelled.

Declaration

public event ValueChangingEventHandler ValueChanging

Event Value