Excel.Range class

Referenz

Paket:: excel

Range stellt eine Gruppe von einer oder mehreren zusammenhängenden Zellen dar, z. B. eine Zelle, eine Zeile, eine Spalte oder einen Zellblock. Wenn Sie mehr darüber erfahren möchten, wie Bereiche in der API verwendet werden, beginnen Sie mit Bereiche in der Excel-JavaScript-API.

Extends: OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

// Get a Range object by its address.
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const cell = range.getCell(0,0);
    cell.load('address');
    await context.sync();
    
    console.log(cell.address);
});

Eigenschaften

address	Gibt den Bereichsverweis im A1-Format an. Der Adresswert enthält den Blattverweis (z. B. "Sheet1! A1:B4").
addressLocal	Stellt den Bereichsverweis für den angegebenen Bereich in der Sprache des Benutzers dar.
cellCount	Gibt die Anzahl der Zellen im Bereich an. Diese API gibt -1 zurück, wenn die Zellenanzahl 2^31-1 (2.147.483.647) überschreitet.
columnCount	Gibt die Gesamtanzahl der Spalten im Bereich an.
columnHidden	Stellt dar, ob alle Spalten im aktuellen Bereich ausgeblendet sind. Der Wert ist `true` , wenn alle Spalten in einem Bereich ausgeblendet sind. Der Wert ist `false` , wenn keine Spalten im Bereich ausgeblendet werden. Der Wert ist `null` , wenn einige Spalten in einem Bereich ausgeblendet sind und andere Spalten im gleichen Bereich nicht ausgeblendet werden.
columnIndex	Gibt die Spaltennummer der ersten Zelle im Bereich an. Nullindiziert.
conditionalFormats	Die Auflistung von `ConditionalFormats` , die den Bereich überschneidet.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
format	Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.
formulas	Stellt die Formel in der A1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
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.
formulasR1C1	Stellt die Formel in der R1C1-Schreibweise dar. Wenn eine Zelle keine Formel enthält, wird stattdessen ihr Wert zurückgegeben.
hidden	Stellt dar, ob alle Zellen im aktuellen Bereich ausgeblendet sind. Der Wert ist `true` , wenn alle Zellen in einem Bereich ausgeblendet sind. Der Wert ist `false` , wenn keine Zellen im Bereich ausgeblendet werden. Wert ist `null` , wenn einige Zellen in einem Bereich ausgeblendet sind und andere Zellen im gleichen Bereich nicht ausgeblendet werden.
numberFormat	Stellt den Zahlenformatcode von Excel für den angegebenen Bereich dar. Weitere Informationen zur Excel-Zahlenformatierung finden Sie unter Zahlenformatcodes.
rowCount	Gibt die Anzahl der Zeilen im Bereich zurück.
rowHidden	Stellt dar, ob alle Zeilen im aktuellen Bereich ausgeblendet sind. Value ist `true` , wenn alle Zeilen in einem Bereich ausgeblendet sind. Der Wert ist `false` , wenn keine Zeilen im Bereich ausgeblendet werden. Der Wert ist `null` , wenn einige Zeilen in einem Bereich ausgeblendet sind und andere Zeilen im gleichen Bereich nicht ausgeblendet werden.
rowIndex	Gibt die Spaltenanzahl der ersten Zelle im Bereich zurück. Nullindiziert.
sort	Stellt die Bereichssortierung des aktuellen Bereichs dar.
text	Textwerte des angegebenen Bereichs. Der Textwert hängt nicht von der Zellenbreite ab. Die Ersetzung des Nummernzeichens (#), die in der Excel-Benutzeroberfläche erfolgt, wirkt sich nicht auf den von der API zurückgegebenen Textwert aus.
values	Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um eine Zeichenfolge, eine Zahl oder einen booleschen Wert handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), minus ("-") oder Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.
valueTypes	Gibt den Datentyp in jeder Zelle an.
worksheet	Das Arbeitsblatt, das den aktuellen Bereich enthält.

Methoden

calculate()	Berechnet einen Zellbereich auf einem Arbeitsblatt.
clear(applyTo)	Löscht Bereichswerte, Format, Füllung, Rahmen usw.
clear(applyToString)	Löscht Bereichswerte, Format, Füllung, Rahmen usw.
delete(shift)	Löscht die dem Bereich zugeordneten Zellen.
delete(shiftString)	Löscht die dem Bereich zugeordneten Zellen.
getBoundingRect(anotherRange)	Ruft das kleinste Bereichsobjekt ab, das die angegebenen Bereiche umfasst. Beispielsweise ist die `GetBoundingRect` von "B2:C5" und "D10:E15" "B2:E15".
getCell(row, column)	Ruft das Bereichsobjekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltenanzahl enthält. Die Zelle kann sich außerhalb der Grenzen ihres übergeordneten Bereichs befinden, solange sie im Arbeitsblattraster verbleibt. Die zurückgegebene Zelle befindet sich relativ zur obersten linken Zelle des Bereichs.
getColumn(column)	Ruft eine Spalte ab, die im Bereich enthalten ist.
getColumnsAfter(count)	Ruft eine bestimmte Anzahl von Spalten rechts vom aktuellen `Range` -Objekt ab.
getColumnsBefore(count)	Ruft eine bestimmte Anzahl von Spalten links vom aktuellen `Range` -Objekt ab.
getEntireColumn()	Ruft ein -Objekt ab, das die gesamte Spalte des Bereichs darstellt (wenn der aktuelle Bereich z. B. zellen "B4:E11" darstellt, ist es `getEntireColumn` ein Bereich, der spalten "B:E") darstellt.
getEntireRow()	Ruft ein -Objekt ab, das die gesamte Zeile des Bereichs darstellt (wenn der aktuelle Bereich z. B. zellen "B4:E11" darstellt, ist es `GetEntireRow` ein Bereich, der die Zeilen "4:11" darstellt).
getIntersection(anotherRange)	Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt.
getIntersectionOrNullObject(anotherRange)	Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getLastCell()	Ruft die letzte Zelle im Bereich ab. Beispielsweise lautet die letzte Zelle des Bereichs „B2: D5“ „D5“.
getLastColumn()	Ruft die letzte Spalte im Bereich ab. Beispielsweise lautet die letzte Spalte von „B2:D5“ „D2:D5“.
getLastRow()	Ruft die letzte Zeile im Bereich ab. Beispielsweise lautet die letzte Zelle des Bereichs "B2: D5" "B5:D5".
getOffsetRange(rowOffset, columnOffset)	Ruft ein Objekt ab, das einen Bereich darstellt, der aus dem angegebenen Bereich versetzt ist. Die Dimension des zurückgegebenen Bereichs entspricht diesem Bereich. Wenn der resultierende Bereich außerhalb des Arbeitsblatt-Rasters erzwungen wird, wird ein Fehler ausgelöst.
getResizedRange(deltaRows, deltaColumns)	Ruft ein `Range` -Objekt ab, das dem aktuellen `Range` -Objekt ähnelt, aber mit der unteren rechten Ecke, die um eine bestimmte Anzahl von Zeilen und Spalten erweitert (oder kontrahiert) ist.
getRow(row)	Ruft eine Zelle ab, die im Bereich enthalten ist.
getRowsAbove(count)	Ruft eine bestimmte Anzahl von Zeilen über dem aktuellen `Range` -Objekt ab.
getRowsBelow(count)	Ruft eine bestimmte Anzahl von Zeilen unterhalb des aktuellen `Range` -Objekts ab.
getUsedRange(valuesOnly)	Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, löst diese Funktion einen Fehler aus `ItemNotFound` .
getUsedRangeOrNullObject(valuesOnly)	Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getVisibleView()	Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.
insert(shift)	Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen. Gibt ein neues `Range` -Objekt am jetzt leeren Platz zurück.
insert(shiftString)	Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen. Gibt ein neues `Range` -Objekt am jetzt leeren Platz zurück.
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
merge(across)	Führt die Zellen des Bereichs in eine Region im Arbeitsblatt zusammen.
select()	Wählt den angegebenen Bereich in der Excel-Benutzeroberfläche aus.
set(properties, options)	Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)	Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Range-Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Excel.Interfaces.RangeData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
track()	Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über `.sync` Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde.
unmerge()	Hebt den Zellverbund des Bereichs in einzelne Zellen auf.
untrack()	Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen `context.sync()` , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

address

Gibt den Bereichsverweis im A1-Format an. Der Adresswert enthält den Blattverweis (z. B. "Sheet1! A1:B4").

readonly address: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.1 ]

addressLocal

Stellt den Bereichsverweis für den angegebenen Bereich in der Sprache des Benutzers dar.

readonly addressLocal: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.1 ]

cellCount

Gibt die Anzahl der Zellen im Bereich an. Diese API gibt -1 zurück, wenn die Zellenanzahl 2^31-1 (2.147.483.647) überschreitet.

readonly cellCount: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.1 ]

columnCount

Gibt die Gesamtanzahl der Spalten im Bereich an.

readonly columnCount: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.1 ]

columnHidden

Stellt dar, ob alle Spalten im aktuellen Bereich ausgeblendet sind. Der Wert ist true , wenn alle Spalten in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Spalten im Bereich ausgeblendet werden. Der Wert ist null , wenn einige Spalten in einem Bereich ausgeblendet sind und andere Spalten im gleichen Bereich nicht ausgeblendet werden.

columnHidden: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.2 ]

columnIndex

Gibt die Spaltennummer der ersten Zelle im Bereich an. Nullindiziert.

readonly columnIndex: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.1 ]

conditionalFormats

Die Auflistung von ConditionalFormats , die den Bereich überschneidet.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Eigenschaftswert

Excel.ConditionalFormatCollection

Hinweise

[ API-Satz: ExcelApi 1.6 ]

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

format

Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.

readonly format: Excel.RangeFormat;

Eigenschaftswert

Excel.RangeFormat

Hinweise

[ API-Satz: ExcelApi 1.1 ]

formulas

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

formulas: any[][];

Eigenschaftswert

any[][]

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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.

formulasLocal: any[][];

Eigenschaftswert

any[][]

Hinweise

[ API-Satz: ExcelApi 1.1 ]

formulasR1C1

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

formulasR1C1: any[][];

Eigenschaftswert

any[][]

Hinweise

[ API-Satz: ExcelApi 1.2 ]

hidden

Stellt dar, ob alle Zellen im aktuellen Bereich ausgeblendet sind. Der Wert ist true , wenn alle Zellen in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Zellen im Bereich ausgeblendet werden. Wert ist null , wenn einige Zellen in einem Bereich ausgeblendet sind und andere Zellen im gleichen Bereich nicht ausgeblendet werden.

readonly hidden: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.2 ]

numberFormat

Stellt den Zahlenformatcode von Excel für den angegebenen Bereich dar. Weitere Informationen zur Excel-Zahlenformatierung finden Sie unter Zahlenformatcodes.

numberFormat: any[][];

Eigenschaftswert

any[][]

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F5:G7";
    const numberFormat = [[null, "d-mmm"], [null, "d-mmm"], [null, null]]
    const values = [["Today", 42147], ["Tomorrow", "5/24"], ["Difference in days", null]];
    const formulas = [[null,null], [null,null], [null,"=G6-G5"]];
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.numberFormat = numberFormat;
    range.values = values;
    range.formulas= formulas;
    range.load('text');
    await context.sync();
    
    console.log(range.text);
});

rowCount

Gibt die Anzahl der Zeilen im Bereich zurück.

readonly rowCount: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.1 ]

rowHidden

Stellt dar, ob alle Zeilen im aktuellen Bereich ausgeblendet sind. Value ist true , wenn alle Zeilen in einem Bereich ausgeblendet sind. Der Wert ist false , wenn keine Zeilen im Bereich ausgeblendet werden. Der Wert ist null , wenn einige Zeilen in einem Bereich ausgeblendet sind und andere Zeilen im gleichen Bereich nicht ausgeblendet werden.

rowHidden: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.2 ]

rowIndex

Gibt die Spaltenanzahl der ersten Zelle im Bereich zurück. Nullindiziert.

readonly rowIndex: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.1 ]

sort

Stellt die Bereichssortierung des aktuellen Bereichs dar.

readonly sort: Excel.RangeSort;

Eigenschaftswert

Excel.RangeSort

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

async function sortTopToBottom(criteria: string) {
    await Excel.run(async (context) => {
        const sheet = context.workbook.worksheets.getActiveWorksheet();
        const range = sheet.getRange("A1:E5");

        // Find the column header that provides the sort criteria.
        const header = range.find(criteria, {});
        header.load("columnIndex");
        await context.sync();

        range.sort.apply(
            [
                {
                    key: header.columnIndex,
                    sortOn: Excel.SortOn.value
                }
            ],
            false /*matchCase*/,
            true /*hasHeaders*/,
            Excel.SortOrientation.rows
        );
        await context.sync();
    });
}

text

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

readonly text: string[][];

Eigenschaftswert

string[][]

Hinweise

[ API-Satz: ExcelApi 1.1 ]

values

Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um eine Zeichenfolge, eine Zahl oder einen booleschen Wert handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), minus ("-") oder Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.

values: any[][];

Eigenschaftswert

any[][]

Hinweise

[ API-Satz: ExcelApi 1.1 ]

valueTypes

Gibt den Datentyp in jeder Zelle an.

readonly valueTypes: Excel.RangeValueType[][];

Eigenschaftswert

Excel.RangeValueType[][]

Hinweise

[ API-Satz: ExcelApi 1.1 ]

worksheet

Das Arbeitsblatt, das den aktuellen Bereich enthält.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Details zur Methode

calculate()

Berechnet einen Zellbereich auf einem Arbeitsblatt.

calculate(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.6 ]

clear(applyTo)

Löscht Bereichswerte, Format, Füllung, Rahmen usw.

clear(applyTo?: Excel.ClearApplyTo): void;

Parameter

applyTo: Excel.ClearApplyTo

Optional. Bestimmt den Typ der Löschaktion. Weitere Informationen finden Sie unter Excel.ClearApplyTo .

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

// Clear the format and contents of the range.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.clear();
    await context.sync(); 
});

clear(applyToString)

Löscht Bereichswerte, Format, Füllung, Rahmen usw.

clear(applyToString?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"): void;

Parameter

applyToString: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"

Optional. Bestimmt den Typ der Löschaktion. Weitere Informationen finden Sie unter Excel.ClearApplyTo .

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.1 ]

delete(shift)

Löscht die dem Bereich zugeordneten Zellen.

delete(shift: Excel.DeleteShiftDirection): void;

Parameter

shift: Excel.DeleteShiftDirection

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen finden Sie unter Excel.DeleteShiftDirection .

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.delete("Left");
    await context.sync(); 
});

delete(shiftString)

Löscht die dem Bereich zugeordneten Zellen.

delete(shiftString: "Up" | "Left"): void;

Parameter

shiftString: "Up" | "Left"

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen finden Sie unter Excel.DeleteShiftDirection .

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.1 ]

getBoundingRect(anotherRange)

Ruft das kleinste Bereichsobjekt ab, das die angegebenen Bereiche umfasst. Beispielsweise ist die GetBoundingRect von "B2:C5" und "D10:E15" "B2:E15".

getBoundingRect(anotherRange: Range | string): Excel.Range;

Parameter

anotherRange: Excel.Range | string

Das Bereichsobjekt, die Adresse oder der Bereichsname.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D4:G6";
    let range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range = range.getBoundingRect("G4:H8");
    range.load('address');
    await context.sync();
    
    console.log(range.address); // Prints Sheet1!D4:H8
});

getCell(row, column)

Ruft das Bereichsobjekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltenanzahl enthält. Die Zelle kann sich außerhalb der Grenzen ihres übergeordneten Bereichs befinden, solange sie im Arbeitsblattraster verbleibt. Die zurückgegebene Zelle befindet sich relativ zur obersten linken Zelle des Bereichs.

getCell(row: number, column: number): Excel.Range;

Parameter

row: number

Zeilenanzahl der abzurufenden Zelle. Nullindiziert.

column: number

Spaltenanzahl der abzurufenden Zelle. Nullindiziert.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const cell = range.getCell(0,0);
    cell.load('address');
    await context.sync();
    
    console.log(cell.address);
});

getColumn(column)

Ruft eine Spalte ab, die im Bereich enthalten ist.

getColumn(column: number): Excel.Range;

Parameter

column: number

Spaltenanzahl des abzurufenden Bereichs. Nullindiziert.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet19";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getColumn(1);
    range.load('address');
    await context.sync();

    console.log(range.address); // prints Sheet1!B1:B8
});

getColumnsAfter(count)

Ruft eine bestimmte Anzahl von Spalten rechts vom aktuellen Range -Objekt ab.

getColumnsAfter(count?: number): Excel.Range;

Parameter

count: number

Optional. Die Anzahl von Spalten, die in den Ergebnisbereich aufgenommen werden soll. Grundsätzlich verwenden Sie eine positive Zahl, um einen Bereich außerhalb des aktuellen Bereichs zu erstellen. Sie können auch eine negative Zahl verwenden, um einen Bereich innerhalb des aktuellen Bereichs zu erstellen. Der Standardwert ist 1.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.2 ]

getColumnsBefore(count)

Ruft eine bestimmte Anzahl von Spalten links vom aktuellen Range -Objekt ab.

getColumnsBefore(count?: number): Excel.Range;

Parameter

count: number

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.2 ]

getEntireColumn()

Ruft ein -Objekt ab, das die gesamte Spalte des Bereichs darstellt (wenn der aktuelle Bereich z. B. zellen "B4:E11" darstellt, ist es getEntireColumn ein Bereich, der spalten "B:E") darstellt.

getEntireColumn(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

// Note: the grid properties of the Range (values, numberFormat, formulas) 
// contains null since the Range in question is unbounded.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D:F";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const rangeEC = range.getEntireColumn();
    rangeEC.load('address');
    await context.sync();
    
    console.log(rangeEC.address);
});

getEntireRow()

Ruft ein -Objekt ab, das die gesamte Zeile des Bereichs darstellt (wenn der aktuelle Bereich z. B. zellen "B4:E11" darstellt, ist es GetEntireRow ein Bereich, der die Zeilen "4:11" darstellt).

getEntireRow(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

// Gets an object that represents the entire row of the range 
// (for example, if the current range represents cells "B4:E11", 
// its GetEntireRow is a range that represents rows "4:11").
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "D:F"; 
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const rangeER = range.getEntireRow();
    rangeER.load('address');
    await context.sync();
    
    console.log(rangeER.address);
});

getIntersection(anotherRange)

Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt.

getIntersection(anotherRange: Range | string): Excel.Range;

Parameter

anotherRange: Excel.Range | string

Das Bereichsobjekt oder die Bereichsadresse, die verwendet wird, um die Schnittmenge der Bereiche zu ermitteln.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = 
        context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getIntersection("D4:G6");
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!D4:F6
});

getIntersectionOrNullObject(anotherRange)

Ruft das Bereichsobjekt ab, das die rechteckige Schnittmenge der angegebenen Bereiche darstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;

Parameter

anotherRange: Excel.Range | string

Das Bereichsobjekt oder die Bereichsadresse, die verwendet wird, um die Schnittmenge der Bereiche zu ermitteln.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.4 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getLastCell()

Ruft die letzte Zelle im Bereich ab. Beispielsweise lautet die letzte Zelle des Bereichs „B2: D5“ „D5“.

getLastCell(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastCell();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!F8
});

getLastColumn()

Ruft die letzte Spalte im Bereich ab. Beispielsweise lautet die letzte Spalte von „B2:D5“ „D2:D5“.

getLastColumn(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastColumn();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!F1:F8
});

getLastRow()

Ruft die letzte Zeile im Bereich ab. Beispielsweise lautet die letzte Zelle des Bereichs "B2: D5" "B5:D5".

getLastRow(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getLastRow();
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!A8:F8
});

getOffsetRange(rowOffset, columnOffset)

Ruft ein Objekt ab, das einen Bereich darstellt, der aus dem angegebenen Bereich versetzt ist. Die Dimension des zurückgegebenen Bereichs entspricht diesem Bereich. Wenn der resultierende Bereich außerhalb des Arbeitsblatt-Rasters erzwungen wird, wird ein Fehler ausgelöst.

getOffsetRange(rowOffset: number, columnOffset: number): Excel.Range;

Parameter

rowOffset: number

Die Anzahl der Zeilen (positiv, negativ oder 0), um die der Bereich versetzt werden soll. Bei positiven Werten erfolgt der Versatz nach unten, bei negativen Werten nach oben.

columnOffset: number

Die Anzahl der Spalten (positiv, negativ oder 0), um die der Bereich versetzt werden soll. Bei positiven Werten erfolgt der Versatz nach rechts, bei negativen Werten nach links.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "D4:F6";
    const range = 
        context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getOffsetRange(-1,4);
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!H3:J5
});

getResizedRange(deltaRows, deltaColumns)

Ruft ein Range -Objekt ab, das dem aktuellen Range -Objekt ähnelt, aber mit der unteren rechten Ecke, die um eine bestimmte Anzahl von Zeilen und Spalten erweitert (oder kontrahiert) ist.

getResizedRange(deltaRows: number, deltaColumns: number): Excel.Range;

Parameter

deltaRows: number

Die Anzahl von Zeilen, um die die untere rechte Ecke relativ zum aktuellen Bereich zu erweitern ist. Verwenden Sie eine positive Zahl, um den Bereich zu erweitern, oder eine negative Zahl, um ihn zu verkleinern.

deltaColumns: number

Die Anzahl der Spalten, um die die untere rechte Ecke relativ zum aktuellen Bereich erweitert werden soll. Verwenden Sie eine positive Zahl, um den Bereich zu erweitern, oder eine negative Zahl, um ihn zu verkleinern.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.2 ]

getRow(row)

Ruft eine Zelle ab, die im Bereich enthalten ist.

getRow(row: number): Excel.Range;

Parameter

row: number

Zeilenanzahl des abzurufenden Bereichs. Nullindiziert.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress).getRow(1);
    range.load('address');
    await context.sync();
    
    console.log(range.address); // prints Sheet1!A2:F2
});

getRowsAbove(count)

Ruft eine bestimmte Anzahl von Zeilen über dem aktuellen Range -Objekt ab.

getRowsAbove(count?: number): Excel.Range;

Parameter

count: number

Optional. Die Anzahl von Zeilen, die in den Ergebnisbereich aufgenommen werden soll. Grundsätzlich verwenden Sie eine positive Zahl, um einen Bereich außerhalb des aktuellen Bereichs zu erstellen. Sie können auch eine negative Zahl verwenden, um einen Bereich innerhalb des aktuellen Bereichs zu erstellen. Der Standardwert ist 1.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.2 ]

getRowsBelow(count)

Ruft eine bestimmte Anzahl von Zeilen unterhalb des aktuellen Range -Objekts ab.

getRowsBelow(count?: number): Excel.Range;

Parameter

count: number

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.2 ]

getUsedRange(valuesOnly)

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, löst diese Funktion einen Fehler aus ItemNotFound .

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parameter

valuesOnly: boolean

Betrachtet nur Zellen mit Werten als verwendet. [API-Satz: ExcelApi 1.2]

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-relationships.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // We want the most recent quarter that has data, so
    // exclude quarters without data and get the last of
    // the remaining columns.
    const usedDataRange = dataRange.getUsedRange(true /* valuesOnly */);
    const currentQuarterRange = usedDataRange.getLastColumn();

    // Asian and European teams have separate contests.
    const asianSalesRange = sheet.getRange("A2:E4");
    const europeanSalesRange = sheet.getRange("A5:E7");

    // The data for each chart is the intersection of the
    // current quarter column and the rows for the continent.
    const asianContestRange = asianSalesRange.getIntersectionOrNullObject(currentQuarterRange);
    const europeanContestRange = europeanSalesRange.getIntersectionOrNullObject(currentQuarterRange);

    // Must sync before you can test the output of *OrNullObject
    // method/property.
    await context.sync();

    if (asianContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("Asian");
    } else {
        createContinentChart(
            sheet,
            "Asian",
            asianContestRange,
            "A9",
            "F24"
        );
    }

    if (europeanContestRange.isNullObject) {
        // See the declaration of this function for how to
        // test this code path.
        reportMissingData("European");
    } else {
        createContinentChart(
            sheet,
            "European",
            europeanContestRange,
            "A25",
            "F40"
        );
    }

    await context.sync();
});

getUsedRangeOrNullObject(valuesOnly)

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn innerhalb des Bereichs keine verwendeten Zellen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parameter

valuesOnly: boolean

Betrachtet nur Zellen mit Werten als verwendet.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.4 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/used-range.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const salesTable = sheet.tables.getItem("SalesTable");
    const dataRange = salesTable.getDataBodyRange();

    // Pass true so only cells with values count as used
    const usedDataRange = dataRange.getUsedRangeOrNullObject(
        true /* valuesOnly */
    );

    //Must sync before reading value returned from *OrNullObject method/property.
    await context.sync();

    if (usedDataRange.isNullObject) {
        console.log("Need Data to Make Chart");
        console.log("To create a meaningful chart, press 'Fill the table' (or add names to the Product column and numbers to some of the other cells). Then press 'Try to create chart' again.");
    } else {
        const chart = sheet.charts.add(
            Excel.ChartType.columnClustered,
            dataRange,
            "Columns"
        );
        chart.setPosition("A15", "F30");
        chart.title.text = "Quarterly sales chart";
        chart.legend.position = "Right";
        chart.legend.format.fill.setSolidColor("white");
        chart.dataLabels.format.font.size = 15;
        chart.dataLabels.format.font.color = "black";
    }

    await context.sync();
});

getVisibleView()

Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.

getVisibleView(): Excel.RangeView;

Gibt zurück

Excel.RangeView

Hinweise

[ API-Satz: ExcelApi 1.3 ]

insert(shift)

Fügt eine Zelle oder einen Zellbereich in das Arbeitsblatt anstelle dieses Bereichs ein, und verschiebt die anderen Zellen, um Platz zu schaffen. Gibt ein neues Range -Objekt am jetzt leeren Platz zurück.

insert(shift: Excel.InsertShiftDirection): Excel.Range;

Parameter

shift: Excel.InsertShiftDirection

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen finden Sie unter Excel.InsertShiftDirection .

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "F5:F10";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.insert(Excel.InsertShiftDirection.down);
    await context.sync();
});

insert(shiftString)

insert(shiftString: "Down" | "Right"): Excel.Range;

Parameter

shiftString: "Down" | "Right"

Gibt an, wohin die Zellen verschoben werden. Weitere Informationen finden Sie unter Excel.InsertShiftDirection .

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range;

Parameter

options: Excel.Interfaces.RangeLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.Range

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.Range;

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.Range

Beispiele

// Use the range address to get the range object.
await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8"; 
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Range;

Parameter

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.Range

merge(across)

Führt die Zellen des Bereichs in eine Region im Arbeitsblatt zusammen.

merge(across?: boolean): void;

Parameter

across: boolean

Optional. Legen Sie fest true , um Zellen in jeder Zeile des angegebenen Bereichs als separate zusammengeführte Zellen zusammenzuführen. Der Standardwert ist false.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:C3";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.merge(true);
    await context.sync(); 
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-merged-ranges.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet and the table in that worksheet.
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const tableRange = sheet.getRange("B2:E6");

  // Create a merged range in the first row of the table.
  const chartTitle = tableRange.getRow(0);
  chartTitle.merge(true);

  // Format the merged range.
  chartTitle.format.horizontalAlignment = "Center";

  await context.sync();
});

select()

Wählt den angegebenen Bereich in der Excel-Benutzeroberfläche aus.

select(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "F5:F10"; 
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.select();
    await context.sync(); 
});

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Excel.Interfaces.RangeUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options: OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Range): void;

Parameter

properties: Excel.Range

Gibt zurück

void

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/90-scenarios/multiple-property-set.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    const sourceRange = sheet.getRange("B2:E2");
    sourceRange.load("format/fill/color, format/font/name, format/font/color");
    await context.sync();

    // Set properties based on the loaded and synced 
    // source range.
    const targetRange = sheet.getRange("B7:E7");
    targetRange.set(sourceRange); 
    targetRange.format.autofitColumns();
    await context.sync();
});

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Range-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.RangeData;

Gibt zurück

Excel.Interfaces.RangeData

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde.

track(): Excel.Range;

Gibt zurück

Excel.Range

unmerge()

Hebt den Zellverbund des Bereichs in einzelne Zellen auf.

unmerge(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:C3";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.unmerge();
    await context.sync(); 
});

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Excel.Range;

Gibt zurück

Excel.Range

Beispiele

await Excel.run(async (context) => {
    const largeRange = context.workbook.getSelectedRange();
    largeRange.load(["rowCount", "columnCount"]);
    await context.sync();

    for (let i = 0; i < largeRange.rowCount; i++) {
        for (let j = 0; j < largeRange.columnCount; j++) {
            const cell = largeRange.getCell(i, j);
            cell.values = [[i *j]];

            // Call untrack() to release the range from memory.
            cell.untrack();
        }
    }

    await context.sync();
});

Freigeben über

Excel.Range class

Hinweise

Beispiele

Eigenschaften

Methoden

Details zur Eigenschaft

address

Eigenschaftswert

Hinweise

addressLocal

Eigenschaftswert

Hinweise

cellCount

Eigenschaftswert

Hinweise

columnCount

Eigenschaftswert

Hinweise

columnHidden

Eigenschaftswert

Hinweise

columnIndex

Eigenschaftswert

Hinweise

conditionalFormats

Eigenschaftswert

Hinweise

context

Eigenschaftswert

format

Eigenschaftswert

Hinweise

formulas

Eigenschaftswert

Hinweise

formulasLocal

Eigenschaftswert

Hinweise

formulasR1C1

Eigenschaftswert

Hinweise

hidden

Eigenschaftswert

Hinweise

numberFormat

Eigenschaftswert

Hinweise

Beispiele

rowCount

Eigenschaftswert

Hinweise

rowHidden

Eigenschaftswert

Hinweise

rowIndex

Eigenschaftswert

Hinweise

sort

Eigenschaftswert

Hinweise

Beispiele

text

Eigenschaftswert

Hinweise

values

Eigenschaftswert

Hinweise

valueTypes

Eigenschaftswert

Hinweise

worksheet

Eigenschaftswert

Hinweise

Details zur Methode

calculate()

Gibt zurück

Hinweise

clear(applyTo)

Parameter