Mac Developer Library

Developer

Quartz Framework Reference PDFActionRemoteGoTo Class Reference

Options
Deployment Target:

On This Page
Language:

PDFActionRemoteGoTo

Inheritance


Conforms To


Import Statement


Swift

import Quartz

Objective-C

@import Quartz;

Availability


Available in OS X v10.5 and later.

PDFActionRemoteGoTo, a subclass of PDFAction, defines methods for getting and setting the destination of a go-to action that targets another document.

  • Initializes the remote go-to action with the specified page index, point, and document URL.

    Declaration

    Swift

    init!(pageIndex pageIndex: Int, atPoint point: NSPoint, fileURL url: NSURL!)

    Objective-C

    - (id)initWithPageIndex:(NSUInteger)pageIndex atPoint:(NSPoint)point fileURL:(NSURL *)url

    Parameters

    pageIndex

    The page index of the remote document.

    point

    The point on the page in the remote document.

    url

    The URL of the remote PDF document.

    Return Value

    An initialized PDFActionRemoteGoTo instance, or NULL if the object could not be initialized..

    Discussion

    The PDFActionRemoteGoTo object uses a zero-based page index, not a PDFPage object. This simplifies the handling of remote destinations for documents that may not be instantiated yet.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Returns the zero-based page index referenced by the remote go-to action.

    Declaration

    Swift

    func pageIndex() -> Int

    Objective-C

    - (NSUInteger)pageIndex

    Return Value

    The page index referenced by the remote go-to action.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Sets the zero-based page index referenced by the remote go-to action.

    Declaration

    Swift

    func setPageIndex(_ pageIndex: Int)

    Objective-C

    - (void)setPageIndex:(NSUInteger)pageIndex

    Parameters

    pageIndex

    The page index in the remote document to go to.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.

    See Also

    – pageIndex

  • Returns the point, in page space, on the page referenced by the remote go-to action.

    Declaration

    Swift

    func point() -> NSPoint

    Objective-C

    - (NSPoint)point

    Return Value

    The point on the page of the remote document referenced by the action. If either the x value or the y value of the point is kPDFDestinationUnspecifiedValue, no position on the page is specified.

    Discussion

    Page space is a 72-dpi coordinate system with the origin at the lower-left corner of the current page.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Sets the point, in page space, on the page referenced by the remote go-to action.

    Declaration

    Swift

    func setPoint(_ point: NSPoint)

    Objective-C

    - (void)setPoint:(NSPoint)point

    Parameters

    point

    The point on the remote page to go to. If either the x value or the y value of the point is kPDFDestinationUnspecifiedValue, no position on the page is specified.

    Discussion

    Page space is a 72-dpi coordinate system with the origin at the lower-left corner of the current page.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Returns the URL of the document referenced by the remote go-to action.

    Declaration

    Swift

    func URL() -> NSURL!

    Objective-C

    - (NSURL *)URL

    Return Value

    The URL of the remote document referenced by the action.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.

  • Sets the URL of the document referenced by the remote go-to action.

    Declaration

    Swift

    func setURL(_ url: NSURL!)

    Objective-C

    - (void)setURL:(NSURL *)url

    Parameters

    url

    The URL of the remote document to go to.

    Import Statement

    Objective-C

    @import Quartz;

    Swift

    import Quartz

    Availability

    Available in OS X v10.5 and later.