ProgressBarEventArguments

class ansys.stk.core.stkobjects.ProgressBarEventArguments

Represents a structure used by the Percent Complete events.

Overview

Methods

cancel

Cancel a lengthy operation.

Properties

canceled	Return whether the lengthy operation has been canceled.
can_cancel	Return whether the lengthy operation can be canceled.
percent_completed	Return the current progress status. The value returned is greater or equal to 0 and less or equal to 100.
message	Get a progress message.

Import detail

from ansys.stk.core.stkobjects import ProgressBarEventArguments

Property detail

property ProgressBarEventArguments.canceled: bool

Return whether the lengthy operation has been canceled.

property ProgressBarEventArguments.can_cancel: bool

Return whether the lengthy operation can be canceled.

property ProgressBarEventArguments.percent_completed: int

Return the current progress status. The value returned is greater or equal to 0 and less or equal to 100.

property ProgressBarEventArguments.message: str

Get a progress message.

Method detail

ProgressBarEventArguments.cancel(self) → None

Cancel a lengthy operation.

Returns:

None