Common Methods

<< Click to Display Table of Contents >>

Manual > Control Reference > Common to all controls >

Common Methods

 

Methods that all controls have in common are called common methods.

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

AddTag

Declare (register) tags that you want to access from scripts in an object. This allows you to:

Tag values can now be input and output using GetVal/ ReadVal/ WriteVal/ ReadRequestRefresh/ ReadRefresh/ WriteRequestRefresh/WriteRefresh. Also, when the tag value changes, the "OnTagValueChanged" event will be called.

○

○

×

DelTag

Unregisters a tag. Tag registration is automatically unregistered when the form is closed, so there is no need to call DelTag unless there is a specific reason.

○

○

×

ClearAllTag

Unsubscribe from all tags.

○

○

×

GetVal

Get tag values from cache (recommended, fast). Bulk loading is also possible using an array.

○

○

×

ReadVal

Gets the tag value (DataSource can be specified). However, only one tag can be read.

○

○

×

WriteVal

Write a value to a tag (single-point tag write).

○

○

×

ReadRefresh

Refresh the tag cache (recommended, fast). You can also specify multiple tags at once using an array.

○

○

×

WriteRefresh

Write tag values together and refresh the cache (recommended, fast).

○

○

×

ReadRequest

Make a read request (used in conjunction with ReadRequestRefresh).

○

○

×

ReadRequestRefresh

Execute all read requests and refresh the cache (recommended/fast).

○

○

×

WriteRequest

Make a write request (used in conjunction with WriteRequestRefresh).

○

○

×

WriteRequestRefresh

Execute all write requests and refresh the cache (recommended/fast).

○

○

×

 

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

GetBindScript

Gets the binding format.

×

○

×

SetBindScript

Set the binding format.

×

○

×

 

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

GetParentObj

Get the parent object.

○

○

×

GetChildObj

Get the child object.

○

○

×

GetChildObjCount

Gets the number of child objects.

○

○

×

GetObjIndex

Gets the position of the current object among its parent objects.

○

○

×

GetProperty

Get a property value.

×

○

×

SetProperty

Set a property value.

×

○

×

CopyProperty

Copy property values from other objects.

×

○

×

GetSourceProperty

Gets the initial property value.

×

○

×

CallCommonEvent

Call common event (OnCommonEvent).

×

○

×

CallMethod

Invoke a method on an object.

×

○

×

HitTest

Determines whether the object itself overlaps with the specified object or coordinate value.

×

○

×

BringToFront

Move the component to the front.

×

○

×

BringToBack

Move the component to the back.

×

○

×

SetFocus

Move the focus to your control.

×

○

×

LostFocus

Remove the focus from your control.

×

○

×

StartDrag

Starts dragging in both X and Y directions.

×

○

×

StartDragX

Start dragging in the X direction only.

×

○

×

StartDragY

Start dragging in the Y direction only.

×

○

×

StopDrag

End the drag.

×

○

×

IsDrag

Gets whether the object is being dragged.

×

○

×

Intersect

Gets the overlapping area of objects.

×

○

×

GetMousePos

Gets the coordinates of the mouse relative to the object.

×

○

×

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

SetTimer

Start the timer.

○

○

×

KillTimer

End the timer.

○

○

×

KillAllTimer

Ends all timers.

○

○

×

 

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

OpenDialog

Opens the form as a dialog.

×

○

×

OpenModalDialog

Opens the form as a modal dialog.

×

○

×

CloseDialog

Close the dialog.

×

○

×

 

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

Redraw

Forces a redraw.

×

○

×

 

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

Animate

Animate objects.

×

○

×

 

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

OpenMsg

Opens a simple common dialog message box.

×

○

×

OpenModalMsg

Opens a simple common dialog message box modally.

×

○

×

CloseMsg

Closes the simple common dialog message box.

×

○

×

OpenYesNoMsg

Opens a simple common dialog message box with Yes/No buttons.

×

○

×

OpenModalYesNoMsg

Opens a simple common dialog message box modally with Yes/No buttons.

×

○

×

CloseYesNoMsg

Closes a simple common dialog message box with a Yes/No button.

×

○

×

OpenYesNoCancelMsg

Opens a simple common dialog message box with Yes/No/Cancel buttons.

×

○

×

OpenModalYesNoCancelMsg

Opens a simple common dialog message box modally with Yes/No/Cancel buttons.

×

○

×

CloseYesNoCancelMsg

Closes a simple common dialog message box with Yes/No/Cancel buttons.

×

○

×

OpenPassword

Opens the simple common dialog password dialog.

×

○

×

OpenModalPassword

Opens the Simple Common Dialog password dialog modally.

×

○

×

ClosePassword

Closes the Simple Common Dialog password dialog.

×

○

×

OpenNumKey

Opens the simple common dialog numeric keyboard.

×

○

×

OpenModalNumKey

Opens a modal numeric keyboard for a simple common dialog.

×

○

×

OpenNumKeyEdit

Opens a numeric keyboard exclusively for edit boxes in simple common dialogs.

×

○

×

OpenModalNumKeyEdit

Opens a modal numeric keyboard exclusively for the edit box of the simple common dialog.

×

○

×

CloseNumKey

Close the numeric keyboard in the simple common dialog.

×

○

×

OpenTextKey

Opens the simple common dialog text keyboard.

×

○

×

OpenModalTextKey

Opens a simple common dialog text keyboard modally.

×

○

×

OpenTextKeyEdit

Opens a text keyboard dedicated to the edit box of the simple common dialog.

×

○

×

OpenModalTextKeyEdit

Opens a modal text keyboard exclusively for the edit box of the simple common dialog.

×

○

×

CloseTextKey

Close the text keyboard in the simple common dialog.

×

○

×

OpenCalendar

Opens the simple common dialog Calendar dialog.

×

○

×

OpenModalCalendar

Opens the simple common dialog calendar dialog modally.

×

○

×

CloseCalendar

Closes the Simple Common Dialog Calendar dialog.

×

○

×

OpenFormMap

Opens the Form Map dialog.

×

○

×

OpenModalFormMap

Opens the Form Map dialog modally.

×

○

×

CloseFormMap

Close the Form Map dialog.

×

○

×

SetFormMap

Set the form in the Form Map dialog.

×

○

×

ClearFormMap

Cancels the form set in the Form Map dialog.

×

○

×

RefreshFormMap

Refresh the Form Map dialog screen.

×

○

×

OpenColor

Opens a simple common dialog for selecting a color.

×

○

×

OpenModalColor

Opens a simple common dialog color selection dialog modally.

×

○

×

CloseColor

Close the simple common dialog color selection dialog.

×

○

×

OpenSearch

Opens the Simple Common Dialog search dialog.

×

○

×

OpenModalSearch

Opens the simple common dialog search dialog modally.

×

○

×

CloseSearch

Close the search dialog of the simple common dialog.

×

○

×

OpenCommonDialog

Open the common dialog (for simple common dialog customization).

×

○

×

OpenModalCommonDialog

Open the common dialog modally (for simple common dialog customization).

×

○

×

CloseCommonDialog

Close the common dialog (for simple common dialog customization).

×

○

×

OpenWindowsDialog

Open a Windows dialog.

×

○

×

 

 

Method name

explanation

script

action

browser

script

Arithmetic Expression

syntax

AddExpression

Register the formula.

○

×

×

DelExpression

Unregister an expression.

○

×

×

DelAllExpression

Unregister all expressions.

○

×

×

 

 

 

hint

Dialog-related methods are provided as common methods. For example, they can be executed as form methods such as "this.OpenDialog (...)", or as root methods such as "::OpenDialog(...)". Regardless of how they are called, the dialog will not be hidden behind the form, but when multiple dialogs are displayed at the same time, there is a difference in the behavior of the hierarchical display between the two.

 

■ When executed as a form method

The displayed dialog will always be displayed in front of the object that called it (i.e. it will not be hidden behind the object that called it. Therefore, if you display a dialog from within a displayed dialog, the later dialog will always be displayed in front of the earlier dialog.

 

■ When executed as a route method

In contrast to the above, if multiple dialogs are displayed as root methods, each dialog is positioned as being in the same hierarchy, so no dependency occurs in the hierarchical display. In other words, the operator can freely move between multiple dialog displays with the mouse.