ExcelScript.RangeView interface

Paquet:

ExcelScript

RangeView représente un ensemble de cellules visibles de la plage parent.

Remarques

Exemples

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

Méthodes

getCellAddresses()	Représente les adresses de cellule du RangeView.
getColumnCount()	Nombre de colonnes visibles.
getFormulas()	Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
getFormulasLocal()	Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
getFormulasR1C1()	Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
getIndex()	Retourne une valeur qui représente l’index du RangeView.
getNumberFormat()	Représente le code de format de nombre d’Excel pour une cellule donnée.
getRange()	Obtient la plage parente associée au actuel RangeView.
getRowCount()	Nombre de lignes visibles.
getRows()	Représente une collection d’affichages de plage associés à la plage.
getText()	Valeurs de texte de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. Le remplacement par le signe # qui se produit dans l’interface utilisateur d’Excel n’a aucun effet sur la valeur de texte renvoyée par l’API.
getValues()	Représente les valeurs brutes de l’affichage de plage spécifié. Les données renvoyées peuvent être des chaînes, des valeurs numériques ou des valeurs booléennes. Les cellules contenant une erreur renvoie la chaîne d’erreur.
getValueTypes()	Représente le type de données de chaque cellule.
setFormulas(formulas)	Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
setFormulasLocal(formulasLocal)	Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
setFormulasR1C1(formulasR1C1)	Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
setNumberFormat(numberFormat)	Représente le code de format de nombre d’Excel pour une cellule donnée.
setValues(values)	Représente les valeurs brutes de l’affichage de plage spécifié. Les données renvoyées peuvent être des chaînes, des valeurs numériques ou des valeurs booléennes. Les cellules contenant une erreur renvoie la chaîne d’erreur.

Détails de la méthode

getCellAddresses()

Représente les adresses de cellule du RangeView.

getCellAddresses(): string[][];

Retours

string[][]

Exemples

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

getColumnCount()

Nombre de colonnes visibles.

getColumnCount(): number;

Retours

number

getFormulas()

Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

getFormulas(): string[][];

Retours

string[][]

getFormulasLocal()

Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

getFormulasLocal(): string[][];

Retours

string[][]

getFormulasR1C1()

Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

getFormulasR1C1(): string[][];

Retours

string[][]

getIndex()

Retourne une valeur qui représente l’index du RangeView.

getIndex(): number;

Retours

number

getNumberFormat()

Représente le code de format de nombre d’Excel pour une cellule donnée.

getNumberFormat(): string[][];

Retours

string[][]

getRange()

Obtient la plage parente associée au actuel RangeView.

getRange(): Range;

Retours

ExcelScript.Range

getRowCount()

Nombre de lignes visibles.

getRowCount(): number;

Retours

number

getRows()

Représente une collection d’affichages de plage associés à la plage.

getRows(): RangeView[];

Retours

ExcelScript.RangeView[]

getText()

Valeurs de texte de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. Le remplacement par le signe # qui se produit dans l’interface utilisateur d’Excel n’a aucun effet sur la valeur de texte renvoyée par l’API.

getText(): string[][];

Retours

string[][]

getValues()

Représente les valeurs brutes de l’affichage de plage spécifié. Les données renvoyées peuvent être des chaînes, des valeurs numériques ou des valeurs booléennes. Les cellules contenant une erreur renvoie la chaîne d’erreur.

getValues(): (string | number | boolean)[][];

Retours

(string | number | boolean)[][]

getValueTypes()

Représente le type de données de chaque cellule.

getValueTypes(): RangeValueType[][];

Retours

ExcelScript.RangeValueType[][]

setFormulas(formulas)

Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

setFormulas(formulas: string[][]): void;

Paramètres

formulas

string[][]

Retours

void

setFormulasLocal(formulasLocal)

Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

setFormulasLocal(formulasLocal: string[][]): void;

Paramètres

formulasLocal

string[][]

Retours

void

setFormulasR1C1(formulasR1C1)

Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

setFormulasR1C1(formulasR1C1: string[][]): void;

Paramètres

formulasR1C1

string[][]

Retours

void

setNumberFormat(numberFormat)

Représente le code de format de nombre d’Excel pour une cellule donnée.

setNumberFormat(numberFormat: string[][]): void;

Paramètres

numberFormat

string[][]

Retours

void

setValues(values)

Représente les valeurs brutes de l’affichage de plage spécifié. Les données renvoyées peuvent être des chaînes, des valeurs numériques ou des valeurs booléennes. Les cellules contenant une erreur renvoie la chaîne d’erreur.

setValues(values: (string | number | boolean)[][]): void;

Paramètres

values

(string | number | boolean)[][]

Retours

void