CPDFBackground Class Reference

Inherits from NSObject
Declared in CPDFBackground.h

Overview

Adds and removes the background.

  type

Method to get / set the type of the background.

@property (nonatomic, assign) CPDFBackgroundType type

Discussion

Method to get / set the type of the background.

See Also

Declared In

CPDFBackground.h

  color

Method to get / set the color of the background.

@property (nonatomic, strong) CPDFKitPlatformColor *color

Discussion

Method to get / set the color of the background.

Declared In

CPDFBackground.h

  scale

Method to get / set the scale of the background.

@property (nonatomic, assign) CGFloat scale

Discussion

Method to get / set the scale of the background.

Declared In

CPDFBackground.h

  rotation

Method to get / set the rotation angle of the background.

@property (nonatomic, assign) CGFloat rotation

Discussion

Method to get / set the rotation angle of the background.

Declared In

CPDFBackground.h

  opacity

Method to get / set the opacity of the background.

@property (nonatomic, assign) CGFloat opacity

Discussion

Method to get / set the opacity of the background.

Declared In

CPDFBackground.h

  pageString

Method to get / set the page range of the background by string, such as “0,3,5-7”.

@property (nonatomic, strong) NSString *pageString

Discussion

Method to get / set the page range of the background by string, such as “0,3,5-7”.

Declared In

CPDFBackground.h

  verticalAlignment

Method to get / set the vertical alignment of the background.

@property (nonatomic, assign) NSUInteger verticalAlignment

Discussion

Method to get / set the vertical alignment of the background.

Declared In

CPDFBackground.h

  horizontalAlignment

Method to get / set the horizontal offset of the background.

@property (nonatomic, assign) NSUInteger horizontalAlignment

Discussion

Method to get / set the horizontal offset of the background.

Declared In

CPDFBackground.h

  xOffset

Method to get / set the horizontal offset of the background.

@property (nonatomic, assign) CGFloat xOffset

Discussion

Method to get / set the horizontal offset of the background.

Declared In

CPDFBackground.h

  yOffset

Method to get / set the vertical offset of the background.

@property (nonatomic, assign) CGFloat yOffset

Discussion

Method to get / set the vertical offset of the background.

Declared In

CPDFBackground.h

  isAllowsView

Method to get / set whether to support the background to be displayed.

@property (nonatomic, assign) BOOL isAllowsView

Discussion

Method to get / set whether to support the background to be displayed.

Declared In

CPDFBackground.h

  isAllowsPrint

Method to get / set whether to support the background to be printed.

@property (nonatomic, assign) BOOL isAllowsPrint

Discussion

Method to get / set whether to support the background to be printed.

Declared In

CPDFBackground.h

  hasBackground

Method to check whether the document has a background.

@property (nonatomic, assign) BOOL hasBackground

Discussion

Method to check whether the document has a background.

Declared In

CPDFBackground.h

– setImage:

Sets the image of the background.

- (void)setImage:(CPDFKitPlatformImage *)image

Discussion

Sets the image of the background.

Declared In

CPDFBackground.h

– update

Updates the background.

- (void)update

Discussion

Updates the background.

Declared In

CPDFBackground.h

– reload

Reload the background.

- (void)reload

Discussion

Reload the background.

Declared In

CPDFBackground.h

– clear

Removes the background.

- (BOOL)clear

Discussion

Removes the background.

Declared In

CPDFBackground.h