group | |
Type | object |
Dictionary | LCS |
Library | LiveCode Script |
Syntax |
|
Synonyms | grp,background,bkgnd,bg |
Summary | |
Introduced | 1.0 |
OS | mac, windows, linux, ios, android |
Platforms | desktop, server, mobile |
Example |
|
Related | Keyword: card, templateGroup Property: showName Object: scrollbar Glossary: property, radio button, menu bar, object type, control |
Description | Use the group object type to hold sets of controls, radio-button clusters, menu bars, and controls to be displayed on more than one card. A group is a set of controls that has been made into a single control. You can select, move, resize, or copy the group, and all the controls in it come with the group. You can show a border around the group (using its border property), a label (using the showName property), or scrollbars. Groups can contain any type of control (including other nested groups). When referring to a group using the synonyms background, bkgnd, or bg, the reference is to one among the groups in a stack, rather than to one among the groups on a card. For example, the object reference background 1 indicates the first group in the current stack, not the lowest-layered group on the current card. |
Tags | objects |
Type | Name | Summary | Syntax |
---|---|---|---|
command | group | group [<objectList>] | |
- - - | place | Adds an existing group of objects to a card and sets the sharedBehavior property to true. | place <group> onto <card> |
- - - | remove | Deletes a group from a specified card. | remove <group> from <card> |
- - - | start editing | Puts a stack into group-editing mode. | start editing <group> [of <stack>] |
- - - | stop editing | Takes a stack out of group-editing mode. | stop editing [<group> [of <stack>]] |
- - - | ungroup | Makes a group's objects into card objects, deleting the group. | ungroup |
message | closeControl | Sent to a group when the user is leaving the card that contains it. | closeControl |
- - - | deleteBackground | deleteBackground | |
- - - | deleteGroup | deleteGroup | |
- - - | newBackground | Sent to a new group right after it's created. | newBackground |
- - - | newGroup | Sent to a new group right after it's created. | newGroup |
- - - | openBackground | Sent to all background groups when a card they are placed on is opened. | openBackground <pBackgroundID> |
- - - | openControl | Sent to a group right after you go to the card that contains it or to a background group right after going from a card where it was is not placed on to one where it is. | openControl |
- - - | preOpenBackground | Sent to the current card when you go from a card that does not have a group to a card that does. | preOpenBackground <pBackgroundID> |
- - - | preOpenControl | Sent to a group when you go to the card that contains it and to a background group when going from a card which it is not placed on to one where it is. | preOpenControl |
- - - | scrollbarDrag | Sent to a field, scrollbar, or group when the user drags the scrollbar thumb or when a text selection causes a field to scroll. | scrollbarDrag <pNewPosition> |
property | backgroundBehavior | Specifies whether a group behaves as a background and come after it's card on the message path. | set the backgroundBehavior of <group> to {true | false} |
- - - | backgroundColor | Specifies an object's background color. | set the backgroundColor of <object> to {empty | <colorName> | <RGBColor>} set the backgroundColor [of <chunk>] [of <line>] of <field> to {empty| <colorName> | <RGBColor>} |
- - - | backgroundPattern | The backgroundPattern specifies the pattern used to draw an object's background. | set the backgroundPattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | backSize | Specifies the width and height of the specified background. | set the backSize of <group> to <width>, <height> |
- - - | borderColor | Specifies the color of an object's border. | set the borderColor of <object> to {empty | <colorName> | <RGBColor>} set the borderColor of <line> of <field> to {empty | <colorName> | <RGBColor>} |
- - - | borderPattern | Specifies the pattern of an object's border. | set the borderPattern of <object> to {empty | <patternNumber> | <imageID>} |
- - - | bottom | Specifies how far an object's bottom edge is from the top of the window or screen. | set the bottom of <object> to <number> |
- - - | bottomColor | Specifies the color of a three-D object's lowered edge. | set the bottomColor of <object> to {empty | <colorName> | <RGBColor>} |
- - - | bottomMargin | Specifies how close text within an object can come to the object's lower edge, and how close objects in a group can come to the group's lower edge. | set the bottomMargin of {<button> | <field> | <group>} to <pixels> |
- - - | bottomPattern | Specifies the pattern of a three-D object's lowered edge. | set the bottomPattern of <object> to {empty | <patternNumber> | <imageID>} |
- - - | bottomRight | Specifies the location of the specified object's lower right corner. | set the bottomRight of <object> to right,bottom |
- - - | boundingRect | Specifies whether a group automatically changes size to fit when its controls are moved or resized. | set the boundingRect of <group> to {<left>, <top>, <right>, <bottom> | empty } |
- - - | cantDelete | Specifies whether an object can be deleted. | set the cantDelete of {<card> | <group> | <stack>} to {true | false} |
- - - | cardNames | Lists the short name property of all the cards in a stack, or all the cards that contain a specified group. | get the cardNames of {group | stack} |
- - - | childControlIDs | Reports the IDs of all the children of a group. | get the childControlIDs of <group> |
- - - | childControlNames | Reports the names of all the children of a group. | get the childControlNames of <group> |
- - - | clipsToRect | Specfies whether the rectangle of the group or the union of the rectangles of the child controls of the group governs the groups displayed rectangle. | set the clipsToRect of <group> to {true | false} |
- - - | container | This property defines how the layout of a control behaves with respect to its owner. | set the container[propertyName] of object to propertyValue get the container[propertyName] of object |
- - - | container expanded | Expands the control so that it fills the available space. | set the container["type"] of object to "expanded" |
- - - | container flexible | Expands the control so that it fills the available space. | set the container["type"] of object to "expanded" |
- - - | content | Defines how the controls belonging to the group or card are arranged. | set the content[propertyName] of object to propertyValue get the content[propertyName] of object |
- - - | content align | Set the align of all the children of a group or of a card. | set the content["type"] of object to "align" |
- - - | content center | Center all the children in a group or card with respect to these. | set the content["type"] of object to "center" |
- - - | cursorHover | Specifies the mouse cursor to be displayed when pointing over a control. | get the cursorHover of object set the cursorHover of object to {cursorName | imageID} |
- - - | defaultMenubar | Specifies which menu bar is displayed on Mac OS systems when the active window's menubar property is empty. | set the defaultMenubar to <group> |
- - - | disabled | Specifies that an object is dimmed and does not respond to user action. | set the disabled of <object> to {true | false} |
- - - | dontSearch | Specifies whether the find command skips a field, group, or card. | set the dontSearch of <field> to {true | false} |
- - - | enabled | Specifies that an object is active and responds to user action. | set the enabled of <object> to {true | false} |
- - - | flex | The flex factor to use for the control. | get the flex of object set the flex of object to {<integer>} |
- - - | focusColor | Specifies the color of the outline around the active control or the field with the insertion point. | set the focusColor of <object> to {empty | <colorName> | <RGBColor>} |
- - - | focusPattern | Specifies the pattern used for an object's outline when it has the insertion point or is active focused. | set the focusPattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | foregroundColor | Specifies the color of object text and borders. | set the foregroundColor of <object> to {empty | <colorName> | <RGBColor>} set the foregroundColor of [<chunk> of] <field> to {empty| <colorName> | <RGBColor>} |
- - - | foregroundPattern | Specifies the pattern used for object text and borders. | set the foregroundPattern of <object> to {<patternNumber> | <imageID> | empty} set the foregroundPattern of [<chunk> of] <field> to {<patternNumber> | <imageID> | empty} |
- - - | formattedHeight | Reports the height needed by an object to display its full contents without scrolling. | get the formattedHeight of <object> get the formattedHeight of [<chunk> of] <field> |
- - - | formattedLeft | Reports the distance between the left edge of the stack window and the leftmost object in a card or group. | get the formattedLeft of {<group> | <card>} get the formattedLeft of <chunk> of <field> |
- - - | formattedRect | Reports the rectangle that surrounds all the objects in a card or group. | get the formattedRect of {<card> | <group>} get the formattedRect of <chunk> of <field> |
- - - | formattedTop | Reports the distance between the top edge of the stack window and the topmost object in a card or group. | get the formattedTop of {<card> | <group>} get the formattedTop of <chunk> of <field> |
- - - | formattedWidth | Reports the width needed by an object to display its full contents without scrolling. | get the formattedWidth of <object> get the formattedWidth of [<chunk> of] <field> |
- - - | height | Specifies the distance from an object's top edge to its bottom edge. | set the height of <object> to <numberOfPixels> |
- - - | hiliteColor | Specifies the color of the background when an object, or text in an object, is highlighted. | set the hiliteColor [of <object>] to {empty | <colorName> | <RGBColor>} |
- - - | hilitedButton | Specifies which button in a group is currently highlighted. | set the hilitedButton of <group> to <buttonNumber> |
- - - | hilitedButtonID | Specifies which button in a group is currently highlighted. | set the hilitedButtonID of <group> to <buttonID> |
- - - | hilitedButtonName | Specifies which button in a group is currently highlighted. | set the hilitedButtonName of <group> to <buttonName> |
- - - | hilitePattern | Specifies the fill pattern used for the background when an object, or text in an object, is highlighted. | set the hilitePattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | hScroll | set the hScroll of {<field> | <group>} to <pixels> | |
- - - | hScrollbar | Specifies whether a field or group has a horizontal scrollbar. | set the hScrollbar of {<field> | <group>} to {true | false} |
- - - | ID | Reports the unique ID number assigned to an object. | set the ID of {image | stack} to <number> get the [{ long | abbreviated | short }] ID of <object> |
- - - | layer | Specifies the back-to-front order of objects on a card or the order of cards in a stack. | set the layer of <object> to {<layerNumber> | top | bottom} |
- - - | layoutBreakpoints | Gets the list of layout breakpoints that the object has. | get the layoutBreakpoints of object |
- - - | layoutMargins | Sets the margin for all four sides of a control. | get the layoutMargins of object set the layoutMargins of object to {pixels | horizontal, vertical |left, top, right, bottom} |
- - - | layoutPadding | Sets the padding space required by all sides of a control. | get the layoutPadding of object set the layoutPadding of object to {pixels | horizontal, vertical | left, top, right, bottom} |
- - - | left | Specifies how far an object's left edge is from the left edge of the window or screen. | set the left of <object> to <numberOfPixels> |
- - - | leftMargin | Specifies how close text within an object can come to the object's left edge, and how close objects in a group can come to the group's left edge. | set the leftMargin of {<button> | <field> | <group>} to <pixels> |
- - - | location | Specifies where an object is. | set the location of <object> to <point> |
- - - | lockUpdates | When a control within a group is resized or moved it causes all parents to recalculate their bounds appropriately. The lockUpdates property of the group prevents this behavior. | set the lockUpdates of <group> to {true | false} |
- - - | name | Specifies the name of an object. | set the [{ long | abbreviated | short }] name of <object> to <string> get the name |
- - - | order | The order that has a control within its owner. | get the order of object set the order of object to {<integer>} |
- - - | owner | Reports which object is next in the object hierarchy. | get the [{ long | abbreviated | short }] owner of <object> |
- - - | position | Sets how the object is positioned within its owner. | get the position[propertyName] of object set the position[propertyName] of object to propertyValue |
- - - | position align | Aligns the control within its owner. | set the position["type"] of object to "align" |
- - - | position center | Centers the object with respect to its owner. | set the position["type"] of object to "center" |
- - - | position fixed | Sets the position of one or more sides of a control with respect to its owner. | set the position["type"] of object to "fixed" |
- - - | radioBehavior | Specifies that only one radio button in a group can be highlighted at a time. | set the radioBehavior of <group> to {true | false} |
- - - | relayerGroupedControls | Specifies whether you can change the layer of controls in a group even if not in group-editing mode. | set the relayerGroupedControls to {true | false} |
- - - | right | Specifies how far an object's right edge is from the left edge of the window or screen. | set the right of <object> to <pixels> |
- - - | rightMargin | Specifies how close text within an object can come to the object's right edge, and how close objects in a group can come to the group's right edge. | set the rightMargin of {<button> | <field> | <group>} to <pixels> |
- - - | scrollbarWidth | Specifies the width of the scrollbar associated with a scrolling field or group. | set the scrollbarWidth of {<field> | <group>} to <pixels> |
- - - | selectGroupedControls | Specifies whether clicking an object in a group selects the object or the entire group. | set the selectGroupedControls to {true | false} set the selectGroupedControls of group <groupname> to {true | false} |
- - - | shadowColor | Specifies the color of an object's drop shadow or the background of a scrollbar. | set the shadowColor of <object> to {empty | <colorName> | <RGBColor>} |
- - - | shadowPattern | Specifies the pattern of an object's drop shadow. | set the shadowPattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | showName | Specifies whether an object's name is displayed within it. | set the showName of {<button> | <graphic> | <group>} to {true | false} |
- - - | tabGroupBehavior | Specifies whether the arrow keys navigate within a group and whether the Tab key skips to the next group. | set the tabGroupBehavior of <group> to {true | false} |
- - - | top | Specifies how far an object's top edge is from the top of the window or screen. | set the top of <object> to <numberOfPixels> |
- - - | topColor | Specifies the color of a three-D object's raised edge. | set the topColor of <object> to {empty | <colorName> | <RGBColor>} |
- - - | topLeft | Specifies the location of the specified object's upper left corner. | set the topLeft of <object> to left,top |
- - - | topMargin | Specifies how close text within an object can come to the object's upper edge, and how close objects in a group can come to the group's upper edge. | set the topMargin of {<button> | <field> | <group>} to <pixels> |
- - - | topPattern | Specifies the pattern used to draw a three-D object's raised edge. | set the topPattern of <object> to {<patternNumber> | <imageID> | empty} |
- - - | topRight | Specifies the location of the specified object's upper right corner. | set the topRight of <object> to <right>, <top> |
- - - | traversalOn | Specifies whether a control can become the active control|active (focused) control. | set the traversalOn of <object> to {true | false} |
- - - | unboundedHScroll | Specifies whether automatic clamping of the hScroll offsets of a group is on or off. | set the unboundedHScroll of <group> to {true | false} |
- - - | unboundedVScroll | Specifies whether automatic clamping of the vScroll offsets of a group is on or off. | set the unboundedVScroll of <group> to {true | false} |
- - - | vScroll | set the vScroll of {<field> | <group>} to <pixels> get the scroll of <stack> | |
- - - | vScrollbar | Specifies whether a field or group has a vertical scrollbar. | set the vScrollbar of {<field> | <group>} to {true | false} |