Worksheet Classe

Definição

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Folha de cálculo.

Esta classe está disponível no Office 2007 e superior.

Quando o objeto é serializado como xml, o nome qualificado é x:folha de cálculo.

public class Worksheet : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Worksheet = class
    inherit OpenXmlPartRootElement

Public Class Worksheet
Inherits OpenXmlPartRootElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Worksheet

Exemplos

O seguinte exemplo de código insere uma nova folha de cálculo num documento de folha de cálculo ao fornecer o respetivo nome de ficheiro. Depois de executar o exemplo de código, examine o ficheiro de teste "WorksheetEx.xlsx" e repare na nova folha de cálculo com o nome "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  

Comentários

[ISO/IEC 29500-1 1st Edition]

folha de cálculo (Folha de Cálculo)

Este é o elemento raiz das partes da Folha de Cálculo num documento de Folha de CálculoML.

Elementos pai
Elemento raiz da parte folha de cálculo Folha de Cálculo de Folha de Cálculo

Elementos filho	Subclautilizar
Filtro Automático (Definições do Filtro Automático)	§18.3.1.2
cellWatches (Itens de Monitorização de Células)	§18.3.1.9
colBreaks (Quebras de Página Verticais)	§18.3.1.14
colunas (Informações da Coluna)	§18.3.1.17
conditionalFormatting (Formatação Condicional)	§18.3.1.18
controlos (Controlos Incorporados)	§18.3.1.21
customProperties (Propriedades Personalizadas)	§18.3.1.23
customSheetViews (Vistas de Folha Personalizada)	§18.3.1.27
dataConsolidate (Consolidação de Dados)	§18.3.1.29
dataValidations (Validações de Dados)	§18.3.1.33
dimensão (Dimensões da Folha de Cálculo)	§18.3.1.35
desenho (Desenho)	§18.3.1.36
drawingHF (Referência de Desenho no Rodapé do Cabeçalho)	§18.3.1.37
extLst (Área de Armazenamento de Dados de Funcionalidades Futuras)	§18.2.10
headerFooter (Definições do Rodapé do Cabeçalho)	§18.3.1.46
hiperligações (Hiperligações)	§18.3.1.48
ignoredErrors (Erros Ignorados)	§18.3.1.51
mergeCells (Unir Células)	§18.3.1.55
oleObjects (Objetos Incorporados)	§18.3.1.60
pageMargins (Margens da Página)	§18.3.1.62
pageSetup (Definições de Configuração de Página)	§18.3.1.63
phoneticPr (Propriedades Fonéticas)	§18.4.3
imagem (Imagem de Fundo)	§18.3.1.67
printOptions (Opções de Impressão)	§18.3.1.70
protectedRanges (Intervalos Protegidos)	§18.3.1.72
rowBreaks (Quebras de Página Horizontais (Linha))	§18.3.1.74
cenários (Cenários)	§18.3.1.76
sheetCalcPr (Propriedades de Cálculo da Folha)	§18.3.1.79
sheetData (Dados da Folha)	§18.3.1.80
sheetFormatPr (Propriedades do Formato da Folha)	§18.3.1.81
sheetPr (Propriedades da Folha)	§18.3.1.82
sheetProtection (Opções de Proteção de Folhas)	§18.3.1.85
sheetViews (Vistas de Folha)	§18.3.1.88
smartTags (Etiquetas Inteligentes)	§18.3.1.90
sortState (Estado de Ordenação)	§18.3.1.92
tableParts (Peças de Tabela)	§18.3.1.95
webPublishItems (Itens de Publicação na Web)	§18.3.1.98

[Nota: a definição de Esquema XML W3C do modelo de conteúdo deste elemento (CT_Worksheet) está localizada em {A.2. nota de fim]

ISO/IEC29500: 2008.

Construtores

Worksheet()	Inicializa uma nova instância da classe Folha de Cálculo.
Worksheet(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Folha de Cálculo com os elementos subordinados especificados.
Worksheet(OpenXmlElement[])	Inicializa uma nova instância da classe Folha de Cálculo com os elementos subordinados especificados.
Worksheet(String)	Inicializa uma nova instância da classe Folha de Cálculo a partir de XML externo.

Propriedades

ChildElements	Obtém todos os nós subordinados do elemento atual. (Herdado de OpenXmlElement)
ExtendedAttributes	Obtém todos os atributos expandidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
Features	Obtém um IFeatureCollection para o elemento atual. Esta coleção de funcionalidades será só de leitura, mas herdará as funcionalidades da parte principal e do pacote, se disponível. (Herdado de OpenXmlElement)
FirstChild	Obtém o primeiro elemento subordinado do elemento OpenXmlElement atual. (Herdado de OpenXmlCompositeElement)
HasAttributes	Obtém um valor que indica se o elemento atual tem atributos. (Herdado de OpenXmlElement)
HasChildren	Obtém um valor que indica se o elemento atual tem elementos subordinados. (Herdado de OpenXmlCompositeElement)
InnerText	Obtém ou define os valores concatenados do nó atual e de todos os respetivos subordinados. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós subordinados do nó atual. (Herdado de OpenXmlCompositeElement)
LastChild	Obtém o último elemento subordinado do elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir esse elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
LocalName	Obtém o nome local do elemento atual. (Herdado de OpenXmlElement)
MCAttributes	Obtém ou define os atributos de compatibilidade de markup. Devolve nulo se não forem definidos atributos de compatibilidade de markup para o elemento atual. (Herdado de OpenXmlElement)
NamespaceDeclarations	Obtém todas as declarações de espaço de nomes definidas no elemento atual. Devolve um enumerador vazio se não existir nenhuma declaração de espaço de nomes. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do espaço de nomes do elemento atual. (Herdado de OpenXmlElement)
OpenXmlElementContext	Obtém o OpenXmlElementContext do elemento atual. (Herdado de OpenXmlElement)
OpenXmlPart	Obtém a parte que está associada à árvore DOM. Devolve nulo quando a árvore DOM não está associada a uma peça. (Herdado de OpenXmlPartRootElement)
OuterXml	Obtém a marcação que representa o elemento atual e todos os respetivos elementos subordinados. (Herdado de OpenXmlElement)
Parent	Obtém o elemento principal do elemento atual. (Herdado de OpenXmlElement)
Prefix	Obtém o prefixo de espaço de nomes do elemento atual. (Herdado de OpenXmlElement)
SheetDimension	SheetDimension. Representa a seguinte etiqueta de elemento no esquema: x:dimensão.
SheetFormatProperties	SheetFormatProperties. Representa a seguinte etiqueta de elemento no esquema: x:sheetFormatPr.
SheetProperties	SheetProperties. Representa a seguinte etiqueta de elemento no esquema: x:sheetPr.
SheetViews	SheetViews. Representa a seguinte etiqueta de elemento no esquema: x:sheetViews.
WorksheetPart	Obtém a Peça de Folha de Cálculo associada a este elemento.
XmlQualifiedName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)
XName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotações do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adiciona o elemento especificado ao elemento se for um subordinado conhecido. Esta ação adiciona o elemento na localização correta de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de espaço de nomes ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os predecessores do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os predecessores do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations(Type)	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations<T>()	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Acrescenta cada elemento de uma lista de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao fim da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos expandidos. (Herdado de OpenXmlElement)
Clone()	Cria um duplicado do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria um duplicado deste nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumerar todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os subordinados do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos do elemento colateral que seguem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos do elemento colateral que precedem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da etiqueta especificado e o URI do espaço de nomes. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento subordinado no tipo T. (Herdado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente após o elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Insere o elemento especificado imediatamente após o elemento atual. (Herdado de OpenXmlElement)
InsertAt<T>(T, Int32)	Insere o elemento especificado no índice especificado dos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente antes do elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Insere o elemento especificado imediatamente antes do elemento atual. (Herdado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina se o elemento atual aparece depois de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual aparece antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
Load(WorksheetPart)	Carrega o DOM a partir da Peça de Folha de Cálculo
LookupNamespace(String)	Resolve o prefixo do espaço de nomes no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um URI de espaço de nomes no âmbito do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement seguinte. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir um OpenXmlElement seguinte. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Reload()	Recarrega o conteúdo da peça para uma árvore DOM Open XML. Este método pode ser chamado várias vezes e, sempre que for chamado, a árvore será recarregada e as alterações anteriores na árvore serão abandonadas. (Herdado de OpenXmlPartRootElement)
Remove()	Remove o elemento atual do respetivo elemento principal. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos subordinados do elemento atual que são do tipo T. (Herdado de OpenXmlElement)
RemoveAnnotations(Type)	Remove as anotações do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAnnotations<T>()	Remove as anotações com o tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAttribute(String, String)	Remove o atributo do elemento atual. (Herdado de OpenXmlElement)
RemoveChild<T>(T)	Remove o elemento subordinado especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de espaço de nomes para o prefixo especificado. Não remove nada se não existir um prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos subordinados do elemento atual por outro elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
Save()	Guarda os dados na árvore DOM novamente na peça. Este método pode ser chamado várias vezes e, sempre que for chamado, o fluxo será descarregado. (Herdado de OpenXmlPartRootElement)
Save(Stream)	Guarda a árvore DOM no fluxo especificado. (Herdado de OpenXmlPartRootElement)
Save(WorksheetPart)	Guarda o DOM na Peça de Folha de Cálculo.
SetAttribute(OpenXmlAttribute)	Define um atributo para o elemento especificado. Se o atributo for um atributo conhecido, o valor do atributo é definido. Se o atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define vários atributos para o elemento . Se um atributo for um atributo conhecido, o valor do atributo é definido. Se um atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Guarda o nó atual no XmlWriter especificado. (Herdado de OpenXmlPartRootElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Folha de cálculo. Esta classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, o nome qualificado é x:folha de cálculo. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devolve um enumerador que itera através da coleção subordinada. (Herdado de OpenXmlElement)