Captions Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Configurações de legenda.

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

Quando o objeto é serializado como xml, seu 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)

Esse elemento especifica a presença de informações sobre legendas em um determinado documento WordprocessingML. Essas informações são divididas em dois componentes:

• O elemento filho legenda define o formato para um único tipo de legenda a ser adicionado automaticamente ao documento.

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

Essas informações devem ser usadas para determinar as legendas que são adicionadas automaticamente aos objetos quando são inseridas em um documento WordprocessingML. [Observação: essa configuração normalmente é ignorada, a menos que seja especificada no modelo padrão de um aplicativo. nota final]

[Exemplo: considere o diagrama abaixo ilustrando um documento WordprocessingML contendo uma tabela que foi rotulada com um legenda:

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

Neste diagrama, a tabela contida no documento WordprocessingML foi rotulada inserindo um legenda abaixo da tabela que consiste na tabela de cadeia de caracteres seguida por um número decimal. Esse formato de legenda inserido automaticamente é especificado usando 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 legenda em um determinado documento WordprocessingML com seu elemento filho legenda. Especificamente, o elemento filho legenda especifica um único tipo de legenda a ser usado no documento WordprocessingML. exemplo final]

A legendagem aproveita campos (§17.16.5) para rotular objetos com referência a:

• Outros objetos legendados em um determinado documento

• Outros objetos legendados no mesmo capítulo em um determinado documento (quando os números do capítulo são adicionados especificando o atributo chapNum no tipo legenda. Um capítulo é uma seção de texto dentro de um documento WordprocessingML precedido pelo conteúdo com um estilo especificado por para demarcar capítulos em documentos. Somente um estilo pode ser especificado como o estilo usado para um único tipo de legenda para demarcar capítulos em um documento. Um capítulo termina imediatamente acima da próxima instância de conteúdo com o estilo usado para demarcar capítulos.

[Exemplo: considere o diagrama abaixo:

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

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

Este diagrama mostra um documento WordprocessingML contendo dois capítulos, cada um contendo duas tabelas rotuladas com legendas. O estilo associado à demarcação de capítulo foi aplicado às cadeias de caracteres: Capítulo 1 – FY02 e Capítulo 2 – FY03 neste documento. Especificamente, o estilo usado para demarcar capítulos é o estilo com seu atributo styleID igual a Heading2 conforme especificado pelo valor de atributo de título 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" />   

Em outras palavras, o WordprocessingML acima pode ser usado para rotular objetos (nesse caso, tabelas) inseridos em um determinado documento WordprocessingML gerado por um aplicativo com um legenda que consiste em: a tabela de cadeia de caracteres seguida por um número decimal correspondente ao número de capítulo em que a tabela está presente, um hifen e uma letra em inglês maiúscula correspondente ao índice da tabela determinada no capítulo determinado. exemplo final]

[Observação: o WordprocessingML foi projetado para que o elemento legenda possa ser usado em conjunto com aplicativos para fornecer uma experiência dinâmica de legendagem. Em outras palavras, um aplicativo pode usar o WordprocessingML no exemplo acima para inserir automaticamente um legenda que consiste na Tabela de cadeia de caracteres seguida por um campo de número decimais incrementante abaixo das tabelas quando as tabelas são inseridas em um documento WordprocessingML conforme definido pelo elemento autoCaption (§17.15.1.7). nota final]

Elementos pai
configurações (§17.15.1.78)

Elementos filho	Subclause
autoCaptions (Configurações automáticas de legenda)	§17.15.1.8
legenda (definição de tipo de legenda única)	§17.15.1.16

[Observação: a definição de Esquema XML W3C do modelo de conteúdo desse elemento (CT_Captions) está localizada em §A.1. nota final]

ISO/IEC29500: 2008.

Construtores

Captions()	Inicializa uma nova instância da classe Captions.
Captions(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Captions com os elementos filho especificados.
Captions(OpenXmlElement[])	Inicializa uma nova instância da classe Captions com os elementos filho especificados.
Captions(String)	Inicializa uma nova instância da classe Captions do XML externo.

Propriedades

ChildElements	Obtém todos os nós filho do elemento atual. (Herdado de OpenXmlElement)
ExtendedAttributes	Obtém todos os atributos estendidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
Features	Obtém um IFeatureCollection para o elemento atual. Essa coleção de recursos será somente leitura, mas herdará recursos de sua parte pai e pacote, se disponível. (Herdado de OpenXmlElement)
FirstChild	Obtém o primeiro filho 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 filho. (Herdado de OpenXmlCompositeElement)
InnerText	Obtém ou define os valores concatenados do nó atual e de todos os seus filhos. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós filho do nó atual. (Herdado de OpenXmlCompositeElement)
LastChild	Obtém o último filho do elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver 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 marcação. Retorna nulo se nenhum atributo de compatibilidade de marcação for definido para o elemento atual. (Herdado de OpenXmlElement)
NamespaceDeclarations	Obtém todas as declarações de namespace definidas no elemento atual. Retornará um enumerador vazio se não houver nenhuma declaração de namespace. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do namespace 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 seus elementos filho. (Herdado de OpenXmlElement)
Parent	Obtém o elemento pai do elemento atual. (Herdado de OpenXmlElement)
Prefix	Obtém o prefixo namespace 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 ele for uma criança conhecida. Isso adiciona o elemento no local correto de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de namespace ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os ancestrais do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os ancestrais do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado 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 final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos até o final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao final da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos estendidos. (Herdado de OpenXmlElement)
Clone()	Cria uma duplicata do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria uma duplicata desse nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumera todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os filhos do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os filhos do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos irmãos que seguem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos irmãos que precedem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da marca e o URI do namespace especificados. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento filho 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 filhos 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 é exibido após um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual é exibido antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
LookupNamespace(String)	Resolve o prefixo namespace no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um uri de namespace no escopo do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum próximo elemento OpenXmlElement. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver o próximo OpenXmlElement. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic ) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Remove()	Remove o elemento atual de seu pai. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos filho do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos filho 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 filho especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de namespace do prefixo especificado. Não removerá nada se não houver nenhum prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos filho 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 será definido. Se o atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define uma série de atributos para o elemento. Se um atributo for um atributo conhecido, o valor do atributo será definido. Se um atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Salva o nó atual no XmlWriter especificado. (Herdado de OpenXmlElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Configurações de legenda. Essa classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é w:captions. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)