Footnote
Содержание
[
Скрывать
]Footnote class
Представляет контейнер для текста сноски или концевой сноски.
Чтобы узнать больше, посетитеРабота со сносками и концевыми сносками документальная статья.
public class Footnote : InlineStory
Конструкторы
| Имя | Описание |
|---|---|
| Footnote(DocumentBase, FootnoteType) | Инициализирует экземплярFootnote класс. |
Характеристики
| Имя | Описание |
|---|---|
| ActualReferenceMark { get; } | Получает фактический текст сноски, отображаемый в документе для этой сноски. |
| Count { get; } | Получает количество непосредственных потомков этого узла. |
| CustomNodeId { get; set; } | Указывает пользовательский идентификатор узла. |
| virtual Document { get; } | Получает документ, к которому принадлежит этот узел. |
| FirstChild { get; } | Получает первый дочерний элемент узла. |
| FirstParagraph { get; } | Получает первый абзац в истории. |
| Font { get; } | Предоставляет доступ к форматированию шрифта символа привязки этого объекта. |
| FootnoteType { get; } | Возвращает значение, указывающее, является ли это сноской или концевой сноской. |
| HasChildNodes { get; } | Возвратистинный если у этого узла есть дочерние узлы. |
| IsAuto { get; set; } | Содержит значение, указывающее, является ли это автоматически пронумерованной сноской или сноской с определяемым пользователем настраиваемым сносным знаком. |
| override IsComposite { get; } | Возвратистинный так как этот узел может иметь дочерние узлы. |
| IsDeleteRevision { get; } | Возвращает значение true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений. |
| IsInsertRevision { get; } | Возвращает значение true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений. |
| IsMoveFromRevision { get; } | Возвратистинный если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений. |
| IsMoveToRevision { get; } | Возвратистинный если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений. |
| LastChild { get; } | Получает последний дочерний элемент узла. |
| LastParagraph { get; } | Получает последний абзац в истории. |
| NextSibling { get; } | Получает узел, следующий сразу за данным узлом. |
| override NodeType { get; } | ВозвратFootnote . |
| Paragraphs { get; } | Получает коллекцию абзацев, которые являются непосредственными дочерними элементами истории. |
| ParentNode { get; } | Получает непосредственного родителя этого узла. |
| ParentParagraph { get; } | Возвращает родителяParagraph этого узла. |
| PreviousSibling { get; } | Получает узел, непосредственно предшествующий данному узлу. |
| Range { get; } | ВозвращаетRangeобъект, представляющий часть документа, содержащуюся в этом узле. |
| ReferenceMark { get; set; } | Получает/устанавливает пользовательский ссылочный знак, который будет использоваться для этой сноски. Значение по умолчанию:пустая строка (Empty ), то есть используются автоматически пронумерованные сноски. |
| override StoryType { get; } | ВозвратFootnotes илиEndnotes . |
| Tables { get; } | Получает коллекцию таблиц, которые являются непосредственными дочерними элементами истории. |
Методы
| Имя | Описание |
|---|---|
| override Accept(DocumentVisitor) | Принимает посетителя. |
| override AcceptEnd(DocumentVisitor) | Принимает посетителя для посещения конца сноски. |
| override AcceptStart(DocumentVisitor) | Принимает посетителя для посещения начала сноски. |
| AppendChild<T>(T) | Добавляет указанный узел в конец списка дочерних узлов для данного узла. |
| Clone(bool) | Создает дубликат узла. |
| CreateNavigator() | Создает навигатор, который можно использовать для перемещения и чтения узлов. |
| EnsureMinimum() | Если последний дочерний элемент не является абзацем, создает и добавляет один пустой абзац. |
| GetAncestor(NodeType) | Получает первого предка указанногоNodeType . |
| GetAncestor(Type) | Получает первого предка указанного типа объекта. |
| GetChild(NodeType, int, bool) | Возвращает N-й дочерний узел, соответствующий указанному типу. |
| GetChildNodes(NodeType, bool) | Возвращает живую коллекцию дочерних узлов, соответствующих указанному типу. |
| GetEnumerator() | Обеспечивает поддержку для каждой итерации стиля по дочерним узлам этого узла. |
| override GetText() | Получает текст этого узла и всех его дочерних узлов. |
| IndexOf(Node) | Возвращает индекс указанного дочернего узла в массиве дочерних узлов. |
| InsertAfter<T>(T, Node) | Вставляет указанный узел сразу после указанного ссылочного узла. |
| InsertBefore<T>(T, Node) | Вставляет указанный узел непосредственно перед указанным ссылочным узлом. |
| NextPreOrder(Node) | Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка. |
| PrependChild<T>(T) | Добавляет указанный узел в начало списка дочерних узлов для данного узла. |
| PreviousPreOrder(Node) | Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка. |
| Remove() | Удаляет себя из родителя. |
| RemoveAllChildren() | Удаляет все дочерние узлы текущего узла. |
| RemoveChild<T>(T) | Удаляет указанный дочерний узел. |
| RemoveSmartTags() | Удаляет всеSmartTag узлы-потомки текущего узла. |
| SelectNodes(string) | Выбирает список узлов, соответствующих выражению XPath. |
| SelectSingleNode(string) | Выбирает первыйNode что соответствует выражению XPath. |
| ToString(SaveFormat) | Экспортирует содержимое узла в строку указанного формата. |
| ToString(SaveOptions) | Экспортирует содержимое узла в строку, используя указанные параметры сохранения. |
Примечания
TheFootnote класс используется для представления как обычных, так и концевых сносок в документе Word.
Footnote является узлом встроенного уровня и может быть только дочерним узломParagraph.
Footnote может содержатьParagraph иTable дочерние узлы.
Примеры
Показывает, как вставлять и настраивать сноски.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Добавьте текст и сделайте на него ссылку с помощью сноски. Эта сноска поместит небольшую надстрочную ссылку
// отметьте после текста, на который он ссылается, и создайте запись под основным текстом в нижней части страницы.
// Эта запись будет содержать ссылочный знак сноски и текст ссылки,
// который мы передадим методу "InsertFootnote" конструктора документа.
builder.Write("Main body text.");
Footnote footnote = builder.InsertFootnote(FootnoteType.Footnote, "Footnote text.");
// Если это свойство установлено в значение "true", то ссылочный знак нашей сноски
// будет его индексом среди всех сносок раздела.
// Это первая сноска, поэтому ссылочный знак будет «1».
Assert.True(footnote.IsAuto);
// Мы можем переместить конструктор документа внутрь сноски, чтобы редактировать ее ссылочный текст.
builder.MoveTo(footnote.FirstParagraph);
builder.Write(" More text added by a DocumentBuilder.");
builder.MoveToDocumentEnd();
Assert.AreEqual("\u0002 Footnote text. More text added by a DocumentBuilder.", footnote.GetText().Trim());
builder.Write(" More main body text.");
footnote = builder.InsertFootnote(FootnoteType.Footnote, "Footnote text.");
// Мы можем установить пользовательский ссылочный знак, который будет использоваться в сноске вместо ее индексного номера.
footnote.ReferenceMark = "RefMark";
Assert.False(footnote.IsAuto);
// Закладка с флагом "IsAuto", установленным в значение true, по-прежнему будет отображать свой реальный индекс
// даже если предыдущие закладки отображали пользовательские контрольные метки, контрольная метка этой закладки будет «3».
builder.Write(" More main body text.");
footnote = builder.InsertFootnote(FootnoteType.Footnote, "Footnote text.");
Assert.True(footnote.IsAuto);
doc.Save(ArtifactsDir + "InlineStory.AddFootnote.docx");
Смотрите также
- class InlineStory
- пространство имен Aspose.Words.Notes
- сборка Aspose.Words
