Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
desktop:ribbon [2017/04/09 23:07] agcyphers [Methods] |
desktop:ribbon [2018/04/14 16:09] (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 [[http://developer.xojo.com/string|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. | | | 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. | | | 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. | | | 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. | | ||
| - | | FindTab( Text as String ) as RibbonTab | Finds a child RibbonTab by it’s text. | | + | | FindTab( Text as [[http://developer.xojo.com/string|String]] ) as RibbonTab | Finds a child RibbonTab by it’s text. | |
| | FireMinimize() | Causes the GraffitiRibbon class to collapse. | | | FireMinimize() | Causes the GraffitiRibbon class to collapse. | | ||
| | FireMaximize() | Causes the GraffitiRibbon class to expand. | | | FireMaximize() | Causes the GraffitiRibbon class to expand. | | ||
| | FireRestore() | Causes the GraffitiRibbon class to restore it’s previous size. | | | FireRestore() | Causes the GraffitiRibbon class to restore it’s previous size. | | ||
| | RemoveAllTabs() | Removes all child RibbonTabs. | | | RemoveAllTabs() | Removes all child RibbonTabs. | | ||
| - | | RemoveTab( TabIndex as Integer ) | Removes a tab by it’s index. | | + | | RemoveTab( TabIndex as [[http://developer.xojo.com/integer|Integer]] ) | Removes a tab by it’s index. | |
| - | | RemoveTab( TabText as String ) | Removes a tab by it’s text. | | + | | RemoveTab( TabText as [[http://developer.xojo.com/string|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 | [[http://developer.xojo.com/boolean|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 | [[http://developer.xojo.com/boolean|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 | [[http://developer.xojo.com/boolean|Boolean]] | False | Determines whether the control can be minimized. | |
| - | | ButtonBackColor | Color | Sets the background color of buttons when the mouse is over them. | + | | ButtonBackColor | [[http://developer.xojo.com/color|Color]] | &c000000 | Sets the background color of buttons when the mouse is over them. | |
| - | | ButtonTextColor | Color | Sets the text color of buttons. | + | | ButtonTextColor | [[http://developer.xojo.com/color|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 | [[http://developer.xojo.com/integer|Integer]] | 0 | Sets the height of the control when it is fully visible. | |
| - | | RibbonBGColor | Color | Determines the background color of the control. | + | | RibbonBGColor | [[http://developer.xojo.com/color|Color]] | &c000000 | Determines the background color of the control. | |
| - | | SectionBGColor | Color | Determines the background color of button container sections. | + | | SectionBGColor | [[http://developer.xojo.com/color|Color]] | &c000000 | Determines the background color of button container sections. | |
| - | | SectionTextColor | Color | Determines the text color of button container sections. | + | | SectionTextColor | [[http://developer.xojo.com/color|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 | [[http://developer.xojo.com/color|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 | [[http://developer.xojo.com/color|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 | [[http://developer.xojo.com/color|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. | ||