Aspose::Words::Markup::StructuredDocumentTagRangeEnd Class Reference

Detailed Description

Represents an end of ranged structured document tag which accepts multi-sections content. See also StructuredDocumentTagRangeStart node.

Examples

Shows how to get the properties of multi-section structured document tags.

auto doc = MakeObject<Document>(MyDir + u"Multi-section structured document tags.docx");
 
auto rangeStartTag =
    System::DynamicCast_noexcept<StructuredDocumentTagRangeStart>(doc->GetChildNodes(NodeType::StructuredDocumentTagRangeStart, true)->idx_get(0));
auto rangeEndTag =
    System::DynamicCast_noexcept<StructuredDocumentTagRangeEnd>(doc->GetChildNodes(NodeType::StructuredDocumentTagRangeEnd, true)->idx_get(0));
 
std::cout << "StructuredDocumentTagRangeStart values:" << std::endl;
std::cout << "\t|Id: " << rangeStartTag->get_Id() << std::endl;
std::cout << "\t|Title: " << rangeStartTag->get_Title() << std::endl;
std::cout << "\t|PlaceholderName: " << rangeStartTag->get_PlaceholderName() << std::endl;
std::cout << String::Format(u"\t|IsShowingPlaceholderText: {0}", rangeStartTag->get_IsShowingPlaceholderText()) << std::endl;
std::cout << String::Format(u"\t|LockContentControl: {0}", rangeStartTag->get_LockContentControl()) << std::endl;
std::cout << String::Format(u"\t|LockContents: {0}", rangeStartTag->get_LockContents()) << std::endl;
std::cout << String::Format(u"\t|Level: {0}", rangeStartTag->get_Level()) << std::endl;
std::cout << String::Format(u"\t|NodeType: {0}", rangeStartTag->get_NodeType()) << std::endl;
std::cout << "\t|RangeEnd: " << rangeStartTag->get_RangeEnd() << std::endl;
std::cout << "\t|Color: " << rangeStartTag->get_Color().ToArgb() << std::endl;
std::cout << String::Format(u"\t|SdtType: {0}", rangeStartTag->get_SdtType()) << std::endl;
std::cout << "\t|Tag: " << rangeStartTag->get_Tag() << "\n" << std::endl;
 
std::cout << "StructuredDocumentTagRangeEnd values:" << std::endl;
std::cout << "\t|Id: " << rangeEndTag->get_Id() << std::endl;
std::cout << String::Format(u"\t|NodeType: {0}", rangeEndTag->get_NodeType()) << std::endl;

#include <Aspose.Words.Cpp/Markup/StructuredDocumentTagRangeEnd.h>

Inheritance diagram for Aspose::Words::Markup::StructuredDocumentTagRangeEnd:

Public Member Functions
	StructuredDocumentTagRangeEnd (const SharedPtr< DocumentBase > &doc, int32_t id)
	Initializes a new instance of the Structured document tag range end class. More...
bool	Accept (SharedPtr< DocumentVisitor > visitor) override
	Accepts a visitor. More...
int32_t	get_Id () const
	Specifies a unique read-only persistent numerical Id for this StructuredDocumentTagRange node. Corresponding StructuredDocumentTagRangeStart node has the same Id. More...
NodeType	get_NodeType () const override
	Gets the type of this node. More...
virtual const TypeInfo &	GetType () const override
virtual bool	Is (const TypeInfo &target) const override
Public Member Functions inherited from Node
SharedPtr< Node >	Clone (bool isCloneChildren)
	Creates a duplicate of the node. More...
int32_t	get_CustomNodeId () const
	Specifies custom node identifier. More...
virtual SharedPtr< DocumentBase >	get_Document () const
	Gets the document to which this node belongs. More...
virtual bool	get_IsComposite ()
	Returns true if this node can contain other nodes. More...
SharedPtr< Node >	get_NextSibling ()
	Gets the node immediately following this node. More...
SharedPtr< CompositeNode >	get_ParentNode ()
	Gets the immediate parent of this node. More...
SharedPtr< Node >	get_PreviousSibling ()
	Gets the node immediately preceding this node. More...
SharedPtr< Range >	get_Range ()
	Returns a Range object that represents the portion of a document that is contained in this node. More...
SharedPtr< CompositeNode >	GetAncestor (NodeType ancestorType)
	Gets the first ancestor of the specified NodeType. More...
template<typename T >
T	GetAncestorOf ()
virtual String	GetText ()
	Gets the text of this node and of all its children. More...
SharedPtr< Node >	NextPreOrder (const SharedPtr< Node > &rootNode)
	Gets next node according to the pre-order tree traversal algorithm. More...
SharedPtr< Node >	PreviousPreOrder (const SharedPtr< Node > &rootNode)
	Gets the previous node according to the pre-order tree traversal algorithm. More...
void	Remove ()
	Removes itself from the parent. More...
void	set_CustomNodeId (int32_t value)
	Setter for get_CustomNodeId. More...
String	ToString (SaveFormat saveFormat)
	Exports the content of the node into a string in the specified format. More...
String	ToString (const SharedPtr< SaveOptions > &saveOptions)
	Exports the content of the node into a string using the specified save options. More...

Static Public Member Functions
static const TypeInfo &	Type ()
Static Public Member Functions inherited from Node
static String	NodeTypeToString (NodeType nodeType)
	A utility method that converts a node type enum value into a user friendly string. More...
static const TypeInfo &	Type ()

Constructor & Destructor Documentation

StructuredDocumentTagRangeEnd()

Aspose::Words::Markup::StructuredDocumentTagRangeEnd::StructuredDocumentTagRangeEnd	(	const System::SharedPtr< Aspose::Words::DocumentBase > &	doc,
		int32_t	id
	)

Initializes a new instance of the Structured document tag range end class.

Parameters

doc	The owner document.
id	Identifier of the corresponding structured document tag range start.

Examples

Shows how to create/remove structured document tag and its content.

void SdtRangeExtendedMethods()
{
    auto doc = MakeObject<Document>();
    auto builder = MakeObject<DocumentBuilder>(doc);
 
    builder->Writeln(u"StructuredDocumentTag element");
 
    SharedPtr<StructuredDocumentTagRangeStart> rangeStart;
    InsertStructuredDocumentTagRanges(doc, rangeStart);
 
    // Removes ranged structured document tag, but keeps content inside.
    rangeStart->RemoveSelfOnly();
 
    rangeStart = System::DynamicCast<StructuredDocumentTagRangeStart>(doc->GetChild(NodeType::StructuredDocumentTagRangeStart, 0, false));
    ASPOSE_ASSERT_EQ(nullptr, rangeStart);
 
    auto rangeEnd = System::DynamicCast<StructuredDocumentTagRangeEnd>(doc->GetChild(NodeType::StructuredDocumentTagRangeEnd, 0, false));
 
    ASPOSE_ASSERT_EQ(nullptr, rangeEnd);
    ASSERT_EQ(u"StructuredDocumentTag element", doc->GetText().Trim());
 
    InsertStructuredDocumentTagRanges(doc, rangeStart);
 
    SharedPtr<Node> paragraphNode = rangeStart->LINQ_LastOrDefault();
    ASPOSE_ASSERT_EQ(u"StructuredDocumentTag element",
                     paragraphNode != nullptr ? System::ObjectExt::Box<String>(paragraphNode->GetText().Trim()) : nullptr);
 
    // Removes ranged structured document tag and content inside.
    rangeStart->RemoveAllChildren();
 
    paragraphNode = rangeStart->LINQ_LastOrDefault();
    ASPOSE_ASSERT_EQ(nullptr, paragraphNode != nullptr ? System::ObjectExt::Box<String>(paragraphNode->GetText()) : nullptr);
}
 
void InsertStructuredDocumentTagRanges(SharedPtr<Document> doc, SharedPtr<StructuredDocumentTagRangeStart>& rangeStart)
{
    rangeStart = MakeObject<StructuredDocumentTagRangeStart>(doc, SdtType::PlainText);
    auto rangeEnd = MakeObject<StructuredDocumentTagRangeEnd>(doc, rangeStart->get_Id());
 
    doc->get_FirstSection()->get_Body()->InsertBefore(rangeStart, doc->get_FirstSection()->get_Body()->get_FirstParagraph());
    doc->get_LastSection()->get_Body()->InsertAfter(rangeEnd, doc->get_FirstSection()->get_Body()->get_FirstParagraph());
}

Member Function Documentation

Accept()

bool Aspose::Words::Markup::StructuredDocumentTagRangeEnd::Accept ( System::SharedPtr< Aspose::Words::DocumentVisitor >  visitor )

overridevirtual

Accepts a visitor.

Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

For more info see the Visitor design pattern.

Parameters

visitor

The visitor that will visit the nodes.

Returns

True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Examples

Shows how to use a DocumentVisitor implementation to remove all hidden content from a document.

void RemoveHiddenContentFromDocument()
{
    auto doc = MakeObject<Document>(MyDir + u"Hidden content.docx");
 
    auto hiddenContentRemover = MakeObject<ExFont::RemoveHiddenContentVisitor>();
 
    // Below are three types of fields which can accept a document visitor,
    // which will allow it to visit the accepting node, and then traverse its child nodes in a depth-first manner.
    // 1 -  Paragraph node:
    auto para = System::DynamicCast<Paragraph>(doc->GetChild(NodeType::Paragraph, 4, true));
    para->Accept(hiddenContentRemover);
 
    // 2 -  Table node:
    SharedPtr<Table> table = doc->get_FirstSection()->get_Body()->get_Tables()->idx_get(0);
    table->Accept(hiddenContentRemover);
 
    // 3 -  Document node:
    doc->Accept(hiddenContentRemover);
 
    doc->Save(ArtifactsDir + u"Font.RemoveHiddenContentFromDocument.docx");
}
 
class RemoveHiddenContentVisitor : public DocumentVisitor
{
public:
    VisitorAction VisitFieldStart(SharedPtr<FieldStart> fieldStart) override
    {
        if (fieldStart->get_Font()->get_Hidden())
        {
            fieldStart->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitFieldEnd(SharedPtr<FieldEnd> fieldEnd) override
    {
        if (fieldEnd->get_Font()->get_Hidden())
        {
            fieldEnd->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitFieldSeparator(SharedPtr<FieldSeparator> fieldSeparator) override
    {
        if (fieldSeparator->get_Font()->get_Hidden())
        {
            fieldSeparator->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitRun(SharedPtr<Run> run) override
    {
        if (run->get_Font()->get_Hidden())
        {
            run->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitParagraphStart(SharedPtr<Paragraph> paragraph) override
    {
        if (paragraph->get_ParagraphBreakFont()->get_Hidden())
        {
            paragraph->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitFormField(SharedPtr<FormField> formField) override
    {
        if (formField->get_Font()->get_Hidden())
        {
            formField->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitGroupShapeStart(SharedPtr<GroupShape> groupShape) override
    {
        if (groupShape->get_Font()->get_Hidden())
        {
            groupShape->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitShapeStart(SharedPtr<Shape> shape) override
    {
        if (shape->get_Font()->get_Hidden())
        {
            shape->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitCommentStart(SharedPtr<Comment> comment) override
    {
        if (comment->get_Font()->get_Hidden())
        {
            comment->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitFootnoteStart(SharedPtr<Footnote> footnote) override
    {
        if (footnote->get_Font()->get_Hidden())
        {
            footnote->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitSpecialChar(SharedPtr<SpecialChar> specialChar) override
    {
        if (specialChar->get_Font()->get_Hidden())
        {
            specialChar->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitTableEnd(SharedPtr<Table> table) override
    {
        // The content inside table cells may have the hidden content flag, but the tables themselves cannot.
        // If this table had nothing but hidden content, this visitor would have removed all of it,
        // and there would be no child nodes left.
        // Thus, we can also treat the table itself as hidden content and remove it.
        // Tables which are empty but do not have hidden content will have cells with empty paragraphs inside,
        // which this visitor will not remove.
        if (!table->get_HasChildNodes())
        {
            table->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitCellEnd(SharedPtr<Cell> cell) override
    {
        if (!cell->get_HasChildNodes() && cell->get_ParentNode() != nullptr)
        {
            cell->Remove();
        }
 
        return VisitorAction::Continue;
    }
 
    VisitorAction VisitRowEnd(SharedPtr<Row> row) override
    {
        if (!row->get_HasChildNodes() && row->get_ParentNode() != nullptr)
        {
            row->Remove();
        }
 
        return VisitorAction::Continue;
    }
};

Implements Aspose::Words::Node.

get_Id()

int32_t Aspose::Words::Markup::StructuredDocumentTagRangeEnd::get_Id

(

)

const

Specifies a unique read-only persistent numerical Id for this StructuredDocumentTagRange node. Corresponding StructuredDocumentTagRangeStart node has the same Id.

Examples

Shows how to get the properties of multi-section structured document tags.

auto doc = MakeObject<Document>(MyDir + u"Multi-section structured document tags.docx");
 
auto rangeStartTag =
    System::DynamicCast_noexcept<StructuredDocumentTagRangeStart>(doc->GetChildNodes(NodeType::StructuredDocumentTagRangeStart, true)->idx_get(0));
auto rangeEndTag =
    System::DynamicCast_noexcept<StructuredDocumentTagRangeEnd>(doc->GetChildNodes(NodeType::StructuredDocumentTagRangeEnd, true)->idx_get(0));
 
std::cout << "StructuredDocumentTagRangeStart values:" << std::endl;
std::cout << "\t|Id: " << rangeStartTag->get_Id() << std::endl;
std::cout << "\t|Title: " << rangeStartTag->get_Title() << std::endl;
std::cout << "\t|PlaceholderName: " << rangeStartTag->get_PlaceholderName() << std::endl;
std::cout << String::Format(u"\t|IsShowingPlaceholderText: {0}", rangeStartTag->get_IsShowingPlaceholderText()) << std::endl;
std::cout << String::Format(u"\t|LockContentControl: {0}", rangeStartTag->get_LockContentControl()) << std::endl;
std::cout << String::Format(u"\t|LockContents: {0}", rangeStartTag->get_LockContents()) << std::endl;
std::cout << String::Format(u"\t|Level: {0}", rangeStartTag->get_Level()) << std::endl;
std::cout << String::Format(u"\t|NodeType: {0}", rangeStartTag->get_NodeType()) << std::endl;
std::cout << "\t|RangeEnd: " << rangeStartTag->get_RangeEnd() << std::endl;
std::cout << "\t|Color: " << rangeStartTag->get_Color().ToArgb() << std::endl;
std::cout << String::Format(u"\t|SdtType: {0}", rangeStartTag->get_SdtType()) << std::endl;
std::cout << "\t|Tag: " << rangeStartTag->get_Tag() << "\n" << std::endl;
 
std::cout << "StructuredDocumentTagRangeEnd values:" << std::endl;
std::cout << "\t|Id: " << rangeEndTag->get_Id() << std::endl;
std::cout << String::Format(u"\t|NodeType: {0}", rangeEndTag->get_NodeType()) << std::endl;

get_NodeType()

Aspose::Words::NodeType Aspose::Words::Markup::StructuredDocumentTagRangeEnd::get_NodeType ( ) const

overridevirtual

Gets the type of this node.

Examples

Shows how to traverse a composite node's tree of child nodes.

void RecurseChildren()
{
    auto doc = MakeObject<Document>(MyDir + u"Paragraphs.docx");
 
    // Any node that can contain child nodes, such as the document itself, is composite.
    ASSERT_TRUE(doc->get_IsComposite());
 
    // Invoke the recursive function that will go through and print all the child nodes of a composite node.
    TraverseAllNodes(doc, 0);
}
 
void TraverseAllNodes(SharedPtr<CompositeNode> parentNode, int depth)
{
    for (SharedPtr<Node> childNode = parentNode->get_FirstChild(); childNode != nullptr; childNode = childNode->get_NextSibling())
    {
        std::cout << (String(u'\t', depth)) << Node::NodeTypeToString(childNode->get_NodeType());
 
        // Recurse into the node if it is a composite node. Otherwise, print its contents if it is an inline node.
        if (childNode->get_IsComposite())
        {
            std::cout << std::endl;
            TraverseAllNodes(System::DynamicCast<CompositeNode>(childNode), depth + 1);
        }
        else if (System::ObjectExt::Is<Inline>(childNode))
        {
            std::cout << " - \"" << childNode->GetText().Trim() << "\"" << std::endl;
        }
        else
        {
            std::cout << std::endl;
        }
    }
}

Shows how to remove all child nodes of a specific type from a composite node.

auto doc = MakeObject<Document>(MyDir + u"Tables.docx");
 
ASSERT_EQ(2, doc->GetChildNodes(NodeType::Table, true)->get_Count());
 
SharedPtr<Node> curNode = doc->get_FirstSection()->get_Body()->get_FirstChild();
 
while (curNode != nullptr)
{
    // Save the next sibling node as a variable in case we want to move to it after deleting this node.
    SharedPtr<Node> nextNode = curNode->get_NextSibling();
 
    // A section body can contain Paragraph and Table nodes.
    // If the node is a Table, remove it from the parent.
    if (curNode->get_NodeType() == NodeType::Table)
    {
        curNode->Remove();
    }
 
    curNode = nextNode;
}
 
ASSERT_EQ(0, doc->GetChildNodes(NodeType::Table, true)->get_Count());

Shows how to use a node's NextSibling property to enumerate through its immediate children.

auto doc = MakeObject<Document>(MyDir + u"Paragraphs.docx");
 
for (SharedPtr<Node> node = doc->get_FirstSection()->get_Body()->get_FirstChild(); node != nullptr; node = node->get_NextSibling())
{
    std::cout << std::endl;
    std::cout << "Node type: " << Node::NodeTypeToString(node->get_NodeType()) << std::endl;
 
    String contents = node->GetText().Trim();
    std::cout << (contents == String::Empty ? u"This node contains no text" : String::Format(u"Contents: \"{0}\"", node->GetText().Trim()))
              << std::endl;
}

Implements Aspose::Words::Node.

GetType()

virtual const System::TypeInfo& Aspose::Words::Markup::StructuredDocumentTagRangeEnd::GetType ( ) const

overridevirtual

Reimplemented from Aspose::Words::Node.

Is()

virtual bool Aspose::Words::Markup::StructuredDocumentTagRangeEnd::Is ( const System::TypeInfo &  target ) const

overridevirtual

Reimplemented from Aspose::Words::Node.

Type()

static const System::TypeInfo& Aspose::Words::Markup::StructuredDocumentTagRangeEnd::Type ( )

static