DocumentTools
SetProperty
set property of an embedded component
Calling Sequence
Parameters
Description
Examples
Compatibility
SetProperty(id, attr, val, refreshopt)
SetProperty([id1, attr1, val1], [id2,attr2,val2], ... , refreshopt)
id
-
{name, string} ; name of embedded component
attr
{name, string} ; property of the component that is to be set
val
(optional) anything ; value of property to set
refreshopt
expression of the form refresh = value, where value is true or false; specifies whether or not to immediately update the document
The SetProperty function sets the value of a property of an embedded component.
If the val option is omitted, the referenced component is reset to its default value.
By default, when this command is invoked from inside the code which is executed as the action of another embedded component, the document is not updated until that code terminates. The option refresh = true (or just refresh) can be used to force the document to update during the call to SetProperty.
For a list of embedded components, see Overview of Embedded Components.
Suppose that your document has a slider component with the name Slider1. To set the position of this slider to 110th of its maximum (assuming the range is the default of 0..100) , you can do this:
withDocumentTools:
SetPropertySlider1,value,10
Suppose your document has a plot component with the name Plot0. To display a single plot in the component, use the following commands.
p1≔plotx,x=0..1:
SetPropertyPlot0,value,p1:
To display an array of plots in the plot component, you must force the array to stay unsimplified by referring to it with quotes. See the specific component help page for any other special input instructions.
p2≔plotx2,x=0..1:
p3≔plotsdisplayArrayp1,p2:
SetPropertyPlot0,value,p3:
If code attached to a button causes several other embedded component values to change, you would normally not want the document to update until all those changes have been made. If you want to force updating after each change, use the refresh = true option (which can be abbreviated as just refresh). For example the following code illustrates updating a series of ComboBox elements. It is assumed that this code is attached to a Button component.
s≔:
useDocumentToolsinforito5dos ≔ ops,i;SetPropertyComboBox||i,'itemList',s;SetPropertyComboBox||i,'value',s1,refreshend doend use
The DocumentTools[SetProperty] command was updated in Maple 2016.
See Also
Button
ComboBox
DocumentTools[Do]
DocumentTools[GetProperty]
Overview of Embedded Components
Download Help Document
