Back to Devexpress

RibbonHitTest Enum

windowsforms-devexpress-dot-xtrabars-dot-ribbon-dot-viewinfo-407575de.md

latest7.0 KB
Original Source

RibbonHitTest Enum

Lists values that identify a Ribbon Control’s elements.

Namespace : DevExpress.XtraBars.Ribbon.ViewInfo

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public enum RibbonHitTest
vb
Public Enum RibbonHitTest

Members

NameDescription
None

The test point does not belong to any visual element or is outside a Ribbon Control.

| | CaptionBar |

The test point belongs to the caption bar - an area shared with the RibbonForm‘s title bar that displays items from the RibbonControl.CaptionBarItemLinks collection.

| | HeaderPanel |

The test point belongs to a header panel.

| | PageHeader |

The test point belongs to a page header.

| | PageHeaderCategory |

The test point belongs to a page category‘s header.

| | Panel |

The test point belongs to a group panel.

| | PageGroup |

The test point belongs to a page group.

| | PageGroupCaption |

The test point belongs to the caption of a page group.

| | PageGroupCaptionButton |

The test point belongs to the caption button of a page group.

| | ItemSeparator |

The test point belongs to a bar item separator.

| | Item |

The test point belongs to a Items and Item Links.

| | ItemDrop |

The test point belongs to a bar item’s drop down button.

| | Toolbar |

The test point belongs to a Quick Access Toolbar.

| | ApplicationButton |

The test point belongs to the Application Button.

| | Gallery |

The test point belongs to a Gallery.

| | GalleryItem |

The test point belongs to a Gallery item.

| | GalleryItemGroup |

The test point belongs to a Gallery group.

| | GalleryUpButton |

The test point belongs to the Up button which is used to scroll up a Gallery’s content.

| | GalleryDownButton |

The test point belongs to the Down button which is used to scroll down a Gallery’s content.

| | GalleryLeftButton |

The test point belongs to the left scroll button which is used to scroll a Gallery’s content to the left.

| | GalleryRightButton |

The test point belongs to the right scroll button which is used to scroll a Gallery’s content to the right.

| | GalleryDropDownButton |

The test point belongs to the Dropdown button which is used to invoke an In-Ribbon Gallery’s Dropdown Gallery.

| | GallerySizingPanel |

The test point belongs to a Dropdown Gallery’s Sizing panel.

| | GallerySizeGrip |

The test point belongs to the size grip.

| | GalleryFilter |

The test point belongs to the Filter panel within a Dropdown Gallery.

| | GalleryImage |

The test point belongs to the image within a Gallery item.

| | StatusBar |

The test point belongs to a Ribbon Status Bar.

| | PageHeaderLeftScroll |

The test point belongs to the left page scroll button.

| | PageHeaderRightScroll |

The test point belongs to the right page scroll button.

| | PanelLeftScroll |

The test point belongs to the left scroll button used to scroll through a page’s contents.

| | PanelRightScroll |

The test point belongs to the right scroll button used to scroll through a page’s contents.

| | FormCaption |

The test point belongs to a Ribbon form’s caption.

| | FormCloseButton |

The test point belongs to the Close button in the top-right corner of a Ribbon form.

| | FormMinimizeButton |

The test point belongs to the Minimize button in the top-right corner of a Ribbon form.

| | FormFullScreenButton |

The test point belongs to the Full-Screen Mode button (see RibbonControl.ShowDisplayOptionsMenuButton) in the top-right corner of a Ribbon form.

| | FormMaximizeButton |

The test point belongs to the Maximize button in the top-right corner of a Ribbon form.

| | FormHelpButton |

The test point belongs to the Help button in the top-right corner of a Ribbon form.

| | FullScreenModeBar |

The test point belongs to the bar at the top window edge to which a Ribbon Control with an Office 2013 style applied (see the RibbonControl.RibbonStyle property) is minimized in Full-Screen Mode.

| | SystemMenuArea |

The test point belongs to the system menu area.

| | MessageBar |

The test point belongs to a message bar (Office 365 style).

|

The following properties accept/return RibbonHitTest values:

Remarks

The values listed by this enumeration are returned by the RibbonHitInfo.HitTest property of a RibbonHitInfo object. RibbonHitInfo objects can be created by calling the RibbonControl.CalcHitInfo and RibbonStatusBar.CalcHitInfo methods.

See Also

RibbonControl.CalcHitInfo

RibbonStatusBar.CalcHitInfo

DevExpress.XtraBars.Ribbon.ViewInfo Namespace