DL Logo

PDRedaction Structures

_t_PDRedactParams

Header: PDExpT.h:6822

Description

Parameters used to represent the properties for a redaction mark.

Syntax

struct _t_PDRedactParams {
ASUns32 size;
The size of the data structure.
ASInt32 pageNum;
The page number where this redaction mark is found.
ASFixedQuad *redactQuads;
An array of ASFixedQuad objects representing the regions on the page to be redacted.
ASUns32 numQuads;
The length of the array specified by redactQuad.
PDColorValueRec *colorVal;
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.
ASText overlayText;
The overlay text to be used 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. If this field is NULL, or an empty "ASText", then no text will be generated.
PDHorizAlign horizAlign;
The horizontal alignment to be used for the overlay text when generating the replacement form for this redaction mark.
PDColorValueRec *fillColor;
Allow specification of a color and opacity to be used in the "normal" or unredacted appearance as an overlay for the interior of the redaction area. The color specified in colorVal will be used as the border color for the "normal" appearance. If this field is NULL, then no fill will be placed in the "normal" appearance.
ASFixed fillOpacity;
PDColorValueRec *borderColor;
Allow a specification of the border color If this field is NULL, and there is a fillColor, no borders wil be drawn in the normal appearance. If there is also no fillColor, then the colorVal, will be used as the border color. If that is also omitted, the border will be drawn in black.
PDColorValueRec *textColor;
Allow specification of the text color in the redacted appearance If this field is NULL, and there is text to be drawn, it will be drawn in black.
ASFixed textSize;
Allow Specification of the text size in the redacted appearance If this field is zero, it will be presumed to be 10.0.
PDEFont textFont;
Allow specification of the text font in the redacted appearance If a PDEFont is specified, it will be used. If a PDEFont is not specified, and a textFontName is specified, a PDEFont will be constructed using that font name, and inserted as an embedded, subset font for this annotation. If neither are specified, a base14 form of the font "Helvetica" will be created and used for this annotation (If text is present).
char *textFontName;
ASBool repeat;
Allow specification that the text is to be repeated to fill the redaction area. If this value is false, a single copy of the text will be drawn within the redacted appearance. If it is true, the text will be repeated as needed, both horiziontally and vertically, to fill the redacted area.
ASBool scaleToFit;
Allow specification that the text is to be scaled down to fit the redaction area If this field is false, and repeat is also false, one copy of the text will be drawn within the redacted area. If this text exceeds the size of the redacted area, it will be allowed to overflow.

If this field is true, and the text exceeds either the height or width of the redacted area, the text will be scaled without distortion to fit into the redacted area. Note that if the repeat flag is also true, this may result in reduced size text, which is repeated in one dimension, if the dimensions are very different in extent.

ASText title;
Specify the name of the redaction popup.
ASText note;
Specify the content of the popup note associated with this annotion.
} PDRedactParamsRec, *PDRedactParams;

Used By

PDRedaction Functions

PDRedactionGetProps

Header: PDProcs.h:12012

Description

Retrieves a set of properties for a given redaction mark.

Syntax

ASBool PDRedactionGetProps(PDAnnot redactionAnnot, PDRedactParams redactionProps);

Parameters

redactionAnnot
IN The redaction mark whose properties are to be returned.
redactionProps
OUT The set of properties to be filled by this method.

Returns

true if the properties were successfully returned, false otherwise.

Exceptions

PDRedactionSetProps

Header: PDProcs.h:12024

Description

Assigns a set of properties to a given redaction mark.

Syntax

ASBool PDRedactionSetProps(PDAnnot redactionAnnot, PDRedactParams redactionProps);

Parameters

redactionAnnot
IN/OUT The redaction mark whose properties are to be assigned.
redactionProps
IN The set of properties to be assigned by this method.

Returns

true if the properties were successfully assigned, false otherwise.

Exceptions