Aspose::Words::Tables::Row Class Reference

Represents a table row. More...

#include "Aspose.Words.Cpp/Model/Tables/Row.h"

Inherits Aspose::Words::CompositeNode, IRowAttrSource, and ITrackableNode.

Public Member Functions

virtual Aspose::Words::NodeType get_NodeType () const
 Returns NodeType.Row. More...
 
System::SharedPtr< Aspose::Words::Tables::Tableget_ParentTable ()
 Returns the immediate parent table of the row. More...
 
bool get_IsFirstRow ()
 True if this is the first row in a table; false otherwise. More...
 
bool get_IsLastRow ()
 True if this is the last row in a table; false otherwise. More...
 
System::SharedPtr< Aspose::Words::Tables::Cellget_FirstCell ()
 Returns the first Cell in the row. More...
 
System::SharedPtr< Aspose::Words::Tables::Cellget_LastCell ()
 Returns the last Cell in the row. More...
 
System::SharedPtr< Aspose::Words::Tables::CellCollectionget_Cells ()
 Provides typed access to the Cell child nodes of the row. More...
 
System::SharedPtr< Aspose::Words::Tables::RowFormatget_RowFormat ()
 Provides access to the formatting properties of the row. More...
 
System::SharedPtr< Aspose::Words::Revisions::EditRevision > get_InsertRevision ()
 
void set_InsertRevision (System::SharedPtr< Aspose::Words::Revisions::EditRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::EditRevision > get_DeleteRevision ()
 
void set_DeleteRevision (System::SharedPtr< Aspose::Words::Revisions::EditRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::MoveRevision > get_MoveFromRevision ()
 
void set_MoveFromRevision (System::SharedPtr< Aspose::Words::Revisions::MoveRevision > value)
 
System::SharedPtr< Aspose::Words::Revisions::MoveRevision > get_MoveToRevision ()
 
void set_MoveToRevision (System::SharedPtr< Aspose::Words::Revisions::MoveRevision > value)
 
 Row (System::SharedPtr< Aspose::Words::DocumentBase > doc)
 Initializes a new instance of the Row class. More...
 
virtual bool Accept (System::SharedPtr< Aspose::Words::DocumentVisitor > visitor)
 Accepts a visitor. More...
 
virtual System::String GetText ()
 Gets the text of all cells in this row including the end of row character. More...
 
void EnsureMinimum ()
 If the Row has no cells, creates and appends one Cell. More...
 
System::SharedPtr< System::ObjectGetDirectRowAttr (int32_t key)
 
System::SharedPtr< System::ObjectFetchRowAttr (int32_t key)
 
System::SharedPtr< System::ObjectFetchInheritedRowAttr (int32_t key)
 
void SetRowAttr (int32_t key, System::SharedPtr< System::Object > value)
 
void ClearRowAttrs ()
 
void ResetToDefaultAttrs ()
 
- 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 ()
 
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
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)
 
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

Represents a table row.

Row can only be a child of a Table.

Row can contain one or more Cell nodes.

A minimal valid row needs to have at least one Cell.

Constructor & Destructor Documentation

◆ Row()

Aspose::Words::Tables::Row::Row ( System::SharedPtr< Aspose::Words::DocumentBase doc)

Initializes a new instance of the Row class.

When Row is created, it belongs to the specified document, but is not yet part of the document and ParentNode is null.

To append Row to the document use InsertAfter or InsertBefore on the table where you want the row inserted.

Parameters
docThe owner document.

Member Function Documentation

◆ Accept()

virtual bool Aspose::Words::Tables::Row::Accept ( System::SharedPtr< Aspose::Words::DocumentVisitor visitor)
virtual

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
visitorThe visitor that will visit the nodes.
Returns
True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

Calls DocumentVisitor.VisitRowStart, then calls Accept for all child nodes of the section and calls DocumentVisitor.VisitRowEnd at the end.

Implements Aspose::Words::Node.

◆ ClearRowAttrs()

void Aspose::Words::Tables::Row::ClearRowAttrs ( )

◆ EnsureMinimum()

void Aspose::Words::Tables::Row::EnsureMinimum ( )

If the Row has no cells, creates and appends one Cell.

◆ FetchInheritedRowAttr()

System::SharedPtr<System::Object> Aspose::Words::Tables::Row::FetchInheritedRowAttr ( int32_t  key)

◆ FetchRowAttr()

System::SharedPtr<System::Object> Aspose::Words::Tables::Row::FetchRowAttr ( int32_t  key)

◆ get_Cells()

System::SharedPtr<Aspose::Words::Tables::CellCollection> Aspose::Words::Tables::Row::get_Cells ( )

Provides typed access to the Cell child nodes of the row.

◆ get_DeleteRevision()

System::SharedPtr<Aspose::Words::Revisions::EditRevision> Aspose::Words::Tables::Row::get_DeleteRevision ( )

◆ get_FirstCell()

System::SharedPtr<Aspose::Words::Tables::Cell> Aspose::Words::Tables::Row::get_FirstCell ( )

Returns the first Cell in the row.

◆ get_InsertRevision()

System::SharedPtr<Aspose::Words::Revisions::EditRevision> Aspose::Words::Tables::Row::get_InsertRevision ( )

◆ get_IsFirstRow()

bool Aspose::Words::Tables::Row::get_IsFirstRow ( )

True if this is the first row in a table; false otherwise.

◆ get_IsLastRow()

bool Aspose::Words::Tables::Row::get_IsLastRow ( )

True if this is the last row in a table; false otherwise.

◆ get_LastCell()

System::SharedPtr<Aspose::Words::Tables::Cell> Aspose::Words::Tables::Row::get_LastCell ( )

Returns the last Cell in the row.

◆ get_MoveFromRevision()

System::SharedPtr<Aspose::Words::Revisions::MoveRevision> Aspose::Words::Tables::Row::get_MoveFromRevision ( )

◆ get_MoveToRevision()

System::SharedPtr<Aspose::Words::Revisions::MoveRevision> Aspose::Words::Tables::Row::get_MoveToRevision ( )

◆ get_NodeType()

virtual Aspose::Words::NodeType Aspose::Words::Tables::Row::get_NodeType ( ) const
virtual

Returns NodeType.Row.

Implements Aspose::Words::Node.

◆ get_ParentTable()

System::SharedPtr<Aspose::Words::Tables::Table> Aspose::Words::Tables::Row::get_ParentTable ( )

Returns the immediate parent table of the row.

Equivalent to (Table)FirstNonMarkupParentNode.

◆ get_RowFormat()

System::SharedPtr<Aspose::Words::Tables::RowFormat> Aspose::Words::Tables::Row::get_RowFormat ( )

Provides access to the formatting properties of the row.

◆ GetDirectRowAttr()

System::SharedPtr<System::Object> Aspose::Words::Tables::Row::GetDirectRowAttr ( int32_t  key)

◆ GetText()

virtual System::String Aspose::Words::Tables::Row::GetText ( )
virtual

Gets the text of all cells in this row including the end of row character.

Returns concatenated text of all child nodes with the end of row character ControlChar.Cell appended at the end.

The returned string includes all control and special characters as described in Aspose::Words::ControlChar.

Reimplemented from Aspose::Words::CompositeNode.

◆ ResetToDefaultAttrs()

void Aspose::Words::Tables::Row::ResetToDefaultAttrs ( )

◆ set_DeleteRevision()

void Aspose::Words::Tables::Row::set_DeleteRevision ( System::SharedPtr< Aspose::Words::Revisions::EditRevision >  value)

◆ set_InsertRevision()

void Aspose::Words::Tables::Row::set_InsertRevision ( System::SharedPtr< Aspose::Words::Revisions::EditRevision >  value)

◆ set_MoveFromRevision()

void Aspose::Words::Tables::Row::set_MoveFromRevision ( System::SharedPtr< Aspose::Words::Revisions::MoveRevision >  value)

◆ set_MoveToRevision()

void Aspose::Words::Tables::Row::set_MoveToRevision ( System::SharedPtr< Aspose::Words::Revisions::MoveRevision >  value)

◆ SetRowAttr()

void Aspose::Words::Tables::Row::SetRowAttr ( int32_t  key,
System::SharedPtr< System::Object value 
)