ExcelScript.RangeFormat interface

Referência

Pacote:: ExcelScript

Um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

Comentários

Exemplos

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

Métodos

adjustIndent(amount)	Ajusta o recuo da formatação de intervalo. O valor de recuo varia de 0 a 250 e é medido em caracteres.
autofitColumns()	Altera a largura das colunas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.
autofitRows()	Altera a altura das linhas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.
getAutoIndent()	Especifica se o texto é recuado automaticamente quando o alinhamento de texto é definido como distribuição igual.
getBorders()	Coleção de objetos border que se aplicam a todo o intervalo.
getColumnWidth()	Especifica a largura de todas as colunas dentro do intervalo. Se as larguras da coluna não forem uniformes, `null` serão retornadas.
getFill()	Retorna o objeto de preenchimento definido em todo o intervalo.
getFont()	Retorna o objeto font definido em todo o intervalo.
getHorizontalAlignment()	Representa o alinhamento horizontal do objeto especificado. Confira `ExcelScript.HorizontalAlignment` detalhes.
getIndentLevel()	Um número inteiro entre 0 e 250 que indica o nível de recuo.
getProtection()	Retorna o objeto de proteção de formato para um intervalo.
getRangeBorder(index)	Obtém um objeto Border usando o respectivo nome.
getRangeBorderTintAndShade()	Especifica um duplo que clareia ou escure uma cor para bordas de intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um `null` valor indica que toda a coleção de bordas não tem uma configuração uniforme `tintAndShade` .
getReadingOrder()	A ordem de leitura para o intervalo.
getRowHeight()	A altura de todas as linhas no intervalo. Se as alturas da linha não forem uniformes, `null` serão retornadas.
getShrinkToFit()	Especifica se o texto reduz automaticamente para se encaixar na largura da coluna disponível.
getTextOrientation()	A orientação de texto de todas as células dentro do intervalo. A orientação de texto deve ser um inteiro de -90 a 90 ou 180 para texto orientado verticalmente. Se a orientação dentro de um intervalo não for uniforme, será `null` retornada.
getUseStandardHeight()	Determina se a altura da linha do `Range` objeto é igual à altura padrão da folha. Retornará `true` se a altura da linha do `Range` objeto for igual à altura padrão da folha. Retorna `null` se o intervalo contiver mais de uma linha e as linhas não tiverem a mesma altura. Retorna `false` caso contrário.
getUseStandardWidth()	Especifica se a largura da coluna do `Range` objeto é igual à largura padrão da folha. Retornará `true` se a largura da coluna do `Range` objeto for igual à largura padrão da folha. Retorna `null` se o intervalo contiver mais de uma coluna e as colunas não tiverem a mesma altura. Retorna `false` caso contrário.
getVerticalAlignment()	Representa o alinhamento vertical do objeto especificado. Confira `ExcelScript.VerticalAlignment` detalhes.
getWrapText()	Especifica se o Excel encapsula o texto no objeto. Um `null` valor indica que todo o intervalo não tem uma configuração de envoltório uniforme
setAutoIndent(autoIndent)	Especifica se o texto é recuado automaticamente quando o alinhamento de texto é definido como distribuição igual.
setColumnWidth(columnWidth)	Especifica a largura de todas as colunas dentro do intervalo.
setHorizontalAlignment(horizontalAlignment)	Representa o alinhamento horizontal do objeto especificado. Confira `ExcelScript.HorizontalAlignment` detalhes.
setIndentLevel(indentLevel)	Um número inteiro entre 0 e 250 que indica o nível de recuo.
setRangeBorderTintAndShade(rangeBorderTintAndShade)	Especifica um duplo que clareia ou escure uma cor para bordas de intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um `null` valor indica que toda a coleção de bordas não tem uma configuração uniforme `tintAndShade` .
setReadingOrder(readingOrder)	A ordem de leitura para o intervalo.
setRowHeight(rowHeight)	Especifica a altura de todas as linhas no intervalo.
setShrinkToFit(shrinkToFit)	Especifica se o texto reduz automaticamente para se encaixar na largura da coluna disponível.
setTextOrientation(textOrientation)	A orientação de texto de todas as células dentro do intervalo. A orientação de texto deve ser um inteiro de -90 a 90 ou 180 para texto orientado verticalmente. Se a orientação dentro de um intervalo não for uniforme, será `null` retornada.
setUseStandardHeight(useStandardHeight)	Determina se a altura da linha do `Range` objeto é igual à altura padrão da folha. Observação: essa propriedade destina-se apenas a ser definida como `true`. Defini-lo como `false` não tem efeito.
setUseStandardWidth(useStandardWidth)	Especifica se a largura da coluna do `Range` objeto é igual à largura padrão da folha. Observação: essa propriedade destina-se apenas a ser definida como `true`. Defini-lo como `false` não tem efeito.
setVerticalAlignment(verticalAlignment)	Representa o alinhamento vertical do objeto especificado. Confira `ExcelScript.VerticalAlignment` detalhes.
setWrapText(wrapText)	Especifica se o Excel encapsula o texto no objeto. Um `null` valor indica que todo o intervalo não tem uma configuração de envoltório uniforme

Detalhes do método

adjustIndent(amount)

Ajusta o recuo da formatação de intervalo. O valor de recuo varia de 0 a 250 e é medido em caracteres.

adjustIndent(amount: number): void;

Parâmetros

amount: number

O número de espaços de caracteres pelos quais o recuo atual é ajustado. Esse valor deve estar entre -250 e 250. Observação: se o valor elevar o nível de recuo acima de 250, o nível de recuo permanecerá com 250. Da mesma forma, se o valor diminuir o nível de recuo abaixo de 0, o nível de recuo permanecerá 0.

Retornos

void

Exemplos

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

Altera a largura das colunas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.

autofitColumns(): void;

Retornos

void

Exemplos

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

Altera a altura das linhas do intervalo atual para obter o melhor ajuste, com base nos dados atuais nas colunas.

autofitRows(): void;

Retornos

void

Exemplos

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

Especifica se o texto é recuado automaticamente quando o alinhamento de texto é definido como distribuição igual.

getAutoIndent(): boolean;

Retornos

boolean

getBorders()

Coleção de objetos border que se aplicam a todo o intervalo.

getBorders(): RangeBorder[];

Retornos

ExcelScript.RangeBorder[]

getColumnWidth()

Especifica a largura de todas as colunas dentro do intervalo. Se as larguras da coluna não forem uniformes, null serão retornadas.

getColumnWidth(): number;

Retornos

number

Exemplos

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

Retorna o objeto de preenchimento definido em todo o intervalo.

getFill(): RangeFill;

Retornos

ExcelScript.RangeFill

Exemplos

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

Retorna o objeto font definido em todo o intervalo.

getFont(): RangeFont;

Retornos

ExcelScript.RangeFont

Exemplos

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

Representa o alinhamento horizontal do objeto especificado. Confira ExcelScript.HorizontalAlignment detalhes.

getHorizontalAlignment(): HorizontalAlignment;

Retornos

ExcelScript.HorizontalAlignment

getIndentLevel()

Um número inteiro entre 0 e 250 que indica o nível de recuo.

getIndentLevel(): number;

Retornos

number

getProtection()

Retorna o objeto de proteção de formato para um intervalo.

getProtection(): FormatProtection;

Retornos

ExcelScript.FormatProtection

getRangeBorder(index)

Obtém um objeto Border usando o respectivo nome.

getRangeBorder(index: BorderIndex): RangeBorder;

Parâmetros

index: ExcelScript.BorderIndex

Valor de índice do objeto Border a ser recuperado. Confira ExcelScript.BorderIndex detalhes.

Retornos

ExcelScript.RangeBorder

Exemplos

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

Especifica um duplo que clareia ou escure uma cor para bordas de intervalo. O valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null valor indica que toda a coleção de bordas não tem uma configuração uniforme tintAndShade .

getRangeBorderTintAndShade(): number;

Retornos

number

getReadingOrder()

A ordem de leitura para o intervalo.

getReadingOrder(): ReadingOrder;

Retornos

ExcelScript.ReadingOrder

getRowHeight()

A altura de todas as linhas no intervalo. Se as alturas da linha não forem uniformes, null serão retornadas.

getRowHeight(): number;

Retornos

number

Exemplos

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

Especifica se o texto reduz automaticamente para se encaixar na largura da coluna disponível.

getShrinkToFit(): boolean;

Retornos

boolean

getTextOrientation()

A orientação de texto de todas as células dentro do intervalo. A orientação de texto deve ser um inteiro de -90 a 90 ou 180 para texto orientado verticalmente. Se a orientação dentro de um intervalo não for uniforme, será null retornada.

getTextOrientation(): number;

Retornos

number

getUseStandardHeight()

Determina se a altura da linha do Range objeto é igual à altura padrão da folha. Retornará true se a altura da linha do Range objeto for igual à altura padrão da folha. Retorna null se o intervalo contiver mais de uma linha e as linhas não tiverem a mesma altura. Retorna false caso contrário.

getUseStandardHeight(): boolean;

Retornos

boolean

getUseStandardWidth()

Especifica se a largura da coluna do Range objeto é igual à largura padrão da folha. Retornará true se a largura da coluna do Range objeto for igual à largura padrão da folha. Retorna null se o intervalo contiver mais de uma coluna e as colunas não tiverem a mesma altura. Retorna false caso contrário.

getUseStandardWidth(): boolean;

Retornos

boolean

getVerticalAlignment()

Representa o alinhamento vertical do objeto especificado. Confira ExcelScript.VerticalAlignment detalhes.

getVerticalAlignment(): VerticalAlignment;

Retornos

ExcelScript.VerticalAlignment

getWrapText()

Especifica se o Excel encapsula o texto no objeto. Um null valor indica que todo o intervalo não tem uma configuração de envoltório uniforme

getWrapText(): boolean;

Retornos

boolean

setAutoIndent(autoIndent)

Especifica se o texto é recuado automaticamente quando o alinhamento de texto é definido como distribuição igual.

setAutoIndent(autoIndent: boolean): void;

Parâmetros

autoIndent: boolean

Retornos

void

setColumnWidth(columnWidth)

Especifica a largura de todas as colunas dentro do intervalo.

setColumnWidth(columnWidth: number): void;

Parâmetros

columnWidth: number

Retornos

void

Exemplos

/**
 * 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)

Representa o alinhamento horizontal do objeto especificado. Confira ExcelScript.HorizontalAlignment detalhes.

setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;

Parâmetros

horizontalAlignment: ExcelScript.HorizontalAlignment

Retornos

void

Exemplos

/**
 * 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)

Um número inteiro entre 0 e 250 que indica o nível de recuo.

setIndentLevel(indentLevel: number): void;

Parâmetros

indentLevel: number

Retornos

void

setRangeBorderTintAndShade(rangeBorderTintAndShade)

setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;

Parâmetros

rangeBorderTintAndShade: number

Retornos

void

setReadingOrder(readingOrder)

A ordem de leitura para o intervalo.

setReadingOrder(readingOrder: ReadingOrder): void;

Parâmetros

readingOrder: ExcelScript.ReadingOrder

Retornos

void

setRowHeight(rowHeight)

Especifica a altura de todas as linhas no intervalo.

setRowHeight(rowHeight: number): void;

Parâmetros

rowHeight: number

Retornos

void

Exemplos

/**
 * 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)

Especifica se o texto reduz automaticamente para se encaixar na largura da coluna disponível.

setShrinkToFit(shrinkToFit: boolean): void;

Parâmetros

shrinkToFit: boolean

Retornos

void

setTextOrientation(textOrientation)

setTextOrientation(textOrientation: number): void;

Parâmetros

textOrientation: number

Retornos

void

setUseStandardHeight(useStandardHeight)

Determina se a altura da linha do Range objeto é igual à altura padrão da folha. Observação: essa propriedade destina-se apenas a ser definida como true. Defini-lo como false não tem efeito.

setUseStandardHeight(useStandardHeight: boolean): void;

Parâmetros

useStandardHeight: boolean

Retornos

void

setUseStandardWidth(useStandardWidth)

Especifica se a largura da coluna do Range objeto é igual à largura padrão da folha. Observação: essa propriedade destina-se apenas a ser definida como true. Defini-lo como false não tem efeito.

setUseStandardWidth(useStandardWidth: boolean): void;

Parâmetros

useStandardWidth: boolean

Retornos

void

setVerticalAlignment(verticalAlignment)

Representa o alinhamento vertical do objeto especificado. Confira ExcelScript.VerticalAlignment detalhes.

setVerticalAlignment(verticalAlignment: VerticalAlignment): void;

Parâmetros

verticalAlignment: ExcelScript.VerticalAlignment

Retornos

void

Exemplos

/**
 * 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)

Especifica se o Excel encapsula o texto no objeto. Um null valor indica que todo o intervalo não tem uma configuração de envoltório uniforme

setWrapText(wrapText: boolean): void;

Parâmetros

wrapText: boolean

Retornos

void

Exemplos

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