ClickIndex - 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]

 ClickIndex
 programmatically perform the click action of selecting an index or multiple indices of supported components

 Calling Sequence ClickIndex( id, selectindex, opts )

Parameters

 id - {string,symbol}; name of the component selectindex - {nonnegint,list(nonnegint),range(nonnegint)}; index or indices to be selected nowarning - (optional) truefalse; indicates whether a warning will appear when no Value Change Code is provided by the user for the component. The default is false.

Description

 • The ClickIndex command interacts with a component as if the user used the cursor to click the component.
 • The command is only available for Combo Box and List Box components.
 • The Select Code is executed.
 • This command has no return value.
 • If selectindex is a nonnegative integer, it designates the index of the entry to select. The first index is 0.
 • If selectindex is a list of nonnegative integers, it designates the indices of the entries to select. The first index is 0.
 • If selectindex is a range of nonnegative integers, it designates the range of indices of the entries to select. The first index is 0.

Examples

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

 x^2+2*x-1x^4-6x-1-x^2-4*x

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.

 > $\mathrm{with}\left(\mathrm{DocumentTools}:-\mathrm{Actions}\right):$

Single index:

 > $\mathrm{ClickIndex}\left("ListBoxTest",1\right)$

List of indices:

 > $\mathrm{ClickIndex}\left("ListBoxTest",\left[1,3\right]\right)$

Range of indices:

 > $\mathrm{ClickIndex}\left("ListBoxTest",0..2\right)$

Compatibility

 • The DocumentTools:-Actions:-ClickIndex command was introduced in Maple 2022.
 • For more information on Maple 2022 changes, see Updates in Maple 2022.

 See Also