evCreate API 5.7 Help

SetCellRangeBackground Function

Applies a given new fill to the background of the cells given as a continuous range in a given table item from an Envision document currently opened in the Canvas Envision Creator app.

SetCellRangeBackground( tableObj: [[[EvItem|canvas-envision-document-items.html#object-items]]], cells: [[[EvTableCellRange|evtablecellrange-interface.html]]], background: [[[EvFill|evfill-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 continuous range of cells whose background fill should be changed.

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

cells: EvTableCellRange

An EvTableCellRange object, a given continuous range of cells in the given table item whose background fill should be changed.

background: EvFill

An EvFill object, a given new fill that should be applied to the background of the cells within the given continuous range in the given table item.

Return value

Promise<void>

A Promise that, if fulfilled, resolves to void if the given new fill has been successfully applied to the background of the cells within the given range in the given table item from the current document.

17 April 2025