Excel.Range class

Gibt den Bereichsbezug im A1-Format an. Der Adresswert enthält den Blattbezug (z. B. "Tabelle1! A1:B4").

readonly address: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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

readonly addressLocal: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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

Hinweise

API-Satz: ExcelApi 1.1

Gibt die Gesamtanzahl der Spalten im Bereich an.

readonly columnCount: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Gibt an, ob alle Spalten im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Spalten in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Spalten im Bereich ausgeblendet sind. Ein Wert ist null , wenn einige Spalten in einem Bereich ausgeblendet und andere Spalten im selben Bereich nicht ausgeblendet sind.

columnHidden: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.2

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

readonly columnIndex: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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

context: RequestContext;

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/formatting.yaml

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

    expensesTable.getHeaderRowRange().format.fill.color = "#C70039";
    expensesTable.getDataBodyRange().format.fill.color = "#DAF7A6";
    expensesTable.rows.getItemAt(1).getRange().format.fill.color = "#FFC300";
    expensesTable.columns.getItemAt(0).getDataBodyRange().format.fill.color = "#FFA07A";
    
  await context.sync();
});

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

formulas: any[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

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

    const data = [
        ["Total Price"],
        ["=C3 * D3"],
        ["=C4 * D4"],
        ["=C5 * D5"],
        ["=SUM(E3:E5)"]
    ];
    
    const range = sheet.getRange("E2:E6");
    range.formulas = data;
    range.format.autofitColumns();

    await context.sync();
});

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

Hinweise

API-Satz: ExcelApi 1.1

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

formulasR1C1: any[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.2

Gibt an, ob alle Zellen im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Zellen in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Zellen im Bereich ausgeblendet sind. Wert ist null , wenn einige Zellen in einem Bereich ausgeblendet sind und andere Zellen im selben Bereich nicht ausgeblendet sind.

readonly hidden: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.2

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

numberFormat: any[][];

Eigenschaftswert

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

Gibt die Anzahl der Zeilen im Bereich zurück.

readonly rowCount: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Gibt an, ob alle Zeilen im aktuellen Bereich ausgeblendet sind. Wert ist true , wenn alle Zeilen in einem Bereich ausgeblendet sind. Wert ist false , wenn keine Zeilen im Bereich ausgeblendet sind. Ein Wert ist null , wenn einige Zeilen in einem Bereich ausgeblendet sind und andere Zeilen im selben Bereich nicht.

rowHidden: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.2

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

readonly rowIndex: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Stellt die Bereichssortierung des aktuellen Bereichs dar.

readonly sort: Excel.RangeSort;

Eigenschaftswert

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();
    });
}

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

readonly text: string[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um Zeichenfolgen, Zahlen oder boolesche Werte handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), einem Minuszeichen ("-") oder einem Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel. Gebietsschemaförmige Zeichenfolgen (z. B. das Datum "19-8-2025" in nl-NL oder fr-FR, Format TT-MM-JJJJ) werden als Text statt als Datumsangaben gespeichert. Um sicherzustellen, dass Datumsangaben als Datumsangaben gespeichert werden, verwenden Sie eine gebietsschemaabhängige API wie formulasLocal oder ein gebietsschemaneutrales Format wie ISO (JJJJ-MM-TT) oder eine numerische Datumsreihe.

values: any[][];

Eigenschaftswert

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-cell-control.yaml

// Change the value of the checkbox in B3.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const range = sheet.getRange("B3");

  range.values = [["TRUE"]];
  await context.sync();
});

Gibt den Datentyp in jeder Zelle an.

readonly valueTypes: Excel.RangeValueType[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Das Arbeitsblatt, das den aktuellen Bereich enthält.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Löschen von Bereichswerten und Formatierungen, z. B. Füllung und Rahmen.

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

Parameter

Gibt zurück

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(); 
});

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range: Excel.Range = sheet.getRange("E2:E5");

    range.clear();

    await context.sync();
});

Löschen von Bereichswerten und Formatierungen, z. B. Füllung und Rahmen.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

Löscht die dem Bereich zugeordneten Zellen.

delete(shift: Excel.DeleteShiftDirection): void;

Parameter

Gibt zurück

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(); 
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml

// This function deletes data from a range and sets the delete shift direction to "up".
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range: Excel.Range = sheet.getRange("A5:F5");
    range.delete(Excel.DeleteShiftDirection.up);
});

Löscht die dem Bereich zugeordneten Zellen.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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

Gibt zurück

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

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

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

Parameter

Gibt zurück

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

Ruft eine Spalte ab, die im Bereich enthalten ist.

getColumn(column: number): Excel.Range;

Parameter

Gibt zurück

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

Ruft eine bestimmte Anzahl von Spalten rechts neben dem aktuellen Range Objekt ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

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

getEntireColumn(): Excel.Range;

Gibt zurück

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

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

getEntireRow(): Excel.Range;

Gibt zurück

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

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

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

Parameter

Gibt zurück

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

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

getLastCell(): Excel.Range;

Gibt zurück

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

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

getLastColumn(): Excel.Range;

Gibt zurück

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

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

getLastRow(): Excel.Range;

Gibt zurück

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

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

Gibt zurück

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

Ruft ein Range Objekt ab, das dem aktuellen Range Objekt ähnelt, aber mit einer vergrößerten unteren rechten Ecke um eine bestimmte Anzahl von Zeilen und Spalten erweitert (oder zusammengezogen).

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

Ruft eine Zelle ab, die im Bereich enthalten ist.

getRow(row: number): Excel.Range;

Parameter

Gibt zurück

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

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn sich in dem Bereich keine verwendeten Zellen befinden, löst diese Funktion einen ItemNotFound Fehler aus.

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

Parameter

Gibt zurück

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();
});

Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.

getVisibleView(): Excel.RangeView;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.3

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/get-visible-range-of-a-filtered-table.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable = sheet.tables.getItem("ExpensesTable");                    
    const visibleRange = expensesTable.getDataBodyRange().getVisibleView().load("values");
    await sheet.context.sync();

    const visibleValues = visibleRange.values;
    console.log(visibleValues);
    await context.sync();
});

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 an dem jetzt leeren Bereich zurück.

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

Parameter

Gibt zurück

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();
});

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 an dem jetzt leeren Bereich zurück.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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

Gibt zurück

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

Gibt zurück

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

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

Gibt zurück

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

merge(across?: boolean): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

Beispiele

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

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

select(): void;

Gibt zurück

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(); 
});

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

Gibt zurück

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

set(properties: Excel.Range): void;

Parameter

Gibt zurück

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();
});

Ü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 sie übergeben wird.) Während das ursprüngliche Excel.Range Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.RangeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.RangeData;

Gibt zurück

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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde.

track(): Excel.Range;

Gibt zurück

Hebt den Zellverbund des Bereichs in einzelne Zellen auf.

unmerge(): void;

Gibt zurück

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(); 
});

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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Excel.Range;

Gibt zurück

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();
});