pycatia.in_interfaces.documentation_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.in_interfaces.documentation_setting_att.DocumentationSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
DocumentationSettingAtt

Setting controller for the Help property tab page.
Role: This interface is implemented by a component which represents the
controller of the documentation settings.
property companion_path: str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property CompanionPath() As CATBSTR

Returns the User Companion location (path) parameter.
Return type:

str

property doc_language: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property DocLanguage() As long

Returns the technical documentation language parameter.
Return type:

int

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetCompanionPathInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetDocLanguageInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetPriorityInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func GetTechnicalDocumentationPathInfo(CATBSTR
ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the technical documentation location
parameter.
Role:Retrieves the state of the technical documentation location 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 priority: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Priority() As CATDocContextualPriority

Returns the contextual priority parameter.
Returns:

enum cat_doc_contextual_priority

Return type:

int

set_companion_path_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetCompanionPathLock(boolean iLocked)

Locks or unlocks the User Companion location parameter.
Role:Locks or unlocks the User Companion location 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_doc_language_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetDocLanguageLock(boolean iLocked)

Locks or unlocks the technical documentation language
parameter.
Role:Locks or unlocks the technical documentation language 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_priority_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetPriorityLock(boolean iLocked)

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

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetTechnicalDocumentationPathLock(boolean iLocked)

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

property technical_documentation_path: str

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property TechnicalDocumentationPath() As CATBSTR

Returns the technical documentation location (path) parameter.
Return type:

str