IscAnnotation

The IscAnnotation class provides access to a diagram annotation allowing annotation text to be set and cleared.

Field Values

**IscAnnotation Field Values**
Type	Field Name	Description
String	HTMLText	Gets or sets the text displayed in the annotation. A limited set of simple HTML formats is supported.

IscAnnotation Class

class ipsa.IscAnnotation

Provides access to a diagram annotation allowing annotation text to be set and cleared.

SetName(strName: str) → bool

Sets the name as a string.

Parameters:: strName (str) – The selected string name.
Returns:: True if successful.
Return type:: bool

GetIValue(nFieldIndex: int) → int

Returns an integer value for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The integer value.
Return type:: int

GetDValue(nFieldIndex: int) → float

Returns a double value for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The double value.
Return type:: float

GetSValue(nFieldIndex: int) → str

Returns a string value for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The string value.
Return type:: str

GetBValue(nFieldIndex: int) → bool

Returns a boolean value for the enumerated field.

Parameters:: nFieldIndex (int) – The field index.
Returns:: The boolean value.
Return type:: bool

SetIValue(nFieldIndex: int, nValue: int) → bool

Sets the value for the enumerated field from an integer.

Parameters:

nFieldIndex (int) – The field index.
nValue (int) – The given integer value.

Returns:

True if successful.

Return type:

bool

SetDValue(nFieldIndex: int, dValue: float) → bool

Sets the value for the enumerated field from a double.

Parameters:

nFieldIndex (int) – The field index.
dValue (float) – The given double value.

Returns:

True if successful.

Return type:

bool

SetSValue(nFieldIndex: int, strValue: int) → bool

Sets the value for the enumerated field from a string.

Parameters:

nFieldIndex (int) – The field index.
strValue (str) – The given string value.

Returns:

True if successful.

Return type:

bool

SetBValue(nFieldIndex: int, bValue: bool) → bool

Sets the value for the enumerated field from boolean.

Parameters:

nFieldIndex (int) – The field index.
bValue (bool) – The given boolean value.

Returns:

True if successful.

Return type:

bool