CheckBox

WPF. CheckBox

CheckBox

Constructor

new CheckBox(propsopt) → {CheckBox}

Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes a CheckBox test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
CheckBox

Methods

absoluteLocation(locationopt) → {Point|Description}

The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

attachedText(attachedTextopt) → {string|Description}

The object's attached text.
Parameters:
NameTypeAttributesDescription
attachedTextstring <optional>
When provided, this method acts as a setter and sets the attachedText value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored attachedText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

canFocus(canFocusopt) → {boolean|Description}

This object's name as set by the developer.
Parameters:
NameTypeAttributesDescription
canFocusboolean <optional>
When provided, this method acts as a setter and sets the canFocus value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored canFocus value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

fullNamePath(fullNamePathopt) → {string|Description}

The full hierarchy of the object's name with all parent objects.
Parameters:
NameTypeAttributesDescription
fullNamePathstring <optional>
When provided, this method acts as a setter and sets the fullNamePath value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored fullNamePath value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

fullType(fullTypeopt) → {string|Description}

The full type name of this object.
Parameters:
NameTypeAttributesDescription
fullTypestring <optional>
When provided, this method acts as a setter and sets the fullType value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored fullType value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

helpText(helptextopt) → {string|Description}

The check box's help text.
Parameters:
NameTypeAttributesDescription
helptextstring <optional>
When provided, this method acts as a setter and sets the helptext value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored helptext value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

isChecked(IsCheckedopt) → {boolean|Description}

The check box's IsChecked value.
Parameters:
NameTypeAttributesDescription
IsCheckedboolean <optional>
When provided, this method acts as a setter and sets the IsChecked value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current IsChecked value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isEnabled(isEnabledopt) → {boolean|Description}

Indicates whether the object is enable.
Parameters:
NameTypeAttributesDescription
isEnabledboolean <optional>
When provided, this method acts as a setter and sets the isEnabled value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isFocused(isFocusedopt) → {boolean|Description}

Indicates whether the object is focused.
Parameters:
NameTypeAttributesDescription
isFocusedboolean <optional>
When provided, this method acts as a setter and sets the isFocused value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isFocused value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isThreeState(IsThreeStateopt) → {boolean|Description}

The check box's IsThreeState value.
Parameters:
NameTypeAttributesDescription
IsThreeStateboolean <optional>
When provided, this method acts as a setter and sets the IsThreeState value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current IsThreeState value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isVisible(isVisibleopt) → {boolean|Description}

Indicates whether the object is visible.
Parameters:
NameTypeAttributesDescription
isVisibleboolean <optional>
When provided, this method acts as a setter and sets the isVisible value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isVisible value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

location(locationopt) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the location value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

nativeClass(nativeClassopt) → {string|Description}

The object's native class.
Parameters:
NameTypeAttributesDescription
nativeClassstring <optional>
When provided, this method acts as a setter and sets the nativeClass value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored nativeClass value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

objectName(objectNameopt) → {string|Description}

This object's name as set by the developer.
Parameters:
NameTypeAttributesDescription
objectNamestring <optional>
When provided, this method acts as a setter and sets the objectName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored objectName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

objectProperties(objectPropertiesopt) → {object|Description}

The concrete test object properties including custom properties.
Parameters:
NameTypeAttributesDescription
objectPropertiesobject <optional>
When provided, this method acts as a setter and sets the objectProperties value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored objectProperties value; otherwise it returns 'this' for use with the builder pattern.
Type
object | Description

parentText(parentTextopt) → {string|Description}

The text associated with the parent of the check box.
Parameters:
NameTypeAttributesDescription
parentTextstring <optional>
When provided, this method acts as a setter and sets the parentText value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored parentText value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

size(sizeopt) → {Size|Description}

The object's size in pixels.
Parameters:
NameTypeAttributesDescription
sizeSize <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

state(stateopt) → {CheckedState|Description}

The check box's state.
Parameters:
NameTypeAttributesDescription
stateCheckedState <optional>
When provided, this method acts as a setter and sets the state value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current state value; otherwise it returns 'this' for use with the builder pattern.
Type
CheckedState | Description

text(textopt) → {string|Description}

The text associated with the object.
Parameters:
NameTypeAttributesDescription
textstring <optional>
When provided, this method acts as a setter and sets the text value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

windowTitleRegExp(windowClassRegExpopt) → {string|Description}

The constant part of the window title.
Parameters:
NameTypeAttributesDescription
windowClassRegExpstring <optional>
When provided, this method acts as a setter and sets the windowTitleRegExp value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowTitleRegExp value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description