DocumentTools[Components] - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Document Tools : Components : DocumentTools/Components/Button

DocumentTools[Components]

  

Button

  

generate XML for a Button Component

 

Calling Sequence

Parameters

Options

Description

Examples

Compatibility

Calling Sequence

Button( caption, opts )

Parameters

caption

-

(optional) string:="Button"; the caption on the button

opts

-

(optional) ; one or more keyword options as described below

Options

• 

action : string:=""; A string which parses to one or more valid statements in 1-D Maple Notation. These statements form the Value Changed Action Component Code that executes when the Button is clicked. The default is the empty string (no action code).

• 

enabled : truefalse; Indicates whether the component is enabled. The default is true.

If enabled is false then the inserted component is grayed out and interaction with it cannot be initiated.

• 

fontcolor : {list(nonnegint),symbol,string}:=[0,0,0] ; Specifies the font color of the component. The passed value can be either a named color or a list of three integers each between 0 and 255. A list of nonnegative integers is interpreted as RGB values in a 24bit 3-channel color space. The default value is [0,0,0] which corresponds to black.

• 

height : posint; The height in pixels of the component.

• 

identity : {name,string}; The reference name of the component.

• 

image : {string,Matrix,Array}; Image to be displayed on the component, specified as either a the name of an external image file or a Matrix or Array as recognized by commands in the ImageTools package. The caption parameter and the image option are mutually exclusive; only one may be supplied.

• 

showborders : truefalse; Indicates whether borders will be shown

• 

tooltip : string; The text that appears when the mouse pointer hovers over the component. The default is the empty string (no tooltip).

• 

visible : truefalse; Indicates whether the component is visible. The default is true.

• 

width : posint; The width in pixels of the component.

Description

• 

The Button command in the Component Constructors package returns an XML function call which represents a Button Component.

• 

The generated XML may be used with the results of commands in the Layout Constructors package to create an entire Worksheet or Document in XML form. Such a representation of a Worksheet or Document may be inserted into the current document using the InsertContent command.

Examples

withDocumentTools:

withDocumentTools:-Components:

withDocumentTools:-Layout:

Executing the Button command produces a function call.

SButtonMy Button,identity=Button0

S_XML_EC-Buttonid=Button0,caption=My Button,enabled=true,fontcolor=[0,0,0],visible=true,show-border=true

(1)

By using commands from the Layout Constructors package a nested function call can be produced which represents a worksheet.

xmlWorksheetGroupInputTextfieldS:

That XML representation of a worksheet can be inserted directly.

InsertContentxml:

codestring\ns := true;\n\nt := false;

codestring s := true; t := false;

(2)

SButtonMy Button,identity=Button0,tooltip=My example button,action=codestring:

xmlWorksheetGroupInputTextfieldS:

The previous example's call to the InsertContent command inserted a component with identity "Button0", which still exists in this worksheet. Inserting additional content whose input contains another component with that same identity "Button0" incurs a substitution of the input identity in order to avoid a conflict with the identity of the existing component.

The return value of the following call to InsertContent is a table which can be used to reference the substituted identity of the inserted component.

lookupInsertContentxml,output=table

lookuptableButton0=Button1

(3)

lookupButton0

Button1

(4)

GetPropertylookupButton0,caption

My Button

(5)

imgcatkerneloptsdatadir,/images/up_arrow.gif:

BButtonimage=img,identity=Button17:

InsertContentWorksheetGroupInputTextfieldB:

imgArray1..60,1..40,1..3,i,j,k`if`k=3,j40,0,datatype=float8,order=C_order:

BButtonimage=img,identity=Button17:

InsertContentWorksheetGroupInputTextfieldB:

BButtonimage=img,identity=Button17,width=70,height=20:

InsertContentWorksheetGroupInputTextfieldB:

BButtonMy Button,fontcolor=DarkGreen:

InsertContentWorksheetGroupInputTextfieldB:

Compatibility

• 

The DocumentTools:-Components:-Button command was introduced in Maple 2015.

• 

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

• 

The DocumentTools:-Components:-Button command was updated in Maple 2016.

• 

The fontcolor option was introduced in Maple 2016.

• 

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

See Also

Component Code

Component Constructors

DocumentTools

Embedded Components

XMLTools