pycatia.funct_system_interfaces.functional_system_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.funct_system_interfaces.functional_system_setting_att.FunctionalSystemSettingAtt(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
FunctionalSystemSettingAtt

Enables attribute access to PFD options.
property document_content_at_creation: int

Note

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

Returns or sets the DocumentContentAtCreation parameter.

Parameters:

iDocumentContentAtCreation
oDocumentContentAtCreation Document Content At Creation Attribute
Legal values:
0 : Sample elements
1: empty

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Return type:

int

property functional_action_presentation: int

Note

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

Returns or sets the FunctionalActionPresentation
parameter.

Parameters:

iDocumentContentAtCreation
or oDocumentContentAtCreation Functional Action Presentation Legal
values:
0 : A : Action
1: SAO : Subject Action Object
2: ASO : Action Subject Object

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Return type:

int

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

Note

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

Retrieves environment informations for the DocumentContentAtCreation
parameter.
Role:Retrieves the state of the DocumentContentAtCreation 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_functional_action_presentation_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the FunctionalActionPresentation
parameter.
Role:Retrieves the state of the FunctionalActionPresentation 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_show_parameters_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the ShowParameters
parameter.
Role:Retrieves the state of the ShowParameters 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_show_relations_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the ShowRelations
parameter.
Role:Retrieves the state of the ShowRelations 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_show_synchro_status_of_local_param_cache_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the
ShowSynchroStatusOfLocalParamCache parameter.
Role:Retrieves the state of the ShowSynchroStatusOfLocalParamCache
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_split_functional_object_name_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the SplitFunctionalObjectName
parameter.
Role:Retrieves the state of the SplitFunctionalObjectName 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_string_used_as_carriage_return_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the StringUsedAsCarriageReturn
parameter.
Role:Retrieves the state of the StringUsedAsCarriageReturn 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_type_of_icon_on_functional_element_info(io_admin_level: str, io_locked: str) → bool

Note

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

Retrieves environment informations for the TypeOfIconOnFunctionalElement
parameter.
Role:Retrieves the state of the TypeOfIconOnFunctionalElement 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

set_document_content_at_creation_lock(i_locked: bool) → None

Note

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

Locks or unlocks the DocumentContentAtCreation parameter.
Role:Locks or unlocks the DocumentContentAtCreation 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.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_functional_action_presentation_lock(i_locked: bool) → None

Note

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

Locks or unlocks the FunctionalActionPresentation
parameter.
Role:Locks or unlocks the FunctionalActionPresentation 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.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_show_parameters_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ShowParameters parameter.
Role:Locks or unlocks the ShowParameters 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.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_show_relations_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ShowRelations parameter.
Role:Locks or unlocks the ShowRelations 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.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_show_synchro_status_of_local_param_cache_lock(i_locked: bool) → None

Note

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

Locks or unlocks the ShowSynchroStatusOfLocalParamCache
parameter.
Role:Locks or unlocks the ShowSynchroStatusOfLocalParamCache 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.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_split_functional_object_name_lock(i_locked: bool) → None

Note

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

Locks or unlocks the SplitFunctionalObjectName parameter.
Role:Locks or unlocks the SplitFunctionalObjectName 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.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

set_string_used_as_carriage_return_lock(i_locked: bool) → None

Note

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

Locks or unlocks the StringUsedAsCarriageReturn parameter.
Role:Locks or unlocks the StringUsedAsCarriageReturn 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_type_of_icon_on_functional_element_lock(i_locked: bool) → None

Note

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

Locks or unlocks the TypeOfIconOnFunctionalElement
parameter.
Role:Locks or unlocks the TypeOfIconOnFunctionalElement 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.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_locked (bool) –

Return type:

None

property show_parameters: int

Note

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

Returns or sets the ShowParameters parameter.

Parameters:

iShowParameters
or oShowParameters Show Parameters Legal values:
False :
True:

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Return type:

int

property show_relations: int

Note

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

Returns or sets the ShowRelations parameter.

Parameters:

iShowRelations
or oShowRelations Show Relations Legal values:
False :
True:
Return type:

int

property show_synchro_status_of_local_param_cache: int

Note

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

Returns or sets the ShowSynchroStatusOfLocalParamCache
parameter.

Parameters:

iShowSynchroStatusOfLocalParamCache
or oShowSynchroStatusOfLocalParamCache Show Synchronisation Status
OfLocal Parameter Cache Legal values:
False :
True :
Return type:

int

property split_functional_object_name: int

Note

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

Returns or sets the SplitFunctionalObjectName parameter.

Parameters:

iSplitFunctionalObjectName
or oSplitFunctionalObjectName Legal values:
False : don’t split functional object name
True : split Functional object name

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Return type:

int

property string_used_as_carriage_return: str

Note

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

Returns or sets the StringUsedAsCarriageReturn parameter.

Parameters:

iStringUsedAsCarriageReturn
or oStringUsedAsCarriageReturn String Used As Carriage Return


Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Return type:

str

property type_of_icon_on_functional_element: int

Note

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

Returns or sets the TypeOfIconOnFunctionalElement
parameter.

Parameters:

iTypeOfIconOnFunctionalElement
or oTypeOfIconOnFunctionalElement Type Of Icon On Functional
Elements Legal values:
0 : indicate a current association with PPR links.
1: indicate a current generative script.
Return type:

int