Worksheet Klasse

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Paket:

DocumentFormat.OpenXml v3.0.1

Arbeitsblatt.

Diese Klasse ist in Office 2007 und höher verfügbar.

Wenn das Objekt als XML serialisiert wird, lautet der qualifizierte Name x:worksheet.

public class Worksheet : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Worksheet = class
    inherit OpenXmlPartRootElement

Public Class Worksheet
Inherits OpenXmlPartRootElement

Vererbung

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Worksheet

Beispiele

Im folgenden Codebeispiel wird ein neues Arbeitsblatt unter Angabe des Dateinamens in ein Tabellenkalkulationsdokument eingefügt. Nachdem Sie das Codebeispiel ausgeführt haben, untersuchen Sie die Testdatei "WorksheetEx.xlsx", und beachten Sie das neue Arbeitsblatt mit dem Namen "mySheet".

using System;  
using System.Linq;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Spreadsheet;  

namespace WorkSheetEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\Users\Public\Documents\WorksheetEx.xlsx";  

            using (SpreadsheetDocument spreadSheet = SpreadsheetDocument.Open(fileName, true))  
            {  
                // Add a WorksheetPart.  
                WorksheetPart newWorksheetPart = spreadSheet.WorkbookPart.AddNewPart<WorksheetPart>();  
                newWorksheetPart.Worksheet = new Worksheet(new SheetData());  

                // Create Sheets object.  
                Sheets sheets = spreadSheet.WorkbookPart.Workbook.GetFirstChild<Sheets>();  
                string relationshipId = spreadSheet.WorkbookPart.GetIdOfPart(newWorksheetPart);  

                // Create a unique ID for the new worksheet.  
                uint sheetId = 1;  
                if (sheets.Elements<Sheet>().Count() > 0)  
                {  
                    sheetId = sheets.Elements<Sheet>().Select(s => s.SheetId.Value).Max() + 1;  
                }  

                // Give the new worksheet a name.  
                string sheetName = "mySheet" + sheetId;  

                // Append the new worksheet and associate it with the workbook.  
                Sheet sheet = new Sheet() { Id = relationshipId, SheetId = sheetId, Name = sheetName };  
                sheets.Append(sheet);  
            }  
            Console.WriteLine("All done.");  
            Console.ReadKey();  
        }  
    }  
}  

Imports System.Linq  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  
Module Module1  
    Sub Main()  
        Dim fileName As String = "C:\Users\Public\Documents\WorksheetEx.xlsx"  
        Dim spreadSheet As SpreadsheetDocument = SpreadsheetDocument.Open(fileName, True)  

        Using (spreadSheet)  
            ' Add a WorksheetPart.  
            Dim newWorksheetPart As WorksheetPart = spreadSheet.WorkbookPart.AddNewPart(Of WorksheetPart)()  
            newWorksheetPart.Worksheet = New Worksheet(New SheetData())  

            ' Create a Sheets object.  
            Dim sheets As Sheets = spreadSheet.WorkbookPart.Workbook.GetFirstChild(Of Sheets)()  
            Dim relationshipId As String = spreadSheet.WorkbookPart.GetIdOfPart(newWorksheetPart)  

            ' Get a unique ID for the new worksheet.  
            Dim sheetId As UInteger = 1  
            If (sheets.Elements(Of Sheet).Count > 0) Then  
                sheetId = sheets.Elements(Of Sheet).Select(Function(s) s.SheetId.Value).Max + 1  
            End If  

            ' Give the new worksheet a name.  
            Dim sheetName As String = ("mySheet" + sheetId.ToString())  

            ' Append the new worksheet and associate it with the workbook.  
            Dim sheet As Sheet = New Sheet  
            sheet.Id = relationshipId  
            sheet.SheetId = sheetId  
            sheet.Name = sheetName  
            sheets.Append(sheet)  
        End Using  
        Console.WriteLine("All done.")  
        Console.ReadKey()  
    End Sub  
End Module  

Hinweise

[ISO/IEC 29500-1 1. Auflage]

Arbeitsblatt (Arbeitsblatt)

Dies ist das Stammelement von Arbeitsblattteilen in einem SpreadsheetML-Dokument.

Übergeordnete Elemente
Stammelement des SpreadsheetML-Arbeitsblattteils

Untergeordnete Elemente	Subclause
autoFilter (AutoFilter-Einstellungen)	§18.3.1.2
cellWatches (Zellenüberwachungselemente)	§18.3.1.9
colBreaks (Vertikale Seitenumbrüche)	§18.3.1.14
cols (Spalteninformationen)	§18.3.1.17
conditionalFormatting (Bedingte Formatierung)	§18.3.1.18
-Steuerelemente (eingebettete Steuerelemente)	§18.3.1.21
customProperties (benutzerdefinierte Eigenschaften)	§18.3.1.23
customSheetViews (benutzerdefinierte Blattansichten)	§18.3.1.27
dataConsolidate (Datenkonsolidieren)	§18.3.1.29
dataValidations (Datenüberprüfungen)	§18.3.1.33
Dimension (Arbeitsblattdimensionen)	§18.3.1.35
Zeichnung (Zeichnung)	§18.3.1.36
drawingHF (Zeichnungsverweis in Kopfzeilenfuß)	§18.3.1.37
extLst (Future Feature Data Storage Area)	§18.2.10
headerFooter (Einstellungen für Kopfzeilenfuß)	§18.3.1.46
Hyperlinks (Links)	§18.3.1.48
ignoredErrors (Ignorierte Fehler)	§18.3.1.51
mergeCells (Zellen zusammenführen)	§18.3.1.55
oleObjects (Eingebettete Objekte)	§18.3.1.60
pageMargins (Seitenränder)	§18.3.1.62
pageSetup (Einstellungen für Die Einrichtung der Seite)	§18.3.1.63
phoneticPr (Phonetische Eigenschaften)	§18.4.3
Bild (Hintergrundbild)	§18.3.1.67
printOptions (Druckoptionen)	§18.3.1.70
protectedRanges (Geschützte Bereiche)	§18.3.1.72
rowBreaks (Horizontale Seitenumbrüche (Zeile))	§18.3.1.74
Szenarien (Szenarien)	§18.3.1.76
sheetCalcPr (Blattberechnungseigenschaften)	§18.3.1.79
sheetData (Blattdaten)	§18.3.1.80
sheetFormatPr (Blattformateigenschaften)	§18.3.1.81
sheetPr (Blatteigenschaften)	§18.3.1.82
sheetProtection (Blattschutzoptionen)	§18.3.1.85
sheetViews (Blattansichten)	§18.3.1.88
smartTags (Smarttags)	§18.3.1.90
sortState (Sort state)	§18.3.1.92
tableParts (Tabellenteile)	§18.3.1.95
webPublishItems (Web publishing items)	§18.3.1.98

[Hinweis: Die W3C-XML-Schemadefinition des Inhaltsmodells (CT_Worksheet) dieses Elements befindet sich in §A.2. Ende des Hinweises]

ISO/IEC29500: 2008.

Konstruktoren

Worksheet()	Initialisiert einen neuen instance der Worksheet-Klasse.
Worksheet(IEnumerable<OpenXmlElement>)	Initialisiert einen neuen instance der Worksheet-Klasse mit den angegebenen untergeordneten Elementen.
Worksheet(OpenXmlElement[])	Initialisiert einen neuen instance der Worksheet-Klasse mit den angegebenen untergeordneten Elementen.
Worksheet(String)	Initialisiert eine neue instance der Worksheet-Klasse aus äußerem XML.

Eigenschaften

ChildElements	Ruft alle untergeordneten Knoten des aktuellen Elements ab. (Geerbt von OpenXmlElement)
ExtendedAttributes	Ruft alle erweiterten Attribute (Attribute, die im Schema nicht definiert sind) des aktuellen Elements ab. (Geerbt von OpenXmlElement)
Features	Ruft ein IFeatureCollection für das aktuelle Element ab. Diese Featuresammlung ist schreibgeschützt, erbt jedoch Features von ihrem übergeordneten Teil und Paket, falls verfügbar. (Geerbt von OpenXmlElement)
FirstChild	Ruft das erste untergeordnete Element des aktuellen OpenXmlElement-Elements ab. (Geerbt von OpenXmlCompositeElement)
HasAttributes	Ruft einen Wert ab, der angibt, ob das aktuelle Element über Attribute verfügt. (Geerbt von OpenXmlElement)
HasChildren	Ruft einen Wert ab, der angibt, ob das aktuelle Element über untergeordnete Elemente verfügt. (Geerbt von OpenXmlCompositeElement)
InnerText	Ruft die verketteten Werte des aktuellen Knotens und aller untergeordneten Elemente ab oder legt diese fest. (Geerbt von OpenXmlCompositeElement)
InnerXml	Ruft das Markup ab, das nur die untergeordneten Knoten des aktuellen Knotens darstellt, oder legt dieses fest. (Geerbt von OpenXmlCompositeElement)
LastChild	Ruft das letzte untergeordnete Element des aktuellen OpenXmlElement-Elements ab. Gibt null (Nothing in Visual Basic) zurück, wenn kein solches OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlCompositeElement)
LocalName	Ruft den lokalen Namen des aktuellen Elements ab. (Geerbt von OpenXmlElement)
MCAttributes	Ruft die Markupkompatibilitätsattribute ab oder legt sie fest. Gibt NULL zurück, wenn für das aktuelle Element keine Markupkompatibilitätsattribute definiert sind. (Geerbt von OpenXmlElement)
NamespaceDeclarations	Ruft alle im aktuellen Element definierten Namespacedeklarationen ab. Gibt einen leeren Enumerator zurück, wenn keine Namespacedeklaration vorhanden ist. (Geerbt von OpenXmlElement)
NamespaceUri	Ruft den Namespace-URI des aktuellen Elements ab. (Geerbt von OpenXmlElement)
OpenXmlElementContext	Ruft den OpenXmlElementContext des aktuellen Elements ab. (Geerbt von OpenXmlElement)
OpenXmlPart	Ruft den Teil ab, der der DOM-Struktur zugeordnet ist. Er gibt NULL zurück, wenn die DOM-Struktur keinem Teil zugeordnet ist. (Geerbt von OpenXmlPartRootElement)
OuterXml	Ruft das Markup ab, das das aktuelle Element und alle untergeordneten Elemente darstellt. (Geerbt von OpenXmlElement)
Parent	Ruft das übergeordnete Element des aktuellen Elements ab. (Geerbt von OpenXmlElement)
Prefix	Ruft das Namespacepräfix des aktuellen Elements ab. (Geerbt von OpenXmlElement)
SheetDimension	SheetDimension. Stellt das folgende Elementtag im Schema dar: x:dimension.
SheetFormatProperties	SheetFormatProperties. Stellt das folgende Elementtag im Schema dar: x:sheetFormatPr.
SheetProperties	SheetProperties. Stellt das folgende Elementtag im Schema dar: x:sheetPr.
SheetViews	SheetViews. Stellt das folgende Elementtag im Schema dar: x:sheetViews.
WorksheetPart	Ruft das WorksheetPart ab, das diesem Element zugeordnet ist.
XmlQualifiedName	Ruft den qualifizierten Namen des aktuellen Elements ab. (Geerbt von OpenXmlElement)
XName	Ruft den qualifizierten Namen des aktuellen Elements ab. (Geerbt von OpenXmlElement)

Methoden

AddAnnotation(Object)	Fügt der Liste der Anmerkungen des aktuellen OpenXmlElement-Elements ein -Objekt hinzu. (Geerbt von OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Fügt dem Element das angegebene Element hinzu, wenn es sich um ein bekanntes untergeordnetes Element handelt. Dadurch wird das -Element an der richtigen Position gemäß dem Schema hinzugefügt. (Geerbt von OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Fügt dem aktuellen Knoten eine Namespacedeklaration hinzu. (Geerbt von OpenXmlElement)
Ancestors()	Listet alle Vorgängerelemente des aktuellen Elements auf. (Geerbt von OpenXmlElement)
Ancestors<T>()	Listet nur die Vorgänger des aktuellen Elements auf, die den angegebenen Typ aufweisen. (Geerbt von OpenXmlElement)
Annotation(Type)	Ruft das erste Anmerkungsobjekt des angegebenen Typs aus dem aktuellen OpenXmlElement-Element ab. (Geerbt von OpenXmlElement)
Annotation<T>()	Ruft das erste Anmerkungsobjekt des angegebenen Typs aus dem aktuellen OpenXmlElement-Element ab. (Geerbt von OpenXmlElement)
Annotations(Type)	Ruft eine Auflistung von Anmerkungen mit dem angegebenen Typ für das aktuelle OpenXmlElement-Element ab. (Geerbt von OpenXmlElement)
Annotations<T>()	Ruft eine Auflistung von Anmerkungen mit dem angegebenen Typ für das aktuelle OpenXmlElement-Element ab. (Geerbt von OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Fügt jedes Element aus einer Liste von Elementen an das Ende der Liste der untergeordneten Elemente des aktuellen Elements an. (Geerbt von OpenXmlElement)
Append(OpenXmlElement[])	Fügt jedes Element aus einem Array von Elementen an das Ende der Liste der untergeordneten Elemente des aktuellen Elements an. (Geerbt von OpenXmlElement)
AppendChild<T>(T)	Fügt das angegebene Element am Ende der Liste der untergeordneten Knoten des aktuellen Elements an. (Geerbt von OpenXmlCompositeElement)
ClearAllAttributes()	Löscht alle Attribute, einschließlich bekannter und erweiterter Attribute. (Geerbt von OpenXmlElement)
Clone()	Erstellt ein Duplikat des aktuellen Knotens. (Geerbt von OpenXmlElement)
CloneNode(Boolean)	Erstellt ein Duplikat dieses Knotens.
Descendants()	Listet alle Nachfolger des aktuellen Elements auf. (Geerbt von OpenXmlElement)
Descendants<T>()	Listet alle Nachfolger des aktuellen Elements vom Typ T auf. (Geerbt von OpenXmlElement)
Elements()	Listet alle untergeordneten Elemente des aktuellen Elements auf. (Geerbt von OpenXmlElement)
Elements<T>()	Listet nur die untergeordneten Elemente des aktuellen Elements auf, die den angegebenen Typ aufweisen. (Geerbt von OpenXmlElement)
ElementsAfter()	Listet alle gleichgeordneten Elemente auf, die dem aktuellen Element folgen und dasselbe übergeordnete Element wie das aktuelle Element haben. (Geerbt von OpenXmlElement)
ElementsBefore()	Listet alle gleichgeordneten Elemente auf, die dem aktuellen Element vorausgehen und dasselbe übergeordnete Element wie das aktuelle Element haben. (Geerbt von OpenXmlElement)
GetAttribute(String, String)	Ruft ein Open XML-Attribut mit dem angegebenen Tagnamen und Namespace-URI ab. (Geerbt von OpenXmlElement)
GetAttributes()	Ruft eine Liste ab, die eine Kopie aller Attribute enthält. (Geerbt von OpenXmlElement)
GetEnumerator()	Gibt einen Enumerator zurück, der die untergeordnete Auflistung durchläuft. (Geerbt von OpenXmlElement)
GetFirstChild<T>()	Sucht das erste untergeordnete Element im Typ T. (Geerbt von OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Fügt das angegebene Element unmittelbar nach dem angegebenen Verweiselement ein. (Geerbt von OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Fügt das angegebene Element unmittelbar nach dem aktuellen Element ein. (Geerbt von OpenXmlElement)
InsertAt<T>(T, Int32)	Fügt das angegebene Element am angegebenen Index der untergeordneten Elemente des aktuellen Elements ein. (Geerbt von OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Fügt das angegebene Element unmittelbar vor dem angegebenen Verweiselement ein. (Geerbt von OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Fügt das angegebene Element unmittelbar vor dem aktuellen Element ein. (Geerbt von OpenXmlElement)
IsAfter(OpenXmlElement)	Bestimmt, ob das aktuelle Element nach einem angegebenen Element in Dokumentreihenfolge angezeigt wird. (Geerbt von OpenXmlElement)
IsBefore(OpenXmlElement)	Bestimmt, ob das aktuelle Element vor einem angegebenen Element in Dokumentreihenfolge angezeigt wird. (Geerbt von OpenXmlElement)
Load(WorksheetPart)	Lädt das DOM aus dem WorksheetPart
LookupNamespace(String)	Löst das Namespacepräfix im Kontext des aktuellen Knotens auf. (Geerbt von OpenXmlElement)
LookupPrefix(String)	Sucht das entsprechende Präfix für einen Namespace-URI im aktuellen Elementbereich. (Geerbt von OpenXmlElement)
NextSibling()	Ruft das OpenXmlElement-Element ab, das unmittelbar auf das aktuelle OpenXmlElement-Element folgt. Gibt null (Nothing in Visual Basic) zurück, wenn kein nächstes OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlElement)
NextSibling<T>()	Ruft das OpenXmlElement-Element mit dem angegebenen Typ ab, der auf das aktuelle OpenXmlElement-Element folgt. Gibt null (Nothing in Visual Basic) zurück, wenn kein nächstes OpenXmlElement vorhanden ist. (Geerbt von OpenXmlElement)
PrependChild<T>(T)	Fügt das angegebene Element am Anfang der Liste der untergeordneten Knoten des aktuellen Elements ein. (Geerbt von OpenXmlCompositeElement)
PreviousSibling()	Ruft das OpenXmlElement-Element ab, das unmittelbar vor dem aktuellen OpenXmlElement-Element steht. Gibt null (Nothing in Visual Basic ) zurück, wenn kein vorangehendes OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlElement)
PreviousSibling<T>()	Ruft das OpenXmlElement-Element mit dem angegebenen Typ ab, der dem aktuellen OpenXmlElement vorangestellt ist. Gibt null (Nothing in Visual Basic) zurück, wenn kein vorheriges OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlElement)
Reload()	Lädt den Inhalt des Teils in eine Open XML-DOM-Struktur neu. Diese Methode kann mehrmals aufgerufen werden, und bei jedem Aufruf wird die Struktur erneut geladen, und vorherige Änderungen an der Struktur werden abgebrochen. (Geerbt von OpenXmlPartRootElement)
Remove()	Entfernt das aktuelle Element aus dem übergeordneten Element. (Geerbt von OpenXmlElement)
RemoveAllChildren()	Entfernt alle untergeordneten Elemente des aktuellen Elements. (Geerbt von OpenXmlCompositeElement)
RemoveAllChildren<T>()	Entfernen Sie alle untergeordneten Elemente des aktuellen Elements vom Typ T. (Geerbt von OpenXmlElement)
RemoveAnnotations(Type)	Entfernt die Anmerkungen des angegebenen Typs aus dem aktuellen OpenXmlElement-Element. (Geerbt von OpenXmlElement)
RemoveAnnotations<T>()	Entfernt die Anmerkungen mit dem angegebenen Typ aus dem aktuellen OpenXmlElement-Element. (Geerbt von OpenXmlElement)
RemoveAttribute(String, String)	Entfernt das Attribut aus dem aktuellen Element. (Geerbt von OpenXmlElement)
RemoveChild<T>(T)	Entfernt das angegebene untergeordnete Element. (Geerbt von OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Entfernt die Namespacedeklaration für das angegebene Präfix. Entfernt nichts, wenn kein Präfix vorhanden ist. (Geerbt von OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Ersetzt eines der untergeordneten Elemente des aktuellen Elements durch ein anderes OpenXmlElement-Element. (Geerbt von OpenXmlCompositeElement)
Save()	Speichert die Daten in der DOM-Struktur wieder im Teil. Diese Methode kann mehrmals aufgerufen werden, und bei jedem Aufruf wird der Stream geleert. (Geerbt von OpenXmlPartRootElement)
Save(Stream)	Speichert die DOM-Struktur im angegebenen Stream. (Geerbt von OpenXmlPartRootElement)
Save(WorksheetPart)	Speichert das DOM im WorksheetPart.
SetAttribute(OpenXmlAttribute)	Legt ein Attribut auf das angegebene Element fest. Wenn das Attribut ein bekanntes Attribut ist, wird der Wert des Attributs festgelegt. Wenn es sich bei dem Attribut um ein erweitertes Attribut handelt, wird das "openxmlAttribute" der Liste der erweiterten Attribute hinzugefügt. (Geerbt von OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Legt eine Reihe von Attributen für das -Element fest. Wenn ein Attribut ein bekanntes Attribut ist, wird der Wert des Attributs festgelegt. Wenn ein Attribut ein erweitertes Attribut ist, wird das "openxmlAttribute" der Liste der erweiterten Attribute hinzugefügt. (Geerbt von OpenXmlElement)
WriteTo(XmlWriter)	Speichert den aktuellen Knoten im angegebenen XmlWriter. (Geerbt von OpenXmlPartRootElement)

Explizite Schnittstellenimplementierungen

IEnumerable.GetEnumerator()	Arbeitsblatt. Diese Klasse ist in Office 2007 und höher verfügbar. Wenn das Objekt als XML serialisiert wird, lautet der qualifizierte Name x:worksheet. (Geerbt von OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Gibt einen Enumerator zurück, der die untergeordnete Auflistung durchläuft. (Geerbt von OpenXmlElement)