pycatia.cat_sch_platform_interfaces.sch_cntr_doc_link

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_cntr_doc_link.SchCntrDocLink(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

SchCntrDocLink

Manage the on-off sheet connector.

get_link(o_sch_connector: SchAppConnector, o_document_name: str) → None

Note

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

o Sub GetLink(SchAppConnector oSchConnector,

CATBSTR oDocumentName)

Get the linked connector and its document name.

Parameters:

oSchConnector

The connector that is linked to this connector.

oDocumentName

Name of document containing the linked connector.

Example:

Dim objThisIntf As SchCntrDocLink

Dim objArg1 As SchAppConnector

Dim strVar2 As String

…

objThisIntf.GetLinkobjArg1,strVar2

Parameters:

• o_sch_connector (SchAppConnector) –

• o_document_name (str) –

Return type:

None

link(i_sch_connector: SchAppConnector) → None

Note

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

o Sub Link(SchAppConnector iSchConnector)

Create an external link to another connector.

Parameters:

iSchConnector

The connector to link to.

Example:

Dim objThisIntf As SchCntrDocLink

Dim objArg1 As SchAppConnector

…

objThisIntf.LinkobjArg1

Parameters:

i_sch_connector (SchAppConnector) –

Return type:

None

un_link() → None

Note

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

o Sub UnLink()

Remove external link to another connector.

Example:

Dim objThisIntf As SchCntrDocLink

…

objThisIntf.UnLink

Return type:

None