Header Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Cabeçalho.

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

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

public class Header : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Header = class
    inherit OpenXmlPartRootElement

Public Class Header
Inherits OpenXmlPartRootElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Header

Comentários

[ISO/IEC 29500-1 1st Edition]

hdr (Header)

Esse elemento especifica o conteúdo de um único cabeçalho para uso em uma ou mais seções de um documento WordprocessingML.

Dentro do elemento hdr, o conteúdo do elemento é semelhante ao conteúdo do elemento body (§17.2.2) e contém o que é chamado de marcação no nível do bloco – marcação que pode existir como um elemento irmão para parágrafos em um documento wordprocessingML.

[Exemplo: considere o seguinte documento simples de uma página com um cabeçalho:

88f5cf14-b052-4a97-ab3f-7e52ce0c959f

Este documento define um cabeçalho com o cabeçalho de texto. O conteúdo do cabeçalho é armazenado em uma parte de Cabeçalho exclusiva. O cabeçalho resultante é representado pelo seguinte WordprocessingML:

<w:hdr>  
  <w:p>  
    <w:r>  
      <w:t>  
Header</w:t>  
    </w:r>  
  </w:p>  
</w:hdr>  

Como cabeçalhos são contêineres de conteúdo de nível de bloco, todos os elementos de nível de bloco podem ser usados dentro deles. Neste exemplo específico, o conteúdo é um parágrafo único. exemplo final]

[Exemplo: considere um documento de três páginas mais complexo com cabeçalhos de página diferentes primeiro, ímpares e até mesmo definidos:

678d902e-6383-428e-a110-0095e3dc75bf

Este documento define três cabeçalhos armazenados em três partes de cabeçalho diferentes. Os cabeçalhos resultantes são representados pelo seguinte WordprocessingML:

Parte do cabeçalho da primeira página:

<w:hdr>  
  <w:p>  
    <w:r>  
      <w:t>  
First</w:t>  
    </w:r>  
  </w:p>  
</w:hdr>  

Até mesmo a parte do cabeçalho da página:

<w:hdr>  
  <w:p>  
    <w:r>  
      <w:t>  
Even</w:t>  
    </w:r>  
  </w:p>  
</w:hdr>  

Parte do cabeçalho de página ímpar:

<w:hdr>  
  <w:p>  
    <w:r>  
      <w:t>  
Odd</w:t>  
    </w:r>  
  </w:p>  
</w:hdr>  

exemplo final]

Elementos pai
Elemento raiz da parte cabeçalho wordprocessingML

Elementos filho	Subclause
altChunk (âncora para conteúdo externo importado)	§17.17.2.1
bookmarkEnd (Fim do Indicador)	§17.13.6.1
bookmarkStart (Início do Indicador)	§17.13.6.2
commentRangeEnd (Fim do Intervalo de Âncora de Comentários)	§17.13.4.3
commentRangeStart (Início do Intervalo de Âncora de Comentários)	§17.13.4.4
customXml (elemento XML personalizado de nível de bloco)	§17.5.1.6
customXmlDelRangeEnd (extremidade de exclusão de marcação XML personalizada)	§17.13.5.4
customXmlDelRangeStart (início da exclusão de marcação XML personalizada)	§17.13.5.5
customXmlInsRangeEnd (extremidade de inserção de marcação XML personalizada)	§17.13.5.6
customXmlInsRangeStart (Início da Inserção de Marcação XML Personalizada)	§17.13.5.7
customXmlMoveFromRangeEnd (extremidade de origem de movimentação de marcação XML personalizada)	§17.13.5.8
customXmlMoveFromRangeStart (início da origem da movimentação de marcação XML personalizada)	§17.13.5.9
customXmlMoveToRangeEnd (Marcação XML Personalizada Mover Local de Destino)	§17.13.5.10
customXmlMoveToRangeStart (início da localização de destino de movimentação de marcação XML personalizada)	§17.13.5.11
del (Conteúdo de Execução Excluído)	§17.13.5.14
ins (Conteúdo de Execução Inserido)	§17.13.5.18
moveFrom (mover conteúdo de execução de origem)	§17.13.5.22
moveFromRangeEnd (Mover contêiner de localização de origem – fim)	§17.13.5.23
moveFromRangeStart (Mover contêiner de localização de origem – iniciar)	§17.13.5.24
moveTo (mover conteúdo de execução de destino)	§17.13.5.25
moveToRangeEnd (mover contêiner de localização de destino – fim)	§17.13.5.27
moveToRangeStart (Mover contêiner de localização de destino – iniciar)	§17.13.5.28
oMath (Matemática do Office)	§22.1.2.77
oMathPara (Parágrafo de Matemática do Office)	§22.1.2.78
p (Parágrafo)	§17.3.1.22
permEnd (fim da permissão de intervalo)	§17.13.7.1
permStart (Início da Permissão de Intervalo)	§17.13.7.2
proofErr (âncora de erro de revisão)	§17.13.8.1
sdt (marca de documento estruturado no nível do bloco)	§17.5.2.29
tbl (Tabela)	§17.4.38

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

ISO/IEC29500: 2008.

Construtores

Header()	Inicializa uma nova instância da classe Cabeçalho.
Header(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Cabeçalho com os elementos filho especificados.
Header(OpenXmlElement[])	Inicializa uma nova instância da classe Cabeçalho com os elementos filho especificados.
Header(String)	Inicializa uma nova instância da classe Cabeçalho 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)
HeaderPart	Obtém o HeaderPart associado a esse elemento.
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)
OpenXmlPart	Obtém a parte associada à árvore DOM. Ele retorna nulo quando a árvore DOM não está associada a uma parte. (Herdado de OpenXmlPartRootElement)
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)
Load(HeaderPart)	Carrega o DOM da Parte de Cabeçalho
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)
Reload()	Recarrega o conteúdo da parte em uma árvore DOM Open XML. Esse método pode ser chamado várias vezes e cada vez que for chamado, a árvore será recarregada e as alterações anteriores na árvore são abandonadas. (Herdado de OpenXmlPartRootElement)
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)
Save()	Salva os dados na árvore DOM de volta para a parte. Esse método pode ser chamado várias vezes e cada vez que for chamado, o fluxo será liberado. (Herdado de OpenXmlPartRootElement)
Save(HeaderPart)	Salva o DOM na Parte de Cabeçalho.
Save(Stream)	Salva a árvore DOM no fluxo especificado. (Herdado de OpenXmlPartRootElement)
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 OpenXmlPartRootElement)

Implantações explícitas de interface

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