PageRangeFilter Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.redaction.redactions.RedactionFilter
public class PageRangeFilter extends RedactionFilter
Represents redaction filter, setting page range inside a document to apply redaction.
Learn more
- More details about applying redactions: Redaction basics
- More details about redaction filters: Use PDF redaction filters
| Constructor | Description |
|---|---|
| PageRangeFilter(PageSeekOrigin origin, int index, int count) | Initializes a new instance of RemovePageRedaction class. |
| Method | Description |
|---|---|
| getOrigin() | Gets seek reference position, the beginning or the end of a document. |
| getIndex() | Gets start position index (0-based). |
| getCount() | Gets the count of pages to remove. |
| isPageInRange(int pageIndex, int pageCount) | Checks if this filter page range contains given page. |
public PageRangeFilter(PageSeekOrigin origin, int index, int count)
Initializes a new instance of RemovePageRedaction class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| origin | PageSeekOrigin | Seek reference position, the beginning or the end of a document |
| index | int | Start position index (0-based) |
| count | int | Count of pages to remove |
public final PageSeekOrigin getOrigin()
Gets seek reference position, the beginning or the end of a document.
Returns: PageSeekOrigin - Seek reference position, the beginning or the end of a document.
public final int getIndex()
Gets start position index (0-based).
Returns: int - Start position index (0-based).
public final int getCount()
Gets the count of pages to remove.
Returns: int - The count of pages to remove.
public final boolean isPageInRange(int pageIndex, int pageCount)
Checks if this filter page range contains given page.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageIndex | int | index of the page (zero-bazed) |
| pageCount | int | total page count |
Returns: boolean - true, if this filter range contains page
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
