ClickValue - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.

Online Help

All Products    Maple    MapleSim


DocumentTools[Actions]

  

ClickValue

  

programmatically perform the click action of selecting a value or multiple values of supported components

 

Calling Sequence

Parameters

Description

Examples

Compatibility

Calling Sequence

ClickValue( id, selectvalue, opts )

Parameters

id

-

{string,symbol}; name of the component

selectvalue

-

{numeric,string,list}; value(s) to be selected

nowarning

-

(optional) truefalse; indicates whether a warning will appear when no Value Changed Code is provided by the user for the component. The default is false.

Description

• 

The ClickValue command interacts with a component as if the user used the cursor to click the component.

• 

The command is only available for Combo Box, Dial, List Box, Meter, Rotary Gauge, Slider, and Volume Gauge components.

• 

The Click Code is executed.

• 

This command has no return value.

• 

If selectvalue is numeric, it designates the value of the component to select, if present in the component.

• 

If selectvalue is a string, it designates the string value of the component to select, if present in the component.

• 

If selectvalue is a list, it designates the values of the List Box component to select, if present.

• 

Combo Box, Dial, Meter, Rotary Gauge, Slider, and Volume Gauge components do not support list input.

Examples

Here we have a List Box component that displays various expressions to be plotted. Executing the ClickValue command with a relevant expression or expressions will select one or more expressions and update the plot.

 

You need to open the help page as a worksheet to view how executing the ClickIndex command on the List Box causes the plot to update to the expression selected.

withDocumentTools:-Actions:

Single value:

ClickValueListBoxTest,x^4-6

List of values:

ClickValueListBoxTest,x-1,x^2+2*x-1

Here we have a Slider component that represents the exponential value to be displayed in the plot of x^n, where n is the slider value. Executing the ClickValue command with a numeric value will define the value for n and update the plot accordingly.

 

You need to open the help page as a worksheet to view how executing the ClickValue command on the Slider causes the plot to update based on the exponent value selected.

ClickValueSliderTest,3

ClickValueSliderTest,2

Compatibility

• 

The DocumentTools:-Actions:-ClickValue command was introduced in Maple 2022.

• 

For more information on Maple 2022 changes, see Updates in Maple 2022.

See Also

Component Constructors

DocumentTools

Embedded Components