 | RedactOptions Class |
Class specifies options used to redact text from PDF files.
Inheritance HierarchyNamespace: Opait.Redact
Assembly: Opait.Redact (in Opait.Redact.dll) Version: 1.3.3.0
SyntaxC#
public sealed class RedactOptions
The RedactOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RedactOptions |
Initializes a new instance of the RedactOptions class.
|
| RedactOptions(XElement) |
Initializes a new instance of the RedactOptions class from the specified XML element.
|
Properties| Name | Description | |
|---|---|---|
 | CanRedact |
Gets a flag to indicate that the redaction has at least one active rule.
|
| Encrypt |
Gets or sets a value to indicate whether redacted characters are
encrypted and stored in the PDF metadata stream.
|
| Password |
An optional password to encrypt redaction data before storing
in the PDF metadata stream. If not specified and the document
is encrypted, then the OwnerPassword, if specified, will be
used also as the redaction password. If both of RedactPassword
and OwnerPassword are unspecified, then a standard secret
password will be use to encrypt the redaction data.
|
| WhiteBox |
Option controls whether redactions are drawn using black or
while boxes.
|
Methods| Name | Description | |
|---|---|---|
| FromXml |
Loads redaction options from teh specified XML element.
|
| Reset |
Resets all redaction rules.
|
| ToXml |
Saves the current instance as an XML element.
|
Fields| Name | Description | |
|---|---|---|
 | RedactRules |
List of regular expression patterns used to detect
redacted text.
|
See Also