SetText Function

Replaces the characters given as a continuous range in a given text item from an Envision document currently opened in the Canvas Envision Creator app with given new text and Markdown formatting.

    SetText(
        obj: [[[EvItem|canvas-envision-document-items.html#object-items]]],
        text: string,
        span?: [[[EvCharSpan|evcharspan-interface.html]]],
        withMarkdown?: boolean
    ): Promise<void>

Parameters

obj: EvItem

An Object item object, a text item from the Envision document currently opened in the Canvas Envision Creator app with the given range of characters that should be replaced.

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

text: string

A string, a given new text that should replace the characters within the given range in the given text item.

span?: EvCharSpan

An EvCharSpan object, a given continuous range of characters that should be replaced with the given new text.

The default value is the entire text in the given text item.

withMarkdown?: boolean

A Boolean, a flag to indicate whether the given new text includes (true) or does not include (false) Markdown formatting.

The default value is false.

Return value

Promise<void>: A Promise that, if fulfilled, resolves to void if the given new text has successfully replaced the characters within the given range in the given text item in the current document.

17 April 2025