image

Typeobject
DictionaryLCS
LibraryLiveCode Script
Syntax
image
Synonymsimg
Summary

A control that contains a bitmapped picture.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Example
hide image "Blinking Star"
export image ID 9234 to file "Test Image.jpg"
RelatedKeyword: templateImage, file, image, control
Property: filename, imageData, resizeQuality
Object: image, graphic
Glossary: property, paint tool, bitmap, command, object type
Description

Use the image object type to hold photographs, icons, and decorative elements, and to allow the user to paint.

Each image contains a bitmapped picture, which can either be imported with the import command or created using the painttools. An image can display either its own data, or a file specified by the image's filename property.

An image is contained in a card, group, or background. Images cannot contain other objects.

Note: Animated GIFs cannot be resized in LiveCode.

Tagsobjects
TypeNameSummarySyntax
messagedeleteImage

Sent to an image just before it is removed from the stack.

deleteImage

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

- - -IDChanged

Sent to an image when its ID property is changed.

IDChanged <pOldID>, <pNewID>

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

- - -newImage

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

newImage

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

propertyalphaData

Specifies the binary data that makes up the alpha channel of the picture in an image object.

set the alphaData of <image> to <binaryData>

- - -altID

Specifies an alternate ID for objects.

set the altID of <object> to <IDNumber>

- - -alwaysBuffer

Determines whether the contents of windows, players, and images are buffered offscreen.

set the alwaysBuffer of {<stack> | <image> | <player>} 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>

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

- - -centerRect

Specifies a region of pixels that should be stretched when the image is stretched.

set the centerRect[angle] of <image> to <rectangle>

get the [effective] centerRect[angle] of <image>

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

- - -constantMask

Specifies whether animated GIFs ignore changes in the mask data when displaying the GIF.

set the constantMask of <image> 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"

- - -currentFrame

Specifies the current frame of an animated GIF.

set the currentFrame of <image> to <frameNumber>

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

- - -disabled

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

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

- - -dontDither

Specifies whether 24-bit images are dithered on displays with fewer colors.

set the dontDither of <image> to {true | false}

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

- - -filename

Specifies the file associated with a player or image.

set the filename of {<image> | <player>} to {<filePath> | <URL>}

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

- - -frameCount

Reports the number of frames in an animated GIF image.

get the frameCount of <image>

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

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

- - -hotSpot

Specifies the location of the hot spot when an image is being used as a cursor.

set the hotSpot of <image> to <point>

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

- - -imageData

Specifies the binary data that makes up the picture in an image object.

set the imageData of <image> to <binaryData>

- - -imagePixmapID

Specifies the internal window ID of the pixmap used to redraw an image.

get the imagePixmapID of <image>

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

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

- - -location

Specifies where an object is.

set the location of <object> to <point>

- - -magnify

Shows or hides a window showing a magnified view of an image.

set the magnify of <image> to {true | false}

- - -maskData

Specifies which pixels of an image are displayed.

set the maskData of <image> to <binaryData>

- - -maskPixmapID

Specifies the window ID of the X11 pixmap used to mask an image.

set the maskPixmapID of <image> to {empty | <windowID>}

- - -metadata of image

The metadata property of an image is a read only array of metadata from the image file.

put the metadata of <imageObject> into <metadataArray>

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

- - -palindromeFrames

Specifies that a looping animated GIF plays forward and backward.

set the palindromeFrames of <image> to {true | false}

- - -patterns

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

set the patterns of <object> to <patternsList>

- - -pixels

The pixels property is not implemented and is reserved.

pixels

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

- - -repeatCount

Specifies the number of times an animated GIF image repeats.

set the repeatCount of <image> to <numberOfCycles>

- - -resizeQuality

Specifies which method LiveCode should use to scale an image.

set the resizeQuality of <image> to <qualityValue>

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

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

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

- - -size

Reports the amount of disk space taken by an object.

get the size of <object>

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

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

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

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

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

- - -width

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

set the width of <object> to <numberOfPixels>

- - -xHot

Specifies the horizontal position of the hot spot when an image is being used as a cursor.

set the xHot of <image> to <pixels>

- - -yHot

Specifies the vertical position of the hot spot when an image is being used as a cursor.

set the yHot of <image> to <pixels>