Attribute

Quick Facts

Property	Value
Class	`CENPyOlpAttribute`
Module	`cenpylib.CENPyOlpAttribute`
Package	`cenpylib`
Release	R2025.2.4
Methods	13
Subclasses	Attribute Bool, Attribute Double, Attribute Enum, Attribute Int, Attribute String, Attribute Table

Inheritance

Quick Start


# Boilerplate Example
attribute = ...  # obtained from the runtime context
result = attribute.GetVisibility()

Method Index

Method	Returns	Summary
`SetOlpProperty`	`—`	Sets Olp Property of attribute.
`GetVisibility`	`bool`	Get visibility status of attribute.
`SetVisibility`	`—`	Set visibility status of attribute.
`GetName`	`str`	Get name of attribute.
`SetName`	`—`	Set name of attribute.
`GetRecomputeEnterState`	`int`	Returns the enter state for recompute valid for this attribute.
`SetReComputeEnterState`	`—`	Sets the enter state for recompute for this attribute.
`IsValid`	`bool`	Checks if attribute is a valid olp attribute
`SetReadOnly`	`—`	Set readonly status of attribute.
`GetReadOnly`	`bool`	Get readonly status of attribute.
`SetIconName`	`—`	Set the icon name for this attribute.
`GetIconName`	`str`	Returns the icon name for this attribute
`SetTooltipKey`	`—`	Set the tooltipKey for this attribute.

Query Methods

`GetVisibility`


def GetVisibility() -> bool

Get visibility status of attribute.

Returns: bool — visibility status

`GetName`


def GetName() -> str

Get name of attribute.

Returns: str — name

`GetRecomputeEnterState`


def GetRecomputeEnterState() -> int

Returns the enter state for recompute valid for this attribute.

Returns: int — Recompute enter state.

`IsValid`


def IsValid() -> bool

Checks if attribute is a valid olp attribute

Returns: bool — True if valid, False if not valid or null

`GetReadOnly`


def GetReadOnly() -> bool

Get readonly status of attribute.

Returns: bool — readonly status

`GetIconName`


def GetIconName() -> str

Returns the icon name for this attribute

Returns: str — The icon for this attribute

Mutation Methods

`SetOlpProperty`


def SetOlpProperty(iOlpProperty: int)

Sets Olp Property of attribute.

Parameters:

Name	Type	Description
`iOlpProperty`	`int`	input of Olp Property, one or combination of following values can be given - USER_ATTRIBUTE \| PROCESS_ATTRIBUTE \| OPERATION_ATTRIBUTE \| OPERATION_GROUP_ATTRIBUTE \| GLOBAL_ATTRIBUTE

`SetVisibility`


def SetVisibility(visible: bool)

Set visibility status of attribute.

Parameters:

Name	Type	Description
`visible`	`bool`	input of visibility status

`SetName`


def SetName(name: str)

Set name of attribute.

Parameters:

Name	Type	Description
`name`	`str`	name of attribute

`SetReComputeEnterState`


def SetReComputeEnterState(recomputableEnterState: int)

Sets the enter state for recompute for this attribute.

Parameters:

Name	Type	Description
`recomputableEnterState`	`int`	Recompute enter state.

`SetReadOnly`


def SetReadOnly(readOnly: bool)

Set readonly status of attribute.

Parameters:

Name	Type	Description
`readOnly`	`bool`	input of readonly status

`SetIconName`


def SetIconName(iconName: str)

Set the icon name for this attribute. Attention: Currently this method has no effect in ActiveProgramDashboard and in ProgrammingDefaultsDashboard because the icons there are managed in settings.xml

Parameters:

Name	Type	Description
`iconName`	`str`	The icon to be used for this attribute

`SetTooltipKey`


def SetTooltipKey(tooltipKey: str)

Set the tooltipKey for this attribute.

Parameters:

Name	Type	Description
`tooltipKey`	`str`	Key for tooltip

Version Notes

This class is documented as of release R2025.2.4.

Was this page helpful?