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`	Читання	Отримує тип цього Structured document tag.
`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`	Читання/Запис	Отримує/встановлює поточний стан Checkbox SDT.
`Appearance`	`SdtAppearance`	Читання/Запис	Отримує/встановлює зовнішній вигляд структурованого тегу документа.
`DateDisplayLocale`	`int`	Читання/Запис	Дозволяє встановити/отримати формат мови для дати, що відображається в цьому SDT.
`DateDisplayFormat`	`string`	Читання/Запис	Рядок, який представляє формат, у якому відображаються дати.
`FullDate`	`DateTime`	Читання/Запис	Вказує повну дату та час, які востаннє були введені в цьому SDT.
`DateStorageFormat`	`SdtDateStorageFormat`	Читання/Запис	Отримує/встановлює формат, у якому зберігається дата для SDT типу дата, коли SDT прив’язується до вузла XML у сховищі даних документа.
`CalendarType`	`SdtCalendarType`	Читання/Запис	Вказує тип календаря для цього SDT.
`BuildingBlockGallery`	`string`	Читання/Запис	Вказує тип будівельного блоку для цього SDT.
`BuildingBlockCategory`	`string`	Читання/Запис	Вказує категорію будівельного блоку для цього вузла SDT.
`Multiline`	`bool`	Читання/Запис	Вказує, чи дозволяє цей SDT декілька рядків тексту.
`Color`	`System.Drawing.Color`	Читання/Запис	Отримує або встановлює колір структурованого тегу документа.
`Style`	`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)`	Вибирає перший Node, який відповідає виразу 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)`	Отримує попередній вузол згідно алгоритму обходу дерева у порядку pre-order.
`ToString(saveFormat: SaveFormat)`	Експортує вміст вузла у рядок у вказаному форматі.
`NodeTypeToString(nodeType: NodeType)`	Допоміжний метод, який перетворює значення перерахунку типу вузла у зрозумілий користувачеві рядок.

Дивіться також

Aspose.Words for .NET — Enterprise API Reference