textbutton
Max Reference
Open Help

textbutton

Button with text

Examples

Arguments

None.

Attributes

active [int] (default: 1)

When active mode is set to 0, the textbutton object will not respond to mouse clicks, and the object is grayed out. This attribute is enabled by default.

align [atom]

Sets the text alignment.

bgcolor [4 floats]

Sets the background color of the textbutton object when the button is in the "off" state in RGBA format.

bgoncolor [4 floats]

Sets the background color of the textbutton object when the button is in the "on" state in RGBA format. The bgoncolor attribute is mapped to the elementcolor style color.

blinktime [int] (default: 150)

Specifies the duration (in milliseconds) that the textbutton object will flash when it is clicked upon or receives a bang message.

fontlink [int] (default: 0)

Toggles setting the size of the button to the currently selected font size and character width.

legacytextcolor [int] (default: 0)7.0.0

Legacy Text Color Mode

mode [int] (default: 0)

Sets the button mode.

Possible values:

0 = 'Button'
1 = 'Toggle'

outputmode [int] (default: 1)

Sets the output mode. Output modes are:

0: Send output on mouse down
1: Send output on mouse up (default)

Possible values:

0 = 'Mouse down'
1 = 'Mouse up'

parameter_enable [int]

Enables use of this object with Max for Live Parameters and allows for setting initial parameter values in the Max environment.

rounded [float] (default: 0.)

Sets the amount in pixels by which to round the textbutton shape.

spacing_x [float] (default: 4.)

Sets the horizontal spacing for the textbutton object in pixels.

spacing_y [float] (default: 4.)

Sets the vertical spacing for the textbutton object in pixels.

style [symbol]7.0.0

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

text [atom] (default: Button)

Sets the button label, and sets the the "off" state label when mode is set to 1 (toggle).

textcolor [4 floats]

Sets the text color for the textbutton object when the button is in the "off" state in RGBA format. The textcolor attribute is mapped to the accentcolor style color.

texton [atom] (default: Button On)

Button label in "on" state

textoncolor [4 floats]

Sets the text color for the textbutton object when the button is in the "on" state in RGBA format. The textoncolor attribute is mapped to the color style color.

textovercolor [4 floats]

Sets the text color for the textbutton object on mouseover when the button is in the "off" state in RGBA format. The textovercolor attribute is mapped to the selectioncolor style color.

tosymbol [int] (default: 1)

Output text as a single symbol

truncate [int] (default: 1)

Sets the text truncation mode. Alignment modes are:

0: no truncation
1: truncate from the right (e.g. abcdef... . This is the default.
2: truncate from center (e.g. abcd...wxyz

Possible values:

0 = 'No truncation'
1 = 'Truncate from the right'
2 = 'Truncate from the middle'

underline [int] (default: 0)

The word underline , followed by a zero or one, toggles the underlining of text in the textbutton object. The default is 0 (no underlining).

usebgoncolor [int] (default: 0)7.0.0

Toggles the use of a background "on" color.

usetextovercolor [int] (default: 0)7.0.0

Toggles the use of a different color when hovering over the text.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Parameter Attributes

Order

Typeint

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable

Typeint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Typeint

When checked, the Scripting Name is linked to the Long Name attribute.

Long Name

Typesymbol

The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name

Typesymbol

Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.

Type

Typeint

Specifies the data type. The data types used in Max for Live are:

Float
Int
Enum (enumerated list)
Blob

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to a range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values are likely to be outside of the 0-255 range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enum

Typelist

When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Modulation Mode

Typeint

Sets the Modulation Mode used by the Live application. The modulation modes are:

None
Unipolar
Bipolar
Additive
Absolute

Modulation Range

Typelist

This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enable

Typeint

When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).

Initial

Typelist

Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Unit Style

Typeint

Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values

Custom Units

Typesymbol

Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponent

Typefloat

When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Steps

Typeint

The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility

Typeint

For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)

Typeint

Speed limits values triggered by automation.

Defer Automation Output

Typeint

Defers values triggered by automation.

Messages

bang

The behavior depends on the current mode settings.

mode 0 (button): A bang message will re-trigger the object's output.

mode 1 (trigger): A bang message will switch the object's state and trigger the output.

int

Arguments

input [int]
If the mode attribute is set to 0 (button), a bang is sent out the left outlet, and the text message is displayed and set out the middle outlet.

If the mode attribute is set to 1 (toggle), and the number input is 1, textbutton is set to 'on', a 1 is sent out the left outlet and the texton message is displayed and set out the middle outlet.
If the number input is 0, textbutton is set to 'off', a 0 is sent out the left outlet and the text message is displayed and set out the middle outlet.

float

Arguments

input [float]
At float message is converted to int . See the int listing for usage.

(mouse)

If the mode attribute is set to 0 (button), a mouse click on textbutton highlights it for as long as the mouse is held down, sending a bang out the left outlet when the mouse button is pressed down, and another bang out the left outlet when the mouse button is released. The button text is also sent out the middle outlet on mouse click.

If the mode attribute is set to 1 (toggle), and the initial state of the toggle is 0, textbutton is set to 'on', a 1 is sent out the left outlet and the texton message is displayed and set out the middle outlet.
If initial state of the toggle is 1, textbutton is set to 'off', a 0 is sent out the left outlet and the text message is displayed and set out the middle outlet.

set

Arguments

set-input [int]
If the mode attribute is set to 1 (toggle), the set message toggles the on or off state without sending anything out the outlets. The word set , followed by any non-zero number, sets toggle to on; set 0 sets it to off.

setsymbol

Arguments

button-text-item [list]
If the mode attribute is set to 1 (toggle), the word setsymbol , followed by either the texton or text symbol, causes the textbutton to display that symbol, but does not cause any output. The symbol is case-sensitive.

symbol

Arguments

button-text-item [list]
If the mode attribute is set to 1 (toggle), the word symbol , followed by either the texton or text symbol, causes textbutton to display that symbol, switch to the toggle state, and trigger the corresponding output.

See Also

Name Description
matrixctrl Matrix switch control
message Send any message
pictctrl Picture-based control
pictslider Picture-based slider control
tab Tab control
ubutton Transparent button