Back to Devexpress

ToggleSwitch Properties

windowsforms-devexpress-dot-xtraeditors-dot-toggleswitch-dot-underscore-properties.md

latest41.4 KB
Original Source

ToggleSwitch Properties

A check editor that uses a movable bar to edit Boolean values.

NameDescription
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the editor for use by accessibility client applications. Inherited from BaseEdit.
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications. Inherited from BaseEdit.
AccessibleNameGets or sets the object’s name used by accessibility client applications. Inherited from BaseEdit.
AccessibleRoleGets or sets the object’s accessible role. Inherited from BaseEdit.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowHtmlTextInToolTipGets or sets whether HTML formatting is allowed in the control’s regular tooltips. Inherited from BaseControl.
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSizeThis property is not relevant for this class. Inherited from Control.
AutoSizeInLayoutControlGets or sets whether the editor’s width is changed to display the editor’s content in its entirety. This property is in effect when the editor resides within a LayoutControl. Inherited from BaseCheckEdit.
BackColorGets or sets the background color of an enabled editor. Inherited from BaseEdit.
BackgroundImageGets or sets the background image displayed in the control. Inherited from Control.
BackgroundImageLayoutGets or sets the background image layout as defined in the ImageLayout enumeration. Inherited from Control.
BindingContextGets or sets the BindingContext for the control. Inherited from Control.
BindingManagerGets the BindingManagerBase object. Inherited from BaseEdit.
BorderStyleGets or sets the style used to draw the check editor’s border. Inherited from BaseCheckEdit.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CanShowDialogFor internal use. Inherited from BaseEdit.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenuGets or sets the context menu for the editor. Inherited from BaseEdit.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the ControlBase control. Inherited from ControlBase.
DataBindingsGets the data bindings for the control. Inherited from Control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultErrorIcon staticGets or sets the default error icon. Inherited from BaseEdit.
DefaultErrorIconAlignment staticGets or sets the location of the default error icon in relation to the editor. Inherited from BaseEdit.
DefaultErrorImageOptions staticGets a set of options that allow you to assign and customize the default icon displayed when an error is associated with the editor. Inherited from BaseEdit.
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protectedGets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayRectangleGets the rectangle that represents the display area of the control. Inherited from Control.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
EditorContainsFocusTests whether the editor or its popup window has focus. Inherited from BaseEdit.
EditorTypeNameGets the editor’s class name.
EditValueGets or sets the editor’s edit value, which specifies the editor’s check state.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
EnterMoveNextControlGets or sets whether focus is moved to the next control (according to the tab order) when an end-user presses ENTER. Inherited from BaseEdit.
ErrorIconGets or sets an icon displayed when an error is associated with the editor. Inherited from BaseEdit.
ErrorIconAlignmentGets or sets the alignment of the icon displayed when an error is associated with the editor. Inherited from BaseEdit.
ErrorImageOptionsGets a set of options that allow you to assign and customize an icon displayed when an error is associated with the editor. Inherited from BaseEdit.
ErrorTextGets or sets the tooltip displayed when the mouse pointer hovers over the error icon. Inherited from BaseEdit.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FontGets or sets the font used to display editor contents. Inherited from BaseEdit.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the editor content’s foreground color. Inherited from BaseEdit.
HandleGets the window handle that the control is bound to. Inherited from Control.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HeightGets or sets the height of the control. Inherited from Control.
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InplaceTypeGets or sets the inplace type of an editor. Inherited from BaseEdit.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsDesignModeGets a value indicating whether the control is currently in design mode. Inherited from BaseControl.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsDrawingThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseEdit.
IsEditorActiveGets whether the editor is active. Inherited from BaseEdit.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsLoadingGets a value indicating whether the editor is being loaded. Inherited from BaseEdit.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
IsModifiedGets or sets whether the editor’s value has been modified since the editor last received focus or since it was last validated. Inherited from BaseEdit.
IsNeedFocusThis member supports the internal editors library infrastructure and is not intended to be used from your code. Inherited from BaseEdit.
IsOnGets or sets the control’s check state.
IsRightToLeftGets whether the ControlBase‘s visual elements are actually aligned to support locales using right-to-left fonts. Inherited from ControlBase.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeelGets an object containing the editor’s look and feel settings. Inherited from BaseEdit.
MarginGets or sets the space between controls. Inherited from Control.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MenuManagerGets or sets an object that controls the look and feel of the popup menus. Inherited from BaseEdit.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
NameGets or sets the name of the control. Inherited from Control.
OldEditValueGets the last successfully validated value. Inherited from BaseEdit.
PaddingThis property is not supported by the BaseEdit class. Inherited from BaseEdit.
ParentGets or sets the parent container of the control. Inherited from Control.
PopupServiceControl staticThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseEdit.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from BaseCheckEdit.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
PropertiesGets an object containing properties, methods and events specific to the ToggleSwitch control.
ReadOnlyGets or sets whether the editor’s value cannot be changed by end-users. Inherited from BaseEdit.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
RegionGets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftGets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
ScaleChildren protectedGets a value that determines the scaling of child controls. Inherited from Control.
ScaleFactorReturns scale multipliers that are currently applied to a control’s original width and height. Inherited from BaseControl.
ServiceObjectThis method is used internally when using editors inplace and is not intended to be called in your code. Inherited from BaseEdit.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
ShowToolTipsGets or sets whether a tooltip should be displayed when the mouse pointer is over the control. Inherited from BaseControl.
SiteGets or sets the site of the control. Inherited from Control.
SizeGets or sets the height and width of the control. Inherited from Control.
StyleControllerGets or sets the style controller component that provides style settings for this control. Inherited from BaseControl.
SuperTipGets or sets a SuperToolTip for the current control. Inherited from BaseControl.
SuppressModifierKeyGets or sets whether to suppress the specified keyboard key for the editor. Inherited from BaseEdit.
TabIndexGets or sets the tab order of the control within its container. Inherited from Control.
TabStopGets or sets whether an end-user can focus this control using the TAB key. Inherited from BaseEdit.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextThis property is not supported by the ToggleSwitch class.
ToolTipGets or sets a regular tooltip’s text content. Inherited from BaseControl.
ToolTipAnchorGets or sets whether the tooltip is anchored relative to the mouse cursor or relative to the editor. This property is not in effect if you handle the ToolTipController.GetActiveObjectInfo event. Inherited from BaseEdit.
ToolTipControllerGets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for this control. Inherited from BaseControl.
ToolTipIconTypeGets or sets the type of the tooltip icon. Inherited from BaseControl.
ToolTipTitleGets or sets a regular tooltip’s title. Inherited from BaseControl.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.

See Also

ToggleSwitch Class

ToggleSwitch Members

DevExpress.XtraEditors Namespace