Sheet Klasse

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Paket:

DocumentFormat.OpenXml v3.0.1

Blattinformationen.

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

Wenn das Objekt als xml serialisiert wird, lautet der qualifizierte Name x:sheet.

public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElement

type Sheet = class
    inherit OpenXmlLeafElement

Public Class Sheet
Inherits OpenXmlLeafElement

Vererbung

Object

OpenXmlElement

OpenXmlLeafElement

Sheet

Beispiele

Im folgenden Codebeispiel wird ein neues Arbeitsblatt in die Arbeitsmappe eines vorhandenen Tabellenkalkulationsdokuments eingefügt.

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

namespace SheetEx  
{  
    class Program  
    {  
        // Insert a new worksheet in a spreadsheet document.  
        static void Main(string[] args)  
        {  
            string document = @"C:\users\public\documents\SheetsEx.xlsx";  

            // Open the document for editing.  
            using (SpreadsheetDocument spreadsheetDocument  
                = SpreadsheetDocument.Open(document, true))  
            {  
                // Add a blank WorksheetPart.  
                WorksheetPart newWorksheetPart =   
                    spreadsheetDocument.WorkbookPart.AddNewPart<WorksheetPart>();  
                newWorksheetPart.Worksheet = new Worksheet(new SheetData());  

                Sheets sheets = spreadsheetDocument.WorkbookPart.Workbook  
                    .GetFirstChild<Sheets>();  
                string relationshipId = spreadsheetDocument.WorkbookPart  
                    .GetIdOfPart(newWorksheetPart);  

                // Get 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("A new sheet has been inserted into the workbook.\nPress a key.");  
                Console.ReadKey();  
            }  
        }  
    }  
}  

Imports System.Linq  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  

Module Module1  
    ' Insert a new worksheet in a spreadsheet document.  
    Sub Main(ByVal args As String())  
        Dim document As String = "C:\users\public\documents\SheetsEx.xlsx"  

        ' Open the document for editing.  
        Using spreadsheetDocument As SpreadsheetDocument = _  
            spreadsheetDocument.Open(document, True)  
            ' Add a blank WorksheetPart.  
            Dim newWorksheetPart As WorksheetPart = _  
                spreadsheetDocument.WorkbookPart.AddNewPart(Of WorksheetPart)()  
            newWorksheetPart.Worksheet = New Worksheet(New SheetData())  

            Dim sheets As Sheets = _  
                spreadsheetDocument.WorkbookPart.Workbook.GetFirstChild(Of Sheets)()  
            Dim relationshipId As String = _  
                spreadsheetDocument.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  

            ' Append the new worksheet and associate it with the workbook.  
            Dim sheet As New Sheet() With { _  
             .Id = relationshipId, _  
             .SheetId = sheetId, _  
             .Name = sheetName _  
            }  
            sheets.Append(sheet)  

            Console.WriteLine("A new sheet has been inserted into the workbook." _  
                              & vbLf & "Press a key.")  
            Console.ReadKey()  
        End Using  
    End Sub  
End Module  

Hinweise

[ISO/IEC 29500-1 1. Auflage]

Blatt (Blattinformationen)

Dieses Element definiert ein Blatt in dieser Arbeitsmappe. Blattdaten werden in einem separaten Teil gespeichert.

Übergeordnete Elemente
Blätter (§18.2.20)

Attribute	Beschreibung
id (Beziehungs-ID) Namespace: .../officeDocument/2006/relationships	Gibt den Bezeichner des Blattteils an, in dem die Definition für dieses Blatt gespeichert ist. Dieses Attribut ist erforderlich. Die möglichen Werte für dieses Attribut werden durch den ST_RelationshipId einfachen Typ (§22.8.2.1) definiert.
name (Blattname)	Gibt den Namen des Blatts an. Dieser Name muss eindeutig sein. Dieses Attribut ist erforderlich. Die möglichen Werte für dieses Attribut werden durch den ST_Xstring einfachen Typ definiert (§22.9.2.19).
sheetId (Blattregisterkarten-ID)	Gibt den internen Bezeichner für das Blatt an. Dieser Bezeichner muss eindeutig sein. Dieses Attribut ist erforderlich. Die möglichen Werte dieses Attributs werden durch den unsignedInt-Datentyp des W3C-XML-Schemas definiert.
State (Sichtbarer Zustand)	Gibt den sichtbaren Zustand dieses Blatts an. Der Standardwert für dieses Attribut ist "visible". Die möglichen Werte für dieses Attribut werden durch den ST_SheetState einfachen Typ definiert (§18.18.68).

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

ISO/IEC29500: 2008.

Konstruktoren

Sheet()

Initialisiert eine neue instance der Sheet-Klasse.

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 OpenXmlElement-Elements ab. Gibt null (Nothing in Visual Basic) zurück, wenn kein solches OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlElement)
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 OpenXmlLeafElement)
Id	Beziehungs-ID Stellt das folgende Attribut im Schema dar: r:id
InnerText	Ruft die verketteten Werte des Knotens und aller untergeordneten Elemente ab oder legt diese fest. (Geerbt von OpenXmlElement)
InnerXml	Ruft das Markup ab, das nur untergeordnete Elemente des aktuellen Elements darstellt, oder legt dieses fest. (Geerbt von OpenXmlLeafElement)
LastChild	Ruft das letzte untergeordnete Element des OpenXmlElement-Elements ab. Gibt null (Nothing in Visual Basic) zurück, wenn kein solches OpenXmlElement-Element vorhanden ist. (Geerbt von OpenXmlElement)
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)
Name	Blattname Stellt das folgende Attribut im Schema dar: name
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)
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)
SheetId	Blattregisterkarten-ID Stellt das folgende Attribut im Schema dar: sheetId
State	Sichtbarer Zustand Stellt das folgende Attribut im Schema dar: state
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)
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 OpenXmlElement)
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 OpenXmlElement)
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 in die Liste der untergeordneten Elemente des aktuellen Elements ein. (Geerbt von OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Fügt das angegebene Element unmittelbar vor dem angegebenen Verweiselement ein. (Geerbt von OpenXmlElement)
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)
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 Elemente des aktuellen Elements ein. (Geerbt von OpenXmlElement)
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)
Remove()	Entfernt das aktuelle Element aus dem übergeordneten Element. (Geerbt von OpenXmlElement)
RemoveAllChildren()	Entfernt alle untergeordneten Elemente des aktuellen Elements. (Geerbt von OpenXmlLeafElement)
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 aus der Liste der untergeordneten Elemente des aktuellen Elements. (Geerbt von OpenXmlElement)
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 ein untergeordnetes Element durch ein anderes untergeordnetes Element in der Liste der untergeordneten Elemente des aktuellen Elements. (Geerbt von OpenXmlElement)
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 OpenXmlElement)

Explizite Schnittstellenimplementierungen

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