pycatia.dnb_work_interfaces.work_general_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.dnb_work_interfaces.work_general_setting_att.WorkGeneralSettingAtt(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

WorkGeneralSettingAtt

Interface representing xxx.

Role: Components that implement DNBIAWorkGeneralSettingAtt are

…

Do not use the DNBIAWorkGeneralSettingAtt interface for such and such

ClassReference, Class#MethodReference, #InternalMethod…

property annotation_activity: bool¶

Note

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

Returns or sets the AnnotationActivity parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:: bool

property dnbwi_num_column_list: tuple¶

Note

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

Returns the DNBWINumColumnList parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:: tuple

get_annotation_activity_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the AnnotationActivity

parameter.

Role:Retrieves the state of the AnnotationActivity 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_dnbwi_num_column_list_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DNBWINumColumnList

parameter.

Role:Retrieves the state of the DNBWINumColumnList 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_move_activity_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MoveActivity

parameter.

Role:Retrieves the state of the MoveActivity 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_style_sheet_path_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the StyleSheetPath

parameter.

Role:Retrieves the state of the StyleSheetPath 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_text_activity_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the TextActivity

parameter.

Role:Retrieves the state of the TextActivity 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_view_point_activity_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewPointActivity

parameter.

Role:Retrieves the state of the ViewPointActivity 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_visibility_activity_info(io_admin_level: str, io_locked: str) → bool¶

Note

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

CATBSTR ioLocked) As boolean

Retrieves environment informations for the VisibilityActivity

parameter.

Role:Retrieves the state of the VisibilityActivity 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 move_activity: bool¶

Note

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

Returns or sets the MoveActivity parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:: bool

set_annotation_activity_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the AnnotationActivity parameter.

Role:Locks or unlocks the AnnotationActivity 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_dnbwi_num_column_list_lock(i_locked: bool) → None¶

Note

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

Parameters:: i_locked (bool) –
Return type:: None

set_move_activity_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the MoveActivity parameter.

Role:Locks or unlocks the MoveActivity 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_style_sheet_path_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the StyleSheetPath parameter.

Role:Locks or unlocks the StyleSheetPath 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_text_activity_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the TextActivity parameter.

Role:Locks or unlocks the TextActivity 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_view_point_activity_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the ViewPointActivity parameter.

Role:Locks or unlocks the ViewPointActivity 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_visibility_activity_lock(i_locked: bool) → None¶

Note

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

Locks or unlocks the VisibilityActivity parameter.

Role:Locks or unlocks the VisibilityActivity 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 style_sheet_path: str¶

Note

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

Returns or sets the StyleSheetPath parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:: str

property text_activity: bool¶

Note

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

Returns or sets the TextActivity parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:: bool

property view_point_activity: bool¶

Note

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

Returns or sets the ViewPointActivity parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:: bool

property visibility_activity: bool¶

Note

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

Returns or sets the VisibilityActivity parameter.

Ensure consistency with the C++ interface to which the work is delegated.

Return type:: bool

pycatia.dnb_work_interfaces.work_general_setting_att¶

Navigation

Related Topics