Window

Window management object than can be used to represent a window on the desktop.

Constructor function.

var myObject = new Window();

var myObject = new Window(otherWindow);

1. otherWindow - (Window) other Window to copy

• (ParameterTypeError) incorrect parameter type
• (ParameterCountError) incorrect parameter count

Create an invalid Window.

var myObject = new Window();

Create a Window representing a copy of otherWindow.

var myObject = new Window(otherWindow);

Returns an array of Window representing all the windows on the desktop.

Window.all();

• (array) an array of Window

This example will print all the windows titles in the console.

var windows = Window.all();
for(var i = 0; i < windows.length; ++i)
    Console.print(windows[i].title() + "\n");

Searches for windows matching some criteria. Any omitted criteria is not used. Only windows matching all criteria are returned.

Window.find(parameters);

1. parameters - (object) search parameters
   • title - (string) window title
   • titleMode - (enum) see match modes for the list of possible values
   • titleCaseSensitive - (bool) set this to true if you want the title matching to be case sensitive
   • className - (string) window class name
   • classNameMode - (enum) see match modes for the list of possible values
   • classNameCaseSensitive - (bool) set this to true if you want the class name matching to be case sensitive
   • processId - (integer) set this to a process id to get only windows owned by this process
   • process - (ProcessHandle) set this to an instance of a ProcessHandle id to get only windows owned by this process

• (array) an array of found Window

• (ProcessHandleError) invalid ProcessHandle

Find the window called "Notepad".

var windows = Window.find({
	title: "Notepad"
});

Find the windows whose title starts with "Notepad", using wildcards.

var windows = Window.find({
	title: "Notepad*",
	titleMode: Window.Wildcard
});

You can use the following code to show the title of all found windows :

for(var i = 0; i < windows.length; ++i)
	Console.print(windows[i].title() + "\n");

Returns a copy of this Window.

myObject.clone();

• (Window) a copy of this Window

var copyOfMyObject = myObject.clone();

Returns true if this Window and another are referencing the same window.

myObject.equals(other);

1. other - (Window) another Window

• (bool) true if other is referencing the same window

if(myFirstObject.equals(mySecondObject))
	//Do something

Returns a string representing this Window.

myObject.toString();

• (string) a string representing this Window

Console.print(myObject.toString());

This method is automatically called when trying to convert a Window to a string.

Returns true if this Window is referencing a window, false otherwise.

myObject.isValid();

• (bool) true if this Window is referencing a window

if(myObject.isValid())
	//Do something

Returns the title of the current window.

myObject.title();

• (string) the title of the referenced window

• (InvalidWindowError) invalid Window

Console.print(myObject.title());

Returns the class name of the current window.

myObject.className();

• (string) the class name of the referenced window

• (InvalidWindowError) invalid Window

Console.print(myObject.className());

Returns true if this Window is the foreground Window, false otherwise.

myObject.isActive();

• (bool) true if this Window is the foreground Window

• (InvalidWindowError) invalid Window

Returns a Rect representing the rectangle of the window.

myObject.rect();

myObject.rect(useBorders);

- useBorders - (bool) use window borders when resizing the window (default: true) [Added in Actionaz 3.2.0.]

• (Rect) a Rect representing the rectangle of the window

• (InvalidWindowError) invalid Window

Returns a ProcessHandle representing the process owning the window.

myObject.process();

• (ProcessHandle) a ProcessHandle representing the process owning the window

• (InvalidWindowError) invalid Window

Close this window.

myObject.close();

• (Window) this Window

• (InvalidWindowError) invalid Window
• (CloseWindowError) unable to close the window

Kill the process owning this window.

myObject.killCreator();

• (Window) this Window

• (InvalidWindowError) invalid Window
• (KillCreatorError) unable to kill the the window owner

Set this window to the foreground.

myObject.setForeground();

• (Window) this Window

• (InvalidWindowError) invalid Window
• (SetForegroundError) unable to set this window to the foreground

Minimize the window.

myObject.minimize();

• (Window) this Window

• (InvalidWindowError) invalid Window
• (MinimizeError) unable to minimize the window

Maximize the window.

myObject.maximize();

• (Window) this Window

• (InvalidWindowError) invalid Window
• (MaximizeError) unable to maximize the window

Move the window.

myObject.move(point);

1. point - (Point) point where to move the window

• (Window) this Window

• (InvalidWindowError) invalid Window
• (MoveError) unable to move the window

Resize the window.

myObject.resize(size);

myObject.resize(size, useBorders);

1. size - (Size) the new size of the window
2. useBorders - (bool) use window borders when resizing the window (default: true) [Added in Actionaz 3.2.0.]

• (Window) this Window

• (InvalidWindowError) invalid Window
• (ResizeError) unable to resize the window

Match modes for the find function.

1. RegExp: search using regular expressions
2. Wildcard: search using wildcards
3. WildcardUnix: search using Unix type wildcards
4. FixedString: search using a fixed string

Find the windows whose title starts with "Notepad", using wildcards.

var windows = Window.find({
	title: "Notepad*",
	titleMode: Window.Wildcard
});