DesktopCustomSwitch

LibraryDescription
"A switch button that is not based on the operating system theme."

DesktopUIControl
DesktopCustomSwitch

control DesktopCustomSwitch

Properties

AcceptFocus	This property is for Mac only where focus is normally not active unless Full Keyboard access is on. Setting this to true activates focus support even if full keyboard access is not turned on in the system.
AccessibilityLabel	Label used by the macOS accessibility manager for various of disability settings and devices.
Bold	Sets the text font to bold.
ButtonColor	Sets the body color of the button when button is enabled.
ButtonShape	Configures the shape of the switch button, Rounded or Rectangular.
ButtonSize	Sets the Size of the button.
DBBackColor	Fills background with custom color when in double buffering mode. (MacOS X and Linux systems are always double buffered by the OS it self)
DMButtonColor	Sets the body color of the switch button when button is enabled in dark mode if SeparateDarkModeStyle is set to true.
DMFocusColor	Color for the focus on the switch button when button in dark mode if SeparateDarkModeStyle is set to true.
DMOffButtonColor	Color of the button when it is off when system is in dark mode and SeparateDarkModeStyle property is set to true.
DMTextColor	Sets the text color when switch is on and system is in dark mode and SeparateDarkModeStyle property is set to true.
DMTextColorOff	Sets the text color when switch is off and system is in dark mode and SeparateDarkModeStyle property is set to true.
DMUseSystemFocusColor	When system is in darkmode and SeparateDarkModeStyle is set to true then If this property is set to true then the button will attempt to use system focus color when possible, having fallback to the controls focus color.
DoubleBuffer	DoubleBuffers the drawing of the control on Windows systems. (MacOS X and Linux systems are always double buffered by the OS it self)
Enabled (Inherited)	Determines if the control should be enabled when the owning window is opened.
FocusColor	Color for the focus on the switch button.
FocusDrawingType	Configures how focus should be represented.
FontName	Sets the text font
FontSize	Sets the text font size.
FontUnit	Sets the unit of the FontSize.
Handle (Inherited)	Returns a handle to the control.
HasDBBackColor	If set to true then the color defined in the DBBackColor property will be used as background color when in double buffer mode. (MacOS X and Linux systems are always double buffered by the OS it self)
HasTextColor	If set to true then TextColor and TextColorOff properties will be used to determined text color.
Height (Inherited)	The height (in points) of the control.
IOSymbolVisible	If set to true then IO symbols are drawn in the switch.
Index (Inherited)	If the control is used in a control set, this specifies the control's index in the set.
Italic	Sets the text font to italic.
LabelVisible	If set to true then the on / off label behind the button is visible.
Left (Inherited)	The left side of the control in local coordinates (relative to the window)
OffButtonColor	Color of the button when it is off.
OffText	Property to localize the text for the Off state of the button.
OnText	Property to localize the text for the On state of the button.
SeparateDarkModeStyle	If set to true then the color style properties from the DM (DarkMode) named properties will be used when the system is in Darkmode.
TextColor	Sets the text color when switch is on.
TextColorOff	Sets the text color when switch is off.
TextYOffset	Use the property to adjust the Text Y offset of the text.
Top (Inherited)	The top of the control in local coordinates (relative to the window).
Underline	Sets the text font to underlined.
UseSystemFocusColor	If set to true then the button will attempt to use system focus color when possible, having fallback to the controls focus color.
Value	Value of the button, false for off and true for on.
Visible (Inherited)	Determines whether the control is visible when its owning window is opened. The default is True: the control is visible.
Width (Inherited)	The width (in points) of the control.
Window (Inherited)	The control's parent window.

Methods

Close (Inherited)	Closes a control.
Press	Visually simulates mouse press on the switch.
ReloadEvents	Reloads events if having used AddHandler to subscribe events.
SetFocus (Inherited)	If applicable, sets the focus to the DesktopUIControl. KeyDown events are directed to the control.

Events

ConstructContextualMenu (Inherited)	This event is called when it is appropriate to display a contextual menu for the control.
ContextualMenuItemSelected (Inherited)	Fires when a contextual menuitem selectedItem was selected but the MenuItemSelected event and the MenuHandler for the DesktopMenuItem did not handle the menu selection.
DragEnter (Inherited)	Fires when the passed DragItem enters the DesktopUIControl.
DragExit (Inherited)	Fires when the passed DragItem exits the DesktopUIControl.
DragOver (Inherited)	Fires when the DragItem is over the DesktopUIControl.
DropObject (Inherited)	The item represented by Obj has been dropped on the control.
FocusLost	The switch button has lost focus.
FocusReceived	The switch button has gotten focus.
KeyUp (Inherited)	Fires when the passed Key is released in the control that has the focus.
MouseDrag (Inherited)	The mouse button was pressed inside the control and moved (dragged) at the location local to the control passed in to x, y. The user has moved the mouse inside the control while the mouse button is held down. This event handler receives parameters that indicate where the mouse is in coordinates local to the control.
MouseEnter (Inherited)	The mouse has entered the area of the control.
MouseExit (Inherited)	The mouse has left the area of the control.
MouseMove (Inherited)	The mouse has moved within the control to the coordinates passed. The coordinates are local to the control, not to the window.
MouseWheel (Inherited)	The mouse wheel has been moved.
PreProcessStyle	Overrides style attribute on the button right before rendering. The override is for current rendering and alter base properties of the button.
ValueChanged	The state on the CustomSwitch has been changed either by code or user interaction.