Difference between revisions of "Commandgroup"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) (→Description) |
||
(14 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages. | ||
+ | |||
+ | ====Description==== | ||
+ | Shown below in a standalone [[Form]]. Click the image to see in a [[Custom_Sections_and_Gadgets|Custom Section]] in a Lianja [[Page Attributes|Page]]. | ||
+ | |||
+ | [[{{ns:file}}:commandgroup_commandbutton.png|link={{filepath:commandgroup_commandbutton_cs.png}}|Commandgroup, Commandbutton]] | ||
+ | |||
+ | A command button is typically used to start an event that performs an action such as closing a form, moving to a different record, printing a report, and so on. Use the CommandGroup control to create a set of command buttons that you can manipulate individually or as a group. | ||
+ | |||
====Properties==== | ====Properties==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Properties|Common Properties]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Property | !width="20%"|Property | ||
!Access (R/RW) | !Access (R/RW) | ||
Line 9: | Line 18: | ||
!width="50%"|Description | !width="50%"|Description | ||
|- | |- | ||
− | | | + | |ButtonCount |
|RW | |RW | ||
− | | | + | |Numeric |
− | | | + | |Number of buttons |
+ | |- | ||
+ | |Margin | ||
+ | |RW | ||
+ | |Numeric | ||
+ | |Button margins | ||
|- | |- | ||
|Orientation | |Orientation | ||
|RW | |RW | ||
− | | | + | |Numeric |
− | | | + | |Orientation: 0 = horizontal, >0 = vertical |
+ | |- | ||
+ | |Spacing | ||
+ | |RW | ||
+ | |Numeric | ||
+ | |Button spacing | ||
|- | |- | ||
|} | |} | ||
Line 23: | Line 42: | ||
====Methods==== | ====Methods==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Methods|Common Methods]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Method | !width="20%"|Method | ||
!Args | !Args | ||
!width="50%"|Description | !width="50%"|Description | ||
|- | |- | ||
− | | | + | |valign="top"|AddObject |
− | | | + | |valign="top"|existing as Object | newobject as Character, class as Character |
− | | | + | |valign="top"|Add an existing object or a new object, in which case the object's class must also be specified |
− | | | + | |
− | | | + | |
− | + | ||
− | | | + | |
|- | |- | ||
|Buttons | |Buttons | ||
− | | | + | |button as Numeric |
− | | | + | |Return an object reference to the specified button |
|- | |- | ||
− | | | + | |RemoveObject |
− | | | + | |existing as Object |
− | | | + | |Remove the specified object |
|- | |- | ||
|} | |} | ||
Line 50: | Line 65: | ||
====Events==== | ====Events==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Events|Common Events]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Event | !width="20%"|Event | ||
!Args | !Args | ||
!width="50%"|Description | !width="50%"|Description | ||
− | + | |- | |
+ | |click | ||
+ | |button as Numeric | ||
+ | |Occurs when a button in the group is clicked | ||
+ | |- | ||
|} | |} | ||
+ | |||
+ | [[Category:Documentation]] | ||
+ | [[Category:Framework Classes]] |
Latest revision as of 11:00, 9 April 2018
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Contents
Description
Shown below in a standalone Form. Click the image to see in a Custom Section in a Lianja Page.
A command button is typically used to start an event that performs an action such as closing a form, moving to a different record, printing a report, and so on. Use the CommandGroup control to create a set of command buttons that you can manipulate individually or as a group.
Properties
This class supports the Common Properties plus the following:
Property | Access (R/RW) | Value | Description |
---|---|---|---|
ButtonCount | RW | Numeric | Number of buttons |
Margin | RW | Numeric | Button margins |
Orientation | RW | Numeric | Orientation: 0 = horizontal, >0 = vertical |
Spacing | RW | Numeric | Button spacing |
Methods
This class supports the Common Methods plus the following:
Method | Args | Description |
---|---|---|
AddObject | existing as Object | newobject as Character, class as Character | Add an existing object or a new object, in which case the object's class must also be specified |
Buttons | button as Numeric | Return an object reference to the specified button |
RemoveObject | existing as Object | Remove the specified object |
Events
This class supports the Common Events plus the following:
Event | Args | Description |
---|---|---|
click | button as Numeric | Occurs when a button in the group is clicked |