RemoteGoToAction Class Documentation

classRemoteGoToAction : Action

Namespace:Datalogics::PDFL

Inherits from:
Action

Detailed Description

A remote go-to action is an action that includes a RemoteDestination object.

The action associated with this object, when selected, opens a separate PDF file, or opens a web page in a browser window.

Referenced by

Constructor & Destructor Documentation

RemoteGoToAction

RemoteGoToAction(RemoteGoToActionrhs, InternalConstructsignifier)

Parameters

signifier: InternalConstruct

RemoteGoToAction

RemoteGoToAction(FileSpecificationfileSpec, RemoteDestinationremoteDest)

Parameters

fileSpec: FileSpecification

A FileSpecification containing the path to the remote document.

remoteDest: RemoteDestination

A RemoteDestination representing the destination to jump in the remote document.

General constructor.

The action's target will be the path referenced in the FileSpecification parameter. If the path is absolute, the target path will also be absolute. If the path is relative, the target path will also be relative.

Generally, the FileSpecification and RemoteDestination should be associated with the same Document, and this Document should be the same Document that contains the RemoteGoToAction. (All three objects, FileSpecification, RemoteDestination, and RemoteGoToAction, are associated with a Document at creation time, and the association cannot be changed.) The RemoteGoToAction will be associated with the same Document that the RemoteDestination parameter is associated with.

When creating the RemoteGoToAction, the FileSpecification and RemoteDestination given to the constructor must be associated with the same Document, or an exception will be thrown.

Property Documentation

FileSpecification

FileSpecificationFileSpecification[get, set]

NewWindow

boolNewWindow[get, set]

PDFDict

PDFDictPDFDict[get]

RemoteDestination

RemoteDestinationRemoteDestination[get, set]

Subtype

stringSubtype[get]

Member Function Documentation

ConstructorRetrieve

static new static RemoteGoToActionConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

new static RemoteGoToAction

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

Equals

override boolEquals(objectobj)

Parameters

obj: object

Returns:

override bool

SameTypeEquals

boolSameTypeEquals(Actionarg0)

Parameters

arg0: Action

Returns:

bool

ToString

override stringToString()

Returns:

override string