StructuredDocumentTag

StructuredDocumentTag class

Representa una etiqueta de documento estructurado (SDT o control de contenido) en un documento.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Constructores

Nombre Descripción
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel) Inicializa una nueva instancia del Etiqueta de documento estructurado clase.

Propiedades

Nombre Descripción
Appearance { get; set; } Obtiene/establece la apariencia de una etiqueta de documento estructurado.
BuildingBlockCategory { get; set; } Especifica la categoría de bloque de construcción para este SDT nodo. No puede ser nulo.
BuildingBlockGallery { get; set; } Especifica el tipo de bloque de construcción para este SDT . No puede ser nulo.
CalendarType { get; set; } Especifica el tipo de calendario para este SDT . El valor predeterminado esDefault
Checked { get; set; } Obtiene/establece el estado actual de la casilla de verificación SDT . El valor por defecto de esta propiedad es false.
ChildNodes { get; } Obtiene todos los nodos secundarios inmediatos de este nodo.
Color { get; set; } Obtiene o establece el color de la etiqueta del documento estructurado.
ContentsFont { get; } Formato de fuente que se aplicará al texto ingresado en SDT .
Count { get; } Obtiene el número de hijos inmediatos de este nodo.
CustomNodeId { get; set; } Especifica el identificador de nodo personalizado.
DateDisplayFormat { get; set; } Cadena que representa el formato en el que se muestran las fechas. No puede ser nulo. Las fechas para inglés (EE. UU.) son “mm/dd/yyyy”
DateDisplayLocale { get; set; } Permite establecer/obtener el formato de idioma para la fecha que se muestra en este SDT .
DateStorageFormat { get; set; } Obtiene/establece el formato en el que se almacena la fecha para una fecha SDT cuando el SDT está vinculado a un nodo XML en el almacén de datos del documento. El valor predeterminado esDateTime
virtual Document { get; } Obtiene el documento al que pertenece este nodo.
EndCharacterFont { get; } Formato de fuente que se aplicará al último carácter del texto ingresado en SDT .
FirstChild { get; } Obtiene el primer hijo del nodo.
FullDate { get; set; } Especifica la fecha y la hora completas que se ingresaron por última vez en este SDT .
HasChildNodes { get; } Devuelve verdadero si este nodo tiene nodos secundarios.
Id { get; } Especifica un Id. numérico persistente único de solo lectura para este SDT.
override IsComposite { get; } Devuelve verdadero ya que este nodo puede tener nodos secundarios.
IsShowingPlaceholderText { get; set; } Especifica si el contenido de este SDT se interpretará que contiene marcador de posición text (a diferencia de los contenidos de texto regulares dentro de la SDT).
IsTemporary { get; set; } Especifica si este SDT se eliminará del documento WordProcessingML cuando se modifique su contenido .
LastChild { get; } Obtiene el último hijo del nodo.
Level { get; } Obtiene el nivel en el que este SDT ocurre en el árbol del documento.
ListItems { get; } ObtieneSdtListItemCollection asociado con este SDT .
LockContentControl { get; set; } Cuando se establece en verdadero, esta propiedad prohibirá que un usuario elimine este SDT .
LockContents { get; set; } Cuando se establece en verdadero, esta propiedad prohibirá que un usuario edite el contenido de este SDT .
Multiline { get; set; } Especifica si este SDT permite múltiples líneas de texto.
NextSibling { get; } Obtiene el nodo que sigue inmediatamente a este nodo.
override NodeType { get; } Devoluciones NodeType.StructuredDocumentTag .
ParentNode { get; } Obtiene el padre inmediato de este nodo.
Placeholder { get; } Obtiene elBuildingBlock que contiene texto de marcador de posición que debe mostrarse cuando el contenido de esta ejecución de SDT está vacío, el elemento XML asignado asociado está vacío como se especifica mediante elXmlMapping elemento o elIsShowingPlaceholderText elemento es verdadero.
PlaceholderName { get; set; } Obtiene o establece el Nombre delBuildingBlock que contiene texto de marcador de posición.
PreviousSibling { get; } Obtiene el nodo inmediatamente anterior a este nodo.
Range { get; } Devuelve un Rango objeto que representa la parte de un documento que está contenido en este nodo.
SdtType { get; } Obtiene el tipo de este Etiqueta de documento estructurado .
Style { get; set; } Obtiene o establece el Estilo de la etiqueta del documento estructurado.
StyleName { get; set; } Obtiene o establece el nombre del estilo aplicado a la etiqueta del documento estructurado.
Tag { get; set; } Especifica una etiqueta asociada con el nodo SDT actual. No puede ser nulo.
Title { get; set; } Especifica el nombre descriptivo asociado con este SDT . No puede ser nulo.
WordOpenXML { get; } Obtiene una cadena que representa el XML contenido dentro del nodo en elFlatOpc formato.
XmlMapping { get; } Obtiene un objeto que representa la asignación de esta etiqueta de documento estructurado a datos XML en una parte XML personalizada del documento actual.

Métodos

Nombre Descripción
override Accept(DocumentVisitor) Acepta un visitante.
AppendChild(Node) Agrega el nodo especificado al final de la lista de nodos secundarios para este nodo.
Clear() Borra el contenido de esta etiqueta de documento estructurado y muestra un marcador de posición si está definido.
Clone(bool) Crea un duplicado del nodo.
CreateNavigator() Reservado para uso del sistema. IXPathNavigable.
GetAncestor(NodeType) Obtiene el primer ancestro del especificadoNodeType .
GetAncestor(Type) Obtiene el primer ancestro del tipo de objeto especificado.
GetChild(NodeType, int, bool) Devuelve un enésimo nodo secundario que coincide con el tipo especificado.
GetChildNodes(NodeType, bool) Devuelve una colección activa de nodos secundarios que coinciden con el tipo especificado.
GetEnumerator() Proporciona soporte para la iteración de cada estilo sobre los nodos secundarios de este nodo.
override GetText() Obtiene el texto de este nodo y de todos sus hijos.
IndexOf(Node) Devuelve el índice del nodo secundario especificado en la matriz de nodos secundarios.
InsertAfter(Node, Node) Inserta el nodo especificado inmediatamente después del nodo de referencia especificado.
InsertBefore(Node, Node) Inserta el nodo especificado inmediatamente antes del nodo de referencia especificado.
NextPreOrder(Node) Obtiene el siguiente nodo de acuerdo con el algoritmo de recorrido del árbol de pedido previo.
PrependChild(Node) Agrega el nodo especificado al principio de la lista de nodos secundarios para este nodo.
PreviousPreOrder(Node) Obtiene el nodo anterior de acuerdo con el algoritmo de recorrido del árbol de pedido previo.
Remove() Se elimina a sí mismo del padre.
RemoveAllChildren() Elimina todos los nodos secundarios del nodo actual.
RemoveChild(Node) Elimina el nodo secundario especificado.
RemoveSelfOnly() Elimina solo este nodo SDT, pero mantiene su contenido dentro del árbol del documento.
RemoveSmartTags() Elimina todoSmartTag nodos descendientes del nodo actual.
SelectNodes(string) Selecciona una lista de nodos que coinciden con la expresión XPath.
SelectSingleNode(string) Selecciona el primer nodo que coincide con la expresión XPath.
SetCheckedSymbol(int, string) Establece el símbolo utilizado para representar el estado marcado de un control de contenido de casilla de verificación.
SetUncheckedSymbol(int, string) Establece el símbolo utilizado para representar el estado no marcado de un control de contenido de casilla de verificación.
ToString(SaveFormat) Exporta el contenido del nodo a una cadena en el formato especificado.
ToString(SaveOptions) Exporta el contenido del nodo a una cadena utilizando las opciones de guardado especificadas.

Observaciones

Las etiquetas de documentos estructurados (SDT) permiten incorporar la semántica definida por el cliente, así como su comportamiento y apariencia en un documento.

En esta versión, Aspose.Words proporciona una serie de métodos y propiedades públicos para manipular el comportamiento y el contenido deStructuredDocumentTag . La asignación de nodos SDT a paquetes XML personalizados dentro de un documento se puede realizar usando elXmlMapping propiedad.

StructuredDocumentTag puede ocurrir en un documento en los siguientes lugares:

  • Nivel de bloque: entre párrafos y tablas, como hijo de unBody ,HeaderFooter , Comment ,Footnote o unShape nodo.
  • Nivel de fila: entre las filas de una tabla, como hijo de unaTable nodo.
  • Nivel de celda: entre las celdas de una fila de la tabla, como hijo de unaRow nodo.
  • Nivel en línea: entre el contenido en línea dentro, como elemento secundario de unParagraph.
  • Anidado dentro de otroStructuredDocumentTag.

Ejemplos

Muestra cómo trabajar con estilos para elementos de control de contenido.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// A continuación se muestran dos formas de aplicar un estilo del documento a una etiqueta de documento estructurado.
// 1 - Aplicar un objeto de estilo de la colección de estilos del documento:
Style quoteStyle = doc.Styles[StyleIdentifier.Quote];
StructuredDocumentTag sdtPlainText =
    new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Inline) { Style = quoteStyle };

// 2 - Hacer referencia a un estilo en el documento por su nombre:
StructuredDocumentTag sdtRichText =
    new StructuredDocumentTag(doc, SdtType.RichText, MarkupLevel.Inline) { StyleName = "Quote" };

builder.InsertNode(sdtPlainText);
builder.InsertNode(sdtRichText);

Assert.AreEqual(NodeType.StructuredDocumentTag, sdtPlainText.NodeType);

NodeCollection tags = doc.GetChildNodes(NodeType.StructuredDocumentTag, true);

foreach (Node node in tags)
{
    StructuredDocumentTag sdt = (StructuredDocumentTag)node;

    Assert.AreEqual(StyleIdentifier.Quote, sdt.Style.StyleIdentifier);
    Assert.AreEqual("Quote", sdt.StyleName);
}

Ver también