pycatia.cat_sch_platform_interfaces.sch_frame_info

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_sch_platform_interfaces.sch_frame_info.SchFrameInfo(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
SchFrameInfo

Manage the background view of a schematic viewer.
get_label_code(o_label: str, i_b_horiz: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetLabelCode(CATBSTR oLabel,
boolean iBHoriz)

Get the frame label code.

Parameters:

oLabel
Label code.
iBHoriz
If TRUE, then the labels are for horizontal spacing, else, they are
for vertical spacing.

Example:

Dim objThisIntf As SchFrameInfo
Dim strVar1 As String
Dim bVar2 As boolean
…
objThisIntf.GetLabelCodestrVar1,bVar2
Parameters:

  • o_label (str) –

  • i_b_horiz (bool) –

Return type:

None

get_origin_corner_code(o_origin_corner: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetOriginCornerCode(CATBSTR oOriginCorner)

Get the frame origin corner code.

Parameters:

oOriginCorner
Origin corner code.

Example:

Dim objThisIntf As SchFrameInfo
Dim strVar1 As String
…
objThisIntf.GetOriginCornerCodestrVar1
Parameters:

o_origin_corner (str) –

Return type:

None

get_spacing_code(o_spacing: str, i_b_horiz: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetSpacingCode(CATBSTR oSpacing,
boolean iBHoriz)

Get the frame spacing code.

Parameters:

oSpacing
Spacing code.
iBHoriz
If TRUE, then the spacing is for horizontal, else, the spacing is
for vertical.

Example:

Dim objThisIntf As SchFrameInfo
Dim strVar1 As String
Dim bVar2 As boolean
…
objThisIntf.GetSpacingCodestrVar1,bVar2
Parameters:

  • o_spacing (str) –

  • i_b_horiz (bool) –

Return type:

None

set_label_code(i_label: str, i_b_horiz: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLabelCode(CATBSTR iLabel,
boolean iBHoriz)

Set the frame label code.

Parameters:

iLabel
Label code.
iBHoriz
If TRUE, then the labels are for horizontal spacing, else, they are
for vertical spacing.

Example:

Dim objThisIntf As SchFrameInfo
Dim strVar1 As String
Dim bVar2 As boolean
…
objThisIntf.SetLabelCodestrVar1,bVar2
Parameters:

  • i_label (str) –

  • i_b_horiz (bool) –

Return type:

None

set_origin_corner_code(i_origin_corner: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetOriginCornerCode(CATBSTR iOriginCorner)

Set the frame origin corner code.

Parameters:

iOriginCorner
Origin corner code.

Example:

Dim objThisIntf As SchFrameInfo
Dim strVar1 As String
…
objThisIntf.SetOriginCornerCodestrVar1
Parameters:

i_origin_corner (str) –

Return type:

None

set_spacing_code(i_spacing: str, i_b_horiz: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSpacingCode(CATBSTR iSpacing,
boolean iBHoriz)

Set the frame spacing code.

Parameters:

iSpacing
Spacing code.
iBHoriz
If TRUE, then the spacing is for horizontal, else, the spacing is
for vertical.

Example:

Dim objThisIntf As SchFrameInfo
Dim strVar1 As String
Dim bVar2 As boolean
…
objThisIntf.SetSpacingCodestrVar1,bVar2
Parameters:

  • i_spacing (str) –

  • i_b_horiz (bool) –

Return type:

None