StructuredDocumentTag

Обзор

StructuredDocumentTag — это класс в Aspose.Words FOSS для .NET. Наследуется от: CompositeNode, IMarkupNode, ITrackableNode и ещё 2.

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

Этот класс предоставляет 31 метод для работы с объектами StructuredDocumentTag в программах .NET. Доступные методы включают: Accept, AcceptEnd, AcceptStart, AppendChild, Clear, Clone, CreateNavigator, GetAncestor, GetAncestorOf, GetChild, GetChildNodes, GetEnumerator и ещё 19 методов. Все публичные члены доступны любому приложению .NET после установки пакета Aspose.Words FOSS для .NET. Свойства: Appearance, BuildingBlockCategory, BuildingBlockGallery, CalendarType, Checked, Color и ещё 38.

Свойства

Имя:	Тип:	Доступ	Описание:
`NodeType`	`NodeType`	Чтение	Возвращает StructuredDocumentTag.
`Placeholder`	`BuildingBlock`	Чтение	Получает BuildingBlock, содержащий текст-заполнитель, который должен отображаться, когда содержимое этого выполнения SDT пусто, соответствующий сопоставленный элемент XML пуст, как указано через элемент XmlMapping, или элемент IsShowingPlaceholderText имеет значение true.
`PlaceholderName`	`string`	Чтение/запись	Получает или задает имя BuildingBlock, содержащего текст-заполнитель.
`Level`	`MarkupLevel`	Чтение	Получает уровень, на котором этот SDT находится в дереве документа.
`SdtType`	`SdtType`	Чтение	Получает тип этого структурированного тега документа.
`Id`	`int`	Чтение	Указывает уникальный только для чтения постоянный числовой Id для этого SDT.
`LockContentControl`	`bool`	Чтение/запись	При значении true это свойство будет запрещать пользователю удалять этот SDT.
`LockContents`	`bool`	Чтение/запись	При значении true это свойство будет запрещать пользователю редактировать содержимое этого SDT.
`IsShowingPlaceholderText`	`bool`	Чтение/запись	Указывает, следует ли интерпретировать содержимое этого SDT как содержащий заполнительный текст (в отличие от обычного текста внутри SDT).
`Tag`	`string`	Чтение/запись	Указывает тег, связанный с текущим узлом SDT.
`ContentsFont`	`Font`	Чтение	Форматирование шрифта, которое будет применено к тексту, введённому в SDT.
`EndCharacterFont`	`Font`	Чтение	Форматирование шрифта, которое будет применяться к последнему символу текста, введённого в SDT.
`IsTemporary`	`bool`	Чтение/запись	Указывает, следует ли удалять этот SDT из документа WordProcessingML, когда его содержимое изменяется.
`Title`	`string`	Чтение/запись	Указывает удобочитаемое имя, связанное с этим SDT.
`ListItems`	`SdtListItemCollection`	Чтение	Получает SdtListItemCollection, связанный с этим SDT.
`Checked`	`bool`	Чтение/запись	Получает/Устанавливает текущее состояние флажка SDT.
`Appearance`	`SdtAppearance`	Чтение/запись	Получает/устанавливает внешний вид структурированного тега документа.
`DateDisplayLocale`	`int`	Чтение/запись	Позволяет установить/получить языковой формат даты, отображаемой в этом SDT.
`DateDisplayFormat`	`string`	Чтение/запись	Строка, представляющая формат, в котором отображаются даты.
`FullDate`	`DateTime`	Чтение/запись	Указывает полную дату и время, последний раз введённые в этот SDT.
`DateStorageFormat`	`SdtDateStorageFormat`	Чтение/запись	Получает/устанавливает формат, в котором дата для SDT типа «date» хранится, когда SDT привязан к узлу XML в хранилище данных документа.
`CalendarType`	`SdtCalendarType`	Чтение/запись	Указывает тип календаря для этого SDT.
`BuildingBlockGallery`	`string`	Чтение/запись	Указывает тип строительного блока для этого SDT.
`BuildingBlockCategory`	`string`	Чтение/запись	Указывает категорию строительного блока для этого узла SDT.
`Multiline`	`bool`	Чтение/запись	Указывает, разрешает ли этот SDT несколько строк текста.
`Color`	`System.Drawing.Color`	Чтение/запись	Получает или задает цвет структурного тега документа.
`Style`	`Style`	Чтение/запись	Получает или задает стиль структурированного тега документа.
`StyleName`	`string`	Чтение/запись	Получает или задает имя стиля, применяемого к тегу структурированного документа.
`XmlMapping`	`XmlMapping`	Чтение	Получает объект, представляющий отображение этого тега структурированного документа на данные XML в пользовательской части XML текущего документа.
`WordOpenXML`	`string`	Чтение	Получает строку, представляющую XML, содержащийся в узле, в формате FlatOpc.
`WordOpenXMLMinimal`	`string`	Чтение	Получает строку, представляющую XML, содержащийся в узле, в формате FlatOpc.
`IsComposite`	`bool`	Чтение	Возвращает true, так как этот узел может иметь дочерние узлы.
`HasChildNodes`	`bool`	Чтение	Возвращает true, если у этого узла есть какие-либо дочерние узлы.
`FirstChild`	`Node`	Чтение	Получает первый дочерний элемент узла.
`LastChild`	`Node`	Чтение	Получает последний дочерний элемент узла.
`Count`	`int`	Чтение	Получает количество непосредственных дочерних элементов этого узла.
`ParentNode`	`CompositeNode`	Чтение	Получает непосредственного родителя этого узла.
`Document`	`DocumentBase`	Чтение	Получает документ, к которому принадлежит этот узел.
`PreviousSibling`	`Node`	Чтение	Получает узел, непосредственно предшествующий этому узлу.
`NextSibling`	`Node`	Чтение	Получает узел, непосредственно следующий за этим узлом.
`Range`	`Range`	Чтение	Возвращает объект Range, представляющий часть документа, содержащуюся в этом узле.
`CustomNodeId`	`int`	Чтение/запись	Указывает пользовательский идентификатор узла.
`IsMultiSection`	`bool`	Чтение	Возвращает true, если данный экземпляр является диапазонным (многоразделным) тегом структурированного документа.
`Node`	`Node`	Чтение	Возвращает объект Node, реализующий этот интерфейс.

Методы

Сигнатура	Описание:
`StructuredDocumentTag(doc: DocumentBase, type: SdtType, level: MarkupLevel)`	Инициализирует новый экземпляр класса Structured document tag.
`SetCheckedSymbol(characterCode: int, fontName: string)`	Устанавливает символ, используемый для представления состояния «отмечено» в элементе управления содержимым флажка.
`SetUncheckedSymbol(characterCode: int, fontName: string)`	Устанавливает символ, используемый для представления состояния «не отмечено» в элементе управления содержимым флажка.
`RemoveSelfOnly()`	Удаляет только этот узел SDT, но сохраняет его содержимое в дереве документа.
`Accept(visitor: DocumentVisitor)`	Вызывает VisitStructuredDocumentTagStart, затем вызывает Accept для всех дочерних узлов смарт-тега и в конце вызывает VisitStructuredDocumentTagEnd.
`Clear()`	Очищает содержимое этого тега структурированного документа и отображает заполнитель, если он определён.
`AcceptStart(visitor: DocumentVisitor)`	Принимает посетителя для посещения начала StructuredDocumentTag.
`AcceptEnd(visitor: DocumentVisitor)`	Принимает посетителя для посещения конца StructuredDocumentTag.
`GetText()`	Получает текст этого узла и всех его дочерних элементов.
`GetChildNodes(nodeType: NodeType, isDeep: bool)`	Возвращает коллекцию дочерних узлов, соответствующих указанному типу.
`GetChild(nodeType: NodeType, index: int, isDeep: bool)`	Возвращает N-й дочерний узел, соответствующий указанному типу.
`SelectNodes(xpath: string)`	Выбирает список узлов, соответствующих выражению XPath.
`SelectSingleNode(xpath: string)`	Выбирает первый узел, соответствующий выражению XPath.
`GetEnumerator()`	Обеспечивает поддержку итерации в стиле «for each» по дочерним узлам этого узла.
`AppendChild(newChild: T)`	Добавляет указанный узел в конец списка дочерних узлов этого узла.
`PrependChild(newChild: T)`	Добавляет указанный узел в начало списка дочерних узлов этого узла.
`InsertAfter(newChild: T, refChild: Node)`	Вставляет указанный узел сразу после указанного узла-ссылки.
`InsertBefore(newChild: T, refChild: Node)`	Вставляет указанный узел сразу перед указанным узлом-ссылкой.
`RemoveChild(oldChild: T)`	Удаляет указанный дочерний узел.
`RemoveAllChildren()`	Удаляет все дочерние узлы текущего узла.
`RemoveSmartTags()`	Удаляет все SmartTag узлы-потомки текущего узла.
`IndexOf(child: Node)`	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
`CreateNavigator()`	Создаёт навигатор, который можно использовать для обхода и чтения узлов.
`Clone(isCloneChildren: bool)`	Следует использовать перегрузку Clone(bool, INodeCloningListener), когда клонирование узла является частью другого (обычно составного) процесса клонирования узлов.
`GetAncestor(ancestorType: Type)`	Получает первого предка указанного типа объекта.
`GetAncestorOf()`	Вызывает GetAncestorOf у этого экземпляра StructuredDocumentTag.
`Remove()`	Удаляет себя из родителя.
`NextPreOrder(rootNode: Node)`	Получает следующий узел согласно алгоритму обхода дерева в порядке предобхода.
`PreviousPreOrder(rootNode: Node)`	Получает предыдущий узел согласно алгоритму обхода дерева в порядке предобхода.
`ToString(saveFormat: SaveFormat)`	Экспортирует содержимое узла в строку в указанном формате.
`NodeTypeToString(nodeType: NodeType)`	Вспомогательный метод, который преобразует значение перечисления типа узла в удобочитаемую строку.

См. также:

Aspose.Words for .NET — Enterprise API Reference