Differences
This shows you the differences between two versions of the page.
desktop:ribbon [2018/04/14 16:09] |
desktop:ribbon [2019/10/23 05:53] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ==== See Also ==== | ||
+ | [[desktop:ribbonbutton|GraffitiRibbonButton]]\\ | ||
+ | [[desktop:ribbonsection|GraffitiRibbonSection]]\\ | ||
+ | [[desktop:ribbontab|GraffitiRibbonTab]]\\ | ||
+ | |||
+ | ==== Enumerations ==== | ||
+ | ^ Name ^ Values ^ | ||
+ | | | This class exposes no enumerations. | | ||
+ | |||
+ | ==== Constants ==== | ||
+ | ^ Name ^ Type ^ Value ^ | ||
+ | | | | This class exposes no constants. | | ||
+ | |||
+ | ==== Events ==== | ||
+ | ^ Definition ^ Description ^ | ||
+ | | ButtonClick( ButtonName as String ) | Fires when the user clicks the button specified by ButtonName. | | ||
+ | | Minimized() | Fires when the user clicks the minimize button, or the control is animated and it’s size is made smaller. | | ||
+ | | Restored() | Fires when the user clicks the maximize button, or the control is animated and it’s size is made larger. | | ||
+ | | TabChange( newTab as RibbonTab ) | Fires when the user clicks to change displayed tabs. | | ||
+ | |||
+ | ==== Methods ==== | ||
+ | ^ Definition ^ Description ^ | ||
+ | | AddTab( newTab as RibbonTab ) | Adds a RibbonTab to the ribbon control. | | ||
+ | | FindTab( Text as String ) as RibbonTab | Finds a child RibbonTab by it’s text. | | ||
+ | | FireMinimize() | Causes the GraffitiRibbon class to collapse. | | ||
+ | | FireMaximize() | Causes the GraffitiRibbon class to expand. | | ||
+ | | FireRestore() | Causes the GraffitiRibbon class to restore it’s previous size. | | ||
+ | | RemoveAllTabs() | Removes all child RibbonTabs. | | ||
+ | | RemoveTab( TabIndex as Integer ) | Removes a tab by it’s index. | | ||
+ | | RemoveTab( TabText as String ) | Removes a tab by it’s text. | | ||
+ | |||
+ | ==== Properties ==== | ||
+ | ^ Name ^ Type ^ Default Value ^ Description ^ | ||
+ | | AllowAnimations | Boolean | False | Determines whether the control will be animated when minimizing/maximizing/restoring. | ||
+ | | AllowAutoHide | Boolean | False | Determines whether the control will automatically hide when the mouse is not hovering above it. | | ||
+ | | AllowMinimize | Boolean | False | Determines whether the control can be minimized. | | ||
+ | | ButtonBackColor | Color | &c000000 | Sets the background color of buttons when the mouse is over them. | | ||
+ | | ButtonTextColor | Color | &c000000 | Sets the text color of buttons. | | ||
+ | | Children() | RibbonTab | Nil | Array which contains all RibbonTab children of the class. | | ||
+ | | ExpandedHeight | Integer | 0 | Sets the height of the control when it is fully visible. | | ||
+ | | RibbonBGColor | Color | &c000000 | Determines the background color of the control. | | ||
+ | | SectionBGColor | Color | &c000000 | Determines the background color of button container sections. | | ||
+ | | SectionTextColor | Color | &c000000 | Determines the text color of button container sections. | | ||
+ | | SelectedTab | RibbonTab | Nil | The currently selected tab. | | ||
+ | | TabBackColor | Color | &c000000 | The background color of the RibbonTabs. | | ||
+ | | TabTextColor_Active | Color | &c000000 | The text color of a tab when it is the currently selected tab. | | ||
+ | | TabTextColor_Inactive | Color | &c000000 | The text color of a tab when it is not the currently selected tab. | | ||
+ | |||
+ | ==== Examples ==== | ||
+ | There are currently no examples for this class. | ||