Excel.WorkbookRangeAreas class

Paket:

excel

Stellt eine Auflistung von einem oder mehreren rechteckigen Bereichen in mehreren Arbeitsblättern dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.12 ]

Eigenschaften

addresses	Gibt ein Array von Adressen im A1-Stil zurück. Adresswerte enthalten den Namen des Arbeitsblatts für jeden rechteckigen Zellblock (z. B. "Sheet1! A1:B4, Sheet1! D1:D4"). Schreibgeschützt.
areas	Gibt das RangeAreasCollection -Objekt zurück. Jede RangeAreas in der Auflistung stellt einen oder mehrere Rechteckbereiche in einem Arbeitsblatt dar.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
ranges	Gibt Bereiche zurück, aus denen dieses Objekt in einem -Objekt besteht RangeCollection .

Methoden

getRangeAreasBySheet(key)	Gibt das Objekt basierend auf der RangeAreas Arbeitsblatt-ID oder dem Namen in der Auflistung zurück.
getRangeAreasOrNullObjectBySheet(key)	Gibt das Objekt basierend auf dem Namen oder der RangeAreas ID des Arbeitsblatts in der Auflistung zurück. Wenn das Arbeitsblatt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
toJSON()	Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.WorkbookRangeAreas Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.WorkbookRangeAreasData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
track()	Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde.
untrack()	Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

addresses

Gibt ein Array von Adressen im A1-Stil zurück. Adresswerte enthalten den Namen des Arbeitsblatts für jeden rechteckigen Zellblock (z. B. "Sheet1! A1:B4, Sheet1! D1:D4"). Schreibgeschützt.

readonly addresses: string[];

Eigenschaftswert

string[]

Hinweise

[ API-Satz: ExcelApi 1.12 ]

areas

Gibt das RangeAreasCollection -Objekt zurück. Jede RangeAreas in der Auflistung stellt einen oder mehrere Rechteckbereiche in einem Arbeitsblatt dar.

readonly areas: Excel.RangeAreasCollection;

Eigenschaftswert

Excel.RangeAreasCollection

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

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

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

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

ranges

Gibt Bereiche zurück, aus denen dieses Objekt in einem -Objekt besteht RangeCollection .

readonly ranges: Excel.RangeCollection;

Eigenschaftswert

Excel.RangeCollection

Hinweise

[ API-Satz: ExcelApi 1.12 ]

Details zur Methode

getRangeAreasBySheet(key)

Gibt das Objekt basierend auf der RangeAreas Arbeitsblatt-ID oder dem Namen in der Auflistung zurück.

getRangeAreasBySheet(key: string): Excel.RangeAreas;

Parameter

key

string

Der Name oder die ID des Arbeitsblatts.

Gibt zurück

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.12 ]

getRangeAreasOrNullObjectBySheet(key)

Gibt das Objekt basierend auf dem Namen oder der RangeAreas ID des Arbeitsblatts in der Auflistung zurück. Wenn das Arbeitsblatt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas;

Parameter

key

string

Der Name oder die ID des Arbeitsblatts.

Gibt zurück

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.12 ]

load(options)

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

load(options?: Excel.Interfaces.WorkbookRangeAreasLoadOptions): Excel.WorkbookRangeAreas;

Parameter

options

Excel.Interfaces.WorkbookRangeAreasLoadOptions

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

Gibt zurück

Excel.WorkbookRangeAreas

load(propertyNames)

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

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.WorkbookRangeAreas

load(propertyNamesAndPaths)

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

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

Parameter

propertyNamesAndPaths

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

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

Gibt zurück

Excel.WorkbookRangeAreas

toJSON()

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

toJSON(): Excel.Interfaces.WorkbookRangeAreasData;

Gibt zurück

Excel.Interfaces.WorkbookRangeAreasData

track()

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

track(): Excel.WorkbookRangeAreas;

Gibt zurück

Excel.WorkbookRangeAreas

untrack()

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

untrack(): Excel.WorkbookRangeAreas;

Gibt zurück

Excel.WorkbookRangeAreas