new Calendar(propsopt) → {Calendar}
The description of a Calendar test object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props | Object |
<optional> | Initializes a Calendar test object using the supplied property bag. |
Returns:
the description object that was initialized.
- Type
- Calendar
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
date(dateopt) → {Date|Description}
The date of the Calendar test object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
date | Date | string |
<optional> | When provided, this method acts as a setter and sets the date value. If it is a string, the format must be must be conformed with the Date object of JavaScript. |
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored date value;
otherwise it returns 'this' for use with the builder pattern.
- Type
- Date | Description
isEnabled(isEnabledopt) → {boolean|Description}
Indicates whether the object is enable.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isEnabled | boolean |
<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:
| Name | Type | Attributes | Description |
|---|---|---|---|
isFocused | boolean |
<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
isRightAligned(isRightAlignedopt) → {boolean|Description}
Indicates whether the object is right aligned.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isRightAligned | boolean |
<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(isRightToLeftLayoutopt) → {boolean|Description}
Indicates whether the object is Right to Left layout.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isRightToLeftLayout | boolean |
<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(isRightToLeftReadingopt) → {boolean|Description}
Indicates whether the object is Right to Left reading.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isRightToLeftReading | boolean |
<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
isVisible(isVisibleopt) → {boolean|Description}
Indicates whether the object is visible.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
isVisible | boolean |
<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:
| 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
state(stateopt) → {CheckedState|Description}
The check box status of the Calendar test object.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
state | CheckedState |
<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 stored 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:
| 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
