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

object

PageIterator

Implements

IDisposable

Inherited Members

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

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(bool)

Declaration

[HandleProcessCorruptedStateExceptions]
protected virtual void Dispose(bool A_0)

Parameters

Type	Name	Description
bool	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
object	o	a given Object

Returns

Type	Description
bool	true, if equals to the given object

~PageIterator()

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

Declaration

protected ~PageIterator()

GetPageNumber()

Gets the page number

Declaration

public int GetPageNumber()

Returns

Type	Description
int	page number

HasNext()

Determine if true if the iteration has more elements.

Declaration

public bool HasNext()

Returns

Type	Description
bool	true if the iteration has more elements.

Next()

iterates to next Page object

Declaration

public void Next()

Set(PageIterator)

Sets value to the given PageIterator object

Declaration

public void Set(PageIterator p)

Parameters

Type	Name	Description
PageIterator	p	given PageIterator object

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

Operators

operator ==(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
bool	true, if both PageIterator are equal

operator !=(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
bool	true, if both PageIterator are not equal

Implements

IDisposable