SetProperty Function

Creates or updates a given custom property of a given object item from an Envision document currently opened in the Canvas Envision Creator app.

    SetProperty(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], property: [[[EvObjectProperty|evobjectproperty-interface.html]]]): Promise<void>

Parameters

obj: EvItem: An Object item object, an object item from the Envision document currently opened in the Canvas Envision Creator app whose given custom property should be created or updated.
property: EvObjectProperty: An EvObjectProperty object, a custom property that should be created or updated in the given object item from the current document.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given custom property of the given object item has been successfully created or updated.

Discussion

If the given object item already has a custom property with the key specified in the given EvObjectProperty object, the value of this property will be updated. Otherwise, a new custom property will be added to the given object item.

12 February 2025