SetAlignment Function

Applies a given new text alignment to the characters given as a continuous range in a given text item from an Envision document currently opened in the Canvas Envision Creator app.

    SetAlignment(
        obj: [[[EvItem|canvas-envision-document-items.html#object-items]]],
        alignment: [[[EvTextAlignment|evtextalignment-interface.html]]],
        span?: [[[EvCharSpan|evcharspan-interface.html]]]
    ): 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 realigned.

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

alignment: EvTextAlignment

An EvTextAlignment object, a given new text alignment that should be applied to the characters within the given range in the text item.

span?: EvCharSpan

An EvCharSpan object, a given continuous range of characters that should be realigned.

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

Return value

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

17 April 2025