Поделиться через


Sheet Класс

Определение

Сведения о листе.

Этот класс доступен в Office 2007 и более поздних версиях.

Когда объект сериализуется как xml, его полное имя — x:sheet.

[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(22, "sheet")]
public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElement
public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElement
[DocumentFormat.OpenXml.SchemaAttr(22, "sheet")]
public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElement
[DocumentFormat.OpenXml.SchemaAttr("x:sheet")]
public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElement
[DocumentFormat.OpenXml.SchemaAttr("x:sheet")]
public class Sheet : DocumentFormat.OpenXml.TypedOpenXmlLeafElement
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElement
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
[<DocumentFormat.OpenXml.SchemaAttr(22, "sheet")>]
type Sheet = class
    inherit OpenXmlLeafElement
type Sheet = class
    inherit OpenXmlLeafElement
[<DocumentFormat.OpenXml.SchemaAttr(22, "sheet")>]
type Sheet = class
    inherit OpenXmlLeafElement
[<DocumentFormat.OpenXml.SchemaAttr("x:sheet")>]
type Sheet = class
    inherit OpenXmlLeafElement
[<DocumentFormat.OpenXml.SchemaAttr("x:sheet")>]
type Sheet = class
    inherit TypedOpenXmlLeafElement
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type Sheet = class
    inherit OpenXmlLeafElement
Public Class Sheet
Inherits OpenXmlLeafElement
Public Class Sheet
Inherits TypedOpenXmlLeafElement
Наследование
Наследование
Атрибуты

Примеры

В следующем примере кода вставляется новый лист в книгу существующего документа электронной таблицы.

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  

Комментарии

[ISO/IEC 29500-1 1 издание]

лист (сведения о листе)

Этот элемент определяет лист в этой книге. Данные листа хранятся в отдельной части.

Родительские элементы
листы (§18.2.20)
Атрибуты Описание
id (идентификатор связи)

Пространство имен: .../officeDocument/2006/relationships
Указывает идентификатор части листа, в которой хранится определение для этого листа.

Этот атрибут является обязательным.

Возможные значения для этого атрибута определяются простым типом ST_RelationshipId (§22.8.2.1).
name (имя листа) Указывает имя листа. Это имя должно быть уникальным.

Этот атрибут является обязательным.

Возможные значения для этого атрибута определяются ST_Xstring простого типа (§22.9.2.19).
sheetId (идентификатор вкладки листа) Задает внутренний идентификатор листа. Этот идентификатор должен быть уникальным.

Этот атрибут является обязательным.

Возможные значения для этого атрибута определены в типе данных unsignedInt схемы W3C XML.
состояние (видимое состояние) Указывает видимое состояние этого листа.

Значение по умолчанию для этого атрибута — "visible".

Возможные значения для этого атрибута определяются ST_SheetState простого типа (§18.18.68).

[Примечание. Определение схемы XML W3C для модели содержимого этого элемента (CT_Sheet) находится в §A.2. конечная заметка]

ISO/IEC29500: 2008.

Конструкторы

Sheet()

Инициализирует новый экземпляр класса Sheet.

Свойства

ChildElements

Возвращает все дочерние узлы текущего элемента.

(Унаследовано от OpenXmlElement)
ExtendedAttributes

Возвращает все расширенные атрибуты (атрибуты, не определенные в схеме) текущего элемента.

(Унаследовано от OpenXmlElement)
Features

IFeatureCollection Возвращает для текущего элемента. Эта коллекция компонентов будет доступна только для чтения, но будет наследовать компоненты от родительской части и пакета, если они доступны.

(Унаследовано от OpenXmlElement)
FirstChild

Возвращает первый дочерний элемент элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет.

(Унаследовано от OpenXmlElement)
HasAttributes

Возвращает значение, указывающее, имеет ли текущий элемент какие-либо атрибуты.

(Унаследовано от OpenXmlElement)
HasChildren

Возвращает значение, указывающее, содержит ли текущий элемент какие-либо дочерние элементы.

(Унаследовано от OpenXmlLeafElement)
Id

Идентификатор связи

Представляет следующий атрибут в схеме: r:id

InnerText

Возвращает или задает объединенные значения узла и всех его дочерних элементов.

(Унаследовано от OpenXmlElement)
InnerXml

Возвращает или задает разметку, представляющую только дочерние элементы текущего элемента.

(Унаследовано от OpenXmlLeafElement)
LastChild

Возвращает последний дочерний элемент элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет.

(Унаследовано от OpenXmlElement)
LocalName

Сведения о листе.

Этот класс доступен в Office 2007 и более поздних версиях.

Когда объект сериализуется как xml, его полное имя — x:sheet.

LocalName

Возвращает локальное имя текущего элемента.

(Унаследовано от OpenXmlElement)
MCAttributes

Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки.

(Унаследовано от OpenXmlElement)
Name

Имя листа

Представляет следующий атрибут в схеме: name

NamespaceDeclarations

Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен.

(Унаследовано от OpenXmlElement)
NamespaceUri

Возвращает универсальный код ресурса (URI) пространства имен текущего элемента.

(Унаследовано от OpenXmlElement)
OpenXmlElementContext

Возвращает openXmlElementContext текущего элемента.

(Унаследовано от OpenXmlElement)
OuterXml

Возвращает разметку, представляющую текущий элемент и все его дочерние элементы.

(Унаследовано от OpenXmlElement)
Parent

Возвращает родительский элемент текущего элемента.

(Унаследовано от OpenXmlElement)
Prefix

Возвращает префикс пространства имен текущего элемента.

(Унаследовано от OpenXmlElement)
SheetId

Идентификатор вкладки листа

Представляет следующий атрибут в схеме: sheetId

State

Видимое состояние

Представляет следующий атрибут в схеме: state

XmlQualifiedName

Возвращает полное имя текущего элемента.

(Унаследовано от OpenXmlElement)
XName

Возвращает полное имя текущего элемента.

(Унаследовано от OpenXmlElement)

Методы

AddAnnotation(Object)

Добавляет объект в список заметок текущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
AddNamespaceDeclaration(String, String)

Добавляет объявление пространства имен в текущий узел.

(Унаследовано от OpenXmlElement)
Ancestors()

Перечисляет все предки текущего элемента.

(Унаследовано от OpenXmlElement)
Ancestors<T>()

Перечисляет только предки текущего элемента, имеющие указанный тип.

(Унаследовано от OpenXmlElement)
Annotation(Type)

Получение первого объекта заметки указанного типа из текущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
Annotation<T>()

Получение первого объекта заметки указанного типа из текущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
Annotations(Type)

Возвращает коллекцию заметок с указанным типом для текущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
Annotations<T>()

Возвращает коллекцию заметок с указанным типом для текущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)

Добавляет каждый элемент из списка элементов в конец списка дочерних элементов текущего элемента.

(Унаследовано от OpenXmlElement)
Append(OpenXmlElement[])

Добавляет каждый элемент из массива элементов в конец списка дочерних элементов текущего элемента.

(Унаследовано от OpenXmlElement)
AppendChild<T>(T)

Добавляет указанный элемент в конец списка дочерних узлов текущего элемента.

(Унаследовано от OpenXmlElement)
ClearAllAttributes()

Очищает все атрибуты, включая как известные, так и расширенные атрибуты.

(Унаследовано от OpenXmlElement)
Clone()

Создает дубликат текущего узла.

(Унаследовано от OpenXmlElement)
CloneNode(Boolean)

Создает дубликат этого узла.

Descendants()

Перечисляет все потомки текущего элемента.

(Унаследовано от OpenXmlElement)
Descendants<T>()

Перечисление всех потомков текущего элемента типа T.

(Унаследовано от OpenXmlElement)
Elements()

Перечисляет все дочерние элементы текущего элемента.

(Унаследовано от OpenXmlElement)
Elements<T>()

Перечисляет только дочерние элементы текущего элемента, имеющие указанный тип.

(Унаследовано от OpenXmlElement)
ElementsAfter()

Перечисляет все одноуровневые элементы, которые следуют за текущим элементом и имеют тот же родительский элемент, что и текущий элемент.

(Унаследовано от OpenXmlElement)
ElementsBefore()

Перечисляет все одноуровневые элементы, которые предшествуют текущему элементу и имеют тот же родительский элемент, что и текущий элемент.

(Унаследовано от OpenXmlElement)
GetAttribute(String, String)

Возвращает атрибут Open XML с указанным именем тега и URI пространства имен.

(Унаследовано от OpenXmlElement)
GetAttributes()

Возвращает список, содержащий копию всех атрибутов.

(Унаследовано от OpenXmlElement)
GetEnumerator()

Возвращает перечислитель, который выполняет итерацию по дочерней коллекции.

(Унаследовано от OpenXmlElement)
GetFirstChild<T>()

Находит первый дочерний элемент в типе T.

(Унаследовано от OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)

Вставляет указанный элемент сразу после указанного ссылочного элемента.

(Унаследовано от OpenXmlElement)
InsertAfterSelf<T>(T)

Вставляет указанный элемент сразу после текущего элемента.

(Унаследовано от OpenXmlElement)
InsertAt<T>(T, Int32)

Вставляет указанный элемент по указанному индексу в список дочерних элементов текущего элемента.

(Унаследовано от OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)

Вставляет указанный элемент непосредственно перед указанным ссылочным элементом.

(Унаследовано от OpenXmlElement)
InsertBeforeSelf<T>(T)

Вставляет указанный элемент непосредственно перед текущим элементом.

(Унаследовано от OpenXmlElement)
IsAfter(OpenXmlElement)

Определяет, отображается ли текущий элемент после указанного элемента в порядке документа.

(Унаследовано от OpenXmlElement)
IsBefore(OpenXmlElement)

Определяет, отображается ли текущий элемент перед указанным элементом в порядке документа.

(Унаследовано от OpenXmlElement)
LookupNamespace(String)

Разрешает префикс пространства имен в контексте текущего узла.

(Унаследовано от OpenXmlElement)
LookupPrefix(String)

Находит соответствующий префикс для URI пространства имен в текущем элементе область.

(Унаследовано от OpenXmlElement)
NextSibling()

Возвращает элемент OpenXmlElement, который сразу же следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
NextSibling<T>()

Возвращает элемент OpenXmlElement с указанным типом, который следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего OpenXmlElement.

(Унаследовано от OpenXmlElement)
PrependChild<T>(T)

Вставляет указанный элемент в начало списка дочерних элементов текущего элемента.

(Унаследовано от OpenXmlElement)
PreviousSibling()

Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
PreviousSibling<T>()

Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
Remove()

Удаляет текущий элемент из родительского элемента.

(Унаследовано от OpenXmlElement)
RemoveAllChildren()

Удаляет все дочерние элементы текущего элемента.

(Унаследовано от OpenXmlLeafElement)
RemoveAllChildren<T>()

Удалите все дочерние элементы текущего элемента типа T.

(Унаследовано от OpenXmlElement)
RemoveAnnotations(Type)

Удаляет заметки указанного типа из текущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
RemoveAnnotations<T>()

Удаляет заметки с указанным типом из текущего элемента OpenXmlElement.

(Унаследовано от OpenXmlElement)
RemoveAttribute(String, String)

Удаляет атрибут из текущего элемента.

(Унаследовано от OpenXmlElement)
RemoveChild<T>(T)

Удаляет указанный дочерний элемент из списка дочерних элементов текущего элемента.

(Унаследовано от OpenXmlElement)
RemoveNamespaceDeclaration(String)

Удаляет объявление пространства имен для указанного префикса. Ничего не удаляет, если нет префикса.

(Унаследовано от OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)

Заменяет дочерний элемент другим дочерним элементом в списке дочерних элементов текущего элемента.

(Унаследовано от OpenXmlElement)
SetAttribute(OpenXmlAttribute)

Задает атрибут заданного элемента. Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute.

(Унаследовано от OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)

Задает ряд атрибутов элемента . Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute.

(Унаследовано от OpenXmlElement)
WriteTo(XmlWriter)

Сохраняет текущий узел в указанном xmlWriter.

(Унаследовано от OpenXmlElement)

Явные реализации интерфейса

IEnumerable.GetEnumerator()

Сведения о листе.

Этот класс доступен в Office 2007 и более поздних версиях.

Когда объект сериализуется как xml, его полное имя — x:sheet.

(Унаследовано от OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()

Возвращает перечислитель, который выполняет итерацию по дочерней коллекции.

(Унаследовано от OpenXmlElement)

Применяется к