WindowsCollection

class ansys.stk.core.uicore.WindowsCollection

Provide methods and properties to manage the windows.

Overview

Methods

item	Retrieve a window object.
arrange	Arranges the application windows using the specified style.
add	Create a new window. The bstrPluginID is a COM ProgID associated with an STK plugin.
get_item_by_index	Retrieve a window object by index in collection.
get_item_by_name	Retrieve a window object by name of window object.

Properties

count	Return a total number of window objects in the collection.
_new_enum	Enumerates the windows in the collection.

Import detail

from ansys.stk.core.uicore import WindowsCollection

Property detail

property WindowsCollection.count: int

Return a total number of window objects in the collection.

property WindowsCollection._new_enum: EnumeratorProxy

Enumerates the windows in the collection.

Method detail

WindowsCollection.item(self, index_or_caption: Any) → Window

Retrieve a window object.

Parameters:

index_or_caption : Any

Returns:

Window

WindowsCollection.arrange(self, arrange_style: WindowArrangeStyle) → None

Arranges the application windows using the specified style.

Parameters:

arrange_style : WindowArrangeStyle

Returns:

None

WindowsCollection.add(self, plugin_id: str, init_data: Any) → Window

Create a new window. The bstrPluginID is a COM ProgID associated with an STK plugin.

Parameters:

plugin_id : str

init_data : Any

Returns:

Window

WindowsCollection.get_item_by_index(self, index: int) → Window

Retrieve a window object by index in collection.

Parameters:

index : int

Returns:

Window

WindowsCollection.get_item_by_name(self, name: str) → Window

Retrieve a window object by name of window object.

Parameters:

name : str

Returns:

Window