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

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Hyperlink

Represents 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:

iUrl

The URL to be added to the Hyperlink.

Example:

This example links TheUrl to the NewHyperlink

Hyperlink.

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 long

Returns the number of Url which are linked to the

Hyperlink.

Example:

This example reads the number of Url in the Hyperlink NewHyperlink

.

Dim number As Integer

number = NewHyperlink.CountObject

Return type:

int

item_object(i_index: int | str) → str

Note

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

o Func ItemObject(CATVariant iIndex) As CATBSTR

Returns an Url which is linked to the Hyperlink using its

index.

Parameters:

iIndex

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

object is 1, and the index of the last object is CountObject.

Returns:

The retrieved Url

Example:

This example retrieves in ThisUrl the ninth

object

from the NewHyperlink Hyperlink.

Dim ThisUrl As String

Set ThisUrl = NewHyperlink.ItemObject(9)

Parameters:

i_index (CATVariant) –

Return type:

str

remove_object(i_index: int | str) → 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 its

index.

Parameters:

iIndex

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

object is 1, and the index of the last object is CountObject.

Example:

This example removes the ninth Url

from the NewHyperlink Hyperlink.

NewHyperlink.RemoveObject(9)

Parameters:

i_index (CATVariant) –

Return type:

None