StructuredDocumentTag

StructuredDocumentTag class

Представляет тег структурированного документа (SDT или элемент управления содержимым) в документе.

public class StructuredDocumentTag : CompositeNode, IStructuredDocumentTag

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

Имя Описание
StructuredDocumentTag(DocumentBase, SdtType, MarkupLevel) Инициализирует новый экземпляр Тег структурированного документа класс.

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

Имя Описание
Appearance { get; set; } Получает/задает внешний вид тега структурированного документа.
BuildingBlockCategory { get; set; } Указывает категорию стандартного блока для этого СДТ node. Не может быть нулевым.
BuildingBlockGallery { get; set; } Определяет тип стандартного блока для этого СДТ . Не может быть нулевым.
CalendarType { get; set; } Определяет тип календаря для этого СДТ . По умолчаниюDefault
Checked { get; set; } Получает/устанавливает текущее состояние флажка СДТ . Значение по умолчанию для этого свойства — false.
ChildNodes { get; } Получает все непосредственные дочерние узлы этого узла.
Color { get; set; } Получает или задает цвет тега структурированного документа.
ContentsFont { get; } Форматирование шрифта, которое будет применяться к тексту, введенному в СДТ .
Count { get; } Получает количество непосредственных дочерних элементов этого узла.
CustomNodeId { get; set; } Указывает идентификатор пользовательского узла.
DateDisplayFormat { get; set; } Строка, представляющая формат отображения дат. Не может быть нулевым. Даты для английского языка (США): «мм/дд/гггг».
DateDisplayLocale { get; set; } Позволяет установить/получить языковой формат для даты, отображаемой в этом СДТ .
DateStorageFormat { get; set; } Получает/устанавливает формат, в котором дата для SDT даты сохраняется, когда СДТ привязан к узлу XML в хранилище данных документа. Значение по умолчанию:DateTime
virtual Document { get; } Получает документ, которому принадлежит этот узел.
EndCharacterFont { get; } Форматирование шрифта, которое будет применено к последнему символу текста, введенного в СДТ .
FirstChild { get; } Получает первого потомка узла.
FullDate { get; set; } Указывает полную дату и время, введенные в последний раз в этом СДТ .
HasChildNodes { get; } Возвращает true, если у этого узла есть дочерние узлы.
Id { get; } Указывает уникальный постоянный числовой идентификатор только для чтения для этого СДТ.
override IsComposite { get; } Возвращает true, так как этот узел может иметь дочерние узлы.
IsShowingPlaceholderText { get; set; } Указывает, будет ли содержимое этого СДТ должен интерпретироваться как содержащий заполнитель text (в отличие от обычного текстового содержимого в SDT).
IsTemporary { get; set; } Указывает, является ли это СДТ должен быть удален из документа WordProcessingML при изменении его содержимого .
LastChild { get; } Получает последний дочерний элемент узла.
Level { get; } Получает уровень, на котором СДТ встречается в дереве документа.
ListItems { get; } получаетSdtListItemCollection связанные с этим СДТ .
LockContentControl { get; set; } Если установлено значение true, это свойство запрещает пользователю удалять это СДТ .
LockContents { get; set; } Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этого СДТ .
Multiline { get; set; } Указывает, является ли это СДТ позволяет использовать несколько строк текста.
NextSibling { get; } Получает узел, следующий сразу за этим узлом.
override NodeType { get; } Возвращает NodeType.StructuredDocumentTag .
ParentNode { get; } Получает непосредственного родителя этого узла.
Placeholder { get; } ПолучаетBuildingBlock содержащий текст-заполнитель, который должен отображаться, когда содержимое этого запуска SDT пусто, связанный сопоставленный XML-элемент пуст, как указано черезXmlMapping element илиIsShowingPlaceholderText элемент истинный.
PlaceholderName { get; set; } Получает или задает имяBuildingBlock содержащий текст-заполнитель.
PreviousSibling { get; } Получает узел, непосредственно предшествующий этому узлу.
Range { get; } Возвращает Диапазон объект, представляющий часть документа, содержащегося в этом узле.
SdtType { get; } Получает тип этого Тег структурированного документа .
Style { get; set; } Получает или задает стиль тега структурированного документа.
StyleName { get; set; } Получает или задает имя стиля, применяемого к тегу структурированного документа.
Tag { get; set; } Указывает тег, связанный с текущим узлом SDT. Не может быть нулевым.
Title { get; set; } Указывает понятное имя, связанное с этим СДТ . Не может быть нулевым.
WordOpenXML { get; } Получает строку, представляющую XML, содержащийся в узле вFlatOpc формат.
XmlMapping { get; } Получает объект, представляющий сопоставление этого тега структурированного документа с XML data в пользовательской XML-части текущего документа.

Методы

Имя Описание
override Accept(DocumentVisitor) Принимает посетителя.
AppendChild(Node) Добавляет указанный узел в конец списка дочерних узлов для этого узла.
Clear() Очищает содержимое этого тега структурированного документа и отображает заполнитель, если он определен.
Clone(bool) Создает дубликат узла.
CreateNavigator() Зарезервировано для системного использования. IXPathNavigable.
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) Удаляет указанный дочерний узел.
RemoveSelfOnly() Удаляет только сам этот узел SDT, но сохраняет его содержимое в дереве документа.
RemoveSmartTags() Удаляет всеSmartTag узлы-потомки текущего узла.
SelectNodes(string) Выбирает список узлов, соответствующих выражению XPath.
SelectSingleNode(string) Выбирает первый узел, соответствующий выражению XPath.
SetCheckedSymbol(int, string) Устанавливает символ, используемый для представления отмеченного состояния элемента управления содержимым флажка.
SetUncheckedSymbol(int, string) Устанавливает символ, используемый для представления неотмеченного состояния элемента управления содержимым флажка.
ToString(SaveFormat) Экспортирует содержимое узла в строку в указанном формате.
ToString(SaveOptions) Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Примечания

Теги структурированного документа (SDT) позволяют встраивать в документ определяемую пользователем семантику, а также его поведение и внешний вид .

В этой версии Aspose.Words предоставляет ряд общедоступных методов и свойств для управления поведением и содержимымStructuredDocumentTag . Сопоставление узлов SDT с пользовательскими пакетами XML в документе можно выполнить с помощью XmlMapping имущество.

StructuredDocumentTag может встречаться в документе в следующих местах:

  • Блочный уровень — среди абзацев и таблиц, как дочерний элементBody ,HeaderFooter , Comment ,Footnote илиShape узел.
  • Уровень строки — среди строк в таблице, как дочерний элементTable узел.
  • Уровень ячейки — среди ячеек в строке таблицы, как дочерний элементRow узел.
  • Встроенный уровень — среди встроенного контента внутри, как дочерний элементParagraph.
  • Вложенный в другойStructuredDocumentTag.

Примеры

Показывает, как работать со стилями для элементов управления содержимым.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Ниже приведены два способа применения стиля из документа к тегу структурированного документа.
// 1 - Применить объект стиля из коллекции стилей документа:
Style quoteStyle = doc.Styles[StyleIdentifier.Quote];
StructuredDocumentTag sdtPlainText =
    new StructuredDocumentTag(doc, SdtType.PlainText, MarkupLevel.Inline) { Style = quoteStyle };

// 2 - Ссылка на стиль в документе по имени:
StructuredDocumentTag sdtRichText =
    new StructuredDocumentTag(doc, SdtType.RichText, MarkupLevel.Inline) { StyleName = "Quote" };

builder.InsertNode(sdtPlainText);
builder.InsertNode(sdtRichText);

Assert.AreEqual(NodeType.StructuredDocumentTag, sdtPlainText.NodeType);

NodeCollection tags = doc.GetChildNodes(NodeType.StructuredDocumentTag, true);

foreach (Node node in tags)
{
    StructuredDocumentTag sdt = (StructuredDocumentTag)node;

    Assert.AreEqual(StyleIdentifier.Quote, sdt.Style.StyleIdentifier);
    Assert.AreEqual("Quote", sdt.StyleName);
}

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