Class RedactionCreationOptions

Defines how to create redactions for a matched RedactionMatchRule.

Inheritance
Object
RedactionCreationOptions
Inherited Members
Namespace: Accusoft.PrizmDocServer.Redaction
Assembly: PrizmDocServerSDK.dll
Syntax
public class RedactionCreationOptions

Constructors

RedactionCreationOptions()

Initializes a new instance of the RedactionCreationOptions class.

Declaration
public RedactionCreationOptions()

Properties

BorderColor

Gets or sets the border color of the redaction box to use for all redactions created by a rule. Value must be a CSS-style, 6-character RGB hex value, like "#FF0000" (red), or null for the remote server default, typically "#000000" (black). Default is null.

Declaration
public string BorderColor { get; set; }
Property Value
Type Description
String
Remarks

Only applies when viewing redactions in the viewer or when producing a redacted PDF. Does not apply when producing redacted plain text.

BorderThickness

Gets or sets the pixel width of the redaction box border to use for all redactions created by a rule, or null for the remote server default, typically 1. Default is null.

Declaration
public uint? BorderThickness { get; set; }
Property Value
Type Description
Nullable<UInt32>
Remarks

Only applies when viewing redactions in the viewer or when producing a redacted PDF. Does not apply when producing redacted plain text.

Data

Gets or sets an arbitrary key/value string metadata to attach to all redactions created by a rule. Useful if your application will do any parsing or modifying of the markup JSON output.

Declaration
public Dictionary<string, string> Data { get; set; }
Property Value
Type Description
Dictionary<String, String>
Remarks

Only affects the producted markup JSON. The data is not included when producing a redacted PDF or redacted plain text.

FillColor

Gets or sets the fill color of the redaction box to use for all redactions created by a rule. Value must be a CSS-style, 6-character RGB hex value, like "#FF0000" (red), or null for the remote server default, typically "#000000" (black). Default is null.

Declaration
public string FillColor { get; set; }
Property Value
Type Description
String
Remarks

Only applies when viewing redactions in the viewer or when producing a redacted PDF. Does not apply when producing redacted plain text.

FontColor

Gets or sets the color of the Reason text to use for all redactions created by a rule. Value must be a CSS-style, 6-character RGB hex value, like "#FF0000" (red), or null for the remote server default, typically "#FFFFFF" (white). Default is null.

Declaration
public string FontColor { get; set; }
Property Value
Type Description
String
Remarks

Only applies when viewing redactions in the viewer or when producing a redacted PDF. Does not apply when producing redacted plain text.

Reason

Gets or sets the redaction reason to use for all redactions created by a rule. When viewing redactions in the viewer, and when producing redacted PDFs, the redaction reason will be printed as text in the center of the redaction box to explain why the content was redacted. Default is null.

Declaration
public string Reason { get; set; }
Property Value
Type Description
String
Remarks

Only applies when viewing redactions in the viewer or when producing a redacted PDF. Does not apply when producing redacted plain text.