ExcelScript.RangeFormat interface

Référence

Paquet:: ExcelScript

Objet de format qui comprend les propriétés de police, de remplissage, de bordures, d’alignement et d’autres propriétés de la plage.

Remarques

Exemples

/**
 * 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éthodes

adjustIndent(amount)	Ajuste la mise en retrait de la mise en forme de la plage. La valeur de retrait est comprise entre 0 et 250 et est mesurée en caractères.
autofitColumns()	Modifie la largeur des colonnes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.
autofitRows()	Modifie la hauteur des lignes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.
getAutoIndent()	Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte est défini sur une distribution égale.
getBorders()	Collection d’objets de bordure qui s’appliquent à l’ensemble de la plage.
getColumnWidth()	Spécifie la largeur de toutes les colonnes de la plage. Si les largeurs de colonne ne sont pas uniformes, `null` est retourné.
getFill()	Renvoie l’objet de remplissage défini sur la plage globale.
getFont()	Renvoie l’objet de police défini sur l’ensemble de la plage.
getHorizontalAlignment()	Représente l’alignement horizontal de l’objet spécifié. Pour plus d’informations, consultez `ExcelScript.HorizontalAlignment` .
getIndentLevel()	Entier compris entre 0 à 250 qui indique le niveau de retrait du style.
getProtection()	Renvoie l’objet de protection du format pour une plage.
getRangeBorder(index)	Obtient un objet de bordure à l’aide de son nom.
getRangeBorderTintAndShade()	Spécifie un double qui éclaircit ou assombrit une couleur pour les bordures de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une `null` valeur indique que l’ensemble de la collection de bordures n’a pas de paramètre uniforme `tintAndShade` .
getReadingOrder()	L’ordre de lecture de la plage.
getRowHeight()	Hauteur de toutes les lignes de la plage. Si les hauteurs de ligne ne sont pas uniformes, `null` est retourné.
getShrinkToFit()	Spécifie si le texte se réduit automatiquement pour s’adapter à la largeur de colonne disponible.
getTextOrientation()	Orientation du texte de toutes les cellules de la plage. L’orientation du texte doit être un entier compris entre -90 et 90, ou 180 pour le texte orienté verticalement. Si l’orientation au sein d’une plage n’est pas uniforme, `null` elle est retournée.
getUseStandardHeight()	Détermine si la hauteur de ligne de l’objet `Range` est égale à la hauteur standard de la feuille. Retourne `true` si la hauteur de ligne de l’objet `Range` est égale à la hauteur standard de la feuille. Retourne `null` si la plage contient plusieurs lignes et que les lignes n’ont pas toutes la même hauteur. Retourne `false` dans le cas contraire.
getUseStandardWidth()	Spécifie si la largeur de colonne de l’objet `Range` est égale à la largeur standard de la feuille. Retourne `true` si la largeur de colonne de l’objet `Range` est égale à la largeur standard de la feuille. Retourne `null` si la plage contient plusieurs colonnes et que les colonnes ne sont pas toutes de la même hauteur. Retourne `false` dans le cas contraire.
getVerticalAlignment()	Représente l’alignement vertical de l’objet spécifié. Pour plus d’informations, consultez `ExcelScript.VerticalAlignment` .
getWrapText()	Spécifie si Excel encapsule le texte dans l’objet. Une `null` valeur indique que la plage entière n’a pas de paramètre d’habillage uniforme
setAutoIndent(autoIndent)	Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte est défini sur une distribution égale.
setColumnWidth(columnWidth)	Spécifie la largeur de toutes les colonnes de la plage.
setHorizontalAlignment(horizontalAlignment)	Représente l’alignement horizontal de l’objet spécifié. Pour plus d’informations, consultez `ExcelScript.HorizontalAlignment` .
setIndentLevel(indentLevel)	Entier compris entre 0 à 250 qui indique le niveau de retrait du style.
setRangeBorderTintAndShade(rangeBorderTintAndShade)	Spécifie un double qui éclaircit ou assombrit une couleur pour les bordures de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une `null` valeur indique que l’ensemble de la collection de bordures n’a pas de paramètre uniforme `tintAndShade` .
setReadingOrder(readingOrder)	L’ordre de lecture de la plage.
setRowHeight(rowHeight)	Spécifie la hauteur de toutes les lignes de la plage.
setShrinkToFit(shrinkToFit)	Spécifie si le texte se réduit automatiquement pour s’adapter à la largeur de colonne disponible.
setTextOrientation(textOrientation)	Orientation du texte de toutes les cellules de la plage. L’orientation du texte doit être un entier compris entre -90 et 90, ou 180 pour le texte orienté verticalement. Si l’orientation au sein d’une plage n’est pas uniforme, `null` elle est retournée.
setUseStandardHeight(useStandardHeight)	Détermine si la hauteur de ligne de l’objet `Range` est égale à la hauteur standard de la feuille. Remarque : cette propriété est uniquement destinée à être définie sur `true`. La définition de la valeur `false` sur n’a aucun effet.
setUseStandardWidth(useStandardWidth)	Spécifie si la largeur de colonne de l’objet `Range` est égale à la largeur standard de la feuille. Remarque : cette propriété est uniquement destinée à être définie sur `true`. La définition de la valeur `false` sur n’a aucun effet.
setVerticalAlignment(verticalAlignment)	Représente l’alignement vertical de l’objet spécifié. Pour plus d’informations, consultez `ExcelScript.VerticalAlignment` .
setWrapText(wrapText)	Spécifie si Excel encapsule le texte dans l’objet. Une `null` valeur indique que la plage entière n’a pas de paramètre d’habillage uniforme

Détails de la méthode

adjustIndent(amount)

Ajuste la mise en retrait de la mise en forme de la plage. La valeur de retrait est comprise entre 0 et 250 et est mesurée en caractères.

adjustIndent(amount: number): void;

Paramètres

amount: number

Nombre d’espaces de caractères par lesquels le retrait actuel est ajusté. Cette valeur doit être comprise entre -250 et 250. Remarque : Si le montant augmente le niveau de retrait au-dessus de 250, le niveau de retrait reste avec 250. De même, si le montant abaisse le niveau de retrait en dessous de 0, le niveau de retrait reste 0.

Retours

void

Exemples

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

Modifie la largeur des colonnes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.

autofitColumns(): void;

Retours

void

Exemples

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

Modifie la hauteur des lignes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.

autofitRows(): void;

Retours

void

Exemples

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

Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte est défini sur une distribution égale.

getAutoIndent(): boolean;

Retours

boolean

getBorders()

Collection d’objets de bordure qui s’appliquent à l’ensemble de la plage.

getBorders(): RangeBorder[];

Retours

ExcelScript.RangeBorder[]

getColumnWidth()

Spécifie la largeur de toutes les colonnes de la plage. Si les largeurs de colonne ne sont pas uniformes, null est retourné.

getColumnWidth(): number;

Retours

number

Exemples

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

Renvoie l’objet de remplissage défini sur la plage globale.

getFill(): RangeFill;

Retours

ExcelScript.RangeFill

Exemples

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

Renvoie l’objet de police défini sur l’ensemble de la plage.

getFont(): RangeFont;

Retours

ExcelScript.RangeFont

Exemples

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

Représente l’alignement horizontal de l’objet spécifié. Pour plus d’informations, consultez ExcelScript.HorizontalAlignment .

getHorizontalAlignment(): HorizontalAlignment;

Retours

ExcelScript.HorizontalAlignment

getIndentLevel()

Entier compris entre 0 à 250 qui indique le niveau de retrait du style.

getIndentLevel(): number;

Retours

number

getProtection()

Renvoie l’objet de protection du format pour une plage.

getProtection(): FormatProtection;

Retours

ExcelScript.FormatProtection

getRangeBorder(index)

Obtient un objet de bordure à l’aide de son nom.

getRangeBorder(index: BorderIndex): RangeBorder;

Paramètres

index: ExcelScript.BorderIndex

Valeur d’indice de l’objet de bordure à récupérer. Pour plus d’informations, consultez ExcelScript.BorderIndex .

Retours

ExcelScript.RangeBorder

Exemples

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

Spécifie un double qui éclaircit ou assombrit une couleur pour les bordures de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que l’ensemble de la collection de bordures n’a pas de paramètre uniforme tintAndShade .

getRangeBorderTintAndShade(): number;

Retours

number

getReadingOrder()

L’ordre de lecture de la plage.

getReadingOrder(): ReadingOrder;

Retours

ExcelScript.ReadingOrder

getRowHeight()

Hauteur de toutes les lignes de la plage. Si les hauteurs de ligne ne sont pas uniformes, null est retourné.

getRowHeight(): number;

Retours

number

Exemples

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

Spécifie si le texte se réduit automatiquement pour s’adapter à la largeur de colonne disponible.

getShrinkToFit(): boolean;

Retours

boolean

getTextOrientation()

Orientation du texte de toutes les cellules de la plage. L’orientation du texte doit être un entier compris entre -90 et 90, ou 180 pour le texte orienté verticalement. Si l’orientation au sein d’une plage n’est pas uniforme, null elle est retournée.

getTextOrientation(): number;

Retours

number

getUseStandardHeight()

Détermine si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Retourne true si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Retourne null si la plage contient plusieurs lignes et que les lignes n’ont pas toutes la même hauteur. Retourne false dans le cas contraire.

getUseStandardHeight(): boolean;

Retours

boolean

getUseStandardWidth()

Spécifie si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Retourne true si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Retourne null si la plage contient plusieurs colonnes et que les colonnes ne sont pas toutes de la même hauteur. Retourne false dans le cas contraire.

getUseStandardWidth(): boolean;

Retours

boolean

getVerticalAlignment()

Représente l’alignement vertical de l’objet spécifié. Pour plus d’informations, consultez ExcelScript.VerticalAlignment .

getVerticalAlignment(): VerticalAlignment;

Retours

ExcelScript.VerticalAlignment

getWrapText()

Spécifie si Excel encapsule le texte dans l’objet. Une null valeur indique que la plage entière n’a pas de paramètre d’habillage uniforme

getWrapText(): boolean;

Retours

boolean

setAutoIndent(autoIndent)

Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte est défini sur une distribution égale.

setAutoIndent(autoIndent: boolean): void;

Paramètres

autoIndent: boolean

Retours

void

setColumnWidth(columnWidth)

Spécifie la largeur de toutes les colonnes de la plage.

setColumnWidth(columnWidth: number): void;

Paramètres

columnWidth: number

Retours

void

Exemples

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

Représente l’alignement horizontal de l’objet spécifié. Pour plus d’informations, consultez ExcelScript.HorizontalAlignment .

setHorizontalAlignment(horizontalAlignment: HorizontalAlignment): void;

Paramètres

horizontalAlignment: ExcelScript.HorizontalAlignment

Retours

void

Exemples

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

Entier compris entre 0 à 250 qui indique le niveau de retrait du style.

setIndentLevel(indentLevel: number): void;

Paramètres

indentLevel: number

Retours

void

setRangeBorderTintAndShade(rangeBorderTintAndShade)

setRangeBorderTintAndShade(rangeBorderTintAndShade: number): void;

Paramètres

rangeBorderTintAndShade: number

Retours

void

setReadingOrder(readingOrder)

L’ordre de lecture de la plage.

setReadingOrder(readingOrder: ReadingOrder): void;

Paramètres

readingOrder: ExcelScript.ReadingOrder

Retours

void

setRowHeight(rowHeight)

Spécifie la hauteur de toutes les lignes de la plage.

setRowHeight(rowHeight: number): void;

Paramètres

rowHeight: number

Retours

void

Exemples

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

Spécifie si le texte se réduit automatiquement pour s’adapter à la largeur de colonne disponible.

setShrinkToFit(shrinkToFit: boolean): void;

Paramètres

shrinkToFit: boolean

Retours

void

setTextOrientation(textOrientation)

setTextOrientation(textOrientation: number): void;

Paramètres

textOrientation: number

Retours

void

setUseStandardHeight(useStandardHeight)

Détermine si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Remarque : cette propriété est uniquement destinée à être définie sur true. La définition de la valeur false sur n’a aucun effet.

setUseStandardHeight(useStandardHeight: boolean): void;

Paramètres

useStandardHeight: boolean

Retours

void

setUseStandardWidth(useStandardWidth)

Spécifie si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Remarque : cette propriété est uniquement destinée à être définie sur true. La définition de la valeur false sur n’a aucun effet.

setUseStandardWidth(useStandardWidth: boolean): void;

Paramètres

useStandardWidth: boolean

Retours

void

setVerticalAlignment(verticalAlignment)

Représente l’alignement vertical de l’objet spécifié. Pour plus d’informations, consultez ExcelScript.VerticalAlignment .

setVerticalAlignment(verticalAlignment: VerticalAlignment): void;

Paramètres

verticalAlignment: ExcelScript.VerticalAlignment

Retours

void

Exemples

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

Spécifie si Excel encapsule le texte dans l’objet. Une null valeur indique que la plage entière n’a pas de paramètre d’habillage uniforme

setWrapText(wrapText: boolean): void;

Paramètres

wrapText: boolean

Retours

void

Exemples

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

Partager via

ExcelScript.RangeFormat interface

Remarques

Exemples

Méthodes

Détails de la méthode

adjustIndent(amount)

Paramètres

Retours

Exemples

autofitColumns()

Retours

Exemples

autofitRows()

Retours

Exemples

getAutoIndent()

Retours

getBorders()

Retours

getColumnWidth()

Retours

Exemples

getFill()

Retours

Exemples

getFont()

Retours

Exemples

getHorizontalAlignment()

Retours

getIndentLevel()

Retours

getProtection()

Retours

getRangeBorder(index)

Paramètres

Retours

Exemples

getRangeBorderTintAndShade()

Retours

getReadingOrder()

Retours

getRowHeight()

Retours

Exemples

getShrinkToFit()

Retours

getTextOrientation()

Retours

getUseStandardHeight()

Retours

getUseStandardWidth()

Retours

getVerticalAlignment()

Retours

getWrapText()

Retours

setAutoIndent(autoIndent)

Paramètres

Retours

setColumnWidth(columnWidth)

Paramètres

Retours

Exemples

setHorizontalAlignment(horizontalAlignment)

Paramètres

Retours

Exemples

setIndentLevel(indentLevel)

Paramètres

Retours

setRangeBorderTintAndShade(rangeBorderTintAndShade)

Paramètres

Retours

setReadingOrder(readingOrder)

Paramètres

Retours

setRowHeight(rowHeight)

Paramètres