PSPDFDocumentEditorConfiguration

Objective-C


@interface PSPDFDocumentEditorConfiguration
    : PSPDFBaseConfiguration <PSPDFDocumentEditorConfigurationBuilder *>

Configuration options for various document editor controllers.

Note

Set the configuration values before passing this object to view controllers for display.

Presets


                      
                      
                      
                      
                      pageTemplates

A list of predefined page patterns.

Declaration

Objective-C

@property (nonatomic, readonly) NSArray<PSPDFPageTemplate *> *_Nonnull pageTemplates;

currentDocumentPageSize
A page size that represents a representative page on the current Needs to be set based on the current document.

Note
Can’t be nil if pageSizes is empty.
Declaration
Objective-C

@property (nonatomic, readonly) PSPDFPageSize *_Nonnull currentDocumentPageSize;
pageSizes
A list of predefined page sizes.

Note
Can’t be empty if currentDocumentPageSize is nil.
Declaration
Objective-C

@property (nonatomic, readonly) NSArray<PSPDFPageSize *> *_Nonnull pageSizes;
currentDocumentDirectory
Represents the directory of the current document.

Note
Can’t be nil if saveDirectories is empty.
Declaration
Objective-C

@property (nonatomic, readonly) PSPDFDirectory *_Nonnull currentDocumentDirectory;
saveDirectories
A list of predefined save directories.

Note
Can’t be empty if currentDocumentDirectory is nil.
Declaration
Objective-C

@property (nonatomic, readonly) NSArray<PSPDFDirectory *> *_Nonnull saveDirectories;
compressions
A list of predefined compressions.

Note
Can’t be empty if selectedCompression is nil.
Declaration
Objective-C

@property (nonatomic, readonly) NSArray<PSPDFCompression *> *_Nonnull compressions;

Selection

selectedTemplate
The currently selected page pattern. Defaults to nil (no page pattern).
Declaration
Objective-C

@property (nonatomic, readonly) PSPDFPageTemplate *_Nonnull selectedTemplate;
selectedPageSize
The currently selected page size. Defaults to currentDocumentPageSize if available, otherwise the first item in pageSizes is used.
Declaration
Objective-C

@property (nonatomic, readonly) PSPDFPageSize *_Nonnull selectedPageSize;
selectedOrientation
The currently selected page orientation. Defaults to PSPDFDocumentOrientationPortrait.
Declaration
Objective-C

@property (nonatomic, readonly) PSPDFDocumentOrientation selectedOrientation;
selectedColor
The currently selected page background color. Setting this to nil will result in the default white color being used.
Declaration
Objective-C

@property (nonatomic, readonly) NSColor *_Nonnull selectedColor;
selectedImage
The currently selected page image. Setting this to nil will result in no image being used.
Declaration
Objective-C

@property (nonatomic, readonly) NSImage *_Nonnull selectedImage;
selectedImagePageSize
A page size that represents a the size of the selected image.

Note
Will be nil when selectedImage is nil.
Declaration
Objective-C

@property (nonatomic, readonly) PSPDFPageSize *_Nonnull selectedImagePageSize;
selectedCompression
Represents the compression for the selected image.

Note
Will be nil when selectedImage is nil.
Declaration
Objective-C

@property (nonatomic, readonly) PSPDFCompression *_Nonnull selectedCompression;
selectedSaveDirectory
The currently selected save directory. Defaults to currentDocumentDirectory if available, otherwise the first item in saveDirectories is used.
Declaration
Objective-C

@property (nonatomic, readonly) PSPDFDirectory *_Nonnull selectedSaveDirectory;
userFacingCompressionEnabled
Defines, whether the image compression should be editable by the user. Defaults to true. When set to NO, images will use the default compression of 0.8
Declaration
Objective-C

@property (nonatomic, readonly) BOOL userFacingCompressionEnabled;
allowExternalFileSource
Defines, whether the available source of new pages should be external file. Defaults to false. When set to NO, file selector is not available.

Note
On iOS 10 and earlier, an application initializing a document picker requires the iCloud entitlement set.
Declaration
Objective-C

@property (nonatomic, readonly) BOOL allowExternalFileSource;