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

Nombre	Descripción
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel)	Inicializa una nueva instancia delEtiqueta 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 del bloque de construcción para esteTED node. No se puedenulo .
BuildingBlockGallery { get; set; }	Especifica el tipo de bloque de construcció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 ingresado enTED .
Count { get; }	Obtiene el número de hijos inmediatos de este nodo.
CustomNodeId { get; set; }	Especifica un identificador de nodo personalizado.
DateDisplayFormat { get; set; }	Cadena que representa el formato en que se muestran las fechas.
DateDisplayLocale { get; set; }	Permite establecer/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 de una SDT de fecha cuandoTED 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 enTED .
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; }	Devuelveverdadero si este nodo tiene nodos secundarios.
Id { get; }	Especifica un identificador numérico persistente único de solo lectura para esteTED.
override IsComposite { get; }	Devuelveverdadero ya que este nodo puede tener nodos secundarios.
IsShowingPlaceholderText { get; set; }	Especifica si el contenido de esteTED se 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á que un usuario elimine estoTED .
LockContents { get; set; }	Cuando se establece enverdadero , esta propiedad prohibirá que un usuario edite el contenido de esteTED .
Multiline { get; set; }	Especifica si estoTED permite múltiples líneas de texto.
NextSibling { get; }	Obtiene el nodo inmediatamente siguiente a este nodo.
override NodeType { get; }	DevuelveStructuredDocumentTag .
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 SDT está vacío, el elemento XML mapeado asociado está vacío como se especifica medianteXmlMapping elemento o elIsShowingPlaceholderText elemento esverdadero .
PlaceholderName { get; set; }	Obtiene o establece el nombre delBuildingBlock contiene texto de marcador de posición.
PreviousSibling { get; }	Obtiene el nodo inmediatamente anterior a este nodo.
Range { get; }	Devuelve unRangeobjeto que representa la porción de un documento que está contenida 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 delWordOpenXML propiedad, 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

Nombre	Descripción
override Accept(DocumentVisitor)	Acepta un visitante.
override AcceptEnd(DocumentVisitor)	Acepta un visitante por visitar el final de StructuredDocumentTag.
override AcceptStart(DocumentVisitor)	Acepta un visitante por visitar el inicio de StructuredDocumentTag.
AppendChild<T>(T)	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 puede utilizarse para recorrer y leer nodos.
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 nodo secundario N 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<T>(T, Node)	Inserta el nodo especificado inmediatamente después del nodo de referencia especificado.
InsertBefore<T>(T, Node)	Inserta el nodo especificado inmediatamente antes del nodo de referencia especificado.
NextPreOrder(Node)	Obtiene el siguiente nodo según el algoritmo de recorrido del árbol de preorden.
PrependChild<T>(T)	Agrega el nodo especificado al comienzo de la lista de nodos secundarios para este nodo.
PreviousPreOrder(Node)	Obtiene el nodo anterior según el algoritmo de recorrido del árbol de preorden.
Remove()	Se elimina a sí mismo del padre.
RemoveAllChildren()	Elimina todos los nodos secundarios del nodo actual.
RemoveChild<T>(T)	Elimina el nodo secundario especificado.
RemoveSelfOnly()	Elimina únicamente este nodo SDT, pero conserva 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 primerNode 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 en una cadena en el formato especificado.
ToString(SaveOptions)	Exporta el contenido del nodo en 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 con using 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 unaShape nodo.
• Nivel de fila: entre filas de una tabla, como hijo de unaTable nodo.
• A nivel de celda: entre celdas en una fila de tabla, como elemento secundario de unaRow nodo.
• Nivel en línea: entre el contenido en línea dentro, como un 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 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

• class CompositeNode
• interface IStructuredDocumentTag
• espacio de nombres Aspose.Words.Markup
• asamblea Aspose.Words