To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

Dialog

StdWin. Dialog

new Dialog(propsopt) → {Dialog}

The description of a Dialog test object.
Parameters:
Name Type Attributes Description
props Object <optional>
Initializes a Dialog test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
Dialog

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:
Name Type Attributes Description
location Point <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(accessibleNameopt) → {string|Description}

The object's accessible name.
Parameters:
Name Type Attributes Description
accessibleName string <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(attachedTextopt) → {string|Description}

The object's attached text.
Parameters:
Name Type Attributes Description
attachedText string <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(hasBorderopt) → {bool|Description}

Indicates whether the Window or the Dialog has borders.
Parameters:
Name Type Attributes Description
hasBorder bool <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
bool | Description

hasCaption(hasCaptionopt) → {bool|Description}

Indicates whether the Window or the Dialog has a cation.
Parameters:
Name Type Attributes Description
hasCaption bool <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
bool | Description

hasSizebox(hasSizeboxopt) → {bool|Description}

Indicates whether the Window or the Dialog has a sizebox.
Parameters:
Name Type Attributes Description
hasSizebox bool <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
bool | Description

hasSystemMenu(hasSystemMenuopt) → {bool|Description}

Indicates whether the Window or the Dialog has system menu.
Parameters:
Name Type Attributes Description
hasSystemMenu bool <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
bool | Description

isActive(isActiveopt) → {bool|Description}

Indicates whether the Window or the Dialog is active.
Parameters:
Name Type Attributes Description
isActive bool <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
bool | Description

isChildWindow(isChildWindowopt) → {bool|Description}

Indicates whether the window or the dialog is a child window/dialog.
Parameters:
Name Type Attributes Description
isChildWindow bool <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
bool | Description

isEnabled(isEnabledopt) → {bool|Description}

Indicates whether the object is enable.
Parameters:
Name Type Attributes Description
isEnabled bool <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
bool | Description

isFocused(isFocusedopt) → {bool|Description}

Indicates whether the object is focused.
Parameters:
Name Type Attributes Description
isFocused bool <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
bool | Description

isMaximizable(isMaximizableopt) → {bool|Description}

Indicates whether the Window or the Dialog is maximizable.
Parameters:
Name Type Attributes Description
isMaximizable bool <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
bool | Description

isMdiChildWindow(isMdiChildWindowopt) → {bool|Description}

Indicates whether the Window or the Dialog is MDI child window/dialog.
Parameters:
Name Type Attributes Description
isMdiChildWindow bool <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
bool | Description

isMinimizable(isMinimizableopt) → {bool|Description}

Indicates whether the Window or the Dialog is minimizable.
Parameters:
Name Type Attributes Description
isMinimizable bool <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
bool | Description

isOwnedWindow(isOwnedWindowopt) → {bool|Description}

Indicates whether the window or the dialog is an owned window/dialog.
Parameters:
Name Type Attributes Description
isOwnedWindow bool <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
bool | Description

isPopupWindow(isPopupWindowopt) → {bool|Description}

Indicates whether the Window or the Dialog is a popup window/dialog.
Parameters:
Name Type Attributes Description
isPopupWindow bool <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
bool | Description

isRightAligned(isRightAlignedopt) → {bool|Description}

Indicates whether the object is right aligned.
Parameters:
Name Type Attributes Description
isRightAligned bool <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
bool | Description

isRightToLeftLayout(isRightToLeftLayoutopt) → {bool|Description}

Indicates whether the object is Right to Left layout.
Parameters:
Name Type Attributes Description
isRightToLeftLayout bool <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
bool | Description

isRightToLeftReading(isRightToLeftReadingopt) → {bool|Description}

Indicates whether the object is Right to Left reading.
Parameters:
Name Type Attributes Description
isRightToLeftReading bool <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
bool | Description

isToolWindow(isToolWindowopt) → {bool|Description}

Indicates whether the Window or the Dialog is a tool window.
Parameters:
Name Type Attributes Description
isToolWindow bool <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
bool | Description

isTopmost(isTopmostopt) → {bool|Description}

Indicates whether the Window or the Dialog is top-most.
Parameters:
Name Type Attributes Description
isTopmost bool <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
bool | Description

isVisible(isVisibleopt) → {bool|Description}

Indicates whether the object is visible.
Parameters:
Name Type Attributes Description
isVisible bool <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
bool | Description

location(locationopt) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.
Parameters:
Name Type Attributes Description
location Point <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:
Name Type Attributes Description
nativeClass string <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(sizeopt) → {Size|Description}

The object's size in pixels.
Parameters:
Name Type Attributes Description
size Size <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(textopt) → {string|Description}

The text associated with the object.
Parameters:
Name Type Attributes Description
text string <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(windowClassRegExpopt) → {string|Description}

The permanent part of the MFC window class.
Parameters:
Name Type Attributes Description
windowClassRegExp string <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(windowExtendedStyleopt) → {WindowExtendedStyles|Description}

The extended window style of the object. The possible value is in the enum WindowExtendedStyles
Parameters:
Name Type Attributes Description
windowExtendedStyle WindowExtendedStyles <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(windowIdopt) → {Number|Description}

The object's window ID.
Parameters:
Name Type Attributes Description
windowId Number <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(windowStyleopt) → {WindowStyles|Description}

The window style of the object. The possible value is in the enum WindowStyles
Parameters:
Name Type Attributes Description
windowStyle WindowStyles <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(windowClassRegExpopt) → {string|Description}

The constant part of the window title.
Parameters:
Name Type Attributes Description
windowClassRegExp string <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