Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Collapse]DevExpress.Utils
   [Expand]AppearanceObject Class
   [Expand]AppearanceObjectEx Class
   [Expand]AppearanceOptions Class
   [Expand]AppearanceOptionsEx Class
   [Expand]BaseAppearanceCollection Class
   [Expand]CheckContextButton Class
   [Expand]ContextButton Class
   [Expand]ContextButtonBase Class
   [Collapse]ContextItem Class
     ContextItem Members
     ContextItem Constructor
    [Expand]ContextItem Properties
    [Expand]ContextItem Events
    [Expand]ContextItem Methods
   [Expand]DefaultToolTipController Class
   [Expand]DXMouseEventArgs Class
    EditorShowMode Enumeration
   [Expand]FlyoutPanel Class
   [Expand]FlyoutPanelButtonOptions Class
   [Expand]FlyoutPanelOptions Class
    GroupElementLocation Enumeration
   [Expand]HideException Class
    HKeyPrefix Enumeration
   [Expand]ImageCollection Class
   [Expand]Images Class
   [Expand]KeyShortcut Class
    Locations Enumeration
   [Expand]RatingContextButton Class
   [Expand]SharedImageCollection Class
    SharedImageCollectionImageSizeMode Enumeration
   [Expand]SuperToolTip Class
   [Expand]TextOptions Class
   [Expand]ThumbnailImageEventArgs Class
   [Expand]ToolTipControlInfo Class
   [Expand]ToolTipController Class
    ToolTipControllerBeforeShowEventHandler Delegate
   [Expand]ToolTipControllerCalcSizeEventArgs Class
    ToolTipControllerCalcSizeEventHandler Delegate
   [Expand]ToolTipControllerCustomDrawEventArgs Class
    ToolTipControllerCustomDrawEventHandler Delegate
   [Expand]ToolTipControllerEventArgsBase Class
   [Expand]ToolTipControllerGetActiveObjectInfoEventArgs Class
    ToolTipControllerGetActiveObjectInfoEventHandler Delegate
   [Expand]ToolTipControllerShowEventArgs Class
    ToolTipIconSize Enumeration
    ToolTipIconType Enumeration
   [Expand]ToolTipItem Class
    ToolTipLocation Enumeration
    ToolTipStyle Enumeration
    ToolTipType Enumeration
   [Expand]TrackBarContextButton Class
    Trimming Enumeration
   [Expand]WorkspaceManager Class
    XPThemeSupport Enumeration
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

ContextItem Class

The base class for the context buttons.

Namespace:DevExpress.Utils
Assembly:DevExpress.Utils.v17.1.dll

Expanded Syntax

Expanded Remarks

The ContextItem class serves as a base class for the context buttons, which are represented by the ContextButton, CheckContextButton, RatingContextButton and TrackBarContextButton classes. The context buttons can be displayed in the owner control to provide end-users with custom functionality. In the figure below, you can see the PictureEdit control that displays all the available types of context buttons.

The context buttons can be displayed in the following controls:

By default, if a context button is added to the ContextButtons collection of the owner control, it is automatically displayed when an end-user hovers over the owner control with the mouse cursor. You can override this behavior and specify that a particular context button is always visible or hidden using the Visibility property. Also, the context button can be displayed in the enabled or disabled state. The disabled button is displayed in a light hue and does not respond to end-user interaction. To specify whether a button is enabled or disabled, use the Enabled property.

The AppearanceNormal and AppearanceHover properties allow you to customize the button appearance in the normal and hovered states, respectively. The glyphs displayed by the context button in these states can be specified by the Glyph and HoverGlyph properties. For the RatingContextButton objects, these properties specify the grading scale point glyphs in the corresponding states.

The Alignment property allows you to align the context button relative to the owner control. Note that the alignment affects the orientation of the button — it can be oriented vertically or horizontally. If the alignment relative to the owner control does not meet your needs, you can align the context button relative to another button — anchor element (see AnchorAlignment).

The owner control exposes the ContextButtonClick event that fires when a context button is clicked. This event allows you to respond to clicks on context buttons in a centralized way. You can also handle the Click event to respond to a click on a particular button.

Also, the owner control exposes the ContextButtonOptions property that provides access to the settings applied to the context buttons displayed in the control, and the panels containing these buttons. Using this property you can specify the following settings:

  • back color of each panel (top, bottom, etc.) that contains the context buttons, and the amount of empty space around the buttons;
  • animation type used to show the panels and the animation duration time;
  • glyph skinning feature for all context buttons. This setting can be overridden for a particular button using the AllowGlyphSkinning property;
  • button opacity in the normal, hovered and disabled states;
  • indent between the buttons;
  • HTML formatting feature for button captions and tool tips.

Expanded Inheritance Hierarchy

System.Object
    ContextItem
       CheckContextButton
       ContextButton
       ContextButtonBase
       RatingContextButton
       TrackBarContextButton

Expanded See Also

How would you rate this topic?​​​​​​​