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

Die Sammlung dieser ConditionalFormats Schnittmenge den Bereich.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.6

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

context: RequestContext;

Eigenschaftswert

Greift auf das auf diesen Bereich angewendete Zellensteuerelement zu. Wenn der Bereich über mehrere Zellsteuerelemente verfügt, wird zurückgegeben EmptyCellControl.

control: CellControl;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.18

Beispiele

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

// Add checkboxes to the table.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Change the boolean values to checkboxes.
  range.control = {
    type: Excel.CellControlType.checkbox
  };
  await context.sync();
});

Gibt ein Datenüberprüfungsobjekt zurück.

readonly dataValidation: Excel.DataValidation;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.8

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

Gibt die Arrayformel eines Bereichs an. Wenn der angegebene Bereich keine Matrixformel enthält, gibt diese Eigenschaft zurück null.

formulaArray: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApiDesktop 1.1

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

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

Stellt dar, ob alle Zellen einen Überlaufrahmen aufweisen. Gibt zurück true , ob alle Zellen einen Überlaufrahmen haben oder false wenn alle Zellen keinen Überlaufrahmen haben. Gibt zurück null , ob Zellen mit und ohne Überlaufrahmen innerhalb des Bereichs vorhanden sind.

readonly hasSpill: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.12

Gibt die Entfernung in Punkten für 100 % Zoom vom oberen Rand des Bereichs bis zum unteren Rand des Bereichs zurück.

readonly height: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.10

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 Hyperlink für den aktuellen Bereich dar.

hyperlink: Excel.RangeHyperlink;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

Beispiele

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

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

    let productsRange = sheet.getRange("A3:A5");
    productsRange.load("values");

    await context.sync();

    // Create a hyperlink to a URL 
    // for each product name in the first table.
    for (let i = 0; i < productsRange.values.length; i++) {
        let cellRange = productsRange.getCell(i, 0);
        let cellText = productsRange.values[i][0];

        let hyperlink = {
            textToDisplay: cellText,
            screenTip: "Search Bing for '" + cellText + "'",
            address: "https://www.bing.com?q=" + cellText
        }
        cellRange.hyperlink = hyperlink;
    }

    await context.sync();
});

Gibt an, ob der angegebene Bereich eine ganze Spalte ist.

readonly isEntireColumn: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

Gibt an, ob der angegebene Bereich eine ganze Zeile ist.

readonly isEntireRow: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

Gibt den Abstand in Punkten vom linken Rand des Arbeitsblatts bis zum linken Rand des Bereichs für einen Zoom von 100 % zurück.

readonly left: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.10

Stellt den Datentypstatus der einzelnen Zellen dar.

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

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

Stellt die Kategorie des Zahlenformats für jede Zelle dar.

readonly numberFormatCategories: Excel.NumberFormatCategory[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.12

Stellt den Excel-Zahlenformatcode für den angegebenen Bereich auf der Grundlage der Spracheinstellungen des Benutzers dar. Excel führt beim Abrufen oder Festlegen der numberFormatLocal Eigenschaft keine Sprach- oder Formatkonvertierung aus. Jeder zurückgegebene Text verwendet die lokal formatierten Zeichenfolgen basierend auf der in den Systemeinstellungen angegebenen Sprache.

numberFormatLocal: any[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

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

Gibt an, ob alle Zellen als Arrayformel gespeichert werden sollen. Gibt zurück true , false ob alle Zellen als Matrixformel oder nicht alle Zellen als Matrixformel gespeichert wurden. Gibt zurück null , ob einige Zellen als Arrayformel gespeichert werden, andere nicht.

readonly savedAsArray: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.12

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

Stellt die Formatvorlage des aktuellen Bereichs dar. Wenn die Formatvorlagen der Zellen inkonsistent sind, null wird zurückgegeben. Bei benutzerdefinierten Formatvorlagen wird der Formatvorlagenname zurückgegeben. Bei integrierten Formatvorlagen wird eine Zeichenfolge zurückgegeben, die einen Wert in der BuiltInStyle Aufzählung darstellt.

style: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

Beispiele

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

await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    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

Gibt den Abstand in Punkten für einen Zoom von 100 % vom oberen Rand des Arbeitsblatts bis zum oberen Rand des Bereichs zurück.

readonly top: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.10

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

Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz Range.valueszu unterstützt unterstützt dies alle Datentypen, Range.valuesAsJson die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Von dieser API zurückgegebene Daten stimmen immer mit dem Gebietsschema en-US überein. Um Daten im Anzeigegebietsschema des Benutzers abzurufen, verwenden Sie Range.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml

// This function creates a double data type,
// and sets the format of this data type as a date.
await Excel.run(async (context) => {
  // Get the Sample worksheet and a range on that sheet.
  const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
  const dateRange = sheet.getRange("A1");

  // Write a number formatted as a date to cell A1.
  dateRange.valuesAsJson = [
    [
      {
        type: Excel.CellValueType.double,
        basicValue: 32889.0,
        numberFormat: "m/d/yyyy"
      }
    ]
  ];
  await context.sync();
});

Eine JSON-Darstellung der Werte in den Zellen in diesem Bereich. Im Gegensatz Range.valueszu unterstützt unterstützt dies alle Datentypen, Range.valuesAsJsonLocal die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Die von dieser API zurückgegebenen Daten entsprechen immer dem Anzeigegebietsschema des Benutzers. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie Range.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Gibt den Datentyp in jeder Zelle an.

readonly valueTypes: Excel.RangeValueType[][];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Gibt die Entfernung in Punkten vom linken Rand des Bereichs bis zum rechten Rand des Bereichs für einen Zoom von 100 % zurück.

readonly width: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.10

Das Arbeitsblatt, das den aktuellen Bereich enthält.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Füllt einen Bereich vom aktuellen Bereich bis zum Zielbereich mithilfe der angegebenen AutoFill-Logik. Der Zielbereich kann horizontal oder vertikal sein null oder den Quellbereich erweitern. Nicht zusammenhängende Bereiche werden nicht unterstützt.

Weitere Informationen finden Sie unter Verwenden von AutoAusfüllen und Blitzvorschau.

autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9, ExcelApi-Vorschau für NULL destinationRange

Beispiele

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

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();
  const sumCell = sheet.getRange("P4");
  
  // Copy everything. The formulas will be contextually updated based on their new locations.
  sumCell.autoFill("P4:P7", Excel.AutoFillType.fillCopy);
  sumCell.format.autofitColumns();
  await context.sync();
});

Füllt einen Bereich vom aktuellen Bereich bis zum Zielbereich mithilfe der angegebenen AutoFill-Logik. Der Zielbereich kann horizontal oder vertikal sein null oder den Quellbereich erweitern. Nicht zusammenhängende Bereiche werden nicht unterstützt.

Weitere Informationen finden Sie unter Verwenden von AutoAusfüllen und Blitzvorschau.

autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9, ExcelApi-Vorschau für NULL destinationRange

Berechnet einen Zellbereich auf einem Arbeitsblatt.

calculate(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.6

Überprüft die Rechtschreibung von Wörtern in diesem Bereich. Mit dieser Methode wird das Dialogfeld "Rechtschreibung" auf der Excel-Benutzeroberfläche geöffnet.

checkSpelling(options?: Excel.CheckSpellingOptions): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApiDesktop 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(); 
});

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 Werte der Zellen im Bereich, wobei Zellen, die Steuerelemente enthalten, besonders berücksichtigt werden. Wenn der Bereich nur leere Werte und auf ihren Standardwert festgelegte Steuerelemente enthält, werden die Werte und die Formatierung des Steuerelements entfernt. Andernfalls werden die Zellen mit Steuerelementen auf ihren Standardwert festgelegt, und die Werte der anderen Zellen im Bereich werden gelöscht.

clearOrResetContents(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.18

Beispiele

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

// Remove all content from the Analysis column.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Get the second column in the table, without the header.
  const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();

  // Clear all the data from the second column.
  range.clearOrResetContents();
  await context.sync();
});

Konvertiert die Bereichszellen mit Datentypen in Text.

convertDataTypeToText(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Konvertiert die Bereichszellen in verknüpfte Datentypen im Arbeitsblatt.

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder RangeAreas in den aktuellen Bereich. Der Zielbereich kann eine andere Größe als der Quellbereich haben, oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wie bei der Kopierfunktion in der Excel-Benutzeroberfläche wird der Quellinhalt mehrfach repliziert, wenn der Zielbereich in Zeilen oder Spalten um ein Vielfaches größer als der Quellbereich ist. Zum Beispiel führt eine Kopie des 2x2-Bereichs in einen 2x6-Bereich zu 3 Kopien des ursprünglichen 2x2-Bereichs.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the copied data.
    sheet.getRange("F2").values = [["Copied Formula"]];

    // Copy a range preserving the formulas.
    // Note: non-formula values are copied over as is.
    sheet.getRange("G2").copyFrom("A1:E1", Excel.RangeCopyType.formulas);
    await context.sync();
});

Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder RangeAreas in den aktuellen Bereich. Der Zielbereich kann eine andere Größe als der Quellbereich haben, oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist. Hinweis: Wie bei der Kopierfunktion in der Excel-Benutzeroberfläche wird der Quellinhalt mehrfach repliziert, wenn der Zielbereich in Zeilen oder Spalten um ein Vielfaches größer als der Quellbereich ist. Zum Beispiel führt eine Kopie des 2x2-Bereichs in einen 2x6-Bereich zu 3 Kopien des ursprünglichen 2x2-Bereichs.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", skipBlanks?: boolean, transpose?: boolean): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

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

Löscht die dem Bereich zugeordneten Zellen.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

Sucht die angegebene Zeichenfolge anhand der angegebenen Kriterien. Wenn der aktuelle Bereich größer als eine einzelne Zelle ist, wird die Suche auf diesen Bereich beschränkt, andernfalls erstreckt sich die Suche auf das gesamte Blatt ab dieser Zelle.

find(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Parameter

Gibt zurück

Das Range Objekt, das die erste Zelle darstellt, die einen Wert enthält, der dem Suchtext und den Suchkriterien entspricht.

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

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

    // NOTE: If no match is found, an ItemNotFound error
    // is thrown when Range.find is evaluated.
    const searchText = (document.getElementById("searchText") as HTMLTextAreaElement).value;
    const foundRange = searchRange.find(searchText, {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();

    console.log(foundRange.address);
});

Sucht die angegebene Zeichenfolge anhand der angegebenen Kriterien. Wenn der aktuelle Bereich größer als eine einzelne Zelle ist, wird die Suche auf diesen Bereich beschränkt, andernfalls erstreckt sich die Suche auf das gesamte Blatt ab dieser Zelle. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Parameter

Gibt zurück

Die Range den Suchkriterien entsprachen.

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const table = sheet.tables.getItem("ExpensesTable");
    const searchRange = table.getRange();
    const searchText = (document.getElementById("searchText") as HTMLTextAreaElement).value;
    const foundRange = searchRange.findOrNullObject(searchText, {
        completeMatch: isCompleteMatchToggle,
        matchCase: isMatchCaseToggle,
        searchDirection: searchDirectionToggle
    });
    
    foundRange.load("address");
    await context.sync();

    if (foundRange.isNullObject) {
        console.log("Text not found");
    } else {
        console.log(foundRange.address);
    }
});

Führt eine Blitzvorschau auf den aktuellen Bereich aus. Die Blitzvorschau füllt Daten automatisch aus, wenn sie ein Muster erkennt. Daher muss es sich bei dem Bereich um einen Bereich mit einer einzelnen Spalte handeln, der von Daten umgeben ist, um ein Muster zu finden.

flashFill(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Ruft ein Range Objekt mit derselben Zelle oben links wie das aktuelle Range Objekt ab, jedoch mit der angegebenen Anzahl von Zeilen und Spalten.

getAbsoluteResizedRange(numRows: number, numColumns: number): Excel.Range;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.7

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

Gibt ein 2D-Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Zelle kapselt.

getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Parameter

Gibt zurück

Ein 2D-Array, in dem jedes Element die angeforderten Eigenschaften der entsprechenden Zelle darstellt.

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

await Excel.run(async (context) => {
    const cell = context.workbook.getActiveCell();

    // Get only the properties requested in this load-options object.
    const propertiesToGet: Excel.CellPropertiesLoadOptions = {
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                bold: true,
                color: true
            }
        },
        style: true
    };
    const cellProperties = cell.getCellProperties(propertiesToGet);

    await context.sync();
    const activeCellProperties: Excel.CellProperties = cellProperties.value[0][0];
    console.log(JSON.stringify(activeCellProperties, null, 2));
});

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

Gibt ein eindimensionales Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Spalte kapselt. Für Eigenschaften, die innerhalb einer bestimmten Spalte nicht für alle Zellen konsistent sind, wird NULL zurückgegeben.

getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult<ColumnProperties[]>;

Parameter

Gibt zurück

Ein Array, in dem jedes Element die angeforderten Eigenschaften der entsprechenden Spalte darstellt.

Hinweise

API-Satz: ExcelApi 1.9

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

Gibt ein WorkbookRangeAreas Objekt zurück, das den Bereich darstellt, der alle abhängigen Zellen eines angegebenen Bereichs im selben Arbeitsblatt oder in mehreren Arbeitsblättern enthält. Gibt einen ItemNotFound Fehler aus, wenn keine abhängigen Personen gefunden werden.

getDependents(): Excel.WorkbookRangeAreas;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.15

Beispiele

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

/** Highlight all dependents (direct and indirect) of the active cell. */
async function getAllDependents() {
  await Excel.run(async (context) => {
    // Get addresses of all dependent cells of the active cell.
    const range = context.workbook.getActiveCell();
    const dependents = range.getDependents();
    range.load("address");
    dependents.areas.load("address");
    await context.sync();

    console.log(`All dependent cells of ${range.address} (orange cells):`);

    for (let i = 0; i < dependents.areas.items.length; i++) {
      // Highlight and print the address of each dependent cell.
      dependents.areas.items[i].format.fill.color = "Orange";
      console.log(`  ${dependents.areas.items[i].address}`);
    }
    await context.sync();
  });

Gibt ein WorkbookRangeAreas Objekt zurück, das den Bereich darstellt, der alle direkt abhängigen Zellen eines angegebenen Bereichs im gleichen Arbeitsblatt oder auf mehreren Arbeitsblättern enthält. Gibt einen ItemNotFound Fehler aus, wenn keine abhängigen Personen gefunden werden.

getDirectDependents(): Excel.WorkbookRangeAreas;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.13

Beispiele

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

/** Highlight the direct dependents of the active cell. */
async function getDirectDependents() {
  await Excel.run(async (context) => {
    // Direct dependents are cells that contain formulas that directly refer to the active cell.
    let range = context.workbook.getActiveCell();
    let directDependents = range.getDirectDependents();
    range.load("address");
    directDependents.areas.load("address");
    await context.sync();

    console.log(`Direct dependent cells of ${range.address} (yellow cells):`);

    for (let i = 0; i < directDependents.areas.items.length; i++) {
      // Highlight and print the address of each direct dependent cell.
      directDependents.areas.items[i].format.fill.color = "Yellow";
      console.log(`  ${directDependents.areas.items[i].address}`);
    }
    await context.sync();
  });

Gibt ein WorkbookRangeAreas Objekt zurück, das den Bereich darstellt, der alle unmittelbar vorhergehenden Zellen eines angegebenen Bereichs im selben Arbeitsblatt oder in mehreren Arbeitsblättern enthält. Gibt einen ItemNotFound Fehler aus, wenn keine Präzedenzfälle gefunden werden.

getDirectPrecedents(): Excel.WorkbookRangeAreas;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.12

Beispiele

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

/** Highlight the direct precedents of the active cell. */
async function getDirectPrecedents() {
  await Excel.run(async (context) => {
    // Precedents are cells referenced by the formula in a cell.
    // A "direct precedent" is a cell directly referenced by the selected formula.
    let range = context.workbook.getActiveCell();
    let directPrecedents = range.getDirectPrecedents();
    range.load("address");
    directPrecedents.areas.load("address");
    await context.sync();

    console.log(`Direct precedent cells of ${range.address} (yellow cells):`);

    for (let i = 0; i < directPrecedents.areas.items.length; i++) {
      // Highlight and print the address of each direct precedent cell.
      directPrecedents.areas.items[i].format.fill.color = "Yellow";
      console.log(`  ${directPrecedents.areas.items[i].address}`);
    }
    await context.sync();
  });

Gibt ein 2D-Array zurück, das die Anzeigedaten für die Schriftart, Füllung, Rahmen, Ausrichtung und andere Eigenschaften jeder Zelle kapselt. Im Gegensatz getCellPropertieszu , das nur Eigenschaften anzeigt, die direkt für die Zelle festgelegt sind, werden Eigenschaften zurückgegeben, die aus indirekten Quellen angezeigt werden, z. B. bedingte Formatierungen oder Formatvorlagen.

getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Parameter

Gibt zurück

Ein 2D-Array, in dem jedes Element die angeforderten Anzeigeeigenschaften der entsprechenden Zelle darstellt.

Hinweise

API-Satz: ExcelApi 1.19

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const cell = sheet.getRange("D3");
    const propertiesToGet: Excel.CellPropertiesLoadOptions = {
        address: true,
        format: {
            fill: {
                color: true
            },
            font: {
                bold: true,
                color: true
            },
        },
        style: true
    };

    // Direct properties exclude formatting inherited from styles or conditional formatting.
    const directProperties = cell.getCellProperties(propertiesToGet);
    // Displayed properties include formatting inherited from styles or conditional formatting.
    const displayedProperties = cell.getDisplayedCellProperties(propertiesToGet);

    await context.sync();

    console.log("Direct properties:");
    console.log(JSON.stringify(directProperties.value[0][0], null, 2));
    console.log("Displayed properties (including conditional formatting):");
    console.log(JSON.stringify(displayedProperties.value[0][0], null, 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);
});

Gibt ein Bereichsobjekt zurück, das den aktuellen Bereich und bis zum Rand des Bereichs umfasst, basierend auf der angegebenen Richtung. Dies entspricht dem Verhalten von STRG+UMSCHALT+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.

getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.13

Beispiele

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

await Excel.run(async (context) => {
  // Get the selected range.
  const range = context.workbook.getSelectedRange();

  // Specify the direction with the `KeyboardDirection` enum.
  const direction = Excel.KeyboardDirection.down;

  // Get the active cell in the workbook.
  const activeCell = context.workbook.getActiveCell();

  // Get all the cells from the currently selected range to the bottom-most edge of the used range.
  // This method acts like the Ctrl+Shift+Arrow key keyboard shortcut while a range is selected.
  const extendedRange = range.getExtendedRange(
    direction,
    activeCell // If the selected range contains more than one cell, the active cell must be defined.
  );
  extendedRange.select();

  await context.sync();
});

Gibt ein Bereichsobjekt zurück, das den aktuellen Bereich und bis zum Rand des Bereichs umfasst, basierend auf der angegebenen Richtung. Dies entspricht dem Verhalten von STRG+UMSCHALT+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.

getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.13

Rendert den Bereich als Base64-codiertes PNG-Bild.

getImage(): OfficeExtension.ClientResult<string>;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.7

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 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 festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

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

Parameter

Gibt zurück

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

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

Gibt ein RangeAreas Objekt zurück, das die verbundenen Bereiche in diesem Bereich darstellt. Beachten Sie, dass diese Methode das Ergebnis nicht zurückgeben kann, wenn die Anzahl der zusammengeführten Bereiche in diesem Bereich größer als 512 ist. Wenn das RangeAreas Objekt nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getMergedAreasOrNullObject(): Excel.RangeAreas;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.13

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

  // Retrieve the merged range within the table and load its details.
  const mergedAreas = tableRange.getMergedAreasOrNullObject();
  mergedAreas.load("address");
  mergedAreas.load("cellCount");

  // Select the merged range.
  const range = mergedAreas.areas.getItemAt(0);
  range.select();
  await context.sync();

  // Print out the details of the `mergedAreas` range object.
  console.log(`Address of the merged range: ${mergedAreas.address}`);
  console.log(`Number of cells in the merged range: ${mergedAreas.cellCount}`);

  await context.sync();
});

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 eine bereichsbezogene Auflistung von PivotTables ab, die sich mit dem Bereich überschneiden.

getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.12

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  const activeRange = context.workbook.getSelectedRange();

  // Get all the PivotTables that intersect with this range.
  const partiallyContainedPivotTables = activeRange.getPivotTables();
  // Get all the PivotTables that are completely contained within this range.
  const fullyContainedPivotTables = activeRange.getPivotTables(true);

  partiallyContainedPivotTables.load("name");
  fullyContainedPivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current range:")
  partiallyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
  console.log("PivotTables completely contained in the current range:")
  fullyContainedPivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

Gibt ein WorkbookRangeAreas Objekt zurück, das den Bereich darstellt, der alle vorhergehenden Zellen eines angegebenen Bereichs im selben Arbeitsblatt oder auf mehreren Arbeitsblättern enthält. Gibt einen ItemNotFound Fehler aus, wenn keine Präzedenzfälle gefunden werden.

getPrecedents(): Excel.WorkbookRangeAreas;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.14

Beispiele

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

/** Highlight all precedents (direct and indirect) of the active cell. */
async function getAllPrecedents() {
  await Excel.run(async (context) => {
    // Precedents are cells referenced by the formula in a cell.
    let range = context.workbook.getActiveCell();
    let precedents = range.getPrecedents();
    range.load("address");
    precedents.areas.load("address");
    await context.sync();

    console.log(`All precedent cells of ${range.address} (orange cells):`);

    for (let i = 0; i < precedents.areas.items.length; i++) {
      // Highlight and print the address of each precedent cell.
      precedents.areas.items[i].format.fill.color = "Orange";
      console.log(`  ${precedents.areas.items[i].address}`);
    }
    await context.sync();
  });

Gibt ein Bereichsobjekt zurück, bei dem es sich um die Randzelle des Datenbereichs handelt, der der angegebenen Richtung entspricht. Dies entspricht dem Verhalten der STRG+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.

getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.13

Beispiele

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

await Excel.run(async (context) => {
  // Get the selected range.
  const range = context.workbook.getSelectedRange();

  // Specify the direction with the `KeyboardDirection` enum.
  const direction = Excel.KeyboardDirection.up;

  // Get the active cell in the workbook.
  const activeCell = context.workbook.getActiveCell();

  // Get the top-most cell of the current used range.
  // This method acts like the Ctrl+Arrow key keyboard shortcut while a range is selected.
  const rangeEdge = range.getRangeEdge(
    direction,
    activeCell // If the selected range contains more than one cell, the active cell must be defined.
  );
  rangeEdge.select();

  await context.sync();
});

Gibt ein Bereichsobjekt zurück, bei dem es sich um die Randzelle des Datenbereichs handelt, der der angegebenen Richtung entspricht. Dies entspricht dem Verhalten der STRG+PFEILTASTE in der Excel unter Windows-Benutzeroberfläche.

getRangeEdge(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.13

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

Gibt ein eindimensionales Array zurück, das die Daten für die Schriftart, die Füllung, den Rahmen, die Ausrichtung und andere Eigenschaften jeder Zeile kapselt. Für Eigenschaften, die nicht in jeder Zelle innerhalb einer bestimmten Zeile konsistent sind, null werden zurückgegeben.

getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult<RowProperties[]>;

Parameter

Gibt zurück

Ein Array, in dem jedes Element die angeforderten Eigenschaften der entsprechenden Zeile darstellt.

Hinweise

API-Satz: ExcelApi 1.9

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

Ruft das RangeAreas Objekt ab, das aus einem oder mehreren rechteckigen Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, wird ein ItemNotFound Fehler ausgelöst.

getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const usedRange = sheet.getUsedRange();

    // Find the ranges with either text or logical (boolean) values.
    const formulaRanges = usedRange.getSpecialCells("Constants", "LogicalText");
    formulaRanges.format.fill.color = "orange";

    return context.sync();
});

Ruft das RangeAreas Objekt ab, das aus einem oder mehreren rechteckigen Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, wird ein ItemNotFound Fehler ausgelöst.

getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Ruft das RangeAreas Objekt ab, das aus einem oder mehreren Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Ruft das RangeAreas Objekt ab, das aus einem oder mehreren Bereichen besteht und alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Ruft beim Aufruf für eine Ankerzelle das Bereichsobjekt ab, das den Überlaufbereich enthält. Schlägt bei Anwendung auf einen Bereich mit mehr als einer Zelle fehl.

getSpillingToRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.12

Beispiele

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

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

  // Set G4 to a formula that returns a dynamic array.
  const targetCell = sheet.getRange("G4");
  targetCell.formulas = [["=A4:D4"]];

  // Get the address of the cells that the dynamic array spilled into.
  const spillRange = targetCell.getSpillingToRange();
  spillRange.load("address");

  // Fit the columns for readability.
  sheet.getUsedRange().format.autofitColumns();
  await context.sync();

  console.log(`Copying the table headers spilled into ${spillRange.address}.`);
});

Ruft beim Aufruf für eine Ankerzelle das Bereichsobjekt ab, das den Überlaufbereich enthält. Wenn der Bereich keine Ankerzelle ist oder der Überlaufbereich nicht gefunden werden kann, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpillingToRangeOrNullObject(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.12

Ruft das Bereichsobjekt ab, das die Ankerzelle für eine Zelle enthält, in die ein Überlauf erfolgen kann. Schlägt bei Anwendung auf einen Bereich mit mehr als einer Zelle fehl.

getSpillParent(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.12

Ruft das Bereichsobjekt ab, das die Ankerzelle enthält, in die die Zelle überläuft. Wenn es sich nicht um eine übergelaufene Zelle handelt oder mehr als eine Zelle angegeben ist, dann gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpillParentOrNullObject(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.12

Gibt ein Range Objekt zurück, das den umgebenden Bereich für die obere linke Zelle in diesem Bereich darstellt. Eine umgebende Region ist ein Bereich, der von einer Kombination von leeren Zeilen und leeren Spalten relativ zu diesem Bereich begrenzt wird.

getSurroundingRegion(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.7

Ruft eine bereichsbezogene Sammlung von Tabellen ab, die sich mit dem Bereich überschneidet.

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

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

Gibt den verwendeten Bereich des angegebenen Bereichsobjekts zurück. Wenn sich in dem Bereich keine verwendeten Zellen befinden, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

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

Parameter

Gibt zurück

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

Stellt die sichtbaren Zeilen des aktuellen Bereichs dar.

getVisibleView(): Excel.RangeView;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.3

Gruppiert Spalten und Zeilen für eine Gliederung.

group(groupOption: Excel.GroupOption): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

Beispiele

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

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // Group the larger, main level. Note that the outline controls
    // will be on row 10, meaning 4-9 will collapse and expand.
    sheet.getRange("4:9").group(Excel.GroupOption.byRows);

    // Group the smaller, sublevels. Note that the outline controls
    // will be on rows 6 and 9, meaning 4-5 and 7-8 will collapse and expand.
    sheet.getRange("4:5").group(Excel.GroupOption.byRows);
    sheet.getRange("7:8").group(Excel.GroupOption.byRows);
    await context.sync();
});

Gruppiert Spalten und Zeilen für eine Gliederung.

group(groupOption: "ByRows" | "ByColumns"): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

Blendet die Details der Zeile oder Spaltengruppe aus.

hideGroupDetails(groupOption: Excel.GroupOption): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

Blendet die Details der Zeile oder Spaltengruppe aus.

hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

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

Verschiebt Zellwerte, Formatierungen und Formeln aus dem aktuellen Bereich in den Zielbereich und ersetzt die alten Informationen in diesen Zellen. Der Zielbereich wird automatisch erweitert, wenn er kleiner als der aktuelle Bereich ist. Zellen im Zielbereich, die außerhalb des ursprünglichen Bereichs liegen, werden nicht geändert. Hinweis: Wenn ein Bereich mit dieser API an eine neue Adresse verschoben wird, sollte das neue Bereichsobjekt mithilfe der neuen Adresse abgerufen werden.

moveTo(destinationRange: Range | string): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.11

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    // Place a label in front of the moved data.
    sheet.getRange("F12").values = [["Moved Range:"]];

    // Move the range from A1:E1 to G12:K12.
    sheet.getRange("A1:E1").moveTo("G12");
    await context.sync();
});

Entfernt doppelte Werte aus dem durch die Spalten angegebenen Bereich.

removeDuplicates(columns: number[], includesHeader: boolean): Excel.RemoveDuplicatesResult;

Parameter

Gibt zurück

Das resultierende Objekt, das die Anzahl der entfernten Zeilen und die Anzahl der verbleibenden eindeutigen Zeilen enthält.

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

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

    const deleteResult = range.removeDuplicates([0],true);    
    deleteResult.load();    
    await context.sync();

    console.log(deleteResult.removed + " entries with duplicate names removed.");
    console.log(deleteResult.uniqueRemaining + " entries with unique names remain in the range.");
});

Sucht und ersetzt die angegebene Zeichenfolge auf der Grundlage der im aktuellen Bereich angegebenen Kriterien.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parameter

Gibt zurück

Die Anzahl der durchgeführten Ersetzungen.

Hinweise

API-Satz: ExcelApi 1.9

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

Updates den Bereich basierend auf einem 2D-Array von Zelleigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.

setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

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

    // Create the SettableCellProperties objects for the range.
    // Create these objects once, outside the function, in your add-in.
    const topHeaderProps: Excel.SettableCellProperties = {
        // Set the style property to the name of an Excel style.
        // The `BuiltInStyle` enum lists the built-in style names.
        // A style overwrites formatting, so don't use style and format in the same object.
        style: Excel.BuiltInStyle.heading1
    };

    const headerProps: Excel.SettableCellProperties = {
        // Setting these cell properties doesn't change unspecified format subproperties.
        format: {
            fill: {
                color: "Blue"
            },
            font: {
                color: "White",
                bold: true
            }
        }
    };

    const nonApplicableProps: Excel.SettableCellProperties = {
        format: {
            fill: {
                pattern: Excel.FillPattern.gray25
            },
            font: {
                color: "Gray",
                italic: true
            }
        }
    };

    const matchupScoreProps: Excel.SettableCellProperties = {
        format: {
            borders: {
                bottom: {
                    style: Excel.BorderLineStyle.continuous
                },
                left: {
                    style: Excel.BorderLineStyle.continuous
                },
                right: {
                    style: Excel.BorderLineStyle.continuous
                },
                top: {
                    style: Excel.BorderLineStyle.continuous
                }
            },
            horizontalAlignment: Excel.HorizontalAlignment.center
        }
    };

    const range = sheet.getRange("A1:E5");

    // Use empty JSON objects to leave a cell's properties unchanged.
    range.setCellProperties([
        [topHeaderProps, {}, {}, {}, {}],
        [{}, {}, headerProps, headerProps, headerProps],
        [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    await context.sync();
});

Updates den Bereich basierend auf einem eindimensionalen Array von Spalteneigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Legt für einen Bereich Neuberechnung bei der nächsten auszuführenden Neuberechnung fest.

setDirty(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Updates den Bereich basierend auf einem eindimensionalen Array von Zeileneigenschaften, die Elemente wie Schriftart, Füllung, Rahmen und Ausrichtung kapseln.

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

Zeigt die Karte für eine aktive Zelle an, wenn sie einen hohen Wertinhalt hat.

showCard(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.7

Zeichnet Spurpfeile zu den direkten Nachfolgern des Bereichs.

showDependents(remove?: boolean): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApiDesktop 1.1

Zeigt die Details der Zeile oder Spaltengruppe an.

showGroupDetails(groupOption: Excel.GroupOption): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

Zeigt die Details der Zeile oder Spaltengruppe an.

showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

Zeichnet Spurpfeile zu den direkten Vorgängerzellen des Bereichs.

showPrecedents(remove?: boolean): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApiDesktop 1.1

Legt den Marshallingmodus der Python in Excel-Formel =PY fest.

togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi BETA (NUR VORSCHAU)

Legt den Marshallingmodus der Python in Excel-Formel =PY fest.

togglePythonMarshalMode(marshalMode?: "PythonObject" | "ExcelValue"): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi BETA (NUR VORSCHAU)

Ü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 die Gruppierung von Spalten und Zeilen für eine Gliederung auf.

ungroup(groupOption: Excel.GroupOption): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

Beispiele

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

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    
    // This removes two levels of groups from the "A1-R10" range.
    // Any groups at the same level on the same dimension will be removed by a single call.
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byRows);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    sheet.getRange("A1:R10").ungroup(Excel.GroupOption.byColumns);
    await context.sync();
});

Hebt die Gruppierung von Spalten und Zeilen für eine Gliederung auf.

ungroup(groupOption: "ByRows" | "ByColumns"): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

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