FrameworkEnums - harborsiem/WinForms-Ribbon GitHub Wiki
Framework Enums
Microsoft Windows Ribbon Enums are renamed for the user.
FontProperties
Originalname: UI_FONTPROPERTIES
Specifies values that identify the font property state of a FontControl, such as Strikethrough. This enum is used in FontControl.
Enum names:
| Name | Description |
|---|---|
| NotAvailable | The property is not available. |
| NotSet | The property is not set. |
| Set | The property is set. |
FontUnderline
Originalname: UI_FONTUNDERLINE
Specifies values that identify the underline state of a FontControl. This enum is used in FontControl.
Enum names:
| Name | Description |
|---|---|
| NotAvailable | Underlining is not enabled. |
| NotSet | Underlining is off. |
| Set | Underlining is on. |
FontVerticalPosition
Originalname: UI_FONTVERTICALPOSITION
Specifies values that identify the vertical-alignment state of a FontControl. This enum is used in FontControl.
Enum names:
| Name | Description |
|---|---|
| NotAvailable | Vertical positioning is not enabled. |
| NotSet | Vertical positioning is enabled but not toggled. |
| SuperScript | Vertical positioning is enabled and toggled for superscript. |
| SubScript | Vertical positioning is enabled and toggled for subscript. |
FontDeltaSize
Originalname: UI_FONTDELTASIZE
Specifies values that identify whether the font size of a highlighted text run should be incremented or decremented. This enum is used in FontControl.
Enum names:
| Name | Description |
|---|---|
| Grow | Increment the font size. |
| Shrink | Decrement the font size. |
SwatchColorType
Originalname: UI_SWATCHCOLORTYPE
Specifies the values that identify how a color swatch in a DropDownColorPicker or a FontControl color picker (Text color or Text highlight) is filled.
Enum names:
| Name | Description |
|---|---|
| NoColor | The swatch is transparent. |
| Automatic | The swatch is filled with a solid RGB color bound to GetSysColor(COLOR_WINDOWTEXT). |
| RGB | The swatch is filled with a solid RGB color. |
SwatchColorMode
Originalname: UI_SWATCHCOLORMODE
Specifies whether a swatch has normal or monochrome mode.
Enum names:
| Name | Description |
|---|---|
| Normal | The swatch is normal mode. |
| Monochrome | The swatch is monochrome. The swatch's RGB color value will be interpreted as a 1 bit-per-pixel pattern. |
ContextAvailability
Originalname: UI_CONTEXTAVAILABILITY
Specifies values that identify the availability of a contextual tab.
Enum names:
| Name | Description |
|---|---|
| NotAvailable | A contextual tab is not available for the selected object. |
| Available | A contextual tab is available for the selected object. The tab is not the active tab. |
| Active | A contextual tab is available for the selected object. The tab is the active tab. |
ControlDock
Originalname: UI_CONTROLDOCK
Specifies values that identify the dock state of the Quick Access Toolbar (QAT).
Enum names:
| Name | Description |
|---|---|
| Top | The QAT is docked in the nonclient area of the Ribbon host application. |
| Bottom | The QAT is docked as a visually integral band below the Ribbon. |
CollectionChange
Originalname: UI_COLLECTIONCHANGE
Specifies values that identify the types of changes that can be made to a collection.
Enum names:
| Name | Description |
|---|---|
| Insert | Insert an item into the collection. |
| Remove | Delete an item from the collection. |
| Replace | Replace an item in the collection. |
| Reset | Delete all items from the collection. |
CommandType
Originalname: UI_COMMANDTYPE
Specifies values that identify the type of Command associated with a Ribbon control.
Enum names:
| Name | Description |
|---|---|
| Unknown | The type of command is not known. |
| Group | Group |
| Action | Action (Button, HelpButton) |
| Anchor | Anchor (ApplicationMenu, DropDownButton, SplitButton, Tab) |
| Context | Context (TabGroup) |
| Collection | Collection (ComboBox, DropDownGallery, InRibbonGallery, SplitButtonGallery) |
| CommandCollection | Command collection (DropDownGallery, InRibbonGallery, QuickAccessToolbar, SplitButtonGallery) |
| Decimal | Decimal (Spinner) |
| Boolean | Boolean (ToggleButton, CheckBox) |
| Font | Font (FontControl) |
| RecentItems | RecentItems |
| ColorAnchor | ColorAnchor (DropDownColorPicker) |
| ColorCollection | ColorCollection. This Command type is not supported by any framework controls. |
EventType
Originalname: UI_EVENTTYPE
Since Windows 8.
Identifies the types of events associated with a Ribbon.
Enum names:
| Name | Description |
|---|---|
| ApplicationMenuOpened | The ApplicationMenu opened |
| RibbonMinimized | The Ribbon minimized |
| RibbonExpanded | The Ribbon expanded |
| ApplicationModeSwitched | The application mode changed |
| TabActivated | A Tab activated |
| MenuOpened | A menu opened |
| CommandExecuted | A Command executed |
| TooltipShown | A Command tooltip displayed. |
EventLocation
Originalname: UI_EVENTLOCATION
Since Windows 8.
Identifies the locations where events associated with a Ribbon control can originate.
Enum names:
| Name | Description |
|---|---|
| Ribbon | The Ribbon |
| QAT | The QuickAccessToolbar |
| ApplicationMenu | The ApplicationMenu |
| ContextPopup | The ContextPopup |
CollectionType
Identifies the UICollection type.
Enum names:
| Name | Description |
|---|---|
| ItemsSource | The UICollection member GalleryItemItemsSource of a Gallery Control with Items. |
| Categories | The UICollection member GalleryCategories of a Gallery Control. |
| QatItemsSource | The UICollection member QatItemsSource of a Qat Control. |
| CommandItemsSource | The UICollection member GalleryCommandItemsSource of a Gallery Control with Commands. |
FontPropertiesEnum
Identifies the font properties in FontControlEventArgs property ChangedFontProperties.
Enum names:
| Name | Description |
|---|---|
| None | None. |
| Family | Object is a font family. Type of string. |
| Size | Object is a font size. Type of decimal. |
| Bold | Object is a Bold value. Type of FontProperties. |
| Italic | Object is a Italic value. Type of FontProperties. |
| Underline | Object is a Underline value. Type of FontUnderline. |
| Strikethrough | Object is a Strikethrough value. Type of FontProperties. |
| VerticalPositioning | Object is a VerticalPositioning value. Type of FontVerticalPosition. |
| ForegroundColor | Object is a Foreground Color value. Type of Color. |
| BackgroundColor | Object is a Background Color value. Type of Color. |
| ForegroundColorType | Object is a Foreground ColorType value. Type of SwatchColorType. |
| BackgroundColorType | Object is a Background ColorType value. Type of SwatchColorType. |
| ChangedProperties | Not used. |
| DeltaSize | Object is a DeltaSize value. Type of Nullable<FontDeltaSize>. |