Skip to main content

field

Type

object

Summary

A control that contains text.

Syntax

field

Description

Use the field object type to hold text or to provide a place for the user to enter text.

Fields can contain styled text (with different fonts, sizes, styles, and colors for different parts of the text they contain). A field can be displayed with or without horizontal and vertical scrollbars, and can be unlocked (allowing the user to enter text) or locked.

A field is contained in a card, group, or background. Fields cannot contain other objects.

Examples

set the backgroundColor of field "Warnings" to "red"
put it into line 3 of field "Help"

glossary: object type

keyword: templateField, control

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile

Associated Syntax

Message

NameSummarySyntax
socketErrorSent when an error occurs on a socket that causes the socket to close or to fail to open.socketError <pSocketID>, <pErrorString>
tabKeySent when the user presses the Tab key.tabKey
mouseWithinSent periodically to an object while the mouse pointer is within its borders.mouseWithin
rawKeyDownSent when the user presses any key.rawKeyDown <pKeyCode>
dragEndSent to the object a drag and drop started from, when the data is dropped.dragEnd
commandKeyDownSent when a Command key combination (Control-key on Unix or Windows) is pressed.commandKeyDown <pKeyName>
controlKeyDownSent when a Control key combination is pressed.controlKeyDown <pKeyName>
exitFieldSent to the field with the selection when the selection is being removed from the field, and its contents have not changed.exitField
functionKeySent when the user presses a function key.functionKey <pKeyNumber>
optionKeyDownSent when the user presses an Option key, Meta key, or Alt key combination.optionKeyDown <pKeyName>
focusOutSent to a button or field when it becomes inactive (loses focus).focusOut
nameChangedSent to an object when its name is changed.nameChanged <pOldName>, <pNewName>
dragDropSent to the object where data was dropped when a drag and drop finishes.dragDrop
deleteFieldSent to a field just before it is removed from the stack.deleteField
scrollbarDragSent 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>
dragLeaveSent when the mouse pointer moves out of an object during a drag and drop.dragLeave
socketTimeoutSent when an open socket, read from socket or write to socket command halts for the time specified by the socketTimeoutInterval property. socketTimeout <pSocketID>
textChangedSent when the content of a field has changed.textChanged
selectedObjectChangedSent to an object when it is selected.selectedObjectChanged
dragEnterSent when the mouse pointer moves into an object during a drag and drop.dragEnter
enterKeySent when the user presses the Enter key, if there is no text selection. enterKey
backspaceKeySent to the active control, or to the current card if no control is focused.backspaceKey
escapeKeySent when the user presses the Escape key.escapeKey
copyKeySent when the user presses the key combination equivalent to the Copy menu item.copyKey
mouseReleaseSent when the user releases the mouse outside the control that was clicked. mouseRelease <pButtonNumber>
arrowKeySent to the active control, or to the current card if no control is focused, when the user presses an arrow key.arrowKey <pKey>
pasteKeySent when the user presses the key combination equivalent to the "Paste" menu item.pasteKey
mouseDownSent when the user presses the mouse button.mouseDown <pButtonNumber>
closeFieldSent to a field when the focus is being removed from that field and the field's content has changed.closeField
returnInFieldSent to a field when the selection is in the field and the user presses the Return key.returnInField
focusInSent to a control when it becomes active focused.focusIn
selectionChangedSent to a field or player when the selection is changed.selectionChanged
mouseEnterSent when the mouse pointer moves into an object.mouseEnter
deleteKeySent to the active (focused) control(glossary), or to the current card if there is no active control.deleteKey
rawKeyUpSent when the user releases any key that was pressed (other than a modifier key).rawKeyUp <pKeyCode>
mouseUpSent when the user releases the mouse button.mouseUp <pButtonNumber>
dragMoveSent when the user moves the mouse during a drag and drop.dragMove
cutKeySent when the user presses the key combination equivalent to the Cut menu item.cutKey
mouseStillDownSent periodically while the mouse button is being held down.mouseStillDown <pButtonNumber>
linkClickedSent when the user clicks grouped text.linkClicked <pLinkedTextOfChunk>
dragStartSent to a control when the user clicked on it and then started to drag the mouse pointer.dragStart
openFieldSent to an unlocked field when you click or select text in that field.openField
mouseMoveSent when the user moves the mouse.mouseMove <pNewMouseH>, <pNewMouseV>
resizeControlSent to a control right after the user resizes it.resizeControl
newFieldSent to a new field right after it's created.newField
enterInFieldSent to the field with the current selection when the user presses the Enter key.enterInField
keyDownSent when the user presses a key.keyDown <pKeyName>
mouseLeaveSent when the mouse pointer moves out of an object.mouseLeave
socketClosedSent when the remote system closes a socket.socketClosed <pSocketID>
mouseDoubleUpSent when the mouse button is released at the end of a double-click.mouseDoubleUp <pButtonNumber>
keyUpSent when the user releases a pressed key.keyUp <pKeyName>
mouseDoubleDownSent when the user double-clicks.mouseDoubleDown <pButtonNumber>

Command

NameSummarySyntax
put unicodeInserts a unicode string into a field where specified.put unicode <value> {before | into | after} <fieldChunk>

Property

NameSummarySyntax
metadataThe **metadata** property of a field chunk specifies additional information stored with the field chunk but not visible to the user.set the metadata of <fieldChunk> to <string>
lockTextSpecifies whether the contents of a field can be selected and changed by the user.set the lockText of <field> to {true | false}
lineIndexThe line offset in the field of the start of the chunk.get the lineIndex of <fieldChunk>
topRightSpecifies the location of the specified object's upper right corner. set the topRight of <object> to <right>, <top>
formattedWidthReports 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>
multipleHilitesSpecifies whether more than one line can be selected in a list field. set the multipleHilites of <field> to {true | false}
listDepthSpecifies the depth of a line in a list.set the listDepth of <line> of <field> to 1
spaceBelowDetermines the space below a paragraph in a field.set the spaceBelow of <line> of <field> to <pixels>
scriptSpecifies the contents of an object's **script**.set the script of <object> to <string>
borderColorSpecifies 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>}
hilitePixelSpecifies 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>
unicodePlainTextReturns the contents of a field chunk as plain text.set the unicodePlainText of [chunk of] field to string get the unicodePlainText of [chunk of] field
patternsSpecifies all the patterns of an object, in shorthand form.set the patterns of <object> to <patternsList>
topMarginSpecifies 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>
numberSpecifies 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>
topLeftSpecifies the location of the specified object's upper left corner. set the topLeft of <object> to left,top
altIDSpecifies an alternate ID for objects.set the altID of <object> to <IDNumber>
rightSpecifies how far an object's right edge is from the left edge of the window or screen.set the right of <object> to <pixels>
focusPatternSpecifies 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}
topPatternSpecifies the pattern used to draw a three-D object's raised edge. set the topPattern of <object> to {<patternNumber> | <imageID> | empty}
foregroundColorSpecifies 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>}
scrollbarWidthSpecifies the width of the scrollbar associated with a scrolling field or group.set the scrollbarWidth of {<field> | <group>} to <pixels>
threeDHiliteSpecifies whether selected lines in a list field look like they're receding into the screen.set the threeDHilite of <field> to {true | false}
textSpecifies the text contained by a button or field or the binary data in an image.set the text of {<button> | <field> | <image>} to <string>
fixedLineHeightSpecifies whether the lines in a field are all the same height, or vary in height to fit the text on that line.set the fixedLineHeight of <field> to {true | false}
dontWrapSpecifies whether the text in a paragraph or field word-wraps when it reaches the field's right edge.set the dontWrap [of <line>] of <field> to {true | false}
borderPixelSpecifies which entry in the color table is used for the color of an object's border.set the borderPixel of <object> to <colorNumber>
shadowPixelSpecifies 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>
showLinesSpecifies whether dotted lines are shown on the text baselines of a field. set the showLines of <field> to {true | false}
listBehaviorSpecifies whether a locked field behaves as a clickable list.set the listBehavior of <field> to {true | false}
mimeTextThe **mimeText** property is not implemented and is reserved.mimeText
behaviorAllows an object to inherit its script handlers from another object.set the behavior of <object> to {<button> | <stack>}
metadata of fieldThe metadata property of a field chunk specifies additional information stored with the field chunk but not visible to the user.set the metadata of <fieldChunk> to <string>
customPropertiesSpecifies 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>
shadowColorSpecifies the color of an object's drop shadow or the background of a scrollbar.set the shadowColor of <object> to {empty | <colorName> | <RGBColor>}
borderWidthSpecifies the width of an object's border.set the borderWidth of <object> to <pixelWidth> set the borderWidth of <line> of <field> to <pixelWidth>
listIndexSets the index for a paragraph when an (ordered) listStyle is set .set the listIndex of <line> of <field> to <index>
textShiftSpecifies how far text is shifted up or down from its baseline.set the textShift of <chunk> of <field> to <pixels>
textSizeSpecifies 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>
textHeightSpecifies the amount of space between lines of text in a field.set the textHeight of <field> to <pixels>
encodingReturns the encoding of the specified piece of text.the encoding of { button | graphic | group } the encoding of [<chunk> of] <field>
formattedRectReports 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>
shadowOffsetSpecifies the size and direction of an object's drop shadow.set the shadowOffset of <object> to <pixels>
textFontSpecifies 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>]
enabledSpecifies that an object is active and responds to user action. set the enabled of <object> to {true | false}
backgroundColorSpecifies 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>}
hiliteColorSpecifies the color of the background when an object, or text in an object, is highlighted.set the hiliteColor [of <object>] to {empty | <colorName> | <RGBColor>}
noncontiguousHilitesSpecifies whether the user can select non-adjacent lines of a list field. set the noncontiguousHilites of <field> to {true | false}
dontSearchSpecifies whether the find command skips a field, group, or card. set the dontSearch of <field> to {true | false}
vScrollSpecifies the vertical scroll of a field, group, or stack.set the vScroll of {<field> | <group>} to <pixels> get the scroll of <stack>
paddingDetermines the padding of the cells of a table in a field.set the padding of line <lineNumber> of <fieldReference> to <pixels>
allowKeyInFieldHas no effect and is included in LiveCode for compatibility with imported SuperCard projects.set the allowKeyInField to {true | false}
dropShadowSpecifies the drop shadow to use for an object.set the dropShadow of object to <propertiesArray> set the dropShadow[<propertyName>] of object to <propertyValue>
charIndexThe character offset in the field of the start of the chunk.get the charIndex of <fieldChunk>
styledTextSpecifies the contents of a field, with its text formatting represented as LiveCode styled text array.set the styledText of <field> to <styledArray>
textAlignSpecifies how text is aligned or justified in a field or button.set the textAlign [of <line>] of {<button> | <field>} to {left | center | right}
leftMarginSpecifies 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>
bottomPatternSpecifies the pattern of a three-D object's lowered edge.set the bottomPattern of <object> to {empty | <patternNumber> | <imageID>}
customPropertySetsLists all the custom property sets that can apply to an object. get the customPropertySets of <object>
hilitePatternSpecifies 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}
autoTabSpecifies whether pressing Return (or Enter) moves to the next field.set the autoTab of <field> to {true | false}
sharedTextSpecifies whether a grouped field's text is the same on all cards with that group.set the sharedText of <field> to {true | false}
visibleSpecifies whether an object can be seen or is hidden.set the [effective] visible of <object> to {true | false}
shadowPatternSpecifies the pattern of an object's drop shadow.set the shadowPattern of <object> to {<patternNumber> | <imageID> | empty}
hGridSpecifies whether lines are shown below each text line in a field.set the hGrid [of line <lineNumber>] of <field> to {true | false}
imageSourceSpecifies an image to be displayed in place of the specified character in a field.set the imageSource of <character> to {<imageID> | <imageName> | <imageURL> |empty}
layerSpecifies 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}
backgroundPatternThe **backgroundPattern** specifies the pattern used to draw an object's background.set the backgroundPattern of <object> to {<patternNumber> | <imageID> | empty}
vScrollbarSpecifies whether a field or group has a vertical scrollbar.set the vScrollbar of {<field> | <group>} to {true | false}
topColorSpecifies the color of a three-D object's raised edge.set the topColor of <object> to {empty | <colorName> | <RGBColor>}
toggleHilitesSpecifies whether clicking a selected line in a list field deselects that line.set the toggleHilites of <field> to {true | false}
pageRangesSplits the content of a field into pages based on the height of a field.get the pageRanges of <field>
bottomSpecifies how far an object's bottom edge is from the top of the window or screen.set the bottom of <object> to <number>
borderPatternSpecifies the pattern of an object's border.set the borderPattern of <object> to {empty | <patternNumber> | <imageID>}
colorOverlaySpecifies the color overlay to use for an object.set the colorOverlay of object to <propertiesArray> set the colorOverlay[<propertyName>] of object to <propertyValue>
heightSpecifies the distance from an object's top edge to its bottom edge. set the height of <object> to <numberOfPixels>
outerGlowSpecifies the outer glow to use for an object.set the outerglow of object to <propertiesArray> set the outerglow[<propertyName>] of object to <propertyValue>
listIndentSpecifies the size of the margins used when indenting lists.set the listIndent of <line> of <field> to 1
bottomPixelSpecifies 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>
traversalOnSpecifies whether a control can become the active (focused) control. set the traversalOn of <object> to {true | false}
rightIndentDetermines the indentation of a paragraph in a field.set the rightIndent of <line> of <field> to <pixels>
linkTextAttaches data to a section of text in a field.set the linkText of <chunk> of <field> to <textString>
plainTextReturns the contents of a field chunk as plain text.set the plainText of [<chunk> of] <field> to <string> get the plainText of [<chunk> of] <field>
cursorMovementSets the mechanism for moving the cursor in fields containing both left-to-right and right-to-left text.set the cursorMovement of field to <mechanism>
topSpecifies how far an object's top edge is from the top of the window or screen.set the top of <object> to <numberOfPixels>
rectangleSpecifies the area within which an object is drawn.set the rectangle of <object> to <left>, <top>, <right>, <bottom> get the [effective] rectangle of <object>
tabAlignSpecifies the alignment of tab stops in a field.set the tabAlign [of line lineNumber] of field to tabAlignList
invisibleSpecifies whether an object is hidden.set the invisible of <object> to {true | false} get the [effective] invisible of <object>
layerModeSpecifies whether an object is dynamic or static.set the layerMode of <object> to <mode> get the [effective] layerMode of <object>
topPixelSpecifies 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>
RTFTextSpecifies the contents of a field, with its text formatting represented in RTF format.set the RTFText of [<chunk> of] <field> to <RTFString>
keyboardTypeConfigures the type of keyboard that is to be displayed.set the keyboardType of <field> to <type> get the keyboardType of <field>
bottomRightSpecifies the location of the specified object's lower right corner. set the bottomRight of <object> to right,bottom
vGridSpecifies whether a field's tab stops are treated as cell boundaries.set the vGrid [of line <lineNumber>] of <field> to {true | false}
formattedLeftReports 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>
foregroundPixelSpecifies which entry in the color table is used for an object's text and borders.set the foregroundPixel of <object> to <colorNumber>
unicodeTooltipSpecifies 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>
leftIndentDetermines the indentation of a paragraph in a field.set the leftIndent of <line> of <field> to <pixels>
bottomLeftSpecifies the location of the specified object's lower left corner. set the bottomLeft of <object> to <left>, <bottom>
innerShadowSpecifies the inner shadow to use for an object.set the innerShadow of object to <propertiesArray> set the innerShadow[<propertyName>] of object to <propertyValue>
locationSpecifies where an object is.set the location of <object> to <point>
leftSpecifies how far an object's left edge is from the left edge of the window or screen.set the left of <object> to <numberOfPixels>
showFocusBorderDisplays a border around the active control.set the showFocusBorder of <control> to {true | false}
formattedTextUnwraps hard-wrapped lines, or provides the hard-wrapped contents of a field. set the formattedText of [<chunk> of] <field> to <string> get the formattedText of [<chunk> of] <field>
textDirectionSpecifies whether the field should lay out its contents in a left-to-right or right-to-left manner.set the textDirection of field to <direction>
unicodeTextSpecifies 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>
listStyleSpecifies what type of list style is used for the line of text.set the listStyle of <line> of <field> to <style>
disabledSpecifies that an object is dimmed and does not respond to user action.set the disabled of <object> to {true | false}
hilitedLineSpecifies the numbers of the selected lines in a list field.set the hilitedLine of <field> to <listOfLines>
rightMarginSpecifies 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>
selectedSpecifies whether an object is **selected**.set the selected of <object> to {true | false}
tabStopsSpecifies the location of tab stops in a field.set the tabStops [of line <lineNumber>] of <field> to <tabStopList>
propertiesSpecifies some of an object's **properties** and their current values. set the properties of <object> to <propertiesArray>
colorsSpecifies all the colors of an object, in shorthand form.set the colors of <object> to <colorsList>
hScrollSpecifies the horizontal scroll of a field or group.set the hScroll of {<field> | <group>} to <pixels>
IDReports the unique ID number assigned to an object.set the ID of {image | stack} to <number> get the [{ long | abbreviated | short }] ID of <object>
tabWidthsSpecifies the width of columns in a field.set the tabWidths [of line <lineNumber>] of <field> to <tabWidthList>
customPropertySetSpecifies a set of custom properties applied to an object.set the customPropertySet of object to {setName | empty}
flaggedUnderlines the chunk with a red dotted line.set the flagged of <fieldChunk> to {true | false}
backgroundPixelSpecifies which entry in the color table is used for an object's background color.set the backgroundPixel of <object> to <colorNumber>
pageHeightsReports the height of each printed page if a field is printed.get the pageHeights of <field>
hScrollbarSpecifies whether a field or group has a horizontal scrollbar.set the hScrollbar of {<field> | <group>} to {true | false}
HTMLTextSpecifies the contents of a field, including all text styles and paragraph formatting, represented as HTML tags and special characters represented as HTML entities.set the HTMLText of [<chunk> of] <field> to <htmlString> get the [effective] HTMLText of [<chunk> of] <field>
firstIndentDetermines the indentation of the first line of a paragraph in a field. set the firstIndent [of <line>] of <field> to <pixels>
formattedTopReports 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>
focusPixelSpecifies 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>
bottomColorSpecifies the color of a three-D object's lowered edge.set the bottomColor of <object> to {empty | <colorName> | <RGBColor>}
bottomMarginSpecifies 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>
textStyleSpecifies 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}
threeDSpecifies whether an object appears to stick out of or recede into the screen.set the threeD of <object> to {true | false}
widthThe **width** of an object is the distance from its left edge to its right edge.set the width of <object> to <numberOfPixels>
showBorderSpecifies whether an outline is drawn around an object.set the showBorder of <object> to {true | false}
innerGlowSpecifies the inner glow to use for an objectset the innerGlow of object to <propertiesArray> set the innerGlow[<propertyName>] of object to <propertyValue>
nameSpecifies the name of an object.set the [{ long | abbreviated | short }] name of <object> to <string> get the name
ownerReports which object is next in the object hierarchy.get the [{ long | abbreviated | short }] owner of <object>
returnKeyTypeConfigures the type of return key that is to be displayed on the keyboard.set the returnKeyType of <field> to <type> get the returnKeyType of <field>
wideMarginsSpecifies the amount of blank space at the edges of a field.set the wideMargins of <field> to {true | false}
formattedHeightReports 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>
focusColorSpecifies 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>}
customKeysLists the names of all the custom properties of an object. set the customKeys of <object> to {<propertiesList> | empty}
foregroundPatternSpecifies 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}
hiddenSpecifies whether a line of text (paragraph) of a field is hidden from the user.set the hidden of <line> of <field> to {true | false}
unicodeFormattedTextUnwraps hard-wrapped lines, or provides the hard-wrapped contents of a field. set the unicodeFormattedText of [chunk of] field to string get the unicodeFormattedText of [chunk of] field
spaceAboveDetermines the space above a paragraph in a field.set the spaceAbove of <line> of <field> to <pixels>
Thank you for your feedback!

Was this page helpful?