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
Implements
Inherited Members
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 |
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 |
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 |
Returns
Type | Description |
---|---|
PageIterator | a |
Set(PageIterator)
Sets value to the given PageIterator
object
Declaration
public void Set(PageIterator p)
Parameters
Type | Name | Description |
---|---|---|
PageIterator | p | given |
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 | r | a |
Returns
Type | Description |
---|---|
System.Boolean | true, if both |
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 | r | a |
Returns
Type | Description |
---|---|
System.Boolean | true, if both |