OpenForm

<< Click to Display Table of Contents >>

Manual > Control Reference > Route > Route Methods >

OpenForm


 

Open the form.

 


Syntax 1

OpenForm(

         basedFormName

         [,systemParam]

         [,openParam]

         )

 


Parameters

 

basedFormName

 

Type:

character

 

Form Name

 

systemParam

 

Type:

General purpose

 

System parameters. Each element is "parameter name:value". To specify multiple elements, specify them as an array like this: c("parameter name 1:value 1", "parameter name 2:value 2",...). Note that this parameter does not support map values.

 

Parameters

Default value

explanation

formName

""

Specify the name of the form after it is displayed.This is the new form name to reference from the script. If omitted, the name specified in basedFormName will be used. It must not overlap with the currently displayed form name.

stretch

FORM

The size of the form is adjusted to fit the browser's display size (or the display size of the view to be displayed in the case of a frame).

 

NONE

Don't stretch.

STRETCH_FULL

The image is stretched to fit the display size.

STRETCH_KEEPRATE

The image is stretched to fit the display size (maintaining aspect ratio).

RESIZE_FULL

Adjust the form size to fit the display size.

RESIZE_KEEPRATE

Adjust the form size to fit the display size (maintain aspect ratio).

FORM

Matches the setting of the form's Strech property.

DEFAULT

Matches the setting of the route's Strech property.

 

* If this argument is not specified or if an empty string is specified, the Strech property of the form will be used.

 

visualTheme

""

Specifies the visual theme name in text.

 

 

Example: When there is only one element

::OpenForm("Form01","formName:frmForm01");

 

Example: In the case of multiple elements

::OpenForm("Form01",c("formName:frmForm01","stretch:RESIZE_FULL"));

 

 

openParam

 

Type:

General purpose

 

Open parameter. Each element is "parameter name:value". To specify an array, use c("parameter name 1:value 1", "parameter name 2:value 2",...). It is also possible to pass a map value generated by the MAP route method.

 

The information passed in the open parameters can be retrieved from the called form's script using the GetOpenParam method.

 

Return Value

 

 

Type:

Boolean

 

FALSE - Failure. TRUE - Success.

 


hmtoggle_plus1Explanation

 

 


Syntax 2

OpenForm(

         formName

         [,stretch]

         [,openParam]

         )

 


Parameters

 

formName

 

Type:

character

 

Form Name

 

stretch

 

Type:

character

 

The form size is expanded to fit the browser display size (or the display size of the view to be displayed in the case of a frame).

 

"NONE" - no stretching

"STRETCH_FULL" - Stretch to fit the display size.

"STRETCH_KEEPRATE" - Stretch to fit the display size (keep aspect ratio)

"RESIZE_FULL" - Adjust form size to fit display size

"RESIZE_KEEPRATE" - Adjust form size to fit display size (keep aspect ratio)

"FORM" - Matches the setting of the form's Strech property

"DEFAULT" - Matches the setting of the route's Strech property

 

* If this argument is not specified or if an empty string is specified, the Strech property of the form will be used.

 

openParam

 

Type:

General purpose

 

Open parameter. Each element is "parameter name:value". To specify an array, use c("parameter name 1:value 1", "parameter name 2:value 2",...). It is also possible to pass a map value generated by the MAP route method.

 

The information passed in the open parameters can be retrieved from the called form's script using the GetOpenParam method.

 

Return Value

 

 

Type:

Boolean

 

FALSE - Failure. TRUE - Success.

 


hmtoggle_plus1Explanation

 

 


Supported


×

Script Action

○

Browser script

×

Calculation Expression Syntax

 


reference