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.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Hyperlinks

add(i_object: AnyObject) → Hyperlink

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func Add(AnyObject iObject) As Hyperlink

Adds a Hyperlink to the Hyperlinks collection. Be careful: only one

Hyperlink instance is allowed per object which supports the hyperlink. If one

adds a Hyperlink on an object which already has a Hyperlink, the call fails.

The Hyperlink name is internally generated. If one wants to manage Hyperlink

using its name, he has to set it manually.

Parameters:

iObject

The object which supports the hyperlink.

Example:

The following example adds a Hyperlink

Dim NewHyperlink As Hyperlink

Set NewHyperlink = TheHyperlinks.Add(iObject)

Parameters:

i_object (AnyObject) –

Return type:

Hyperlink

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 Hyperlink

Retrieve an Hyperlink associated to an object

Parameters:

iObject

The object which supports the hyperlink. The call fails otherwise.

Returns:

The retrieved Hyperlink if it exists

Example:

This example retrieves an existing one in the TheHyperlinks

collection.

Dim NewHyperlink As Hyperlink

Set NewHyperlink = TheHyperlinks.GetHyperlink(iObject)

Parameters:

i_object (AnyObject) –

Return type:

Hyperlink

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 Hyperlink

Returns an Hyperlink using its index from the Hyperlinks

collection.

Parameters:

iIndex

The index or the name of the hyperlink to retrieve from the

collection of Hyperlinks. As a numerics, this index is the rank of the

Hyperlink in the collection. The index of the first Hyperlink in the collection

is 1, and the index of the last Hyperlink is Count. As a string, it is the name

you assigned to the Hyperlink.

Returns:

The retrieved Hyperlink

Example:

This example retrieves in ThisHyperlink the ninth Hyperlink

,

and in ThatHyperlink the Hyperlink named

Hyperlink3 from the TheHyperlinks collection.

Dim ThisHyperlink As Hyperlink

Set ThisHyperlink = TheHyperlinks.Item(9)

Dim ThatHyperlink As Hyperlink

Set ThatHyperlink = TheHyperlinks.Item(“Hyperlink3”)

Parameters:

i_index (cat_variant) –

Return type:

Hyperlink

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:

iIndex

The index or the name of the Hyperlink to retrieve from the

collection of Hyperlinks. As a numerics, this index is the rank of the

Hyperlink in the collection. The index of the first Hyperlink in the collection

is 1, and the index of the last Hyperlink is Count. As a string, it is the name

you assigned to the Hyperlink.

Example:

The following example removes the tenth Hyperlink and the

Hyperlink named

Hyperlink 2 from the TheHyperlinks collection.

TheHyperlinks.Remove(10)

TheHyperlinks.Remove(“Hyperlink2”)

Parameters:

i_index (cat_variant) –

Return type:

None