Aspose::Words::InlineStory Class Referenceabstract

Base class for inline-level nodes that can contain paragraphs and tables. More...

#include "Aspose.Words.Cpp/Model/Text/InlineStory.h"

Inherits Aspose::Words::CompositeNode, and IInline.

Inherited by Aspose::Words::Comment, and Aspose::Words::Footnote.

Public Member Functions

virtual Aspose::Words::StoryType get_StoryType ()=0
 Returns the type of the story. More...
 
System::SharedPtr< Aspose::Words::Paragraphget_ParentParagraph ()
 Retrieves the parent Aspose::Words::Paragraph of this node. More...
 
System::SharedPtr< Aspose::Words::Paragraphget_FirstParagraph ()
 Gets the first paragraph in the story. More...
 
System::SharedPtr< Aspose::Words::Paragraphget_LastParagraph ()
 Gets the last paragraph in the story. More...
 
System::SharedPtr< Aspose::Words::ParagraphCollectionget_Paragraphs ()
 Gets a collection of paragraphs that are immediate children of the story. More...
 
System::SharedPtr< Aspose::Words::Tables::TableCollectionget_Tables ()
 Gets a collection of tables that are immediate children of the story. More...
 
bool get_IsInsertRevision ()
 Returns true if this object was inserted in Microsoft Word while change tracking was enabled. More...
 
bool get_IsDeleteRevision ()
 Returns true if this object was deleted in Microsoft Word while change tracking was enabled. More...
 
bool get_IsMoveFromRevision ()
 Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled. More...
 
bool get_IsMoveToRevision ()
 Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled. More...
 
System::SharedPtr< Aspose::Words::Fontget_Font ()
 Provides access to the font formatting of the anchor character of this object. More...
 
System::SharedPtr< Aspose::Words::RunPr > get_RunPr_IInline ()
 
void set_RunPr_IInline (System::SharedPtr< Aspose::Words::RunPr > value)
 
System::SharedPtr< Aspose::Words::Paragraphget_ParentParagraph_IInline ()
 
System::SharedPtr< Aspose::Words::DocumentBaseget_Document_IInline ()
 
int32_t get_DirectRunAttrsCount ()
 
void EnsureMinimum ()
 If the last child is not a paragraph, creates and appends one empty paragraph. More...
 
System::SharedPtr< Aspose::Words::RunPr > GetExpandedRunPr_IInline (Aspose::Words::RunPrExpandFlags flags)
 
System::SharedPtr< System::ObjectGetDirectRunAttr (int32_t fontAttr)
 
System::SharedPtr< System::ObjectFetchInheritedRunAttr (int32_t fontAttr)
 
void SetRunAttr (int32_t fontAttr, System::SharedPtr< System::Object > value)
 
void RemoveRunAttr (int32_t key)
 
void ClearRunAttrs ()
 
- Public Member Functions inherited from Aspose::Words::CompositeNode
virtual bool get_IsComposite ()
 Returns true as this node can have child nodes. More...
 
bool get_HasChildNodes ()
 Returns true if this node has any child nodes. More...
 
System::SharedPtr< Aspose::Words::NodeCollectionget_ChildNodes ()
 Gets all immediate child nodes of this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_FirstChild () const
 Gets the first child of the node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_LastChild () const
 Gets the last child of the node. More...
 
int32_t get_Count ()
 Gets the number of immediate children of this node. More...
 
System::SharedPtr< Aspose::Words::CompositeNodeget_Container ()
 
virtual ~CompositeNode ()
 
virtual System::String GetText ()
 Gets the text of this node and of all its children. More...
 
System::SharedPtr< Aspose::Words::NodeCollectionGetChildNodes (Aspose::Words::NodeType nodeType, bool isDeep)
 Returns a live collection of child nodes that match the specified type. More...
 
System::SharedPtr< Aspose::Words::NodeGetChild (Aspose::Words::NodeType nodeType, int32_t index, bool isDeep)
 Returns an Nth child node that matches the specified type. More...
 
System::SharedPtr< Aspose::Words::NodeListSelectNodes (System::String xpath)
 Selects a list of nodes matching the XPath expression. More...
 
System::SharedPtr< Aspose::Words::NodeSelectSingleNode (System::String xpath)
 Selects the first Node that matches the XPath expression. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Node > > > GetEnumerator ()
 Provides support for the for each style iteration over the child nodes of this node. More...
 
System::SharedPtr< Aspose::Words::NodeAppendChild (System::SharedPtr< Aspose::Words::Node > newChild)
 Adds the specified node to the end of the list of child nodes for this node. More...
 
System::SharedPtr< Aspose::Words::NodePrependChild (System::SharedPtr< Aspose::Words::Node > newChild)
 Adds the specified node to the beginning of the list of child nodes for this node. More...
 
System::SharedPtr< Aspose::Words::NodeInsertAfter (System::SharedPtr< Aspose::Words::Node > newChild, System::SharedPtr< Aspose::Words::Node > refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
System::SharedPtr< Aspose::Words::NodeInsertBefore (System::SharedPtr< Aspose::Words::Node > newChild, System::SharedPtr< Aspose::Words::Node > refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
System::SharedPtr< Aspose::Words::NodeRemoveChild (System::SharedPtr< Aspose::Words::Node > oldChild)
 Removes the specified child node. More...
 
void RemoveAllChildren ()
 Removes all the child nodes of the current node. More...
 
void RemoveSmartTags ()
 Removes all Aspose::Words::Markup::SmartTag descendant nodes of the current node. More...
 
int32_t IndexOf (System::SharedPtr< Aspose::Words::Node > child)
 Returns the index of the specified child node in the child node array. More...
 
System::SharedPtr< Aspose::Words::NodeGetNextMatchingNode (System::SharedPtr< Aspose::Words::Node > &curNode)
 
- Public Member Functions inherited from Aspose::Words::Node
virtual Aspose::Words::NodeType get_NodeType () const =0
 Gets the type of this node. More...
 
System::SharedPtr< Aspose::Words::CompositeNodeget_ParentNode ()
 Gets the immediate parent of this node. More...
 
System::SharedPtr< Aspose::Words::DocumentBaseget_Document ()
 Gets the document to which this node belongs. More...
 
System::SharedPtr< Aspose::Words::Nodeget_PreviousSibling ()
 Gets the node immediately preceding this node. More...
 
System::SharedPtr< Aspose::Words::Nodeget_NextSibling ()
 Gets the node immediately following this node. More...
 
System::SharedPtr< Aspose::Words::Rangeget_Range ()
 Returns a Range object that represents the portion of a document that is contained in this node. More...
 
System::SharedPtr< Aspose::Words::NodeClone (bool isCloneChildren)
 
virtual bool Accept (System::SharedPtr< Aspose::Words::DocumentVisitor > visitor)=0
 Accepts a visitor. More...
 
template<typename T >
GetAncestorOf ()
 
System::SharedPtr< Aspose::Words::CompositeNodeGetAncestor (Aspose::Words::NodeType ancestorType)
 Gets the first ancestor of the specified Aspose::Words::NodeType. More...
 
void Remove ()
 Removes itself from the parent. More...
 
System::SharedPtr< Aspose::Words::NodeNextPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets next node according to the pre-order tree traversal algorithm. More...
 
System::SharedPtr< Aspose::Words::NodePreviousPreOrder (System::SharedPtr< Aspose::Words::Node > rootNode)
 Gets the previous node according to the pre-order tree traversal algorithm. More...
 
System::String ToString (Aspose::Words::SaveFormat saveFormat)
 Exports the content of the node into a string in the specified format. More...
 
System::String ToString (System::SharedPtr< Aspose::Words::Saving::SaveOptions > saveOptions)
 Exports the content of the node into a string using the specified save options. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > >
typedef IEnumerator< System::SharedPtr< Aspose::Words::Node > > IEnumeratorType
 Enumerator type. More...
 
- Static Public Member Functions inherited from Aspose::Words::Node
static System::String NodeTypeToString (Aspose::Words::NodeType nodeType)
 A utility method that converts a node type enum value into a user friendly string. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Base class for inline-level nodes that can contain paragraphs and tables.

InlineStory is a container for block-level nodes Aspose::Words::Paragraph and Aspose::Words::Tables::Table.

The classes that derive from InlineStory are inline-level nodes that can contain their own text (paragraphs and tables). For example, a Comment node contains text of a comment and a Footnote contains text of a footnote.

Member Function Documentation

◆ ClearRunAttrs()

void Aspose::Words::InlineStory::ClearRunAttrs ( )

◆ EnsureMinimum()

void Aspose::Words::InlineStory::EnsureMinimum ( )

If the last child is not a paragraph, creates and appends one empty paragraph.

◆ FetchInheritedRunAttr()

System::SharedPtr<System::Object> Aspose::Words::InlineStory::FetchInheritedRunAttr ( int32_t  fontAttr)

◆ get_DirectRunAttrsCount()

int32_t Aspose::Words::InlineStory::get_DirectRunAttrsCount ( )

◆ get_Document_IInline()

System::SharedPtr<Aspose::Words::DocumentBase> Aspose::Words::InlineStory::get_Document_IInline ( )

◆ get_FirstParagraph()

System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::InlineStory::get_FirstParagraph ( )

Gets the first paragraph in the story.

◆ get_Font()

System::SharedPtr<Aspose::Words::Font> Aspose::Words::InlineStory::get_Font ( )

Provides access to the font formatting of the anchor character of this object.

◆ get_IsDeleteRevision()

bool Aspose::Words::InlineStory::get_IsDeleteRevision ( )

Returns true if this object was deleted in Microsoft Word while change tracking was enabled.

◆ get_IsInsertRevision()

bool Aspose::Words::InlineStory::get_IsInsertRevision ( )

Returns true if this object was inserted in Microsoft Word while change tracking was enabled.

◆ get_IsMoveFromRevision()

bool Aspose::Words::InlineStory::get_IsMoveFromRevision ( )

Returns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.

◆ get_IsMoveToRevision()

bool Aspose::Words::InlineStory::get_IsMoveToRevision ( )

Returns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.

◆ get_LastParagraph()

System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::InlineStory::get_LastParagraph ( )

Gets the last paragraph in the story.

◆ get_Paragraphs()

System::SharedPtr<Aspose::Words::ParagraphCollection> Aspose::Words::InlineStory::get_Paragraphs ( )

Gets a collection of paragraphs that are immediate children of the story.

◆ get_ParentParagraph()

System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::InlineStory::get_ParentParagraph ( )

Retrieves the parent Aspose::Words::Paragraph of this node.

◆ get_ParentParagraph_IInline()

System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::InlineStory::get_ParentParagraph_IInline ( )

◆ get_RunPr_IInline()

System::SharedPtr<Aspose::Words::RunPr> Aspose::Words::InlineStory::get_RunPr_IInline ( )

◆ get_StoryType()

virtual Aspose::Words::StoryType Aspose::Words::InlineStory::get_StoryType ( )
pure virtual

Returns the type of the story.

Implemented in Aspose::Words::Comment, and Aspose::Words::Footnote.

◆ get_Tables()

System::SharedPtr<Aspose::Words::Tables::TableCollection> Aspose::Words::InlineStory::get_Tables ( )

Gets a collection of tables that are immediate children of the story.

◆ GetDirectRunAttr()

System::SharedPtr<System::Object> Aspose::Words::InlineStory::GetDirectRunAttr ( int32_t  fontAttr)

◆ GetExpandedRunPr_IInline()

System::SharedPtr<Aspose::Words::RunPr> Aspose::Words::InlineStory::GetExpandedRunPr_IInline ( Aspose::Words::RunPrExpandFlags  flags)

◆ RemoveRunAttr()

void Aspose::Words::InlineStory::RemoveRunAttr ( int32_t  key)

◆ set_RunPr_IInline()

void Aspose::Words::InlineStory::set_RunPr_IInline ( System::SharedPtr< Aspose::Words::RunPr >  value)

◆ SetRunAttr()

void Aspose::Words::InlineStory::SetRunAttr ( int32_t  fontAttr,
System::SharedPtr< System::Object value 
)