evCreate API 5.7 Help

RemoveProperty Function

Permanently removes a given custom property from a given object item.

RemoveProperty(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], propertyKey: string): 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 removed.

propertyKey: string

A string, the key of a custom property that should be removed from the given object item.

Return value

Promise<void>

A Promise that, if fulfilled, resolves to void if the given custom property has been successfully removed from the given object item.

27 March 2025