|
Aspose::Words::Story Class Reference
Base class for elements that contain block-level nodes Paragraph and Table.
Text of a Word document is said to consist of several stories. The main text is stored in the main text story represented by Body, each header and footer is stored in a separate story represented by HeaderFooter.
- Examples
Shows how to remove all shapes from a node.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Use a DocumentBuilder to insert a shape. This is an inline shape,
// which has a parent Paragraph, which is a child node of the first section's Body.
builder->InsertShape(ShapeType::Cube, 100.0, 100.0);
ASSERT_EQ(1, doc->GetChildNodes(NodeType::Shape, true)->get_Count());
// We can delete all shapes from the child paragraphs of this Body.
ASSERT_EQ(StoryType::MainText, doc->get_FirstSection()->get_Body()->get_StoryType());
doc->get_FirstSection()->get_Body()->DeleteShapes();
ASSERT_EQ(0, doc->GetChildNodes(NodeType::Shape, true)->get_Count());
#include <Aspose.Words.Cpp/Story.h>
Inheritance diagram for Aspose::Words::Story:
Public Member Functions | |
| SharedPtr< Paragraph > | AppendParagraph (String text) |
| A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object. More... | |
| void | DeleteShapes () |
| Deletes all shapes from the text of this story. More... | |
| SharedPtr< Paragraph > | get_FirstParagraph () |
| Gets the first paragraph in the story. More... | |
| SharedPtr< Paragraph > | get_LastParagraph () |
| Gets the last paragraph in the story. More... | |
| SharedPtr< ParagraphCollection > | get_Paragraphs () |
| Gets a collection of paragraphs that are immediate children of the story. More... | |
| StoryType | get_StoryType () const |
| Gets the type of this story. More... | |
| SharedPtr< TableCollection > | get_Tables () |
| Gets a collection of tables that are immediate children of the story. More... | |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| Public Member Functions inherited from CompositeNode | |
| SharedPtr< Node > | AppendChild (SharedPtr< Node > newChild) |
| Adds the specified node to the end of the list of child nodes for this node. More... | |
| SharedPtr< NodeCollection > | get_ChildNodes () |
| Gets all immediate child nodes of this node. More... | |
| SharedPtr< CompositeNode > | get_Container () override |
| int32_t | get_Count () |
| Gets the number of immediate children of this node. More... | |
| SharedPtr< Node > | get_FirstChild () const |
| Gets the first child of the node. More... | |
| bool | get_HasChildNodes () |
| Returns true if this node has any child nodes. More... | |
| bool | get_IsComposite () override |
| Returns true as this node can have child nodes. More... | |
| SharedPtr< Node > | get_LastChild () const |
| Gets the last child of the node. More... | |
| SharedPtr< Node > | GetChild (NodeType nodeType, int32_t index, bool isDeep) |
| Returns an Nth child node that matches the specified type. More... | |
| SharedPtr< NodeCollection > | GetChildNodes (NodeType nodeType, bool isDeep) |
| Returns a live collection of child nodes that match the specified type. More... | |
| SharedPtr< Node > | GetCurrentNode () override |
| SharedPtr< IEnumerator< SharedPtr< Node > > > | GetEnumerator () override |
| Provides support for the for each style iteration over the child nodes of this node. More... | |
| SharedPtr< Node > | GetNextMatchingNode (SharedPtr< Node > curNode) override |
| String | GetText () override |
| Gets the text of this node and of all its children. More... | |
| int32_t | IndexOf (SharedPtr< Node > child) |
| Returns the index of the specified child node in the child node array. More... | |
| SharedPtr< Node > | InsertAfter (SharedPtr< Node > newChild, SharedPtr< Node > refChild) |
| Inserts the specified node immediately after the specified reference node. More... | |
| SharedPtr< Node > | InsertBefore (SharedPtr< Node > newChild, SharedPtr< Node > refChild) |
| Inserts the specified node immediately before the specified reference node. More... | |
| SharedPtr< Node > | PrependChild (SharedPtr< Node > newChild) |
| Adds the specified node to the beginning of the list of child nodes for this node. More... | |
| void | RemoveAllChildren () |
| Removes all the child nodes of the current node. More... | |
| SharedPtr< Node > | RemoveChild (SharedPtr< Node > oldChild) |
| Removes the specified child node. More... | |
| void | RemoveSmartTags () |
| Removes all SmartTag descendant nodes of the current node. More... | |
| SharedPtr< NodeList > | SelectNodes (String xpath) |
| Selects a list of nodes matching the XPath expression. More... | |
| SharedPtr< Node > | SelectSingleNode (String xpath) |
| Selects the first Node that matches the XPath expression. More... | |
| Public Member Functions inherited from Node | |
| virtual bool | Accept (SharedPtr< DocumentVisitor > visitor)=0 |
| Accepts a visitor. More... | |
| 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... | |
| SharedPtr< Node > | get_NextSibling () |
| Gets the node immediately following this node. More... | |
| virtual NodeType | get_NodeType () const =0 |
| Gets the type of 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 () |
| SharedPtr< Node > | NextPreOrder (SharedPtr< Node > rootNode) |
| Gets next node according to the pre-order tree traversal algorithm. More... | |
| SharedPtr< Node > | PreviousPreOrder (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 (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 CompositeNode | |
| 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 () |
Member Function Documentation
◆ AppendParagraph()
| System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::Story::AppendParagraph | ( | System::String | text | ) |
A shortcut method that creates a Paragraph object with optional text and appends it to the end of this object.
- Parameters
-
text The text for the paragraph. Can be null or empty string.
- Returns
- The newly created and appended paragraph.
- Examples
Shows how to create a header and a footer.
auto doc = MakeObject<Document>();
// Create a header and append a paragraph to it. The text in that paragraph
// will appear at the top of every page of this section, above the main body text.
auto header = MakeObject<HeaderFooter>(doc, HeaderFooterType::HeaderPrimary);
doc->get_FirstSection()->get_HeadersFooters()->Add(header);
SharedPtr<Paragraph> para = header->AppendParagraph(u"My header.");
ASSERT_TRUE(header->get_IsHeader());
ASSERT_TRUE(para->get_IsEndOfHeaderFooter());
// Create a footer and append a paragraph to it. The text in that paragraph
// will appear at the bottom of every page of this section, below the main body text.
auto footer = MakeObject<HeaderFooter>(doc, HeaderFooterType::FooterPrimary);
doc->get_FirstSection()->get_HeadersFooters()->Add(footer);
para = footer->AppendParagraph(u"My footer.");
ASSERT_FALSE(footer->get_IsHeader());
ASSERT_TRUE(para->get_IsEndOfHeaderFooter());
ASPOSE_ASSERT_EQ(footer, para->get_ParentStory());
ASPOSE_ASSERT_EQ(footer->get_ParentSection(), para->get_ParentSection());
ASPOSE_ASSERT_EQ(footer->get_ParentSection(), header->get_ParentSection());
doc->Save(ArtifactsDir + u"HeaderFooter.Create.docx");
◆ DeleteShapes()
| void Aspose::Words::Story::DeleteShapes | ( | ) |
Deletes all shapes from the text of this story.
- Examples
Shows how to remove all shapes from a node.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Use a DocumentBuilder to insert a shape. This is an inline shape,
// which has a parent Paragraph, which is a child node of the first section's Body.
builder->InsertShape(ShapeType::Cube, 100.0, 100.0);
ASSERT_EQ(1, doc->GetChildNodes(NodeType::Shape, true)->get_Count());
// We can delete all shapes from the child paragraphs of this Body.
ASSERT_EQ(StoryType::MainText, doc->get_FirstSection()->get_Body()->get_StoryType());
doc->get_FirstSection()->get_Body()->DeleteShapes();
ASSERT_EQ(0, doc->GetChildNodes(NodeType::Shape, true)->get_Count());
◆ get_FirstParagraph()
| System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::Story::get_FirstParagraph | ( | ) |
Gets the first paragraph in the story.
- Examples
Shows how to format a run of text using its font property.
auto doc = MakeObject<Document>();
auto run = MakeObject<Run>(doc, u"Hello world!");
SharedPtr<Aspose::Words::Font> font = run->get_Font();
font->set_Name(u"Courier New");
font->set_Size(36);
font->set_HighlightColor(System::Drawing::Color::get_Yellow());
doc->get_FirstSection()->get_Body()->get_FirstParagraph()->AppendChild(run);
doc->Save(ArtifactsDir + u"Font.CreateFormattedRun.docx");
Shows how to create and format a text box.
auto doc = MakeObject<Document>();
// Create a floating text box.
auto textBox = MakeObject<Shape>(doc, ShapeType::TextBox);
textBox->set_WrapType(WrapType::None);
textBox->set_Height(50);
textBox->set_Width(200);
// Set the horizontal, and vertical alignment of the text inside the shape.
textBox->set_HorizontalAlignment(HorizontalAlignment::Center);
textBox->set_VerticalAlignment(VerticalAlignment::Top);
// Add a paragraph to the text box and add a run of text that the text box will display.
textBox->AppendChild(MakeObject<Paragraph>(doc));
SharedPtr<Paragraph> para = textBox->get_FirstParagraph();
para->get_ParagraphFormat()->set_Alignment(ParagraphAlignment::Center);
auto run = MakeObject<Run>(doc);
run->set_Text(u"Hello world!");
para->AppendChild(run);
doc->get_FirstSection()->get_Body()->get_FirstParagraph()->AppendChild(textBox);
doc->Save(ArtifactsDir + u"Shape.CreateTextBox.docx");
◆ get_LastParagraph()
| System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::Story::get_LastParagraph | ( | ) |
Gets the last paragraph in the story.
- Examples
Shows how to move a DocumentBuilder's cursor position to a specified node.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Writeln(u"Run 1. ");
// The document builder has a cursor, which acts as the part of the document
// where the builder appends new nodes when we use its document construction methods.
// This cursor functions in the same way as Microsoft Word's blinking cursor,
// and it also always ends up immediately after any node that the builder just inserted.
// To append content to a different part of the document,
// we can move the cursor to a different node with the "MoveTo" method.
builder->MoveTo(doc->get_FirstSection()->get_Body()->get_FirstParagraph()->get_Runs()->idx_get(0));
// The cursor is now in front of the node that we moved it to.
// Adding a second run will insert it in front of the first run.
builder->Writeln(u"Run 2. ");
ASSERT_EQ(u"Run 2. \rRun 1.", doc->GetText().Trim());
// Move the cursor to the end of the document to continue appending text to the end as before.
builder->MoveTo(doc->get_LastSection()->get_Body()->get_LastParagraph());
builder->Writeln(u"Run 3. ");
ASSERT_EQ(u"Run 2. \rRun 1. \rRun 3.", doc->GetText().Trim());
◆ get_Paragraphs()
| System::SharedPtr<Aspose::Words::ParagraphCollection> Aspose::Words::Story::get_Paragraphs | ( | ) |
Gets a collection of paragraphs that are immediate children of the story.
- Examples
Shows how to check whether a paragraph is a move revision.
auto doc = MakeObject<Document>(MyDir + u"Revisions.docx");
// This document contains "Move" revisions, which appear when we highlight text with the cursor,
// and then drag it to move it to another location
// while tracking revisions in Microsoft Word via "Review" -> "Track changes".
ASSERT_EQ(6, doc->get_Revisions()->LINQ_Count([](SharedPtr<Revision> r) { return r->get_RevisionType() == RevisionType::Moving; }));
SharedPtr<ParagraphCollection> paragraphs = doc->get_FirstSection()->get_Body()->get_Paragraphs();
// Move revisions consist of pairs of "Move from", and "Move to" revisions.
// These revisions are potential changes to the document that we can either accept or reject.
// Before we accept/reject a move revision, the document
// must keep track of both the departure and arrival destinations of the text.
// The second and the fourth paragraph define one such revision, and thus both have the same contents.
ASSERT_EQ(paragraphs->idx_get(1)->GetText(), paragraphs->idx_get(3)->GetText());
// The "Move from" revision is the paragraph where we dragged the text from.
// If we accept the revision, this paragraph will disappear,
// and the other will remain and no longer be a revision.
ASSERT_TRUE(paragraphs->idx_get(1)->get_IsMoveFromRevision());
// The "Move to" revision is the paragraph where we dragged the text to.
// If we reject the revision, this paragraph instead will disappear, and the other will remain.
ASSERT_TRUE(paragraphs->idx_get(3)->get_IsMoveToRevision());
◆ get_StoryType()
| Aspose::Words::StoryType Aspose::Words::Story::get_StoryType | ( | ) | const |
Gets the type of this story.
- Examples
Shows how to remove all shapes from a node.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
// Use a DocumentBuilder to insert a shape. This is an inline shape,
// which has a parent Paragraph, which is a child node of the first section's Body.
builder->InsertShape(ShapeType::Cube, 100.0, 100.0);
ASSERT_EQ(1, doc->GetChildNodes(NodeType::Shape, true)->get_Count());
// We can delete all shapes from the child paragraphs of this Body.
ASSERT_EQ(StoryType::MainText, doc->get_FirstSection()->get_Body()->get_StoryType());
doc->get_FirstSection()->get_Body()->DeleteShapes();
ASSERT_EQ(0, doc->GetChildNodes(NodeType::Shape, true)->get_Count());
◆ get_Tables()
| System::SharedPtr<Aspose::Words::Tables::TableCollection> Aspose::Words::Story::get_Tables | ( | ) |
Gets a collection of tables that are immediate children of the story.
- Examples
Shows how to remove the first and last rows of all tables in a document.
auto doc = MakeObject<Document>(MyDir + u"Tables.docx");
SharedPtr<TableCollection> tables = doc->get_FirstSection()->get_Body()->get_Tables();
ASSERT_EQ(5, tables->idx_get(0)->get_Rows()->get_Count());
ASSERT_EQ(4, tables->idx_get(1)->get_Rows()->get_Count());
for (const auto& table : System::IterateOver(tables->LINQ_OfType<SharedPtr<Table>>()))
{
if (table->get_FirstRow() != nullptr)
{
table->get_FirstRow()->Remove();
}
if (table->get_LastRow() != nullptr)
{
table->get_LastRow()->Remove();
}
}
ASSERT_EQ(3, tables->idx_get(0)->get_Rows()->get_Count());
ASSERT_EQ(2, tables->idx_get(1)->get_Rows()->get_Count());
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::CompositeNode.
Reimplemented in Aspose::Words::HeaderFooter, and Aspose::Words::Body.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::CompositeNode.
Reimplemented in Aspose::Words::HeaderFooter, and Aspose::Words::Body.
◆ Type()
|
static |