Window

StdWin. Window

new Window(props[opt]) → {Window}

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

Methods

absoluteLocation(location[opt]) → {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

accessibleName(accessibleName[opt]) → {string|Description}

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

attachedText(attachedText[opt]) → {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

hasBorder(hasBorder[opt]) → {boolean|Description}

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

hasCaption(hasCaption[opt]) → {boolean|Description}

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

hasSizebox(hasSizebox[opt]) → {boolean|Description}

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

hasSystemMenu(hasSystemMenu[opt]) → {boolean|Description}

Indicates whether the Window or the Dialog has system menu.
Parameters:
NameTypeAttributesDescription
hasSystemMenuboolean <optional>
When provided, this method acts as a setter and sets the hasSystemMenu value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored hasSystemMenu value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isActive(isActive[opt]) → {boolean|Description}

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

isChildWindow(isChildWindow[opt]) → {boolean|Description}

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

isEnabled(isEnabled[opt]) → {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(isFocused[opt]) → {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

isMaximizable(isMaximizable[opt]) → {boolean|Description}

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

isMdiChildWindow(isMdiChildWindow[opt]) → {boolean|Description}

Indicates whether the Window or the Dialog is MDI child window/dialog.
Parameters:
NameTypeAttributesDescription
isMdiChildWindowboolean <optional>
When provided, this method acts as a setter and sets the isMdiChildWindow value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isMdiChildWindow value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isMinimizable(isMinimizable[opt]) → {boolean|Description}

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

isOwnedWindow(isOwnedWindow[opt]) → {boolean|Description}

Indicates whether the window or the dialog is an owned window/dialog.
Parameters:
NameTypeAttributesDescription
isOwnedWindowboolean <optional>
When provided, this method acts as a setter and sets the isOwnedWindow value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isOwnedWindow value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isPopupWindow(isPopupWindow[opt]) → {boolean|Description}

Indicates whether the Window or the Dialog is a popup window/dialog.
Parameters:
NameTypeAttributesDescription
isPopupWindowboolean <optional>
When provided, this method acts as a setter and sets the isPopupWindow value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isPopupWindow value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isRightAligned(isRightAligned[opt]) → {boolean|Description}

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

isRightToLeftLayout(isRightToLeftLayout[opt]) → {boolean|Description}

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

isRightToLeftReading(isRightToLeftReading[opt]) → {boolean|Description}

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

isToolWindow(isToolWindow[opt]) → {boolean|Description}

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

isTopmost(isTopmost[opt]) → {boolean|Description}

Indicates whether the Window or the Dialog is top-most.
Parameters:
NameTypeAttributesDescription
isTopmostboolean <optional>
When provided, this method acts as a setter and sets the isTopmost value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isTopmost value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isVisible(isVisible[opt]) → {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(location[opt]) → {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(nativeClass[opt]) → {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

size(size[opt]) → {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

text(text[opt]) → {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

windowClassRegExp(windowClassRegExp[opt]) → {string|Description}

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

windowExtendedStyle(windowExtendedStyle[opt]) → {WindowExtendedStyles|Description}

The extended window style of the object. The possible value is in the enum WindowExtendedStyles
Parameters:
NameTypeAttributesDescription
windowExtendedStyleWindowExtendedStyles <optional>
When provided, this method acts as a setter and sets the windowExtendedStyle value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowExtendedStyle value; otherwise it returns 'this' for use with the builder pattern.
Type
WindowExtendedStyles | Description

windowId(windowId[opt]) → {number|Description}

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

windowStyle(windowStyle[opt]) → {WindowStyles|Description}

The window style of the object. The possible value is in the enum WindowStyles
Parameters:
NameTypeAttributesDescription
windowStyleWindowStyles <optional>
When provided, this method acts as a setter and sets the windowStyle value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowStyle value; otherwise it returns 'this' for use with the builder pattern.
Type
WindowStyles | Description

windowTitleRegExp(windowClassRegExp[opt]) → {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