Aspose::Words::ParagraphCollection Class Reference
Provides typed access to a collection of Aspose::Words::Paragraph nodes. More...
#include "Aspose.Words.Cpp/Model/Text/ParagraphCollection.h"
Inherits Aspose::Words::NodeCollection.
Public Member Functions | |
| System::SharedPtr< Aspose::Words::Paragraph > | idx_get (int32_t index) |
| Retrieves a Paragraph at the given index. More... | |
| System::ArrayPtr< System::SharedPtr< Aspose::Words::Paragraph > > | ToArray () |
| Copies all paragraphs from the collection to a new array of paragraphs. More... | |
 Public Member Functions inherited from Aspose::Words::NodeCollection | |
| int32_t | get_Count () |
| Gets the number of nodes in the collection. More... | |
| System::SharedPtr< Aspose::Words::CompositeNode > | get_Container () |
| System::SharedPtr< Aspose::Words::Node > | idx_get (int32_t index) |
| Retrieves a node at the given index. More... | |
| void | Add (System::SharedPtr< Aspose::Words::Node > node) |
| Adds a node to the end of the collection. More... | |
| void | Insert (int32_t index, System::SharedPtr< Aspose::Words::Node > node) |
| Inserts a node into the collection at the specified index. More... | |
| void | Remove (System::SharedPtr< Aspose::Words::Node > node) |
| Removes the node from the collection and from the document. More... | |
| void | RemoveAt (int32_t index) |
| Removes the node at the specified index from the collection and from the document. More... | |
| void | Clear () |
| Removes all nodes from this collection and from the document. More... | |
| bool | Contains (System::SharedPtr< Aspose::Words::Node > node) |
| Determines whether a node is in the collection. More... | |
| int32_t | IndexOf (System::SharedPtr< Aspose::Words::Node > node) |
| Returns the zero-based index of the specified node. More... | |
| System::ArrayPtr< System::SharedPtr< Aspose::Words::Node > > | ToArray () |
| Copies all nodes from the collection to a new array of nodes. More... | |
| System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Node > > > | GetEnumerator () |
| System::SharedPtr< Aspose::Words::Node > | GetNextMatchingNode (System::SharedPtr< Aspose::Words::Node > &curNode) |
| 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... | |
| Object & | operator= (Object const &x) |
| Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object * | SharedRefAdded () |
| 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 TypeInfo & | GetType () 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::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Node > > | |
| typedef IEnumerator< System::SharedPtr< Aspose::Words::Node > > | IEnumeratorType |
| Enumerator type. More... | |
| Public Types inherited from System::Object | |
| typedef SmartPtr< Object > | ptr |
| Alias for smart pointer type. More... | |
| typedef System::Details::SharedMembersType | shared_members_type |
| structure to keep list of shared pointers contained in object. 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 TypeInfo & | Type () |
| 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
Provides typed access to a collection of Aspose::Words::Paragraph nodes.
Member Function Documentation
◆ idx_get()
| System::SharedPtr<Aspose::Words::Paragraph> Aspose::Words::ParagraphCollection::idx_get | ( | int32_t | index | ) |
Retrieves a Paragraph at the given index.
The index is zero-based.
Negative indexes are allowed and indicate access from the back of the collection. For example -1 means the last item, -2 means the second before last and so on.
If index is greater than or equal to the number of items in the list, this returns a null reference.
If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.
- Parameters
-
index An index into the collection.
◆ ToArray()
| System::ArrayPtr<System::SharedPtr<Aspose::Words::Paragraph> > Aspose::Words::ParagraphCollection::ToArray | ( | ) |
Copies all paragraphs from the collection to a new array of paragraphs.
- Returns
- An array of paragraphs.