Captions Класс

Определение

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

DocumentFormat.OpenXml.Wordprocessing

Сборка:

DocumentFormat.OpenXml.dll

Пакет:

DocumentFormat.OpenXml v3.0.1

Параметры субтитров.

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

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

public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Captions = class
    inherit OpenXmlCompositeElement

Public Class Captions
Inherits OpenXmlCompositeElement

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

Object

OpenXmlElement

OpenXmlCompositeElement

Captions

Комментарии

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

captions (Caption Settings)

Этот элемент указывает наличие сведений о субтитрах в заданном документе WordprocessingML. Эти сведения делятся на два компонента:

• Дочерний элемент подпись определяет формат для одного типа подпись, который будет автоматически добавлен в документ.

• Дочерний элемент autoCaptions определяет типы объектов, к которым автоматически применяется формат подпись.

Эти сведения следует использовать для определения субтитров, которые автоматически добавляются к объектам при их вставке в документ WordprocessingML. [Примечание. Этот параметр обычно игнорируется, если он не указан в шаблоне приложения по умолчанию. конечная заметка]

[Пример. Рассмотрим приведенную ниже схему, иллюстрируя документ WordprocessingML, содержащий таблицу, помеченную подпись:

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

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

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

Здесь элемент субтитров указывает наличие одного или нескольких форматов подпись в данном документе WordprocessingML с его дочерним элементом подпись. В частности, дочерний элемент подпись указывает один тип подпись, который будет использоваться в документе WordprocessingML. конец примера

Субтитры используют поля (§17.16.5) для маркировки объектов со ссылкой на:

• Другие объекты с субтитрами в заданном документе

• Другие объекты с субтитрами в пределах одной главы в данном документе (при добавлении номеров глав путем определения атрибута chapNum в типе подпись. Глава — это раздел текста в документе WordprocessingML, перед которым предшествует содержимое со стилем, заданным для демаркации глав в документах. В качестве стиля, используемого для одного типа подпись для демаркации глав в документе, можно указать только один стиль. Глава заканчивается непосредственно над следующим экземпляром содержимого со стилем, используемым для демаркации глав.

[Пример. Рассмотрим следующую схему:

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

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

На этой схеме показан документ WordprocessingML, содержащий две главы, каждая из которых содержит две таблицы с подписями. Стиль, связанный с демаркацией главы, был применен к строкам: глава 1 — FY02 и глава 2 — FY03 в этом документе. В частности, стиль, используемый для демаркации глав, представляет собой стиль с атрибутом styleID, равным Заголовку 2, как указано в значении атрибута заголовка WordprocessingML для формата подпись:

<w:caption w:name="Table" w:pos="below" w:chapNum="1" w:heading="2" w:numFmt="upperLetter" w:sep="8212" />   

Иными словами, приведенный выше объект WordprocessingML можно использовать для маркировки объектов (в данном случае таблиц), вставленных в данный документ WordprocessingML, созданный приложением с подпись, состоящим из: строки Table, за которой следует десятичное число, соответствующее номеру главы, в котором присутствует таблица, дефис и заглавная буква на английском языке, соответствующие индексу данной таблицы в указанной главе. конец примера

[Примечание. WordprocessingML разработан таким образом, что элемент подпись можно использовать в сочетании с приложениями для обеспечения динамического создания субтитров. Другими словами, приложение может использовать WordprocessingML в приведенном выше примере для автоматической вставки подпись, состоящей из строки Table, за которой следует добавочное поле десятичного числа под таблицами, когда таблицы вставляются в документ WordprocessingML, как определено элементом autoCaption (§17.15.1.7). конечная заметка]

Родительские элементы
параметры (§17.15.1.78)

Дочерние элементы	Вложенные запросы
autoCaptions (параметры автоматического субтитров)	§17.15.1.8
подпись (определение типа с одним субтитром)	§17.15.1.16

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

ISO/IEC29500: 2008.

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

Captions()	Инициализирует новый экземпляр класса Captions.
Captions(IEnumerable<OpenXmlElement>)	Инициализирует новый экземпляр класса Captions указанными дочерними элементами.
Captions(OpenXmlElement[])	Инициализирует новый экземпляр класса Captions указанными дочерними элементами.
Captions(String)	Инициализирует новый экземпляр класса Captions из внешнего XML-кода.

Свойства

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

Методы

AddAnnotation(Object)	Добавляет объект в список заметок текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Добавляет указанный элемент в элемент , если он является известным дочерним элементом. При этом элемент будет добавлен в правильное расположение в соответствии со схемой. (Унаследовано от OpenXmlCompositeElement)
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)	Добавляет указанный элемент в конец списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
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)	Вставляет указанный элемент сразу после указанного ссылочного элемента. (Унаследовано от OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Вставляет указанный элемент сразу после текущего элемента. (Унаследовано от OpenXmlElement)
InsertAt<T>(T, Int32)	Вставляет указанный элемент по указанному индексу дочерних элементов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Вставляет указанный элемент непосредственно перед указанным ссылочным элементом. (Унаследовано от OpenXmlCompositeElement)
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)	Вставляет указанный элемент в начало списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
PreviousSibling()	Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
PreviousSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Remove()	Удаляет текущий элемент из родительского элемента. (Унаследовано от OpenXmlElement)
RemoveAllChildren()	Удаляет все дочерние элементы текущего элемента. (Унаследовано от OpenXmlCompositeElement)
RemoveAllChildren<T>()	Удалите все дочерние элементы текущего элемента типа T. (Унаследовано от OpenXmlElement)
RemoveAnnotations(Type)	Удаляет заметки указанного типа из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
RemoveAnnotations<T>()	Удаляет заметки с указанным типом из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
RemoveAttribute(String, String)	Удаляет атрибут из текущего элемента. (Унаследовано от OpenXmlElement)
RemoveChild<T>(T)	Удаляет указанный дочерний элемент. (Унаследовано от OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Удаляет объявление пространства имен для указанного префикса. Ничего не удаляет, если нет префикса. (Унаследовано от OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Заменяет один из дочерних элементов текущего элемента другим элементом OpenXmlElement. (Унаследовано от OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Задает атрибут заданного элемента. Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute. (Унаследовано от OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Задает ряд атрибутов элемента . Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute. (Унаследовано от OpenXmlElement)
WriteTo(XmlWriter)	Сохраняет текущий узел в указанном xmlWriter. (Унаследовано от OpenXmlElement)

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

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