NewCheckBox

Adds a checkbox control to a form

[Set oCtl =] oFrm.NewCheckBox

( Name, Left, Top, Width, Height, Caption, [Value], [Container] )

Part

Description

Set oCtl =

(optional) Store a reference to the new control in the variable oCtl. This variable can be used to access the control's properties and methods

oFrm

A reference to a form object (see the NewForm method)

Name

The name of the control. It must be unique within the form and may not be empty or start with an asterisk (*)

Left

See the list of properties below

Top

See the list of properties below

Width

See the list of properties below

Height

See the list of properties below

Caption

See the list of properties below

Value

(optional) See the list of properties below

Container

(optional) The name of an existing frame control that will act as container for the checkbox. If unspecified or an empty string, the Form itself will be the container. Please note that the Left and Top properties are relative to the container's left and top edges

Property

Description

Alignment

0

Text is left-aligned; control is right-aligned (default)

1

Text is right-aligned; control is left-aligned

BackColor

Background color (use the RGB function to assign a color value)

Caption

The text displayed next to the control (maximum 255 character). You can specify an access key for the control by including an ampersand sign (&)

Enabled

(boolean) Determines if the control can respond to user-generated events

Fontname

The font used to display text. The default is determined by the system. Check the glossary for an explanation about setting font properties.

Fontsize

The size of the font in points. The maximum is 2160 points.

Fontbold

(boolean) Enable or disable the bold style of a font

Fontitalic

(boolean) Enable or disable the italic style of a font

Fontstrikethru

(boolean) Enable or disable the strikethru style of a font

Fontunderline

(boolean) Enable or disable the underline style of a font

ForeColor

Foreground color (use the RGB function to assign a color value)

Height

The height of the control in twips

Left

The distance from the left edge of the specified container in twips

Parent

(read-only) Returns the parent form, object or collection. You can use the parent property to access the properties and methods of an object's parent

TabStop

(boolean) Determines whether the TAB key can be used to move the focus

Tag

(reserved) Used internally to store the user-defined controlname

ToolTipText

Explanatory text that appears in a small rectangle below the object when you pause the mouse pointer (hover) over it for about one second

Top

The distance from the top edge of the specified container in twips

Value

0

Unchecked (default)

1

Checked

2

Checked, but dimmed

Visible

(boolean) Determines whether the control is visible or hidden

Width

The width of the control in twips

Method

Description

Move

Parameters: left [, top [, width [, height ]]]

Only the left argument is required. However, to specify any other arguments, you must specify all arguments that appear in the syntax before the argument you want to specify. For example, you can't specify width without specifying left and top. Any trailing arguments that are unspecified remain unchanged

Refresh

Forces a complete repaint of a control

SetFocus

Moves the focus to the specified control

Event

Description

Event raised

Click

Occurs when clicking the control with the left mouse button, by pressing an ACCESS KEY for the control, pressing the SPACEBAR when the control has the focus or changing the control's Value property from code

Controlname

To be able to handle events you need to operate a form in callback mode.
This subject is described in the following topics: Callback forms, ClickHandler

Option Explicit

Const vbModal = 1

Dim oDlg, oFrm, oCtl

'Create the WshDialog.Kit object and store a reference in oDlg
Set oDlg = Wscript.CreateObject("WshDialog.Kit", "oDlg_")

'Add a new form and store a reference to it in the variable oFrm
Set oFrm = oDlg.NewForm("Sample")

'Add an unchecked checkbox control named CBX1 to the oFrm form
'and store a reference to the CBX1 control in the variable oCtl
Set oCtl = oFrm.NewCheckBox("CBX1", 100, 100, 1700, 200, "CheckBox Caption", 0)

'Use the reference variable to modify the tooltiptext property
oCtl.ToolTipText = "This is a sample checkbox"
'This does the same but uses Ctl(<controlname>) to get a reference
oFrm.Ctl("CBX1").ToolTipText = "This is a sample checkbox"

'Add an OK button and set it's Default property
Set oCtl = oFrm.NewButton("OK", 450, 500, 1000, 375, "&OK")
oCtl.Default = True

'Automatically size the form and show it (modally)
oFrm.Autosize
oFrm.Show vbModal

'Show the checkbox state (only if the OK button was clicked)
If oDlg.Clicked = "OK" Then
    Select Case oFrm.Ctl("CBX1").Value
    Case 0
        MsgBox "The CBX1 control was unchecked"
    Case 1
        MsgBox "The CBX1 control was checked"
    Case Else
        'Ignore (2 = checked, but dimmed)
    End Select
End If