Skip to main content
Version: 2027.02 Beta
View as Markdown

system.i18n.modifyNotes

This function is used in Python Scripting.

Description​

Adds, updates, or removes the note attached to one or more translation keys in the Translation Manager. Each entry in the values dictionary maps a translation key to its note. A value of None removes that key's note. If any entry is invalid, no changes are applied.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

tip

This function accepts keyword arguments.

system.i18n.modifyNotes(values)

Parameters​

TypeParameterDescription
DictionaryvaluesA dictionary mapping each translation key to its note. A value of None removes the key's note.

Returns​

None

Scope​

Gateway, Vision Client, Perspective Session

Code Examples​

Code Snippet
# Add or update notes for two keys, and remove the note from a third.
notes = {
    "START_COMMAND": "Label for the main start button.",
    "STOP_COMMAND": "Label for the main stop button.",
    "OLD_COMMAND": None
}

system.i18n.modifyNotes(notes)