Aspose::Words::Markup::SmartTag class
SmartTag class
This element specifies the presence of a smart tag around one or more inline structures (runs, images, fields,etc.) within a paragraph. To learn more, visit the Structured Document Tags or Content Control documentation article.
class SmartTag : public Aspose::Words::CompositeNode,
public Aspose::Words::Markup::IMarkupNode
Methods
Method | Description |
---|---|
Accept(System::SharedPtr<Aspose::Words::DocumentVisitor>) override | Accepts a visitor. |
AcceptEnd(System::SharedPtr<Aspose::Words::DocumentVisitor>) override | Accepts a visitor for visiting the end of the SmartTag. |
AcceptStart(System::SharedPtr<Aspose::Words::DocumentVisitor>) override | Accepts a visitor for visiting the start of the SmartTag. |
AppendChild(T) | |
Clone(bool) | Creates a duplicate of the node. |
get_Count() | Gets the number of immediate children of this node. |
get_CustomNodeId() const | Specifies custom node identifier. |
virtual get_Document() const | Gets the document to which this node belongs. |
get_Element() const | Specifies the name of the smart tag within the document. |
get_FirstChild() const | Gets the first child of the node. |
get_HasChildNodes() | Returns true if this node has any child nodes. |
get_IsComposite() override | Returns true as this node can have child nodes. |
get_LastChild() const | Gets the last child of the node. |
get_NextNode() const | |
get_NextSibling() | Gets the node immediately following this node. |
get_NodeType() const override | Returns SmartTag. |
get_ParentNode() | Gets the immediate parent of this node. |
get_PreviousSibling() | Gets the node immediately preceding this node. |
get_PrevNode() const | |
get_Properties() const | A collection of the smart tag properties. |
get_Range() | Returns a Range object that represents the portion of a document that is contained in this node. |
get_Uri() const | Specifies the namespace URI of the smart tag. |
GetAncestor(Aspose::Words::NodeType) | Gets the first ancestor of the specified NodeType. |
GetAncestorOf() | |
GetChild(Aspose::Words::NodeType, int32_t, bool) | Returns an Nth child node that matches the specified type. |
GetChildNodes(Aspose::Words::NodeType, bool) | Returns a live collection of child nodes that match the specified type. |
GetEnumerator() override | Provides support for the for each style iteration over the child nodes of this node. |
GetText() override | Gets the text of this node and of all its children. |
GetType() const override | |
IndexOf(const System::SharedPtr<Aspose::Words::Node>&) | Returns the index of the specified child node in the child node array. |
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>&) | Gets next node according to the pre-order tree traversal algorithm. |
static NodeTypeToString(Aspose::Words::NodeType) | A utility method that converts a node type enum value into a user friendly string. |
PrependChild(T) | |
PreviousPreOrder(const System::SharedPtr<Aspose::Words::Node>&) | Gets the previous node according to the pre-order tree traversal algorithm. |
Remove() | Removes itself from the parent. |
RemoveAllChildren() | Removes all the child nodes of the current node. |
RemoveChild(T) | |
RemoveSmartTags() | Removes all SmartTag descendant nodes of the current node. |
SelectNodes(const System::String&) | Selects a list of nodes matching the XPath expression. |
SelectSingleNode(const System::String&) | Selects the first Node that matches the XPath expression. |
set_CustomNodeId(int32_t) | Setter for Aspose::Words::Node::get_CustomNodeId. |
set_Element(const System::String&) | Setter for Aspose::Words::Markup::SmartTag::get_Element. |
set_NextNode(const System::SharedPtr<Aspose::Words::Node>&) | |
set_PrevNode(const System::SharedPtr<Aspose::Words::Node>&) | |
set_Uri(const System::String&) | Setter for Aspose::Words::Markup::SmartTag::get_Uri. |
SetParent(const System::SharedPtr<Aspose::Words::Node>&) | |
SetTemplateWeakPtr(uint32_t) override | |
SmartTag(const System::SharedPtr<Aspose::Words::DocumentBase>&) | Initializes a new instance of the SmartTag class. |
ToString(Aspose::Words::SaveFormat) | Exports the content of the node into a string in the specified format. |
ToString(const System::SharedPtr<Aspose::Words::Saving::SaveOptions>&) | Exports the content of the node into a string using the specified save options. |
static Type() |
Remarks
Smart tags is a kind of custom XML markup. Smart tags provide a facility for embedding customer-defined semantics into the document via the ability to provide a basic namespace/name for a run or set of runs within a document.
SmartTag can be a child of a Paragraph or another SmartTag node.
The complete list of child nodes that can occur inside a smart tag consists of BookmarkStart, BookmarkEnd, FieldStart, FieldSeparator, FieldEnd, FormField, Comment, Footnote, Run, SpecialChar, Shape, GroupShape, CommentRangeStart, CommentRangeEnd, SmartTag.
Examples
Shows how to create smart tags.
void Create()
{
auto doc = MakeObject<Document>();
// A smart tag appears in a document with Microsoft Word recognizes a part of its text as some form of data,
// such as a name, date, or address, and converts it to a hyperlink that displays a purple dotted underline.
auto smartTag = MakeObject<SmartTag>(doc);
// Smart tags are composite nodes that contain their recognized text in its entirety.
// Add contents to this smart tag manually.
smartTag->AppendChild(MakeObject<Run>(doc, u"May 29, 2019"));
// Microsoft Word may recognize the above contents as being a date.
// Smart tags use the "Element" property to reflect the type of data they contain.
smartTag->set_Element(u"date");
// Some smart tag types process their contents further into custom XML properties.
smartTag->get_Properties()->Add(MakeObject<CustomXmlProperty>(u"Day", String::Empty, u"29"));
smartTag->get_Properties()->Add(MakeObject<CustomXmlProperty>(u"Month", String::Empty, u"5"));
smartTag->get_Properties()->Add(MakeObject<CustomXmlProperty>(u"Year", String::Empty, u"2019"));
// Set the smart tag's URI to the default value.
smartTag->set_Uri(u"urn:schemas-microsoft-com:office:smarttags");
doc->get_FirstSection()->get_Body()->get_FirstParagraph()->AppendChild(smartTag);
doc->get_FirstSection()->get_Body()->get_FirstParagraph()->AppendChild(MakeObject<Run>(doc, u" is a date. "));
// Create another smart tag for a stock ticker.
smartTag = MakeObject<SmartTag>(doc);
smartTag->set_Element(u"stockticker");
smartTag->set_Uri(u"urn:schemas-microsoft-com:office:smarttags");
smartTag->AppendChild(MakeObject<Run>(doc, u"MSFT"));
doc->get_FirstSection()->get_Body()->get_FirstParagraph()->AppendChild(smartTag);
doc->get_FirstSection()->get_Body()->get_FirstParagraph()->AppendChild(MakeObject<Run>(doc, u" is a stock ticker."));
// Print all the smart tags in our document using a document visitor.
doc->Accept(MakeObject<ExSmartTag::SmartTagPrinter>());
// Older versions of Microsoft Word support smart tags.
doc->Save(ArtifactsDir + u"SmartTag.Create.doc");
// Use the "RemoveSmartTags" method to remove all smart tags from a document.
ASSERT_EQ(2, doc->GetChildNodes(NodeType::SmartTag, true)->get_Count());
doc->RemoveSmartTags();
ASSERT_EQ(0, doc->GetChildNodes(NodeType::SmartTag, true)->get_Count());
}
class SmartTagPrinter : public DocumentVisitor
{
public:
VisitorAction VisitSmartTagStart(SharedPtr<SmartTag> smartTag) override
{
std::cout << "Smart tag type: " << smartTag->get_Element() << std::endl;
return VisitorAction::Continue;
}
VisitorAction VisitSmartTagEnd(SharedPtr<SmartTag> smartTag) override
{
std::cout << "\tContents: \"" << smartTag->ToString(SaveFormat::Text) << "\"" << std::endl;
if (smartTag->get_Properties()->get_Count() == 0)
{
std::cout << "\tContains no properties" << std::endl;
}
else
{
std::cout << "\tProperties: ";
auto properties = MakeArray<String>(smartTag->get_Properties()->get_Count());
int index = 0;
for (const auto& cxp : System::IterateOver(smartTag->get_Properties()))
{
properties[index++] = String::Format(u"\"{0}\" = \"{1}\"", cxp->get_Name(), cxp->get_Value());
}
std::cout << String::Join(u", ", properties) << std::endl;
}
return VisitorAction::Continue;
}
};
See Also
- Class CompositeNode
- Namespace Aspose::Words::Markup
- Library Aspose.Words for C++