button

Typeobject
DictionaryLCS
LibraryLiveCode Script
Syntax
button
Synonymsbtn
Summary

A control that is clickable.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Example
set the hilite of button "Warning" to false
if the number of this card is 1 then hide button "Previous"
RelatedKeyword: templateButton, control, button, menu
Property: menuMode, style
Command: popup
Glossary: property, tabbed button, contextual menu, object type, combo box
Description

Use the button object type to create a clickable button, a tabbed window, or a menu.

Button objects can be push buttons, checkboxes, radio buttons, or menus, depending on the setting of their style property.

A button whose style is set to "menu" can be a popup or contextual menu, pulldown menu, option menu, tabbed button, or combo box, depending on the setting of its menuMode property.

A button is contained in a card, group, or background. Buttons cannot contain other objects.

Note: A standard button is rendered by the operating system, not LiveCode. Changing certain properties of such a button will cause the button to stop honouring the native theme. Properties that affect the button's colour and border may cause this issue.

Tagsobjects
TypeNameSummarySyntax
messagedeleteButton

Sent to a button just before it is removed from the stack.

deleteButton

- - -dragDrop

Sent to the object where data was dropped when a drag and drop finishes.

dragDrop

- - -dragEnd

Sent to the object a drag and drop started from, when the data is dropped.

dragEnd

- - -dragEnter

Sent when the mouse pointer moves into an object during a drag and drop.

dragEnter

- - -dragLeave

Sent when the mouse pointer moves out of an object during a drag and drop.

dragLeave

- - -dragMove

Sent when the user moves the mouse during a drag and drop.

dragMove

- - -dragStart

Sent to a control when the user clicked on it and then started to drag the mouse pointer.

dragStart

- - -focusIn

Sent to a control when it becomes active focused.

focusIn

- - -focusOut

Sent to a button or field when it becomes inactive (loses focus).

focusOut

- - -menuPick

Sent to a button when a menu item is chosen from the menu associated with that button.

menuPick <pChosenItem> [, <pPreviousTab>]

- - -mouseDoubleDown

Sent when the user double-clicks.

mouseDoubleDown <pButtonNumber>

- - -mouseDoubleUp

Sent when the mouse button is released at the end of a double-click.

mouseDoubleUp <pButtonNumber>

- - -mouseDown

Sent when the user presses the mouse button.

mouseDown <pButtonNumber>

- - -mouseEnter

Sent when the mouse pointer moves into an object.

mouseEnter

- - -mouseLeave

Sent when the mouse pointer moves out of an object.

mouseLeave

- - -mouseMove

Sent when the user moves the mouse.

mouseMove <pNewMouseH>, <pNewMouseV>

- - -mouseRelease

Sent when the user releases the mouse outside the control that was clicked.

mouseRelease <pButtonNumber>

- - -mouseStillDown

Sent periodically while the mouse button is being held down.

mouseStillDown <pButtonNumber>

- - -mouseUp

Sent when the user releases the mouse button.

mouseUp <pButtonNumber>

- - -mouseWithin

Sent periodically to an object while the mouse pointer is within its borders.

mouseWithin

- - -nameChanged

Sent to an object when its name is changed.

nameChanged <pOldName>, <pNewName>

- - -newButton

Sent to a new button right after it's created.

newButton

- - -resizeControl

Sent to a control right after the user resizes it.

resizeControl

- - -selectedObjectChanged

Sent to an object when it is selected.

selectedObjectChanged

- - -socketClosed

Sent when the remote system closes a socket.

socketClosed <pSocketID>

- - -socketError

Sent when an error occurs on a socket that causes the socket to close or to fail to open.

socketError <pSocketID>, <pErrorString>

- - -socketTimeout

Sent when an open socket, read from socket or write to socket command halts for the time specified by the socketTimeoutInterval property.

socketTimeout <pSocketID>

propertyacceleratorKey

Specifies a shortcut key combination for a button's mouseUp handler.

set the accel[erator]Key of <button> to {empty | <letterChar>}

- - -acceleratorModifiers

Specifies one or more modifier keys that must be pressed with the button shortcut key specified by the acceleratorKey property.

set the acceleratorModifiers of <button> to {empty | <keys>}

- - -acceleratorText

Specifies the shortcut hint that appears at the right edge of a button.

set the accel[erator]Text of <button> to <string>

- - -altID

Specifies an alternate ID for objects.

set the altID of <object> to <IDNumber>

- - -armBorder

Determines whether a button is drawn with a border when armed.

set the armBorder of <button> to {true | false}

- - -armed

Specifies whether a button has a changed (active) appearance due to the mouse pointer moving into it

set the armed of <button> to {true | false}

- - -armedIcon

Specifies an image to display in a button when the mouse pointer enters it.

set the armedIcon of <button> to {<imageID> | <imageName>}

- - -armFill

Determines whether a button menu is drawn with a border when armed.

set the armFill of <button> to {true | false}

- - -autoArm

Specifies whether a button becomes armed when the mouse pointer moves into it.

set the autoArm of <button> to {true | false}

- - -autoHilite

Specifies whether a button highlights when it's pressed, or whether selected text in a field is highlighted.

set the autoHilite of {<button> | <field>} 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}

- - -backgroundPixel

Specifies which entry in the color table is used for an object's background color.

set the backgroundPixel of <object> to <colorNumber>

- - -behavior

Allows an object to inherit its script handlers from another object.

set the behavior of <object> to {<button> | <stack>}

- - -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>}

- - -borderPixel

Specifies which entry in the color table is used for the color of an object's border.

set the borderPixel of <object> to <colorNumber>

- - -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>}

- - -bottomLeft

Specifies the location of the specified object's lower left corner.

set the bottomLeft of <object> to <left>, <bottom>

- - -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>}

- - -bottomPixel

Specifies which entry in the color table is used for the color of a three-D object's lowered edge.

set the bottomPixel of <object> to <colorNumber>

- - -bottomRight

Specifies the location of the specified object's lower right corner.

set the bottomRight of <object> to right,bottom

- - -colorOverlay

Specifies the color overlay to use for an object.

set the colorOverlay of object to <propertiesArray>

set the colorOverlay[<propertyName>] of object to <propertyValue>

- - -colors

Specifies all the colors of an object, in shorthand form.

set the colors of <object> to <colorsList>

- - -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"

- - -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}

- - -customKeys

Lists the names of all the custom properties of an object.

set the customKeys of <object> to {<propertiesList> | empty}

- - -customProperties

Specifies all the custom properties of an object that are in the current customPropertySet, along with their settings.

set the customProperties of <object> to <propertiesArray>

set the customProperties[<propertySet>] of <object> to <propertiesArray>

- - -customPropertySet

Specifies a set of custom properties applied to an object.

set the customPropertySet of object to {setName | empty}

- - -customPropertySets

Lists all the custom property sets that can apply to an object.

get the customPropertySets of <object>

- - -default

Specifies that a button will be automatically chosen when the user presses Return or Enter.

set the default of <button> to {true | false}

- - -disabled

Specifies that an object is dimmed and does not respond to user action.

set the disabled of <object> to {true | false}

- - -disabledIcon

Specifies an image to display in a button when the button is disabled.

set the disabledIcon of <button> to {<imageID> | <imageName>}

- - -dropShadow

Specifies the drop shadow to use for an object.

set the dropShadow of object to <propertiesArray>

set the dropShadow[<propertyName>] of object to <propertyValue>

- - -enabled

Specifies that an object is active and responds to user action.

set the enabled of <object> to {true | false}

- - -encoding

Returns the encoding of the specified piece of text.

the encoding of { button | graphic | group }

the encoding of [<chunk> of] <field>

- - -family

Coordinates a set of radio buttons so that only one button of a family can be highlighted.

set the family of <button> to <number>

- - -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}

- - -focusPixel

Specifies which entry in the color table is used for the color of an object's outline when it has the insertion point or is active focused.

set the focusPixel of <object> to <colorNumber>

- - -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}

- - -foregroundPixel

Specifies which entry in the color table is used for an object's text and borders.

set the foregroundPixel of <object> to <colorNumber>

- - -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>

- - -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>

- - -hilite

Determines whether a button is highlighted.

set the hilite of <button> to {true | false}

- - -hiliteBorder

Specifies whether a three-D button appears to be pushed in when it is highlighted.

set the hiliteBorder of <button> to {true | false}

- - -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>}

- - -hilitedIcon

Specifies an image to display in a button when the button is highlighted.

set the hilitedIcon of <button> to {<imageID> | <imageName>}

- - -hiliteFill

Specifies whether a button's background is filled with the hiliteColor and hilitePattern when the button is highlighted.

set the hiliteFill of <button> to {true | false}

- - -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}

- - -hilitePixel

Specifies which entry in the color table is used for the background color when an object, or text in an object, is highlighted.

set the hilitePixel of <object> to <colorNumber>

- - -hoverIcon

Specifies an image to display in a button when the mouse pointer enters the button.

set the hoverIcon of <button> to {<imageID> | <imageName>}

- - -iconGravity

Specifies wether the icon of a button is placed independently of the label.

set the iconGravity of <button> to <position>

- - -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>

- - -innerGlow

Specifies the inner glow to use for an object

set the innerGlow of object to <propertiesArray>

set the innerGlow[<propertyName>] of object to <propertyValue>

- - -innerShadow

Specifies the inner shadow to use for an object.

set the innerShadow of object to <propertiesArray>

set the innerShadow[<propertyName>] of object to <propertyValue>

- - -invisible

Specifies whether an object is hidden.

set the invisible of <object> to {true | false}

get the [effective] invisible of <object>

- - -label

Specifies the string shown in a stack window's title bar, or a text label to be displayed on the specified object if its showName property is true.

set the label of <object> to <labelString>

- - -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}

- - -layerMode

Specifies whether an object is dynamic or static.

set the layerMode of <object> to <mode>

get the [effective] layerMode of <object>

- - -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}

- - -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>

- - -menuHistory

Specifies the number of the currently selected item of the menu that belongs to a button.

set the menuHistory of <button> to <itemNumber>

- - -menuLines

Specifies the number of visible lines in a drop-down list menu belonging to a button.

set the menuLines of <button> to <number>

- - -menuMode

Determines the appearance and behavior of menus associated with a button.

set the menuMode of <button> to <menuType>

- - -menuMouseButton

Specifies which mouse button can be used to access the menu associated with a button.

set the menuMouseButton of <button> to {zero | <pButtonNumber>}

- - -menuName

Specifies the stack where the menu associated with a button is located.

set the menuName of <button> to <stack>

- - -mnemonic

Specifies which character of a button's name can be used with the Alt key to trigger the button.

set the mnemonic of <button> to <number>

- - -name

Specifies the name of an object.

set the [{ long | abbreviated | short }] name of <object> to <string>

get the name

- - -number

Specifies an object's position within a file, a card's position within a stack, or a control's layer on a card.

set the number of <card> to <number>

get the number of <object>

- - -order

The order that has a control within its owner.

get the order of object

set the order of object to {<integer>}

- - -outerGlow

Specifies the outer glow to use for an object.

set the outerglow of object to <propertiesArray>

set the outerglow[<propertyName>] of object to <propertyValue>

- - -owner

Reports which object is next in the object hierarchy.

get the [{ long | abbreviated | short }] owner of <object>

- - -patterns

Specifies all the patterns of an object, in shorthand form.

set the patterns of <object> to <patternsList>

- - -penBack

Has no effect and is included in LiveCode for compatibility with imported SuperCard projects.

set the penBack [of <object>] to <colorNumber>

- - -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"

- - -properties

Specifies some of an object's properties and their current values.

set the properties of <object> to <propertiesArray>

- - -rectangle

Specifies the area within which an object is drawn.

set the rectangle of <object> to <left>, <top>, <right>, <bottom>

get the [effective] rectangle of <object>

- - -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>

- - -script

Specifies the contents of an object's script.

set the script of <object> to <string>

- - -selected

Specifies whether an object is selected.

set the selected of <object> 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>}

- - -shadowOffset

Specifies the size and direction of an object's drop shadow.

set the shadowOffset of <object> to <pixels>

- - -shadowPattern

Specifies the pattern of an object's drop shadow.

set the shadowPattern of <object> to {<patternNumber> | <imageID> | empty}

- - -shadowPixel

Specifies which entry in the color table is used for the color of an object's drop shadow or the background of a scrollbar.

set the shadowPixel of <object> to <colorNumber>

- - -sharedHilite

Specifies whether a grouped button's hilite property is the same on all cards with that group.

set the sharedHilite of <button> to {true | false}

- - -showBorder

Specifies whether an outline is drawn around an object.

set the showBorder of <object> to {true | false}

- - -showFocusBorder

Displays a border around the active control.

set the showFocusBorder of <control> to {true | false}

- - -showHilite

Specifies whether the box or circle belonging to checkboxes and radio buttons is shown.

set the showHilite of <button> to {true | false}

- - -showIcon

Specifies whether a button's icon is visible.

set the showIcon of <button> to {true | false}

- - -showName

Specifies whether an object's name is displayed within it.

set the showName of {<button> | <graphic> | <group>} to {true | false}

- - -style

Specifies the general appearance and behavior of an object.

set the style of <object> to <styleName>

- - -text

Specifies the text contained by a button or field or the binary data in an image.

set the text of {<button> | <field> | <image>} to <string>

- - -textAlign

Specifies how text is aligned or justified in a field or button.

set the textAlign [of <line>] of {<button> | <field>} to {left | center | right}

- - -textFont

Specifies the font face of text in an object.

set the textFont of <object> to <fontName> [, <language>]

set the textFont of [<chunk> of] <field> to <fontName> [, <language>]

- - -textSize

Specifies the point size of text displayed by an object.

set the textSize of <object> to <pointSize>

set the textSize of [<chunk> of] <field> to <pointSize>

- - -textStyle

Specifies the style or styles applied to text in an object.

set the textStyle of <object> to {empty | plain | <stylesList>}

set the textStyle of [<chunk> of] <field> to {empty | plain | <stylesList>}

set the textStyle[<style>] of object to {true | false}

- - -threeD

Specifies whether an object appears to stick out of or recede into the screen.

set the threeD of <object> to {true | false}

- - -titleWidth

Specifies the amount of a button's width used to display the button's name or label property to the left of the button.

set the titleWidth of <button> to <pixels>

- - -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}

- - -topPixel

Specifies which entry in the color table is used for the color of a three-D object's raised edge.

set the topPixel of <object> to <colorNumber>

- - -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}

- - -unicodeLabel

Specifies the UTF-16 string to be displayed on the specified object if its showName property is true.

set the unicodeLabel of object to labelString

- - -unicodeText

Specifies the text in a field, represented as Unicode (double-byte characters).

set the unicodeText of [<chunk> of] <field> to <unicodeString>

set the unicodeText of <button> to <unicodeString>

- - -unicodeTooltip

Specifies the explanatory text (UTF-16 string) that pops up in a small box when the user points to an object.

set the unicodeTooltip of object to <unicodeString>

- - -visible

Specifies whether an object can be seen or is hidden.

set the [effective] visible of <object> to {true | false}

- - -visited

Specifies whether a button or grouped text has been clicked during the current session.

set the visited of <button> to {true | false}

set the visited of <chunk> of <field> to {true | false}

- - -visitedIcon

Specifies an image to display in a button when the button's visited property is true.

set the visitedIcon of <button> to {<imageID> | <imageName>}

- - -width

The width of an object is the distance from its left edge to its right edge.

set the width of <object> to <numberOfPixels>