ExcelScript.RangeAreas interface

Referenz

Paket:: ExcelScript

RangeAreas stellt eine Auflistung von einem oder mehreren rechteckigen Bereichen im selben Arbeitsblatt dar.

Hinweise

Beispiele

/**
 * This script clears all the cells in the current worksheet that are displaying errors.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula error.
  const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);

  // If there are any error cells, clear them.
  if (errorCells) {
    errorCells.clear();
  }
}

Methoden

addConditionalFormat(type)	Fügt der Auflistung ein neues bedingtes Format mit der ersten/obersten Priorität hinzu.
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.
clearAllConditionalFormats()	Löscht alle bedingten Formate, die im aktuellen angegebenen Bereich aktiv sind.
convertDataTypeToText()	Konvertiert alle Zellen im mit Datentypen in `RangeAreas` Text.
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.
getAddress()	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").
getAddressLocal()	Gibt den `RangeAreas` Verweis im Gebietsschema des Benutzers zurück.
getAreaCount()	Gibt die Anzahl der rechteckigen Bereiche zurück, aus denen dieses `RangeAreas` Objekt besteht.
getAreas()	Gibt eine Auflistung rechteckiger Bereiche zurück, aus denen dieses `RangeAreas` Objekt besteht.
getCellCount()	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.
getConditionalFormat(id)	Gibt ein bedingtes Format zurück, das durch seine ID identifiziert wird. Wenn das bedingte Formatobjekt nicht vorhanden ist, gibt diese Methode zurück `undefined`.
getConditionalFormats()	Gibt eine Auflistung bedingter Formate zurück, die sich mit zellen in diesem `RangeAreas` Objekt überschneiden.
getDataValidation()	Gibt ein Datenüberprüfungsobjekt für alle Bereiche im zurück `RangeAreas`.
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).
getFormat()	Gibt ein `RangeFormat` -Objekt zurück, das die Schriftart, Füllung, Rahmen, Ausrichtung und andere Eigenschaften für alle Bereiche im `RangeAreas` Objekt kapselt.
getIntersection(anotherRange)	Gibt das `RangeAreas` -Objekt zurück, das die Schnittmenge der angegebenen Bereiche oder `RangeAreas`darstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode zurück `undefined`.
getIsEntireColumn()	Gibt an, ob alle Bereiche in diesem `RangeAreas` Objekt ganze Spalten darstellen (z. B. "A:C, Q:Z").
getIsEntireRow()	Gibt an, ob alle Bereiche in diesem `RangeAreas` Objekt ganze Zeilen darstellen (z. B. "1:3, 5:7").
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.
getPredefinedCellStyle()	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.
getSpecialCells(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 zurück `undefined`.
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 `RangeAreas`vorhanden sind, gibt diese Methode zurück `undefined`.
getWorksheet()	Gibt das Arbeitsblatt für die aktuelle `RangeAreas`zurück.
setDirty()	Legt fest, dass bei `RangeAreas` der nächsten Neuberechnung neu berechnet wird.
setPredefinedCellStyle(predefinedCellStyle)	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.

Details zur Methode

addConditionalFormat(type)

Fügt der Auflistung ein neues bedingtes Format mit der ersten/obersten Priorität hinzu.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Parameter

type: ExcelScript.ConditionalFormatType

Der Typ des bedingten Formats, das hinzugefügt wird. Weitere Informationen finden Sie unter ExcelScript.ConditionalFormatType .

Gibt zurück

ExcelScript.ConditionalFormat

calculate()

Berechnet alle Zellen im RangeAreas.

calculate(): void;

Gibt zurück

void

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?: ClearApplyTo): void;

Parameter

applyTo: ExcelScript.ClearApplyTo

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

Gibt zurück

void

Beispiele

/**
 * This script clears all the cells in the current worksheet that are displaying errors.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula error.
  const errorCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas, ExcelScript.SpecialCellValueType.errors);

  // If there are any error cells, clear them.
  if (errorCells) {
    errorCells.clear();
  }
}

clearAllConditionalFormats()

Löscht alle bedingten Formate, die im aktuellen angegebenen Bereich aktiv sind.

clearAllConditionalFormats(): void;

Gibt zurück

void

convertDataTypeToText()

Konvertiert alle Zellen im mit Datentypen in RangeAreas Text.

convertDataTypeToText(): void;

Gibt zurück

void

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?: RangeCopyType,
            skipBlanks?: boolean,
            transpose?: boolean
        ): void;

Parameter

sourceRange: ExcelScript.Range | ExcelScript.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: ExcelScript.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

getAddress()

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

getAddress(): string;

Gibt zurück

string

getAddressLocal()

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

getAddressLocal(): string;

Gibt zurück

string

getAreaCount()

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

getAreaCount(): number;

Gibt zurück

number

getAreas()

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

getAreas(): Range[];

Gibt zurück

ExcelScript.Range[]

getCellCount()

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.

getCellCount(): number;

Gibt zurück

number

getConditionalFormat(id)

Gibt ein bedingtes Format zurück, das durch seine ID identifiziert wird. Wenn das bedingte Formatobjekt nicht vorhanden ist, gibt diese Methode zurück undefined.

getConditionalFormat(id: string): ConditionalFormat | undefined;

Parameter

id: string

Die ID des bedingten Formats.

Gibt zurück

ExcelScript.ConditionalFormat | undefined

getConditionalFormats()

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

getConditionalFormats(): ConditionalFormat[];

Gibt zurück

ExcelScript.ConditionalFormat[]

getDataValidation()

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

getDataValidation(): DataValidation;

Gibt zurück

ExcelScript.DataValidation

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(): RangeAreas;

Gibt zurück

ExcelScript.RangeAreas

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(): RangeAreas;

Gibt zurück

ExcelScript.RangeAreas

getFormat()

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

getFormat(): RangeFormat;

Gibt zurück

ExcelScript.RangeFormat

Beispiele

/**
 * This script finds and highlights all the cells in the current worksheet that contain a formula.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range on the current sheet.
  const currentSheet = workbook.getActiveWorksheet();
  const usedRange = currentSheet.getUsedRange();

  // Get the RangeAreas object for each cell with a formula.
  const formulaCells = usedRange.getSpecialCells(ExcelScript.SpecialCellType.formulas);

  // Add a light blue background to the cells containing formulas.
  formulaCells.getFormat().getFill().setColor("#ADD8E6");
}

getIntersection(anotherRange)

Gibt das RangeAreas -Objekt zurück, das die Schnittmenge der angegebenen Bereiche oder RangeAreasdarstellt. Wenn keine Schnittmenge gefunden wird, gibt diese Methode zurück undefined.

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

Parameter

anotherRange: ExcelScript.Range | ExcelScript.RangeAreas | string

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

Gibt zurück

ExcelScript.RangeAreas

getIsEntireColumn()

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

getIsEntireColumn(): boolean;

Gibt zurück

boolean

getIsEntireRow()

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

getIsEntireRow(): boolean;

Gibt zurück

boolean

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
        ): 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

ExcelScript.RangeAreas

getPredefinedCellStyle()

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.

getPredefinedCellStyle(): string;

Gibt zurück

string

getSpecialCells(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 zurück undefined.

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

Parameter

cellType: ExcelScript.SpecialCellType

Der Typ der einzuschließenden Zellen.

cellValueType: ExcelScript.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

ExcelScript.RangeAreas

getTables(fullyContained)

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

getTables(fullyContained?: boolean): Table[];

Parameter

fullyContained: boolean

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

Gibt zurück

ExcelScript.Table[]

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, gibt diese Methode zurück undefined.

getUsedRangeAreas(valuesOnly?: boolean): RangeAreas;

Parameter

valuesOnly: boolean

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

Gibt zurück

ExcelScript.RangeAreas

getWorksheet()

Gibt das Arbeitsblatt für die aktuelle RangeAreaszurück.

getWorksheet(): Worksheet;

Gibt zurück

ExcelScript.Worksheet

setDirty()

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

setDirty(): void;

Gibt zurück

void

setPredefinedCellStyle(predefinedCellStyle)

setPredefinedCellStyle(predefinedCellStyle: string): void;

Parameter

predefinedCellStyle: string

Gibt zurück

void

Beispiele

/**
 * This script sets the cell style to "warning text"
 * on every cell with a formula error.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the used range in the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const usedRange = sheet.getUsedRange();

  // Get any cells that are displaying errors.
  const errorCells = usedRange.getSpecialCells(
    ExcelScript.SpecialCellType.formulas,
    ExcelScript.SpecialCellValueType.errors
  );

  // Check if there are error cells before proceeding.
  if (errorCells) {
    // Use the built-in warning text style on the error cells.
    errorCells.setPredefinedCellStyle(
      ExcelScript.BuiltInStyle.warningText.toString()
    );
  } else {
    console.log("No formula errors in the worksheet.");
  }
}

Freigeben über

ExcelScript.RangeAreas interface

Hinweise

Beispiele

Methoden

Details zur Methode

addConditionalFormat(type)

Parameter

Gibt zurück

calculate()

Gibt zurück

clear(applyTo)

Parameter

Gibt zurück

Beispiele

clearAllConditionalFormats()

Gibt zurück

convertDataTypeToText()

Gibt zurück

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Parameter

Gibt zurück

getAddress()

Gibt zurück

getAddressLocal()

Gibt zurück

getAreaCount()

Gibt zurück

getAreas()

Gibt zurück

getCellCount()

Gibt zurück

getConditionalFormat(id)

Parameter

Gibt zurück

getConditionalFormats()

Gibt zurück

getDataValidation()

Gibt zurück

getEntireColumn()

Gibt zurück

getEntireRow()

Gibt zurück

getFormat()

Gibt zurück

Beispiele

getIntersection(anotherRange)

Parameter

Gibt zurück

getIsEntireColumn()

Gibt zurück

getIsEntireRow()

Gibt zurück

getOffsetRangeAreas(rowOffset, columnOffset)

Parameter

Gibt zurück

getPredefinedCellStyle()

Gibt zurück

getSpecialCells(cellType, cellValueType)

Parameter

Gibt zurück

getTables(fullyContained)

Parameter

Gibt zurück

getUsedRangeAreas(valuesOnly)

Parameter

Gibt zurück

getWorksheet()

Gibt zurück

setDirty()

Gibt zurück

setPredefinedCellStyle(predefinedCellStyle)

Parameter

Gibt zurück

Beispiele

Zusätzliche Ressourcen