Show / Hide Table of Contents

Class PageIterator

PageIterator is an iterator type that can be used to traverse a list pages in a PDF document. For more information, please PDFDoc::GetPageIterator().

Inheritance
System.Object
PageIterator
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: pdftron.PDF
Assembly: PDFNet.dll
Syntax
public class PageIterator : IDisposable

Methods

Current()

Gets the current Page object

Declaration
public Page Current()
Returns
Type Description
Page

current Page object

Dispose()

Releases all resources used by the PageIterator

Declaration
public override sealed void Dispose()

Dispose(Boolean)

Declaration
[HandleProcessCorruptedStateExceptions]
protected virtual void Dispose(bool A_0)
Parameters
Type Name Description
System.Boolean A_0

Equals(Object)

Checks whether this PageIterator is the same as the specified object.

Declaration
public bool Equals(object o)
Parameters
Type Name Description
System.Object o

a given Object

Returns
Type Description
System.Boolean

true, if equals to the given object

Finalize()

Allows a PageIterator to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Declaration
protected void Finalize()

GetPageNumber()

Gets the page number

Declaration
public int GetPageNumber()
Returns
Type Description
System.Int32

page number

HasNext()

Determine if true if the iteration has more elements.

Declaration
public bool HasNext()
Returns
Type Description
System.Boolean

true if the iteration has more elements.

Next()

iterates to next Page object

Declaration
public void Next()

op_Assign(PageIterator)

Assignment operator

Declaration
public PageIterator op_Assign(PageIterator r)
Parameters
Type Name Description
PageIterator r

a PageIterator at the right of the operator

Returns
Type Description
PageIterator

a PageIterator equals to the given object

Set(PageIterator)

Sets value to the given PageIterator object

Declaration
public void Set(PageIterator p)
Parameters
Type Name Description
PageIterator p

given PageIterator object

Operators

Equality(PageIterator, PageIterator)

Equality operator checks whether two PageIterator objects are the same.

Declaration
public static bool operator ==(PageIterator l, PageIterator r)
Parameters
Type Name Description
PageIterator l

a PageIterator at the left of the operator

PageIterator r

a PageIterator at the right of the operator

Returns
Type Description
System.Boolean

true, if both PageIterator are equal

Inequality(PageIterator, PageIterator)

Inequality operator checks whether two PageIterator objects are different.

Declaration
public static bool operator !=(PageIterator l, PageIterator r)
Parameters
Type Name Description
PageIterator l

a PageIterator at the left of the operator

PageIterator r

a PageIterator at the right of the operator

Returns
Type Description
System.Boolean

true, if both PageIterator are not equal

Implements

System.IDisposable
Back to top Generated by DocFX