pycatia.cat_tps_interfaces.flag_note

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.cat_tps_interfaces.flag_note.FlagNote(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

FlagNote

Interface for the TPS Flag Note object.

add_url(i_url: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub AddURL(CATBSTR iUrl)

Sets an URL.

Parameters:

iUrl

URL to Set

Parameters:

i_url (str) –

Return type:

None

property flag_note_text: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property FlagNoteText() As CATBSTR

Retrieves or sets Flag Text.

Parameters:

oText

Returned Flag text.

Return type:

str

get_nbr_url(o_number_of_url: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetNbrURL(CATVariant oNumberOfURL)

Deprecated:

V5-6R2017 This method is replaced by FlagNote.GetNbrURL2

Parameters:

o_number_of_url (cat_variant) –

Return type:

None

get_nbr_url2() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetNbrURL2() As long

Gets the number of URL.

Parameters:

oNumberOfURL

returns param oNumberOfURL.

Return type:

int

modify_url(i_url: str, i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub ModifyURL(CATBSTR iUrl,

CATVariant iIndex)

Modifies an URL.

Parameters:

iUrl

URL to Set.

iIndex

index of the URL to modify.

Parameters:

• i_url (str) –

• i_index (cat_variant) –

Return type:

None

remove_url(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub RemoveURL(CATVariant iIndex)

Remove an URL.

Parameters:

iIndex

position of the URL to remove.

Parameters:

i_index (cat_variant) –

Return type:

None

property text: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

o Property Text() As CATBSTR

Retrieves or sets Flag Text Representation.

Parameters:

oText

Returned text for graphical representation.

Return type:

str

tps_parallel_on_screen() → TPSParallelOnScreen

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func TPSParallelOnScreen() As TPSParallelOnScreen

Gets the annotation on TPSParallelOnScreen interface.

Return type:

TPSParallelOnScreen

url(i_index: cat_variant) → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func URL(CATVariant iIndex) As CATBSTR

Retrieves URL.

Parameters:

iIndex

Index of URL.

oUrl

URL

Parameters:

i_index (cat_variant) –

Return type:

str