pycatia.navigator_interfaces.hyperlink¶
Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445
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.navigator_interfaces.hyperlink.Hyperlink(com_object)¶
Note
CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectHyperlinkRepresents a hyperlink marker.- add_url(i_url: str) → None¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub AddUrl(CATBSTR iUrl)Adds a url to an Hyperlink.Parameters:iUrlThe URL to be added to the Hyperlink.Example:This example links TheUrl to the NewHyperlinkHyperlink.NewHyperlink.AddUrl(TheUrl)
- Parameters:
i_url (str) –
- Return type:
None
- count_object() → int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func CountObject() As longReturns the number of Url which are linked to theHyperlink.Example:This example reads the number of Url in the Hyperlink NewHyperlink.Dim number As Integernumber = NewHyperlink.CountObject
- Return type:
int
- item_object(i_index: cat_variant) → str¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func ItemObject(CATVariant iIndex) As CATBSTRReturns an Url which is linked to the Hyperlink using itsindex.Parameters:iIndexThe index of the Url in the Hyperlink. The index of the firstobject is 1, and the index of the last object is CountObject.Returns:The retrieved UrlExample:This example retrieves in ThisUrl the ninthobjectfrom the NewHyperlink Hyperlink.Dim ThisUrl As StringSet ThisUrl = NewHyperlink.ItemObject(9)
- Parameters:
i_index (cat_variant) –
- Return type:
str
- remove_object(i_index: cat_variant) → None¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub RemoveObject(CATVariant iIndex)Removes an Url which is linked to the Hyperlink using itsindex.Parameters:iIndexThe index of the object in the Hyperlink. The index of the firstobject is 1, and the index of the last object is CountObject.Example:This example removes the ninth Urlfrom the NewHyperlink Hyperlink.NewHyperlink.RemoveObject(9)
- Parameters:
i_index (cat_variant) –
- Return type:
None