Sheet Classe

Définition

Espace de noms:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Paquet:

DocumentFormat.OpenXml v3.0.1

Informations sur la feuille.

Cette classe est disponible dans Office 2007 et versions ultérieures.

Lorsque l’objet est sérialisé au format xml, son nom qualifié est x :sheet.

public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElement

type Sheet = class
    inherit OpenXmlLeafElement

Public Class Sheet
Inherits OpenXmlLeafElement

Héritage

Object

OpenXmlElement

OpenXmlLeafElement

Sheet

Exemples

L’exemple de code suivant insère une nouvelle feuille de calcul dans le classeur d’un document de feuille de calcul existant.

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  

Remarques

[ISO/IEC 29500-1 1st Edition]

feuille (Informations sur la feuille)

Cet élément définit une feuille dans ce classeur. Les données de feuille sont stockées dans une partie distincte.

Éléments parents
feuilles (§18.2.20)

Attributs	Description
id (ID de relation) Espace de noms : .../officeDocument/2006/relationships	Spécifie l’identificateur de la partie de feuille dans laquelle la définition de cette feuille est stockée. Cet attribut est obligatoire. Les valeurs possibles pour cet attribut sont définies par le type simple ST_RelationshipId (§22.8.2.1).
name (Nom de la feuille)	Spécifie le nom de la feuille. Ce nom doit être unique. Cet attribut est obligatoire. Les valeurs possibles pour cet attribut sont définies par le type simple ST_Xstring (§22.9.2.19).
sheetId (ID d’onglet feuille)	Spécifie l’identificateur interne de la feuille. Cet identificateur doit être unique. Cet attribut est obligatoire. Les valeurs possibles de cet attribut sont définies par le type de données unsignedInt du schéma XML du W3C.
état (état visible)	Spécifie l’état visible de cette feuille. La valeur par défaut de cet attribut est « visible ». Les valeurs possibles pour cet attribut sont définies par le type simple ST_SheetState (§18.18.68).

[Remarque : La définition de schéma XML W3C du modèle de contenu de cet élément (CT_Sheet) se trouve dans §A.2. Fin de la remarque]

ISO/IEC29500 : 2008.

Constructeurs

Sheet()

Initialise une nouvelle instance de la classe Sheet.

Propriétés

ChildElements	Obtient tous les nœuds enfants de l’élément actuel. (Hérité de OpenXmlElement)
ExtendedAttributes	Obtient tous les attributs étendus (attributs non définis dans le schéma) de l’élément actuel. (Hérité de OpenXmlElement)
Features	Obtient un IFeatureCollection pour l’élément actuel. Cette collection de fonctionnalités sera en lecture seule, mais héritera des fonctionnalités de sa partie parente et de son package, le cas échéant. (Hérité de OpenXmlElement)
FirstChild	Obtient le premier enfant de l’élément OpenXmlElement. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement de ce type. (Hérité de OpenXmlElement)
HasAttributes	Obtient une valeur indiquant si l’élément actuel a des attributs. (Hérité de OpenXmlElement)
HasChildren	Obtient une valeur qui indique si l’élément actuel a des éléments enfants. (Hérité de OpenXmlLeafElement)
Id	ID de relation Représente l’attribut suivant dans le schéma : r :id
InnerText	Obtient ou définit les valeurs concaténées du nœud et de tous ses enfants. (Hérité de OpenXmlElement)
InnerXml	Obtient ou définit le balisage qui représente uniquement les éléments enfants de l’élément actuel. (Hérité de OpenXmlLeafElement)
LastChild	Obtient le dernier enfant de l’élément OpenXmlElement. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement de ce type. (Hérité de OpenXmlElement)
LocalName	Obtient le nom local de l’élément actuel. (Hérité de OpenXmlElement)
MCAttributes	Obtient ou définit les attributs de compatibilité du balisage. Retourne null si aucun attribut de compatibilité de balisage n’est défini pour l’élément actuel. (Hérité de OpenXmlElement)
Name	Nom de la feuille Représente l’attribut suivant dans le schéma : name
NamespaceDeclarations	Obtient toutes les déclarations d’espace de noms définies dans l’élément actuel. Retourne un énumérateur vide s’il n’y a pas de déclaration d’espace de noms. (Hérité de OpenXmlElement)
NamespaceUri	Obtient l’URI d’espace de noms de l’élément actuel. (Hérité de OpenXmlElement)
OpenXmlElementContext	Obtient l’élément OpenXmlElementContext de l’élément actuel. (Hérité de OpenXmlElement)
OuterXml	Obtient le balisage qui représente l’élément actuel et tous ses éléments enfants. (Hérité de OpenXmlElement)
Parent	Obtient l’élément parent de l’élément actuel. (Hérité de OpenXmlElement)
Prefix	Obtient le préfixe d’espace de noms de l’élément actuel. (Hérité de OpenXmlElement)
SheetId	ID de l’onglet Feuille Représente l’attribut suivant dans le schéma : sheetId
State	État visible Représente l’attribut suivant dans le schéma : état
XmlQualifiedName	Obtient le nom qualifié de l’élément actuel. (Hérité de OpenXmlElement)
XName	Obtient le nom qualifié de l’élément actuel. (Hérité de OpenXmlElement)

Méthodes

AddAnnotation(Object)	Ajoute un objet à la liste d’annotations de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement)
AddNamespaceDeclaration(String, String)	Ajoute une déclaration d’espace de noms au nœud actuel. (Hérité de OpenXmlElement)
Ancestors()	Énumère tous les ancêtres de l’élément actuel. (Hérité de OpenXmlElement)
Ancestors<T>()	Énumère uniquement les ancêtres de l’élément actuel qui ont le type spécifié. (Hérité de OpenXmlElement)
Annotation(Type)	Obtenez le premier objet d’annotation du type spécifié à partir de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement)
Annotation<T>()	Obtenez le premier objet d’annotation du type spécifié à partir de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement)
Annotations(Type)	Obtient une collection d’annotations avec le type spécifié pour l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement)
Annotations<T>()	Obtient une collection d’annotations avec le type spécifié pour l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Ajoute chaque élément d’une liste d’éléments à la fin de la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement)
Append(OpenXmlElement[])	Ajoute chaque élément d’un tableau d’éléments à la fin de la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement)
AppendChild<T>(T)	Ajoute l’élément spécifié à la fin de la liste des nœuds enfants de l’élément actuel. (Hérité de OpenXmlElement)
ClearAllAttributes()	Efface tous les attributs, y compris les attributs connus et les attributs étendus. (Hérité de OpenXmlElement)
Clone()	Crée un doublon du nœud actuel. (Hérité de OpenXmlElement)
CloneNode(Boolean)	Crée un doublon de ce nœud.
Descendants()	Énumère tous les descendants de l’élément actuel. (Hérité de OpenXmlElement)
Descendants<T>()	Énumérez tous les descendants de l’élément actuel de type T. (Hérité de OpenXmlElement)
Elements()	Énumère tous les enfants de l’élément actuel. (Hérité de OpenXmlElement)
Elements<T>()	Énumère uniquement les enfants de l’élément actuel qui ont le type spécifié. (Hérité de OpenXmlElement)
ElementsAfter()	Énumère tous les éléments frères qui suivent l’élément actuel et ont le même parent que l’élément actuel. (Hérité de OpenXmlElement)
ElementsBefore()	Énumère tous les éléments frères qui précèdent l’élément actuel et ont le même parent que l’élément actuel. (Hérité de OpenXmlElement)
GetAttribute(String, String)	Obtient un attribut Open XML avec le nom de balise et l’URI d’espace de noms spécifiés. (Hérité de OpenXmlElement)
GetAttributes()	Obtient une liste qui contient une copie de tous les attributs. (Hérité de OpenXmlElement)
GetEnumerator()	Retourne un énumérateur qui itère au sein de la collection enfant. (Hérité de OpenXmlElement)
GetFirstChild<T>()	Recherche le premier élément enfant de type T. (Hérité de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Insère l’élément spécifié immédiatement après l’élément de référence spécifié. (Hérité de OpenXmlElement)
InsertAfterSelf<T>(T)	Insère l’élément spécifié immédiatement après l’élément actuel. (Hérité de OpenXmlElement)
InsertAt<T>(T, Int32)	Insère l’élément spécifié à l’index spécifié dans la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Insère l’élément spécifié juste avant l’élément de référence spécifié. (Hérité de OpenXmlElement)
InsertBeforeSelf<T>(T)	Insère l’élément spécifié juste avant l’élément actuel. (Hérité de OpenXmlElement)
IsAfter(OpenXmlElement)	Détermine si l’élément actuel apparaît après un élément spécifié dans l’ordre du document. (Hérité de OpenXmlElement)
IsBefore(OpenXmlElement)	Détermine si l’élément actuel apparaît avant un élément spécifié dans l’ordre du document. (Hérité de OpenXmlElement)
LookupNamespace(String)	Résout le préfixe d’espace de noms dans le contexte du nœud actuel. (Hérité de OpenXmlElement)
LookupPrefix(String)	Recherche le préfixe correspondant pour un URI d’espace de noms dans l’étendue de l’élément actuel. (Hérité de OpenXmlElement)
NextSibling()	Obtient l’élément OpenXmlElement qui suit immédiatement l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement suivant. (Hérité de OpenXmlElement)
NextSibling<T>()	Obtient l’élément OpenXmlElement avec le type spécifié qui suit l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic) s’il n’y a pas d’élément OpenXmlElement suivant. (Hérité de OpenXmlElement)
PrependChild<T>(T)	Insère l’élément spécifié au début de la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement)
PreviousSibling()	Obtient l’élément OpenXmlElement qui précède immédiatement l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic ) s’il n’existe aucun élément OpenXmlElement précédent. (Hérité de OpenXmlElement)
PreviousSibling<T>()	Obtient l’élément OpenXmlElement avec le type spécifié qui précède l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement précédent. (Hérité de OpenXmlElement)
Remove()	Supprime l’élément actuel de son parent. (Hérité de OpenXmlElement)
RemoveAllChildren()	Supprime tous les éléments enfants de l’élément actuel. (Hérité de OpenXmlLeafElement)
RemoveAllChildren<T>()	Supprimez tous les éléments enfants de l’élément actuel qui sont de type T. (Hérité de OpenXmlElement)
RemoveAnnotations(Type)	Supprime les annotations du type spécifié de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement)
RemoveAnnotations<T>()	Supprime les annotations avec le type spécifié de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement)
RemoveAttribute(String, String)	Supprime l’attribut de l’élément actuel. (Hérité de OpenXmlElement)
RemoveChild<T>(T)	Supprime l’élément enfant spécifié de la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement)
RemoveNamespaceDeclaration(String)	Supprime la déclaration d’espace de noms pour le préfixe spécifié. Ne supprime rien s’il n’y a pas de préfixe. (Hérité de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Remplace un élément enfant par un autre élément enfant dans la liste d’éléments enfants de l’élément actuel. (Hérité de OpenXmlElement)
SetAttribute(OpenXmlAttribute)	Définit un attribut sur l’élément spécifié. Si l’attribut est un attribut connu, la valeur de l’attribut est définie. Si l’attribut est un attribut étendu, l’attribut « openxmlAttribute » est ajouté à la liste des attributs étendus. (Hérité de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Définit un certain nombre d’attributs à l’élément . Si un attribut est un attribut connu, la valeur de l’attribut est définie. Si un attribut est un attribut étendu, l’attribut « openxmlAttribute » est ajouté à la liste des attributs étendus. (Hérité de OpenXmlElement)
WriteTo(XmlWriter)	Enregistre le nœud actuel dans le XmlWriter spécifié. (Hérité de OpenXmlElement)

Implémentations d’interfaces explicites

IEnumerable.GetEnumerator()	Informations sur la feuille. Cette classe est disponible dans Office 2007 et versions ultérieures. Lorsque l’objet est sérialisé au format xml, son nom qualifié est x :sheet. (Hérité de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retourne un énumérateur qui itère au sein de la collection enfant. (Hérité de OpenXmlElement)