Difference between revisions of "RibbonButton"

From Jeremie Leroy - XOJO Controls Wiki
Jump to: navigation, search
m (1 revision)
Line 10: Line 10:
 
|class=titleClass colspan=3|Properties
 
|class=titleClass colspan=3|Properties
 
|-
 
|-
−
|width=33%|{{Property | name=Blink | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Blink | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=HelpPicture | type=Picture | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=HelpPicture | type=Picture | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=SmallIcon | type=Picture | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=SmallIcon | type=Picture | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=BlinkAmount | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=BlinkAmount | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=HelpTag | type=String | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=HelpTag | type=String | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=State | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=State | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=Caption | type=String | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Caption | type=String | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Horizontal | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Horizontal | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=TempMode | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=TempMode | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=DefaultWidth | type=Integer | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=DefaultWidth | type=Integer | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Icon | type=Picture | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Icon | type=Picture | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Visible | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Visible | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=DoubleButton | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=DoubleButton | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Menu | type=MenuItem | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Menu | type=MenuItem | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=WhiteSpace | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=WhiteSpace | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
 
|-
 
|-
−
|width=33%|{{Property | name=EmbeddedControl | type=RibbonEmbeddedControl | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=EmbeddedControl | type=RibbonEmbeddedControl | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Name | type=String | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Name | type=String | description= | readonly=no | newinversion= | version=1.2.5}}
  
 
|-
 
|-
−
|width=33%|{{Property | name=Enabled | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Enabled | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
−
|width=33%|{{Property | name=Selected | type=Boolean | description= | readonly=no | newinversion=}}
+
|width=33%|{{Property | name=Selected | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
 +
 
 +
|-
 +
|width=33%|{{Property | name=HasMenu | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
 +
|width=33%|{{Property | name=Separator | type=Boolean | description= | readonly=no | newinversion= | version=1.2.5}}
  
 
|-
 
|-
−
|width=33%|{{Property | name=HasMenu | type=Boolean | description= | readonly=no | newinversion=}}
 
−
|width=33%|{{Property | name=Separator | type=Boolean | description= | readonly=no | newinversion=}}
 
 
|}
 
|}
−
 
−
 
  
  
Line 54: Line 54:
 
|{{Method | name=Constructor | description= | newinversion=}}
 
|{{Method | name=Constructor | description= | newinversion=}}
 
|-
 
|-
−
|{{Method | name=Draw | params=g As Graphics, X As Integer, Y As Integer, SectionEnabled As Boolean | description= | returntype=Integer | newinversion=}}
+
|{{Method | name=Draw | params=g As Graphics, X As Integer, Y As Integer, Left As Integer, Top As Integer, SectionEnabled As Boolean | description= | returntype=Integer | newinversion=}}
 
|-
 
|-
 
|{{Method | name=GetXY | params=Byref locX As Integer, locY As Integer | description= | newinversion=}}
 
|{{Method | name=GetXY | params=Byref locX As Integer, locY As Integer | description= | newinversion=}}
Line 63: Line 63:
 
|-
 
|-
 
|{{Method | name=Simulate | params=SimulationStep As Integer | description= | returntype=Integer | newinversion=}}
 
|{{Method | name=Simulate | params=SimulationStep As Integer | description= | returntype=Integer | newinversion=}}
 +
|-
 +
 
|-
 
|-
 
|}
 
|}
−
 
−
 
  
  
Line 72: Line 72:
 
==Class Constants==
 
==Class Constants==
  
−
The following constants are used for the state of the button.
+
The following constants are used for the [[RibbonButton.State|State]] of the button.
  
−
<table>
+
{| class="genericTable"
−
Class constant->Description
+
!Class constant
−
StateNormal->The default display of the button
+
!Description
−
StateMouseOver->The Mouse is over the button. The background of the button is highlighted
+
|-
−
StateMouseDown->The Mouse is down on the button. The background is strongly highlighted
+
|StateNormal
−
</table>
+
|The default display of the button
 +
|-
 +
|StateMouseOver
 +
|The Mouse is over the button. The background of the button is highlighted
 +
|-
 +
|StateMouseDown
 +
|The Mouse is down on the button. The background is strongly highlighted
 +
|}
  
 
==See Also==
 
==See Also==
  
−
[[RibbonSection]], [[RibbonTab classes.
+
RibbonSection, [[RibbonTab]] classes.
−
RibbonCanvas control.]]
+
RibbonCanvas control.

Revision as of 23:55, 24 May 2012

This class is used to define a Button in the Ribbon. Buttons belong to a RibbonSection.



Properties
Blink HelpPicture SmallIcon
BlinkAmount HelpTag State
Caption Horizontal TempMode
DefaultWidth Icon Visible
DoubleButton Menu WhiteSpace
EmbeddedControl Name
Enabled Selected
HasMenu Separator


Methods
Constructor
Constructor
Draw
GetXY
Popup
SetStyle
Simulate


Class Constants

The following constants are used for the State of the button.

Class constant Description
StateNormal The default display of the button
StateMouseOver The Mouse is over the button. The background of the button is highlighted
StateMouseDown The Mouse is down on the button. The background is strongly highlighted

See Also

RibbonSection, RibbonTab classes. RibbonCanvas control.

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