Excel.RangeAreas class
RangeAreas Stellt eine Sammlung eines oder mehrerer rechteckiger Bereiche im selben Arbeitsblatt dar. Weitere Informationen zur Verwendung nicht zusammenhängender Bereiche finden Sie unter "Arbeiten mit mehreren Bereichen gleichzeitig in Excel-Add-Ins".
- Extends
Hinweise
Verwendet von
- Excel.Application: union
- Excel.ConditionalFormat: getRanges, setRanges
- Excel.DataValidation: getInvalidCells, getInvalidCellsOrNullObject
- Excel.PageLayout: getPrintArea, getPrintAreaOrNullObject, setPrintArea
- Excel.Range: copyFrom, getMergedAreasOrNullObject, getSpecialCells, getSpecialCellsOrNullObject
- Excel.RangeAreasCollection: getItemAt, Elemente
- Excel.Window: rangeSelection
- Excel.Workbook: getSelectedRanges
- Excel.WorkbookRangeAreas: getRangeAreasBySheet, getRangeAreasOrNullObjectBySheet
- Excel.Worksheet: findAll, findAllOrNullObject, getRanges
Eigenschaften
| address | Gibt den |
| address |
Gibt den |
| area |
Gibt die Anzahl der rechteckigen Bereiche zurück, aus denen dieses |
| areas | Gibt eine Auflistung rechteckiger Bereiche zurück, aus denen dieses |
| cell |
Gibt die Anzahl der Zellen im |
| conditional |
Gibt eine Auflistung bedingter Formate zurück, die sich mit beliebigen Zellen in diesem |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| data |
Gibt ein Datenüberprüfungsobjekt für alle Bereiche im |
| format | Gibt ein |
| is |
Gibt an, ob alle Bereiche in diesem |
| is |
Gibt an, ob alle Bereiche in diesem |
| style | Stellt die Formatvorlage für alle Bereiche in diesem |
| worksheet | Gibt das Arbeitsblatt für den aktuellen |
Methoden
| calculate() | Berechnet alle Zellen im |
| clear(apply |
Löscht Werte, Format, Füllung, Rahmen und andere Eigenschaften für jeden der Bereiche, aus denen dieses |
| clear(apply |
Löscht Werte, Format, Füllung, Rahmen und andere Eigenschaften für jeden der Bereiche, aus denen dieses |
| clear |
Löscht die Werte der Zellen in den Bereichen, wobei Zellen, die Steuerelemente enthalten, besonders berücksichtigt werden. Wenn die Bereiche nur leere Werte enthalten und Steuerelemente auf ihren Standardwert festgelegt sind, 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 in den Bereichen werden gelöscht. |
| convert |
Wandelt alle Zellen des |
| convert |
Konvertiert alle Zellen in diesem in verknüpfte |
| copy |
Kopiert Zelldaten oder -formatierungen aus dem Quellbereich oder |
| copy |
Kopiert Zelldaten oder -formatierungen aus dem Quellbereich oder |
| get |
Gibt ein |
| get |
Gibt ein |
| get |
Gibt das |
| get |
Gibt das |
| get |
Gibt ein |
| get |
Gibt ein |
| get |
Gibt ein |
| get |
Gibt ein |
| get |
Gibt ein |
| get |
Gibt eine bereichsbezogene Auflistung von Tabellen zurück, die sich mit einem beliebigen Bereich in diesem |
| get |
Gibt das verwendete |
| get |
Gibt das verwendete |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| select() | Wählt die angegebenen Bereichsbereiche in der Excel-Benutzeroberfläche aus. |
| 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. |
| set |
Legt den Wert fest, der |
| toJSON() | Überschreibt die JavaScript-Methode |
| 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 aufrufübergreifend |
| 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 einen Aufruf durchführen |
Details zur Eigenschaft
address
Gibt den RangeAreas Bezug im A1-Format zurück. Der Adresswert enthält den Arbeitsblattnamen für jeden rechteckigen Zellblock (z. B. "Tabelle1! A1:B4, Tabelle1! D1:D4").
readonly address: string;
Eigenschaftswert
string
Hinweise
addressLocal
Gibt den RangeAreas Bezug im Benutzergebietsschema zurück.
readonly addressLocal: string;
Eigenschaftswert
string
Hinweise
areaCount
Gibt die Anzahl der rechteckigen Bereiche zurück, aus denen dieses RangeAreas Objekt besteht.
readonly areaCount: number;
Eigenschaftswert
number
Hinweise
areas
Gibt eine Auflistung rechteckiger Bereiche zurück, aus denen dieses RangeAreas Objekt besteht.
readonly areas: Excel.RangeCollection;
Eigenschaftswert
Hinweise
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
conditionalFormats
Gibt eine Auflistung bedingter Formate zurück, die sich mit beliebigen Zellen in diesem RangeAreas Objekt überschneiden.
readonly conditionalFormats: Excel.ConditionalFormatCollection;
Eigenschaftswert
Hinweise
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 im RangeAreaszurück.
readonly dataValidation: Excel.DataValidation;
Eigenschaftswert
Hinweise
format
Gibt ein RangeFormat Objekt zurück und kapselt die Schriftart, Füllung, Rahmen, Ausrichtung und andere Eigenschaften für alle Bereiche des RangeAreas Objekts.
readonly format: Excel.RangeFormat;
Eigenschaftswert
Hinweise
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
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
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 Aufzählung darstellt.
style: string;
Eigenschaftswert
string
Hinweise
worksheet
Gibt das Arbeitsblatt für den aktuellen RangeAreaszurück.
readonly worksheet: Excel.Worksheet;
Eigenschaftswert
Hinweise
Details zur Methode
calculate()
Berechnet alle Zellen im RangeAreasFeld .
calculate(): void;
Gibt zurück
void
Hinweise
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 findest du hier Excel.ClearApplyTo . Der Standardwert ist "Alle".
Gibt zurück
void
Hinweise
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?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;
Parameter
- applyTo
-
"All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"
Optional. Bestimmt den Typ der Löschaktion. Weitere Informationen findest du hier Excel.ClearApplyTo . Der Standardwert ist "Alle".
Gibt zurück
void
Hinweise
clearOrResetContents()
Löscht die Werte der Zellen in den Bereichen, wobei Zellen, die Steuerelemente enthalten, besonders berücksichtigt werden. Wenn die Bereiche nur leere Werte enthalten und Steuerelemente auf ihren Standardwert festgelegt sind, 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 in den Bereichen werden gelöscht.
clearOrResetContents(): void;
Gibt zurück
void
Hinweise
convertDataTypeToText()
Wandelt alle Zellen des RangeAreas MIT-Datentyps in Text um.
convertDataTypeToText(): void;
Gibt zurück
void
Hinweise
convertToLinkedDataType(serviceID, languageCulture)
Konvertiert alle Zellen in diesem 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 abgefragt werden soll.
Gibt zurück
void
Hinweise
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 enthält, muss deren Form erstellt werden können, indem vollständige Zeilen oder Spalten aus einem rechteckigen Bereich entfernt werden.
- copyType
- Excel.RangeCopyType
Der Typ der Zelldaten oder Formatierungen, die kopiert werden sollen. Der Standardwert ist "Alle".
- skipBlanks
-
boolean
WAHR, wenn leere Zellen im Quellbereich übersprungen werden sollen, oder RangeAreas. Der Standardwert ist „false“.
- transpose
-
boolean
Wahr, wenn die Zellen im Ziel RangeAreastransponiert werden sollen. Der Standardwert ist „false“.
Gibt zurück
void
Hinweise
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?: "All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths", 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 enthält, muss deren Form erstellt werden können, indem vollständige Zeilen oder Spalten aus einem rechteckigen Bereich entfernt werden.
- copyType
-
"All" | "Formulas" | "Values" | "Formats" | "Link" | "ColumnWidths"
Der Typ der Zelldaten oder Formatierungen, die kopiert werden sollen. Der Standardwert ist "Alle".
- skipBlanks
-
boolean
WAHR, wenn leere Zellen im Quellbereich übersprungen werden sollen, oder RangeAreas. Der Standardwert ist „false“.
- transpose
-
boolean
Wahr, wenn die Zellen im Ziel RangeAreastransponiert werden sollen. Der Standardwert ist „false“.
Gibt zurück
void
Hinweise
getEntireColumn()
Gibt ein RangeAreas Objekt zurück, das die gesamten Spalten des RangeAreas darstellt (wenn der aktuelle RangeAreas Wert beispielsweise die Zellen "B4:E11, H2" darstellt, wird "a RangeAreas " zurückgegeben, das die Spalten "B:E, H:H" darstellt).
getEntireColumn(): Excel.RangeAreas;
Gibt zurück
Hinweise
getEntireRow()
Gibt ein RangeAreas Objekt zurück, das die gesamten Zeilen des RangeAreas darstellt (wenn der aktuelle RangeAreas Wert beispielsweise die Zellen "B4:E11" darstellt, gibt er einen Wert RangeAreas zurück, der die Zeilen "4:11" darstellt).
getEntireRow(): Excel.RangeAreas;
Gibt zurück
Hinweise
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 Bereich, RangeAreas das Objekt oder die Bereichsadresse, die zum Bestimmen der Schnittmenge verwendet wird.
Gibt zurück
Hinweise
getIntersectionOrNullObject(anotherRange)
Gibt das RangeAreas Objekt zurück, das die Schnittmenge der angegebenen Bereiche darstellt, oder RangeAreas. 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 | RangeAreas | string): Excel.RangeAreas;
Parameter
- anotherRange
-
Excel.Range | Excel.RangeAreas | string
Der Bereich, RangeAreas das Objekt oder die Adresse, die zum Bestimmen der Schnittmenge verwendet wird.
Gibt zurück
Hinweise
getOffsetRangeAreas(rowOffset, columnOffset)
Gibt ein RangeAreas Objekt zurück, das um den spezifischen Zeilen- und Spaltenoffset verschoben wird. Die Dimension des zurückgegebenen RangeAreas Objekts entspricht dem ursprünglichen Objekt. Wenn das 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 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 der versetzt RangeAreas werden soll. Bei positiven Werten erfolgt der Versatz nach rechts, bei negativen Werten nach links.
Gibt zurück
Hinweise
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 einzubeziehende Zelltyp.
- cellValueType
- Excel.SpecialCellValueType
Wenn cellType ist entweder constants oder formulas, wird 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
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: "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
- cellType
-
"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas"
Der einzubeziehende Zelltyp.
- cellValueType
-
"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"
Wenn cellType ist entweder constants oder formulas, wird 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
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 festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
Parameter
- cellType
- Excel.SpecialCellType
Der einzubeziehende Zelltyp.
- cellValueType
- Excel.SpecialCellValueType
Wenn cellType ist entweder constants oder formulas, wird 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
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 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
- cellType
-
"ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible" | "DirtyFormulas"
Der einzubeziehende Zelltyp.
- cellValueType
-
"All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"
Wenn cellType ist entweder constants oder formulas, wird 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
getTables(fullyContained)
Gibt eine bereichsbezogene Auflistung von Tabellen zurück, die sich mit einem beliebigen Bereich in diesem RangeAreas Objekt überschneiden.
getTables(fullyContained?: boolean): Excel.TableScopedCollection;
Parameter
- fullyContained
-
boolean
If truegibt nur Tabellen zurück, die vollständig innerhalb der Bereichsgrenzen enthalten sind. Der Standardwert ist false.
Gibt zurück
Hinweise
getUsedRangeAreas(valuesOnly)
Gibt das verwendete RangeAreas zurück, das alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas Objekt umfasst. Wenn keine verwendeten Zellen im RangeAreasvorhanden sind, wird der ItemNotFound Fehler ausgelöst.
getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;
Parameter
- valuesOnly
-
boolean
Gibt an, ob Zellen mit Werten nur als verwendete Zellen berücksichtigt werden sollen. Der Standardwert ist false.
Gibt zurück
Hinweise
getUsedRangeAreasOrNullObject(valuesOnly)
Gibt das verwendete RangeAreas zurück, das alle verwendeten Bereiche einzelner rechteckiger Bereiche im RangeAreas Objekt umfasst. Wenn keine verwendeten Zellen in vorhanden RangeAreassind, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getUsedRangeAreasOrNullObject(valuesOnly?: boolean): Excel.RangeAreas;
Parameter
- valuesOnly
-
boolean
Gibt an, ob Zellen mit Werten nur als verwendete Zellen berücksichtigt werden sollen.
Gibt zurück
Hinweise
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
select()
Wählt die angegebenen Bereichsbereiche in der Excel-Benutzeroberfläche aus.
select(): void;
Gibt zurück
void
Hinweise
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 properties-Objekt 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 den Wert fest, der RangeAreas bei der nächsten Neuberechnung neu berechnet werden soll.
setDirty(): void;
Gibt zurück
void
Hinweise
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 sie übergeben wird.) Während das ursprüngliche Excel.RangeAreas Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.RangeAreasData) zurück, das 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 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.RangeAreas;
Gibt zurück
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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Excel.RangeAreas;