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; }	Получает/устанавливает текущее состояние флажка.СДТ . Значение по умолчанию для этого свойства:ЛОЖЬ .
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; }	Возвращаетистинный если у этого узла есть дочерние узлы.
Id { get; }	Указывает для этого уникальный постоянный числовой идентификатор, доступный только для чтения.СДТ.
override IsComposite { get; }	Возвращаетистинный поскольку этот узел может иметь дочерние узлы.
IsShowingPlaceholderText { get; set; }	Указывает, будет ли содержимое этогоСДТдолжно интерпретироваться как содержащее заполнитель text (в отличие от обычного текстового содержимого в SDT).
IsTemporary { get; set; }	Указывает, является ли этоСДТ должен быть удален из документа WordProcessingML при изменении его содержимого .
LastChild { get; }	Получает последнего дочернего узла узла.
Level { get; }	Получает уровень, на котором этоСДТ встречается в дереве документа.
ListItems { get; }	ПолучаетSdtListItemCollection связанный с этимСДТ .
LockContentControl { get; set; }	Если установлено значениеистинный , это свойство запретит пользователю удалять этоСДТ .
LockContents { get; set; }	Если установлено значениеистинный , это свойство запретит пользователю редактировать содержимое этогоСДТ .
Multiline { get; set; }	Указывает, является ли этоСДТ позволяет использовать несколько строк текста.
NextSibling { get; }	Получает узел, следующий сразу за этим узлом.
override NodeType { get; }	ВозвращаетStructuredDocumentTag .
ParentNode { get; }	Получает непосредственного родителя этого узла.
Placeholder { get; }	ПолучаетBuildingBlockсодержащий текст-заполнитель, который должен отображаться, когда содержимое этого запуска SDT пусто, связанный сопоставленный XML-элемент пуст, как указано черезXmlMapping element илиIsShowingPlaceholderText элементистинный .
PlaceholderName { get; set; }	Получает или задает ИмяBuildingBlock содержащий текст-заполнитель.
PreviousSibling { get; }	Получает узел, непосредственно предшествующий этому узлу.
Range { get; }	ВозвращаетRange объект, представляющий часть документа, содержащуюся в этом узле.
SdtType { get; }	Получает тип этогоТег структурированного документа .
Style { get; set; }	Получает или задает стиль тега структурированного документа.
StyleName { get; set; }	Получает или задает имя стиля, примененного к тегу структурированного документа.
Tag { get; set; }	Указывает тег, связанный с текущим узлом SDT. Не может бытьнулевой .
Title { get; set; }	Указывает понятное имя, связанное с этимСДТ . Не может бытьнулевой .
WordOpenXML { get; }	Получает строку, представляющую XML, содержащийся в узле вFlatOpc формат.
WordOpenXMLMinimal { get; }	Получает строку, представляющую XML, содержащийся в узле вFlatOpc format. В отличие отWordOpenXMLСвойство этот метод создает урезанный документ, который исключает любые части, не связанные с содержанием.
XmlMapping { get; }	Получает объект, который представляет сопоставление этого тега структурированного документа с XML-данными в пользовательской части XML текущего документа.

Методы

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

Примечания

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

В этой версии Aspose.Words предоставляет ряд общедоступных методов и свойств, позволяющих манипулировать поведением и содержимымStructuredDocumentTag . Сопоставление узлов SDT с пользовательскими пакетами XML внутри документа можно выполнить с помощью using 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;

    Console.WriteLine(sdt.WordOpenXMLMinimal);

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

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

• class CompositeNode
• interface IStructuredDocumentTag
• пространство имен Aspose.Words.Markup
• сборка Aspose.Words