ExcelScript.ConditionalRangeFormat interface

Пакет:

ExcelScript

Объект формата, инкапсулирующий шрифт, заливку, границы и другие свойства диапазона условных форматов.

Комментарии

Примеры

/**
 * This script applies cell value conditional formatting to a range.
 * Any value less than 60 will have the cell's fill color changed and the font made italic.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const selectedRange = workbook.getSelectedRange();

  // Add cell value conditional formatting.
  const cellValueConditionalFormatting =
    selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();

  // Create the condition, in this case when the cell value is less than 60.
  const rule: ExcelScript.ConditionalCellValueRule = {
    formula1: "60",
    operator: ExcelScript.ConditionalCellValueOperator.lessThan
  };
  cellValueConditionalFormatting.setRule(rule);

  // Set the format to apply when the condition is met.
  const format: ExcelScript.ConditionalRangeFormat = cellValueConditionalFormatting.getFormat();
  format.getFill().setColor("yellow");
  format.getFont().setItalic(true);
}

Методы

getBorders()	Коллекция объектов границы, которые применяются к общему диапазону условного формата.
getConditionalRangeBorder(index)	Возвращает объект границы по его имени.
getConditionalRangeBorderBottom()	Возвращает нижнюю границу.
getConditionalRangeBorderLeft()	Возвращает левую границу.
getConditionalRangeBorderRight()	Возвращает правильную границу.
getConditionalRangeBorderTop()	Возвращает верхнюю границу.
getFill()	Возвращает объект заполнения, определенный в общем диапазоне условного формата.
getFont()	Возвращает объект шрифта, определенный в общем диапазоне условного формата.
getNumberFormat()	Представляет код числового формата Excel для заданного диапазона. Очищается, если null передается.
setNumberFormat(numberFormat)	Представляет код числового формата Excel для заданного диапазона. Очищается, если null передается.

Сведения о методе

getBorders()

Коллекция объектов границы, которые применяются к общему диапазону условного формата.

getBorders(): ConditionalRangeBorder[];

Возвращаемое значение

ExcelScript.ConditionalRangeBorder[]

getConditionalRangeBorder(index)

Возвращает объект границы по его имени.

getConditionalRangeBorder(
            index: ConditionalRangeBorderIndex
        ): ConditionalRangeBorder;

Параметры

index

ExcelScript.ConditionalRangeBorderIndex

Значение индекса получаемого объекта границы. Дополнительные сведения см. в этой ExcelScript.ConditionalRangeBorderIndex статье.

Возвращаемое значение

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderBottom()

Возвращает нижнюю границу.

getConditionalRangeBorderBottom(): ConditionalRangeBorder;

Возвращаемое значение

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderLeft()

Возвращает левую границу.

getConditionalRangeBorderLeft(): ConditionalRangeBorder;

Возвращаемое значение

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderRight()

Возвращает правильную границу.

getConditionalRangeBorderRight(): ConditionalRangeBorder;

Возвращаемое значение

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderTop()

Возвращает верхнюю границу.

getConditionalRangeBorderTop(): ConditionalRangeBorder;

Возвращаемое значение

ExcelScript.ConditionalRangeBorder

getFill()

Возвращает объект заполнения, определенный в общем диапазоне условного формата.

getFill(): ConditionalRangeFill;

Возвращаемое значение

ExcelScript.ConditionalRangeFill

getFont()

Возвращает объект шрифта, определенный в общем диапазоне условного формата.

getFont(): ConditionalRangeFont;

Возвращаемое значение

ExcelScript.ConditionalRangeFont

getNumberFormat()

Представляет код числового формата Excel для заданного диапазона. Очищается, если null передается.

getNumberFormat(): string;

Возвращаемое значение

string

setNumberFormat(numberFormat)

Представляет код числового формата Excel для заданного диапазона. Очищается, если null передается.

setNumberFormat(numberFormat: string): void;

Параметры

numberFormat

string

Возвращаемое значение

void