Redaction Data Type

Redaction is used to specify the text to redact along with the properties of the redaction annotation before it is flattened and the resulting redaction.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs description
caseSensitive boolean element 1/1 Search for only words that match the case of the searchText. The default value is false.
fillColor string element 0/1 The annotation fill color. There is no fill by default.
outlineColor string element 0/1 The annotation outline color. The default color is red. This can be in the format of an html predefined color name (ie Aquamarine), a hex string (ie #7FFFD4), an rgb string (ie rgb(127,255,212)), or as an int string (ie 8388564).
overlayAlignment int element 1/1 The overlay text horizontal alignment. Must be one of 0 (left), 1 (center), or 2 (right). 0 is the default value.
overlayFillColor string element 0/1 The overlay fill color. The default color is black.
overlayFontName string element 0/1 The name of the overlay text Font.

The supported fonts are Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic.

The default font is Helvetica.

overlayFontSize float element 1/1 The size of the overlay font. If the size is 0, then the text will be resized to fill the redacted region. The default font size is 12.
overlayRepeat boolean element 1/1 The flag that determines if the overlay text will repeat to fill the redacted region. The default value is false.
overlayText string element 0/1 The overlay text that should be drawn over the redacted region.
overlayTextColor string element 0/1 The overlay text color. The default color is white.
searchText string element 0/1 The text to search for and redact.
transparency float element 1/1 The annotation transparency as a value between 0 and 1 with 0 being opaque and 1 being completely transparent. The default value is 0.
wholeWords boolean element 1/1 Search for whole words only. The default value is false.

Example

<Redaction>
  <searchText>...</searchText>
  <wholeWords>...</wholeWords>
  <caseSensitive>...</caseSensitive>
  <outlineColor>...</outlineColor>
  <fillColor>...</fillColor>
  <transparency>...</transparency>
  <overlayFillColor>...</overlayFillColor>
  <overlayTextColor>...</overlayTextColor>
  <overlayText>...</overlayText>
  <overlayFontName>...</overlayFontName>
  <overlayFontSize>...</overlayFontSize>
  <overlayAlignment>...</overlayAlignment>
  <overlayRepeat>...</overlayRepeat>
</Redaction>