evCreate API 5.7 Help

SetCellAlignment Function

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

SetCellAlignment( tableObj: [[[EvItem|canvas-envision-document-items.html#object-items]]], cell: [[[EvTableCellIndex|evtablecellindex-type-alias.html]]], alignment: [[[EvTextAlignment|evtextalignment-interface.html]]], span?: [[[EvCharSpan|evcharspan-interface.html]]] ): Promise<void>

Parameters

tableObj: EvItem

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

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

cell: EvTableCellIndex

An EvTableCellIndex object, an array of the row and column indices of a given cell with the given range of characters that should be realigned.

alignment: EvTextAlignment

An EvTextAlignment object, a given new text alignment that should be applied to the characters within the given range in the given cell of the given table 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 cell.

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 cell of the given table item in the current document.

17 April 2025