Sheet 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
工作表信息。
此类在 Office 2007 及更高版本中提供。
当对象序列化为 xml 时,其限定名称为 x:sheet。
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(22, "sheet")]
public class Sheet : DocumentFormat.OpenXml.OpenXmlLeafElementpublic 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 OpenXmlLeafElementtype 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 OpenXmlLeafElementPublic Class Sheet
Inherits OpenXmlLeafElementPublic 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 版]
工作表 (工作表信息)
此元素定义此工作簿中的工作表。 工作表数据存储在单独的部件中。
| 父元素 | 
|---|
| sheets (§18.2.20) | 
| 属性 | 说明 | 
|---|---|
| id (关系 ID) 命名空间: .../officeDocument/2006/relationships | 指定用于存储此工作表定义的工作表部件的标识符。 此特性是必需的。 此属性的可能值由 ST_RelationshipId 简单类型 (§22.8.2.1) 定义。 | 
| name (Sheet Name) | 指定工作表的名称。 此名称应是唯一的。 此特性是必需的。 此属性的可能值由 ST_Xstring 简单类型 (§22.9.2.19) 定义。 | 
| sheetId (工作表选项卡 ID) | 指定工作表的内部标识符。 此标识符应是唯一的。 此特性是必需的。 此属性的可能值由 W3C XML 架构 unsignedInt 数据类型定义。 | 
| 状态 (可见状态) | 指定此工作表的可见状态。 此属性的默认值为“可见”。 此属性的可能值由 ST_SheetState 简单类型 (§18.18.68) 定义。 | 
[注意:此元素的内容模型 (CT_Sheet) 的 W3C XML 架构定义位于 §A.2 中。 注释结束]
ISO/IEC29500:2008。
构造函数
| Sheet() | 初始化 Sheet 类的新实例。 | 
属性
| ChildElements | 获取当前元素的所有子节点。(继承自 OpenXmlElement) | 
| ExtendedAttributes | 获取当前元素的架构) 中未定义的所有扩展属性 (属性。(继承自 OpenXmlElement) | 
| Features | IFeatureCollection获取当前元素的 。 此功能集合将是只读的,但会从其父部件和包继承功能(如果可用)。(继承自 OpenXmlElement) | 
| FirstChild | 获取 OpenXmlElement 元素的第一个子元素。 如果没有这样的 OpenXmlElement 元素,则返回 null (Visual Basic) Nothing。(继承自 OpenXmlElement) | 
| HasAttributes | 获取一个值,该值指示当前元素是否具有任何属性。(继承自 OpenXmlElement) | 
| HasChildren | 获取一个值,该值指示当前元素是否具有任何子元素。(继承自 OpenXmlLeafElement) | 
| Id | 关系 ID 表示架构中的以下属性:r:id | 
| InnerText | 获取或设置节点及其所有子级的串联值。(继承自 OpenXmlElement) | 
| InnerXml | 获取或设置仅表示当前元素的子元素的标记。(继承自 OpenXmlLeafElement) | 
| LastChild | 获取 OpenXmlElement 元素的最后一个子元素。 如果没有这样的 OpenXmlElement 元素,则返回 null (Visual Basic) Nothing。(继承自 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 | 工作表选项卡 ID 表示架构中的以下属性:sheetId | 
| 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) | 获取具有指定标记名称和命名空间 URI 的 Open XML 属性。(继承自 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 元素。 如果没有下一个 OpenXmlElement 元素,则返回 null (Visual Basic) Nothing。(继承自 OpenXmlElement) | 
| NextSibling<T>() | 获取具有当前 OpenXmlElement 元素后面的指定类型的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement,则返回 null (Visual Basic) Nothing。(继承自 OpenXmlElement) | 
| PrependChild<T>(T) | 在当前元素的子元素列表的开头插入指定的元素。(继承自 OpenXmlElement) | 
| PreviousSibling() | 获取紧接在当前 OpenXmlElement 元素之前的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素,则返回 null (Visual Basic ) 中 Nothing。(继承自 OpenXmlElement) | 
| PreviousSibling<T>() | 获取位于当前 OpenXmlElement 之前的指定类型的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素,则返回 null (Visual Basic) Nothing。(继承自 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) |