Button

Type: Button

Extends View

Script class of the Button view.

Properties

Property	Description
	Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view.
`enabled`	Enables/disables the view.
`text`	Get/Set the text of the Button view.

View Properties

Properties defined by the view that are normally editable via properties editor.

Property	Name	Description
`label`	Label	Sets the button label. Set this to nothing to get action/wizard text, if defined
`show_label`	Show Label	Show the label on the button or just the icon.
`icon`	Icon	Button Icon
`stretch`	Stretch	Stretch the button to fill the view contents.
`script`	Script	Edit the button script.
`action`	Action	Action to invoke when clicked. This is more efficient than using a script for the same puropse.
`title`	Title	The title of the window.
`id`	Script ID	The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts.
`tooltip`	Tool Tip	Window tool tip.

Methods

Method	Description
`callListener(eventName, [args])`	Calls all event listeners for the given event name, useful for testing.
`getParent()`	Get the parent window/view (if any) of this view.
`getViewProperties()`	Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view.
`getViewProperty(id)`	Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view.
`on(eventName, callback)`	Adds an event listener for the given event name. e.g. view.on("click", function() { ... });
`pxFromDimension(dimension)`	Convert a dimension string (e.g. "10em", "50dp", "100px") into pixel units, relative to the view object. Returns the size in pixels.
`removeAllListeners([eventName])`	Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed.
`removeListener(eventName, callback)`	Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback);
`setViewProperty(id, value)`	Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view.

Events

Event Description

Event	Description
`onClick()`	Called in Button scripts when the user clicked the Button. External scripts can bind to the 'click' event to be notified when the user clicks the Button. button.on("click", function() { ... });

onClick()

Called in Button scripts when the user clicked the Button.

External scripts can bind to the 'click' event to be notified when the user clicks the Button.

button.on("click", function() { ... });