Back to Devexpress

CheckButton Properties

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

latest43.8 KB
Original Source

CheckButton Properties

A button that supports two states - elevated and depressed. It is possible to prevent the button from receiving focus on click. Multiple buttons can be combined into a radio group, in which only one button is checked at a time.

NameDescription
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
AllowAllUncheckedGets or sets whether a checked button that belongs to a logical group can be unchecked by clicking this button.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowFocusGets or sets whether the button can be focused. Inherited from SimpleButton.
AllowGlyphSkinningGets or sets whether the current SimpleButton icon should be painted with the button’s fore color. Inherited from SimpleButton.
AllowHtmlDrawGets or sets whether the current SimpleButton‘s caption can be formatted using HTML-tags. Inherited from SimpleButton.
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.
AppearanceGets the appearance settings used to paint the control’s contents. Inherited from BaseStyleControl.
AppearanceDisabledProvides access to the appearance settings applied when the current button is disabled. Inherited from BaseButton.
AppearanceHoveredProvides access to the appearance settings applied when the mouse pointer passes over the current button. Inherited from BaseButton.
AppearancePressedProvides access to the appearance settings applied when the current button is clicked. Inherited from BaseButton.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSizeGets or sets whether the control’s size is automatically calculated based on its contents. Inherited from SimpleButton.
AutoSizeInLayoutControlThis member is not supported for the SimpleButton control. Use the SimpleButton.AutoWidthInLayoutControl property instead. Inherited from SimpleButton.
AutoWidthInLayoutControlGets or sets whether the control’s width is changed to display the control’s content in its entirety. This property is in effect when the control resides within a LayoutControl. Inherited from SimpleButton.
BackColorGets or sets the button’s background color. Inherited from BaseButton.
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.
BorderStyleThis member is not supported. Inherited from BaseButton.
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.
ButtonStyleGets or sets the style of the button control. Inherited from BaseButton.
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.
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.
CheckedGets or sets the button’s check state.
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.
CommandGets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. Inherited from BaseButton.
CommandParameterGets or sets the parameter that is passed to the command specified by the Command property. Inherited from BaseButton.
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 shortcut menu associated with the control. Inherited from Control.
ContextMenuStripGets or sets the ContextMenuStrip associated with this control. Inherited from Control.
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.
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.
DialogResultGets or sets a value that is returned to the parent form when the button is clicked. Inherited from BaseButton.
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.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
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 the control’s content. Inherited from BaseStyleControl.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the control’s foreground color. Inherited from BaseStyleControl.
GlyphAlignmentObsolete. Gets or sets the alignment of the image displayed within the button. Inherited from SimpleButton.
GroupIndexGets or sets the button’s group index. Within a group, only one button may be checked at a time. When users click another button in a group, the checked state moves from the current button to the clicked one.
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.
ImageGets or sets the button’s image. Inherited from SimpleButton.
ImageAlignmentObsolete. Gets or sets the alignment of the image displayed within the button. Inherited from SimpleButton.
ImageIndexGets or sets the index of the image displayed on the button. Inherited from SimpleButton.
ImageListGets or sets the source of images to be displayed within the button. Inherited from SimpleButton.
ImageLocationSpecifies the image alignment relative to the button. Inherited from SimpleButton.
ImageOptionsProvides access to all properties that allow you to assign and customize an icon for this SimpleButton. Inherited from SimpleButton.
ImageToTextAlignmentGets or sets how the button’s image is aligned relative to the button’s text. Inherited from SimpleButton.
ImageToTextIndentGets or sets the ditance between the button’s image and text. This property is in effect if the button’s image is aligned relative to the text. Inherited from SimpleButton.
ImageUri

Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current button. A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size).

Inherited from SimpleButton. | | ImeMode | Gets or sets the Input Method Editor (IME) mode of the control. Inherited from Control. | | ImeModeBase protected | Gets or sets the IME mode of a control. Inherited from Control. | | InvokeRequired | Gets 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. | | IsAccessible | Gets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control. | | IsDesignMode | Gets a value indicating whether the control is currently in design mode. Inherited from BaseControl. | | IsDisposed | Gets a value indicating whether the control has been disposed of. Inherited from Control. | | IsHandleCreated | Gets a value indicating whether the control has a handle associated with it. Inherited from Control. | | IsLoading | Gets whether the control is being initialized. Inherited from BaseControl. | | IsMirrored | Gets a value indicating whether the control is mirrored. Inherited from Control. | | IsRightToLeft | Gets whether the ControlBase‘s visual elements are actually aligned to support locales using right-to-left fonts. Inherited from ControlBase. | | LayoutEngine | Gets a cached instance of the control’s layout engine. Inherited from Control. | | Left | Gets 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. | | Location | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control. | | LookAndFeel | Provides access to the object containing the control’s look and feel settings. Inherited from BaseControl. | | Margin | Gets or sets the space between controls. Inherited from Control. | | MaximumSize | Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control. | | MinimumSize | Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control. | | ModifierKeys static | Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control. | | MouseButtons static | Gets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control. | | MousePosition static | Gets the position of the mouse cursor in screen coordinates. Inherited from Control. | | Name | Gets or sets the name of the control. Inherited from Control. | | Padding | Gets or sets padding within the control. Inherited from Control. | | PaintStyle | Gets or sets the button’s paint style. Inherited from BaseButton. | | Parent | Gets or sets the parent container of the control. Inherited from Control. | | PreferredSize | Gets the size of a rectangular area into which the control can fit. Inherited from Control. | | ProductName | Gets the product name of the assembly containing the control. Inherited from Control. | | ProductVersion | Gets the version of the assembly containing the control. Inherited from Control. | | PropagatingImeMode protected static | Gets an object that represents a propagating IME mode. Inherited from Control. | | RecreatingHandle | Gets a value indicating whether the control is currently re-creating its handle. Inherited from Control. | | Region | Gets or sets the window region associated with the control. Inherited from Control. | | RenderRightToLeft protected | This property is now obsolete. Inherited from Control. | | ResizeRedraw protected | Gets or sets a value indicating whether the control redraws itself when resized. Inherited from Control. | | Right | Gets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control. | | RightToLeft | Gets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control. | | ScaleChildren protected | Gets a value that determines the scaling of child controls. Inherited from Control. | | ScaleFactor | Returns scale multipliers that are currently applied to a control’s original width and height. Inherited from BaseControl. | | ShowFocusCues protected | Gets a value indicating whether the control should display focus rectangles. Inherited from Control. | | ShowFocusRectangle | Gets or sets whether the dotted focus rectangle is displayed within the SimpleButton when it has focus. Inherited from SimpleButton. | | ShowKeyboardCues protected | Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control. | | ShowToolTips | Gets or sets whether a tooltip should be displayed when the mouse pointer is over the control. Inherited from BaseControl. | | Site | Gets or sets the site of the control. Inherited from Control. | | Size | Gets or sets the height and width of the control. Inherited from Control. | | StyleController | Gets or sets the style controller component that provides style settings for this control. Inherited from BaseControl. | | SuperTip | Gets or sets a SuperToolTip for the current control. Inherited from BaseControl. | | TabIndex | Gets or sets the tab order of the control within its container. Inherited from Control. | | TabStop | Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control. | | Tag | Gets or sets the object that contains data about the control. Inherited from Control. | | Text | Gets or sets the text string displayed within the button control. Inherited from SimpleButton. | | ToolTip | Gets or sets a regular tooltip’s text content. Inherited from BaseControl. | | ToolTipAnchor | Gets or sets whether the tooltip is anchored relative to the mouse pointer or the button. Inherited from BaseButton. | | ToolTipController | Gets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for this control. Inherited from BaseControl. | | ToolTipIconType | Gets or sets the type of the tooltip icon. Inherited from BaseControl. | | ToolTipTitle | Gets or sets a regular tooltip’s title. Inherited from BaseControl. | | Top | Gets 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. | | TopLevelControl | Gets 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. | | UseWaitCursor | Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control. | | Visible | Gets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control. | | Width | Gets or sets the width of the control. Inherited from Control. | | WindowTarget | This property is not relevant for this class. Inherited from Control. |

See Also

CheckButton Class

CheckButton Members

DevExpress.XtraEditors Namespace