Main Content

StateButton Properties

Control state button appearance and behavior

expand all in page

State buttons are components that indicate a logical state. Properties control the appearance and behavior of a state button. Use dot notation to refer to a specific object and property.

fig = uifigure; sb = uibutton(fig,'state'); sb.Value = true;

Button

expand all

Pressed state of button, specified as0(false) or1(true). When the value is 1, the state button appears pressed. When the value is 0, the state button appears unpressed.

Button label, specified as a character vector, cell array of character vectors, string scalar, string array, or 1-D categorical array. Specify a character vector or string scalar to label the button with a single line of text. Use a cell array or string array to label the button with multiple lines of text. Each element in the array represents a separate line of text. If you specify this property as a categorical array, MATLAB®uses the values in the array, not the full set of categories.

Word wrapping to fit component width, specified as'off'or'on', or as numeric or logical0(false) or1(true). A value of'off'相当于false, and'on'相当于true. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of typematlab.lang.OnOffSwitchState.

使用这个属性to prevent text from getting clipped horizontally when the width of the component is smaller than the text you want to display.

  • 'off'— Text does not wrap.

  • 'on'— Breaks text into new lines so that each line fits within the width of the component and avoids breaking words when possible.

Setting theWordWrapproperty to'on'does not prevent text from getting clipped vertically when the height of the component is too small to display all the lines of text.

Icon source or file, specified as a character vector, a string scalar, or anm-by-n-by-3 truecolor image array. If you specify a file name, it can be an image file name on the MATLAB path or a full path to an image file. If you plan to share an app with others, put the image file on the MATLAB path to facilitate app packaging.

Supported image formats include JPEG, PNG, GIF, SVG, orm-by-n-by-3 truecolor image array. For more information about truecolor image arrays, see图像放大e Types.

  • If the button text takes up all the space specified by thePositionproperty value, then MATLAB does not display the icon.

  • If some room is available for the icon, then MATLAB scales down the image to fit, if necessary.

Example:'icon.png'specifies an icon file on the MATLAB path.

Example:'C:\Documents\icon.png'specifies a full path to an image file.

Font and Color

expand all

Font name, specified as a system supported font name. The default font depends on the specific operating system and locale.

If the specified font is not available, then MATLAB uses the best match among the fonts available on the system where the app is running.

Example:'Arial'

Font size, specified as a positive number. The units of measurement are pixels. The default font size depends on the specific operating system and locale.

Example:14

Font weight, specified as one of these values:

  • 'normal'— Default weight as defined by the particular font

  • 'bold'— Thicker character outlines than'normal'

Not all fonts have a bold font weight. Therefore, specifying a bold font weight can result in the normal font weight.

Font angle, specified as'normal'or'italic'. Setting this property toitalicselects a slanted version of the font, if it is available on the app user’s system.

Font color, specified as an RGB triplet, a hexadecimal color code, or one of the options listed in the table.

RGB triplets and hexadecimal color codes are useful for specifying custom colors.

  • An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range[0,1]; for example,[0.4 0.6 0.7].

  • A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from0toF. The values are not case sensitive. Thus, the color codes'#FF8800','#ff8800','#F80', and'#f80'are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Color Name Short Name RGB Triplet Hexadecimal Color Code 外观
'red' 'r' [1 0 0] '#FF0000'

'green' 'g' [0 1 0] '#00FF00'

'blue' 'b' [0 0 1] '#0000FF'

'cyan' 'c' [0 1 1] '#00FFFF'

'magenta' 'm' [1 0 1] '#FF00FF'

'yellow' 'y' [1 1 0] '#FFFF00'

'black' 'k' [0 0 0] '#000000'

'white' 'w' [1 1 1] '#FFFFFF'

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

RGB Triplet Hexadecimal Color Code 外观
[0 0.4470 0.7410] '#0072BD'

[0.8500 0.3250 0.0980] '#D95319'

[0.9290 0.6940 0.1250] '#EDB120'

[0.4940 0.1840 0.5560] '#7E2F8E'

[0.4660 0.6740 0.1880] '#77AC30'

[0.3010 0.7450 0.9330] '#4DBEEE'

[0.6350 0.0780 0.1840] '#A2142F'

Background color, specified as an RGB triplet, a hexadecimal color code, or one of the color options listed in the table.

RGB triplets and hexadecimal color codes are useful for specifying custom colors.

  • An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range[0,1]; for example,[0.4 0.6 0.7].

  • A hexadecimal color code is a character vector or a string scalar that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from0toF. The values are not case sensitive. Thus, the color codes'#FF8800','#ff8800','#F80', and'#f80'are equivalent.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Color Name Short Name RGB Triplet Hexadecimal Color Code 外观
'red' 'r' [1 0 0] '#FF0000'

'green' 'g' [0 1 0] '#00FF00'

'blue' 'b' [0 0 1] '#0000FF'

'cyan' 'c' [0 1 1] '#00FFFF'

'magenta' 'm' [1 0 1] '#FF00FF'

'yellow' 'y' [1 1 0] '#FFFF00'

'black' 'k' [0 0 0] '#000000'

'white' 'w' [1 1 1] '#FFFFFF'

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

RGB Triplet Hexadecimal Color Code 外观
[0 0.4470 0.7410] '#0072BD'

[0.8500 0.3250 0.0980] '#D95319'

[0.9290 0.6940 0.1250] '#EDB120'

[0.4940 0.1840 0.5560] '#7E2F8E'

[0.4660 0.6740 0.1880] '#77AC30'

[0.3010 0.7450 0.9330] '#4DBEEE'

[0.6350 0.0780 0.1840] '#A2142F'

Interactivity

expand all

State of visibility, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'相当于true, and'off'相当于false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of typematlab.lang.OnOffSwitchState.

  • 'on'— Display the object.

  • 'off'— Hide the object without deleting it. You still can access the properties of an invisible UI component.

To make your app start faster, set theVisibleproperty to'off'for all UI components that do not need to appear at startup.

Operational state, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'相当于true, and'off'相当于false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of typematlab.lang.OnOffSwitchState.

  • If you set this property to'on', the app user can interact with the component.

  • If you set this property to'off', the component appears dimmed, indicating that the app user cannot interact with it, and that it will not trigger a callback.

Tooltip, specified as a character vector, cell array of character vectors, string array, or 1-D categorical array. Use this property to display a message when the user hovers the pointer over the component at run time. The tooltip displays even when the component is disabled. To display multiple lines of text, specify a cell array of character vectors or a string array. Each element in the array becomes a separate line of text. If you specify this property as a categorical array, MATLAB uses the values in the array, not the full set of categories.

Context menu, specified as aContextMenuobject created using theuicontextmenufunction. Use this property to display a context menu when you right-click on a component.

Position

expand all

Location and size of button, specified as the vector of the form[left bottom width height]. This table describes each element in the vector.

Element Description
left Distance from the inner left edge of the parent container to the outer left edge of the button
bottom Distance from the inner bottom edge of the parent container to the outer bottom edge of the button
width Distance between the right and left outer edges of the button
height Distance between the top and bottom outer edges of the button

ThePositionvalues are relative to thedrawable areaof the parent container. The drawable area is the area inside the borders of the container and does not include the area occupied by decorations such as a menu bar or title.

All measurements are in pixel units.

Location and size of button, specified as a four element vector of the form[left bottom width height]. All measurements are in pixel units. This property value is identical to thePositionproperty.

This property is read-only.

Location and size of button, returned as a four element vector of the form[left bottom width height]. All measurements are in pixel units. This property value is identical to thePositionproperty.

Horizontal alignment of the icon and text, specified as'center','left', or'right'. The horizontal alignment is relative to the area inside the borders of the button. Setting this property when the text spans the full width of the button has no apparent effect in the UI.

Vertical alignment of the icon and the text, specified as'center','top', or'bottom'. The vertical alignment is relative to the area inside the borders of the button. Setting this property when the text height fills the height of the button has no apparent effect in the UI.

Location of icon relative to the button text, specified as'left','right','top', or'bottom'. If theTextproperty is empty, then the icon uses theHorizontalAlignmentandVerticalAlignmentproperties instead of theIconAlignmentproperty.

Layout options, specified as aGridLayoutOptionsobject. This property specifies options for components that are children of grid layout containers. If the component is not a child of a grid layout container (for example, it is a child of a figure or panel), then this property is empty and has no effect. However, if the component is a child of a grid layout container, you can place the component in the desired row and column of the grid by setting theRowandColumnproperties on theGridLayoutOptionsobject.

For example, this code places a state button in the third row and second column of its parent grid.

g = uigridlayout([4 3]); sb = uibutton(g,'state'); sb.Layout.Row = 3; sb.Layout.Column = 2;

To make the button span multiple rows or columns, specify theRoworColumnproperty as a two-element vector. For example, this button spans columns2through3:

sb.Layout.Column = [2 3];

Callbacks

expand all

Value changed callback, specified as one of these values:

  • A function handle.

  • A cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.

  • A character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

This callback executes when the user changes the button's state in the app. It does not execute if the state changes programmatically.

This callback function can access specific information about the user’s interaction with the button. MATLAB passes this information in aValueChangedDataobject as the second argument to your callback function. In App Designer, the argument is calledevent. You can query the object properties using dot notation. For example,event.PreviousValuereturns the previous value of the button. TheValueChangedDataobject is not available to callback functions specified as character vectors.

The following table lists the properties of theValueChangedDataobject.

Property Value
Value Value of state button after the app user’s most recent interaction with it
PreviousValue Value of state button before the app user’s most recent interaction with it
Source Component that executes the callback
EventName 'ValueChanged'

For more information about writing callbacks, seeWrite Callbacks in App Designer.

Object creation function, specified as one of these values:

  • Function handle.

  • Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.

  • Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

For more information about specifying a callback as a function handle, cell array, or character vector, seeWrite Callbacks in App Designer.

This property specifies a callback function to execute when MATLAB creates the object. MATLAB initializes all property values before executing theCreateFcncallback. If you do not specify theCreateFcnproperty, then MATLAB executes a default creation function.

Setting theCreateFcnproperty on an existing component has no effect.

If you specify this property as a function handle or cell array, you can access the object that is being created using the first argument of the callback function. Otherwise, use thegcbofunction to access the object.

对象删除函数,指定为酒店之一e values:

  • Function handle.

  • Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.

  • Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

For more information about specifying a callback as a function handle, cell array, or character vector, seeWrite Callbacks in App Designer.

This property specifies a callback function to execute when MATLAB deletes the object. MATLAB executes theDeleteFcncallback before destroying the properties of the object. If you do not specify theDeleteFcnproperty, then MATLAB executes a default deletion function.

If you specify this property as a function handle or cell array, you can access the object that is being deleted using the first argument of the callback function. Otherwise, use thegcbofunction to access the object.

Callback Execution Control

expand all

Callback interruption, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'相当于true, and'off'相当于false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of typematlab.lang.OnOffSwitchState.

This property determines if a running callback can be interrupted. There are two callback states to consider:

  • Therunningcallback is the currently executing callback.

  • Theinterruptingcallback is a callback that tries to interrupt the running callback.

Whenever MATLAB invokes a callback, that callback attempts to interrupt the running callback (if one exists). TheInterruptibleproperty of the object owning the running callback determines if interruption is allowed.

  • A value of'on'allows other callbacks to interrupt the object's callbacks. The interruption occurs at the next point where MATLAB processes the queue, such as when there is adrawnow,figure,uifigure,getframe,waitfor, orpausecommand.

    • If the running callback contains one of those commands, then MATLAB stops the execution of the callback at that point and executes the interrupting callback. MATLAB resumes executing the running callback when the interrupting callback completes.

    • If the running callback does not contain one of those commands, then MATLAB finishes executing the callback without interruption.

  • A value of'off'blocks all interruption attempts. TheBusyActionproperty of the object owning the interrupting callback determines if the interrupting callback is discarded or put into a queue.

Note

Callback interruption and execution behave differently in these situations:

  • If the interrupting callback is aDeleteFcn,CloseRequestFcnorSizeChangedFcncallback, then the interruption occurs regardless of theInterruptibleproperty value.

  • If the running callback is currently executing thewaitforfunction, then the interruption occurs regardless of theInterruptibleproperty value.

  • Timerobjects execute according to schedule regardless of theInterruptibleproperty value.

When an interruption occurs, MATLAB does not save the state of properties or the display. For example, the object returned by thegcaorgcfcommand might change when another callback executes.

Callback queuing, specified as'queue'or'cancel'. TheBusyActionproperty determines how MATLAB handles the execution of interrupting callbacks. There are two callback states to consider:

  • Therunningcallback is the currently executing callback.

  • Theinterruptingcallback is a callback that tries to interrupt the running callback.

Whenever MATLAB invokes a callback, that callback attempts to interrupt a running callback. TheInterruptibleproperty of the object owning the running callback determines if interruption is permitted. If interruption is not permitted, then theBusyActionproperty of the object owning the interrupting callback determines if it is discarded or put in the queue. These are possible values of theBusyActionproperty:

  • 'queue'— Puts the interrupting callback in a queue to be processed after the running callback finishes execution.

  • 'cancel'— Does not execute the interrupting callback.

This property is read-only.

Deletion status, returned as an on/off logical value of typematlab.lang.OnOffSwitchState.

MATLAB sets theBeingDeletedproperty to'on'when theDeleteFcncallback begins execution. TheBeingDeletedproperty remains set to'on'until the component object no longer exists.

Check the value of theBeingDeleted属性来验证object is not about to be deleted before querying or modifying it.

Parent/Child

expand all

Parent container, specified as aFigureobject created using theuifigurefunction, or one of its child containers:Tab,面板,ButtonGroup, orGridLayout. If no container is specified, MATLAB calls theuifigurefunction to create a newFigureobject that serves as the parent container.

Visibility of the object handle, specified as'on','callback', or'off'.

This property controls the visibility of the object in its parent's list of children. When an object is not visible in its parent's list of children, it is not returned by functions that obtain objects by searching the object hierarchy or querying properties. These functions includeget,findobj,clf, andclose. Objects are valid even if they are not visible. If you can access an object, you can set and get its properties, and pass it to any function that operates on objects.

HandleVisibility Value Description
'on' The object is always visible.
'callback' The object is visible from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line. This option blocks access to the object at the command-line, but allows callback functions to access it.
'off' The object is invisible at all times. This option is useful for preventing unintended changes to the UI by another function. Set theHandleVisibilityto'off'to temporarily hide the object during the execution of that function.

Identifiers

expand all

This property is read-only.

Type of graphics object, returned as'uistatebutton'.

对象标识符指定为一个特征向量or string scalar. You can specify a uniqueTagvalue to serve as an identifier for an object. When you need access to the object elsewhere in your code, you can use thefindobjfunction to search for the object based on theTagvalue.

User data, specified as any MATLAB array. For example, you can specify a scalar, vector, matrix, cell array, character array, table, or structure. Use this property to store arbitrary data on an object.

If you are working in App Designer, create public or private properties in the app to share data instead of using theUserDataproperty. For more information, seeShare Data Within App Designer Apps.

See Also

Functions

Introduced in R2016a

MATLAB Documentation

金宝app

Introducing Deep Learning with MATLAB

Introducing Deep Learning with MATLAB

Download ebook