Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
desktop:ribbon [2017/04/09 23:07]
agcyphers [Methods]
desktop:ribbon [2019/10/23 05:53] (current)
Line 1: Line 1:
-====== See Also ======+==== See Also ====
 [[desktop:​ribbonbutton|GraffitiRibbonButton]]\\ [[desktop:​ribbonbutton|GraffitiRibbonButton]]\\
 [[desktop:​ribbonsection|GraffitiRibbonSection]]\\ [[desktop:​ribbonsection|GraffitiRibbonSection]]\\
 [[desktop:​ribbontab|GraffitiRibbonTab]]\\ [[desktop:​ribbontab|GraffitiRibbonTab]]\\
  
-====== Enumerations ​======+==== Enumerations ====
 ^ Name      ^ Values ​      ^ ^ Name      ^ Values ​      ^
 |  | This class exposes no enumerations. | |  | This class exposes no enumerations. |
  
-====== Constants ​======+==== Constants ====
 ^ Name      ^ Type     ^ Value       ^ ^ Name      ^ Type     ^ Value       ^
 |  |  | This class exposes no constants. | |  |  | This class exposes no constants. |
  
-====== Events ​======+==== Events ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
 | ButtonClick( ButtonName as String ) | Fires when the user clicks the button specified by ButtonName. | | ButtonClick( ButtonName as String ) | Fires when the user clicks the button specified by ButtonName. |
Line 19: Line 19:
 | TabChange( newTab as RibbonTab ) | Fires when the user clicks to change displayed tabs. | | TabChange( newTab as RibbonTab ) | Fires when the user clicks to change displayed tabs. |
  
-====== Methods ​======+==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
 | AddTab( newTab as RibbonTab ) | Adds a RibbonTab to the ribbon control. | | AddTab( newTab as RibbonTab ) | Adds a RibbonTab to the ribbon control. |
Line 30: Line 30:
 | RemoveTab( TabText as String ) | Removes a tab by it’s text. | | RemoveTab( TabText as String ) | Removes a tab by it’s text. |
  
-====== Properties ​======+==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| AllowAnimations | Boolean | Determines whether the control will be animated when minimizing/​maximizing/​restoring. +| AllowAnimations | Boolean ​| False | Determines whether the control will be animated when minimizing/​maximizing/​restoring. 
-| AllowAutoHide | Boolean | Determines whether the control will automatically hide when the mouse is not hovering above it. +| AllowAutoHide | Boolean ​| False | Determines whether the control will automatically hide when the mouse is not hovering above it. | 
-| AllowMinimize | Boolean | Determines whether the control can be minimized. +| AllowMinimize | Boolean ​| False | Determines whether the control can be minimized. ​| 
-| ButtonBackColor | Color | Sets the background color of buttons when the mouse is over them. +| ButtonBackColor | Color | &​c000000 ​| Sets the background color of buttons when the mouse is over them. | 
-| ButtonTextColor | Color | Sets the text color of buttons. +| ButtonTextColor | Color | &​c000000 ​| Sets the text color of buttons. ​| 
-| Children() | RibbonTab | Array which contains all RibbonTab children of the class. +| Children() | RibbonTab ​| Nil | Array which contains all RibbonTab children of the class. ​| 
-| ExpandedHeight | Integer | Sets the height of the control when it’s fully visible. +| ExpandedHeight | Integer ​| 0 | Sets the height of the control when it is fully visible. ​| 
-| RibbonBGColor | Color | Determines the background color of the control. +| RibbonBGColor | Color | &​c000000 ​| Determines the background color of the control. ​| 
-| SectionBGColor | Color | Determines the background color of button container sections. +| SectionBGColor | Color | &​c000000 ​| Determines the background color of button container sections. ​| 
-| SectionTextColor | Color | Determines the text color of button container sections. +| SectionTextColor | Color | &​c000000 ​| Determines the text color of button container sections. ​| 
-| SelectedTab | RibbonTab | The currently selected tab. +| SelectedTab | RibbonTab ​| Nil | The currently selected tab. | 
-| TabBackColor | Color | The background color of the RibbonTabs. +| TabBackColor | Color | &​c000000 ​| The background color of the RibbonTabs. ​| 
-| TabTextColor_Active | The text color of a tab when it is the currently selected tab. +| TabTextColor_Active ​| Color | &​c000000 ​| The text color of a tab when it is the currently selected tab. | 
-| TabTextColor_Inactive | The text color of a tab when it is not the currently selected tab.+| TabTextColor_Inactive ​| Color | &​c000000 ​| The text color of a tab when it is not the currently selected tab. |
  
-====== Examples ​======+==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.