pycatia.cat_dde_settings_interfaces.dxf_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.cat_dde_settings_interfaces.dxf_setting_att.DxfSettingAtt(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

DxfSettingAtt

Interface dedicated to modify or read the current settings corresponding to the

DXF Data Exchange (used for DXF or DWG files)

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

delegated.

property export_blocks: int

Note

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

o Property ExportBlocks() As CatDxfExportBlocksEnum (Read

Only)

Get the value of the Export Blocks option. That value is only taken into

account when the export mode is set to Semantic.

Parameters:

oExportBlocks

Legal values: An available value of the enum

CatDxfExportBlocksEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_dxf_export_blocks_enum

Return type:

int

property export_dimensions_as_dimensions: bool

Note

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

o Property ExportDimensionsAsDimensions() As boolean (Read

Only)

Get the value of the Export Dimensions As Dimensions option. That value is

only taken into account when the export mode is set to

Semantic.

Parameters:

oExportDimension

Legal values:

TRUE : Export dimensions as dimensions.

FALSE : Export dimensions as graphical block.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

bool

property export_layer_name: bool

Note

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

o Property ExportLayerName() As boolean (Read Only)

Get the value of the Export Layer Name option. That value is only taken

into account when the export mode is set to Semantic.

Parameters:

oExportLayerName

Legal values:

TRUE : Export Layer Name.

FALSE : Export Layer Number.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

bool

property export_mode: int

Note

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

o Property ExportMode() As CatDxfExportModeEnum (Read Only)

Get the Export Mode option value.

Parameters:

oMode

Legal values: An available value of the enum CatDxfExportModeEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_dxf_export_mode_enum

Return type:

int

property export_sheets: int

Note

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

o Property ExportSheets() As CatDxfExportSheetsEnum (Read

Only)

Get the Exported Sheets option value.

Parameters:

oSheets

Legal values: An available value of the enum

CatDxfExportSheetsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_dxf_export_sheets_enum

Return type:

int

property export_version: int

Note

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

o Property ExportVersion() As CatDxfExportVersionEnum (Read

Only)

Get the Export Version option value.

Parameters:

oVersion

Legal values: An available value of the enum

CatDxfExportVersionEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_dxf_export_version_enum

Return type:

int

property export_views_as_viewports: bool

Note

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

o Property ExportViewsAsViewports() As boolean (Read Only)

Get the value of the Export Views as Viewports option. That value is only

taken into account when the export mode is set to

Semantic.

Parameters:

oViewsAsViewports

Legal values:

TRUE : Export Views as Viewports enable.

FALSE : Export Views as Viewports disable.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

bool

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

Note

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

o Func GetExportBlocksInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Export Blocks

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetExportDimensionsAsDimensionsInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Export Dimensions As Dimensions

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_export_layer_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 GetExportLayerNameInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Export Layer Name

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

get_export_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 GetExportModeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Export Mode

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetExportSheetsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Exported Sheets

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetExportVersionInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Export Version

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetExportViewsAsViewportsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Export Views as Viewports

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportDftStandardInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Drafting standard

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportDimensionsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Import dimensions

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportDxfStandardInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DXF standard

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportEndPointsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Create End Points

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportKeepModelSpaceInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Keep Model Space

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportMapLayerOn2DLInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for Map Layer On 2DL

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportPaperSpacesInBackgroundInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Paper Spaces in Background

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportScaleDenominatorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the scale factor’s denominator value

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportScaleNumeratorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the scale factor’s numerator value

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

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

Note

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

o Func GetImportUnitInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the import unit

option.

Parameters:

ioAdminLevel

If the option is locked, AdminLevel gives the administration level

that imposes the value of the option.

If the option is not locked, AdminLevel gives the administration

level that will give the value of the option after a reset.

ioLocked

Indicates if the option has been locked.

oModified

Indicates if the option has been explicitly modified or remain to

the administrated value.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

• io_admin_level (str) –

• io_locked (str) –

Return type:

bool

property import_dft_standard: str

Note

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

o Property ImportDftStandard() As CATBSTR (Read Only)

Get the name of the Drafting standard, which define the standard of the

resulting CATDrawing file.

Parameters:

oDftStandard

the CATBSTR corresponding to the Drafting standard.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

str

property import_dimensions: int

Note

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

o Property ImportDimensions() As CatDxfImportDimensionsEnum (Read

Only)

Get the Import dimensions option value.

Parameters:

oDimensions

Legal values: An available value of the enum

CatDxfImportDimensionsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_dxf_import_dimensions_enum

Return type:

int

property import_dxf_standard: str

Note

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

o Property ImportDxfStandard() As CATBSTR (Read Only)

Get the name of the Dxf standard, which define the different mapping used

at import.

Parameters:

oDxfStandard

the CATBSTR corresponding to the Dxf standard.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

str

property import_end_points: int

Note

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

o Property ImportEndPoints() As CatDxfImportCreateEndPointsEnum (Read

Only)

Get the Create End Points option value.

Parameters:

oEndPoints

Legal values: An available value of the enum

CatDxfImportCreateEndPointsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_dxf_import_create_end_points_enum

Return type:

int

property import_keep_model_space: bool

Note

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

o Property ImportKeepModelSpace() As boolean (Read Only)

Get the value of the Keep Model Space option.

Parameters:

oKeepModelSpace

Legal values:

TRUE : always keep the entire Model Space in its own sheet.

FALSE : keep the entire Model Space in its own sheet but only if the automatic management detects that it’s required.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

bool

property import_map_layer_on2_dl: bool

Note

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

o Property ImportMapLayerOn2DL() As boolean (Read Only)

Get the value of Map Layer On 2DL sheet option.

Parameters:

oMapLayerOn2DL

Legal values:

TRUE : always Map Layer On 2DL sheets.

FALSE : No specific treatment on layer

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

bool

property import_paper_spaces_in_background: bool

Note

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

o Property ImportPaperSpacesInBackground() As boolean (Read

Only)

Get the value of the Paper Spaces in Background option.

Parameters:

oPaperSpacesInBackground

Legal values:

TRUE : All Paper Spaces entities are put into the corresponding Sheet’s Background

FALSE : All Paper Spaces entities are put into a view inside the corresponding Sheet’s Working Views

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

bool

property import_scale_denominator: float

Note

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

o Property ImportScaleDenominator() As double (Read Only)

Get the denominator value of the scale factor. That value is only taken

into account when the import unit is set to Scale Factor.

Parameters:

oScaleDen

the denominator value of the scale factor.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

float

property import_scale_numerator: float

Note

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

o Property ImportScaleNumerator() As double (Read Only)

Get the numerator value of the scale factor. That value is only taken into

account when the import unit is set to Scale Factor.

Parameters:

oScaleNum

the numerator value of the scale factor.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Return type:

float

property import_unit: int

Note

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

o Property ImportUnit() As CatDxfImportUnitEnum (Read Only)

Get the import unit.

Parameters:

oUnit

Legal values: An available value of the enum CatDxfImportUnitEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Returns:

enum cat_dxf_import_unit_enum

Return type:

int

set_export_blocks(i_export_blocks: int) → None

Note

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

o Sub set_ExportBlocks(CatDxfExportBlocksEnum iExportBlocks)

Set the value of the Export Layer Name option. That value is only taken

into account when the export mode is set to Semantic.

Parameters:

iExportBlocks

Legal values: An available value of the enum

CatDxfExportBlocksEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_export_blocks (int) – enum cat_dxf_export_blocks_enum

Return type:

None

set_export_blocks_lock(i_locked: bool) → None

Note

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

o Sub SetExportBlocksLock(boolean iLocked)

Locks or unlocks the Export Blocks option if the operation is allowed in

the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_export_dimensions_as_dimensions(i_export_dimension: bool) → None

Note

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

o Sub set_ExportDimensionsAsDimensions(boolean

iExportDimension)

Set the value of the Export Dimensions As Dimensions option. That value is

only taken into account when the export mode is set to

Semantic.

Parameters:

iExportDimension

Legal values:

TRUE : Export dimensions as dimensions.

FALSE : Export dimensions as graphical block.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_export_dimension (bool) –

Return type:

None

set_export_dimensions_as_dimensions_lock(i_locked: bool) → None

Note

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

o Sub SetExportDimensionsAsDimensionsLock(boolean iLocked)

Locks or unlocks the Export Dimensions As Dimensions option if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_export_layer_name(i_export_layer_name: bool) → None

Note

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

o Sub set_ExportLayerName(boolean iExportLayerName)

Set the value of the Export Layer Name option. That value is only taken

into account when the export mode is set to Semantic.

Parameters:

iExportLayerName

Legal values:

TRUE : Export Layer Name.

FALSE : Export Layer Number.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_export_layer_name (bool) –

Return type:

None

set_export_layer_name_lock(i_locked: bool) → None

Note

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

o Sub SetExportLayerNameLock(boolean iLocked)

Locks or unlocks the Export Layer Name option if the operation is allowed

in the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_export_mode(i_mode: int) → None

Note

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

o Sub set_ExportMode(CatDxfExportModeEnum iMode)

Set the Export Mode option value.

Parameters:

iMode

Legal values: An available value of the enum CatDxfExportModeEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_mode (int) – enum cat_dxf_export_mode_enum

Return type:

None

set_export_mode_lock(i_locked: bool) → None

Note

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

o Sub SetExportModeLock(boolean iLocked)

Locks or unlocks the Export Mode option if the operation is allowed in the

current administrated environment. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_export_sheets(i_sheets: int) → None

Note

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

o Sub set_ExportSheets(CatDxfExportSheetsEnum iSheets)

set the Exported Sheets option value.

Parameters:

iSheets

Legal values: An available value of the enum

CatDxfExportSheetsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_sheets (int) – enum cat_dxf_export_sheets_enum

Return type:

None

set_export_sheets_lock(i_locked: bool) → None

Note

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

o Sub SetExportSheetsLock(boolean iLocked)

Locks or unlocks the Exported Sheets option if the operation is allowed in

the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_export_version(i_version: int) → None

Note

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

o Sub set_ExportVersion(CatDxfExportVersionEnum iVersion)

Set the Export Version option value.

Parameters:

iVersion

Legal values: An available value of the enum

CatDxfExportVersionEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

:param int i_version:enum cat_dxf_export_version_enum :rtype: None

set_export_version_lock(i_locked: bool) → None

Note

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

o Sub SetExportVersionLock(boolean iLocked)

Locks or unlocks the Export Version option if the operation is allowed in

the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_export_views_as_viewports(i_views_as_viewports: bool) → None

Note

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

o Sub set_ExportViewsAsViewports(boolean iViewsAsViewports)

Set the value of the Export Views as Viewports option. That value is only

taken into account when the export mode is set to

Semantic.

Parameters:

iViewsAsViewports

Legal values:

TRUE : Enable the export of views as Viewports.

FALSE : Disable the export of views as Viewports.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_views_as_viewports (bool) –

Return type:

None

set_export_views_as_viewports_lock(i_locked: bool) → None

Note

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

o Sub SetExportViewsAsViewportsLock(boolean iLocked)

Locks or unlocks the Export Views as Viewports option if the operation is

allowed in the current administrated environment. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_dft_standard(i_dft_standard: str) → None

Note

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

o Sub set_ImportDftStandard(CATBSTR iDftStandard)

Set the name of the Drafting standard, which define the standard of the

resulting CATDrawing file.

Parameters:

iDftStandard

the CATBSTR corresponding to the Drafting standard.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dft_standard (str) –

Return type:

None

set_import_dft_standard_lock(i_locked: bool) → None

Note

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

o Sub SetImportDftStandardLock(boolean iLocked)

Locks or unlocks the Drafting standard option if the operation is allowed

in the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_dimensions(i_dimensions: int) → None

Note

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

o Sub set_ImportDimensions(CatDxfImportDimensionsEnum

iDimensions)

Set the Import dimensions option value.

Parameters:

iDimensions

Legal values: An available value of the enum

CatDxfImportDimensionsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dimensions (int) – enum cat_dxf_import_dimensions_enum

Return type:

None

set_import_dimensions_lock(i_locked: bool) → None

Note

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

o Sub SetImportDimensionsLock(boolean iLocked)

Locks or unlocks the Import dimensions option if the operation is allowed

in the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_dxf_standard(i_dxf_standard: str) → None

Note

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

o Sub set_ImportDxfStandard(CATBSTR iDxfStandard)

Set the name of the Dxf standard, which define the different mapping used

at import.

Parameters:

iDxfStandard

the CATBSTR corresponding to the Dxf standard.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_dxf_standard (str) –

Return type:

None

set_import_dxf_standard_lock(i_locked: bool) → None

Note

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

o Sub SetImportDxfStandardLock(boolean iLocked)

Locks or unlocks the DXF standard option if the operation is allowed in the

current administrated environment. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_end_points(i_end_points: int) → None

Note

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

o Sub set_ImportEndPoints(CatDxfImportCreateEndPointsEnum

iEndPoints)

Set the Create End Points option value.

Parameters:

iEndPoints

Legal values: An available value of the enum

CatDxfImportCreateEndPointsEnum.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_end_points (int) – enum cat_dxf_import_create_end_points_enum

Return type:

None

set_import_end_points_lock(i_locked: bool) → None

Note

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

o Sub SetImportEndPointsLock(boolean iLocked)

Locks or unlocks the Create End Points option if the operation is allowed

in the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_keep_model_space(i_keep_model_space: bool) → None

Note

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

o Sub set_ImportKeepModelSpace(boolean iKeepModelSpace)

Set the value of the Keep Model Space option.

Parameters:

iKeepModelSpace

Legal values:

TRUE : always keep the entire Model Space in its own sheet.

FALSE : keep the entire Model Space in its own sheet but only if the automatic management detects that it’s required.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_keep_model_space (bool) –

Return type:

None

set_import_keep_model_space_lock(i_locked: bool) → None

Note

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

o Sub SetImportKeepModelSpaceLock(boolean iLocked)

Locks or unlocks the Keep Model Space option if the operation is allowed in

the current administrated environment. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_map_layer_on2_dl(i_map_layer_on2_dl: bool) → None

Note

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

o Sub set_ImportMapLayerOn2DL(boolean iMapLayerOn2DL)

Set the value of Map Layer On 2DL sheet option.

Parameters:

iMapLayerOn2DL

Legal values:

TRUE : always Map Layer On 2DL sheets.

FALSE : No specific treatment on layer

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_map_layer_on2_dl (bool) –

Return type:

None

set_import_map_layer_on2_dl_lock(i_locked: bool) → None

Note

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

o Sub SetImportMapLayerOn2DLLock(boolean iLocked)

Locks or unlocks Map on Layer2DL option if the operation is allowed in the

current administrated environment. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_paper_spaces_in_background(i_paper_spaces_in_background: bool) → None

Note

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

o Sub set_ImportPaperSpacesInBackground(boolean

iPaperSpacesInBackground)

Set the value of the Paper Spaces in Background option.

Parameters:

iPaperSpacesInBackground

Legal values:

TRUE : All Paper Spaces entities are put into the corresponding Sheet’s Background

FALSE : All Paper Spaces entities are put into a view inside the corresponding Sheet’s Working Views

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_paper_spaces_in_background (bool) –

Return type:

None

set_import_paper_spaces_in_background_lock(i_locked: bool) → None

Note

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

o Sub SetImportPaperSpacesInBackgroundLock(boolean iLocked)

Locks or unlocks the Paper Spaces in Background option if the operation is

allowed in the current administrated environment. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_scale_denominator(i_scale_den: float) → None

Note

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

o Sub set_ImportScaleDenominator(double iScaleDen)

Get the denominator value of the scale factor. That value is only taken

into account when the import unit is set to Scale Factor.

Parameters:

iScaleDen

the denominator value of the scale factor, which is supposed to be

not null.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_scale_den (float) –

Return type:

None

set_import_scale_denominator_lock(i_locked: bool) → None

Note

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

o Sub SetImportScaleDenominatorLock(boolean iLocked)

Locks or unlocks the scale factor’s denominator value option if the

operation is allowed in the current administrated environment. In user mode

this method will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_scale_numerator(i_scale_num: float) → None

Note

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

o Sub set_ImportScaleNumerator(double iScaleNum)

Set the numerator value of the scale factor. That value is only taken into

account when the import unit is set to Scale Factor.

Parameters:

iScaleNum

the numerator value of the scale factor.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_scale_num (float) –

Return type:

None

set_import_scale_numerator_lock(i_locked: bool) → None

Note

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

o Sub SetImportScaleNumeratorLock(boolean iLocked)

Locks or unlocks the scale factor’s numerator value option if the operation

is allowed in the current administrated environment. In user mode this method

will always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None

set_import_unit(i_unit: int) → None

Note

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

o Sub set_ImportUnit(CatDxfImportUnitEnum iUnit)

Set the import unit.

Parameters:

iUnit

Legal values: An available value of the enum CatDxfImportUnitEnum

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_unit (int) – enum cat_dxf_import_unit_enum

Return type:

None

set_import_unit_lock(i_locked: bool) → None

Note

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

o Sub SetImportUnitLock(boolean iLocked)

Locks or unlocks the import unit option if the operation is allowed in the

current administrated environment. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE: to lock the option.

FALSE: to unlock the option.

Returns:

Legal values:

S_OK : on Success

E_FAIL: on failure

Parameters:

i_locked (bool) –

Return type:

None