Ribbon (PRIM_RBBN)
Ribbon control
Ancestors - Container (PRIM_CPST)Control (PRIM_CTRL)Object (PRIM_OBJT)
Details
A ribbon is a set of tabbed toolbars used access application features.
Example
In this example...
Function Options(*DIRECT)
Begin_Com Role(*EXTENDS #PRIM_FORM) Clientwidth(994) Clientheight(435) Componentversion(2) Top(203) Left(135)
Define_Com Class(#PRIM_RBBN) Name(#Ribbon) Displayposition(1) Left(0) Parent(#COM_OWNER) Tabposition(1) Tabstop(False) Top(0) Width(994)
Define_Com Class(#PRIM_RBBN.ApplicationMenu) Name(#RibbonMenu) Caption('File') Displayposition(3) Keytip('F') Parent(#Ribbon) Tabposition(3) Tabstop(False)
Define_Com Class(#PRIM_RBBN.ApplicationMenuFooter) Name(#RibbonMenuFooter) Displayposition(2) Parent(#Ribbon) Tabposition(2) Tabstop(False)
Define_Com Class(#PRIM_RBBN.ApplicationMenuContent) Name(#RibbonMenuContent) Displayposition(1) Parent(#Ribbon) Tabposition(1) Tabstop(False)
Define_Com Class(#PRIM_RBBN.QuickAccessToolbar) Name(#QuickAccessToolbar) Displayposition(1) Parent(#Ribbon) Tabposition(1) Tabstop(False) Width(80) Left(10)
Define_Com Class(#PRIM_RBBN.HelpToolbar) Name(#HelpToolbar) Displayposition(2) Parent(#Ribbon) Tabposition(2) Tabstop(False) Width(40) Left(954) Top(29)
Define_Com Class(#PRIM_RBBN.Sheet) Name(#Sheet1) Caption('Home') Displayposition(3) Height(91) Keytip('H') Left(0) Parent(#Ribbon) Tabposition(3) Tabstop(False) Top(49) Width(994)
Define_Com Class(#PRIM_RBBN.Sheet) Name(#Sheet2) Caption('Sheet 2') Displayposition(4) Height(91) Keytip('S2') Left(0) Parent(#Ribbon) Tabposition(4) Tabstop(False) Top(49) Width(994)
Define_Com Class(#PRIM_RBBN.Sheet) Name(#Sheet3) Caption('Sheet 3') Displayposition(5) Height(91) Keytip('S3') Left(0) Parent(#Ribbon) Tabposition(5) Tabstop(False) Top(49) Width(994)
Define_Com Class(#PRIM_RBBN.Group) Name(#Group1) Caption('Clipboard') Displayposition(1) Image(#xImagePaste16) Left(12) Parent(#Sheet1) Tabposition(1) Tabstop(False) Width(120)
Define_Com Class(#PRIM_RBBN.Group) Name(#Group2) Caption('Group 2') Displayposition(2) Left(144) Parent(#Sheet1) Tabposition(2) Tabstop(False)
Define_Com Class(#PRIM_RBBN.Group) Name(#Group3) Caption('Group 1') Displayposition(1) Left(12) Parent(#Sheet2) Tabposition(1) Tabstop(False)
Define_Com Class(#PRIM_RBBN.Group) Name(#Group4) Caption('Group 2') Displayposition(2) Left(224) Parent(#Sheet2) Tabposition(2) Tabstop(False)
Define_Com Class(#PRIM_RBBN.Group) Name(#Group5) Caption('Group 1') Displayposition(1) Left(12) Parent(#Sheet3) Tabposition(1) Tabstop(False)
Define_Com Class(#PRIM_RBBN.Group) Name(#Group6) Caption('Group 2') Displayposition(2) Left(224) Parent(#Sheet3) Tabposition(2) Tabstop(False)
Define_Com Class(#PRIM_SPBN) Name(#GroupButton1) Alignment(Top) Autosize(False) Buttonstyle(FlatButton) Caption('Paste') Componentversion(1) Displayposition(1) Height(57) Hint('Paste the contents of the Clipboard') Hinttitle('Paste (Ctrl+V)') Image(#xImagePaste32) Imageposition(AboveCaption) Left(2) Parent(#Group1) Tabposition(1) Top(5) Width(50)
Define_Com Class(#PRIM_SPBN) Name(#GroupButton2) Alignment(Left) Autosize(False) Buttonstyle(FlatButton) Caption('Cut') Componentversion(1) Displayposition(2) Height(22) Hint('Cut the selection and put in on the Clipboard') Hinttitle('Cut (Ctrl+X)') Image(#xImageCut16) Left(55) Parent(#Group1) Tabposition(2) Top(5) Width(60)
Define_Com Class(#PRIM_SPBN) Name(#GroupButton3) Alignment(Left) Autosize(False) Buttonstyle(FlatButton) Caption('Copy') Componentversion(1) Displayposition(3) Height(22) Hint('Copy the selection and put in on the Clipboard') Hinttitle('Copy (Ctrl+C)') Image(#xImageCopy16) Left(55) Parent(#Group1) Tabposition(3) Top(27) Width(60)
Define_Com Class(#PRIM_SLAB) Name(#ContentLabel1) Caption('Last Opened') Displayposition(1) Ellipses(Word) Height(25) Left(0) Parent(#RibbonMenuContent) Top(0) Verticalalignment(Center) Width(90)
Define_Com Class(#PRIM_SPBN) Name(#MenuButton1) Alignment(Left) Autosize(False) Buttonstyle(FlatButton) Caption('New') Componentversion(1) Displayposition(1) Height(40) Image(#xImageNew32) Left(2) Parent(#RibbonMenu) Tabposition(1) Top(0) Width(148)
Define_Com Class(#PRIM_SPBN) Name(#MenuButton2) Alignment(Left) Autosize(False) Buttonstyle(FlatButton) Caption('Open') Componentversion(1) Displayposition(2) Height(40) Image(#xImageOpen32) Left(2) Parent(#RibbonMenu) Tabposition(2) Top(42) Width(148)
Define_Com Class(#PRIM_SPBN) Name(#MenuButton3) Alignment(Left) Autosize(False) Buttonstyle(FlatButton) Caption('Save') Componentversion(1) Displayposition(3) Height(40) Image(#xImageSave32) Left(2) Parent(#RibbonMenu) Tabposition(3) Top(84) Width(148)
Define_Com Class(#PRIM_SPBN) Name(#FooterButton1) Autosize(False) Buttonstyle(FlatButton) Caption('Options') Componentversion(1) Displayposition(1) Height(25) Image(#xImageSettings16) Left(220) Parent(#RibbonMenuFooter) Tabposition(1) Top(0) Width(120)
Define_Com Class(#PRIM_SPBN) Name(#FooterButton2) Autosize(False) Buttonstyle(FlatButton) Caption('Exit') Componentversion(1) Displayposition(2) Height(25) Image(#xImageExit16) Left(345) Parent(#RibbonMenuFooter) Tabposition(2) Top(0) Width(100)
Define_Com Class(#PRIM_SPBN) Name(#QuickAccessButton1) Autosize(False) Buttonstyle(FlatButton) Componentversion(1) Displayposition(1) Height(18) Image(#xImageNew16) Left(0) Parent(#QuickAccessToolbar) Tabposition(1) Top(0) Width(18)
Define_Com Class(#PRIM_SPBN) Name(#QuickAccessButton2) Autosize(False) Buttonstyle(FlatButton) Componentversion(1) Displayposition(2) Height(18) Image(#xImageOpen16) Left(20) Parent(#QuickAccessToolbar) Tabposition(2) Top(0) Width(18)
Define_Com Class(#PRIM_SPBN) Name(#QuickAccessButton3) Autosize(False) Buttonstyle(FlatButton) Componentversion(1) Displayposition(3) Height(18) Image(#xImageSave16) Left(40) Parent(#QuickAccessToolbar) Tabposition(3) Top(0) Width(18)
Define_Com Class(#PRIM_SPBN) Name(#QuickAccessButton4) Autosize(False) Buttonstyle(FlatButton) Componentversion(1) Displayposition(4) Height(18) Image(#xImageClose16) Left(60) Parent(#QuickAccessToolbar) Tabposition(4) Top(0) Width(18)
Define_Com Class(#PRIM_SPBN) Name(#HelpButton1) Autosize(False) Buttonstyle(FlatButton) Componentversion(1) Displayposition(1) Height(18) Image(#xImageMinimizeRibbon16) Left(0) Parent(#HelpToolbar) Tabposition(1) Top(0) Width(18)
Define_Com Class(#PRIM_SPBN) Name(#HelpButton2) Autosize(False) Buttonstyle(FlatButton) Componentversion(1) Displayposition(2) Height(18) Image(#xImageHelp16) Left(20) Parent(#HelpToolbar) Tabposition(2) Top(0) Width(18)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip1) Control(#GroupButton1) Keytip('V') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip2) Control(#GroupButton2) Keytip('X') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip3) Control(#GroupButton3) Keytip('C') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip4) Control(#MenuButton1) Keytip('N') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip5) Control(#MenuButton2) Keytip('O') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip6) Control(#MenuButton3) Keytip('S') Parent(#Ribbon) Shortcut(Ctrl+S)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip7) Control(#FooterButton1) Keytip('E') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip8) Control(#FooterButton2) Keytip('X') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip9) Control(#QuickAccessButton1) Keytip('1') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip10) Control(#QuickAccessButton2) Keytip('2') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip11) Control(#QuickAccessButton3) Keytip('3') Parent(#Ribbon)
Define_Com Class(#PRIM_RBBN.AccessKey) Name(#KeyTip12) Control(#QuickAccessButton4) Keytip('4') Parent(#Ribbon)
End_Com
Properties
| Name | Description |
|---|---|
| BusyUpdates | BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL) |
| BusyUpdatesOfParent | BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL) |
| CanFocus | CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL) |
| ComponentClassName | ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
| ComponentControls | ComponentControls is a collection of all the controls contained in this component. Inherited from Container (PRIM_CPST) |
| ComponentMembers | ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) |
| ComponentPatternName | ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) |
| ComponentTag | Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) |
| ComponentType | ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) |
| ComponentTypeName | ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) |
| Cursor | Cursor sets the cursor image Inherited from Control (PRIM_CTRL) |
| DisplayPosition | DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL) |
| DragStyle | DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL) |
| EnableChildren | EnableChildren specifies if the parent sets the Enabled property of child components Inherited from Container (PRIM_CPST) |
| Enabled | Enable activates/deactivates the component Inherited from Control (PRIM_CTRL) |
| FixedPosition | Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL) |
| Focus | Focus tells whether the component has focus Inherited from Control (PRIM_CTRL) |
| FocusedStyle | Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
| FocusedStyles | Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL) |
| Handle | Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL) |
| Height | The height of the control in pixels Inherited from Control (PRIM_CTRL) |
| Hint | Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL) |
| HintPopup | HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL) |
| HintShow | Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL) |
| HintShowOfParent | Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL) |
| HintTitle | HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL) |
| IsAnimating | IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL) |
| IsRealized | True if the control is currently realized Inherited from Control (PRIM_CTRL) |
| Left | Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL) |
| Minimized | Ribbon is minimized |
| Modified | Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL) |
| MouseOver | MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL) |
| MouseOverPart | True if the cursor is within the bounds of a child component Inherited from Container (PRIM_CPST) |
| MouseOverStyle | MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
| MouseOverStyles | MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL) |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| Opacity | Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL) |
| OpenPage | Reference to the currently open |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL) |
| Popup | Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL) |
| PopupMenu | Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL) |
| PrivateStyle | Style applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST) |
| PrivateStyles | Collection of styles applied to the control but not inherited by child controls Inherited from Container (PRIM_CPST) |
| QuickAccessToolBarOnTop | Show the quick access toolbar above or below the ribbon |
| Rotation | Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL) |
| RotationOriginLeft | RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
| RotationOriginTop | RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL) |
| ScaleHeight | ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
| ScaleOriginLeft | ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
| ScaleOriginTop | ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL) |
| ScaleWidth | ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL) |
| ScreenLeft | ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL) |
| ScreenTop | ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL) |
| ScrollLeft | Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
| ScrollTop | Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL) |
| SkewLeft | SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL) |
| SkewOriginLeft | SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
| SkewOriginTop | SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL) |
| SkewTop | SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL) |
| Style | Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL) |
| Styles | Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL) |
| TabPosition | TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL) |
| TabStop | Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL) |
| ThemeDrawStyle | Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL) |
| Top | Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL) |
| TouchMove | Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL) |
| TouchRotate | Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL) |
| TouchScale | Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL) |
| TouchSize | Determines whether a control can be resized Inherited from Control (PRIM_CTRL) |
| Visible | Show or hide the control Inherited from Control (PRIM_CTRL) |
| VisualStyle | VisualStyle sets the appearance Inherited from Control (PRIM_CTRL) |
| VisualStyleOfParent | Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL) |
| Width | Width of the component in pixels Inherited from Control (PRIM_CTRL) |
Events
| Name | Description |
|---|---|
| AnimationEnded | Fired when an animation is ended Inherited from Control (PRIM_CTRL) Cancelled |
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL) |
| DragDrop | Fired on mouse up to signify the end of a drag process Inherited from Control (PRIM_CTRL) PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult |
| DragOver | Fired during the drag and drop process when the cursor moves over the control Inherited from Control (PRIM_CTRL) PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled |
| EndDrag | Fired when the drag and drop process has completed Inherited from Control (PRIM_CTRL) Source, Payload, DragResult, AggregatedSource, Origin, Handled |
| Initialize | Fired after a component has been realized for the first time Inherited from Control (PRIM_CTRL) |
| MouseEnter | The mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL) |
| MouseHover | The mouse has hovered over the control Inherited from Control (PRIM_CTRL) Origin, Handled |
| MouseLeave | The mouse has left the bounds of the control Inherited from Control (PRIM_CTRL) |
| StartDrag | Fired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL) Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled |
| TouchChange | Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Control (PRIM_CTRL) MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue |
| TouchEnd | Fired when the user stops touching the screen Inherited from Control (PRIM_CTRL) |
| TouchStart | Fired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL) Origin, TouchMove, TouchRotate, TouchScale, TouchSize |
Methods
| Name | Description |
|---|---|
| FadeIn | Animate from invisible to visible Inherited from Control (PRIM_CTRL) Duration, Delay |
| FadeOut | Animate from visible to invisible Inherited from Control (PRIM_CTRL) Duration, Delay, Visible |
| MoveFrom | Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay |
| MoveTo | Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL) Left, Top, Duration, Delay |
| Realize | Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
| Scale | Animate a change of scale Inherited from Control (PRIM_CTRL) ScaleWidth, ScaleHeight, Duration, Delay |
| SetFocus | Sets the control to be the focus control Inherited from Control (PRIM_CTRL) |
| ShowMessages | LANSA Internal Use Inherited from Control (PRIM_CTRL) |
| SizeTo | Changes and animates control size changing Inherited from Control (PRIM_CTRL) Width, Height, Duration, Delay |
| Transition | Animate the change from one control to another Inherited from Container (PRIM_CPST) From, To, TransitionType, Duration, Delay |
| Unrealize | Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL) |
| UpdateDisplay | UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL) |
See also
LANSA Version 15, April 2020