SharedStringTable Clase

Definición

Espacio de nombres:

DocumentFormat.OpenXml.Spreadsheet

Ensamblado:

DocumentFormat.OpenXml.dll

Paquete:

DocumentFormat.OpenXml v3.0.1

Tabla de cadenas compartidas.

Esta clase está disponible en Office 2007 y versiones posteriores.

Cuando el objeto se serializa como xml, su nombre completo es x:sst.

public class SharedStringTable : DocumentFormat.OpenXml.OpenXmlPartRootElement

type SharedStringTable = class
    inherit OpenXmlPartRootElement

Public Class SharedStringTable
Inherits OpenXmlPartRootElement

Herencia

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

SharedStringTable

Ejemplos

En el ejemplo de código siguiente se crea un documento de hoja de cálculo e se inserta un hipervínculo en la celda "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.  

Comentarios

[ISO/IEC 29500-1 1.ª edición]

sst (tabla de cadenas compartidas)

Este elemento es la raíz de la tabla de cadenas compartidas, que actúa como una colección de elementos de cadena individuales (si).

Elementos primarios
Elemento raíz del elemento de tabla de cadenas compartidas SpreadsheetML

Elementos secundarios	Subclause
extLst (Área de almacenamiento de datos de características futuras)	§18.2.10
si (elemento de cadena)	§18.4.8

Atributos	Descripción
count (Recuento de cadenas)	Entero que representa el recuento total de cadenas en el libro. Este recuento no incluye ningún número, solo cuenta el total de cadenas de texto en el libro. Este atributo es opcional a menos que se use uniqueCount , en cuyo caso es necesario. Los valores posibles para este atributo los define el tipo de datos unsignedInt del esquema XML W3C.
uniqueCount (recuento de cadenas único)	Entero que representa el recuento total de cadenas únicas en la tabla de cadenas compartidas. Una cadena es única incluso si es una copia de otra cadena, pero tiene un formato diferente aplicado en el nivel de caracteres. [Ejemplo: World, World y World. El recuento sería 3 y uniqueCount sería 2. Solo se mostraría una entrada para "World" en la tabla porque es la misma cadena, solo con un formato diferente aplicado en el nivel de celda (es decir, aplicado a toda la cadena de la celda). La cadena "World" obtendría una entrada única independiente en la tabla de cadenas compartidas porque tiene un formato diferente aplicado a caracteres específicos. Fin del ejemplo] Este atributo es opcional a menos que se use count , en cuyo caso es necesario. Los valores posibles para este atributo los define el tipo de datos unsignedInt del esquema XML W3C.

[Nota: La definición del esquema XML W3C del modelo de contenido de este elemento (CT_Sst) se encuentra en §A.2. Fin de la nota]

ISO/IEC29500: 2008.

Constructores

SharedStringTable()	Inicializa una nueva instancia de la clase SharedStringTable.
SharedStringTable(IEnumerable<OpenXmlElement>)	Inicializa una nueva instancia de la clase SharedStringTable con los elementos secundarios especificados.
SharedStringTable(OpenXmlElement[])	Inicializa una nueva instancia de la clase SharedStringTable con los elementos secundarios especificados.
SharedStringTable(String)	Inicializa una nueva instancia de la clase SharedStringTable a partir de XML externo.

Propiedades

ChildElements	Obtiene todos los nodos secundarios del elemento actual. (Heredado de OpenXmlElement)
Count	Recuento de cadenas Representa el atributo siguiente en el esquema: count
ExtendedAttributes	Obtiene todos los atributos extendidos (atributos no definidos en el esquema) del elemento actual. (Heredado de OpenXmlElement)
Features	Obtiene un IFeatureCollection para el elemento actual. Esta colección de características será de solo lectura, pero heredará características de su elemento primario y paquete si está disponible. (Heredado de OpenXmlElement)
FirstChild	Obtiene el primer elemento secundario del elemento OpenXmlElement actual. (Heredado de OpenXmlCompositeElement)
HasAttributes	Obtiene un valor que indica si el elemento actual tiene atributos. (Heredado de OpenXmlElement)
HasChildren	Obtiene un valor que indica si el elemento actual tiene algún elemento secundario. (Heredado de OpenXmlCompositeElement)
InnerText	Obtiene o establece los valores concatenados del nodo actual y todos sus elementos secundarios. (Heredado de OpenXmlCompositeElement)
InnerXml	Obtiene o establece el marcado que representa solo los nodos secundarios del nodo actual. (Heredado de OpenXmlCompositeElement)
LastChild	Obtiene el último elemento secundario del elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement de este tipo. (Heredado de OpenXmlCompositeElement)
LocalName	Obtiene el nombre local del elemento actual. (Heredado de OpenXmlElement)
MCAttributes	Obtiene o establece los atributos de compatibilidad de marcado. Devuelve null si no se definen atributos de compatibilidad de marcado para el elemento actual. (Heredado de OpenXmlElement)
NamespaceDeclarations	Obtiene todas las declaraciones de espacio de nombres definidas en el elemento actual. Devuelve un enumerador vacío si no hay ninguna declaración de espacio de nombres. (Heredado de OpenXmlElement)
NamespaceUri	Obtiene el URI del espacio de nombres del elemento actual. (Heredado de OpenXmlElement)
OpenXmlElementContext	Obtiene el Objeto OpenXmlElementContext del elemento actual. (Heredado de OpenXmlElement)
OpenXmlPart	Obtiene la parte asociada al árbol DOM. Devuelve null cuando el árbol DOM no está asociado a una parte. (Heredado de OpenXmlPartRootElement)
OuterXml	Obtiene el marcado que representa el elemento actual y todos sus elementos secundarios. (Heredado de OpenXmlElement)
Parent	Obtiene el elemento primario del elemento actual. (Heredado de OpenXmlElement)
Prefix	Obtiene el prefijo de espacio de nombres del elemento actual. (Heredado de OpenXmlElement)
SharedStringTablePart	Obtiene el objeto SharedStringTablePart asociado a este elemento.
UniqueCount	Recuento de cadenas único Representa el atributo siguiente en el esquema: uniqueCount
XmlQualifiedName	Obtiene el nombre completo del elemento actual. (Heredado de OpenXmlElement)
XName	Obtiene el nombre completo del elemento actual. (Heredado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Agrega un objeto a la lista de anotaciones del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Agrega el elemento especificado al elemento si es un elemento secundario conocido. Esto agrega el elemento en la ubicación correcta según el esquema. (Heredado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Agrega una declaración de espacio de nombres al nodo actual. (Heredado de OpenXmlElement)
Ancestors()	Enumera todos los antecesores del elemento actual. (Heredado de OpenXmlElement)
Ancestors<T>()	Enumera solo los antecesores del elemento actual que tienen el tipo especificado. (Heredado de OpenXmlElement)
Annotation(Type)	Obtenga el primer objeto de anotación del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotation<T>()	Obtenga el primer objeto de anotación del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotations(Type)	Obtiene una colección de anotaciones con el tipo especificado para el elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotations<T>()	Obtiene una colección de anotaciones con el tipo especificado para el elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Anexa cada elemento de una lista de elementos al final de la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
Append(OpenXmlElement[])	Anexa cada elemento de una matriz de elementos al final de la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
AppendChild<T>(T)	Anexa el elemento especificado al final de la lista de nodos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
ClearAllAttributes()	Borra todos los atributos, incluidos los atributos conocidos y los atributos extendidos. (Heredado de OpenXmlElement)
Clone()	Crea un duplicado del nodo actual. (Heredado de OpenXmlElement)
CloneNode(Boolean)	Crea un duplicado de este nodo.
Descendants()	Enumera todos los descendientes del elemento actual. (Heredado de OpenXmlElement)
Descendants<T>()	Enumera todos los descendientes del elemento actual del tipo T. (Heredado de OpenXmlElement)
Elements()	Enumera todos los elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
Elements<T>()	Enumera solo los elementos secundarios del elemento actual que tienen el tipo especificado. (Heredado de OpenXmlElement)
ElementsAfter()	Enumera todos los elementos del mismo nivel que siguen el elemento actual y tienen el mismo elemento primario que el elemento actual. (Heredado de OpenXmlElement)
ElementsBefore()	Enumera todos los elementos del mismo nivel que preceden al elemento actual y tienen el mismo elemento primario que el elemento actual. (Heredado de OpenXmlElement)
GetAttribute(String, String)	Obtiene un atributo Open XML con el nombre de etiqueta y el URI de espacio de nombres especificados. (Heredado de OpenXmlElement)
GetAttributes()	Obtiene una lista que contiene una copia de todos los atributos. (Heredado de OpenXmlElement)
GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)
GetFirstChild<T>()	Busca el primer elemento secundario en el tipo T. (Heredado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserta el elemento especificado inmediatamente después del elemento de referencia especificado. (Heredado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserta el elemento especificado inmediatamente después del elemento actual. (Heredado de OpenXmlElement)
InsertAt<T>(T, Int32)	Inserta el elemento especificado en el índice especificado de los elementos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserta el elemento especificado inmediatamente antes del elemento de referencia especificado. (Heredado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserta el elemento especificado inmediatamente antes del elemento actual. (Heredado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina si el elemento actual aparece después de un elemento especificado en el orden del documento. (Heredado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina si el elemento actual aparece antes que un elemento especificado en el orden del documento. (Heredado de OpenXmlElement)
Load(SharedStringTablePart)	Carga el DOM desde SharedStringTablePart
LookupNamespace(String)	Resuelve el prefijo de espacio de nombres en el contexto del nodo actual. (Heredado de OpenXmlElement)
LookupPrefix(String)	Busca el prefijo correspondiente para un uri de espacio de nombres en el ámbito del elemento actual. (Heredado de OpenXmlElement)
NextSibling()	Obtiene el elemento OpenXmlElement que sigue inmediatamente al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement siguiente. (Heredado de OpenXmlElement)
NextSibling<T>()	Obtiene el elemento OpenXmlElement con el tipo especificado que sigue al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement siguiente. (Heredado de OpenXmlElement)
PrependChild<T>(T)	Inserta el elemento especificado al principio de la lista de nodos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
PreviousSibling()	Obtiene el elemento OpenXmlElement que precede inmediatamente al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic ) si no hay ningún elemento OpenXmlElement anterior. (Heredado de OpenXmlElement)
PreviousSibling<T>()	Obtiene el elemento OpenXmlElement con el tipo especificado que precede al objeto OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement anterior. (Heredado de OpenXmlElement)
Reload()	Vuelve a cargar el contenido de la pieza en un árbol DOM de Open XML. Este método se puede llamar varias veces y cada vez que se llama, se volverá a cargar el árbol y se abandonarán los cambios anteriores en el árbol. (Heredado de OpenXmlPartRootElement)
Remove()	Quita el elemento actual de su elemento primario. (Heredado de OpenXmlElement)
RemoveAllChildren()	Quita todos los elementos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Quite todos los elementos secundarios del elemento actual que son de tipo T. (Heredado de OpenXmlElement)
RemoveAnnotations(Type)	Quita las anotaciones del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
RemoveAnnotations<T>()	Quita las anotaciones con el tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
RemoveAttribute(String, String)	Quita el atributo del elemento actual. (Heredado de OpenXmlElement)
RemoveChild<T>(T)	Quita el elemento secundario especificado. (Heredado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Quita la declaración de espacio de nombres para el prefijo especificado. No quita nada si no hay ningún prefijo. (Heredado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Reemplaza uno de los elementos secundarios del elemento actual por otro elemento OpenXmlElement. (Heredado de OpenXmlCompositeElement)
Save()	Guarda los datos del árbol DOM de nuevo en el elemento. Se puede llamar a este método varias veces y cada vez que se llama, se vaciará la secuencia. (Heredado de OpenXmlPartRootElement)
Save(SharedStringTablePart)	Guarda el DOM en SharedStringTablePart.
Save(Stream)	Guarda el árbol DOM en la secuencia especificada. (Heredado de OpenXmlPartRootElement)
SetAttribute(OpenXmlAttribute)	Establece un atributo en el elemento especificado. Si el atributo es un atributo conocido, se establece el valor del atributo. Si el atributo es un atributo extendido, el atributo "openxmlAttribute" se agrega a la lista de atributos extendidos. (Heredado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Establece una serie de atributos en el elemento . Si un atributo es un atributo conocido, se establece el valor del atributo. Si un atributo es un atributo extendido, el atributo "openxmlAttribute" se agrega a la lista de atributos extendidos. (Heredado de OpenXmlElement)
WriteTo(XmlWriter)	Guarda el nodo actual en el objeto XmlWriter especificado. (Heredado de OpenXmlPartRootElement)

Implementaciones de interfaz explícitas

IEnumerable.GetEnumerator()	Tabla de cadenas compartidas. Esta clase está disponible en Office 2007 y versiones posteriores. Cuando el objeto se serializa como xml, su nombre completo es x:sst. (Heredado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)