SetUseCustomValue Function

Enables or disables custom values for a given dimension item from an Envision document currently opened in the Canvas Envision Creator app.

    SetUseCustomValue(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], use: boolean): Promise<void>

Parameters

obj: EvItem

An Object item object, a dimension item from the Envision document currently opened in the Canvas Envision Creator app for which custom values should be enabled or disabled.

If a given object item is not a dimension, the function throws an error.

use: boolean

A Boolean, a switch to enable (true) or disable (false) custom values for the given dimension item.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if custom values have been successfully enabled or disabled for the given dimension item in the current document.

01 April 2025