Captions Clase

Definición

Espacio de nombres:

DocumentFormat.OpenXml.Wordprocessing

Ensamblado:

DocumentFormat.OpenXml.dll

Paquete:

DocumentFormat.OpenXml v3.0.1

Configuración del título.

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

Cuando el objeto se serializa como xml, su nombre completo es w:captions.

public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Captions = class
    inherit OpenXmlCompositeElement

Public Class Captions
Inherits OpenXmlCompositeElement

Herencia

Object

OpenXmlElement

OpenXmlCompositeElement

Captions

Comentarios

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

captions (Caption Settings)

Este elemento especifica la presencia de información sobre los títulos en un documento WordprocessingML determinado. Esta información se divide en dos componentes:

• El elemento secundario subtítulo define el formato de un único tipo de subtítulo que se agregará automáticamente al documento.

• El elemento secundario autoCaptions define automáticamente los tipos de objetos a los que se aplicará automáticamente un formato de subtítulo.

Esta información debe usarse para determinar los títulos que se agregan automáticamente a los objetos cuando se insertan en un documento WordprocessingML. [Nota: Esta configuración se suele omitir a menos que se especifique en la plantilla predeterminada de una aplicación. Fin de la nota]

[Ejemplo: considere el diagrama siguiente que ilustra un documento WordprocessingML que contiene una tabla que se ha etiquetado con un subtítulo:

9512a3b0-3be8-461e-b333-2dafe873ea54

En este diagrama, la tabla contenida en el documento WordprocessingML se ha etiquetado insertando un subtítulo debajo de la tabla que consta de la cadena Table seguida de un número decimal. Este formato de subtítulo insertado automáticamente se especifica mediante el siguiente esquema WordprocessingML:

<w:captions>  
  <w:caption w:name="Table" w:pos="below" w:numFmt="decimal" />   
</w:captions>  

Aquí, el elemento captions especifica la presencia de uno o varios formatos de subtítulo en un documento WordprocessingML determinado con su elemento secundario subtítulo. En concreto, el elemento secundario subtítulo especifica un único tipo de subtítulo que se va a usar en el documento WordprocessingML. Fin del ejemplo]

La subtitulación aprovecha los campos (§17.16.5) para etiquetar objetos con referencia a:

• Otros objetos con subtítulos dentro de un documento determinado

• Otros objetos con subtítulos dentro del mismo capítulo de un documento determinado (cuando se agregan números de capítulo especificando el atributo chapNum en el tipo subtítulo. Un capítulo es una sección de texto dentro de un documento WordprocessingML precedida por contenido con un estilo especificado por para delimitar los capítulos de los documentos. Solo se puede especificar un estilo como el estilo utilizado para un único tipo de subtítulo para demarcar capítulos en un documento. Un capítulo termina justo encima de la siguiente instancia de contenido con el estilo usado para demarcar capítulos.

[Ejemplo: considere el diagrama siguiente:

ca416e21-0d37-4bbe-9fbc-0ad6b52b74da

83cd18d0-32ad-47ac-8475-614beb06001a

En este diagrama se muestra un documento WordprocessingML que contiene dos capítulos, cada uno de los cuales contiene dos tablas etiquetadas con títulos. El estilo asociado a la demarcación de capítulos se ha aplicado a las cadenas: Capítulo 1 - FY02 y Capítulo 2 - FY03 en este documento. En concreto, el estilo usado para demarcar capítulos es el estilo con su atributo styleID igual a Heading2, tal como especifica el valor del atributo de encabezado de WordprocessingML para el formato subtítulo:

<w:caption w:name="Table" w:pos="below" w:chapNum="1" w:heading="2" w:numFmt="upperLetter" w:sep="8212" />   

En otras palabras, el WordprocessingML anterior se puede usar para etiquetar objetos (en este caso, tablas) insertados en un documento WordprocessingML determinado generado por una aplicación con un subtítulo que consta de: la cadena Table seguida de un número decimal correspondiente al número de capítulo en el que está presente la tabla, un guion y una letra mayúscula en inglés correspondiente al índice de la tabla determinada dentro del capítulo determinado. Fin del ejemplo]

[Nota: WordprocessingML está diseñado para que el elemento subtítulo se pueda usar junto con las aplicaciones para proporcionar una experiencia de subtítulos dinámica. En otras palabras, una aplicación puede usar WordprocessingML en el ejemplo anterior para insertar automáticamente un subtítulo que consta de la cadena Table seguido de un campo de número decimal incrementado debajo de las tablas cuando las tablas se insertan en un documento WordprocessingML tal como se define en el elemento autoCaption (§17.15.1.7). Fin de la nota]

Elementos primarios
settings (§17.15.1.78)

Elementos secundarios	Subclause
autoCaptions (configuración de subtítulos automático)	§17.15.1.8
subtítulo (definición de tipo de título único)	§17.15.1.16

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

ISO/IEC29500: 2008.

Constructores

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

Propiedades

ChildElements	Obtiene todos los nodos secundarios del elemento actual. (Heredado de OpenXmlElement)
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)
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)
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)
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)
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)
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 OpenXmlElement)

Implementaciones de interfaz explícitas

IEnumerable.GetEnumerator()	Configuración del título. Esta clase está disponible en Office 2007 y versiones posteriores. Cuando el objeto se serializa como xml, su nombre completo es w:captions. (Heredado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)