A newer version of Max is available. Click here to access the latest version of the documentation

textedit Reference

Enter text

textedit

Description

Provides a user interface within a patcher which can collect typed-in text from the computer-keyboard.

Examples

Collect text to store in a coll object

Arguments

None.

Attributes

autoscroll [int] (default: 1)

Toggles autoscrolling in the text display area. The message autoscroll 1 lets you scroll past the amount of text displayed in the textedit window when the number of lines is set to 1 and the word wrapping is disabled (see the wordwrap message) using either the cursor or by clicking and dragging in the textedit window. The default is 0 (autoscroll disabled).

bangmode [int] (default: 0)

When bangmode is set to "Bang Outputs Typed Text" (0 = default) then the textedit object will output the text currently being typed when banged. When set to "Bang Outputs Entered Text" (1) then the textedit object will output the text previously entered (will wait until text being typed is completed before sending the new value).

Possible values:

0 = 'Bang Outputs Typed Text'
1 = 'Bang Outputs Entered Text'

bgcolor [4 floats]

Sets the background color of the textedit object in RGBA format.

border [float] (default: 2.)

Sets the size, in pixels, of the border of the textedit object. The default is 1.

bordercolor [4 floats]

Sets the border color of the textedit object in RGBA format. The bordercolor attribute is mapped to the elementcolor style color.

clickmode [int] (default: 0)

Sets the way that the textedit object responds to mouse clicks in the text display area. The message clickmode 0 will send an individual character clicked on out the right outlet of the textedit object. Setting the object with the message clickmode 1 will send the word the user clicks on. The default is 0 (select characters).

Possible values:

0 = 'Output Character'
1 = 'Output Word'

keymode [int] (default: 0)

Sets the way that the textedit object responds to carriage returns while typing characters into its text display area. The message keymode 0 allows for text input, and displays carriage returns normally. Setting the object with the message keymode 1 causes the carriage return to output the entire contents of the current buffer. The default is 0.

lines [int] (default: 0)

Sets the number of lines in the textedit object display.

outputmode [int] (default: 0)

Sets whether the textedit object outputs its contents as a message (0) or as a single symbol (1). The message outputmode 0 causes the output of the object to be sent out as messages. Setting the object with the message outputmode 1 will output the buffer contents as a single symbol. The default is 0 (output as messages).

parameter_enable [int]

Enables use of this object with Max for Live Parameters.

parameter_mappable [int] (default: 1)

When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature.

readonly [int] (default: 0)

Toggles the read only mode of the textedit object. The message readonly 1 disables any user entry into the text box. Messages which operate on the current contents of the textedit buffer such as clear, append, or separator are not affected by the readonly message. The default is 0 (readonly mode off).

rounded [float] (default: 8.)

Sets the rounding radius, in pixels, for the corners of the textedit object.

separator [symbol] (default: nothing)

Designates a symbol as a line separator. and treats it as a carriage return when the contents of the buffer are output. If the buffer contains the text "red green blue" and the object receives the message separator green, the next bang received by textedit will output red (carriage return) blue.

style [symbol] (default: )7.0.0

Sets the style to be applied to the object. Styles can be set using the Format palette.

tabmode [int] (default: 1)

Toggles the ability to cause the tab key to output the entire contents of the current buffer. The default is 1 (on).

textcolor [4 floats]

Sets the text color in RGBA format. The textcolor attribute is mapped to the textcolor_inverse style color.

wordwrap [int] (default: 1)

Sets the way that the textedit object displays messages which are longer than the textedit display area. The message wordwrap 0 will disable text wrapping on word boundaries in the display area. wordwrap is enabled (set to 1) by default.

Common Box Attributes

Parameter Attributes

Messages

bang

Outputs the typed or stored contents of the textedit object's buffer.

int

Arguments

input [int]
Sets the contents of the textedit object's buffer while causing no output.

float

Arguments

input [float]
Sets the contents of the textedit object's buffer while causing no output.

list

Arguments

input [list]
Sets the contents of the textedit object's buffer while causing no output as long as the list is comprised of numbers, otherwise, an error message is displayed.

(mouse)

Clicking with the mouse on the textedit object (when the patcher window is locked) will cause the textedit object to send either the letter or word selected out its right outlet depending on the setting of the click mode (see the clickmode message).

(typing)

When the textedit object is highlighted, typing enters text into the text display area and modifies its buffer, unless the object is set to read-only mode (see the readonly message). The ASCII value of the character typed is sent out the middle outlet.

(drag)

When a file is dragged onto the textedit object, the full file name will be added, replacing any text that was previously typed. Holding down the option/command (Mac), or option/alt (Windows), keys when releasing the mouse will append the file name to the existing text rather than replace it. If the file is in Max's search path, only the file name will be added. If the file is not in Max's search path, the entire file path will be added.

append

Arguments

input [list]
The word append, followed by a message, will append the message to the textedit object's buffer without causing any output.

clear

Erases the contents of the textedit object's buffer.

select

Causes all text (if any) to be highlighted and sets the object to be the target of keyboard events if the object is not in read-only mode.

set

Arguments

input [list]
The word set, followed by any message, sets the contents of the textedit object's buffer while causing no output.

Output

symbol

Out left outlet: The currently stored contents of the textedit object's buffer preceded by the word text are output when the object receives a bang message. If the textedit message has been set to enter text on a carriage return using the keymode 1 message, a carriage return will also output the typed text and the buffer contents.

symbol

Out middle outlet: The ASCII value of the typed key.

symbol

Out right outlet: The word or letter in the textedit object's text box that the user has clicked on.

See Also

Name Description
dialog
jit.cellblock
text
Max Comm Tutorial 3: UDP Networking Max Comm Tutorial 3: UDP Networking