CPDFRedactAnnotation Class Reference

Inherits from	CPDFAnnotation : NSObject
Declared in	CPDFRedactAnnotation.h

Overview

Redaction annotations are used to remove content from a document.

Other Methods

`drawRedactionsAsRedacted`

@property (nonatomic, assign) BOOL drawRedactionsAsRedacted

`– quadrilateralPoints`

Gets the areas that should be covered by the redaction annotation.

- (NSArray *)quadrilateralPoints

Discussion

Gets the areas that should be covered by the redaction annotation.

Declared In

CPDFRedactAnnotation.h

`– setQuadrilateralPoints:`

Uses the quadrilateral points property to set the areas that should be covered by the redaction annotation.

- (void)setQuadrilateralPoints:(NSArray *)points

Discussion

Uses the quadrilateral points property to set the areas that should be covered by the redaction annotation.

Declared In

CPDFRedactAnnotation.h

`– interiorColor`

Gets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.

- (CPDFKitPlatformColor *)interiorColor

Discussion

Gets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.

Declared In

CPDFRedactAnnotation.h

`– setInteriorColor:`

Sets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.

- (void)setInteriorColor:(CPDFKitPlatformColor *)color

Discussion

Sets the fill color displayed in the specified area after applying the redaction. The color is drawn on the specified rect. Defaults to black.

Declared In

CPDFRedactAnnotation.h

`– removeInteriorColor`

remove interior Color(Set it to transparent, or set SetInteriorColor: to nil)

- (BOOL)removeInteriorColor

Discussion

remove interior Color(Set it to transparent, or set SetInteriorColor: to nil)

Declared In

CPDFRedactAnnotation.h

`– borderColor`

Gets the color used for the redaction’s border in its marked state. Defaults to red.

- (CPDFKitPlatformColor *)borderColor

Discussion

Gets the color used for the redaction’s border in its marked state. Defaults to red.

Declared In

CPDFRedactAnnotation.h

`– setBorderColor:`

Sets the color used for the redaction’s border in its marked state. Defaults to red.

- (void)setBorderColor:(CPDFKitPlatformColor *)color

Discussion

Sets the color used for the redaction’s border in its marked state. Defaults to red.

Declared In

CPDFRedactAnnotation.h

`cFont`

Method to set the font name used for the annotation’s text field.

@property (nonatomic, strong) CPDFFont *cFont

Discussion

Method to set the font name used for the annotation’s text field.

Declared In

CPDFRedactAnnotation.h

`fontSize`

Method to get the font size used for the annotation’s text field.

@property (nonatomic, assign) CGFloat fontSize

Discussion

Method to get the font size used for the annotation’s text field.

Declared In

CPDFRedactAnnotation.h

`– fontColor`

Gets the text color displayed in the specified area after applying the redaction.

- (CPDFKitPlatformColor *)fontColor

Discussion

Gets the text color displayed in the specified area after applying the redaction.

Declared In

CPDFRedactAnnotation.h

`– setFontColor:`

Sets the text color displayed in the specified area after applying the redaction.

- (void)setFontColor:(CPDFKitPlatformColor *)fontColor

Discussion

Sets the text color displayed in the specified area after applying the redaction.

Declared In

CPDFRedactAnnotation.h

`– alignment`

Gets the text alignment displayed in the specified area after applying the redaction.

- (NSTextAlignment)alignment

Discussion

Gets the text alignment displayed in the specified area after applying the redaction.

Declared In

CPDFRedactAnnotation.h

`– setAlignment:`

Sets the text alignment displayed in the specified area after applying the redaction.

- (void)setAlignment:(NSTextAlignment)alignment

Discussion

Sets the text alignment displayed in the specified area after applying the redaction.

Declared In

CPDFRedactAnnotation.h

`– overlayText`

Gets the text displayed in the specified area after applying the redaction.

- (NSString *)overlayText

Discussion

Gets the text displayed in the specified area after applying the redaction.

Declared In

CPDFRedactAnnotation.h

`– setOverlayText:`

Sets the text displayed in the specified area after applying the redaction.

- (void)setOverlayText:(NSString *)text

Discussion

Sets the text displayed in the specified area after applying the redaction.

Declared In

CPDFRedactAnnotation.h

`– applyRedaction`

Applies redaction annotation.

- (void)applyRedaction

Discussion

Applies redaction annotation.

Declared In

CPDFRedactAnnotation.h

Deprecated Methods

`– setFont:`

- (void)setFont:(CPDFKitPlatformFont *)font

`– font`

- (CPDFKitPlatformFont *)font