Excel.Worksheet class

Stellt das AutoFilter Objekt des Arbeitsblatts dar.

readonly autoFilter: Excel.AutoFilter;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9]

Gibt eine Sammlung von Diagrammen zurück, die Teil des Arbeitsblatts sind.

readonly charts: Excel.ChartCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.1]

Gibt eine Sammlung aller Kommentarobjekte auf dem Arbeitsblatt zurück.

readonly comments: Excel.CommentCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.10]

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

context: RequestContext;

Eigenschaftswert

Ruft eine Auflistung benutzerdefinierter Eigenschaften auf Arbeitsblattebene ab.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.12]

Bestimmt, ob Excel das Arbeitsblatt bei Bedarf neu berechnen soll. "Wahr", wenn Excel das Arbeitsblatt bei Bedarf neu berechnet. False, falls Excel das Arbeitsblatt nicht neu berechnet.

enableCalculation: boolean;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9]

Ruft ein Objekt ab, mit dem fixierte Bereiche im Arbeitsblatt bearbeitet werden können.

readonly freezePanes: Excel.WorksheetFreezePanes;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.7]

Ruft die Sammlung der horizontalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.

readonly horizontalPageBreaks: Excel.PageBreakCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9]

Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn das Arbeitsblatt umbenannt oder verschoben wird.

readonly id: string;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.1]

Der Anzeigename des Arbeitsblatts. Der Name muss weniger als 32 Zeichen enthalten.

name: string;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.1]

Auflistung von Namen im Bereich des aktuellen Arbeitsblatts.

readonly names: Excel.NamedItemCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.4]

Gibt eine Auflistung aller Notizenobjekte im Arbeitsblatt zurück.

readonly notes: Excel.NoteCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.18]

Ruft das PageLayout Objekt des Arbeitsblatts ab.

readonly pageLayout: Excel.PageLayout;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9]

Die Sammlung von PivotTables, die Teil des Arbeitsblatts sind.

readonly pivotTables: Excel.PivotTableCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.3]

Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.

position: number;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.1]

Gibt das Blattschutzobjekt für ein Arbeitsblatt zurück.

readonly protection: Excel.WorksheetProtection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.2]

Gibt die Sammlung aller Formobjekte auf dem Arbeitsblatt zurück.

readonly shapes: Excel.ShapeCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9]

Gibt an, ob auf dem Arbeitsblatt Datentypsymbole sichtbar sind. Standardmäßig sind die Symbole für Datentypen sichtbar.

showDataTypeIcons: boolean;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.19]

Gibt an, ob Gitternetzlinien für den Benutzer sichtbar sind.

showGridlines: boolean;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.8]

Gibt an, ob Überschriften für den Benutzer sichtbar sind.

showHeadings: boolean;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.8]

Gibt eine Auflistung von Datenschnitten zurück, die Teil des Arbeitsblatts sind.

readonly slicers: Excel.SlicerCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.10]

Gibt die Standardhöhe (Standard) aller Zeilen in der Arbeitsmappe in Punkt zurück.

readonly standardHeight: number;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.7]

Gibt die Standardbreite (Standardbreite) für alle Spalten im Arbeitsblatt an. Eine Einheit der Spaltenbreite entspricht der Breite eines Zeichens im Format Normal. Für proportionale Schriftarten wird die Breite des Zeichens 0 (Null) verwendet.

standardWidth: number;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.7]

Die Registerfarbe des Arbeitsblatts. Wenn das Arbeitsblatt beim Abrufen der Registerfarbe unsichtbar ist, lautet nullder Wert . Wenn das Arbeitsblatt sichtbar ist, die Registerfarbe jedoch auf automatisch festgelegt ist, wird eine leere Zeichenfolge zurückgegeben. Andernfalls wird die Eigenschaft auf eine Farbe in der Form #RRGGBB festgelegt (z. B. "FFA500"). Verwenden Sie beim Festlegen der Farbe eine leere Zeichenkette, um eine "automatische" Farbe einzustellen, oder andernfalls eine echte Farbe.

tabColor: string;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.7]

Gibt einen Wert zurück, der dieses Arbeitsblatt darstellt und von Open Office XML gelesen werden kann. Dies ist ein ganzzahliger Wert, der sich von worksheet.id (der einen global eindeutigen Bezeichner zurückgibt) und worksheet.name (der einen Wert wie "Sheet1" zurückgibt) unterscheidet.

readonly tabId: number;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.14]

Gibt die Sammlung von Tabellen zurück, die Teil des Arbeitsblatts sind.

readonly tables: Excel.TableCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.1]

Ruft die Sammlung der vertikalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.

readonly verticalPageBreaks: Excel.PageBreakCollection;

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.9]

Die Sichtbarkeit des Arbeitsblatts.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Eigenschaftswert

Hinweise

[API-Satz: ExcelApi 1.1 für die Lesesichtbarkeit; 1.2 zum Festlegen.]

Aktivieren Sie das Arbeitsblatt in der Excel-Benutzeroberfläche.

activate(): void;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

Berechnet alle Zellen auf einem Arbeitsblatt.

calculate(markAllDirty: boolean): void;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.6]

Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parameter

Gibt zurück

Das neu erstellte Arbeitsblatt.

Hinweise

[API-Satz: ExcelApi 1.7]

Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.

copy(positionType?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parameter

Gibt zurück

Das neu erstellte Arbeitsblatt.

Hinweise

[API-Satz: ExcelApi 1.7]

Löscht das Arbeitsblatt aus der Arbeitsmappe. Beachten Sie, dass der Löschvorgang mit einer InvalidOperation Ausnahme fehlschlägt, wenn die Sichtbarkeit des Arbeitsblatts auf "VeryHidden" festgelegt ist. Sie sollten die Sichtbarkeit zuerst in "Ausgeblendet" oder "Sichtbar" ändern, bevor Sie sie löschen.

delete(): void;

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

Sucht alle Vorkommen der angegebenen Zeichenfolge anhand der angegebenen Kriterien und gibt sie als RangeAreas Objekt zurück, das aus einem oder mehreren rechteckigen Bereichen besteht. Inhalte in ausgeblendeten Arbeitsblättern werden nicht zurückgegeben.

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parameter

Gibt zurück

Ein RangeAreas Objekt, das aus einem oder mehreren rechteckigen Bereichen besteht, das den Suchkriterien entspricht. Wenn keine der Zellen diese Kriterien erfüllen, wird ein ItemNotFound Fehler ausgelöst.

Hinweise

[API-Satz: ExcelApi 1.9]

Sucht alle Vorkommen der angegebenen Zeichenfolge anhand der angegebenen Kriterien und gibt sie als RangeAreas Objekt zurück, das aus einem oder mehreren rechteckigen Bereichen besteht. Inhalte in ausgeblendeten Arbeitsblättern werden nicht zurückgegeben.

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parameter

Gibt zurück

Ein RangeAreas Objekt, das aus einem oder mehreren rechteckigen Bereichen besteht, das den Suchkriterien entspricht. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

Hinweise

[API-Satz: ExcelApi 1.9]

Ruft das Range Objekt ab, das die einzelne Zelle enthält, basierend auf Zeilen- und Spaltennummern. Die Zelle kann sich außerhalb der Grenzen des übergeordneten Bereichs befinden, solange sie innerhalb des Arbeitsblattrasters bleibt.

getCell(row: number, column: number): Excel.Range;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

Ruft das folgende Arbeitsblatt ab. Wenn keine Arbeitsblätter nach dieser Methode vorhanden sind, wird bei dieser Methode ein Fehler angezeigt.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.5]

Ruft das folgende Arbeitsblatt ab. Wenn keine Arbeitsblätter nach diesem Diagramm vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.5]

Ruft das Arbeitsblatt ab, das diesem vorhergeht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, gibt diese Methode einen Fehler aus.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.5]

Ruft das Arbeitsblatt ab, das diesem vorhergeht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.5]

Ruft das Range Objekt ab, das einen einzelnen rechteckigen Block von Zellen darstellt, der durch die Adresse oder den Namen angegeben wird.

getRange(address?: string): Excel.Range;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

Ruft das Range Objekt ab einem bestimmten Zeilen- und Spaltenindex ab und erstreckt sich über eine bestimmte Anzahl von Zeilen und Spalten.

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.7]

Ruft das RangeAreas Objekt ab, das einen oder mehrere Blöcke rechteckiger Bereiche darstellt, die durch die Adresse oder den Namen angegeben werden.

getRanges(address?: string): Excel.RangeAreas;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.9]

Der verwendete Bereich ist der kleinste Bereich, der mindestens eine der Zellen umfasst, die einen Wert enthalten oder denen eine Formatierung zugewiesen wurde. Wenn das gesamte Arbeitsblatt leer ist, gibt diese Funktion die obere linke Zelle zurück (d. h. es wird kein Fehler ausgegeben).

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1]

Der verwendete Bereich ist der kleinste Bereich, der mindestens eine der Zellen umfasst, die einen Wert enthalten oder denen eine Formatierung zugewiesen wurde. Wenn das gesamte Arbeitsblatt leer ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.4]

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.WorksheetLoadOptions): Excel.Worksheet;

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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

Parameter

Gibt zurück

Sucht und ersetzt die angegebene Zeichenfolge auf der Grundlage der auf dem aktuellen Arbeitsblatt angegebenen Kriterien.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parameter

Gibt zurück

Die Anzahl der durchgeführten Ersetzungen.

Hinweise

[API-Satz: ExcelApi 1.9]

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.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

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

set(properties: Excel.Worksheet): void;

Parameter

Gibt zurück

Zeigt Zeilen- oder Spaltengruppen nach ihren Gliederungsebenen an. Gliedert gruppiert und fasst eine Liste von Daten im Arbeitsblatt zusammen. Die rowLevels Parameter and columnLevels geben an, wie viele Ebenen der Gliederung angezeigt werden. Der zulässige Argumentbereich liegt zwischen 0 und 8. Ein Wert von 0 ändert die aktuelle Anzeige nicht. Ein Wert, der größer als die aktuelle Anzahl von Ebenen ist, zeigt alle Ebenen an.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Parameter

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.10]

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

toJSON(): Excel.Interfaces.WorksheetData;

Gibt zurück

Tritt auf, wenn das Arbeitsblatt aktiviert wird.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.7]

Tritt beim Berechnen des Arbeitsblatts auf.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.8]

Tritt auf, wenn sich Daten in einem bestimmten Arbeitsblatt ändern.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.7]

Tritt auf, wenn eine oder mehrere Spalten sortiert wurden. Dies geschieht als Ergebnis eines Sortiervorgangs von links nach rechts.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.10]

Tritt auf, wenn das Arbeitsblatt deaktiviert ist.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.7]

Tritt ein, wenn das Format für ein bestimmtes Arbeitsblatt geändert wird.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.9]

Tritt auf, wenn eine oder mehrere Formeln in diesem Arbeitsblatt geändert werden. Dieses Ereignis bezieht sich auf die Änderung der Formel selbst, nicht auf den Datenwert, der sich aus der Berechnung der Formel ergibt.

Das Ereignis wird nur ausgelöst, wenn die Zelle bereits eine Formel enthält. Der neue Zellwert enthält möglicherweise keine Formel. Dieses Ereignis wird nicht ausgelöst, wenn eine Formel in eine Zelle eingegeben wird, die zuvor keine Formel enthielt.

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.13]

Tritt auf, wenn der Arbeitsblattname geändert wird.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.17]

Tritt auf, wenn der Schutzstatus des Arbeitsblatts geändert wird.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.14]

Tritt auf, wenn sich der ausgeblendete Status einer oder mehrerer Zeilen auf einem bestimmten Arbeitsblatt geändert hat.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.11]

Tritt auf, wenn eine oder mehrere Zeilen sortiert wurden. Dies geschieht, wenn Zeilen von oben nach unten sortiert werden.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.10]

Tritt auf, wenn sich die Markierung auf einem bestimmten Arbeitsblatt ändert.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.7]

Tritt auf, wenn eine mit der linken Maustaste geklickte/angetippte Aktion auf dem Arbeitsblatt ausgeführt wird. Dieses Ereignis wird beim Klicken in den folgenden Fällen nicht ausgelöst:

• Der Benutzer zieht die Maus, um die Mehrfachauswahl zu ermöglichen.

• Der Benutzer wählt eine Zelle in dem Modus aus, in dem Zellargumente für Formelbezüge ausgewählt sind.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.10]

Tritt auf, wenn die Sichtbarkeit des Arbeitsblatts geändert wird.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Ereignistyp

Hinweise

[API-Satz: ExcelApi 1.17]