PSPDFDocumentEditorConfiguration


@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.
  • The currently selected page pattern. Defaults to nil (no page pattern).

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFPageTemplate *_Nonnull selectedTemplate;

    Swift

    var selectedTemplate: PSPDFPageTemplate { get }
  • The currently selected page size. Defaults to currentDocumentPageSize if available, otherwise the first item in pageSizes is used.

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFPageSize *_Nonnull selectedPageSize;

    Swift

    var selectedPageSize: PSPDFPageSize { get }
  • The currently selected page orientation. Defaults to PSPDFDocumentOrientationPortrait.

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFDocumentOrientation selectedOrientation;

    Swift

    var selectedOrientation: PSPDFDocumentOrientation { get }
  • The currently selected page background color. Setting this to nil will result in the default white color being used.

    Declaration

    Objective-C

    @property (readonly, nonatomic) UIColor *_Nonnull selectedColor;

    Swift

    var selectedColor: NSColor { get }
  • The currently selected page image. Setting this to nil will result in no image being used.

    Declaration

    Objective-C

    @property (readonly, nonatomic) UIImage *_Nonnull selectedImage;

    Swift

    var selectedImage: NSImage { get }
  • A page size that represents a the size of the selected image.

    Note

    Will be nil when selectedImage is nil.

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFPageSize *_Nonnull selectedImagePageSize;

    Swift

    var selectedImagePageSize: PSPDFPageSize { get }
  • Represents the compression for the selected image.

    Note

    Will be nil when selectedImage is nil.

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFCompression *_Nonnull selectedCompression;

    Swift

    var selectedCompression: PSPDFCompression { get }
  • The currently selected save directory. Defaults to currentDocumentDirectory if available, otherwise the first item in saveDirectories is used.

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFDirectory *_Nonnull selectedSaveDirectory;

    Swift

    var selectedSaveDirectory: PSPDFDirectory { get }
  • Defines, whether the image compression should be editable by the user. Defaults to YES. When set to NO, images will use the default compression of 0.8

    Declaration

    Objective-C

    @property (readonly, nonatomic) BOOL userFacingCompressionEnabled;

    Swift

    var userFacingCompressionEnabled: Bool { get }
  • Defines, whether the available source of new pages should be external file. Defaults to NO. 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 (readonly, nonatomic) BOOL allowExternalFileSource;

    Swift

    var allowExternalFileSource: Bool { get }