SetName Function

Updates the name of a given object item from an Envision document currently opened in the Canvas Envision Creator app.

    SetName(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], name: 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 that should be renamed.
name: string: A string, a new name for the given object item.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given object item in the current Envision document has been successfully renamed.

Discussion

Object items should have unique names within a document. In some operations, such as duplication, replication, and copying, object items lose unique names. It is highly recommended to update the names of object items created in such operations to be unique.

27 March 2025