Top  | Previous | Next

Window Properties

Special Properties

Windows have some special properties that you can edit while the window is closed. These properties are modified by right-clicking on the window in the Project Browser.

Name

The name of the window. Must be unique in its folder.

Open on Startup

Windows with this property set to true will be opened when the project starts up in the Vision Client.

"About" Window

At most one window per project may specify an "about" window. This will cause an "About this Application" menu item to appear in the "Help" menu in the Client, which opens the appropriate window.

Dynamic Startup Windows

Sometimes a project needs to alter its startup windows depending on who logged in, what security roles the have, or what computer the client is launched on. In these cases, simply set no startup windows, and write a Client Startup Script that uses the system.nav library to open the correct windows.

Standard Properties

These properties are modified in the Property Editor panel, just like a component's properties. Simply select the window either by clicking on its title bar, or clicking on the window's node in the Project Browser while it is open to select it in the Property Editor.

 

Appearance

Title

The title to be displayed in this window's titlebar.

Scripting name

title

Data type

String

Border Display Policy

Determines if window's border is shown in various window states.

Scripting name

borderDisplayPolicy

Data type

int

Values

0

Always

1

Never

2

When Not Maximized

Titlebar Display Policy

Determines if window's titlebar is shown in various window states.

Scripting name

titlebarDisplayPolicy

Data type

int

Values

0

Always

1

Never

2

When Not Maximized

Titlebar Height

The height of the window's titlebar.

Scripting name

titlebarHeight

Data type

int

Titlebar Font

The font of the window title in the titlebar.

Scripting name

titlebarFont

Data type

Font

Behavior

Dock Position

Determines the position this window is docked to, or if it is floating.

Scripting name

dockPosition

Data type

int

Values

0

Floating

3

West

4

South

2

East

1

North

Closable

Determines whether or not to draw the close (X) button in the upper right corner.

Scripting name

closable

Data type

boolean

Maximizable

Determines whether or not to draw the maximize button in the upper right corner.

Scripting name

maximizable

Data type

boolean

Resizeable

Determines whether or not to let the user resize the window.

Scripting name

resizable

Data type

boolean

Start Maximized

When set to true, the window will become maximized when it is opened.

Scripting name

startMaximized

Data type

boolean

Cache Policy

By default this property is set to Auto, which keeps a window in a memory cache for a while after it is closed, so that if it is opened again it will be quick. The window isn't "active" while it is closed: all of its bindings and scripts are shut down.

Setting this property to Never causes a fresh copy of the window to be deserialized every time it is opened. This is a performance hit, but it also is a convenient way to "clear out" the values of the window from the last time it was opened, which can be helpful in data-entry screens.

Setting the property to Always will trade memory for higher performance, causing the window to always remain cached after the first time it is opened. This means the window will open very fast, but your Client will need lots of memory if you do this to a large amount of windows.

Scripting name

cachePolicy

Data type

int

Flags

expert

Values

0

Auto

1

Never

2

Always

Layout

Location

The location that this window will open up at. Only applicable to floating windows that are not set to start maximized. Also, you must un-check the "Center Window" checkbox on the open-window navigation action in order for this location to take effect

Scripting name

startingLocation

Data type

Point

Size

The dimensions of the window. This can be manipulated by selecting the window and dragging the resize handles along the windows right and bottom edges.

Scripting name

size

Data type

Dimension

Minimum Size

The minimum size that this window will allow itself to be resized to.

Scripting name

minimumSize

Data type

Dimension

Flags

expert

Maximum Size

The maximum size that this window will allow itself to be resized to.

Scripting name

maximumSize

Data type

Dimension

Flags

expert

Layer

Sets the layer that this window is in. Default layer is 0, which is the bottom layer. Windows in higher layers will always be shown on top of windows in layers beneath them.

Scripting name

layer

Data type

int

Flags

expert