Excel.RangeAreas class

RangeAreas stellt eine Auflistung von einem oder mehreren rechteckigen Bereichen im selben Arbeitsblatt dar. Wenn Sie erfahren möchten, wie Sie nicht zusammenhängenden Bereiche verwenden, lesen Sie "Arbeiten mit mehreren Bereichen gleichzeitig in Excel-Add-Ins"..

Extends

Hinweise

[API-Satz: ExcelApi 1.9 ]

Eigenschaften

address

Gibt den RangeAreas Verweis im A1-Format zurück. Der Adresswert enthält den Arbeitsblattnamen für jeden rechteckigen Zellenblock (z. B. "Sheet1! A1:B4, Sheet1! D1:D4").

addressLocal

Gibt den RangeAreas Verweis im Gebietsschema des Benutzers zurück.

areaCount

Gibt die Anzahl der rechteckigen Bereiche zurück, aus denen dieses RangeAreas Objekt besteht.

areas

Gibt eine Auflistung rechteckiger Bereiche zurück, aus denen dieses RangeAreas Objekt besteht.

cellCount

Gibt die Anzahl der Zellen im RangeAreas Objekt zurück, wobei die Zellanzahl aller einzelnen rechteckigen Bereiche summiert wird. Gibt -1 zurück, wenn die Zellanzahl 2^31-1 (2,147,483,647) überschreitet.

conditionalFormats

Gibt eine Auflistung bedingter Formate zurück, die sich mit allen Zellen in diesem RangeAreas Objekt überschneiden.

context

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

dataValidation

Gibt ein Datenüberprüfungsobjekt für alle Bereiche in der RangeAreas.

format

Gibt ein RangeFormat Objekt zurück, das die Schriftart, Füllung, Rahmen, Ausrichtung und andere Eigenschaften für alle Bereiche des Objekts kapselt. RangeAreas

isEntireColumn

Gibt an, ob alle Bereiche dieses Objekts ganze Spalten darstellen (z. B. RangeAreas "A:C, Q:Z").

isEntireRow

Gibt an, ob alle Bereiche in diesem RangeAreas Objekt ganze Zeilen darstellen (z. B. "1:3, 5:7").

style

Stellt die Formatvorlage für alle Bereiche in diesem RangeAreas Objekt 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 Enumeration darstellt.

worksheet

Gibt das Arbeitsblatt für das aktuelle Zurück RangeAreas.

Methoden

calculate()

Berechnet alle Zellen in der RangeAreas.

clear(applyTo)

Löscht Werte, Format, Füllung, Rahmen und andere Eigenschaften für jeden Bereich, aus dem dieses RangeAreas Objekt besteht.

clear(applyToString)

Löscht Werte, Format, Füllung, Rahmen und andere Eigenschaften für jeden Bereich, aus dem dieses RangeAreas Objekt besteht.

convertDataTypeToText()

Konvertiert alle Zellen in den RangeAreas With-Datentypen in Text.

convertToLinkedDataType(serviceID, languageCulture)

Konvertiert alle Zellen in RangeAreas verknüpften Datentypen.

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder RangeAreas in den aktuellen RangeAreas. Das Ziel RangeAreas kann eine andere Größe als der Quellbereich haben oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist.

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder RangeAreas in den aktuellen RangeAreas. Das Ziel RangeAreas kann eine andere Größe als der Quellbereich haben oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist.

getEntireColumn()

Gibt ein Objekt zurück, das die gesamten Spalten des Objekts darstellt (wenn der Aktuelle z. B. RangeAreas die Zellen RangeAreas RangeAreas "B4:E11, H2" darstellt, wird ein Objekt zurückgegeben, RangeAreas das die Spalten "B:E, H:H") darstellt.

getEntireRow()

Gibt ein Objekt zurück, das die gesamten Zeilen des Objekts RangeAreas darstellt RangeAreas (wenn der Aktuelle z. B. die RangeAreas Zellen "B4:E11" darstellt, wird ein Objekt zurückgegeben, RangeAreas das die Zeilen "4:11") darstellt.

getIntersection(anotherRange)

Gibt das RangeAreas Objekt zurück, das die Schnittmenge der angegebenen Bereiche darstellt, oder RangeAreas. Wenn keine Schnittmenge gefunden wird, wird ein ItemNotFound Fehler ausgelöst.

getIntersectionOrNullObject(anotherRange)

Gibt das RangeAreas Objekt zurück, das die Schnittmenge der angegebenen Bereiche darstellt, oder RangeAreas. Wenn keine Schnittmenge gefunden wird, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

getOffsetRangeAreas(rowOffset, columnOffset)

Gibt ein RangeAreas Objekt zurück, das durch den spezifischen Zeilen- und Spaltenversatz verschoben wird. Die Dimension des RangeAreas zurückgegebenen Objekts stimmt mit dem ursprünglichen Objekt überein. Wenn das resultierende Ergebnis RangeAreas außerhalb der Grenzen des Arbeitsblattrasters erzwungen wird, wird ein Fehler ausgelöst.

getSpecialCells(cellType, cellValueType)

Gibt ein RangeAreas Objekt zurück, das alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Löst einen Fehler aus, wenn keine besonderen Zellen gefunden werden, die den Kriterien entsprechen.

getSpecialCells(cellTypeString, cellValueType)

Gibt ein RangeAreas Objekt zurück, das alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Löst einen Fehler aus, wenn keine besonderen Zellen gefunden werden, die den Kriterien entsprechen.

getSpecialCellsOrNullObject(cellType, cellValueType)

Gibt ein RangeAreas Objekt zurück, das alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, die den Kriterien entsprechen, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

Gibt ein RangeAreas Objekt zurück, das alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, die den Kriterien entsprechen, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

getTables(fullyContained)

Gibt eine bereichsbezogene Auflistung von Tabellen zurück, die mit einem beliebigen Bereich in diesem RangeAreas Objekt überlappen.

getUsedRangeAreas(valuesOnly)

Gibt den verwendeten RangeAreas Bereich zurück, der alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas Objekt umfasst. Wenn keine verwendeten Zellen innerhalb der RangeAreaswird der ItemNotFound Fehler ausgelöst.

getUsedRangeAreasOrNullObject(valuesOnly)

Gibt den verwendeten RangeAreas Bereich zurück, der alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas Objekt umfasst. Wenn keine verwendeten Zellen innerhalb der RangeAreasgibt diese Funktion dann ein Objekt zurück, dessen isNullObject Eigenschaft auf true. 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.

set(properties, options)

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

set(properties)

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

setDirty()

Legt fest, dass die RangeAreas Neuberechnung erfolgt, wenn die nächste Neuberechnung erfolgt.

toJSON()

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

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Abkürzung für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, mussten Sie das Objekt der Nachverfolgungsobjektauflistung hinzugefügt haben, 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 eine Abkürzung für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen, context.sync() bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

address

Gibt den RangeAreas Verweis im A1-Format zurück. Der Adresswert enthält den Arbeitsblattnamen für jeden rechteckigen Zellenblock (z. B. "Sheet1! A1:B4, Sheet1! D1:D4").

readonly address: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.9 ]

addressLocal

Gibt den RangeAreas Verweis im Gebietsschema des Benutzers zurück.

readonly addressLocal: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.9 ]

areaCount

Gibt die Anzahl der rechteckigen Bereiche zurück, aus denen dieses RangeAreas Objekt besteht.

readonly areaCount: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.9 ]

areas

Gibt eine Auflistung rechteckiger Bereiche zurück, aus denen dieses RangeAreas Objekt besteht.

readonly areas: Excel.RangeCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9 ]

cellCount

Gibt die Anzahl der Zellen im RangeAreas Objekt zurück, wobei die Zellanzahl aller einzelnen rechteckigen Bereiche summiert wird. Gibt -1 zurück, wenn die Zellanzahl 2^31-1 (2,147,483,647) überschreitet.

readonly cellCount: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.9 ]

conditionalFormats

Gibt eine Auflistung bedingter Formate zurück, die sich mit allen Zellen in diesem RangeAreas Objekt überschneiden.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9 ]

context

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

context: RequestContext;

Eigenschaftswert

dataValidation

Gibt ein Datenüberprüfungsobjekt für alle Bereiche in der RangeAreas.

readonly dataValidation: Excel.DataValidation;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9 ]

format

Gibt ein RangeFormat Objekt zurück, das die Schriftart, Füllung, Rahmen, Ausrichtung und andere Eigenschaften für alle Bereiche des Objekts kapselt. RangeAreas

readonly format: Excel.RangeFormat;

Eigenschaftswert

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 formulas.
    const formulaRanges = usedRange.getSpecialCells("Formulas");
    formulaRanges.format.fill.color = "lightgreen";

    await context.sync();
});

isEntireColumn

Gibt an, ob alle Bereiche dieses Objekts ganze Spalten darstellen (z. B. RangeAreas "A:C, Q:Z").

readonly isEntireColumn: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9 ]

isEntireRow

Gibt an, ob alle Bereiche in diesem RangeAreas Objekt ganze Zeilen darstellen (z. B. "1:3, 5:7").

readonly isEntireRow: boolean;

Eigenschaftswert

boolean

Hinweise

[API-Satz: ExcelApi 1.9 ]

style

Stellt die Formatvorlage für alle Bereiche in diesem RangeAreas Objekt 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 Enumeration darstellt.

style: string;

Eigenschaftswert

string

Hinweise

[API-Satz: ExcelApi 1.9 ]

worksheet

Gibt das Arbeitsblatt für das aktuelle Zurück RangeAreas.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9 ]

Details zur Methode

calculate()

Berechnet alle Zellen in der RangeAreas.

calculate(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9 ]

clear(applyTo)

Löscht Werte, Format, Füllung, Rahmen und andere Eigenschaften für jeden Bereich, aus dem dieses RangeAreas Objekt besteht.

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

Parameter

applyTo
Excel.ClearApplyTo

Optional. Bestimmt den Typ der Löschaktion. Weitere Informationen finden Sie Excel.ClearApplyTo unter. Der Standardwert ist "Alle".

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9 ]

clear(applyToString)

Löscht Werte, Format, Füllung, Rahmen und andere Eigenschaften für jeden Bereich, aus dem dieses RangeAreas Objekt besteht.

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

Parameter

applyToString

"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks"

Optional. Bestimmt den Typ der Löschaktion. Weitere Informationen finden Sie Excel.ClearApplyTo unter. Der Standardwert ist "Alle".

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9 ]

convertDataTypeToText()

Konvertiert alle Zellen in den RangeAreas With-Datentypen in Text.

convertDataTypeToText(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

Konvertiert alle Zellen in RangeAreas verknüpften Datentypen.

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

Parameter

serviceID

number

Die Dienst-ID, die zum Abfragen der Daten verwendet wird.

languageCulture

string

Sprachkultur, nach der der Dienst abgefragt werden soll.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9 ]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder RangeAreas in den aktuellen RangeAreas. Das Ziel RangeAreas kann eine andere Größe als der Quellbereich haben oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist.

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

Parameter

sourceRange

Excel.Range | Excel.RangeAreas | string

Der Quellbereich oder RangeAreas aus dem kopiert werden soll. Wenn die Quelle RangeAreas mehrere Bereiche aufweist, muss ihr Formular erstellt werden können, indem vollständige Zeilen oder Spalten aus einem rechteckigen Bereich entfernt werden.

copyType
Excel.RangeCopyType

Der Typ der Zu kopierenden Zelldaten oder Formatierungen. Der Standardwert ist "Alle".

skipBlanks

boolean

True, wenn leere Zellen im Quellbereich übersprungen werden sollen oder RangeAreas. Der Standardwert ist „false“.

transpose

boolean

True, wenn die Zellen im Ziel transponieren RangeAreas. Der Standardwert ist „false“.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9 ]

copyFrom(sourceRange, copyTypeString, skipBlanks, transpose)

Kopiert Zelldaten oder Formatierungen aus dem Quellbereich oder RangeAreas in den aktuellen RangeAreas. Das Ziel RangeAreas kann eine andere Größe als der Quellbereich haben oder RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist.

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

Parameter

sourceRange

Excel.Range | Excel.RangeAreas | string

Der Quellbereich oder RangeAreas aus dem kopiert werden soll. Wenn die Quelle RangeAreas mehrere Bereiche aufweist, muss ihr Formular erstellt werden können, indem vollständige Zeilen oder Spalten aus einem rechteckigen Bereich entfernt werden.

copyTypeString

"All" | "Formulas" | "Values" | "Formats"

Der Typ der Zu kopierenden Zelldaten oder Formatierungen. Der Standardwert ist "Alle".

skipBlanks

boolean

True, wenn leere Zellen im Quellbereich übersprungen werden sollen oder RangeAreas. Der Standardwert ist „false“.

transpose

boolean

True, wenn die Zellen im Ziel transponieren RangeAreas. Der Standardwert ist „false“.

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9 ]

getEntireColumn()

Gibt ein Objekt zurück, das die gesamten Spalten des Objekts darstellt (wenn der Aktuelle z. B. RangeAreas die Zellen RangeAreas RangeAreas "B4:E11, H2" darstellt, wird ein Objekt zurückgegeben, RangeAreas das die Spalten "B:E, H:H") darstellt.

getEntireColumn(): Excel.RangeAreas;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getEntireRow()

Gibt ein Objekt zurück, das die gesamten Zeilen des Objekts RangeAreas darstellt RangeAreas (wenn der Aktuelle z. B. die RangeAreas Zellen "B4:E11" darstellt, wird ein Objekt zurückgegeben, RangeAreas das die Zeilen "4:11") darstellt.

getEntireRow(): Excel.RangeAreas;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getIntersection(anotherRange)

Gibt das RangeAreas Objekt zurück, das die Schnittmenge der angegebenen Bereiche darstellt, oder RangeAreas. Wenn keine Schnittmenge gefunden wird, wird ein ItemNotFound Fehler ausgelöst.

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

Parameter

anotherRange

Excel.Range | Excel.RangeAreas | string

Der RangeAreas Bereich, das Objekt oder die Bereichsadresse, die zum Bestimmen der Schnittmenge verwendet wird.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getIntersectionOrNullObject(anotherRange)

Gibt das RangeAreas Objekt zurück, das die Schnittmenge der angegebenen Bereiche darstellt, oder RangeAreas. Wenn keine Schnittmenge gefunden wird, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

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

Parameter

anotherRange

Excel.Range | Excel.RangeAreas | string

Der RangeAreas Bereich, das Objekt oder die Adresse, mit dem bzw. der die Schnittmenge bestimmt wird.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getOffsetRangeAreas(rowOffset, columnOffset)

Gibt ein RangeAreas Objekt zurück, das durch den spezifischen Zeilen- und Spaltenversatz verschoben wird. Die Dimension des RangeAreas zurückgegebenen Objekts stimmt mit dem ursprünglichen Objekt überein. Wenn das resultierende Ergebnis RangeAreas außerhalb der Grenzen des Arbeitsblattrasters erzwungen wird, wird ein Fehler ausgelöst.

getOffsetRangeAreas(rowOffset: number, columnOffset: number): Excel.RangeAreas;

Parameter

rowOffset

number

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

columnOffset

number

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

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getSpecialCells(cellType, cellValueType)

Gibt ein RangeAreas Objekt zurück, das alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Löst einen Fehler aus, wenn keine besonderen Zellen gefunden werden, die den Kriterien entsprechen.

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

Parameter

cellType
Excel.SpecialCellType

Der Typ der einzuschließenden Zellen.

cellValueType
Excel.SpecialCellValueType

Wenn cellType entweder constants oder formulaswird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis einbezogen werden sollen. Diese Werte können kombiniert werden, um mehr als einen Typ zurückzugeben. Standardmäßig werden alle Konstanten oder Formeln unabhängig vom Typ ausgewählt.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getSpecialCells(cellTypeString, cellValueType)

Gibt ein RangeAreas Objekt zurück, das alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Löst einen Fehler aus, wenn keine besonderen Zellen gefunden werden, die den Kriterien entsprechen.

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

Parameter

cellTypeString

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Der Typ der einzuschließenden Zellen.

cellValueType

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Wenn cellType entweder constants oder formulaswird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis einbezogen werden sollen. Diese Werte können kombiniert werden, um mehr als einen Typ zurückzugeben. Standardmäßig werden alle Konstanten oder Formeln unabhängig vom Typ ausgewählt.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellType, cellValueType)

Gibt ein RangeAreas Objekt zurück, das alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, die den Kriterien entsprechen, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

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

Parameter

cellType
Excel.SpecialCellType

Der Typ der einzuschließenden Zellen.

cellValueType
Excel.SpecialCellValueType

Wenn cellType entweder constants oder formulaswird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis einbezogen werden sollen. Diese Werte können kombiniert werden, um mehr als einen Typ zurückzugeben. Standardmäßig werden alle Konstanten oder Formeln unabhängig vom Typ ausgewählt.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueType)

Gibt ein RangeAreas Objekt zurück, das alle Zellen darstellt, die dem angegebenen Typ und Wert entsprechen. Wenn keine speziellen Zellen gefunden werden, die den Kriterien entsprechen, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

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

Parameter

cellTypeString

"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Der Typ der einzuschließenden Zellen.

cellValueType

"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

Wenn cellType entweder constants oder formulaswird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis einbezogen werden sollen. Diese Werte können kombiniert werden, um mehr als einen Typ zurückzugeben. Standardmäßig werden alle Konstanten oder Formeln unabhängig vom Typ ausgewählt.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getTables(fullyContained)

Gibt eine bereichsbezogene Auflistung von Tabellen zurück, die mit einem beliebigen Bereich in diesem RangeAreas Objekt überlappen.

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

Parameter

fullyContained

boolean

Wenn truegibt nur Tabellen zurück, die vollständig innerhalb der Bereichsgrenzen enthalten sind. Der Standardwert ist false.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getUsedRangeAreas(valuesOnly)

Gibt den verwendeten RangeAreas Bereich zurück, der alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas Objekt umfasst. Wenn keine verwendeten Zellen innerhalb der RangeAreaswird der ItemNotFound Fehler ausgelöst.

getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;

Parameter

valuesOnly

boolean

Gibt an, ob nur Zellen mit Werten als verwendete Zellen betrachtet werden sollen. Der Standardwert ist false.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

getUsedRangeAreasOrNullObject(valuesOnly)

Gibt den verwendeten RangeAreas Bereich zurück, der alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas Objekt umfasst. Wenn keine verwendeten Zellen innerhalb der RangeAreasgibt diese Funktion dann ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;

Parameter

valuesOnly

boolean

Gibt an, ob nur Zellen mit Werten als verwendete Zellen betrachtet werden sollen.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9 ]

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.RangeAreasLoadOptions): Excel.RangeAreas;

Parameter

options
Excel.Interfaces.RangeAreasLoadOptions

Stellt Optionen bereit, für welche Eigenschaften des Objekts geladen werden soll.

Gibt zurück

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.RangeAreas;

Parameter

propertyNames

string | string[]

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

Gibt zurück

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.RangeAreas;

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

set(properties, options)

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

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

Parameter

properties
Excel.Interfaces.RangeAreasUpdateData

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

options
OfficeExtension.UpdateOptions

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

Gibt zurück

void

set(properties)

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

set(properties: Excel.RangeAreas): void;

Parameter

properties
Excel.RangeAreas

Gibt zurück

void

setDirty()

Legt fest, dass die RangeAreas Neuberechnung erfolgt, wenn die nächste Neuberechnung erfolgt.

setDirty(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApi 1.9 ]

toJSON()

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

toJSON(): Excel.Interfaces.RangeAreasData;

Gibt zurück

track()

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

track(): Excel.RangeAreas;

Gibt zurück

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist eine Abkürzung 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.RangeAreas;

Gibt zurück