Back to Devexpress

CheckContextButton Members

windowsforms-devexpress-dot-utils-dot-checkcontextbutton-dot-underscore-members.md

latest20.2 KB
Original Source

CheckContextButton Members

A context button displaying a check box that can be checked by an end-user.

Constructors

NameDescription
CheckContextButton()Initializes a new instance of the CheckContextButton class.

Properties

NameDescription
AlignmentGets or sets the current item’s alignment relative to the owner control. This property is obsolete, use ContextItem.AlignmentOptions instead. Inherited from ContextItem.
AlignmentOptionsProvides access to options that specify the panel in which the item is displayed, and its position in the panel. Inherited from ContextItem.
AllowGlyphSkinningGets or sets whether the current item’s glyph is painted using the foreground color. Inherited from ContextItem.
AllowHtmlTextCheck Context Buttons do not have captions and therefore cannot be formatted with HTML tags.
AnchorAlignmentGets or sets the alignment of the current item relative to the anchor element. Inherited from ContextItem.
AnchorElementGets or sets an item (anchor element) relative to which the current item is aligned. Inherited from ContextItem.
AnchorElementIdGets or sets the globally unique identifier of the item (anchor element), relative to which the current item is aligned. Inherited from ContextItem.
AnchorIndentGets or sets the indent between the current item and the anchor element. Inherited from ContextItem.
AnchorOffsetGets or sets the translation of the current item from the anchor element. Inherited from ContextItem.
AnimationTypeGets or sets the type of the animation used to show and hide the current item. Inherited from ContextItem.
AppearanceDisabledProvides access to appearance settings applied to this ContextItem in the Disabled state. Inherited from ContextItem.
AppearanceHoverProvides access to the settings used to paint the current item in the hovered state. Inherited from ContextItem.
AppearanceNormalProvides access to the appearance settings used to paint the current item in the normal (not hovered) state. Inherited from ContextItem.
CaptionThis member supports the internal infrastructure, and is not intended to be used directly from your code.
CheckedGets or sets whether the current button is in the checked state.
CheckedGlyphGets or sets the glyph displayed by the current button in the checked state when it is not hovered over with the mouse pointer. This property is obsolete. Use the ImageOptionsCollection property instead.
CollectionGets the collection to which the current item belongs. Inherited from ContextItem.
CommandGets or sets the ICommand whose Execute(Object) method will be called when the Click event is invoked. Inherited from ContextButtonBase.
CommandParameterGets or sets the parameter that is passed to the command specified by the Command property. Inherited from ContextButtonBase.
EnabledGets or sets whether the current item can respond to end-user interaction. Inherited from ContextItem.
GlyphGets or sets the glyph displayed by the current item in the normal (not hovered) state. This property is obsolete. Use the ImageOptionsCollection property instead. Inherited from ContextItem.
HasCheckedGlyphGets whether or not this CheckContextButton has a checked state glyph assigned.
HasGlyphGets whether or not this ContextItem has a glyph assigned. Inherited from ContextItem.
HasHoverCheckedGlyphGets whether or not this CheckContextButton has a hovered checked state glyph assigned.
HasHoverGlyphGets whether or not this ContextItem has a hovered state glyph assigned. Inherited from ContextItem.
HeightGets or sets the button height. Inherited from ContextButtonBase.
HoverCheckedGlyphGets or sets the glyph displayed by the current button in the checked state when it is hovered over with the mouse cursor. This property is obsolete. Use the ImageOptionsCollection property instead.
HoverGlyphGets or sets the glyph displayed by the current item in the hovered state. This property is obsolete. Use the ImageOptionsCollection property instead. Inherited from ContextItem.
HyperLinkColorThis property is not supported for Check Context Buttons.
IdGets or sets the current item’s unique identifier. Inherited from ContextItem.
ImageOptionsProvides access to all properties related to the CheckContextButton icon.
ImageOptionsCollectionProvides access to image-related settings for each CheckContextButton visual state - Normal, Hovered, Checked, HoveredChecked.
MaxHeightGets or sets the maximum height of the current button. Inherited from ContextButtonBase.
MaxWidthGets or sets the maximum width of the current button. Inherited from ContextButtonBase.
NameGets or sets the current item’s name. Inherited from ContextItem.
OriginItemThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from ContextItem.
PaddingGets or sets the amount of space around the current button. Inherited from ContextButtonBase.
ShowToolTipsGets or sets whether a tooltip is shown when the mouse pointer hovers over the button. Inherited from ContextItem.
SizeGets or sets the current item’s size. Inherited from ContextItem.
SuperTipGets or sets a super tooltip shown when the mouse pointer hovers over the button. Inherited from ContextItem.
TagGets or sets custom data associated with the current item. Inherited from ContextItem.
ToolTipGets or sets the text in a regular tooltip shown when the mouse pointer hovers over the button. Inherited from ContextItem.
ToolTipIconTypeGets or sets the icon in a regular tooltip shown when the mouse pointer hovers over the button. Inherited from ContextItem.
ToolTipTitleGets or sets the title in a regular tooltip shown when the mouse pointer hovers over the button. Inherited from ContextItem.
VisibilityGets or sets the item visibility. Inherited from ContextItem.
WidthGets or sets the button width. Inherited from ContextButtonBase.

Methods

NameDescription
AssignPropertiesInternal(ContextItem, Boolean)This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from ContextItem.
AssignPropertiesInternal(ContextItem)This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from ContextItem.
BeginUpdate()Locks the ContextItem object by preventing visual updates until the EndUpdate method is called. Inherited from ContextItem.
BindCommand(Expression<Action>, Object, Func<Object>)Uses the command selector to find an appropriate parameterized command in the source and bind it to this CheckContextButton.
BindCommand(Object, Func<Object>)Binds the specific parameterized command to this CheckContextButton.
BindCommand<T>(Expression<Action<T>>, Object, Func<T>)Uses the command selector to find an appropriate parameterized command of the target type in the source and bind it to this CheckContextButton.
CancelUpdate()Unlocks the ContextItem object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from ContextItem.
Clone()Creates a new ContextItem object that is a copy of the current instance. Inherited from ContextItem.
EndUpdate()Unlocks the ContextItem object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from ContextItem.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetActualCheckedGlyph(ISkinProvider)Returns the Image object specifying the checked state glyph actually assigned.
GetActualGlyph(ISkinProvider)Returns the Image object specifying the glyph actually assigned. Inherited from ContextItem.
GetActualHoverCheckedGlyph(ISkinProvider)Returns the Image object specifying the hovered checked state glyph actually assigned.
GetActualHoverGlyph(ISkinProvider)Returns the Image object specifying the hovered state glyph actually assigned. Inherited from ContextItem.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
RaiseContextItemClick(MouseEventArgs, ContextItemViewInfo)Raises the ContextItem.Click event. Inherited from ContextItem.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ResetSuperTip()Removes the SuperToolTip object assigned to the current context item. Inherited from ContextItem.
ToString()Returns a string that represents the current object. Inherited from Object.

Events

NameDescription
ClickFires when the current item is clicked. Inherited from ContextItem.
CommandCanExecuteChangedOccurs when the CanExecute(Object) status of the Command has changed. Inherited from ContextButtonBase.
CommandChangedOccurs after the value of the Command property has changed. Inherited from ContextButtonBase.
CommandParameterChangedOccurs after the value of the CommandParameter property has changed. Inherited from ContextButtonBase.
CustomToolTipAllows you to specify a tooltip shown when the mouse pointer hovers over a context button. This event is only raised for RatingContextButton and TrackBarContextButton objects. Inherited from ContextItem.
HyperlinkClickFires when a hyperlink in the button caption is clicked. Inherited from ContextButtonBase.

See Also

CheckContextButton Class

DevExpress.Utils Namespace