WinCheckBox Object Plugin

Actions

WinCheckBox.SetChecked(string ObjectName, boolean State);

Description:

Sets the checked/unchecked state of a wincheckbox object.

ObjectName:

(string) The name of the wincheckbox object.

Color:

(boolean) Whether to make the wincheckbox object checked or unchecked

Returns:

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- Set the control as checked WinCheckBox.SetChecked("MyWinCheckBox", true);

WinCheckBox.GetChecked(string ObjectName);

Description:

Returns true if a specific wincheckbox object is checked, or false if it's unchecked.

ObjectName:

(string) The name of the wincheckbox object.

Returns:

True if the wincheckbox object is checked, false if it is unchecked. If an error occurs, false will be returned. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- Check the state of a wincheckbox state = WinCheckBox.GetChecked("MyWinCheckBox");

WinCheckBox.SetText(string ObjectName, String Caption);

Description:

Sets the text (caption) currently displayed on the wincheckbox object.

ObjectName:

(string) The name of the wincheckbox object.

Caption:

(string) The text to be displayed as caption of the wincheckbox object.

Returns:

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- Set the text of the checkbox WinCheckBox.SetText("MyWinCheckBox", "New Caption");

WinCheckBox.GetText(string ObjectName);

Description:

Returns the text currently displayed on the wincheckbox object.

ObjectName:

(string) The name of the wincheckbox object.

Returns:

(string) The currently caption of the wincheckbox object. If no text is displayed or an error occurs, an empty string ("") is returned. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- Get the current caption caption = WinCheckBox.GetText("MyWinCheckBox");

WinCheckBox.SetEnabled(string ObjectName, boolean State);

Description:

Sets the enabled/disabled state of a wincheckbox object.

ObjectName:

(string) The name of the wincheckbox object.

State:

(boolean) Whether to make the checkbox object enabled (true) or disabled (false).

Returns:

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- Disable the WinCheckBox WinCheckBox.SetEnable("MyWinCheckBox", false);

WinCheckBox.SetVisible(string ObjectName, boolean State);

Description:

Sets the visibility of a wincheckbox object.

ObjectName:

(string) The name of the wincheckbox object.

State:

(boolean) Whether to make the checkbox object visible (true) or hidden (false).

Returns:

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- Hide the WinCheckBox WinCheckBox.SetVisible("MyWinCheckBox", false);

WinCheckBox.Redraw(string ObjectName);

Description:

Forces a redraw of the window containing the control. This is intended to be used if the background image or color of the page is changed, and the WinCheckBox object has to be redrawn to continue to look "transparent" on the page in runtime.

ObjectName:

(string) The name of the wincheckbox object.

Returns:

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

Example:

-- Redraw the WindCheckBox window holding the control WinCheckBox.Redraw("MyWinCheckBox");