Redactor class

Redactor class

Represents a main class that controls document redaction process, allowing to open, redact and save documents.

The Redactor type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of Redactor class using file path.
init Initializes a new instance of Redactor class using stream.
init Initializes a new instance of Redactor class for a password-protected document using its path.
init Initializes a new instance of Redactor class for a password-protected document using its path and settings.
init Initializes a new instance of Redactor class for a password-protected document using stream.
init Initializes a new instance of Redactor class for a password-protected document using stream and settings.

Methods

Method Description
apply Applies a redaction to the document.
apply Applies a set of redactions to the document.
apply Applies a redaction policy to the document.
save Saves the document to a file with the following options: AddSuffix = true, RasterizeToPDF = true.
save Saves the document to a file.
save Saves the document to a stream, including custom location.
generate_preview Generates preview images of specific pages in a given image format.
get_document_info Gets the general information about the document - size, page count, etc.

Remarks

Learn more | | | |

Example

The following example demonstrates applying a single redaction to the document.

The following example demonstrates applying a list of redactions to the document.

The following example demonstrates how to apply a redaction policy to all files within a given inbound folder, and save to one of outbound folders - for successfully updated files and for failed ones.

The following example demonstrates how to open a password-protected documents using LoadOptions.

The following example demonstrates how to save a document using SaveOptions.

See Also

RedactionResult class RedactorChangeLog class