Captions Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Definições da Legenda.

Esta classe está disponível no Office 2007 e superior.

Quando o objeto é serializado como xml, o nome qualificado é w:captions.

public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Captions = class
    inherit OpenXmlCompositeElement

Public Class Captions
Inherits OpenXmlCompositeElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

Captions

Comentários

[ISO/IEC 29500-1 1st Edition]

captions (Caption Settings)

Este elemento especifica a presença de informações sobre legendas num determinado documento do WordprocessingML. Estas informações estão divididas em dois componentes:

• O elemento subordinado legenda define o formato de um único tipo de legenda a adicionar automaticamente ao documento.

• O elemento subordinado autoCaptions define os tipos de objetos aos quais um formato de legenda deve ser aplicado automaticamente.

Estas informações devem ser utilizadas para determinar as legendas que são adicionadas automaticamente aos objetos quando são inseridas num documento do WordprocessingML. [Nota: esta definição é normalmente ignorada, a menos que seja especificada no modelo predefinido de uma aplicação. nota de fim]

[Exemplo: considere o diagrama abaixo que ilustra um documento do WordprocessingML que contém uma tabela que foi etiquetada com um legenda:

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

Neste diagrama, a tabela contida no documento wordprocessingML foi etiquetada ao inserir um legenda abaixo da tabela que consiste na cadeia Tabela seguida de um número decimal. Este formato de legenda inserido automaticamente é especificado com o seguinte WordprocessingML:

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

Aqui, o elemento captions especifica a presença de um ou mais formatos de legenda num determinado documento wordprocessingML com o elemento subordinado legenda. Especificamente, o elemento subordinado legenda especifica um único tipo de legenda a utilizar no documento wordprocessingML. exemplo final]

A legendagem tira partido dos campos (}17.16.5) para etiquetar objetos com referência a:

• Outros objetos com legendas dentro de um determinado documento

• Outros objetos com legendas dentro do mesmo capítulo num determinado documento (quando os números de capítulo são adicionados ao especificar o atributo chapNum no tipo de legenda. Um capítulo é uma secção de texto dentro de um documento do WordprocessingML precedido por conteúdo com um estilo que foi especificado por para demarcar capítulos em documentos. Apenas um estilo pode ser especificado como o estilo utilizado para um único tipo de legenda para demarcar capítulos num documento. Um capítulo termina imediatamente acima da instância seguinte do conteúdo com o estilo utilizado para demarcar capítulos.

[Exemplo: considere o diagrama abaixo:

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

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

Este diagrama ilustra um documento do WordprocessingML que contém dois capítulos, cada um com duas tabelas etiquetadas com legendas. O estilo associado à demarcação de capítulos foi aplicado às cadeias: Capítulo 1 - FY02 e Capítulo 2 - FY03 neste documento. Especificamente, o estilo utilizado para demarcar capítulos é o estilo com o respetivo atributo styleID igual a Heading2, conforme especificado pelo valor do atributo de cabeçalho do WordprocessingML para o formato legenda:

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

Por outras palavras, o WordprocessingML acima pode ser utilizado para etiquetar objetos (neste caso, tabelas) inseridos num determinado documento wordprocessingML gerado por uma aplicação com uma legenda consistindo em: a tabela de cadeia seguida de um número decimal correspondente ao número do capítulo em que a tabela está presente, um hífen e uma letra em inglês maiúscula correspondente ao índice da tabela especificado no capítulo especificado. exemplo final]

[Nota: o WordprocessingML foi concebido de modo a que o elemento legenda possa ser utilizado em conjunto com aplicações para proporcionar uma experiência de legendagem dinâmica. Por outras palavras, uma aplicação pode utilizar o WordprocessingML no exemplo acima para inserir automaticamente um legenda que consiste na cadeia Tabela seguida de um campo de número decimal incrementante abaixo das tabelas quando as tabelas são inseridas num documento wordprocessingML, conforme definido pelo elemento autoCaption (\17.15.1.7). nota de fim]

Elementos pai
definições (}17.15.1.78)

Elementos filho	Subclautilizar
preenchimentos automáticos (Definições de Legendagem Automática)	§17.15.1.8
legenda (Definição de Tipo de Legenda Única)	§17.15.1.16

[Nota: a definição de Esquema XML W3C do modelo de conteúdo deste elemento (CT_Captions) está localizada em {A.1. nota de fim]

ISO/IEC29500: 2008.

Construtores

Captions()	Inicializa uma nova instância da classe Legendas.
Captions(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Legendas com os elementos subordinados especificados.
Captions(OpenXmlElement[])	Inicializa uma nova instância da classe Legendas com os elementos subordinados especificados.
Captions(String)	Inicializa uma nova instância da classe Legendas a partir de XML externo.

Propriedades

ChildElements	Obtém todos os nós subordinados do elemento atual. (Herdado de OpenXmlElement)
ExtendedAttributes	Obtém todos os atributos expandidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
Features	Obtém um IFeatureCollection para o elemento atual. Esta coleção de funcionalidades será só de leitura, mas herdará as funcionalidades da parte principal e do pacote, se disponível. (Herdado de OpenXmlElement)
FirstChild	Obtém o primeiro elemento subordinado do elemento OpenXmlElement atual. (Herdado de OpenXmlCompositeElement)
HasAttributes	Obtém um valor que indica se o elemento atual tem atributos. (Herdado de OpenXmlElement)
HasChildren	Obtém um valor que indica se o elemento atual tem elementos subordinados. (Herdado de OpenXmlCompositeElement)
InnerText	Obtém ou define os valores concatenados do nó atual e de todos os respetivos subordinados. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós subordinados do nó atual. (Herdado de OpenXmlCompositeElement)
LastChild	Obtém o último elemento subordinado do elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir esse elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
LocalName	Obtém o nome local do elemento atual. (Herdado de OpenXmlElement)
MCAttributes	Obtém ou define os atributos de compatibilidade de markup. Devolve nulo se não forem definidos atributos de compatibilidade de markup para o elemento atual. (Herdado de OpenXmlElement)
NamespaceDeclarations	Obtém todas as declarações de espaço de nomes definidas no elemento atual. Devolve um enumerador vazio se não existir nenhuma declaração de espaço de nomes. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do espaço de nomes do elemento atual. (Herdado de OpenXmlElement)
OpenXmlElementContext	Obtém o OpenXmlElementContext do elemento atual. (Herdado de OpenXmlElement)
OuterXml	Obtém a marcação que representa o elemento atual e todos os respetivos elementos subordinados. (Herdado de OpenXmlElement)
Parent	Obtém o elemento principal do elemento atual. (Herdado de OpenXmlElement)
Prefix	Obtém o prefixo de espaço de nomes do elemento atual. (Herdado de OpenXmlElement)
XmlQualifiedName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)
XName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotações do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adiciona o elemento especificado ao elemento se for um subordinado conhecido. Esta ação adiciona o elemento na localização correta de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de espaço de nomes ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os predecessores do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os predecessores do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations(Type)	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations<T>()	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Acrescenta cada elemento de uma lista de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao fim da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos expandidos. (Herdado de OpenXmlElement)
Clone()	Cria um duplicado do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria um duplicado deste nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumerar todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os subordinados do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos do elemento colateral que seguem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos do elemento colateral que precedem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da etiqueta especificado e o URI do espaço de nomes. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento subordinado no tipo T. (Herdado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente após o elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Insere o elemento especificado imediatamente após o elemento atual. (Herdado de OpenXmlElement)
InsertAt<T>(T, Int32)	Insere o elemento especificado no índice especificado dos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente antes do elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Insere o elemento especificado imediatamente antes do elemento atual. (Herdado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina se o elemento atual aparece depois de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual aparece antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
LookupNamespace(String)	Resolve o prefixo do espaço de nomes no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um URI de espaço de nomes no âmbito do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement seguinte. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir um OpenXmlElement seguinte. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Remove()	Remove o elemento atual do respetivo elemento principal. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos subordinados do elemento atual que são do tipo T. (Herdado de OpenXmlElement)
RemoveAnnotations(Type)	Remove as anotações do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAnnotations<T>()	Remove as anotações com o tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAttribute(String, String)	Remove o atributo do elemento atual. (Herdado de OpenXmlElement)
RemoveChild<T>(T)	Remove o elemento subordinado especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de espaço de nomes para o prefixo especificado. Não remove nada se não existir um prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos subordinados do elemento atual por outro elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Define um atributo para o elemento especificado. Se o atributo for um atributo conhecido, o valor do atributo é definido. Se o atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define vários atributos para o elemento . Se um atributo for um atributo conhecido, o valor do atributo é definido. Se um atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Guarda o nó atual no XmlWriter especificado. (Herdado de OpenXmlElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Definições da Legenda. Esta classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, o nome qualificado é w:captions. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devolve um enumerador que itera através da coleção subordinada. (Herdado de OpenXmlElement)