Excel.RangeAreas class

Paket:

excel

RangeAreas stellt eine Auflistung von einem oder mehreren rechteckigen Bereichen im selben Arbeitsblatt dar. Informationen zur Verwendung von nicht zusammenhängenden Bereichen finden Sie unter Arbeiten mit mehreren Bereichen gleichzeitig in Excel-Add-Ins.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Eigenschaften

address	Gibt den RangeAreas Verweis im A1-Format zurück. Der Adresswert enthält den Namen des Arbeitsblatts für jeden rechteckigen Zellblock (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 und summiert die Zellanzahl aller einzelnen rechteckigen Bereiche. 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 zellen in diesem RangeAreas Objekt überschneiden.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
dataValidation	Gibt ein Datenüberprüfungsobjekt für alle Bereiche im zurück RangeAreas.
format	Gibt ein RangeFormat -Objekt zurück, das die Schriftart, Füllung, Rahmen, Ausrichtung und andere Eigenschaften für alle Bereiche im RangeAreas Objekt kapselt.
isEntireColumn	Gibt an, ob alle Bereiche in diesem RangeAreas Objekt ganze Spalten darstellen (z. B. "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 die aktuelle RangeAreaszurück.

Methoden

calculate()	Berechnet alle Zellen im RangeAreas.
clear(applyTo)	Löscht Werte, Format, Füllung, Rahmen und andere Eigenschaften für jeden der Bereiche, aus denen dieses RangeAreas Objekt besteht.
clear(applyToString)	Löscht Werte, Format, Füllung, Rahmen und andere Eigenschaften für jeden der Bereiche, aus denen dieses RangeAreas Objekt besteht.
clearOrResetContents()	Löscht die Werte der Zellen in den Bereichen unter besonderer Berücksichtigung von Zellen, die Steuerelemente enthalten. Wenn die Bereiche nur leere Werte und Steuerelemente enthalten, die auf ihren Standardwert festgelegt sind, werden die Werte und die Steuerelementformatierung entfernt. Andernfalls werden die Zellen mit Steuerelementen auf ihren Standardwert festgelegt und die Werte der anderen Zellen in den Bereichen gelöscht.
convertDataTypeToText()	Konvertiert alle Zellen im mit Datentypen in RangeAreas Text.
convertToLinkedDataType(serviceID, languageCulture)	Konvertiert alle Zellen in in verknüpfte RangeAreas 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 oder haben 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 oder haben RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist.
getEntireColumn()	Gibt ein RangeAreas -Objekt zurück, das die gesamten Spalten des RangeAreas darstellt (wenn der aktuelle RangeAreas z. B. zellen "B4:E11, H2" darstellt, wird ein RangeAreas zurückgegeben, das die Spalten "B:E, H:H") darstellt.
getEntireRow()	Gibt ein RangeAreas -Objekt zurück, das die gesamten Zeilen des RangeAreas darstellt (wenn die aktuelle RangeAreas z. B. zellen "B4:E11" darstellt, gibt sie ein zurück RangeAreas , das die Zeilen "4:11" darstellt).
getIntersection(anotherRange)	Gibt das RangeAreas -Objekt zurück, das die Schnittmenge der angegebenen Bereiche oder RangeAreasdarstellt. 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 oder RangeAreasdarstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getOffsetRangeAreas(rowOffset, columnOffset)	Gibt ein RangeAreas Objekt zurück, das durch den spezifischen Zeilen- und Spaltenoffset verschoben wird. Die Dimension des zurückgegebenen RangeAreas entspricht dem ursprünglichen Objekt. Wenn das resultierende 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, cellValueTypeString)	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 Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)	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 Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getTables(fullyContained)	Gibt eine bereichsbezogene Auflistung von Tabellen zurück, die sich mit einem beliebigen Bereich in diesem RangeAreas Objekt überlappen.
getUsedRangeAreas(valuesOnly)	Gibt den verwendeten RangeAreas zurück, der alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas -Objekt umfasst. Wenn keine verwendeten Zellen innerhalb von RangeAreasvorhanden sind, wird der ItemNotFound Fehler ausgelöst.
getUsedRangeAreasOrNullObject(valuesOnly)	Gibt den verwendeten RangeAreas zurück, der alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas -Objekt umfasst. Wenn keine verwendeten Zellen innerhalb von RangeAreasvorhanden sind, 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.
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 bei RangeAreas der nächsten Neuberechnung neu berechnet wird.
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.RangeAreas Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeAreasData) 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

address

Gibt den RangeAreas Verweis im A1-Format zurück. Der Adresswert enthält den Namen des Arbeitsblatts für jeden rechteckigen Zellblock (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

Excel.RangeCollection

Hinweise

[ API-Satz: ExcelApi 1.9 ]

cellCount

Gibt die Anzahl der Zellen im RangeAreas -Objekt zurück und summiert die Zellanzahl aller einzelnen rechteckigen Bereiche. 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 zellen in diesem RangeAreas Objekt überschneiden.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Eigenschaftswert

Excel.ConditionalFormatCollection

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

dataValidation

Gibt ein Datenüberprüfungsobjekt für alle Bereiche im zurück RangeAreas.

readonly dataValidation: Excel.DataValidation;

Eigenschaftswert

Excel.DataValidation

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 im RangeAreas Objekt kapselt.

readonly format: Excel.RangeFormat;

Eigenschaftswert

Excel.RangeFormat

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 in diesem RangeAreas Objekt ganze Spalten darstellen (z. B. "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 die aktuelle RangeAreaszurück.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Details zur Methode

calculate()

Berechnet alle Zellen im 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 der Bereiche, aus denen dieses RangeAreas Objekt besteht.

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

Parameter

applyTo

Excel.ClearApplyTo

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

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 der Bereiche, aus denen dieses RangeAreas Objekt besteht.

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

Parameter

applyToString

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

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

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9 ]

clearOrResetContents()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Löscht die Werte der Zellen in den Bereichen unter besonderer Berücksichtigung von Zellen, die Steuerelemente enthalten. Wenn die Bereiche nur leere Werte und Steuerelemente enthalten, die auf ihren Standardwert festgelegt sind, werden die Werte und die Steuerelementformatierung entfernt. Andernfalls werden die Zellen mit Steuerelementen auf ihren Standardwert festgelegt und die Werte der anderen Zellen in den Bereichen gelöscht.

clearOrResetContents(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

convertDataTypeToText()

Konvertiert alle Zellen im mit Datentypen in RangeAreas Text.

convertDataTypeToText(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9 ]

convertToLinkedDataType(serviceID, languageCulture)

Konvertiert alle Zellen in in verknüpfte RangeAreas 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 abfragt 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 oder haben 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 der zu kopierende Bereich. Wenn die Quelle RangeAreas über mehrere Bereiche verfügt, muss ihre Form 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 "All".

skipBlanks

boolean

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

transpose

boolean

True, wenn die Zellen im Ziel RangeAreastransponieren sollen. 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 oder haben RangeAreas. Das Ziel wird automatisch erweitert, wenn es kleiner als die Quelle ist.

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

Parameter

sourceRange

Excel.Range | Excel.RangeAreas | string

Der Quellbereich oder RangeAreas der zu kopierende Bereich. Wenn die Quelle RangeAreas über mehrere Bereiche verfügt, muss ihre Form erstellt werden können, indem vollständige Zeilen oder Spalten aus einem rechteckigen Bereich entfernt werden.

copyTypeString

"All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"

Der Typ der Zu kopierenden Zelldaten oder formatierungen. Der Standardwert ist "All".

skipBlanks

boolean

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

transpose

boolean

True, wenn die Zellen im Ziel RangeAreastransponieren sollen. Der Standardwert ist „false“.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getEntireColumn()

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

getEntireColumn(): Excel.RangeAreas;

Gibt zurück

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getEntireRow()

Gibt ein RangeAreas -Objekt zurück, das die gesamten Zeilen des RangeAreas darstellt (wenn die aktuelle RangeAreas z. B. zellen "B4:E11" darstellt, gibt sie ein zurück RangeAreas , das die Zeilen "4:11" darstellt).

getEntireRow(): Excel.RangeAreas;

Gibt zurück

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getIntersection(anotherRange)

Gibt das RangeAreas -Objekt zurück, das die Schnittmenge der angegebenen Bereiche oder RangeAreasdarstellt. 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 Bereich, RangeAreas das Objekt oder die Bereichsadresse, die zum Bestimmen der Schnittmenge verwendet wird.

Gibt zurück

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getIntersectionOrNullObject(anotherRange)

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

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

Parameter

anotherRange

Excel.Range | Excel.RangeAreas | string

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

Gibt zurück

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getOffsetRangeAreas(rowOffset, columnOffset)

Gibt ein RangeAreas Objekt zurück, das durch den spezifischen Zeilen- und Spaltenoffset verschoben wird. Die Dimension des zurückgegebenen RangeAreas entspricht dem ursprünglichen Objekt. Wenn das resultierende 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 RangeAreas versetzt werden soll. Bei positiven Werten erfolgt der Versatz nach unten, bei negativen Werten nach oben.

columnOffset

number

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

Gibt zurück

Excel.RangeAreas

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 formulasist, wird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis eingeschlossen 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

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getSpecialCells(cellTypeString, cellValueTypeString)

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", cellValueTypeString?: "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.

cellValueTypeString

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

Wenn cellType entweder constants oder formulasist, wird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis eingeschlossen 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

Excel.RangeAreas

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 Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. 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 formulasist, wird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis eingeschlossen 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

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getSpecialCellsOrNullObject(cellTypeString, cellValueTypeString)

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 Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getSpecialCellsOrNullObject(cellTypeString: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueTypeString?: "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.

cellValueTypeString

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

Wenn cellType entweder constants oder formulasist, wird dieses Argument verwendet, um zu bestimmen, welche Zelltypen in das Ergebnis eingeschlossen 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

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getTables(fullyContained)

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

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

Parameter

fullyContained

boolean

Gibt truebei nur Tabellen zurück, die vollständig in den Bereichsgrenzen enthalten sind. Der Standardwert ist false.

Gibt zurück

Excel.TableScopedCollection

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getUsedRangeAreas(valuesOnly)

Gibt den verwendeten RangeAreas zurück, der alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas -Objekt umfasst. Wenn keine verwendeten Zellen innerhalb von RangeAreasvorhanden sind, wird der ItemNotFound Fehler ausgelöst.

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

Parameter

valuesOnly

boolean

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

Gibt zurück

Excel.RangeAreas

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getUsedRangeAreasOrNullObject(valuesOnly)

Gibt den verwendeten RangeAreas zurück, der alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas -Objekt umfasst. Wenn keine verwendeten Zellen innerhalb von RangeAreasvorhanden sind, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. 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 berücksichtigt werden sollen.

Gibt zurück

Excel.RangeAreas

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 dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.RangeAreas

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

Excel.RangeAreas

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

Excel.RangeAreas

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

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

Gibt zurück

void

set(properties)

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

set(properties: Excel.RangeAreas): void;

Parameter

properties

Excel.RangeAreas

Gibt zurück

void

setDirty()

Legt fest, dass bei RangeAreas der nächsten Neuberechnung neu berechnet wird.

setDirty(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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.RangeAreas Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeAreasData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.RangeAreasData;

Gibt zurück

Excel.Interfaces.RangeAreasData

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

Gibt zurück

Excel.RangeAreas

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

Gibt zurück

Excel.RangeAreas