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 (область хранения данных о будущих компонентах)	§18.2.10
si (строковый элемент)	§18.4.8

Атрибуты	Описание
count (string count)	Целое число, представляющее общее количество строк в книге. Это число не включает числа, оно подсчитывает только общее количество текстовых строк в книге. Этот атрибут необязателен, если не используется uniqueCount , и в этом случае он является обязательным. Возможные значения для этого атрибута определены в типе данных unsignedInt схемы W3C XML.
uniqueCount (число уникальных строк)	Целое число, представляющее общее количество уникальных строк в общей таблице строк. Строка уникальна, даже если она является копией другой строки, но на уровне символов применяется другое форматирование. [Пример: World, World и World. Число будет равно 3, а значение uniqueCount — 2. Только одна запись для "World" будет отображаться в таблице, так как она является одной и той же строкой, только с другим форматированием, примененным на уровне ячейки (т. е. применяется ко всей строке в ячейке). Строка "World" получит отдельную уникальную запись в общей строковой таблице, так как к определенным символам применяется другое форматирование. конец примера] Этот атрибут является необязательным, если не используется счетчик . В этом случае он является обязательным. Возможные значения для этого атрибута определены в типе данных unsignedInt схемы W3C XML.

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

ISO/IEC29500: 2008.

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

SharedStringTable()	Инициализирует новый экземпляр класса SharedStringTable.
SharedStringTable(IEnumerable<OpenXmlElement>)	Инициализирует новый экземпляр класса SharedStringTable указанными дочерними элементами.
SharedStringTable(OpenXmlElement[])	Инициализирует новый экземпляр класса SharedStringTable указанными дочерними элементами.
SharedStringTable(String)	Инициализирует новый экземпляр класса SharedStringTable из внешнего XML-кода.

Свойства

ChildElements	Возвращает все дочерние узлы текущего элемента. (Унаследовано от OpenXmlElement)
Count	Число строк Представляет следующий атрибут в схеме: count
ExtendedAttributes	Возвращает все расширенные атрибуты (атрибуты, не определенные в схеме) текущего элемента. (Унаследовано от OpenXmlElement)
Features	IFeatureCollection Возвращает для текущего элемента. Эта коллекция компонентов будет доступна только для чтения, но будет наследовать компоненты от родительской части и пакета, если они доступны. (Унаследовано от OpenXmlElement)
FirstChild	Получает первый дочерний элемент текущего элемента OpenXmlElement. (Унаследовано от OpenXmlCompositeElement)
HasAttributes	Возвращает значение, указывающее, имеет ли текущий элемент какие-либо атрибуты. (Унаследовано от OpenXmlElement)
HasChildren	Возвращает значение, указывающее, содержит ли текущий элемент какие-либо дочерние элементы. (Унаследовано от OpenXmlCompositeElement)
InnerText	Возвращает или задает объединенные значения текущего узла и всех его дочерних элементов. (Унаследовано от OpenXmlCompositeElement)
InnerXml	Возвращает или задает разметку, представляющую только дочерние узлы текущего узла. (Унаследовано от OpenXmlCompositeElement)
LastChild	Возвращает последний дочерний элемент текущего элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlCompositeElement)
LocalName	Возвращает локальное имя текущего элемента. (Унаследовано от OpenXmlElement)
MCAttributes	Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки. (Унаследовано от OpenXmlElement)
NamespaceDeclarations	Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен. (Унаследовано от OpenXmlElement)
NamespaceUri	Возвращает универсальный код ресурса (URI) пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
OpenXmlElementContext	Возвращает openXmlElementContext текущего элемента. (Унаследовано от OpenXmlElement)
OpenXmlPart	Возвращает часть, связанную с деревом DOM. Он возвращает значение NULL, если дерево DOM не связано с частью. (Унаследовано от 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)	Возвращает атрибут Open XML с указанным именем тега и URI пространства имен. (Унаследовано от 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)	Загружает DOM из SharedStringTablePart
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)	Вставляет указанный элемент в начало списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
PreviousSibling()	Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
PreviousSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Reload()	Перезагружает содержимое части в дерево DOM Open XML. Этот метод можно вызвать несколько раз, и при каждом вызове дерево будет перезагружено, а предыдущие изменения в дереве будут отменены. (Унаследовано от 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)