WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

Button
✖
Button

✖
Button[label,action]

represents a button that is labeled with label, and evaluates action whenever it is clicked.

Details and Options

  • label can be any expression, including a dynamic one. »
  • Button by default displays label in "Button" style, which typically uses the system button font.
  • Button[label,action] maintains action in unevaluated form, evaluating it each time the button is clicked.
  • The following options can be given:
  • Alignment Automatichow to align contents within the button
    Appearance Automaticthe overall appearance of the button
    AutoAction Falsewhether to click the button automatically when the mouse is over it
    Background Automaticbutton background color
    BaselinePosition Automaticalignment relative to surrounding text
    BaseStyle "GenericButton"base style specifications for the button
    ContentPadding Truewhether to shrink the margins tightly around the contents
    Enabled Automaticwhether the button is enabled or grayed out
    Evaluator Automaticthe kernel in which to evaluate expr
    FrameMargins Automaticminimum margins to leave inside the frame
    ImageMargins 0margins around the image of the displayed button
    ImageSize Fullthe overall image size of the displayed button
    Method "Preemptive"the evaluation method to use
    TooltipNonethe tooltip for the button
    TooltipDelay0.`how long to delay before displaying the tooltip
    TooltipStyle{}style specifications for the tooltip
  • With the default setting ImageSize->Full, a button will be sized to fill out its enclosing region in a Grid or related construct.
  • The setting ImageSize->Automatic specifies that the button will be sized to fit its contents, but will not expand to fill out an enclosing region.
  • Settings of Tiny, Small, Medium, and Large for ImageSize specify buttons with certain system-standard minimum sizes.
  • Typical possible settings for the Appearance option include "DialogBox", "Frameless", "Palette", and "FramedPalette". In some cases, "AbuttingLeftRight", "AbuttingRight", etc. are also supported.
  • Appearance->"Pressed" gives a button with a pressed appearance. Appearance->{type,"Pressed"} gives a button of a certain type with a pressed appearance.
  • With Appearance->None, label is displayed literally, without being placed in a button. »
  • Typical possible settings for the Method option include "Preemptive" and "Queued".
  • With the default setting Method->"Preemptive", button actions are performed immediately, preempting any other evaluation, but are allocated only a limited time to complete.
  • With the setting Method->"Queued", button actions are added to the current queue of evaluations, and are performed when other evaluations are complete. No time limit is applied.
  • The settings for BaseStyle are appended to the default style typically given by the "Button" style in the current stylesheet.
  • Button[label] displays as a button labeled with label, but performs no action.
  • Button[prims,action] can be used within graphics objects to specify that action should be evaluated whenever the graphics primitives prims are clicked. »
  • Button[label,None,BaseStyle->stylename] inherits button functionality from the definition of stylename in the stylesheet. Such styles typically allow \[SelectionPlaceholder] to be used in label to represent the currently selected text.
  • Some style names defined in default stylesheets that provide Button functionality:
  • "Paste"effectively use NotebookApply upon the current selection using the button label as the applied data
    "Evaluate"use NotebookApply and SelectionEvaluate in sequence upon the current selection
    "EvaluateCell"use NotebookApply upon the current selection, then evaluate the entire cell containing the selection
    "CopyEvaluate"equivalent to "Evaluate", but paste the result into a new cell instead of changing the currently selected cell
    "CopyEvaluateCell"equivalent to "EvaluateCell", but apply changes to a newly created copy of the input cell instead of changing the currently selected cell

Examples

open allclose all

Basic Examples  (1)Summary of the most common use cases

Create a button that prints a number:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-vg7
Out[1]=1

Scope  (7)Survey of the scope of standard use cases

Button Content  (3)

Use any expression as a label:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-5i5scf
Out[1]=1

Use a dynamic label:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-0ihb1k
Out[1]=1

Use a graphics primitive as a button:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-cesux0
Out[1]=1

Button Control  (2)

Create a list of buttons; use With to ensure evaluation of i:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-qke
Out[1]=1

Another way to get the contents of a button evaluated:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-k1b
Out[2]=2

Display the label literally, without the appearance of a button:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-bb1
Out[1]=1

Button Styles  (2)

Display a button that sorts the selected expression:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-b7aoos
Out[1]=1

Select the list below, and click the button to sort it:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-jt9jre

Display a button that wraps Factor around an expression, then evaluates the entire cell:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-0fxhu
Out[1]=1

Select the first three terms below, then click the button to factor them:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-c0towf

Generalizations & Extensions  (2)Generalized and extended use cases

Get the mouse position in screen coordinates:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-fui
Out[1]=1

Get the mouse position in graphics coordinates:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-b0j69w
Out[1]=1

Options  (23)Common values & functionality for each option

Alignment  (1)

Different predefined alignment options:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-kirosx
Out[1]=1

Appearance  (4)

Predefined button appearances:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-qpwcai
Out[1]=1

On some platforms, the following appearances are also defined:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-q8g21a
Out[1]=1

Use a second element to get the appearance of a pressed button:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-lwohwf
Out[1]=1

Use a special appearance for the button:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-mpnjvf
Out[1]=1

AutoAction  (1)

By default, the button function does not evaluate until you click it:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-8qsvvx
Out[1]=1

By setting AutoAction, the button function evaluates as you mouse over the button area:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-rvdtm
Out[2]=2

Background  (2)

Change the background colors:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-cu2oys
Out[1]=1

Change the background color on every click:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-d4m2
Out[1]=1

BaselinePosition  (2)

Align with the surrounding text:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-fw1qa7
Out[1]=1

Change the baseline position on every button click:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-gnqjy9
Out[1]=1

BaseStyle  (2)

Add styles to a button:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-cahheh
Out[1]=1

Select the behavior of a button:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-gmnf4x
Out[1]=1

Select the expression below and click the above button to expand inline:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-f00kq0

ContentPadding  (1)

Remove extra whitespace around a label with no ascenders or descenders:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-f8ndfn
Out[1]=1

Enabled  (1)

By default, Button is enabled:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-buon3j
Out[1]=1

By setting Enabled->False, the button is disabled but visible in its current state:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-d1mv62
Out[2]=2

Evaluator  (1)

By default, the button function is sent to the kernel for evaluation:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-3tu278
Out[1]=1

By setting Evaluator, the button function is evaluated in the front end:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-4p3lcv
Out[2]=2

Not all functionalities are available in the front end:

In[3]:=3
✖
https://wolfram.com/xid/0mrh4y-zlllkt
Out[3]=3

FrameMargins  (1)

By setting FrameMargins, you make the button content area larger:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-80fq53
Out[1]=1

ImageMargins  (1)

By setting ImageMargins, you make the button area larger:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-gzg6fm
Out[1]=1

ImageSize  (4)

Use preset values:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-d5tfpi
Out[1]=1

Or use any values:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-e2do6g
Out[1]=1

By setting the second element, you can also control the height:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-kxe9rk
Out[1]=1

A fully customized image size:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-lvdo0h
Out[1]=1

Method  (2)

By default, button functions are evaluated on a preemptive link and time out after 5 seconds:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-6sf9if
Out[1]=1

Use Method->"Queued" to evaluate button functions on the main link, which never times out:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-k6ay1g
Out[2]=2

Specify that the stop button event needs to preemptively interrupt an evaluation:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-gjs3xj
Out[1]=1

Applications  (5)Sample problems that can be solved with this function

Make a button that prints the current date:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-l4v
Out[1]=1
In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-smb
Out[1]=1

Create a button that deletes itself:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-6oi99g
Out[1]=1

Create your own hyperlink:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-ueku3j
Out[1]=1

Change color on mouseover:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-buzuo0
Out[2]=2

Create a button that sorts a selected list of items in place:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-etdnpx
Out[1]=1

Select the list below and click the above button to sort the list:

In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-0olep

Properties & Relations  (2)Properties of the function, and connections to other functions

Create a grid of tightly spaced buttons:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-6zhtus
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0mrh4y-sbc5bq
Out[2]=2

Create a button that makes the button the current selection:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-til0bp
Out[1]=1

Possible Issues  (4)Common pitfalls and unexpected behavior

Some functions require the kernel in order to be evaluated:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-e4nrkd
Out[1]=1

Specifying the Background option forces a generic appearance for the button:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-v9niqt
Out[1]=1

Use ImageSize to control buttons in a Grid:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-d6c1ry
Out[1]=1

Use Method->"Queued" to avoid evaluation timeout on the preemptive link:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-bnge98
Out[1]=1

Neat Examples  (3)Surprising or curious use cases

This button changes the color of the disk each time you click it:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-n0i
Out[1]=1

This button changes position each time you click it:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-fycjzo
Out[1]=1

Use a graphics primitive as the button:

In[1]:=1
✖
https://wolfram.com/xid/0mrh4y-4ry51s
Out[1]=1
Wolfram Research (2007), Button, Wolfram Language function, https://reference.wolfram.com/language/ref/Button.html (updated 2010).
✖
Wolfram Research (2007), Button, Wolfram Language function, https://reference.wolfram.com/language/ref/Button.html (updated 2010).

Text

Wolfram Research (2007), Button, Wolfram Language function, https://reference.wolfram.com/language/ref/Button.html (updated 2010).

✖
Wolfram Research (2007), Button, Wolfram Language function, https://reference.wolfram.com/language/ref/Button.html (updated 2010).

CMS

Wolfram Language. 2007. "Button." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2010. https://reference.wolfram.com/language/ref/Button.html.

✖
Wolfram Language. 2007. "Button." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2010. https://reference.wolfram.com/language/ref/Button.html.

APA

Wolfram Language. (2007). Button. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/Button.html

✖
Wolfram Language. (2007). Button. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/Button.html

BibTeX

@misc{reference.wolfram_2025_button, author="Wolfram Research", title="{Button}", year="2010", howpublished="\url{https://reference.wolfram.com/language/ref/Button.html}", note=[Accessed: 02-April-2025 ]}

✖
@misc{reference.wolfram_2025_button, author="Wolfram Research", title="{Button}", year="2010", howpublished="\url{https://reference.wolfram.com/language/ref/Button.html}", note=[Accessed: 02-April-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_button, organization={Wolfram Research}, title={Button}, year={2010}, url={https://reference.wolfram.com/language/ref/Button.html}, note=[Accessed: 02-April-2025 ]}

✖
@online{reference.wolfram_2025_button, organization={Wolfram Research}, title={Button}, year={2010}, url={https://reference.wolfram.com/language/ref/Button.html}, note=[Accessed: 02-April-2025 ]}