Класс Aspose::Words::Notes::Footnote

Footnote class

Представляет контейнер для текста сноски или концевой сноски. Чтобы узнать больше, посетите статью документации Working with Footnote and Endnote.

class Footnote : public Aspose::Words::InlineStory,
                 public Aspose::Words::Revisions::ITrackableNode

Методы

Метод	Описание
Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя.
AcceptEnd(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя для посещения конца сноски.
AcceptStart(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя для посещения начала сноски.
AppendChild(T)
Clone(bool)	Создаёт дубликат узла.
EnsureMinimum()	Если последний дочерний элемент не является абзацем, создаёт и добавляет один пустой абзац.
Footnote(const System::SharedPtr<Aspose::Words::DocumentBase>&, Aspose::Words::Notes::FootnoteType)	Инициализирует экземпляр класса Footnote.
get_ActualReferenceMark()	Получает фактический текст ссылочного знака, отображаемого в документе для этой сноски.
get_Count()	Возвращает количество непосредственных дочерних элементов этого узла.
get_CustomNodeId() const	Указывает пользовательский идентификатор узла.
virtual get_Document() const	Возвращает документ, к которому принадлежит этот узел.
get_FirstChild() const	Возвращает первого дочернего узла.
get_FirstParagraph() override	Возвращает первый абзац в истории.
get_Font()	Предоставляет доступ к форматированию шрифта символа‑якоря этого объекта.
get_FootnoteType() const	Возвращает значение, указывающее, является ли это сноской или концевой сноской.
get_HasChildNodes()	Возвращает true, если у этого узла есть дочерние узлы.
get_IsAuto() const	Содержит значение, указывающее, является ли это автоматически нумерованной сноской или сноской с пользовательским ссылочным знаком.
get_IsComposite() override	Возвращает true, поскольку этот узел может иметь дочерние узлы.
get_IsDeleteRevision()	Возвращает true, если этот объект был удалён в Microsoft Word при включённом отслеживании изменений.
get_IsInsertRevision()	Возвращает true, если этот объект был вставлен в Microsoft Word при включённом отслеживании изменений.
get_IsMoveFromRevision()	Возвращает true, если этот объект был перемещён (удалён) в Microsoft Word при включённом отслеживании изменений.
get_IsMoveToRevision()	Возвращает true, если этот объект был перемещён (вставлен) в Microsoft Word при включённом отслеживании изменений.
get_LastChild() const	Возвращает последнего дочернего узла.
get_LastParagraph() override	Возвращает последний абзац в истории.
get_NextNode() const
get_NextSibling()	Возвращает узел, непосредственно следующий за этим узлом.
get_NodeType() const override	Возвращает Footnote.
get_Paragraphs() override	Возвращает коллекцию абзацев, которые являются непосредственными дочерними элементами истории.
get_ParentNode()	Возвращает непосредственного родителя этого узла.
get_ParentParagraph()	Получает родительский Paragraph этого узла.
get_PreviousSibling()	Возвращает узел, непосредственно предшествующий этому узлу.
get_PrevNode() const
get_Range()	Возвращает объект Range, представляющий часть документа, содержащуюся в этом узле.
get_ReferenceMark() const	Получает/устанавливает пользовательский ссылочный знак, используемый для этой сноски. Значение по умолчанию — empty string, что означает использование автонумерованных сносок.
get_StoryType() override	Возвращает Footnotes или Endnotes.
get_Tables() override	Возвращает коллекцию таблиц, которые являются непосредственными дочерними элементами истории.
GetAncestor(Aspose::Words::NodeType)	Возвращает первого предка указанного NodeType.
GetAncestorOf()
GetChild(Aspose::Words::NodeType, int32_t, bool)	Возвращает N‑й дочерний узел, соответствующий указанному типу.
GetChildNodes(Aspose::Words::NodeType, bool)	Возвращает живую коллекцию дочерних узлов, соответствующих указанному типу.
GetEnumerator() override	Обеспечивает поддержку итерации в стиле foreach по дочерним узлам этого узла.
GetText() override	Получает текст этого узла и всех его дочерних узлов.
GetType() const override
IndexOf(const System::SharedPtr<Aspose::Words::Node>&)	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
InsertAfter(T, const System::SharedPtr<Aspose::Words::Node>&)
InsertBefore(T, const System::SharedPtr<Aspose::Words::Node>&)
Is(const System::TypeInfo&) const override
IsAncestorNode(const System::SharedPtr<Aspose::Words::Node>&)
NextPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Получает следующий узел согласно алгоритму обхода дерева в порядке предобхода.
static NodeTypeToString(Aspose::Words::NodeType)	Вспомогательный метод, преобразующий значение перечисления типа узла в удобочитаемую строку.
PrependChild(T)
PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Получает предыдущий узел согласно алгоритму обхода дерева в порядке предобхода.
Remove()	Удаляет себя из родительского узла.
RemoveAllChildren()	Удаляет все дочерние узлы текущего узла.
RemoveChild(T)
RemoveSmartTags()	Удаляет все дочерние узлы SmartTag текущего узла.
SelectNodes(const System::String&)	Выбирает список узлов, соответствующих XPath-выражению.
SelectSingleNode(const System::String&)	Выбирает первый Node, соответствующий XPath-выражению.
set_CustomNodeId(int32_t)	Сеттер для Aspose::Words::Node::get_CustomNodeId.
set_IsAuto(bool)	Сеттер для Aspose::Words::Notes::Footnote::get_IsAuto.
set_NextNode(const System::SharedPtr<Aspose::Words::Node>&)
set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&)
set_ReferenceMark(const System::String&)	Сеттер для Aspose::Words::Notes::Footnote::get_ReferenceMark.
SetParent(const System::SharedPtr<Aspose::Words::Node>&)
SetTemplateWeakPtr(uint32_t) override
ToString(Aspose::Words::SaveFormat)	Экспортирует содержимое узла в строку в указанном формате.
ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
static Type()

Примечания

Класс Footnote используется для представления как сносок, так и концевых сносок в документе Word.

Footnote is an inline-level node and can only be a child of Paragraph.

Footnote can contain Paragraph and Table child nodes.

Примеры

Показывает, как вставлять и настраивать сноски.

auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);

// Добавьте текст и сослаться на него с помощью сноски. Эта сноска разместит небольшую надстрочную ссылку
// после текста, на который она ссылается, и создаст запись под основным текстом внизу страницы.
// Эта запись будет содержать маркер ссылки сноски и текст ссылки,
// которые мы передадим методу "InsertFootnote" построителя документа.
builder->Write(u"Main body text.");
System::SharedPtr<Aspose::Words::Notes::Footnote> footnote = builder->InsertFootnote(Aspose::Words::Notes::FootnoteType::Footnote, u"Footnote text.");

// Если это свойство установлено в "true", то маркер ссылки нашей сноски
// будет её индексом среди всех сносок раздела.
// Это первая сноска, поэтому её маркер будет "1".
ASSERT_TRUE(footnote->get_IsAuto());

// Мы можем переместить построитель документа внутрь сноски, чтобы отредактировать её текст ссылки.
builder->MoveTo(footnote->get_FirstParagraph());
builder->Write(u" More text added by a DocumentBuilder.");
builder->MoveToDocumentEnd();

ASSERT_EQ(u"\u0002 Footnote text. More text added by a DocumentBuilder.", footnote->GetText().Trim());

builder->Write(u" More main body text.");
footnote = builder->InsertFootnote(Aspose::Words::Notes::FootnoteType::Footnote, u"Footnote text.");

// Мы можем задать пользовательский маркер ссылки, который сноска будет использовать вместо своего порядкового номера.
footnote->set_ReferenceMark(u"RefMark");

ASSERT_FALSE(footnote->get_IsAuto());

// Закладка с флагом "IsAuto", установленным в true, всё равно покажет свой реальный индекс
// даже если предыдущие закладки отображают пользовательские маркеры, поэтому маркер этой закладки будет "3".
builder->Write(u" More main body text.");
footnote = builder->InsertFootnote(Aspose::Words::Notes::FootnoteType::Footnote, u"Footnote text.");

ASSERT_TRUE(footnote->get_IsAuto());

doc->Save(get_ArtifactsDir() + u"InlineStory.AddFootnote.docx");

См. также

Класс Aspose::Words::Notes::EndnoteOptions Aspose::Words::Notes::FootnoteOptions class