14.03.2014 Views

Automation Reference - JMP

Automation Reference - JMP

Automation Reference - JMP

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Application Object <strong>Reference</strong> for Automating <strong>JMP</strong><br />

Document Object<br />

Document Object<br />

The Document object provides properties and methods that are common to the documents underlying each analysis<br />

or data table.<br />

Properties<br />

Application<br />

Property containing a dispatch pointer to the Application object. Can not be set.<br />

AutoSave<br />

Property to specify if a save should be done automatically before documents that contain data tables are closed.<br />

True means save on close. Can be set or retrieved.<br />

FullName<br />

Property containing the full name of the document as a string. For retrieval only.<br />

Name<br />

Property containing the short name of the document as a string. For retrieval only.<br />

Path<br />

Property containing the full path of the document as a string. For retrieval only.<br />

Saved<br />

Property that indicates if a document has been modified since its last save. If False, the document has changes<br />

that haven’t been saved. If True, there are no changes that are unsaved.<br />

Visible<br />

Property that determines if the document is visible (True) or hidden (False). Can be set and retrieved.<br />

Methods<br />

Activate()<br />

Brings the window that contains the document to the foreground.<br />

Close(SaveChanges as Boolean, FileName As String)<br />

Closes the document. SaveChanges gives the user the option of specifying a different filename for a final save of<br />

the document. If SaveChanges is true, set FileName to the path and name of the file where you want the<br />

document saved. If you want to save to the existing document, it is recommended that the Save method be used.<br />

CopyToClipboard()<br />

Copies the contents of the document’s window to the clipboard. If you are copying the contents of an analysis, it<br />

is strongly recommended that you use the CopyToClipboard method that each analysis implements.<br />

Page 63

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!