Difference between revisions of "RibbonCanvas"

From Jeremie Leroy - XOJO Controls Wiki
Jump to: navigation, search
m (1 revision)
(→‎History)
 
(8 intermediate revisions by 2 users not shown)
Line 13: Line 13:
 
|width=50%|{{Event | name=MouseDown | params=X As Integer, Y As Integer | description= | returntype=Boolean | newinversion=}}
 
|width=50%|{{Event | name=MouseDown | params=X As Integer, Y As Integer | description= | returntype=Boolean | newinversion=}}
 
|-
 
|-
−
|width=50%|{{Event | name=GearIconClicked | description= | returntype=Boolean | newinversion=}}
+
|width=50%|{{Event | name=GearIconClicked | description= | returntype=Boolean | newinversion=1.2.0}}
 
|width=50%|{{Event | name=Open | description= | newinversion=}}
 
|width=50%|{{Event | name=Open | description= | newinversion=}}
 
|-
 
|-
Line 26: Line 26:
 
|-
 
|-
 
|width=50%|{{Event | name=MenuAction | params=SectionName As String, ButtonName As String, hitItem As MenuItem | description= | newinversion=}}
 
|width=50%|{{Event | name=MenuAction | params=SectionName As String, ButtonName As String, hitItem As MenuItem | description= | newinversion=}}
 +
 +
|-
 
|}
 
|}
  
Line 33: Line 35:
 
|class=titleClass colspan=3|Properties
 
|class=titleClass colspan=3|Properties
 
|-
 
|-
−
|width=33%|{{Property | name=Animate | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Animate | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Hidden | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Hidden | type=Boolean | description= | readonly=yes | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=ShowTooltips | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=ShowTooltips | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=AutoHide | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=AutoHide | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=HideButtonLeft | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=HideButtonLeft | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Style | type=Integer | description= | readonly=yes | newinversion=}}
+
|width=33%|{{Property | name=Style | type=Integer | description= | readonly=yes | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=BackColor | type=Color | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=BackColor | type=Color | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=LastError | type=String | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=LastError | type=String | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=TabCount | type=Integer | description= | readonly=yes | newinversion=}}
+
|width=33%|{{Property | name=TabCount | type=Integer | description= | readonly=yes | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=BestHeight | type=Integer | description= | readonly=yes | newinversion=}}
+
|width=33%|{{Property | name=BestHeight | type=Integer | description= | readonly=yes | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=LeftOffset | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=LeftOffset | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=TabInnerOffset | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=TabInnerOffset | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=Blinker | type=RibbonBlinker | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=BorderColor | type=Color | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Main | type=RibbonMain | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Main | type=RibbonMain | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=TabMidOffset | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=TabMidOffset | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=BorderColor | type=Color | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=EmbeddedControls | type=RibbonEmbeddedControl | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=RedrawValue | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=ShowGearIcon | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Tabs | type=RibbonTab | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Tabs | type=RibbonTab | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=EmbeddedControls | type=RibbonEmbeddedControl | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Freeze | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=ShowGearIcon | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=ShowHideButton | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Value | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Value | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=Freeze | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=FullRefresh | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=ShowHideButton | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=ShowRefreshTime | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
  
 
|-
 
|-
−
|width=33%|{{Property | name=FullRefresh | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=GearIcon | type=Picture | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=ShowRefreshTime | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=ShowTabs | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
  
 
|-
 
|-
−
|width=33%|{{Property | name=GearIcon | type=Picture | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Hidden | type=Boolean | description= | readonly=yes | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=ShowTabs | type=Boolean | description= | readonly=no | newinversion=}}
+
 
|}
 
|}
−
 
−
 
  
  
Line 82: Line 81:
 
|-
 
|-
 
|width=33%|{{Method | name=AddOpenRecent | params=f As FolderItem | description= | newinversion=}}
 
|width=33%|{{Method | name=AddOpenRecent | params=f As FolderItem | description= | newinversion=}}
−
|width=33%|{{Method | name=LoadFromXML | params=XMLString As String | description= | returntype=Boolean | newinversion=}}
 
−
|width=33%|{{Method | name=SetStyle | params=value As Integer | description= | newinversion=}}
 
−
|-
 
−
|width=33%|{{Method | name=EmbedControl | params=c As RectControl, Left As Integer = - 1, Top As Integer = - 1, Tab As Integer = - 1, Section As Integer = - 1, Button As Integer = - 1 | description= | newinversion=}}
 
 
|width=33%|{{Method | name=Redisplay | description= | newinversion=}}
 
|width=33%|{{Method | name=Redisplay | description= | newinversion=}}
 
|width=33%|{{Method | name=Show | params=Refresh As Boolean = True | description= | newinversion=}}
 
|width=33%|{{Method | name=Show | params=Refresh As Boolean = True | description= | newinversion=}}
 
|-
 
|-
−
|width=33%|{{Method | name=EmbedControl | params=c As RectControl, Button As RibbonButton | description= | newinversion=}}
+
|width=33%|{{Method | name=EmbedControl | params=c As RectControl, Left As Integer = - 1, Top As Integer = - 1, Tab As Integer = - 1, Section As Integer = - 1, Button As Integer = - 1 | description= | newinversion=}}
 
|width=33%|{{Method | name=RemoveOpenRecent | params=f As FolderItem | description= | newinversion=}}
 
|width=33%|{{Method | name=RemoveOpenRecent | params=f As FolderItem | description= | newinversion=}}
 
|width=33%|{{Method | name=toRB | params=FullConstructor As Boolean = False, SaveStyle As Boolean = True | description= | returntype=String | newinversion=}}
 
|width=33%|{{Method | name=toRB | params=FullConstructor As Boolean = False, SaveStyle As Boolean = True | description= | returntype=String | newinversion=}}
Line 103: Line 98:
 
|width=33%|{{Method | name=Hide | params=Refresh As Boolean = True | description= | newinversion=}}
 
|width=33%|{{Method | name=Hide | params=Refresh As Boolean = True | description= | newinversion=}}
 
|width=33%|{{Method | name=SetHighlightColor | params=C As Color | description= | newinversion=}}
 
|width=33%|{{Method | name=SetHighlightColor | params=C As Color | description= | newinversion=}}
 +
 +
|-
 +
|width=33%|{{Method | name=LoadFromXML | params=XMLString As String | description= | returntype=Boolean | newinversion=}}
 +
|width=33%|{{Method | name=SetStyle | params=value As Integer | description= | newinversion=}}
  
 
|-
 
|-
Line 113: Line 112:
 
|-
 
|-
 
|{{Method | name=Register | params=Name As String, ProductKey As String, SerialKey As Integer | description= | returntype=Boolean | newinversion=}}
 
|{{Method | name=Register | params=Name As String, ProductKey As String, SerialKey As Integer | description= | returntype=Boolean | newinversion=}}
 +
|-
 +
 
|-
 
|-
 
|}
 
|}
  
 +
 +
==History==
 +
 +
 +
 +
===Version 1.6.0 - Released 2016-11-14 ===
 +
*New:
 +
**Updated for Xojo 2017R1
 +
 +
*Fix
 +
**OutOfBoundsException on Windows
 +
 +
 +
===Version 1.5.0 - Released 2015-11-28 ===
 +
 +
*Fix
 +
**Several bug fixes
 +
 +
 +
===Version 1.4.0 - Released 2014-09-01 ===
 +
*New:
 +
**Office2013 Style
 +
**Colored Tabs
 +
**Compatible with Xojo
 +
 +
*Deprecated:
 +
**Office2007 Style is no longer supported. No updates or bug fixes will be added for this style.
 +
 +
 +
===Version 1.3.0 - Released 2013-04-27 ===
 +
*New:
 +
**Office2013 Style
 +
**Colored Tabs
 +
 +
*Deprecated:
 +
**Office2007 Style is no longer supported. No updates or bug fixes will be added for this style.
 +
 +
===Version 1.2.5 - Released 2012-05-25===
 +
*Fix:
 +
**Crash on Mac OS with StyleOffice2011 (gradient2)
 +
**Crash on Mac OS (RibbonHelpWindow)
 +
**Embedded control not displaying properly if the Ribbon isn't in top left position.
 +
 +
===Version 1.2.4 - Released 2012-04-15===
 +
*New:
 +
**Removed Class TooltipTimer which isn't needed anymore
 +
 +
*Fix:
 +
**embeddedControl
 +
**Graphical bug in StyleOffice2010
 +
**Buttons with menu: PopupArrow missing the tip pixel in newer versions of RealStudio
 +
 +
 +
===Version 1.2.1===
 +
**Contextual Click in RibbonHelpWindow does not trigger [[RibbonCanvas.Action|Action]] anymore
  
 
==See Also==
 
==See Also==
  
−
[[RibbonButton]], [[RibbonSection]], [[RibbonTab classes.]]
+
[[RibbonButton]], [[RibbonSection]], [[RibbonTab]], [[RibbonMenu]], [[RibbonMenuOption]] classes.

Latest revision as of 17:49, 12 June 2017

The RibbonCanvas is a custom Canvas that displays a Ribbon similar to Microsoft Office and Windows 7 Paint and WordPad.


Events
Action Minimized
Change MouseDown
GearIconClicked Open
GetIcon OpenRecent
GetMenu Restored
HeightChange
MenuAction


Properties
Animate Hidden ShowTooltips
AutoHide HideButtonLeft Style
BackColor LastError TabCount
BestHeight LeftOffset TabInnerOffset
BorderColor Main TabMidOffset
EmbeddedControls ShowGearIcon Tabs
Freeze ShowHideButton Value
FullRefresh ShowRefreshTime
GearIcon ShowTabs
Hidden


Methods
AddOpenRecent Redisplay Show
EmbedControl RemoveOpenRecent toRB
GetButton SendAcceleratorKey toXML
GetMainOption SetColor
Hide SetHighlightColor
LoadFromXML SetStyle


Shared Methods
Register


History

Version 1.6.0 - Released 2016-11-14

  • New:
    • Updated for Xojo 2017R1
  • Fix
    • OutOfBoundsException on Windows


Version 1.5.0 - Released 2015-11-28

  • Fix
    • Several bug fixes


Version 1.4.0 - Released 2014-09-01

  • New:
    • Office2013 Style
    • Colored Tabs
    • Compatible with Xojo
  • Deprecated:
    • Office2007 Style is no longer supported. No updates or bug fixes will be added for this style.


Version 1.3.0 - Released 2013-04-27

  • New:
    • Office2013 Style
    • Colored Tabs
  • Deprecated:
    • Office2007 Style is no longer supported. No updates or bug fixes will be added for this style.

Version 1.2.5 - Released 2012-05-25

  • Fix:
    • Crash on Mac OS with StyleOffice2011 (gradient2)
    • Crash on Mac OS (RibbonHelpWindow)
    • Embedded control not displaying properly if the Ribbon isn't in top left position.

Version 1.2.4 - Released 2012-04-15

  • New:
    • Removed Class TooltipTimer which isn't needed anymore
  • Fix:
    • embeddedControl
    • Graphical bug in StyleOffice2010
    • Buttons with menu: PopupArrow missing the tip pixel in newer versions of RealStudio


Version 1.2.1

    • Contextual Click in RibbonHelpWindow does not trigger Action anymore

See Also

RibbonButton, RibbonSection, RibbonTab, RibbonMenu, RibbonMenuOption classes.

Retrieved from "https://www.jeremieleroy.com/wiki/index.php?title=RibbonCanvas&oldid=16146"