HeaderReference Класс

Определение

Пространство имен:

DocumentFormat.OpenXml.Wordprocessing

Сборка:

DocumentFormat.OpenXml.dll

Пакет:

DocumentFormat.OpenXml v3.0.1

Ссылка на заголовок.

Этот класс доступен в Office 2007 и более поздних версиях.

Когда объект сериализуется как xml, его полное имя — w:headerReference.

public class HeaderReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType

type HeaderReference = class
    inherit HeaderFooterReferenceType

Public Class HeaderReference
Inherits HeaderFooterReferenceType

Наследование

Object

OpenXmlElement

OpenXmlLeafElement

HeaderFooterReferenceType

HeaderReference

Комментарии

[ISO/IEC 29500-1 1 издание]

headerReference (Header Reference)

Этот элемент определяет один верхний колонтитул, который будет связан с текущим разделом документа. Ссылка на этот верхний колонтитул создается посредством атрибута id, который определяет явную связь с соответствующей частью верхнего колонтитула в пакете WordprocessingML.

Если тип отношения, указанного этим элементом, отличается от http://schemas.openxmlformats.org/officeDocument/2006/header или не указан либо для его атрибута TargetMode не задано значение Internal, то документ считается несоответствующим.

В каждом разделе документа может быть до трех разных типов заголовков:

• Верхний колонтитул первой страницы

• Верхний колонтитул нечетной страницы

• Верхний колонтитул четной страницы

Тип верхнего колонтитула, определяемый текущим элементов headerReference, определяется посредством атрибута type.

При отсутствии какого-либо типа верхнего колонтитула в данном разделе применяются следующие правила.

• Если для верхнего колонтитула первой страницы не определен headerReference и задан элемент titlePg, в этом случае верхний колонтитул первой страницы наследуется от предыдущего раздела; если это первый раздел документа, создается новый пустой верхний колонтитул. Если элемент titlePg не задан, верхний колонтитул первой страницы не отображается и на его месте будет использоваться верхний колонтитул нечетной страницы.

• Если для верхнего колонтитула четной страницы задан элемент headerReference и определен элемент evenAndOddHeaders, верхний колонтитул четной страницы наследуется от предыдущего раздела; если это первый раздел документа, создается новый пустой верхний колонтитул. Если элемент evenAndOddHeaders не задан, верхний колонтитул четной страницы не отображается и на его месте будет использоваться верхний колонтитул нечетной страницы.

• Если для верхнего колонтитула нечетной страницы задан элемент headerReference, верхний колонтитул четной страницы наследуется от предыдущего раздела; если это первый раздел документа, создается новый пустой верхний колонтитул.

[Пример: рассмотрим трехстраничный документ, в котором различные верхние колонтитулы первой, четной и нечетной страницы определены следующим образом:

f290aae3-2d0e-46b2-9a84-7e59757bc879

Этот документ определяет три заголовка, каждый из которых имеет связь из части документа с уникальным идентификатором связи, как показано в следующей разметке упаковки:

<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">  
  …  
  <Relationship Id="rId2" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" Target="header1.xml" />  
  <Relationship Id="rId3" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" Target="header2.xml" />  
  <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" Target="header3.xml" />  
  …  
</Relationships>  

Ссылка на эти связи создается в свойствах раздела с помощью следующего элемента WordprocessingML:

<w:sectPr>  
  …  
  <w:headerReference r:id="rId3" w:type="first" />  
  <w:headerReference r:id="rId5" w:type="default" />  
  <w:headerReference r:id="rId2" w:type="even" />  
  …  
</w:sectPr>  

Результирующий раздел должен использовать часть заголовка с идентификатором связи rId3 для первой страницы, часть заголовка с идентификатором связи rId2 для всех последующих четных страниц и часть заголовка с идентификатором связи rId5 для всех последующих нечетных страниц. конец примера

Родительские элементы
sectPr (§17.6.17); sectPr (§17.6.18)

[Примечание. Определение xml-схемы W3C для модели содержимого этого элемента (CT_HdrFtrRef) находится в §A.1. конечная заметка]

ISO/IEC29500: 2008.

Конструкторы

HeaderReference()

Инициализирует новый экземпляр класса HeaderReference.

Свойства

ChildElements	Возвращает все дочерние узлы текущего элемента. (Унаследовано от OpenXmlElement)
ExtendedAttributes	Возвращает все расширенные атрибуты (атрибуты, не определенные в схеме) текущего элемента. (Унаследовано от OpenXmlElement)
Features	IFeatureCollection Возвращает для текущего элемента. Эта коллекция компонентов будет доступна только для чтения, но будет наследовать компоненты от родительской части и пакета, если они доступны. (Унаследовано от OpenXmlElement)
FirstChild	Возвращает первый дочерний элемент элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlElement)
HasAttributes	Возвращает значение, указывающее, имеет ли текущий элемент какие-либо атрибуты. (Унаследовано от OpenXmlElement)
HasChildren	Возвращает значение, указывающее, содержит ли текущий элемент какие-либо дочерние элементы. (Унаследовано от OpenXmlLeafElement)
Id	Связь с частью Представляет следующий атрибут в схеме: r:id (Унаследовано от HeaderFooterReferenceType)
InnerText	Возвращает или задает объединенные значения узла и всех его дочерних элементов. (Унаследовано от OpenXmlElement)
InnerXml	Возвращает или задает разметку, представляющую только дочерние элементы текущего элемента. (Унаследовано от OpenXmlLeafElement)
LastChild	Возвращает последний дочерний элемент элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlElement)
LocalName	Возвращает локальное имя текущего элемента. (Унаследовано от OpenXmlElement)
MCAttributes	Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки. (Унаследовано от OpenXmlElement)
NamespaceDeclarations	Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен. (Унаследовано от OpenXmlElement)
NamespaceUri	Возвращает универсальный код ресурса (URI) пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
OpenXmlElementContext	Возвращает openXmlElementContext текущего элемента. (Унаследовано от OpenXmlElement)
OuterXml	Возвращает разметку, представляющую текущий элемент и все его дочерние элементы. (Унаследовано от OpenXmlElement)
Parent	Возвращает родительский элемент текущего элемента. (Унаследовано от OpenXmlElement)
Prefix	Возвращает префикс пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
Type	type Представляет следующий атрибут в схеме: w:type (Унаследовано от HeaderFooterReferenceType)
XmlQualifiedName	Возвращает полное имя текущего элемента. (Унаследовано от OpenXmlElement)
XName	Возвращает полное имя текущего элемента. (Унаследовано от OpenXmlElement)

Методы

AddAnnotation(Object)	Добавляет объект в список заметок текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
AddNamespaceDeclaration(String, String)	Добавляет объявление пространства имен в текущий узел. (Унаследовано от OpenXmlElement)
Ancestors()	Перечисляет все предки текущего элемента. (Унаследовано от OpenXmlElement)
Ancestors<T>()	Перечисляет только предки текущего элемента, имеющие указанный тип. (Унаследовано от OpenXmlElement)
Annotation(Type)	Получение первого объекта заметки указанного типа из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Annotation<T>()	Получение первого объекта заметки указанного типа из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Annotations(Type)	Возвращает коллекцию заметок с указанным типом для текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Annotations<T>()	Возвращает коллекцию заметок с указанным типом для текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Добавляет каждый элемент из списка элементов в конец списка дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
Append(OpenXmlElement[])	Добавляет каждый элемент из массива элементов в конец списка дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
AppendChild<T>(T)	Добавляет указанный элемент в конец списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlElement)
ClearAllAttributes()	Очищает все атрибуты, включая как известные, так и расширенные атрибуты. (Унаследовано от OpenXmlElement)
Clone()	Создает дубликат текущего узла. (Унаследовано от OpenXmlElement)
CloneNode(Boolean)	Создает дубликат этого узла.
Descendants()	Перечисляет все потомки текущего элемента. (Унаследовано от OpenXmlElement)
Descendants<T>()	Перечисление всех потомков текущего элемента типа T. (Унаследовано от OpenXmlElement)
Elements()	Перечисляет все дочерние элементы текущего элемента. (Унаследовано от OpenXmlElement)
Elements<T>()	Перечисляет только дочерние элементы текущего элемента, имеющие указанный тип. (Унаследовано от OpenXmlElement)
ElementsAfter()	Перечисляет все одноуровневые элементы, которые следуют за текущим элементом и имеют тот же родительский элемент, что и текущий элемент. (Унаследовано от OpenXmlElement)
ElementsBefore()	Перечисляет все одноуровневые элементы, которые предшествуют текущему элементу и имеют тот же родительский элемент, что и текущий элемент. (Унаследовано от OpenXmlElement)
GetAttribute(String, String)	Возвращает атрибут Open XML с указанным именем тега и URI пространства имен. (Унаследовано от OpenXmlElement)
GetAttributes()	Возвращает список, содержащий копию всех атрибутов. (Унаследовано от OpenXmlElement)
GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по дочерней коллекции. (Унаследовано от OpenXmlElement)
GetFirstChild<T>()	Находит первый дочерний элемент в типе T. (Унаследовано от OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Вставляет указанный элемент сразу после указанного ссылочного элемента. (Унаследовано от OpenXmlElement)
InsertAfterSelf<T>(T)	Вставляет указанный элемент сразу после текущего элемента. (Унаследовано от OpenXmlElement)
InsertAt<T>(T, Int32)	Вставляет указанный элемент по указанному индексу в список дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Вставляет указанный элемент непосредственно перед указанным ссылочным элементом. (Унаследовано от OpenXmlElement)
InsertBeforeSelf<T>(T)	Вставляет указанный элемент непосредственно перед текущим элементом. (Унаследовано от OpenXmlElement)
IsAfter(OpenXmlElement)	Определяет, отображается ли текущий элемент после указанного элемента в порядке документа. (Унаследовано от OpenXmlElement)
IsBefore(OpenXmlElement)	Определяет, отображается ли текущий элемент перед указанным элементом в порядке документа. (Унаследовано от OpenXmlElement)
LookupNamespace(String)	Разрешает префикс пространства имен в контексте текущего узла. (Унаследовано от OpenXmlElement)
LookupPrefix(String)	Находит соответствующий префикс для URI пространства имен в текущем элементе область. (Унаследовано от OpenXmlElement)
NextSibling()	Возвращает элемент OpenXmlElement, который сразу же следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
NextSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего OpenXmlElement. (Унаследовано от OpenXmlElement)
PrependChild<T>(T)	Вставляет указанный элемент в начало списка дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
PreviousSibling()	Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
PreviousSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Remove()	Удаляет текущий элемент из родительского элемента. (Унаследовано от OpenXmlElement)
RemoveAllChildren()	Удаляет все дочерние элементы текущего элемента. (Унаследовано от OpenXmlLeafElement)
RemoveAllChildren<T>()	Удалите все дочерние элементы текущего элемента типа T. (Унаследовано от OpenXmlElement)
RemoveAnnotations(Type)	Удаляет заметки указанного типа из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
RemoveAnnotations<T>()	Удаляет заметки с указанным типом из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
RemoveAttribute(String, String)	Удаляет атрибут из текущего элемента. (Унаследовано от OpenXmlElement)
RemoveChild<T>(T)	Удаляет указанный дочерний элемент из списка дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
RemoveNamespaceDeclaration(String)	Удаляет объявление пространства имен для указанного префикса. Ничего не удаляет, если нет префикса. (Унаследовано от OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Заменяет дочерний элемент другим дочерним элементом в списке дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
SetAttribute(OpenXmlAttribute)	Задает атрибут заданного элемента. Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute. (Унаследовано от OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Задает ряд атрибутов элемента . Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute. (Унаследовано от OpenXmlElement)
WriteTo(XmlWriter)	Сохраняет текущий узел в указанном xmlWriter. (Унаследовано от OpenXmlElement)

Явные реализации интерфейса

IEnumerable.GetEnumerator()	Ссылка на заголовок. Этот класс доступен в Office 2007 и более поздних версиях. Когда объект сериализуется как xml, его полное имя — w:headerReference. (Унаследовано от OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по дочерней коллекции. (Унаследовано от OpenXmlElement)