Tool Event
Quick Facts
| Property | Value |
|---|---|
| Class | CENPyOlpToolEvent |
| Module | cenpylib.CENPyOlpToolEvent |
| Package | cenpylib |
| Release | R2025.2.4 |
| Methods | 3 |
| Inherits from | CENPyOlpBuiltInEvent |
Inheritance
Quick Start
# Boilerplate Example
# Acquire the event object from the runtime context
toolEvent = ... # provided by the frameworkMethod Index
| Method | Returns | Summary |
|---|---|---|
On | — | Set tool state to ON. |
Off | — | Set tool state to OFF. |
GetState | bool | Get the tool state. |
Query Methods
GetState
def GetState() -> boolGet the tool state.
Returns: bool — Tool state.
Utilities
On
def On()Set tool state to ON.
Off
def Off()Set tool state to OFF.
Version Notes
This class is documented as of release R2025.2.4.
Was this page helpful?