StructuredDocumentTag

StructuredDocumentTag class

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

Para obtener más información, visite elEtiquetas de documentos estructurados o control de contenido artículo de documentación.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

Constructores

NombreDescripción
StructuredDocumentTag(DocumentBaseSdtTypeMarkupLevel)Inicializa una nueva instancia delEtiqueta de documento estructurado clase.

Propiedades

NombreDescripción
Appearance { get; set; }Obtiene/establece la apariencia de una etiqueta de documento estructurado.
BuildingBlockCategory { get; set; }Especifica la categoría del bloque de creación para esteTED node. No puede sernulo .
BuildingBlockGallery { get; set; }Especifica el tipo de bloque de creación para esteTED . No puede sernulo .
CalendarType { get; set; }Especifica el tipo de calendario para esteTED . El valor predeterminado esDefault
Checked { get; set; }Obtiene/establece el estado actual de la casilla de verificaciónTED . El valor predeterminado para esta propiedad esFALSO .
Color { get; set; }Obtiene o establece el color de la etiqueta del documento estructurado.
ContentsFont { get; }Formato de fuente que se aplicará al texto ingresadoTED .
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 sernulo . Las fechas para inglés (EE. UU.) son “mm/dd/yyyy”
DateDisplayLocale { get; set; }Permite configurar/obtener el formato de idioma para la fecha que se muestra en esteTED .
DateStorageFormat { get; set; }Obtiene/establece el formato en el que se almacena la fecha para una fecha SDT cuandoTEDestá 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 ingresadoTED .
FirstChild { get; }Obtiene el primer hijo del nodo.
FullDate { get; set; }Especifica la fecha y hora completas ingresadas por última vez en esteTED .
HasChildNodes { get; }Devolucionesverdadero si este nodo tiene nodos secundarios.
Id { get; }Especifica una identificación numérica persistente única de solo lectura para estoTED.
override IsComposite { get; }Devolucionesverdadero ya que este nodo puede tener nodos secundarios.
IsShowingPlaceholderText { get; set; }Especifica si el contenido de esteTEDse interpretará como que contiene texto de marcador de posición (a diferencia del contenido de texto normal dentro del SDT).
IsTemporary { get; set; }Especifica si estoTED 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 esteTED ocurre en el árbol del documento.
ListItems { get; }ObtieneSdtListItemCollection asociado con estoTED .
LockContentControl { get; set; }Cuando se establece enverdadero , esta propiedad prohibirá a un usuario eliminar estoTED .
LockContents { get; set; }Cuando se establece enverdadero , esta propiedad prohibirá a un usuario editar el contenido de esteTED .
Multiline { get; set; }Especifica si estoTED permite múltiples líneas de texto.
NextSibling { get; }Obtiene el nodo que sigue inmediatamente a este nodo.
override NodeType { get; }DevolucionesStructuredDocumentTag .
ParentNode { get; }Obtiene el padre inmediato de este nodo.
Placeholder { get; }Obtiene elBuildingBlockque 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 element o elIsShowingPlaceholderText elemento esverdadero .
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 unRange objeto que representa la parte de un documento contenido en este nodo.
SdtType { get; }Obtiene el tipo de estoEtiqueta 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 se puedenulo .
Title { get; set; }Especifica el nombre descriptivo asociado con esteTED . No puede sernulo .
WordOpenXML { get; }Obtiene una cadena que representa el XML contenido dentro del nodo en elFlatOpc formato.
WordOpenXMLMinimal { get; }Obtiene una cadena que representa el XML contenido dentro del nodo en elFlatOpc format. A diferencia delWordOpenXMLpropiedad, este método genera un documento simplificado que excluye cualquier parte no relacionada con el contenido.
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

NombreDescripció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()Crea un navegador que se puede utilizar para atravesar y leer nodos.
GetAncestor(NodeType)Obtiene el primer ancestro del especificadoNodeType .
GetAncestor(Type)Obtiene el primer antepasado 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 cada iteración de 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(NodeNode)Inserta el nodo especificado inmediatamente después del nodo de referencia especificado.
InsertBefore(NodeNode)Inserta el nodo especificado inmediatamente antes del nodo de referencia especificado.
NextPreOrder(Node)Obtiene el siguiente nodo según el algoritmo transversal del árbol de pedidos anticipados.
PrependChild(Node)Agrega el nodo especificado al principio de la lista de nodos secundarios para este nodo.
PreviousPreOrder(Node)Obtiene el nodo anterior según el algoritmo transversal del árbol de pedidos anticipados.
Remove()Se elimina 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 de documentos.
RemoveSmartTags()Elimina todoSmartTagnodos descendientes del nodo actual.
SelectNodes(string)Selecciona una lista de nodos que coinciden con la expresión XPath.
SelectSingleNode(string)Selecciona el primeroNode 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 usando las opciones de guardado especificadas.

Observaciones

Las etiquetas de documentos estructurados (SDT) permiten incorporar 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 aparecer 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 filas de una tabla, como elemento secundario de unaTable nodo.
  • Nivel de celda: entre celdas de una fila de la tabla, como elemento secundario de unRow nodo.
  • Nivel en línea: entre el contenido en línea interno, como hijo 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 - Referencia a un estilo en el documento por 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;

    Console.WriteLine(sdt.WordOpenXMLMinimal);

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

Ver también