MMpy.Symbol.serialise

Syntax

symbol.serialise()

Description

Serialises the symbol object to a string which can then be used in the MMpy.FormSet.set_field function.

Returns

Type
Description
str A string representation of the symbol object.

Notes

This function is normally not used with newly recorded scripts in v2020+ as form sets are now able to accept objects directly.

Examples

symbol = MMpy.Symbol('Mm Symbols', 42, 11.0, '', True, False, 0, MMpy.BorderType.black_border, MMpy.Colour(0, 155, 204))
formset = MMpy.FormSet(...)
 
# Older recorded scripts
formset.set_field('SYMBOL', symbol.serialise())
 
# Newer recorded scripts (v2020+)
formset.set_field(123, symbol)

Resource ID

IDPH_SYMBOL_SERIALISE