ToolbarCollection

class ansys.stk.core.uicore.ToolbarCollection

Provide methods and properties to manage the toolbars.

Overview

Methods

get_item_by_index	Retrieve a toolbar object based on the index in the collection.
get_item_by_name	Retrieve a toolbar object based on the name of the Toolbar in the collection.
get_toolbar_by_id	Return a toolbar object with the specified toolbar identifier. The identifier is a unique number assigned to a toolbar object.
item	Retrieve a toolbar object.

Properties

_new_enum	Enumerates the toolbars in the collection.
count	Return a total number of toolbars in the collection.

Import detail

from ansys.stk.core.uicore import ToolbarCollection

Property detail

property ToolbarCollection._new_enum: EnumeratorProxy

Enumerates the toolbars in the collection.

property ToolbarCollection.count: int

Return a total number of toolbars in the collection.

Method detail

ToolbarCollection.get_item_by_index(self, index: int) → Toolbar

Retrieve a toolbar object based on the index in the collection.

Parameters:

index : int

Returns:

Toolbar

ToolbarCollection.get_item_by_name(self, name: str) → Toolbar

Retrieve a toolbar object based on the name of the Toolbar in the collection.

Parameters:

name : str

Returns:

Toolbar

ToolbarCollection.get_toolbar_by_id(self, id: int) → Toolbar

Return a toolbar object with the specified toolbar identifier. The identifier is a unique number assigned to a toolbar object.

Parameters:

id : int

Returns:

Toolbar

ToolbarCollection.item(self, index_or_caption: Any) → Toolbar

Retrieve a toolbar object.

Parameters:

index_or_caption : Any

Returns:

Toolbar