ExcelScript.RangeView interface

Paket:

ExcelScript

RangeView stellt einen Satz von sichtbaren Zellen des übergeordneten Bereichs dar.

Hinweise

Beispiele

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

Methoden

getCellAddresses()	Stellt die Zellenadressen des RangeViewdar.
getColumnCount()	Die Anzahl der sichtbaren Spalten.
getFormulas()	Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
getFormulasLocal()	Stellt die Formel in der A1-Schreibweise, Sprache des Benutzers und im Gebietsschema der Zahlenformatierung dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
getFormulasR1C1()	Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
getIndex()	Gibt einen Wert zurück, der den Index des RangeViewdarstellt.
getNumberFormat()	Stellt den Excel-Zahlenformatcode für die angegebene Zelle dar.
getRange()	Ruft den übergeordneten Bereich ab, der dem aktuellen RangeViewzugeordnet ist.
getRowCount()	Die Anzahl der sichtbaren Zeilen.
getRows()	Stellt eine Sammlung der mit dem Bereich verknüpften Bereichsansichten dar.
getText()	Textwerte des angegebenen Bereichs. Der Textwert hängt nicht von der Zellenbreite ab. Die Ersetzung des #-Zeichens, die in der Excel-Benutzeroberfläche passiert, wirkt sich nicht auf den von der API zurückgegebenen Textwert aus.
getValues()	Stellt die Rohwerte der angegebenen Bereichsansicht dar. Die zurückgegebenen Daten können vom Typ Zeichenfolge, Zahl oder ein boolescher Wert sein. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück.
getValueTypes()	Stellt den Datentyp in jeder Zelle dar.
setFormulas(formulas)	Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
setFormulasLocal(formulasLocal)	Stellt die Formel in der A1-Schreibweise, Sprache des Benutzers und im Gebietsschema der Zahlenformatierung dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
setFormulasR1C1(formulasR1C1)	Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
setNumberFormat(numberFormat)	Stellt den Excel-Zahlenformatcode für die angegebene Zelle dar.
setValues(values)	Stellt die Rohwerte der angegebenen Bereichsansicht dar. Die zurückgegebenen Daten können vom Typ Zeichenfolge, Zahl oder ein boolescher Wert sein. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück.

Details zur Methode

getCellAddresses()

Stellt die Zellenadressen des RangeViewdar.

getCellAddresses(): string[][];

Gibt zurück

string[][]

Beispiele

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

Die Anzahl der sichtbaren Spalten.

getColumnCount(): number;

Gibt zurück

number

getFormulas()

Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

getFormulas(): string[][];

Gibt zurück

string[][]

getFormulasLocal()

Stellt die Formel in der A1-Schreibweise, Sprache des Benutzers und im Gebietsschema der Zahlenformatierung dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

getFormulasLocal(): string[][];

Gibt zurück

string[][]

getFormulasR1C1()

Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

getFormulasR1C1(): string[][];

Gibt zurück

string[][]

getIndex()

Gibt einen Wert zurück, der den Index des RangeViewdarstellt.

getIndex(): number;

Gibt zurück

number

getNumberFormat()

Stellt den Excel-Zahlenformatcode für die angegebene Zelle dar.

getNumberFormat(): string[][];

Gibt zurück

string[][]

getRange()

Ruft den übergeordneten Bereich ab, der dem aktuellen RangeViewzugeordnet ist.

getRange(): Range;

Gibt zurück

ExcelScript.Range

getRowCount()

Die Anzahl der sichtbaren Zeilen.

getRowCount(): number;

Gibt zurück

number

getRows()

Stellt eine Sammlung der mit dem Bereich verknüpften Bereichsansichten dar.

getRows(): RangeView[];

Gibt zurück

ExcelScript.RangeView[]

getText()

Textwerte des angegebenen Bereichs. Der Textwert hängt nicht von der Zellenbreite ab. Die Ersetzung des #-Zeichens, die in der Excel-Benutzeroberfläche passiert, wirkt sich nicht auf den von der API zurückgegebenen Textwert aus.

getText(): string[][];

Gibt zurück

string[][]

getValues()

Stellt die Rohwerte der angegebenen Bereichsansicht dar. Die zurückgegebenen Daten können vom Typ Zeichenfolge, Zahl oder ein boolescher Wert sein. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück.

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

Gibt zurück

(string | number | boolean)[][]

getValueTypes()

Stellt den Datentyp in jeder Zelle dar.

getValueTypes(): RangeValueType[][];

Gibt zurück

ExcelScript.RangeValueType[][]

setFormulas(formulas)

Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

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

Parameter

formulas

string[][]

Gibt zurück

void

setFormulasLocal(formulasLocal)

Stellt die Formel in der A1-Schreibweise, Sprache des Benutzers und im Gebietsschema der Zahlenformatierung dar. Beispielsweise würde die englische Formel „= SUM(A1, 1.5)“ in Deutsch „= SUMME(A1; 1,5)“ werden. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

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

Parameter

formulasLocal

string[][]

Gibt zurück

void

setFormulasR1C1(formulasR1C1)

Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.

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

Parameter

formulasR1C1

string[][]

Gibt zurück

void

setNumberFormat(numberFormat)

Stellt den Excel-Zahlenformatcode für die angegebene Zelle dar.

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

Parameter

numberFormat

string[][]

Gibt zurück

void

setValues(values)

Stellt die Rohwerte der angegebenen Bereichsansicht dar. Die zurückgegebenen Daten können vom Typ Zeichenfolge, Zahl oder ein boolescher Wert sein. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück.

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

Parameter

values

(string | number | boolean)[][]

Gibt zurück

void