ExcelScript.RangeFormat interface

参考

包:: ExcelScript

一个格式对象，其中封装了区域的字体、填充、边框、对齐方式和其他属性。

注解

示例

/**
 * This script applies some simple formatting to the top row of the used range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the top row of the used range in the current worksheet.
  const selectedSheet = workbook.getActiveWorksheet();
  const topRow = selectedSheet.getUsedRange().getRow(0);

  // For the top row, set the fill to black, the font color to white, and the font to be bold.
  const format: ExcelScript.RangeFormat = topRow.getFormat();
  format.getFill().setColor("black");
  format.getFont().setColor("white");
  format.getFont().setBold(true);
}

方法

adjustIndent(amount)	调整区域格式的缩进。缩进值范围为 0 到 250，以字符为单位。
autofitColumns()	根据列中的当前数据更改当前范围的列宽，以达到最佳宽度。
autofitRows()	根据列中的当前数据，更改当前范围的行高以达到最佳高度。
getAutoIndent()	指定当文本对齐方式设置为相等分布时，是否自动缩进文本。
getBorders()	应用于整个区域的 Border 对象的集合。
getColumnWidth()	指定范围内所有列的宽度。如果列宽不一致， `null` 将返回。
getFill()	返回在整个区域内定义的 fill 对象。
getFont()	返回在整个区域内定义的 Font 对象。
getHorizontalAlignment()	表示指定对象的水平对齐方式。有关详细信息，请参阅 `ExcelScript.HorizontalAlignment`。
getIndentLevel()	0 到 250 之间的一个整数，指示缩进水平。
getProtection()	返回某一区域的格式 protection 对象。
getRangeBorder(index)	使用其名称获取 border 对象
getRangeBorderTintAndShade()	指定一个使范围边框的颜色变浅或变暗的双精度值。该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。值 `null` 指示整个边框集合没有统 `tintAndShade` 一设置。
getReadingOrder()	区域的读取顺序。
getRowHeight()	范围中所有行的高度。如果行高度不一致， `null` 将返回。
getShrinkToFit()	指定文本是否自动收缩以适应可用的列宽。
getTextOrientation()	区域中所有单元格的文本方向。对于垂直方向文本，文本方向应为 -90 到 90 或 180 的整数。如果范围内的方向不一致，则会 `null` 返回。
getUseStandardHeight()	确定对象的行高 `Range` 是否等于工作表的标准高度。 `true`如果对象的行高度`Range`等于工作表的标准高度，则返回。 `null`如果区域包含多行且行的高度不相同，则返回。否则返回 `false` 。
getUseStandardWidth()	指定对象的列宽 `Range` 是否等于工作表的标准宽度。 `true`如果对象的列宽`Range`等于工作表的标准宽度，则返回。 `null`如果区域包含多个列且各列的高度不同，则返回。否则返回 `false` 。
getVerticalAlignment()	表示指定对象的垂直对齐方式。有关详细信息，请参阅 `ExcelScript.VerticalAlignment`。
getWrapText()	指定 Excel 是否包装对象中的文本。值 `null` 指示整个区域没有统一换行设置
setAutoIndent(autoIndent)	指定当文本对齐方式设置为相等分布时，是否自动缩进文本。
setColumnWidth(columnWidth)	指定范围内所有列的宽度。
setHorizontalAlignment(horizontalAlignment)	表示指定对象的水平对齐方式。有关详细信息，请参阅 `ExcelScript.HorizontalAlignment`。
setIndentLevel(indentLevel)	0 到 250 之间的一个整数，指示缩进水平。
setRangeBorderTintAndShade(rangeBorderTintAndShade)	指定一个使范围边框的颜色变浅或变暗的双精度值。该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。值 `null` 指示整个边框集合没有统 `tintAndShade` 一设置。
setReadingOrder(readingOrder)	区域的读取顺序。
setRowHeight(rowHeight)	指定范围中所有行的高度。
setShrinkToFit(shrinkToFit)	指定文本是否自动收缩以适应可用的列宽。
setTextOrientation(textOrientation)	区域中所有单元格的文本方向。对于垂直方向文本，文本方向应为 -90 到 90 或 180 的整数。如果范围内的方向不一致，则会 `null` 返回。
setUseStandardHeight(useStandardHeight)	确定对象的行高 `Range` 是否等于工作表的标准高度。注意：此属性仅用于设置为 `true`。将其设置为 `false` 不起作用。
setUseStandardWidth(useStandardWidth)	指定对象的列宽 `Range` 是否等于工作表的标准宽度。注意：此属性仅用于设置为 `true`。将其设置为 `false` 不起作用。
setVerticalAlignment(verticalAlignment)	表示指定对象的垂直对齐方式。有关详细信息，请参阅 `ExcelScript.VerticalAlignment`。
setWrapText(wrapText)	指定 Excel 是否包装对象中的文本。值 `null` 指示整个区域没有统一换行设置

方法详细信息

adjustIndent(amount)

调整区域格式的缩进。缩进值范围为 0 到 250，以字符为单位。

adjustIndent(amount: number): void;

参数

amount: number

调整当前缩进所依据的字符空格数。此值应介于 -250 和 250 之间。注意：如果金额将缩进级别提高到 250 以上，缩进级别将保持 250。同样，如果量将缩进级别降低到 0 以下，缩进级别将保持 0。

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()

根据列中的当前数据更改当前范围的列宽，以达到最佳宽度。

autofitColumns(): void;

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()

根据列中的当前数据，更改当前范围的行高以达到最佳高度。

autofitRows(): void;

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()

指定当文本对齐方式设置为相等分布时，是否自动缩进文本。

getAutoIndent(): boolean;

boolean

getBorders()

应用于整个区域的 Border 对象的集合。

getBorders(): RangeBorder[];

ExcelScript.RangeBorder[]

getColumnWidth()

指定范围内所有列的宽度。如果列宽不一致， null 将返回。

getColumnWidth(): number;

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()

返回在整个区域内定义的 fill 对象。

getFill(): RangeFill;

ExcelScript.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()

返回在整个区域内定义的 Font 对象。

getFont(): RangeFont;

ExcelScript.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);
}

getHorizontalAlignment()

表示指定对象的水平对齐方式。有关详细信息，请参阅 ExcelScript.HorizontalAlignment。

getHorizontalAlignment(): HorizontalAlignment;

ExcelScript.HorizontalAlignment

getIndentLevel()

0 到 250 之间的一个整数，指示缩进水平。

getIndentLevel(): number;

number

getProtection()

返回某一区域的格式 protection 对象。

getProtection(): FormatProtection;

ExcelScript.FormatProtection

getRangeBorder(index)

使用其名称获取 border 对象

getRangeBorder(index: BorderIndex): RangeBorder;

参数

index: ExcelScript.BorderIndex

要检索的 border 对象的索引值。有关详细信息，请参阅 ExcelScript.BorderIndex。

ExcelScript.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
}

getRangeBorderTintAndShade()

指定一个使范围边框的颜色变浅或变暗的双精度值。该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。值 null 指示整个边框集合没有统 tintAndShade 一设置。

getRangeBorderTintAndShade(): number;

number

getReadingOrder()

区域的读取顺序。

getReadingOrder(): ReadingOrder;

ExcelScript.ReadingOrder

getRowHeight()

范围中所有行的高度。如果行高度不一致， null 将返回。

getRowHeight(): number;

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()

指定文本是否自动收缩以适应可用的列宽。

getShrinkToFit(): boolean;

boolean

getTextOrientation()

区域中所有单元格的文本方向。对于垂直方向文本，文本方向应为 -90 到 90 或 180 的整数。如果范围内的方向不一致，则会 null 返回。

getTextOrientation(): number;

number

getUseStandardHeight()

确定对象的行高 Range 是否等于工作表的标准高度。 true如果对象的行高度Range等于工作表的标准高度，则返回。 null如果区域包含多行且行的高度不相同，则返回。否则返回 false 。

getUseStandardHeight(): boolean;

boolean

getUseStandardWidth()

指定对象的列宽 Range 是否等于工作表的标准宽度。 true如果对象的列宽Range等于工作表的标准宽度，则返回。 null如果区域包含多个列且各列的高度不同，则返回。否则返回 false 。

getUseStandardWidth(): boolean;

boolean

getVerticalAlignment()

表示指定对象的垂直对齐方式。有关详细信息，请参阅 ExcelScript.VerticalAlignment。

getVerticalAlignment(): VerticalAlignment;

ExcelScript.VerticalAlignment

getWrapText()

指定 Excel 是否包装对象中的文本。值 null 指示整个区域没有统一换行设置

getWrapText(): boolean;

boolean

setAutoIndent(autoIndent)

指定当文本对齐方式设置为相等分布时，是否自动缩进文本。

setAutoIndent(autoIndent: boolean): void;

参数

autoIndent: boolean

void

setColumnWidth(columnWidth)

指定范围内所有列的宽度。

setColumnWidth(columnWidth: number): void;

参数

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);
}

setHorizontalAlignment(horizontalAlignment)

表示指定对象的水平对齐方式。有关详细信息，请参阅 ExcelScript.HorizontalAlignment。

setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;

参数

horizontalAlignment: ExcelScript.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);
}

setIndentLevel(indentLevel)

0 到 250 之间的一个整数，指示缩进水平。

setIndentLevel(indentLevel: number): void;

参数

indentLevel: number

void

setRangeBorderTintAndShade(rangeBorderTintAndShade)

setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;

参数

rangeBorderTintAndShade: number

void

setReadingOrder(readingOrder)

区域的读取顺序。

setReadingOrder(readingOrder: ReadingOrder): void;

参数

readingOrder: ExcelScript.ReadingOrder

void

setRowHeight(rowHeight)

指定范围中所有行的高度。

setRowHeight(rowHeight: number): void;

参数

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)

指定文本是否自动收缩以适应可用的列宽。

setShrinkToFit(shrinkToFit: boolean): void;

参数

shrinkToFit: boolean

void

setTextOrientation(textOrientation)

区域中所有单元格的文本方向。对于垂直方向文本，文本方向应为 -90 到 90 或 180 的整数。如果范围内的方向不一致，则会 null 返回。

setTextOrientation(textOrientation: number): void;

参数

textOrientation: number

void

setUseStandardHeight(useStandardHeight)

确定对象的行高 Range 是否等于工作表的标准高度。注意：此属性仅用于设置为 true。将其设置为 false 不起作用。

setUseStandardHeight(useStandardHeight: boolean): void;

参数

useStandardHeight: boolean

void

setUseStandardWidth(useStandardWidth)

指定对象的列宽 Range 是否等于工作表的标准宽度。注意：此属性仅用于设置为 true。将其设置为 false 不起作用。

setUseStandardWidth(useStandardWidth: boolean): void;

参数

useStandardWidth: boolean

void

setVerticalAlignment(verticalAlignment)

表示指定对象的垂直对齐方式。有关详细信息，请参阅 ExcelScript.VerticalAlignment。

setVerticalAlignment(verticalAlignment: VerticalAlignment): void;

参数

verticalAlignment: ExcelScript.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);
}

setWrapText(wrapText)

指定 Excel 是否包装对象中的文本。值 null 指示整个区域没有统一换行设置

setWrapText(wrapText: boolean): void;

参数

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);
}

通过

ExcelScript.RangeFormat interface

注解

示例

方法

方法详细信息

adjustIndent(amount)

参数

返回

示例

autofitColumns()

返回

示例

autofitRows()

返回

示例

getAutoIndent()

返回

getBorders()

返回

getColumnWidth()

返回

示例

getFill()

返回

示例

getFont()

返回

示例

getHorizontalAlignment()

返回

getIndentLevel()

返回

getProtection()

返回

getRangeBorder(index)

参数

返回

示例

getRangeBorderTintAndShade()

返回

getReadingOrder()

返回

getRowHeight()

返回

示例

getShrinkToFit()

返回

getTextOrientation()

返回

getUseStandardHeight()

返回

getUseStandardWidth()

返回

getVerticalAlignment()

返回

getWrapText()

返回

setAutoIndent(autoIndent)

参数

返回

setColumnWidth(columnWidth)

参数

返回

示例

setHorizontalAlignment(horizontalAlignment)

参数

返回

示例

setIndentLevel(indentLevel)

参数

返回

setRangeBorderTintAndShade(rangeBorderTintAndShade)

参数

返回

setReadingOrder(readingOrder)

参数

返回

setRowHeight(rowHeight)

参数