SharedStringTable 类

定义

命名空间:

DocumentFormat.OpenXml.Spreadsheet

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

共享字符串表。

此类在 Office 2007 及更高版本中可用。

当对象序列化为 xml 时，其限定名称为 x：sst。

public class SharedStringTable : DocumentFormat.OpenXml.OpenXmlPartRootElement

type SharedStringTable = class
    inherit OpenXmlPartRootElement

Public Class SharedStringTable
Inherits OpenXmlPartRootElement

继承

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

SharedStringTable

示例

下面的代码示例创建一个新的电子表格文档，并在单元格“A2”中插入超链接。

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

namespace SharedStringTableEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\Users\Public\Documents\SharedStringTableEx.xlsx";  

            // Create a spreadsheet document.  
            SpreadsheetDocument spreadsheetDocument = SpreadsheetDocument.  
                Create(fileName, SpreadsheetDocumentType.Workbook);  

            // Add a WorkbookPart to the document.  
            WorkbookPart workbookpart = spreadsheetDocument.AddWorkbookPart();  
            workbookpart.Workbook = new Workbook();  

            // Add a WorksheetPart to the WorkbookPart.  
            WorksheetPart worksheetPart = workbookpart.AddNewPart<WorksheetPart>();  
            worksheetPart.Worksheet = new Worksheet(new SheetData());  

            // Add Sheets to the Workbook.  
            Sheets sheets =  
                spreadsheetDocument.WorkbookPart.Workbook.AppendChild<Sheets>(new Sheets());  

            // Append a new worksheet and associate it with the workbook.  
            Sheet sheet = new Sheet()  
            { Id = spreadsheetDocument.WorkbookPart.  
                GetIdOfPart(worksheetPart),  
                SheetId = 1,  
                Name = "mySheet"  
            };  
            sheets.Append(sheet);  

            Worksheet worksheet = new Worksheet();  
            SheetData sheetData = new SheetData();  

            Row row =  
                new Row()  
                { RowIndex = 2U,  
                  Spans = new ListValue<StringValue>() { InnerText = "2:2" }  
                };  
            Cell cell =  
                new Cell()  
                { CellReference = "A2",  
                  DataType = CellValues.String,  
                  CellValue = new CellValue("Microsoft")  
                };  
            row.Append(cell);  
            sheetData.Append(row);  
            worksheet.Append(sheetData);  
            worksheetPart.Worksheet = worksheet;  

            workbookpart.Workbook.Save();  

            // Close the document.  
            spreadsheetDocument.Close();  
            InsertHyperLink(fileName, "http://www.microsoft.com", "A2");  

            Console.WriteLine("The hyperlink has been inserted.\nPress a key.");  
            Console.ReadKey();  
        }  

        static public void InsertHyperLink(string fileName, string uri, string cellAddress)  
        {  
            // Open the document for editing.  
            using (SpreadsheetDocument spreadsheetDocument =  
                SpreadsheetDocument.Open(fileName, true))  
            {  
                // Get the first sheet in the workbook.  
                Sheet sheet1 = spreadsheetDocument.WorkbookPart.Workbook.  
                    Descendants<Sheet>().First();  
                WorksheetPart worksheetPart = (WorksheetPart)spreadsheetDocument.  
                    WorkbookPart.GetPartById(sheet1.Id);  

                // Create a hyperlink relationship.  
                HyperlinkRelationship hyperlinkRelationship =  
                    worksheetPart.AddHyperlinkRelationship(new System.Uri  
                    (uri, System.UriKind.Absolute), true);  

                // Add a new shared string table part.  
                SharedStringTablePart sharedStringTablePart1;  
                if (spreadsheetDocument.WorkbookPart.GetPartsCountOfType  
                    <SharedStringTablePart>() > 0)  
                {  
                    sharedStringTablePart1 =  
                        spreadsheetDocument.WorkbookPart.GetPartsOfType  
                        <SharedStringTablePart>().First();  
                }  
                else  
                {  
                    sharedStringTablePart1 =  
                        spreadsheetDocument.WorkbookPart.AddNewPart  
                        <SharedStringTablePart>();  
                }  

                // Add a new shared string table.  
                SharedStringTable sharedStringTable1 =  
                    new SharedStringTable() { Count = (UInt32Value)1U, UniqueCount =  
                        (UInt32Value)1U };  
                sharedStringTablePart1.SharedStringTable = sharedStringTable1;  

                // Create the hyperlink object.  
                Hyperlinks hyperlinks1 = new Hyperlinks();  
                Hyperlink hyperlink1 =  
                    new Hyperlink() { Reference = cellAddress, Id =   
                        hyperlinkRelationship.Id };  

                // Append the hyperlink to the collection.   
                hyperlinks1.Append(hyperlink1);  

                // Append the hyperlink to the worksheet.  
                worksheetPart.Worksheet.Append(hyperlinks1);  
            }  
        }  
    }  
}  
// Output:  
// The hyperlink has been inserted.  
// Press a key.  

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

Module Module1  
    Sub Main(ByVal args As String())  
        Dim fileName As String = "C:\Users\Public\Documents\SharedStringTableEx.xlsx"  

        ' Create a spreadsheet document.  
        Dim spreadsheetDocument As SpreadsheetDocument = spreadsheetDocument.Create(fileName, SpreadsheetDocumentType.Workbook)  

        ' Add a WorkbookPart to the document.  
        Dim workbookpart As WorkbookPart = spreadsheetDocument.AddWorkbookPart()  
        workbookpart.Workbook = New Workbook()  

        ' Add a WorksheetPart to the WorkbookPart.  
        Dim worksheetPart As WorksheetPart = workbookpart.AddNewPart(Of WorksheetPart)()  
        worksheetPart.Worksheet = New Worksheet(New SheetData())  

        ' Add Sheets to the Workbook.  
        Dim sheets As Sheets = spreadsheetDocument.WorkbookPart.Workbook.AppendChild(Of Sheets)(New Sheets())  

        ' Append a new worksheet and associate it with the workbook.  
        Dim sheet As New Sheet() With { _  
         .Id = spreadsheetDocument.WorkbookPart.GetIdOfPart(worksheetPart), _  
         .SheetId = 1, _  
         .Name = "mySheet" _  
        }  
        sheets.Append(sheet)  

        Dim worksheet As New Worksheet()  
        Dim sheetData As New SheetData()  

        Dim row As New Row() With { _  
         .RowIndex = 2UI, _  
         .Spans = New ListValue(Of StringValue)() With { _  
          .InnerText = "2:2" _  
         } _  
        }  
        Dim cell As New Cell() With { _  
         .CellReference = "A2", _  
         .DataType = CellValues.[String], _  
         .CellValue = New CellValue("Microsoft") _  
        }  
        row.Append(cell)  
        sheetData.Append(row)  
        worksheet.Append(sheetData)  
        worksheetPart.Worksheet = worksheet  

        workbookpart.Workbook.Save()  

        ' Close the document.  
        spreadsheetDocument.Close()  
        InsertHyperLink(fileName, "http://www.microsoft.com", "A2")  

        Console.WriteLine("The hyperlink has been inserted." & vbLf & "Press a key.")  
        Console.ReadKey()  
    End Sub  

    Public Sub InsertHyperLink(ByVal fileName As String, ByVal uri As String, ByVal cellAddress As String)  
        ' Open the document for editing.  
        Using spreadsheetDocument As SpreadsheetDocument = spreadsheetDocument.Open(fileName, True)  
            ' Get the first sheet in the workbook.  
            Dim sheet1 As Sheet = spreadsheetDocument.WorkbookPart.Workbook.Descendants(Of Sheet)().First()  
            Dim worksheetPart As WorksheetPart = DirectCast(spreadsheetDocument.WorkbookPart.GetPartById(sheet1.Id), WorksheetPart)  

            ' Create a hyperlink relationship.  
            Dim hyperlinkRelationship As HyperlinkRelationship = worksheetPart.AddHyperlinkRelationship(New System.Uri(uri, System.UriKind.Absolute), True)  

            ' Add a new shared string table part.  
            Dim sharedStringTablePart1 As SharedStringTablePart  
            If spreadsheetDocument.WorkbookPart.GetPartsCountOfType(Of SharedStringTablePart)() > 0 Then  
                sharedStringTablePart1 = spreadsheetDocument.WorkbookPart.GetPartsOfType(Of SharedStringTablePart)().First()  
            Else  
                sharedStringTablePart1 = spreadsheetDocument.WorkbookPart.AddNewPart(Of SharedStringTablePart)()  
            End If  

            ' Add a new shared string table.  
            Dim sharedStringTable1 As New SharedStringTable() With { _  
              .Count = CType(1UI, UInt32Value), _  
              .UniqueCount = CType(1UI, UInt32Value) _  
            }  
            sharedStringTablePart1.SharedStringTable = sharedStringTable1  

            ' Create the hyperlink object.  
            Dim hyperlinks1 As New Hyperlinks()  
            Dim hyperlink1 As New Hyperlink() With { _  
             .Reference = cellAddress, _  
             .Id = hyperlinkRelationship.Id _  
            }  

            ' Append the hyperlink to the collection.   
            hyperlinks1.Append(hyperlink1)  

            ' Append the hyperlink to the worksheet.  
            worksheetPart.Worksheet.Append(hyperlinks1)  
        End Using  
    End Sub  
End Module  
' Output:  
' The hyperlink has been inserted.  
' Press a key.  

注解

[ISO/IEC 29500-1 第 1 版]

sst (共享字符串表)

此元素是共享字符串表的根目录，该表充当单个字符串项的集合， (si) 。

父元素
SpreadsheetML 共享字符串表部件的根元素

子元素	第
extLst (Future Feature Data Storage Area)	§18.2.10
si (字符串项)	§18.4.8

属性	说明
count (String Count)	一个整数，表示工作簿中的字符串总数。 此计数不包括任何数字，它只计算工作簿中的文本字符串总数。 此属性是可选的，除非使用 uniqueCount ，在这种情况下，它是必需的。 此属性的可能值由 W3C XML 架构 unsignedInt 数据类型定义。
uniqueCount (唯一字符串计数)	一个整数，表示共享字符串表中唯一字符串的总计数。 字符串是唯一的，即使它是另一个字符串的副本，但在字符级别应用了不同的格式。 [示例： World、 World 和 World。 计数为 3，uniqueCount 为 2。 表中只显示“World”的一个条目，因为它是同一个字符串，只是在单元格级别应用了不同的格式 (即应用于单元格) 的整个字符串。 “World”字符串将在共享字符串表中获得单独的唯一条目，因为它对特定字符应用了不同的格式。 示例结束] 此属性是可选的，除非使用 count ，在这种情况下，它是必需的。 此属性的可能值由 W3C XML 架构 unsignedInt 数据类型定义。

[注意：此元素的内容模型 (CT_Sst) 的 W3C XML 架构定义位于 §A.2 中。 注释结束]

ISO/IEC29500：2008。

构造函数

SharedStringTable()	初始化 SharedStringTable 类的新实例。
SharedStringTable(IEnumerable<OpenXmlElement>)	使用指定的子元素初始化 SharedStringTable 类的新实例。
SharedStringTable(OpenXmlElement[])	使用指定的子元素初始化 SharedStringTable 类的新实例。
SharedStringTable(String)	从外部 XML 初始化 SharedStringTable 类的新实例。

属性

ChildElements	获取当前元素的所有子节点。 (继承自 OpenXmlElement)
Count	字符串计数 表示架构中的以下属性：count
ExtendedAttributes	获取当前元素的架构) 中未定义的所有扩展属性 (属性。 (继承自 OpenXmlElement)
Features	IFeatureCollection获取当前元素的 。 此功能集合将是只读的，但会从其父部件和包继承功能（如果可用）。 (继承自 OpenXmlElement)
FirstChild	获取当前 OpenXmlElement 元素的第一个子元素。 (继承自 OpenXmlCompositeElement)
HasAttributes	获取一个值，该值指示当前元素是否具有任何属性。 (继承自 OpenXmlElement)
HasChildren	获取一个值，该值指示当前元素是否具有任何子元素。 (继承自 OpenXmlCompositeElement)
InnerText	获取或设置当前节点及其所有子节点的串联值。 (继承自 OpenXmlCompositeElement)
InnerXml	获取或设置仅表示当前节点的子节点的标记。 (继承自 OpenXmlCompositeElement)
LastChild	获取当前 OpenXmlElement 元素的最后一个子元素。 如果没有这样的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlCompositeElement)
LocalName	获取当前元素的本地名称。 (继承自 OpenXmlElement)
MCAttributes	获取或设置标记兼容性属性。 如果未为当前元素定义标记兼容性属性，则返回 null。 (继承自 OpenXmlElement)
NamespaceDeclarations	获取在当前元素中定义的所有命名空间声明。 如果没有命名空间声明，则返回空枚举器。 (继承自 OpenXmlElement)
NamespaceUri	获取当前元素的命名空间 URI。 (继承自 OpenXmlElement)
OpenXmlElementContext	获取当前元素的 OpenXmlElementContext。 (继承自 OpenXmlElement)
OpenXmlPart	获取与 DOM 树关联的部分。 当 DOM 树未与部件关联时，它返回 null。 (继承自 OpenXmlPartRootElement)
OuterXml	获取表示当前元素及其所有子元素的标记。 (继承自 OpenXmlElement)
Parent	获取当前元素的父元素。 (继承自 OpenXmlElement)
Prefix	获取当前元素的命名空间前缀。 (继承自 OpenXmlElement)
SharedStringTablePart	获取与此元素关联的 SharedStringTablePart。
UniqueCount	唯一字符串计数 表示架构中的以下属性：uniqueCount
XmlQualifiedName	获取当前元素的限定名称。 (继承自 OpenXmlElement)
XName	获取当前元素的限定名称。 (继承自 OpenXmlElement)

方法

AddAnnotation(Object)	将 对象添加到当前 OpenXmlElement 元素的批注列表中。 (继承自 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	如果指定元素是已知的子元素，则将其添加到 元素。 这会根据架构将 元素添加到正确的位置。 (继承自 OpenXmlCompositeElement)
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)	将指定的元素追加到当前元素的子节点列表的末尾。 (继承自 OpenXmlCompositeElement)
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)	在指定的引用元素之后立即插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	在当前元素之后立即插入指定的元素。 (继承自 OpenXmlElement)
InsertAt<T>(T, Int32)	在当前元素的子元素的指定索引处插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	将指定的元素紧接在指定的引用元素之前。 (继承自 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	将指定的元素紧接在当前元素的前面。 (继承自 OpenXmlElement)
IsAfter(OpenXmlElement)	确定当前元素是否以文档顺序显示在指定元素之后。 (继承自 OpenXmlElement)
IsBefore(OpenXmlElement)	确定当前元素是否按文档顺序显示在指定元素之前。 (继承自 OpenXmlElement)
Load(SharedStringTablePart)	从 SharedStringTablePart 加载 DOM
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)	在当前元素的子节点列表的开头插入指定的元素。 (继承自 OpenXmlCompositeElement)
PreviousSibling()	获取紧接在当前 OpenXmlElement 元素之前的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic ) 中 Nothing。 (继承自 OpenXmlElement)
PreviousSibling<T>()	获取位于当前 OpenXmlElement 之前的指定类型的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
Reload()	将部件内容重新加载到 Open XML DOM 树中。 此方法可以多次调用，每次调用它时，都会重新加载树，并放弃树上的先前更改。 (继承自 OpenXmlPartRootElement)
Remove()	从其父元素中删除当前元素。 (继承自 OpenXmlElement)
RemoveAllChildren()	删除当前元素的所有子元素。 (继承自 OpenXmlCompositeElement)
RemoveAllChildren<T>()	删除类型为 T 的当前元素的所有子元素。 (继承自 OpenXmlElement)
RemoveAnnotations(Type)	从当前 OpenXmlElement 元素中删除指定类型的注释。 (继承自 OpenXmlElement)
RemoveAnnotations<T>()	从当前 OpenXmlElement 元素中删除具有指定类型的批注。 (继承自 OpenXmlElement)
RemoveAttribute(String, String)	从当前元素中删除 属性。 (继承自 OpenXmlElement)
RemoveChild<T>(T)	删除指定的子元素。 (继承自 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	删除指定前缀的命名空间声明。 如果没有前缀，则不删除任何内容。 (继承自 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	将当前元素的子元素之一替换为另一个 OpenXmlElement 元素。 (继承自 OpenXmlCompositeElement)
Save()	将 DOM 树中的数据保存回 部件。 此方法可以多次调用，每次调用时，都会刷新流。 (继承自 OpenXmlPartRootElement)
Save(SharedStringTablePart)	将 DOM 保存到 SharedStringTablePart 中。
Save(Stream)	将 DOM 树保存到指定的流。 (继承自 OpenXmlPartRootElement)
SetAttribute(OpenXmlAttribute)	将特性设置为指定的元素。 如果该属性是已知属性，则设置该特性的值。 如果该属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	设置元素的多个属性。 如果属性是已知属性，则会设置该属性的值。 如果属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
WriteTo(XmlWriter)	将当前节点保存到指定的 XmlWriter。 (继承自 OpenXmlPartRootElement)

显式接口实现

IEnumerable.GetEnumerator()	共享字符串表。 此类在 Office 2007 及更高版本中可用。 当对象序列化为 xml 时，其限定名称为 x：sst。 (继承自 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)