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 формат. В отличие отWordOpenXML свойство, этот метод генерирует урезанный документ, который исключает любые части, не связанные с содержимым.
XmlMapping { get; }	Получает объект, представляющий сопоставление этого структурированного тега документа с XML-данными в пользовательской XML-части текущего документа.

Методы

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

Примечания

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

В этой версии 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