SubDocumentReference Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Âncora para Local de Subdocumento.

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

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

C#

public class SubDocumentReference : DocumentFormat.OpenXml.Wordprocessing.RelationshipType

Herança

Object

OpenXmlElement

OpenXmlLeafElement

RelationshipType

SubDocumentReference

Comentários

[ISO/IEC 29500-1 1st Edition]

subDoc (Anchor for Subdocument Location)

Esse elemento especifica um local dentro de um documento master para a inserção do conteúdo de um subdocumento especificado. O conteúdo do subdocumento especificado deve aparecer no local especificado no documento master, conforme necessário, mas permanecerá parte do arquivo separado especificado pelo local do subdocumento. O local do subdocumento deve ser especificado pela relação cujo atributo Id corresponde ao atributo id nesse elemento.

Se o tipo de relação da relação especificada por esse elemento não estiver , não http://schemas.openxmlformats.org/officeDocument/2006/subDocumentestiver presente ou não tiver um valor de atributo TargetMode de Externo, o documento será considerado não conforme.

Quando um subdocumento é exibido no local especificado no documento master, a lógica a seguir determina como os estilos e a formatação do subdocumento e do documento master associado devem ser tratados:

• Toda a formatação direta no subdocumento é mantida.

• Para cada estilo em cada subdocumento:

Se existir um estilo com o mesmo valor de atributo styleId no documento master, exiba o conteúdo do subdocumento usando o estilo no documento master.

Caso contrário, importe o estilo para o documento master e exiba o conteúdo usando o estilo original.

Se um subdocumento subsequente também contiver um estilo com o mesmo valor de atributo styleId, o estilo deste último será ignorado e o conteúdo será exibido usando a versão do estilo importado para o documento master.

[Exemplo: considere um livro composto por três capítulos, dois dos quais foram divididos em subdocumentos da seguinte maneira (o retângulo vermelho indica os limites do conteúdo de cada subdocumento):

35b1894c-1477-4693-aeec-f0baccc69f21

O documento master resultante consistiria em seu próprio conteúdo wordprocessingML, bem como âncoras de subdocumento nos locais apropriados:

XML

<w:body>  
  <w:p>  
    …    <w:r>  
      <w:t>My Book</w:t>  
    </w:r>  
  </w:p>  
  <w:p>  
    <w:r>  
      <w:t>Once upon a time…</w:t>  
    </w:r>  
  </w:p>  
  <w:p>  
    <w:subDoc r:id="subDocRel1" />  
  </w:p>  
  <w:p>  
    <w:subDoc r:id="subDocRel2" />  
  </w:p>  
  <w:sectPr>  
    …  </w:sectPr>  
</w:body>  

Os dois elementos subDoc especificam que os subdocumentos direcionados pelas relações com uma ID de subDocRel1 e subDocRel2 devem ser importados nessa ordem após o conteúdo dos dois primeiros parágrafos de conteúdo. Examinando o conteúdo do item da parte de relação correspondente, podemos ver os destinos dessas relações:

XML

<Relationships … >  
  …  <Relationship Id="subDocRel1" TargetMode="External" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/subDocument" Target="Chapter1.docx" />  
  <Relationship Id="subDocRel2" TargetMode="External" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/subDocument" Target="Chapter2.docx" />  
  …</Relationships>  

O item da parte de relação correspondente mostra que os dois arquivos a serem importados estão localizados no mesmo local que o arquivo e o nome atuais Chapter1.docx e Chapter2.docx respectivamente. exemplo final]

Elementos pai
bdo (§17.3.2.3); customXml (§17.5.1.3); dir (§17.3.2.8); fldSimple (§17.16.19); hiperlink (§17.16.22); p (§17.3.1.22); sdtContent (§17.5.2.36); smartTag (§17.5.1.9)

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

ISO/IEC29500: 2008.

Construtores

SubDocumentReference()

Inicializa uma nova instância da classe SubDocumentReference.

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. Retornará nulo (Nada no Visual Basic) se não houver esse elemento OpenXmlElement. (Herdado de OpenXmlElement)
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 OpenXmlLeafElement)
Id	Relação com Parte Representa o seguinte atributo no esquema: r:id (Herdado de RelationshipType)
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. Retornará nulo (Nada no Visual Basic) se não houver 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 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)
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 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>()	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 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 é 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 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 do prefixo especificado. Não removerá nada se não houver nenhum 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 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()	Âncora para Local de Subdocumento. Essa classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é w:subDoc. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)

Aplica-se a