Caption Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Definição de tipo de legenda única.

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

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

public class Caption : DocumentFormat.OpenXml.OpenXmlLeafElement

type Caption = class
    inherit OpenXmlLeafElement

Public Class Caption
Inherits OpenXmlLeafElement

Herança

Object

OpenXmlElement

OpenXmlLeafElement

Caption

Comentários

[ISO/IEC 29500-1 1st Edition]

caption (Single Caption Type Definition)

Esse elemento especifica o conteúdo e o posicionamento das legendas que podem ser usadas para rotular automaticamente objetos em um documento WordprocessingML. Uma legenda é uma cadeia de caracteres que rotula um objeto incluído em um documento WordprocessingML e normalmente consiste em uma cadeia de caracteres mais um campo que numera esse item em uma coleção de objetos semelhantes.

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

1bf50059-fbbd-45cc-85a8-f26871414afb

Neste diagrama, a tabela contida no documento WordprocessingML foi rotulada inserindo uma legenda abaixo da tabela que consiste na cadeia de caracteres Table seguida por um campo cujo resultado é um número decimal. As configurações que produziram automaticamente essa forma de legenda são especificadas usando o seguinte fragmento WordprocessingML:

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

O elemento de legenda especifica os parâmetros da legenda resultante a ser usada para rotular automaticamente o conteúdo dentro do documento WordprocessingML. Especificamente, os atributos name e numFmt especificam que as legendas desse tipo de legenda inseridas no documento WordprocessingML fornecido devem consistir na cadeia de caracteres Table seguida por um campo de número decimal incremental. Além disso, o atributo pos especifica que essas legendas devem ser colocadas abaixo do objeto que são usadas para rotular.

O WordprocessingML foi projetado de forma que o elemento de legenda possa ser usado em conjunto com aplicativos para fornecer uma experiência de legenda dinâmica. Em outras palavras, um aplicativo pode usar o WordprocessingML no exemplo acima para inserir automaticamente uma legenda que consiste na cadeia de caracteres Table seguida por um campo de número decimal incremental abaixo das tabelas quando as tabelas são inseridas em um documento WordprocessingML, conforme definido pelo elemento autoCaption (§17.15.1.7). exemplo de término]

Elementos pai
legendas (§17.15.1.17)

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

ISO/IEC29500: 2008.

Construtores

Nome	Description
Caption()	Inicializa uma nova instância da classe Caption.

Propriedades

Nome	Description
ChapterNumber	Incluir número do capítulo no campo de legenda Representa o seguinte atributo no esquema: w:chapNum
ChildElements	Obtém todos os nós filhos 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. Retorna null (Nothing no Visual Basic) se não existe esse elemento OpenXmlElement. (Herdado de OpenXmlElement)
HasAttributes	Obtém um valor que indica se o elemento atual tem algum atributo. (Herdado de OpenXmlElement)
HasChildren	Obtém um valor que indica se o elemento atual tem algum elemento filho. (Herdado de OpenXmlLeafElement)
Heading	Estilo para títulos de capítulo Representa o seguinte atributo no esquema: w:heading
InnerText	Obtém ou define os valores concatenados do nó e de todos os seus filhos. (Herdado de OpenXmlElement)
InnerXml	Obtém ou define a marcação que representa apenas elementos filho do elemento atual. (Herdado de OpenXmlLeafElement)
LastChild	Obtém o último filho do elemento OpenXmlElement. Retorna null (Nothing no Visual Basic) se não existe esse elemento OpenXmlElement. (Herdado de OpenXmlElement)
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 null se nenhum atributo de compatibilidade de marcação for definido para o elemento atual. (Herdado de OpenXmlElement)
Name	Nome do Tipo de Legenda Representa o seguinte atributo no esquema: w:name
NamespaceDeclarations	Obtém todas as declarações de namespace definidas no elemento atual. Retorna 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)
NoLabel	Não incluir nome na legenda Representa o seguinte atributo no esquema: w:noLabel
NumberFormat	Formato de numeração de legenda Representa o seguinte atributo no esquema: w:numFmt
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)
Position	Posicionamento automático das legendas Representa o seguinte atributo no esquema: w:pos
Prefix	Obtém o prefixo do namespace do elemento atual. (Herdado de OpenXmlElement)
Separator	Número do capítulo/Item Separador de índice Representa o seguinte atributo no esquema: w:sep
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

Nome	Description
AddAnnotation(Object)	Adiciona um objeto à lista de anotações do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
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 ao final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Anexa o elemento especificado ao final da lista de nós filhos do elemento atual. (Herdado de OpenXmlElement)
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>()	Enumere 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 especificado e o URI do namespace. (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 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 OpenXmlElement)
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 na lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente antes do elemento de referência especificado. (Herdado de OpenXmlElement)
InsertBeforeSelf<T>(T)	Insere o elemento especificado imediatamente antes do elemento atual. (Herdado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina se o elemento atual aparece após 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 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 null (Nothing 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. Retorna null (Nothing no Visual Basic) se não houver próximo OpenXmlElement. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
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 OpenXmlLeafElement)
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 da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de namespace para o prefixo especificado. Não removerá nada se não houver prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um elemento filho por outro elemento filho na lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
SetAttribute(OpenXmlAttribute)	Define um atributo para o elemento especificado. Se o atributo for 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 vários atributos para o elemento. Se um atributo for 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

Nome	Description
IEnumerable.GetEnumerator()	Definição de tipo de legenda única. Esta classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é w:legenda. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)