Класс Aspose::Words::Markup::StructuredDocumentTag

StructuredDocumentTag class

Представляет структурный тег документа (SDT или элемент управления содержимым) в документе. Чтобы узнать больше, посетите статью документации Structured Document Tags or Content Control.

class StructuredDocumentTag : public Aspose::Words::CompositeNode,
                              public Aspose::Words::Markup::IMarkupNode,
                              public Aspose::Words::Revisions::ITrackableNode,
                              public Aspose::Words::IRunAttrSource,
                              public Aspose::Words::Markup::IStructuredDocumentTag

Методы

Метод	Описание
Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя.
AcceptEnd(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя для посещения конца StructuredDocumentTag.
AcceptStart(System::SharedPtr<Aspose::Words::DocumentVisitor>) override	Принимает посетителя для посещения начала StructuredDocumentTag.
AppendChild(T)
Clear()	Очищает содержимое этого структурированного тега документа и отображает заполнитель, если он определён.
Clone(bool)	Создаёт дубликат узла.
get_Appearance() override	Получает/устанавливает внешний вид структурированного тега документа.
get_BuildingBlockCategory()	Указывает категорию строительного блока для этого узла SDT. Не может быть null.
get_BuildingBlockGallery()	Указывает тип строительного блока для этого SDT. Не может быть null.
get_CalendarType()	Указывает тип календаря для этого SDT. По умолчанию — Default
get_Checked()	Получает/устанавливает текущее состояние флажка SDT. Значение по умолчанию для этого свойства — false.
get_Color() override	Получает или задает цвет структурированного тега документа.
get_ContentsFont()	Font форматирование, которое будет применено к тексту, введённому в SDT.
get_Count()	Возвращает количество непосредственных дочерних элементов этого узла.
get_CustomNodeId() const	Указывает пользовательский идентификатор узла.
get_DateDisplayFormat()	Строка, представляющая формат, в котором отображаются даты.
get_DateDisplayLocale()	Позволяет установить/получить языковой формат даты, отображаемой в этом SDT.
get_DateStorageFormat()	Получает/устанавливает формат, в котором дата для датового SDT хранится, когда SDT привязан к узлу XML в хранилище данных документа. Значение по умолчанию — DateTime
virtual get_Document() const	Возвращает документ, к которому принадлежит этот узел.
get_EndCharacterFont()	Font форматирование, которое будет применено к последнему символу текста, введённому в SDT.
get_FirstChild() const	Возвращает первого дочернего узла.
get_FullDate()	Указывает полную дату и время, последним введённые в этот SDT.
get_HasChildNodes()	Возвращает true, если у этого узла есть дочерние узлы.
get_Id() override	Указывает уникальный только для чтения постоянный числовой идентификатор для этого SDT.
get_IsComposite() override	Возвращает true, поскольку этот узел может иметь дочерние узлы.
get_IsShowingPlaceholderText() override	Указывает, следует ли интерпретировать содержимое этого SDT как содержащие текст-заполнитель (в отличие от обычного текста внутри SDT). Если установлено в true, это состояние будет восстановлено (показ текста-заполнителя) при открытии документа.
get_IsTemporary() const	Указывает, следует ли удалять этот SDT из документа WordProcessingML при изменении его содержимого.
get_LastChild() const	Возвращает последнего дочернего узла.
get_Level() const override	Получает уровень, на котором этот SDT находится в дереве документа.
get_ListItems()	Получает SdtListItemCollection, связанный с этим SDT.
get_LockContentControl() override	Если установлено в true, это свойство запретит пользователю удалять этот SDT.
get_LockContents() override	Если установлено в true, это свойство запретит пользователю редактировать содержимое этого SDT.
get_Multiline()	Указывает, позволяет ли этот SDT несколько строк текста.
get_NextNode() const
get_NextSibling()	Возвращает узел, непосредственно следующий за этим узлом.
get_NodeType() const override	Возвращает StructuredDocumentTag.
get_ParentNode()	Возвращает непосредственного родителя этого узла.
get_Placeholder() override	Получает BuildingBlock, содержащий текст-заполнитель, который должен отображаться, когда содержимое выполнения этого SDT пусто, соответствующий сопоставленный элемент XML пуст, как указано через элемент XmlMapping, или элемент IsShowingPlaceholderText имеет значение true.
get_PlaceholderName() override	Получает или задает имя BuildingBlock, содержащего текст-заполнитель.
get_PreviousSibling()	Возвращает узел, непосредственно предшествующий этому узлу.
get_PrevNode() const
get_Range()	Возвращает объект Range, представляющий часть документа, содержащуюся в этом узле.
get_SdtType() override	Получает тип этого Structured document tag.
get_Style()	Получает или задает Style структурного тега документа.
get_StyleName()	Получает или задает имя стиля, применяемого к структурному тегу документа.
get_Tag() const override	Указывает тег, связанный с текущим узлом SDT. Не может быть null.
get_Title() const override	Указывает удобочитаемое имя, связанное с этим SDT. Не может быть null.
get_WordOpenXML() override	Получает строку, представляющую XML, содержащийся в узле, в формате FlatOpc.
get_WordOpenXMLMinimal()	Получает строку, представляющую XML, содержащийся в узле в формате FlatOpc. В отличие от свойства WordOpenXML, этот метод генерирует упрощённый документ, исключающий любые части, не связанные с содержимым.
get_XmlMapping() override	Получает объект, представляющий сопоставление этого структурированного тега документа с XML-данными в пользовательской части XML текущего документа.
GetAncestor(Aspose::Words::NodeType)	Возвращает первого предка указанного NodeType.
GetAncestorOf()
GetChild(Aspose::Words::NodeType, int32_t, bool)	Возвращает N‑й дочерний узел, соответствующий указанному типу.
GetChildNodes(Aspose::Words::NodeType, bool) override	Возвращает живую коллекцию дочерних узлов, соответствующих указанному типу.
GetEnumerator() override	Обеспечивает поддержку итерации в стиле foreach по дочерним узлам этого узла.
GetText() override	Получает текст этого узла и всех его дочерних узлов.
GetType() const override
IndexOf(const System::SharedPtr<Aspose::Words::Node>&)	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
InsertAfter(T, const System::SharedPtr<Aspose::Words::Node>&)
InsertBefore(T, const System::SharedPtr<Aspose::Words::Node>&)
Is(const System::TypeInfo&) const override
IsAncestorNode(const System::SharedPtr<Aspose::Words::Node>&)
NextPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Получает следующий узел согласно алгоритму обхода дерева в порядке предобхода.
static NodeTypeToString(Aspose::Words::NodeType)	Вспомогательный метод, преобразующий значение перечисления типа узла в удобочитаемую строку.
PrependChild(T)
PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&)	Получает предыдущий узел согласно алгоритму обхода дерева в порядке предобхода.
Remove()	Удаляет себя из родительского узла.
RemoveAllChildren()	Удаляет все дочерние узлы текущего узла.
RemoveChild(T)
RemoveSelfOnly() override	Удаляет только этот узел SDT, но сохраняет его содержимое в дереве документа.
RemoveSmartTags()	Удаляет все дочерние узлы SmartTag текущего узла.
SelectNodes(const System::String&)	Выбирает список узлов, соответствующих XPath-выражению.
SelectSingleNode(const System::String&)	Выбирает первый Node, соответствующий XPath-выражению.
set_Appearance(Aspose::Words::Markup::SdtAppearance) override	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_Appearance.
set_BuildingBlockCategory(const System::String&)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_BuildingBlockCategory.
set_BuildingBlockGallery(const System::String&)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_BuildingBlockGallery.
set_CalendarType(Aspose::Words::Markup::SdtCalendarType)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_CalendarType.
set_Checked(bool)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_Checked.
set_Color(System::Drawing::Color) override	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_Color.
set_CustomNodeId(int32_t)	Сеттер для Aspose::Words::Node::get_CustomNodeId.
set_DateDisplayFormat(const System::String&)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_DateDisplayFormat.
set_DateDisplayLocale(int32_t)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_DateDisplayLocale.
set_DateStorageFormat(Aspose::Words::Markup::SdtDateStorageFormat)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_DateStorageFormat.
set_FullDate(System::DateTime)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_FullDate.
set_IsShowingPlaceholderText(bool) override	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_IsShowingPlaceholderText.
set_IsTemporary(bool)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_IsTemporary.
set_LockContentControl(bool) override	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_LockContentControl.
set_LockContents(bool) override	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_LockContents.
set_Multiline(bool)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_Multiline.
set_NextNode(const System::SharedPtr<Aspose::Words::Node>&)
set_PlaceholderName(System::String) override	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_PlaceholderName.
set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&)
set_Style(const System::SharedPtr<Aspose::Words::Style>&)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_Style.
set_StyleName(const System::String&)	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_StyleName.
set_Tag(System::String) override	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_Tag.
set_Title(System::String) override	Сеттер для Aspose::Words::Markup::StructuredDocumentTag::get_Title.
SetCheckedSymbol(int32_t, const System::String&)	Устанавливает символ, используемый для представления отмеченного состояния элемента управления checkbox.
SetParent(const System::SharedPtr<Aspose::Words::Node>&)
SetTemplateWeakPtr(uint32_t) override
SetUncheckedSymbol(int32_t, const System::String&)	Устанавливает символ, используемый для представления неотмеченного состояния элемента управления checkbox.
StructuredDocumentTag(const System::SharedPtr<Aspose::Words::DocumentBase>&, Aspose::Words::Markup::SdtType, Aspose::Words::Markup::MarkupLevel)	Инициализирует новый экземпляр класса Structured document tag.
ToString(Aspose::Words::SaveFormat)	Экспортирует содержимое узла в строку в указанном формате.
ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
static Type()

Примечания

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

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

StructuredDocumentTag can occur in a document in the following places:

Block-level - Among paragraphs and tables, as a child of a Body, HeaderFooter, Comment, Footnote or a Shape node.
Row-level - Among rows in a table, as a child of a Table node.
Cell-level - Among cells in a table row, as a child of a Row node.
Inline-level - Among inline content inside, as a child of a Paragraph.
Nested inside another StructuredDocumentTag.

Примеры

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

auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);

// Ниже представлены два способа применения стиля из документа к structured document tag.
// 1 -  Применить объект стиля из коллекции стилей документа:
System::SharedPtr<Aspose::Words::Style> quoteStyle = doc->get_Styles()->idx_get(Aspose::Words::StyleIdentifier::Quote);
auto sdtPlainText = System::MakeObject<Aspose::Words::Markup::StructuredDocumentTag>(doc, Aspose::Words::Markup::SdtType::PlainText, Aspose::Words::Markup::MarkupLevel::Inline);
sdtPlainText->set_Style(quoteStyle);

// 2 -  Ссылка на стиль в документе по имени:
auto sdtRichText = System::MakeObject<Aspose::Words::Markup::StructuredDocumentTag>(doc, Aspose::Words::Markup::SdtType::RichText, Aspose::Words::Markup::MarkupLevel::Inline);
sdtRichText->set_StyleName(u"Quote");

builder->InsertNode(sdtPlainText);
builder->InsertNode(sdtRichText);

ASSERT_EQ(Aspose::Words::NodeType::StructuredDocumentTag, sdtPlainText->get_NodeType());

System::SharedPtr<Aspose::Words::NodeCollection> tags = doc->GetChildNodes(Aspose::Words::NodeType::StructuredDocumentTag, true);

for (auto&& node : System::IterateOver(tags))
{
    auto sdt = System::ExplicitCast<Aspose::Words::Markup::StructuredDocumentTag>(node);

    std::cout << sdt->get_WordOpenXMLMinimal() << std::endl;

    ASSERT_EQ(Aspose::Words::StyleIdentifier::Quote, sdt->get_Style()->get_StyleIdentifier());
    ASSERT_EQ(u"Quote", sdt->get_StyleName());
}

См. также

Aspose::Words::Markup::SmartTag класс Класс Aspose::Words::Markup::StructuredDocumentTagCollection