LaunchAction Class Documentation
class LaunchAction : ActionNamespace:Datalogics::PDFL
- Inherits from:
Action
Detailed Description
A launch action launches an application or opens or prints a document.
Uses types
Constructor & Destructor Documentation
LaunchAction
LaunchAction(FileSpecification fileSpec)Parameters
fileSpec: FileSpecificationA FileSpecification representing the application to be launched or the document to be opened or printed by this action.
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 should be associated with the same Document that contains the LaunchAction. (Both FileSpecification and LaunchAction objects are associated with a Document at creation time, and the association cannot be changed.) The LaunchAction will be associated with the same Document that the FileSpecification parameter is associated with.
If the action's FileSpecification is changed during program execution such that the FileSpecification is associated with a different Document than the LaunchAction, saving the Document that contains the action will create a copy of the FileSpecification in the Document that contains the action.
Property Documentation
FileSpecification
FileSpecification FileSpecification[get, set]The FileSpecification for this action.
Generally, the FileSpecification should be associated with the same Document that contains the LaunchAction. (Both FileSpecification and LaunchAction are associated with a Document at creation time.)
NewWindow
bool NewWindow[get, set]Whether the destination document should be opened in a new window.
By default, this flag is not present.
If the action's FileSpecification is not a PDF, this flag is ignored.
Exceptions
- InternalError —
if the NewWindow flag has not been set on this LaunchAction.
PDFDict
PDFDict PDFDict[get]Retrieve the PDFObject representation of this object.
Subtype
string Subtype[get]The action's subtype.
Member Function Documentation
Dispose
void Dispose()Returns:
voidEquals
override bool Equals(object obj)Parameters
obj: object
Returns:
override boolToString
override string ToString()Returns:
override stringA string describing this Action.
Returns a string representation of this Action.
The string includes the action's subtype.