Back to Devexpress

ContextItem Members

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

latest10.9 KB
Original Source

ContextItem Members

Represents a base class for context items: buttons, track bars, etc.

Constructors

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

Properties

NameDescription
AlignmentGets or sets the current item’s alignment relative to the owner control. This property is obsolete, use ContextItem.AlignmentOptions instead.
AlignmentOptionsProvides access to options that specify the panel in which the item is displayed, and its position in the panel.
AllowGlyphSkinningGets or sets whether the current item’s glyph is painted using the foreground color.
AnchorAlignmentGets or sets the alignment of the current item relative to the anchor element.
AnchorElementGets or sets an item (anchor element) relative to which the current item is aligned.
AnchorElementIdGets or sets the globally unique identifier of the item (anchor element), relative to which the current item is aligned.
AnchorIndentGets or sets the indent between the current item and the anchor element.
AnchorOffsetGets or sets the translation of the current item from the anchor element.
AnimationTypeGets or sets the type of the animation used to show and hide the current item.
AppearanceDisabledProvides access to appearance settings applied to this ContextItem in the Disabled state.
AppearanceHoverProvides access to the settings used to paint the current item in the hovered state.
AppearanceNormalProvides access to the appearance settings used to paint the current item in the normal (not hovered) state.
CollectionGets the collection to which the current item belongs.
EnabledGets or sets whether the current item can respond to end-user interaction.
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.
HasGlyphGets whether or not this ContextItem has a glyph assigned.
HasHoverGlyphGets whether or not this ContextItem has a hovered state glyph assigned.
HoverGlyphGets or sets the glyph displayed by the current item in the hovered state. This property is obsolete. Use the ImageOptionsCollection property instead.
IdGets or sets the current item’s unique identifier.
ImageOptionsProvides access to all properties that allow you to assign and customize a glyph for this ContextItem.
ImageOptionsCollectionProvides access to image-related settings for each ContextItem visual state.
NameGets or sets the current item’s name.
OriginItemThis member supports the internal infrastructure, and is not intended to be used directly from your code.
ShowToolTipsGets or sets whether a tooltip is shown when the mouse pointer hovers over the button.
SizeGets or sets the current item’s size.
SuperTipGets or sets a super tooltip shown when the mouse pointer hovers over the button.
TagGets or sets custom data associated with the current item.
ToolTipGets or sets the text in a regular tooltip shown when the mouse pointer hovers over the button.
ToolTipIconTypeGets or sets the icon in a regular tooltip shown when the mouse pointer hovers over the button.
ToolTipTitleGets or sets the title in a regular tooltip shown when the mouse pointer hovers over the button.
VisibilityGets or sets the item visibility.

Methods

NameDescription
AssignPropertiesInternal(ContextItem, Boolean)This member supports the internal infrastructure, and is not intended to be used directly from your code.
AssignPropertiesInternal(ContextItem)This member supports the internal infrastructure, and is not intended to be used directly from your code.
BeginUpdate()Locks the ContextItem object by preventing visual updates until the EndUpdate method is called.
CancelUpdate()Unlocks the ContextItem object after it has been locked by the BeginUpdate method, without causing an immediate visual update.
Clone()Creates a new ContextItem object that is a copy of the current instance.
EndUpdate()Unlocks the ContextItem object after a call to the BeginUpdate method and causes an immediate visual update.
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.
GetActualGlyph(ISkinProvider)Returns the Image object specifying the glyph actually assigned.
GetActualHoverGlyph(ISkinProvider)Returns the Image object specifying the hovered state glyph actually assigned.
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.
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.
ToString()Returns a string that represents the current object. Inherited from Object.

Events

NameDescription
ClickFires when the current item is clicked.
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.

See Also

ContextItem Class

DevExpress.Utils Namespace