Redaction Class

class Redaction : Annotation

Namespace:Datalogics::PDFL

Inherits from:: Annotation

Detailed Description

Associates an object with its location on a page of a PDF document.

A redaction occludes some part of a document.

Referenced by

Document Redaction

Uses types

Annotation AnnotationFlags Color Font Form HorizontalAlignment OptionalContentContext OptionalContentMembershipDict PDFDict Page Quad Rect Redaction

Constructor & Destructor Documentation

Redaction(Page page, System.Collections.Generic.IList< Quad > regions)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.

Create a new Redaction annotation object with extended options. When Overlay Text is used, font is specified by name. To create a potental redaction and place it elsewhere in the page's annotation array.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor, string fontName)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
fontName: string: The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor, string fontName, double textSize)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
fontName: string: The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.
textSize: double: The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor, string fontName, double textSize, bool repeat)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
fontName: string: The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.
textSize: double: The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.
repeat: bool: When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor, string fontName, double textSize, bool repeat, bool scaleToFit)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance (and in the final document, after redactions are applied). This parameter is considered true if not omitted.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. This parameter is considered true if not omitted.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color (If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
fontName: string: The name of the font to be used when setting the overlayText. When absent or empty, the standard font Helvtica will be used. Using this option, a new internal font is created for each redaction. Each is subset and embedded. When many, many redactions are to be created, this can result in a significant use of processing time. When many redactions are to be created, the option using a font object in place of the font name is preferred.
textSize: double: The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.
repeat: bool: When true, the overlay text will be repeated to fill the redacted area. when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.
scaleToFit: bool: When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.

Create a new Redaction annotation object with extended options .When Overlay Text is used, font is provided as a font. To create a potental redaction and place it elsewhere in the page's annotation array.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor, double textSize)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
textSize: double: The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor, double textSize, bool repeat)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
textSize: double: The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.
repeat: bool: When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.

Redaction(Page page, System.Collections.Generic.IList< Quad > regions, Font font, Color internalColor, bool fillRedacted, bool drawBorder, Color borderColor, bool fillNormal, Color fillColor, double fillOpacity, string overlayText, Color textColor, double textSize, bool repeat, bool scaleToFit)

Parameters

page: Page: The page where this redaction mark is found.
regions: System.Collections.Generic.IList< Quad >: A vector of quadrilateral regions specifying the redaction's bounds, specified in user space coordinates.
font: Font: The font to be used when creating overlay text. For most efficiency, this font should be created prior to the first redaction, and used for all redactions. After the last redaction is created the font may be subset and embedded. Using this option, rather than specifying a font name, significantly speeds the creation of many redactions.
internalColor: Color: The color of the redaction mark. This color is also used as the fill color when generating the replacement form for this redaction mark. The replacement form is the content that will be placed on the page when this mark is applied and the underlying content is removed.
fillRedacted: bool: When true, the area being redacted will be filled with the internalColor in the redacted appearance(and in the final
document, after redactions are applied). If omitted, this parameter will default to true.
drawBorder: bool: When true, the "normal" appearance of the redacted areas will have a border of 1 point, in the borderColor. When it is false, no border will be drawn. If omitted, this parameter will default to true.
borderColor: Color: The color to draw the border around the "normal" appearance of each area. If omitted, and fillColor is not omitted, no border will be drawn. If both fillColor and BorderColor is omitted, border will be drawn in internalColor. If internalColor is also omitted, border will be drawn in black.
fillNormal: bool: When true, the areas being redacted will be drawn, in the "normal" appearance, with an overlaying fill of the fillColor at the fillOpacity. When false, there will be no overlay fill. This paramter is considered false if omitted.
fillColor: Color: The color applied as an overlay to the "normal" (Non redacted) area within the redaction areas. If this color is omitted, a "white" fill will be presumed.
fillOpacity: double: A value from 0 to 1.0 which is the opacity of the fill color(If this value is one, then the content of the redacted area will not be visible in the "normal" mode. If it is zero, then there will be no visible color overlaying the content to be redacted). If omitted, this will default to 1.0.
overlayText: string: The value of the string to be displayed over the redacted area. It will be scaled and/or repeated according to the value of later parameters. If omitted, it will be an empty string, and there will be no overlay text drawn.
textColor: Color: The color to use in drawing the OverlayText. If this is omitted, white will be presumed.
textSize: double: The size, in points, to draw the text too. This may be overridden the scaleTofit value below. If omitted, it will default to 12.0.
repeat: bool: When true, the overlay text will be repeated to fill the redacted area, when false, the overlay text will be displayed only once. When omitted, it is presumed to be false.
scaleToFit: bool: When true, the text size will be decreased to just fill the redacted area. When false, the text size will be constant, as described in textSize. When omitted, this is presumed to be false.

Property Documentation

HorizontalAlignment Align[get, set]

double AnnotationFeatureLevel[get, set]

Color BorderColor[get, set]

Color Color[get, set]

string Contents[get, set]

bool DrawBorder[get, set]

Color FillColor[get]

bool FillNormal[get, set]

double FillOpacity[get]

bool FillRedacted[get, set]

AnnotationFlags Flags[get, set]

string FontFace[get, set]

double FontSize[get, set]

Color InteriorColor[get, set]

Color InternalColor[get, set]

Form NormalAppearance[get, set]

string Note[get, set]

double Opacity[get, set]

OptionalContentMembershipDict OptionalContentMembershipDict[get, set]

Font OverlayFont[get, set]

string OverlayText[get, set]

PDFDict PDFDict[get]

int PageNo[get, set]

System.Collections.Generic.IList< Quad > Quads[get, set]

Rect Rect[get, set]

bool Repeat[get, set]

bool ScaleToFit[get, set]

string Subtype[get]

Color TextColor[get, set]

string Title[get, set]

Member Function Documentation

void Dispose()

Returns:

void

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

Form GenerateAppearance()

Returns:

Form

A Form representing the visual appearance, or null if the appearance could not be generated.

Generate a new appearance stream with the current annotation properties.

The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.

bool HasRichTextData()

Returns:

bool

true if the annotation contains Rich Text String content.

Checks the annotation for Rich Text String content (PDFReference 1.7 Section 8.6.2). Annotations that contain Rich Text String content and do not have a normal appearance set will not be visible when rendering the page.

bool IsCurrentlyVisible(OptionalContentContext occ)

Parameters

occ: OptionalContentContext: The optional content context in which to check visibility.

Returns:

bool

true if the annotation is currently visible.

Tests whether an annotation is visible in a given optional content context, considering the current ON-OFF states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy.

If the annotation occurs more than once within the content, this method only checks the visibility of the first occurrence of the annotation.

This method determines visibility without considering the visbility of the Content object that the annotation belongs to. To determine the visibility of an annotation while taking the Content's visibility into consideration, use the alternate version of this method.

void SetFillColor(Color col, double opacity)

Parameters

col: Color: The color which will fill the annotation when it is viewed in the "normal" or pre-redacted appearance.
opacity: double: The amount of opacity to apply to the fill color. If this value is zero, not color will be seen. If it is 1.0, then the underlying content of the unredacted document will not be visible.

Returns:

void

Set the color used to fill the "normal" appearance.

override string ToString()

Returns:

override string

A string describing this annotation, including its type and rectangle.

Returns a string representation of this annotation.