Page::Redact method¶

Redact removes a range of words and blacks out the location for the specified range from the page.

Overloads¶

Redact(Word, Word)¶

Prototype¶

void Redact(Word firstWord, Word lastWord)

void Redact(Word firstWord, Word lastWord) throws IGRException;

def Redact(self, firstWord: Word, lastWord: Word) -> void

void Redact(Word firstWord, Word lastWord)

void Redact(Word firstWord, Word lastWord)

HRESULT Redact([in] Word* firstWord, [in] Word* lastWord)

Parameters¶

firstWord: Word : The first word to redact.

lastWord: Word : The first word to redact.

Redact(int, int)¶

Prototype¶

void Redact(int firstWord, int lastWord)

void Redact(int firstWord, int lastWord) throws IGRException;

def Redact(self, firstWord: int, lastWord: int) -> void

void Redact(int firstWord, int lastWord)

void Redact(int firstWord, int lastWord)

HRESULT Redact([in] int firstWord, [in] int lastWord)

Parameters¶

firstWord: int : The first word to redact.

lastWord: int : The first word to redact.

Sample Code¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

using Hyland.DocumentFilters;

var api = new Hyland.DocumentFilters.Api();
api.Initialize("License Code", ".");

using var doc = api.GetExtractor("filename.doc");
doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

using var page = Document.Page(0);
if (page.WordCount > 15)
    page.Redact(0, 14);

using var canvas = Filters.MakeOutputCanvas("output.pdf", IGR_DEVICE_IMAGE_PDF, "");
canvas.RenderPage(page);

Additional Information¶

It should be assumed that redacted content will not persist between closing and re-opening a page. To create a redacted Image, PDF, or HTML file, first open a Page, perform the redaction, and render the Page to a Canvas before closing it.

The API allows for redacting single words or a range of words. When redacting a range, whitespace between the words will also be redacted.

See Also¶

• Page interface