pycatia.navigator_interfaces.hyperlinks¶
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.hyperlinks.Hyperlinks(com_object)¶
Note
CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.CollectionHyperlinks- add(i_object: AnyObject) → Hyperlink¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func Add(AnyObject iObject) As HyperlinkAdds a Hyperlink to the Hyperlinks collection. Be careful: only oneHyperlink instance is allowed per object which supports the hyperlink. If oneadds a Hyperlink on an object which already has a Hyperlink, the call fails.The Hyperlink name is internally generated. If one wants to manage Hyperlinkusing its name, he has to set it manually.Parameters:iObjectThe object which supports the hyperlink.Example:The following example adds a HyperlinkDim NewHyperlink As HyperlinkSet NewHyperlink = TheHyperlinks.Add(iObject)
- get_hyperlink(i_object: AnyObject) → Hyperlink¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetHyperlink(AnyObject iObject) As HyperlinkRetrieve an Hyperlink associated to an objectParameters:iObjectThe object which supports the hyperlink. The call fails otherwise.Returns:The retrieved Hyperlink if it existsExample:This example retrieves an existing one in the TheHyperlinkscollection.Dim NewHyperlink As HyperlinkSet NewHyperlink = TheHyperlinks.GetHyperlink(iObject)
- item(i_index: cat_variant) → Hyperlink¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func Item(CATVariant iIndex) As HyperlinkReturns an Hyperlink using its index from the Hyperlinkscollection.Parameters:iIndexThe index or the name of the hyperlink to retrieve from thecollection of Hyperlinks. As a numerics, this index is the rank of theHyperlink in the collection. The index of the first Hyperlink in the collectionis 1, and the index of the last Hyperlink is Count. As a string, it is the nameyou assigned to the Hyperlink.Returns:The retrieved HyperlinkExample:This example retrieves in ThisHyperlink the ninth Hyperlink,and in ThatHyperlink the Hyperlink namedHyperlink3 from the TheHyperlinks collection.Dim ThisHyperlink As HyperlinkSet ThisHyperlink = TheHyperlinks.Item(9)Dim ThatHyperlink As HyperlinkSet ThatHyperlink = TheHyperlinks.Item(“Hyperlink3”)
- Parameters:
i_index (cat_variant) –
- Return type:
- remove(i_index: cat_variant) → None¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub Remove(CATVariant iIndex)Removes a Hyperlink from the Hyperlinks collection.Parameters:iIndexThe index or the name of the Hyperlink to retrieve from thecollection of Hyperlinks. As a numerics, this index is the rank of theHyperlink in the collection. The index of the first Hyperlink in the collectionis 1, and the index of the last Hyperlink is Count. As a string, it is the nameyou assigned to the Hyperlink.Example:The following example removes the tenth Hyperlink and theHyperlink namedHyperlink 2 from the TheHyperlinks collection.TheHyperlinks.Remove(10)TheHyperlinks.Remove(“Hyperlink2”)
- Parameters:
i_index (cat_variant) –
- Return type:
None