pycatia.dmaps_interfaces.tree_tab_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.dmaps_interfaces.tree_tab_setting_att.TreeTabSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
TreeTabSettingAtt
property applicative_data_filter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ApplicativeDataFilter() As long

Returns of sets the value to signify Whether “Applicative Data” created by
an application is visible in the PPR tree
Role: Returns or sets the value of “Applicative Data” option to signify
whether the applicative containers are visualized in the PPR tree
Return type:

int

property assigned_viewer: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AssignedViewer() As long

Returns or sets the value to signify whether the 3D Assigned Viewer is
default viewer or not
Role: Returns or sets the value to signify whether 3D Assigned Viewer is
default viewer or not
Return type:

int

property attributes_filter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property AttributesFilter() As long

Returns or sets the value for “Attributes” option
Role: Returns or sets the value of “Attributes” option to signify whether
the ‘User Attributes’ of an Activity is visualized in the PPR tree
Return type:

int

property collapse_expand_filter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property CollapseExpandFilter() As long

Returns or sets the value to signify Whether the double clicking on an
activity expands/collapses a given activity in the PPR
tree
Role: Returns or sets the value to signify Whether the double clicking on
an activity expands/collapses a given activity in the PPR tree
Return type:

int

property display_name_mode: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property DisplayNameMode() As long

Returns or sets the value to signify whether the E5 Configured Name is to
be displayed
Role: Returns or sets the value to signify whether the E5 Configured Name
is to be displayed
Return type:

int

property display_order: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property DisplayOrder() As long

Returns or sets the value for ‘Display Order’
Role: Returns or sets the value of ‘Display Order’ to signify which order
the product/resource list are in the PPR tree
Return type:

int

property display_process_order: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property DisplayProcessOrder() As long

Returns or sets the value for ‘Display Order for
Processes’
Role: Returns or sets the value of ‘Display Order for Processes’ to signify
which order the processes under ProcessList and ResourcesList are listed in the
PPR tree. Legal values:
1 : manufacturing hub order
0 : loaded order
Return type:

int

get_applicative_data_filter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetApplicativeDataFilterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Applicative Data”
parameter.
Role:Retrieves the state of the “Applicative Data” parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_assigned_viewer_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAssignedViewerInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Assigned Viewer”
parameter.
Role:Retrieves the state of the “Assigned Viewer” parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_attributes_filter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAttributesFilterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Attributes”
parameter.
Role:Retrieves the state of the “Attributes” parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_collapse_expand_filter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetCollapseExpandFilterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Disable Collapse/Expand”
parameter.
Role:Retrieves the state of the “Disable Collapse/Expand” parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_display_name_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetDisplayNameModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Display Name Mode”
parameter.
Role:Retrieves the state of the “Display Name Mode” parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_display_order_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetDisplayOrderInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ‘Display Order’
parameter.
Role:Retrieves the state of the ‘Display Order’ parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_display_process_order_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetDisplayProcessOrderInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ‘Display Order for Processes’
parameter.
Role:Retrieves the state of the ‘Display Order for Processes’ parameter in
the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_items_filter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetItemsFilterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ‘Items Folder’
parameter.
Role:Retrieves the state of the ‘Items Folder’ parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_items_per_relation_filter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetItemsPerRelationFilterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ‘Items Folder(Per Relation
Type)’ parameter.
Role:Retrieves the state of the ‘Items Folder(Per Relation Type)’ parameter
in the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_logical_act_filter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLogicalActFilterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Logical Activities”
parameter.
Role:Retrieves the state of the “Logical Activities” parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_output_product_filter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetOutputProductFilterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Output Products Folder”
parameter.
Role:Retrieves the state of the “Output Products Folder” parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_paste_same_instance_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPasteSameInstanceInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment information for the ‘Paste Same Instance’
parameter.
Role:Retrieves the state of the ‘Paste Same Instance’ parameter in the
current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_render_style_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetRenderStyleInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the “Render Style”
parameter.
Role:Retrieves the state of the “Render Style” parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_resource_filter_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetResourceFilterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ‘Resource Folder’
parameter.
Role:Retrieves the state of the ‘Resource Folder’ parameter in the current
environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.

ioLocked
Indicates if the parameter has been locked.

Returns:
Indicates if the parameter has been explicitly modified or remain to
the administrated value.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

property items_filter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ItemsFilter() As long

Returns or sets the value for ‘Items Folder’
Role: Returns or sets the value of ‘Items Folder’ to signify whether the
‘Assigned Items’ are visualized in the PPR tree
Return type:

int

property items_per_relation_filter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ItemsPerRelationFilter() As long

Returns or sets the value for ‘Items Folder (Per Relation
Type)’
Role: Returns or sets the value of ‘Items Folder(Per Relation Type)’ to
signify whether the ‘Assigned Items’with proper relations ( like First
Processes Product) are visualized in the PPR tree
Return type:

int

property logical_act_filter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LogicalActFilter() As long

Returns or sets the value to signify Whether the logical activites are
visible in the PPR tree
Role: Returns or sets the value of “Logical Activities” option to signify
whether the logical activites are visible in the PPR tree
Return type:

int

property output_product_filter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property OutputProductFilter() As long

Returns of sets the value to signify Whether “Output Products” assigned to
a given activity is visible in the PPR tree
Role: Returns or sets the value of “Output Products Folder” option to
signify whether the output products associated with an activity are visualized
in the PPR tree
Return type:

int

property paste_same_instance: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PasteSameInstance() As long

Returns or sets the value for ‘Paste Same Instance’
Role: Returns or sets the value of ‘Paste Same Instance’ to signify whether
a same product instance in the target process document should be reused or not.
Legal values:
1 : Always paste an instance and do not reuse existing one
0 : Reuse existing instance wherever possible
Return type:

int

property render_style: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RenderStyle() As long

Returns or sets the value to signify whether the 3D Render Style is
Parallel or Perspective
Role: Returns or sets the value to signify whether the 3D Render Style is
Parallel or Perspective
Return type:

int

property resource_filter: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ResourceFilter() As long

Returns or sets the value for ‘Resources Folder’
Role: Returns or sets the value of ‘Resources Folder’ to signify whether
the ‘Assigned Resources’ are visualized in the PPR tree
Return type:

int

set_applicative_data_filter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetApplicativeDataFilterLock(boolean iLocked)

Locks or unlocks the “Applicative Data” parameter.
Role:Locks or unlocks the “Attributes” parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_assigned_viewer_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAssignedViewerLock(boolean iLocked)

Locks or unlocks the “Assigned Viewer” parameter.
Role:Locks or unlocks the “Assigned Viewer” parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_attributes_filter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAttributesFilterLock(boolean iLocked)

Locks or unlocks the “Attributes” parameter.
Role:Locks or unlocks the “Attributes” parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_collapse_expand_filter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetCollapseExpandFilterLock(boolean iLocked)

Locks or unlocks the “Disable Collapse/Expand” parameter.
Role:Locks or unlocks the “Disable Collapse/Expand” parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_display_name_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDisplayNameModeLock(boolean iLocked)

Locks or unlocks the “Display Name Mode” parameter.
Role:Locks or unlocks the “Display Name Mode” parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_display_order_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDisplayOrderLock(boolean iLocked)

Locks or unlocks the ‘Display Order’ parameter.
Role:Locks or unlocks the ‘Display Order’ parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_display_process_order_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetDisplayProcessOrderLock(boolean iLocked)

Locks or unlocks the ‘Display Order for Processes’
parameter.
Role:Locks or unlocks the ‘Display Order for Processes’ parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_items_filter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetItemsFilterLock(boolean iLocked)

Locks or unlocks the ‘Items Folder’ parameter.
Role:Locks or unlocks the ‘Items Folder’ parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_items_per_relation_filter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetItemsPerRelationFilterLock(boolean iLocked)

Locks or unlocks the ‘Items Folde(Per Relation Type)r’
parameter.
Role:Locks or unlocks the ‘Items Folder(Per Relation Type)’ parameter if it
is possible in the current administrative context. In user mode this method
will always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_logical_act_filter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLogicalActFilterLock(boolean iLocked)

Locks or unlocks the “Logical Activities” parameter.
Role:Locks or unlocks the “Logical Activities” parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_output_product_filter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetOutputProductFilterLock(boolean iLocked)

Locks or unlocks the “Output Products Folder” parameter.
Role:Locks or unlocks the “Output Products Folder” parameter if it is
possible in the current administrative context. In user mode this method will
always return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_paste_same_instance_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPasteSameInstanceLock(boolean iLocked)

Locks or unlocks the ‘Paste Same Instance’ parameter.
Role:Locks or unlocks the ‘Paste Same Instance’ parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_render_style_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetRenderStyleLock(boolean iLocked)

Locks or unlocks the “Render Style” parameter.
Role:Locks or unlocks the “Render Style” parameter if it is possible in the
current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None

set_resource_filter_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetResourceFilterLock(boolean iLocked)

Locks or unlocks the ‘Resource Folder’ parameter.
Role:Locks or unlocks the ‘Resource Folder’ parameter if it is possible in
the current administrative context. In user mode this method will always return
E_FAIL.

Parameters:

iLocked
the locking operation to be performed Legal
values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Parameters:

i_locked (bool) –

Return type:

None