PTUserBookmark


@interface PTUserBookmark : NSObject

A user bookmark for a page in a document.

  • Initializes a bookmark with a PDF bookmark object.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPDFBookmark:(nonnull PTBookmark *)bookmark;

    Swift

    init(pdfBookmark bookmark: PTBookmark)

  • Initializes a bookmark with the given information.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTitle:(nonnull NSString *)title
                           pageNumber:(int)pageNumber;

    Swift

    convenience init(title: String, pageNumber: Int32)

  • Initializes a bookmark with the given information.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTitle:(nonnull NSString *)title
                           pageNumber:(int)pageNumber
                           pageObjNum:(unsigned int)pageObjNum;

    Swift

    init(title: String, pageNumber: Int32, pageObjNum: UInt32)

  • The underlying PDF bookmark in the document. The value will be nil if the user bookmark has not been saved.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) PTBookmark *bookmark;

    Swift

    var bookmark: PTBookmark? { get set }

  • The title of the bookmark.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull title;

    Swift

    var title: String { get set }

  • The page number of bookmark.

    Declaration

    Objective-C

    @property (nonatomic) int pageNumber;

    Swift

    var pageNumber: Int32 { get set }

  • The SDF object number of the bookmark’s page.

    Declaration

    Objective-C

    @property (nonatomic) unsigned int pageObjNum;

    Swift

    var pageObjNum: UInt32 { get set }

  • Whether the bookmark has been changed.

    Declaration

    Objective-C

    @property (nonatomic, getter=isEdited) BOOL edited;

    Swift

    var isEdited: Bool { get set }

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init PT_UNAVAILABLE;