Redactor Class |
Namespace: GroupDocs.Redaction
The Redactor type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | Redactor(Stream) |
Initializes a new instance of Redactor class using stream.
|
![]() ![]() | Redactor(String) |
Initializes a new instance of Redactor class using file path.
|
![]() ![]() | Redactor(Stream, LoadOptions) |
Initializes a new instance of Redactor class for a password-protected document using stream.
|
![]() | Redactor(String, LoadOptions) |
Initializes a new instance of Redactor class for a password-protected document using its path.
|
![]() ![]() | Redactor(Stream, LoadOptions, RedactorSettings) |
Initializes a new instance of Redactor class for a password-protected document using stream and settings.
|
![]() | Redactor(String, LoadOptions, RedactorSettings) |
Initializes a new instance of Redactor class for a password-protected document using its path and settings.
|
Name | Description | |
---|---|---|
![]() ![]() | Apply(Redaction) |
Applies a redaction to the document.
|
![]() ![]() | Apply(Redaction) |
Applies a set of redactions to the document.
|
![]() ![]() | Apply(RedactionPolicy) |
Applies a redaction policy to the document.
|
![]() | Dispose |
Releases resources.
|
![]() | Equals | (Inherited from Object.) |
![]() ![]() | GeneratePreview |
Generates preview images of specific pages in a given image format.
|
![]() ![]() | GetDocumentInfo |
Gets the general information about the document - size, page count, etc.
|
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetType | (Inherited from Object.) |
![]() | Save |
Saves the document to a file with the following options: AddSuffix = true, RasterizeToPDF = true.
|
![]() ![]() | Save(SaveOptions) |
Saves the document to a file.
|
![]() ![]() | Save(Stream, RasterizationOptions) |
Saves the document to a stream, including custom location.
|
![]() | ToString | (Inherited from Object.) |
The following example demonstrates applying a single redaction to the document.
using (Redactor redactor = new Redactor(@"D:\\test.docx")) { RedactorChangeLog result = redactor.Apply(new RegexRedaction(LookupStrings.SSNRegexPattern, new ReplacementOptions("[ssn]"))); if (result.Status != RedactionStatus.Failed) { redactor.Save(); }; }
The following example demonstrates applying a list of redactions to the document.
using (Redactor redactor = new Redactor(@"D:\\test.docx")) { var redactionList = new Redaction[] { new ExactPhraseRedaction(LookupStrings.ClientName, new ReplacementOptions("[client]")), new ExactPhraseRedaction(LookupStrings.ClientAddress, new ReplacementOptions(System.Drawing.Color.Red)), new RegexRedaction(LookupStrings.SSNRegexPattern, new ReplacementOptions("[ssn]")), new RegexRedaction(LookupStrings.BankCardRegexPattern, new ReplacementOptions(System.Drawing.Color.Blue)), // ... other redactions new DeleteAnnotationRedaction("(?im:(use|show|describe))"), new EraseMetadataRedaction(MetadataFilter.Author), new MetadataSearchRedaction(LookupStrings.CompanyName, "--company--") }; RedactorChangeLog result = redactor.Apply(redactionList); // false, if at least one redaction failed if (result.Status != RedactionStatus.Failed) { redactor.Save(); }; }
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.
RedactionPolicy policy = RedactionPolicy.Load("RedactionPolicy.xml"); foreach (var fileEntry in Directory.GetFileNames("C:\\Inbound")) { using (Redactor redactor = new Redactor(Path.Combine("C:\\Inbound\\", fileEntry))) { RedactorChangeLog result = redactor.Apply(policy); String resultFolder = result.Status != RedactionStatus.Failed ? "C:\\Outbound\\Done\\" : "C:\\Outbound\\Failed\\"; using (Stream fileStream = File.Open(Path.Combine(resultFolder, fileEntry), FileMode.Open, FileAccess.ReadWrite)) { redactor.Save(fileStream, new RasterizationOptions() { Enabled = false }); } } }
The following example demonstrates how to open a password-protected documents using LoadOptions.
LoadOptions loadOptions = new LoadOptions("mypassword"); using (Redactor redactor = new Redactor(@"C:\sample.pdf", loadOptions)) { // Here we can use document instance to perform redactions }
The following example demonstrates how to save a document using SaveOptions.
using (Redactor redactor = new Redactor(@"C:\sample.pdf")) { // Document redaction goes here // ... // Save the document with default options (convert pages into images, save as PDF) redactor.Save(); // Save the document in original format overwriting original file redactor.Save(new SaveOptions() { AddSuffix = false, RasterizeToPDF = false }); // Save the document to "*_Redacted.*" file in original format redactor.Save(new SaveOptions() { AddSuffix = true, RasterizeToPDF = false }); // Save the document to "*_AnyText.*" (e.g. timestamp instead of "AnyText") in its file name without rasterization redactor.Save(new SaveOptions(false, "AnyText")); }