pycatia.drafting_2dL_interfaces.layout_2d_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.drafting_2dL_interfaces.layout_2d_setting_att.Layout2DSettingAtt(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

Layout2DSettingAtt

The interface to access a CATIA2DLSettingAtt.

property activate_2d_mode: bool

Note

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

o Property Activate2DMode() As boolean

Returns the Activate2DMode parameter.

Return type:

bool

property back_clipping_plane: bool

Note

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

o Property BackClippingPlane() As boolean

Returns the BackClippingPlane parameter.

Return type:

bool

property boundaries_2dl_display: bool

Note

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

o Property Boundaries2DLDisplay() As boolean

Returns the Boundaries2DLDisplay parameter.

Return type:

bool

property boundaries_2dl_line_type: int

Note

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

o Property Boundaries2DLLineType() As long

Returns the Boundaries2DLLineType parameter.

Return type:

int

property boundaries_2dl_thickness: int

Note

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

o Property Boundaries2DLThickness() As long

Returns the Boundaries2DLThickness parameter.

Return type:

int

property callout_creation_dialog_box: bool

Note

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

o Property CalloutCreationDialogBox() As boolean

Returns the CalloutCreationDialogBox parameter.

Return type:

bool

property callout_creation_in_active_view: bool

Note

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

o Property CalloutCreationInActiveView() As boolean

Returns the CalloutCreationInActiveView parameter.

Return type:

bool

property clipping_frame: bool

Note

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

o Property ClippingFrame() As boolean

Returns the ClippingFrame parameter.

Return type:

bool

property clipping_frame_reframe_on_mode: int

Note

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

o Property ClippingFrameReframeOnMode() As

CatClippingFrameReframeOnMode

Returns the ClippingFrameReframeOnMode parameter.

Deprecated:

V5R18

Returns:

enum cat_clipping_frame_reframe_on_mode

Return type:

int

property clipping_view_outline_linetype: int

Note

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

o Property ClippingViewOutlineLinetype() As long

Returns the ClippingViewOutlineLinetype parameter.

Return type:

int

property clipping_view_outline_thickness: int

Note

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

o Property ClippingViewOutlineThickness() As long

Returns the ClippingViewOutlineThickness parameter.

Return type:

int

property create_associative_use_edges: bool

Note

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

o Property CreateAssociativeUseEdges() As boolean

Returns the CreateAssociativeUseEdges parameter.

Return type:

bool

property dedicated_filter_type: int

Note

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

o Property DedicatedFilterType() As CatDedicatedFilterType

Returns the DedicatedFilterType parameter.

Returns:

enum cat_dedicated_filter_type

Return type:

int

property display_back_and_cutting_plane: bool

Note

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

o Property DisplayBackAndCuttingPlane() As boolean

Returns the DisplayBackAndCuttingPlane parameter.

Return type:

bool

property display_clipping_outline: bool

Note

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

o Property DisplayClippingOutline() As boolean

Returns the DisplayClippingOutline parameter.

Return type:

bool

property edit_dedicated_filter_dialog_box: bool

Note

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

o Property EditDedicatedFilterDialogBox() As boolean

Returns the EditDedicatedFilterDialogBox parameter.

Return type:

bool

property fit_all_in_sheet_format: bool

Note

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

o Property FitAllInSheetFormat() As boolean

Returns the FitAllInSheetFormat parameter.

Return type:

bool

get_activate_2d_mode_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetActivate2DModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the Activate2DMode

parameter.

Role:Retrieves the state of the Activate2DMode 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) –

• o_modified (bool) –

Return type:

None

get_back_clipping_plane_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetBackClippingPlaneInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the BackClippingPlane

parameter.

Role:Retrieves the state of the BackClippingPlane 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) –

• o_modified (bool) –

Return type:

None

get_boundaries_2dl_colour(o_value_r: int, o_value_g: int, o_value_b: int) → None

Note

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

o Sub GetBoundaries2DLColor(long oValueR,

long oValueG,

long oValueB)

Returns the Boundaries2DLColor parameter.

Parameters:

• o_value_r (int) –

• o_value_g (int) –

• o_value_b (int) –

Return type:

None

get_boundaries_2dl_colour_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetBoundaries2DLColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the Boundaries2DLColor

parameter.

Role:Retrieves the state of the Boundaries2DLColor 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) –

• o_modified (bool) –

Return type:

None

get_boundaries_2dl_display_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetBoundaries2DLDisplayInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the Boundaries2DLDisplay

parameter.

Role:Retrieves the state of the Boundaries2DLDisplay 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) –

• o_modified (bool) –

Return type:

None

get_boundaries_2dl_line_type_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetBoundaries2DLLineTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the Boundaries2DLLineType

parameter.

Role:Retrieves the state of the Boundaries2DLLineType 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) –

• o_modified (bool) –

Return type:

None

get_boundaries_2dl_thickness_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetBoundaries2DLThicknessInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the Boundaries2DLThickness

parameter.

Role:Retrieves the state of the Boundaries2DLThickness 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) –

• o_modified (bool) –

Return type:

None

get_callout_creation_dialog_box_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetCalloutCreationDialogBoxInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the CalloutCreationDialogBox

parameter.

Role:Retrieves the state of the CalloutCreationDialogBox 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) –

• o_modified (bool) –

Return type:

None

get_callout_creation_in_active_view_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetCalloutCreationInActiveViewInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the CalloutCreationInActiveView

parameter.

Role:Retrieves the state of the CalloutCreationInActiveView 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) –

• o_modified (bool) –

Return type:

None

get_clipping_frame_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetClippingFrameInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the ClippingFrame

parameter.

Role:Retrieves the state of the ClippingFrame 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) –

• o_modified (bool) –

Return type:

None

get_clipping_frame_reframe_on_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 GetClippingFrameReframeOnModeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Deprecated:

V5R18 Retrieves environment informations for the

ClippingFrameReframeOnMode parameter.

Role:Retrieves the state of the ClippingFrameReframeOnMode 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_clipping_view_outline_color(o_value_r: int, o_value_g: int, o_value_b: int) → None

Note

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

o Sub GetClippingViewOutlineColor(long oValueR,

long oValueG,

long oValueB)

Returns the ClippingViewOutlineColor parameter.

Parameters:

• o_value_r (int) –

• o_value_g (int) –

• o_value_b (int) –

Return type:

None

get_clipping_view_outline_color_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetClippingViewOutlineColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the ClippingViewOutlineColor

parameter.

Role:Retrieves the state of the ClippingViewOutlineColor 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) –

• o_modified (bool) –

Return type:

None

get_clipping_view_outline_linetype_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetClippingViewOutlineLinetypeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the ClippingViewOutlineLinetype

parameter.

Role:Retrieves the state of the ClippingViewOutlineLinetype 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) –

• o_modified (bool) –

Return type:

None

get_clipping_view_outline_thickness_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetClippingViewOutlineThicknessInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the ClippingViewOutlineThickness

parameter.

Role:Retrieves the state of the ClippingViewOutlineThickness 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) –

• o_modified (bool) –

Return type:

None

get_create_associative_use_edges_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetCreateAssociativeUseEdgesInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the CreateAssociativeUseEdges

parameter.

Role:Retrieves the state of the CreateAssociativeUseEdges 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) –

• o_modified (bool) –

Return type:

None

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

Note

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

o Func GetDedicatedFilterTypeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DedicatedFilterType

parameter.

Role:Retrieves the state of the DedicatedFilterType 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_back_and_cutting_plane_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetDisplayBackAndCuttingPlaneInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the DisplayBackAndCuttingPlane

parameter.

Role:Retrieves the state of the DisplayBackAndCuttingPlane 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) –

• o_modified (bool) –

Return type:

None

get_display_clipping_outline_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetDisplayClippingOutlineInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the DisplayClippingOutline

parameter.

Role:Retrieves the state of the DisplayClippingOutline 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) –

• o_modified (bool) –

Return type:

None

get_edit_dedicated_filter_dialog_box_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetEditDedicatedFilterDialogBoxInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the EditDedicatedFilterDialogBox

parameter.

Role:Retrieves the state of the EditDedicatedFilterDialogBox 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) –

• o_modified (bool) –

Return type:

None

get_fit_all_in_sheet_format_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetFitAllInSheetFormatInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the FitAllInSheetFormat

parameter.

Role:Retrieves the state of the FitAllInSheetFormat 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) –

• o_modified (bool) –

Return type:

None

get_hide_in_3d_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetHideIn3DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the HideIn3D

parameter.

Role:Retrieves the state of the HideIn3D 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) –

• o_modified (bool) –

Return type:

None

get_insure_filter_names_uniqueness_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetInsureFilterNamesUniquenessInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the InsureFilterNamesUniqueness

parameter.

Role:Retrieves the state of the InsureFilterNamesUniqueness 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) –

• o_modified (bool) –

Return type:

None

get_insure_sheet_names_uniqueness_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetInsureSheetNamesUniquenessInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the InsureSheetNamesUniqueness

parameter.

Role:Retrieves the state of the InsureSheetNamesUniqueness 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) –

• o_modified (bool) –

Return type:

None

get_insure_view_names_uniqueness_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetInsureViewNamesUniquenessInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the InsureViewNamesUniqueness

parameter.

Role:Retrieves the state of the InsureViewNamesUniqueness 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) –

• o_modified (bool) –

Return type:

None

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

Note

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

o Func GetInsureViewNamesUniquenessScopeInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the InsureViewNamesUniquenessScope

parameter.

Role:Retrieves the state of the InsureViewNamesUniquenessScope 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_layout_default_render_style_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetLayoutDefaultRenderStyleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the default render style

parameter.

Role:Retrieves the state of the default 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) –

• o_modified (bool) –

Return type:

None

get_propagate_highlight_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetPropagateHighlightInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the PropagateHighlight

parameter.

Role:Retrieves the state of the PropagateHighlight 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) –

• o_modified (bool) –

Return type:

None

get_protected_elements_colour(o_value_r: int, o_value_g: int, o_value_b: int) → None

Note

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

o Sub GetProtectedElementsColor(long oValueR,

long oValueG,

long oValueB)

Returns the ProtectedElementsColor parameter.

Parameters:

• o_value_r (int) –

• o_value_g (int) –

• o_value_b (int) –

Return type:

None

get_protected_elements_colour_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetProtectedElementsColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the ProtectedElementsColor

parameter.

Role:Retrieves the state of the ProtectedElementsColor 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) –

• o_modified (bool) –

Return type:

None

get_tile_layout_window_info(io_admin_level: str, io_locked: str, o_modified: bool) → None

Note

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

o Sub GetTileLayoutWindowInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the tile of Layout window

parameter.

Role:Retrieves the state of the tile of Layout window 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) –

• o_modified (bool) –

Return type:

None

get_view_background_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 GetViewBackgroundModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewBackgroundMode

parameter.

Role:Retrieves the state of the ViewBackgroundMode 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_filter_creation_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 GetViewFilterCreationModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the ViewFilterCreationMode

parameter.

Role:Retrieves the state of the ViewFilterCreationMode 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 hide_in_3d: bool

Note

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

o Property HideIn3D() As boolean

Returns the HideIn3D parameter.

Return type:

bool

property insure_filter_names_uniqueness: bool

Note

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

o Property InsureFilterNamesUniqueness() As boolean

Returns the InsureFilterNamesUniqueness attribute value to apply to a

Layout at its creation parameter.

Return type:

bool

property insure_sheet_names_uniqueness: bool

Note

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

o Property InsureSheetNamesUniqueness() As boolean

Returns the InsureSheetNamesUniqueness attribute value to apply to a Layout

at its creation parameter.

Return type:

bool

property insure_view_names_uniqueness: bool

Note

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

o Property InsureViewNamesUniqueness() As boolean

Returns the InsureViewNamesUniqueness attribute value to apply to a Layout

at its creation parameter.

Return type:

bool

property insure_view_names_uniqueness_scope: int

Note

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

o Property InsureViewNamesUniquenessScope() As

CatInsureViewNamesUniquenessScope

Returns the InsureViewNamesUniquenessScope parameter.

Returns:

enum cat_insure_view_names_uniqueness_scope

Return type:

int

property layout_default_render_style: int

Note

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

o Property LayoutDefaultRenderStyle() As long

Returns the default render style attribute value to apply to a Layout at

its creation parameter.

Return type:

int

property propagate_highlight: bool

Note

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

o Property PropagateHighlight() As boolean

Returns the PropagateHighlight parameter.

Return type:

bool

set_activate_2d_mode_lock(i_locked: bool) → None

Note

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

o Sub SetActivate2DModeLock(boolean iLocked)

Locks or unlocks the Activate2DMode parameter.

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

Note

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

o Sub SetBackClippingPlaneLock(boolean iLocked)

Locks or unlocks the BackClippingPlane parameter.

Role:Locks or unlocks the BackClippingPlane 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_boundaries_2dl_colour(i_value_r: int, i_value_g: int, i_value_b: int) → None

Note

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

o Sub SetBoundaries2DLColor(long iValueR,

long iValueG,

long iValueB)

Sets the Boundaries2DLColor parameter.

Parameters:

• i_value_r (int) –

• i_value_g (int) –

• i_value_b (int) –

Return type:

None

set_boundaries_2dl_colour_lock(i_locked: bool) → None

Note

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

o Sub SetBoundaries2DLColorLock(boolean iLocked)

Locks or unlocks the Boundaries2DLColor parameter.

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

Note

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

o Sub SetBoundaries2DLDisplayLock(boolean iLocked)

Locks or unlocks the Boundaries2DLDisplay parameter.

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

Note

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

o Sub SetBoundaries2DLLineTypeLock(boolean iLocked)

Locks or unlocks the Boundaries2DLLineType parameter.

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

Note

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

o Sub SetBoundaries2DLThicknessLock(boolean iLocked)

Locks or unlocks the Boundaries2DLThickness parameter.

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

Note

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

o Sub SetCalloutCreationDialogBoxLock(boolean iLocked)

Locks or unlocks the CalloutCreationDialogBox parameter.

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

Note

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

o Sub SetCalloutCreationInActiveViewLock(boolean iLocked)

Locks or unlocks the CalloutCreationInActiveView

parameter.

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

Note

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

o Sub SetClippingFrameLock(boolean iLocked)

Locks or unlocks the ClippingFrame parameter.

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

Note

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

o Sub SetClippingFrameReframeOnModeLock(boolean iLocked)

Deprecated:

V5R18 Locks or unlocks the ClippingFrameReframeOnMode

parameter.

Role:Locks or unlocks the ClippingFrameReframeOnMode 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_clipping_view_outline_colour(i_value_r: int, i_value_g: int, i_value_b: int) → None

Note

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

o Sub SetClippingViewOutlineColor(long iValueR,

long iValueG,

long iValueB)

Sets the ClippingViewOutlineColor parameter.

Parameters:

• i_value_r (int) –

• i_value_g (int) –

• i_value_b (int) –

Return type:

None

set_clipping_view_outline_colour_lock(i_locked: bool) → None

Note

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

o Sub SetClippingViewOutlineColorLock(boolean iLocked)

Locks or unlocks the ClippingViewOutlineColor parameter.

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

Note

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

o Sub SetClippingViewOutlineLinetypeLock(boolean iLocked)

Locks or unlocks the ClippingViewOutlineLinetype

parameter.

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

Note

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

o Sub SetClippingViewOutlineThicknessLock(boolean iLocked)

Locks or unlocks the ClippingViewOutlineThickness

parameter.

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

Note

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

o Sub SetCreateAssociativeUseEdgesLock(boolean iLocked)

Locks or unlocks the CreateAssociativeUseEdges parameter.

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

Note

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

o Sub SetDedicatedFilterTypeLock(boolean iLocked)

Locks or unlocks the DedicatedFilterType parameter.

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

Note

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

o Sub SetDisplayBackAndCuttingPlaneLock(boolean iLocked)

Locks or unlocks the DisplayBackAndCuttingPlane parameter.

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

Note

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

o Sub SetDisplayClippingOutlineLock(boolean iLocked)

Locks or unlocks the DisplayClippingOutline parameter.

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

Note

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

o Sub SetEditDedicatedFilterDialogBoxLock(boolean iLocked)

Locks or unlocks the EditDedicatedFilterDialogBox

parameter.

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

Note

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

o Sub SetFitAllInSheetFormatLock(boolean iLocked)

Locks or unlocks the FitAllInSheetFormat parameter.

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

Note

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

o Sub SetHideIn3DLock(boolean iLocked)

Locks or unlocks the HideIn3D parameter.

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

Note

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

o Sub SetInsureFilterNamesUniquenessLock(boolean iLocked)

Locks or unlocks the InsureFilterNamesUniqueness

parameter.

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

Note

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

o Sub SetInsureSheetNamesUniquenessLock(boolean iLocked)

Locks or unlocks the InsureSheetNamesUniqueness parameter.

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

Note

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

o Sub SetInsureViewNamesUniquenessLock(boolean iLocked)

Locks or unlocks InsureViewNamesUniqueness parameter.

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

Note

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

o Sub SetInsureViewNamesUniquenessScopeLock(boolean iLocked)

Locks or unlocks the InsureViewNamesUniquenessScope

parameter.

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

Note

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

o Sub SetLayoutDefaultRenderStyleLock(boolean iLocked)

Locks or unlocks the default render style parameter.

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

Note

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

o Sub SetPropagateHighlightLock(boolean iLocked)

Locks or unlocks the PropagateHighlight parameter.

Role:Locks or unlocks the PropagateHighlight 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_protected_elements_colour(i_value_r: int, i_value_g: int, i_value_b: int) → None

Note

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

o Sub SetProtectedElementsColor(long iValueR,

long iValueG,

long iValueB)

Sets the ProtectedElementsColor parameter.

Parameters:

• i_value_r (int) –

• i_value_g (int) –

• i_value_b (int) –

Return type:

None

set_protected_elements_colour_lock(i_locked: bool) → None

Note

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

o Sub SetProtectedElementsColorLock(boolean iLocked)

Locks or unlocks the ProtectedElementsColor parameter.

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

Note

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

o Sub SetTileLayoutWindowLock(boolean iLocked)

Locks or unlocks the tile of Layout window parameter.

Role:Locks or unlocks the tile of Layout window 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_background_mode_lock(i_locked: bool) → None

Note

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

o Sub SetViewBackgroundModeLock(boolean iLocked)

Locks or unlocks the ViewBackgroundMode parameter.

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

Note

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

o Sub SetViewFilterCreationModeLock(boolean iLocked)

Locks or unlocks the ViewFilterCreationMode parameter.

Role:Locks or unlocks the ViewFilterCreationMode 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 tile_layout_window: bool

Note

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

o Property TileLayoutWindow() As boolean

Returns the tile of Layout window parameter.

Return type:

bool

property view_background_mode: int

Note

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

o Property ViewBackgroundMode() As CatViewBackgroundMode

Returns the ViewBackgroundMode parameter.

Returns:

enum cat_view_background_mode

Return type:

int

property view_filter_creation_mode: int

Note

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

o Property ViewFilterCreationMode() As

CatViewFilterCreationMode

Returns the ViewFilterCreationMode parameter.

Returns:

enum cat_view_filter_creation_mode

Return type:

int