pycatia.dnb_work_interfaces.wi_text

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.dnb_work_interfaces.wi_text.WIText(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
WIText
property fixed_text: str

Note

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

Returns or sets the value for ‘Fixed Text’
Role: Returns or sets the value of ‘Fixed Text’ to the Activity
Return type:

str

get_attribute(i_attr_name: str) → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAttribute(CATBSTR iAttrName) As CATBSTR

This gets the value of the Attribute.

Parameters:

iAttrName
The Attribute Name whose value we need to get
iAttrValue
CATUnicodeString value of the Attribute
Parameters:

i_attr_name (str) –

Return type:

str

get_geom_associated_to_annotation(i_assignment_type: int, io_point_geom: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetGeomAssociatedToAnnotation(ItemAssignmentType
iAssignmentType,
CATBaseDispatch ioPointGeom)

Gets the underlying geometry associated to FTA Text Annotation which is
added as an item to operation of one WIText Activity or added as item to a
WIText activity. This should be used in case when FTA Text Annotation is
associated to single geometric entity.

Parameters:

iAssignmentType
Point geometry associated to FTA text.
iAssignmentType
Type of the Assignment (Item to the Process)

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

  • i_assignment_type (int) – enum item_assignment_type

  • io_point_geom (AnyObject) –

Return type:

None

Note

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

Retrieves the List of Hyperlinks associated to this
activity
Role: Retrieves the List of Hyperlinks associated to this
activity

Parameters:

ioPath
a CATSafeArrayVariant of CATBSTR that has the list of Hyperlinks

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Return type:

tuple

property resolved_text: str

Note

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

Returns or sets the value for ‘ResolvedText Text’
Role: Returns or sets the value of ‘ResolvedText Text’ to the Activity
Return type:

str

set_attribute(i_attr_name: str, i_attr_value: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAttribute(CATBSTR iAttrName,
CATBSTR iAttrValue)

This sets the value of the Attribute

Parameters:

iAttrName
The Attribute Name whose value we need to get
iAttrValue
CATUnicodeString value of the Attribute
Parameters:

  • i_attr_name (str) –

  • i_attr_value (str) –

Return type:

None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetHyperLinks(CATSafeArrayVariant iHyperlinks)

Sets a List of Hyperlinks to this activity
Role: Sets the List of Hyperlinks to this activity

Parameters:

iPath
a CATSafeArrayVariant of CATBSTR that has the list of Hyperlinks.

Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
Parameters:

i_hyperlinks (tuple) –

Return type:

None

property unresolved_text: str

Note

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

Returns or sets the value for ‘UnresolvedText Text’
Role: Returns or sets the value of ‘UnresolvedText Text’ to the Activity
Return type:

str