encapsulate value(s) to be returned from Maplet application - Maple Help

Online Help

All Products    Maple    MapleSim

Home : Support : Online Help : Programming : Maplets : Elements : Other Elements : Maplets/Elements/Return

Maplets[Elements][Return] - encapsulate value(s) to be returned from Maplet application

Calling Sequence

Return(opts, element_content)

Return[refID](opts, element_content)




equation(s) of the form reference=value; specify options for the Return



any number of ReturnItem elements



name or string; reference to the element



The Return element encapsulates ReturnItem elements, which specify the values to return to Maple when the Maplet application closes.


To simplify specifying options in the Maplets package, certain options and contents can be set without using an equation. The following table lists elements, symbols, and types (in the left column) and the corresponding option or content (in the right column) to which inputs of this type are, by default, assigned.

Elements, Symbols, or Types

Assumed Option or Content




reference option




A Return element can contain any number of ReturnItem elements.


A Return element can be contained in a Maplet element.


The following table describes the control and use of the Return element options.


An x in the I column indicates that the option can be initialized, that is, specified in the calling sequence (element definition).


An x in the R column indicates that the option is required in the calling sequence.


An x in the G column indicates that the option can be read, that is, retrieved by using the Get tool.


An x in the S column indicates that the option can be written, that is, set by using the SetOption element or the Set tool.






















The opts argument can contain one or more of the following equations that set Maplet application options.




reference = name or string


A reference to the Return element.


If the reference is specified by both an index, for example, Return[refID], and a reference in the calling sequence, the index reference takes precedence.



maplet:=MapletBoxCellEnter some text:,TextField'TF1',ButtonOK,Shutdown`return`='R1',Return'R1'ReturnItem'item'='TF1':


This Maplet application can be rewritten by using the following shortcut.

maplet:=MapletBoxCellEnter some text:,TextField'TF1',ButtonOK,Shutdown'TF1':


See Also

Maplets/OtherElements, Maplets[Display], Maplets[Elements], Maplets[Elements][BoxCell], Maplets[Elements][Button], Maplets[Elements][Maplet], Maplets[Elements][ReturnItem], Maplets[Elements][SetOption], Maplets[Elements][Shutdown], Maplets[Elements][TextField], Maplets[Tools][Get], Maplets[Tools][Set], Overview of Maplet Applications

Download Help Document

Was this information helpful?

Please add your Comment (Optional)
E-mail Address (Optional)
What is ? This question helps us to combat spam