Automation Reference - JMP

More documents

Recommendations

Info

Application Object Reference for Automating JMP Application Object Application Object The Application object provides high-level support for running JMP and loading data tables and other files. It is the essential object that must be created in order to have an automation session. Properties Application Returns a dispatch pointer to the JMP object, which you should already have if you are accessing the property. FullName Returns the short name of the JMP application as a string, for example, “JMP”. Name As with FullName, Name returns the short name of the JMP application as a string. Parent Returns the object that is the next level up. Since the application object is top level, it just returns the application object. Visible Sets the JMP session visible if set to True (1), invisible if False (0). The default is False. Setting Visible to True affects windows that are created after changing the setting. Windows that were visible prior to the change remain visible. Methods ClearLog() Clears the contents of the Log window. CloseAllWindows() Closes all currently open windows. CloseWindow()As Boolean Closes the analysis window immediately, rather than waiting for JMP to Exit. Returns True if successful, False if not. CloseWindowsOfType(jmpWindowTypeConstants windowType) Closes all currently open windows of a given type, like Journal or Datatable. jmpWindowTypeConstants contains the available window types that may be closed. Page 36
Application Object Reference for Automating JMP Application Object CreateDOECustom () As DOECustom Creates a DOE Custom Design object. This object is then invoked with methods to Add Factors, Add a Model, Create a Design and finally make a Table. Please read the section under automation of Design of Experiments for further information. CreateTextImportObject(FileName As String, NumberColumns as Integer) As TextImport Creates a TextImport object, which must then be set up with information on columns and rows. FileName is the full path of the file that will be imported, NumberColumns describes how many table columns are in the data. Returns a dispatch pointer to the new TextImport object. EnableInteractiveMode(Flag as Boolean) Lets you display information in message boxes during an automated process rather than in the log. This option effectively turns off the Batch mode processing. GetLogContents() As String Returns the current contents of the Log window as a String. The Log Window can be floating or docked. If the log is hidden, an empty string is returned. GetJSLValue Used to retrieve the value of a JSL global variable of type Integer, Double, String or a List whose elements are a heterogeneous mix of those three types of values. The return value is a VARIANT, which can contain the Integer, Double, String or an Array of Variant records. The method declaration is: GetJSLValue (VariableName As String) As Variant A typical call in Visual Basic is: result = GetJSLValue("MyJSLVariable") Accessing results depends on the type returned, and might be something like this: A = B * result; Or if the value is a String: MsgBox(result) Or if the value is a List and you want the 3rd element: MsgBox(result(2)) GetNumberOfAutomationDatatables()As Integer Returns the number of currently open/viewable data tables within JMP. GetRunCommandErrorString() As String Allows the JSL error text to be retrieved after the existing RunCommand(Command As String) and RunJSLFile(FileName As String) methods have been run. See also HasRunCommandErrorString() As Boolean. An example of the Visual Basic code to access these methods is: MyJMP.RunCommand (Text1.Text) Page 37
Page 1 and 2:
Version 10 Automation Reference JMP
Page 3 and 4:
Application Object Reference for Au
Page 5 and 6: Contents Application Object Referen
Page 21 and 22: Application Object Reference for Au
Page 55: Application Object Reference for Au
Page 107 and 108:
Page 109 and 110:
Page 111 and 112:
Page 113 and 114:
Page 115 and 116:
Page 117 and 118:
Page 119 and 120:
Page 121 and 122:
Page 123 and 124:
Page 125 and 126:
Page 127 and 128:
Page 129 and 130:
Page 131 and 132:
Page 133 and 134:
Page 135 and 136:
Page 137 and 138:
Page 139 and 140:
Page 141 and 142:
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Index Application Object Reference
Page 149 and 150:
Page 151 and 152:
Page 153 and 154:
Page 155 and 156:
Page 157:
show all

Automation Reference - JMP

Create successful ePaper yourself

Delete template?

Save as template?