Collection of PDF document pages. More...

Inherits System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Page > >, and Aspose::Pdf::ISupportsMemoryCleanup.

Classes

class  PagesEnumerableUnrestricted
 

Public Member Functions

ASPOSE_PDF_SHARED_API int32_t get_Count () const override
 Gets count of pages in the document. More...
 
ASPOSE_PDF_SHARED_API bool get_IsSynchronized ()
 Returns true of object is synchorinzed. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Objectget_SyncRoot () const
 Gets synchronization object of the collection. More...
 
ASPOSE_PDF_SHARED_API bool get_IsReadOnly () const override
 Gets value indicating of collection is readonly. Always returns false. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< PageCopyPage (System::SharedPtr< Page > entity)
 Adds page to collection. More...
 
ASPOSE_PDF_SHARED_API void Clear () override
 Clear page collection. More...
 
ASPOSE_PDF_SHARED_API void Delete (int32_t index)
 Delete specified page. More...
 
ASPOSE_PDF_SHARED_API void Delete ()
 Deletes all pages from collection. More...
 
ASPOSE_PDF_SHARED_API int32_t IndexOf (System::SharedPtr< Page > entity) const
 Returns index of the specified page. More...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::SharedPtr< Page >> array, int32_t index) override
 Copyies pages into document. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Page > > > GetEnumerator () override
 Returns enumerator of pages. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< Annotations::AnnotationSelector > visitor)
 Accepts AnnotationSelector visitor object that provides functionality to work with annotations. More...
 
ASPOSE_PDF_SHARED_API void Delete (System::ArrayPtr< int32_t > pages)
 Delete pages specified which numbers are specified in array. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< PageInsert (int32_t pageNumber)
 Insert empty apge into collection at the specified position. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< PageAdd ()
 Adds empty page More...
 
ASPOSE_PDF_SHARED_API void Add (const System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< Page >>> &pages)
 Adds to collection all pages from list. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< PageInsert (int32_t pageNumber, System::SharedPtr< Page > entity)
 Inserts page into page collection at specified place. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Pageidx_get (int32_t index)
 Gets page by index. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< ImagePlacementAbsorber > visitor)
 Accepts ImagePlacementAbsorber visitor object that provides functionality to work with image placement objects. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< Text::TextFragmentAbsorber > visitor)
 Accepts TextFragmentAbsorber visitor object that provides functionality to work with text objects. More...
 
ASPOSE_PDF_SHARED_API void Accept (System::SharedPtr< Text::TextAbsorber > visitor)
 Accepts TextAbsorber visitor object that provides functionality to work with text objects. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::ArrayPtr< System::SharedPtr< Page >> &pages)
 Adds to collection all pages from array. More...
 
ASPOSE_PDF_SHARED_API void Insert (int32_t pageNumber, System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< Page >>> pages)
 Inserts pages from the collection into document. More...
 
ASPOSE_PDF_SHARED_API void Insert (int32_t pageNumber, System::ArrayPtr< System::SharedPtr< Page >> pages)
 Inserts pages of the array into document. More...
 
ASPOSE_PDF_SHARED_API void Flatten ()
 Removes all fields located on the pages and place their values instead. More...
 
ASPOSE_PDF_SHARED_API void FreeMemory () override
 Clears cached data More...
 
ASPOSE_PDF_SHARED_API bool Contains (const System::SharedPtr< Page > &item) const override
 Determines whether this instance contains the object. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::SharedPtr< Page > &item) override
 Removes the specified item, throws
Exceptions
NotSupportedExceptionNotSupportedException

. More...

 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Page > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Page > > array, int arrayIndex)=0
 Copies all collection elements to existing array elements. More...
 
ICollectionoperator= (ICollection &&) noexcept
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&) noexcept
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Page > >
System::SharedPtr< Aspose::Pdf::PageLINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
System::SharedPtr< Aspose::Pdf::PageLINQ_First ()
 Returns the first element of a sequence. More...
 
System::SharedPtr< Aspose::Pdf::PageLINQ_First (const Func< System::SharedPtr< Aspose::Pdf::Page >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
System::SharedPtr< Aspose::Pdf::PageLINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
System::SharedPtr< Aspose::Pdf::PageLINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Pdf::Page >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
System::SharedPtr< Aspose::Pdf::PageLINQ_Last ()
 Returns the last element of a sequence. More...
 
System::SharedPtr< Aspose::Pdf::PageLINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< System::SharedPtr< Aspose::Pdf::Page > > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< System::SharedPtr< Aspose::Pdf::Page >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Page > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(System::SharedPtr< Aspose::Pdf::Page >)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(System::SharedPtr< Aspose::Pdf::Page >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Page > > > LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Pdf::Page >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (System::SharedPtr< Aspose::Pdf::Page > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Page > > > LINQ_OrderBy (const Func< System::SharedPtr< Aspose::Pdf::Page >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Page > > > LINQ_OrderByDescending (const Func< System::SharedPtr< Aspose::Pdf::Page >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::Page >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::Page >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Page > > > LINQ_Concat (SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Page > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, System::SharedPtr< Aspose::Pdf::Page > > > > > LINQ_GroupBy (System::Func< System::SharedPtr< Aspose::Pdf::Page >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< System::SharedPtr< Aspose::Pdf::Page >, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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 reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

System::SharedPtr< PageCollection::PagesEnumerableUnrestrictedget_Unrestricted ()
 
bool get_AnnotationsAdded () const
 
 PageCollection (System::SharedPtr< Document > document)
 Constructor of PageCollection class. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (PageCollection, CODEPORTING_ARGS(System::SharedPtr< Document > document))
 
System::SharedPtr< PageGetUnrestricted (int32_t index)
 Returns page by its index. Page More...
 
System::SharedPtr< PageInsert (int32_t pageNumber, System::SharedPtr< Page > entity, System::SharedPtr< Copier > copier)
 Inserts page into document using specified copier. More...
 
System::SharedPtr< PageAdd (System::SharedPtr< Page > entity, System::SharedPtr< Copier > copier)
 Adds page to document using passed copier object. More...
 
void Add (System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< Page >>> pages, System::SharedPtr< Copier > copier)
 
void Dispose ()
 frees up memory More...
 
System::SharedPtr< PageFindByObjectId (int32_t objectID)
 
System::SharedPtr< PageFindByPdfObject (System::SharedPtr< Engine::Data::IPdfObject > pdfObject)
 
virtual ASPOSE_PDF_SHARED_API ~PageCollection ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Page > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Protected Attributes

System::WeakPtr< Document_document
 
System::SharedPtr< Engine::CommonData::IPages > pages
 PageCollection object from Pdf Engine More...
 
bool FreezeNumbersCache
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Page > >
typedef System::SharedPtr< Aspose::Pdf::PageValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< Aspose::Pdf::Page > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Page > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::Page > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = System::SharedPtr< Aspose::Pdf::Page >
 
using iterator = System::Details::VirtualizedIterator< System::SharedPtr< Aspose::Pdf::Page > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< System::SharedPtr< Aspose::Pdf::Page > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< System::SharedPtr< Aspose::Pdf::Page > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = System::SharedPtr< Aspose::Pdf::Page >
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Collection of PDF document pages.

Constructor & Destructor Documentation

◆ PageCollection()

Aspose::Pdf::PageCollection::PageCollection ( System::SharedPtr< Document document)
protected

Constructor of PageCollection class.

Parameters
documentDocument instance

◆ ~PageCollection()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::PageCollection::~PageCollection ( )
protectedvirtual

Member Function Documentation

◆ Accept() [1/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Accept ( System::SharedPtr< Annotations::AnnotationSelector visitor)

Accepts AnnotationSelector visitor object that provides functionality to work with annotations.

Parameters
visitorAnnotationSelector Visitor

◆ Accept() [2/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Accept ( System::SharedPtr< ImagePlacementAbsorber visitor)

Accepts ImagePlacementAbsorber visitor object that provides functionality to work with image placement objects.

Parameters
visitorImage placement object.

◆ Accept() [3/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Accept ( System::SharedPtr< Text::TextFragmentAbsorber visitor)

Accepts TextFragmentAbsorber visitor object that provides functionality to work with text objects.

Parameters
visitorText fragment absorber object.

◆ Accept() [4/4]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Accept ( System::SharedPtr< Text::TextAbsorber visitor)

Accepts TextAbsorber visitor object that provides functionality to work with text objects.

Parameters
visitorText absorber object.

◆ Add() [1/5]

ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Aspose::Pdf::PageCollection::Add ( )

Adds empty page

Returns
Added page.

◆ Add() [2/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Add ( const System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< Page >>> &  pages)

Adds to collection all pages from list.

Parameters
pagesList which contains all pages which must be added.

◆ Add() [3/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Add ( const System::ArrayPtr< System::SharedPtr< Page >> &  pages)

Adds to collection all pages from array.

Parameters
pagesArray of pages which will be added.

◆ Add() [4/5]

System::SharedPtr<Page> Aspose::Pdf::PageCollection::Add ( System::SharedPtr< Page entity,
System::SharedPtr< Copier >  copier 
)
protected

Adds page to document using passed copier object.

Parameters
entity
copier

◆ Add() [5/5]

void Aspose::Pdf::PageCollection::Add ( System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< Page >>>  pages,
System::SharedPtr< Copier >  copier 
)
protected

◆ Clear()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Clear ( )
overridevirtual

◆ Contains()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::PageCollection::Contains ( const System::SharedPtr< Page > &  item) const
overridevirtual

Determines whether this instance contains the object.

Parameters
itemThe item.
Returns
true if [contains] [the specified item]; otherwise, false.
Exceptions
NotSupportedException

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Page > >.

◆ CopyPage()

ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Aspose::Pdf::PageCollection::CopyPage ( System::SharedPtr< Page entity)

Adds page to collection.

Parameters
entityPage which should be added.
Returns
Added page.

◆ CopyTo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< Page >>  array,
int32_t  index 
)
override

Copyies pages into document.

Parameters
arrayArray containing Pages object to insert into document. It must be Object[] or Page[].
indexStarting index where pages will be inserted

◆ Delete() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Delete ( int32_t  index)

Delete specified page.

Parameters
indexNumber of page that will be deleted. Pages numbers start from 1.

◆ Delete() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Delete ( )

Deletes all pages from collection.

◆ Delete() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Delete ( System::ArrayPtr< int32_t >  pages)

Delete pages specified which numbers are specified in array.

Parameters
pagesArray of pages to be deleted.

◆ Dispose()

void Aspose::Pdf::PageCollection::Dispose ( )
protected

frees up memory

◆ FindByObjectId()

System::SharedPtr<Page> Aspose::Pdf::PageCollection::FindByObjectId ( int32_t  objectID)
protected

◆ FindByPdfObject()

System::SharedPtr<Page> Aspose::Pdf::PageCollection::FindByPdfObject ( System::SharedPtr< Engine::Data::IPdfObject >  pdfObject)
protected

◆ Flatten()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Flatten ( )

Removes all fields located on the pages and place their values instead.

◆ FreeMemory()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::FreeMemory ( )
overridevirtual

Clears cached data

Implements Aspose::Pdf::ISupportsMemoryCleanup.

◆ get_AnnotationsAdded()

bool Aspose::Pdf::PageCollection::get_AnnotationsAdded ( ) const
protected

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::PageCollection::get_Count ( ) const
overridevirtual

◆ get_IsReadOnly()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::PageCollection::get_IsReadOnly ( ) const
overridevirtual

Gets value indicating of collection is readonly. Always returns false.

Reimplemented from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Page > >.

◆ get_IsSynchronized()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::PageCollection::get_IsSynchronized ( )

Returns true of object is synchorinzed.

◆ get_SyncRoot()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::PageCollection::get_SyncRoot ( ) const

Gets synchronization object of the collection.

◆ get_Unrestricted()

System::SharedPtr<PageCollection::PagesEnumerableUnrestricted> Aspose::Pdf::PageCollection::get_Unrestricted ( )
protected

◆ GetEnumerator()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Page> > > Aspose::Pdf::PageCollection::GetEnumerator ( )
overridevirtual

Returns enumerator of pages.

Returns
Enumerator of pages

Implements System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Page > >.

◆ GetUnrestricted()

System::SharedPtr<Page> Aspose::Pdf::PageCollection::GetUnrestricted ( int32_t  index)
protected

Returns page by its index. Page

Parameters
indexIndex of requested page. Pages are numbered from 1.
Returns
Requested page

◆ idx_get()

ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Aspose::Pdf::PageCollection::idx_get ( int32_t  index)

Gets page by index.

Parameters
indexIndex of page.
Returns
Retreived page.

◆ IndexOf()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::PageCollection::IndexOf ( System::SharedPtr< Page entity) const

Returns index of the specified page.

Pages numbers start from 1. Returns 0 in case collection doesn't contain the page.

Parameters
entityPage object. Pages numbers start from 1.
Returns
Index of the page in collection.

◆ Insert() [1/5]

ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Aspose::Pdf::PageCollection::Insert ( int32_t  pageNumber)

Insert empty apge into collection at the specified position.

Parameters
pageNumberPosition of the new page.
Returns
Inserted page.

◆ Insert() [2/5]

ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Aspose::Pdf::PageCollection::Insert ( int32_t  pageNumber,
System::SharedPtr< Page entity 
)

Inserts page into page collection at specified place.

Parameters
pageNumberRequired page index in collection.
entityPage to be inserted.
Returns
Inserted page.

◆ Insert() [3/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Insert ( int32_t  pageNumber,
System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< Page >>>  pages 
)

Inserts pages from the collection into document.

Parameters
pageNumberStarting position of the new pages.
pagesPages collection.

◆ Insert() [4/5]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PageCollection::Insert ( int32_t  pageNumber,
System::ArrayPtr< System::SharedPtr< Page >>  pages 
)

Inserts pages of the array into document.

Parameters
pageNumberStarting number of the new pages.
pagesArray of pages which will be inserted.

◆ Insert() [5/5]

System::SharedPtr<Page> Aspose::Pdf::PageCollection::Insert ( int32_t  pageNumber,
System::SharedPtr< Page entity,
System::SharedPtr< Copier >  copier 
)
protected

Inserts page into document using specified copier.

Parameters
pageNumberStarting position of the new pages.
entityPage to be inserted.
copierCopier object.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::PageCollection::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( PageCollection  ,
CODEPORTING_ARGS(System::SharedPtr< Document > document)   
)
protected

◆ Remove()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::PageCollection::Remove ( const System::SharedPtr< Page > &  item)
overridevirtual

Removes the specified item, throws

Exceptions
NotSupportedExceptionNotSupportedException

.

Parameters
itemThe item.
Returns
Exceptions
NotSupportedExceptionNotSupportedException

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Page > >.

Member Data Documentation

◆ _document

System::WeakPtr<Document> Aspose::Pdf::PageCollection::_document
protected

◆ FreezeNumbersCache

bool Aspose::Pdf::PageCollection::FreezeNumbersCache
protected

◆ pages

System::SharedPtr<Engine::CommonData::IPages> Aspose::Pdf::PageCollection::pages
protected

PageCollection object from Pdf Engine