ExcelScript.RangeFormat interface

Изменяет отступ для форматирования диапазона. Значение отступа находится в диапазоне от 0 до 250 и измеряется в символах.

adjustIndent(amount: number): void;

Параметры

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

Примеры

/**
 * This script adjusts the indentation of a specific table column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the current worksheet.
  const selectedSheet = workbook.getActiveWorksheet();
  const table = selectedSheet.getTables()[0];

  // Get the data range of the second column.
  const secondColumn = table.getColumn(2);
  const data = secondColumn.getRangeBetweenHeaderAndTotal();

  // Add an indentation of 1 character space to the data range.
  data.getFormat().adjustIndent(1);
}

Изменяет ширину столбцов текущего диапазона на оптимальную с учетом текущих данных в столбцах.

autofitColumns(): void;

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

Примеры

/**
 * This script creates a new table from existing data and autofits the columns.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Create the table.
  const table = currentSheet.addTable(usedRange, true);

  // Format the table columns.
  table.getRange().getFormat().autofitColumns();
}

Изменяет высоту строк текущего диапазона на оптимальную с учетом текущих данных в столбцах.

autofitRows(): void;

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

Примеры

/**
 * This script creates a new table from existing data and autofits the rows.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Create the table.
  const table = currentSheet.addTable(usedRange, true);

  // Format the table rows.
  table.getRange().getFormat().autofitRows();
}

Указывает, является ли текст автоматически отступом, если задано равное распределение текста.

getAutoIndent(): boolean;

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

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

getBorders(): RangeBorder[];

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

Задает ширину всех столбцов в диапазоне. Если ширина столбцов не равномерна, null возвращается значение .

getColumnWidth(): number;

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

Примеры

/**
 * This script doubles the column width for every column in the active worksheet's used range.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // To optimize performance, get all the current row heights before setting them.
  let currentWidths = Array<number>(usedRange.getColumnCount());
  for (let column = 0; column < currentWidths.length; column++) {
    currentWidths[column] = usedRange.getColumn(column).getFormat().getColumnWidth();
  }

  // Set the new column widths.
  for (let column = 0; column < currentWidths.length; column++) {
    usedRange.getFormat().setColumnWidth(currentWidths[column] * 2);
  }

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

getFill(): RangeFill;

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

Примеры

/**
 * This script gives the total row of a table a green color fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  let table = workbook.getTables()[0];

  // Get the range for the total row of the table.
  let totalRange = table.getTotalRowRange();

  // Set the fill color to green.
  totalRange.getFormat().getFill().setColor("green");
}

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

getFont(): RangeFont;

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

Примеры

/**
 * This script bolds the text of cell A1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get A1 on the current worksheet.
  const cell = workbook.getActiveWorksheet().getCell(0,0);

  // Bold the font for that cell
  cell.getFormat().getFont().setBold(true);
}

Представляет выравнивание по горизонтали для указанного объекта. Дополнительные сведения см. в этой ExcelScript.HorizontalAlignment статье.

getHorizontalAlignment(): HorizontalAlignment;

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

Целое число от 0 до 250, указывающее уровень отступа.

getIndentLevel(): number;

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

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

getProtection(): FormatProtection;

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

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

getRangeBorder(index: BorderIndex): RangeBorder;

Параметры

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

Примеры

/**
 * This script adds a border around the outside of a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a range from the current worksheet.
  let range = workbook.getActiveWorksheet().getRange("B2:E15");

  // Add a border around the whole bounding range.
  let format = range.getFormat();
  format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
}

Задает двойник, который осветляет или затемняет цвет границ диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. null Значение указывает, что вся коллекция границ не имеет единообразного tintAndShade параметра.

getRangeBorderTintAndShade(): number;

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

Направление чтения для диапазона.

getReadingOrder(): ReadingOrder;

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

Высота всех строк в диапазоне. Если высота строк не равномерна, null возвращается значение .

getRowHeight(): number;

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

Примеры

/**
 * This script doubles the row height for every row in the active worksheet's used range.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // To optimize performance, get all the current row heights before setting them.
  let currentHeights = Array<number>(usedRange.getRowCount());
  for (let row = 0; row < currentHeights.length; row++) {
    currentHeights[row] = usedRange.getRow(row).getFormat().getRowHeight();
  }

  // Set the new row heights.
  for (let row = 0; row < currentHeights.length; row++) {
    usedRange.getFormat().setRowHeight(currentHeights[row] * 2);
  }
}

Указывает, будет ли текст автоматически сжиматься в соответствии с доступной шириной столбца.

getShrinkToFit(): boolean;

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

Ориентация текста всех ячеек в диапазоне. Ориентация текста должна быть целым числом от -90 до 90 или 180 для вертикально ориентированного текста. Если ориентация в диапазоне не однородна, возвращается null .

getTextOrientation(): number;

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

Определяет, равна ли высота Range строки объекта стандартной высоте листа. Возвращает значение true , если высота Range строки объекта равна стандартной высоте листа. Возвращает значение null , если диапазон содержит более одной строки и строки не совпадают по высоте. В противном случае возвращает значение false .

getUseStandardHeight(): boolean;

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

Указывает, соответствует ли ширина столбца Range объекта стандартной ширине листа. Возвращает значение true , если ширина столбца Range объекта равна стандартной ширине листа. Возвращает значение null , если диапазон содержит более одного столбца, а высота столбцов не совпадает. В противном случае возвращает значение false .

getUseStandardWidth(): boolean;

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

Представляет выравнивание по вертикали для указанного объекта. Дополнительные сведения см. в этой ExcelScript.VerticalAlignment статье.

getVerticalAlignment(): VerticalAlignment;

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

Указывает, будет ли Excel переносить текст в объект . null Значение указывает, что для всего диапазона не задано равномерное обертывание.

getWrapText(): boolean;

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

Указывает, является ли текст автоматически отступом, если задано равное распределение текста.

setAutoIndent(autoIndent: boolean): void;

Параметры

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

Задает ширину всех столбцов в диапазоне.

setColumnWidth(columnWidth: number): void;

Параметры

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

Примеры

/**
 * This script inserts a new column and sets that column's width to 100 pixels wide.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();

  // Insert a new column between the current B and C columns.
  const bcRange = currentSheet.getRange("C:C");
  const newColumn = bcRange.insert(ExcelScript.InsertShiftDirection.right);
  
  // Set the column width of the new column to 100 pixels.
  newColumn.getFormat().setColumnWidth(100);
}

Представляет выравнивание по горизонтали для указанного объекта. Дополнительные сведения см. в этой ExcelScript.HorizontalAlignment статье.

setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;

Параметры

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

Примеры

/**
 * This script centers the text in a table's header row cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const table = currentSheet.getTables()[0];

  // Get the header range.
  const headerRange = table.getHeaderRowRange();

  // Set the horizontal text alignment to `center`.
  headerRange.getFormat().setHorizontalAlignment(ExcelScript.HorizontalAlignment.center);
}

Целое число от 0 до 250, указывающее уровень отступа.

setIndentLevel(indentLevel: number): void;

Параметры

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

Задает двойник, который осветляет или затемняет цвет границ диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. null Значение указывает, что вся коллекция границ не имеет единообразного tintAndShade параметра.

setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;

Параметры

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

Направление чтения для диапазона.

setReadingOrder(readingOrder: ReadingOrder): void;

Параметры

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

Задает высоту всех строк в диапазоне.

setRowHeight(rowHeight: number): void;

Параметры

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

Примеры

/**
 * This script inserts a new row and sets that row's width to 100 pixels tall.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();

  // Insert a new row between the current 2 and 3 rows.
  const bcRange = currentSheet.getRange("3:3");
  const newRow = bcRange.insert(ExcelScript.InsertShiftDirection.down);
  
  // Set the row height of the new row to 100 pixels.
  newRow.getFormat().setRowHeight(100);
}

Указывает, будет ли текст автоматически сжиматься в соответствии с доступной шириной столбца.

setShrinkToFit(shrinkToFit: boolean): void;

Параметры

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

Ориентация текста всех ячеек в диапазоне. Ориентация текста должна быть целым числом от -90 до 90 или 180 для вертикально ориентированного текста. Если ориентация в диапазоне не однородна, возвращается null .

setTextOrientation(textOrientation: number): void;

Параметры

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

Определяет, равна ли высота Range строки объекта стандартной высоте листа. Примечание. Это свойство предназначено только для присвоения значения true. Установка значения не false оказывает никакого влияния.

setUseStandardHeight(useStandardHeight: boolean): void;

Параметры

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

Указывает, соответствует ли ширина столбца Range объекта стандартной ширине листа. Примечание. Это свойство предназначено только для присвоения значения true. Установка значения не false оказывает никакого влияния.

setUseStandardWidth(useStandardWidth: boolean): void;

Параметры

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

Представляет выравнивание по вертикали для указанного объекта. Дополнительные сведения см. в этой ExcelScript.VerticalAlignment статье.

setVerticalAlignment(verticalAlignment: VerticalAlignment): void;

Параметры

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

Примеры

/**
 * This script sets the vertical alignment formatting to "top"
 * for every cell in the row.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get row 1 for the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const firstRow = sheet.getRange("1:1");

  // Set the vertical alignment formatting on the row.
  firstRow.getFormat().setVerticalAlignment(ExcelScript.VerticalAlignment.top);
}

Указывает, будет ли Excel переносить текст в объект . null Значение указывает, что для всего диапазона не задано равномерное обертывание.

setWrapText(wrapText: boolean): void;

Параметры

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

Примеры

/**
 * This script turns on the text wrapping for a column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the E column in current worksheet.
  const column = workbook.getActiveWorksheet().getRange("E:E");

  // Set wrap text to true for the column.
  column.getFormat().setWrapText(true);
}