com.groupdocs.redaction.redactions

Class RemovePageRedaction

java.lang.Object

com.groupdocs.redaction.Redaction

com.groupdocs.redaction.redactions.RemovePageRedaction

public class RemovePageRedaction
extends Redaction

Represents a redaction that removes a page (slide, worksheet, etc.) from a document.

Learn more

• More details about applying redactions: Redaction basics
• More details about removing pages: Remove page redaction

The following example demonstrates how to remove the last page of the document.

try (Redactor redactor = new Redactor("C:\\test.pdf"))
 {
    redactor.apply(new RemovePageRedaction(PageSeekOrigin.END, 0, 1));
    redactor.save()
 }
  

Constructor Summary

Constructors

Constructor and Description
RemovePageRedaction(PageSeekOrigin origin, int index, int count) Initializes a new instance of RemovePageRedaction class.

Method Summary

Modifier and Type	Method and Description
RedactorLogEntry	applyTo(DocumentFormatInstance formatInstance) Applies the redaction to a given format instance.
int	getCount() Gets the count of pages to remove.
int	getIndex() Gets start position index (0-based).
PageSeekOrigin	getOrigin() Gets seek reference position, the beginning or the end of a document.

Methods inherited from class com.groupdocs.redaction.Redaction

getDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemovePageRedaction

public RemovePageRedaction(PageSeekOrigin origin,
                           int index,
                           int count)

Initializes a new instance of RemovePageRedaction class.

Parameters:

origin - Seek reference position, the beginning or the end of a document

index - Start position index (0-based)

count - Count of pages to remove

Method Detail

applyTo

public RedactorLogEntry applyTo(DocumentFormatInstance formatInstance)

Applies the redaction to a given format instance.

Specified by:

applyTo in class Redaction

Parameters:

formatInstance - An instance of a document to apply redaction

Returns:

Status of the redaction: success/failure and error message if any

getCount

public final int getCount()

Gets the count of pages to remove.

Returns:

The count of pages to remove.

getIndex

public final int getIndex()

Gets start position index (0-based).

Returns:

Start position index (0-based).

getOrigin

public final PageSeekOrigin getOrigin()

Gets seek reference position, the beginning or the end of a document.

Returns:

Seek reference position, the beginning or the end of a document.