InlineStory

InlineStory class

Базовый класс для узлов встроенного уровня, которые могут содержать абзацы и таблицы.

public abstract class InlineStory : CompositeNode

Характеристики

Имя Описание
ChildNodes { get; } Получает все непосредственные дочерние узлы этого узла.
Count { get; } Получает количество непосредственных дочерних элементов этого узла.
CustomNodeId { get; set; } Указывает идентификатор пользовательского узла.
virtual Document { get; } Получает документ, которому принадлежит этот узел.
FirstChild { get; } Получает первого потомка узла.
FirstParagraph { get; } Получает первый абзац в истории.
Font { get; } Предоставляет доступ к форматированию шрифта символа привязки этого объекта.
HasChildNodes { get; } Возвращает true, если у этого узла есть дочерние узлы.
override IsComposite { get; } Возвращает true, так как этот узел может иметь дочерние узлы.
IsDeleteRevision { get; } Возвращает значение true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.
IsInsertRevision { get; } Возвращает значение true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.
IsMoveFromRevision { get; } Возвращает истинный если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.
IsMoveToRevision { get; } Возвращает истинный если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.
LastChild { get; } Получает последний дочерний элемент узла.
LastParagraph { get; } Получает последний абзац в истории.
NextSibling { get; } Получает узел, следующий сразу за этим узлом.
abstract NodeType { get; } Получает тип этого узла.
Paragraphs { get; } Получает набор абзацев, которые являются непосредственными дочерними элементами статьи.
ParentNode { get; } Получает непосредственного родителя этого узла.
ParentParagraph { get; } Извлекает родителяParagraph этого узла.
PreviousSibling { get; } Получает узел, непосредственно предшествующий этому узлу.
Range { get; } Возвращает Диапазон объект, представляющий часть документа, содержащегося в этом узле.
abstract StoryType { get; } Возвращает тип истории.
Tables { get; } Получает набор таблиц, которые являются непосредственными дочерними элементами истории.

Методы

Имя Описание
abstract Accept(DocumentVisitor) Принимает посетителя.
AppendChild(Node) Добавляет указанный узел в конец списка дочерних узлов для этого узла.
Clone(bool) Создает дубликат узла.
CreateNavigator() Зарезервировано для системного использования. IXPathNavigable.
EnsureMinimum() Если последний дочерний элемент не является абзацем, создает и добавляет один пустой абзац.
GetAncestor(NodeType) Получает первого предка указанногоNodeType .
GetAncestor(Type) Получает первого предка указанного типа объекта.
GetChild(NodeType, int, bool) Возвращает N-й дочерний узел, соответствующий указанному типу.
GetChildNodes(NodeType, bool) Возвращает динамическую коллекцию дочерних узлов, соответствующих указанному типу.
GetEnumerator() Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла.
override GetText() Получает текст этого узла и всех его дочерних элементов.
IndexOf(Node) Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
InsertAfter(Node, Node) Вставляет указанный узел сразу после указанного ссылочного узла.
InsertBefore(Node, Node) Вставляет указанный узел непосредственно перед указанным ссылочным узлом.
NextPreOrder(Node) Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
PrependChild(Node) Добавляет указанный узел в начало списка дочерних узлов для этого узла.
PreviousPreOrder(Node) Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
Remove() Удаляет себя из родителя.
RemoveAllChildren() Удаляет все дочерние узлы текущего узла.
RemoveChild(Node) Удаляет указанный дочерний узел.
RemoveSmartTags() Удаляет всеSmartTag узлы-потомки текущего узла.
SelectNodes(string) Выбирает список узлов, соответствующих выражению XPath.
SelectSingleNode(string) Выбирает первый узел, соответствующий выражению XPath.
ToString(SaveFormat) Экспортирует содержимое узла в строку в указанном формате.
ToString(SaveOptions) Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Примечания

встроенная история является контейнером для узлов блочного уровняParagraph а такжеTable.

Классы, происходящие от встроенная история являются узлами встроенного уровня, которые могут содержать собственный текст (абзацы и таблицы). Например, Комментарий node содержит текст comment и Сноска содержит текст сноски.

Примеры

Показывает, как добавить комментарий к абзацу.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.Write("Hello world!");

Comment comment = new Comment(doc, "John Doe", "JD", DateTime.Today);
builder.CurrentParagraph.AppendChild(comment);
builder.MoveTo(comment.AppendChild(new Paragraph(doc)));
builder.Write("Comment text.");

Assert.AreEqual(DateTime.Today, comment.DateTime);

// В Microsoft Word мы можем щелкнуть правой кнопкой мыши этот комментарий в теле документа, чтобы отредактировать его или ответить на него. 
doc.Save(ArtifactsDir + "InlineStory.AddComment.docx");

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

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");

Смотрите также