`MdiArea`

The Collection of sub windows in the main window.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Create a large cuboid

cube = project.Contents.Geometry:AddCuboid(cf.Point(0,0,0), 10, 10, 10)

    -- Get the first view

view1 = application.MainWindow.MdiArea[1]

    -- Zoom to extents on the view

view1.ViewWindow.View:ZoomToExtents()

Inheritance

The MdiArea object is derived from the Object object.

Usage locations

The MdiArea object can be accessed from the following locations:

Collection lists
- MainWindow object has collection MdiArea.

Property List

AbsoluteFilePath: The full path of the project file (directory path and file name including the file extension). (Read only string)
AbsolutePath: The full directory path of the project file (directory path excluding the file name and extension). (Read only string)
Count: The number of MdiSubWindow items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

CascadeWindows (): Cascade the windows.
CloseAllWindows (): Close all windows.
CloseWindow (window MdiSubWindow): Close specified window.
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Item (index number): Returns the MdiSubWindow for the given index in the collection. (Returns a MdiSubWindow object.)
Item (label string): Returns the MdiSubWindow for the given label in the collection. (Returns a MdiSubWindow object.)
Items (): Returns a table of MdiSubWindow items. (Returns a UnsupportedType(List of MdiSubWindow) object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
TileWindows (): Tile the windows.
UniqueName (label string): Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a string object.)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

AbsoluteFilePath

The full path of the project file (directory path and file name including the file extension).

Type: string
Access: Read only

AbsolutePath

The full directory path of the project file (directory path excluding the file name and extension).

Type: string
Access: Read only

Count

The number of MdiSubWindow items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

CascadeWindows ()

Cascade the windows.

CloseAllWindows ()

Close all windows.

CloseWindow (window MdiSubWindow)

Close specified window.

Input Parameters

window(MdiSubWindow): The window to close.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the item.

Return

boolean: The success of the check.

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

Item (index number)

Returns the MdiSubWindow for the given index in the collection.

Input Parameters

index(number): The index of the MdiSubWindow.

Return

MdiSubWindow: The item in the collection

Item (label string)

Returns the MdiSubWindow for the given label in the collection.

Input Parameters

label(string): The label of the MdiSubWindow.

Return

MdiSubWindow: The item in the collection

Items ()

Returns a table of MdiSubWindow items.

Return

UnsupportedType(List of MdiSubWindow): The list of items in the collection

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

TileWindows ()

Tile the windows.

UniqueName (label string)

Generates a unique name base of the provided base name. If the base name already exists in the collection, a digit will be appended until a valid name is generated.

Input Parameters

label(string): The base name.

Return

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.