Automation Reference - JMP

More documents

Recommendations

Info

Application Object Reference for Automating JMP Application Object If (MyJMP.HasRunCommandErrorString) Then MsgBox (MyJMP.GetRunCommandErrorString) End If GetTableHandleFromIndex(Integer Index) Returns the handle to the DataTable automation object given the index of a data table in the range from 1 to the number of data tables open within JMP. GetTableHandleFromName(Name as String)As DataTable Finds a data table based on its name, and returns a handle to the automation object of the table. GetTableNameFromIndex(Integer Index) Returns the name of the data table as a string given the index of a data table in the range from 1 to the number of data tables open within JMP. HasRunCommandErrorString() As Boolean Provides a simple way to query to see if there is error text at all, rather than checking for an empty string. See also GetRunCommandErrorString() As String. An example of the Visual Basic code to access these methods is: MyJMP.RunCommand (Text1.Text) If (MyJMP.HasRunCommandErrorString) Then MsgBox (MyJMP.GetRunCommandErrorString) End If HonorSessionSavePref(Flag as Boolean) Under automation, session save is not performed on shutdown. Automation operations often recreate a certain state, and the session save confuses this. If session save is desired on shutdown during automation, call this method with a True parameter before calling the Quit method and then JMP will follow the session save preference setting. Passing a parameter of False tells JMP to ignore the session save for automation. InternetOpenItem(String URL, internetItemTypes openHow) As DataTable Opens a text or binary file. The options include opening a HTML file in its raw form into a text editor, opening a HTML file as text with the HTML tags stripped out, opening a binary JMP file and opening a HTML file that contains TABLE tags (TABLE, TD, TR, etc.) as a JMP data table. The second parameter determines the action. For the last two methods, a pointer to a JMP data table automation object will be returned in the method invocation is successful, otherwise a NULL will be returned. For the first two methods, a NULL is always returned. InternetOpenTextAsData(URL As String) As DataTable Opens a Text file at the specified URL into a JMP script window, and then attempts to import the text in that Window as a JMP data table. The current preferences for Text Import are used for the text import phase. If successful, the function returns a pointer to a JMP data table that can be manipulated using the DataTable automation object methods. NULL is returned if the method fails. An example of code for this is: Set DT = MyJMP.InternetOpenTextAsData("www.sas.com/MyData/data.txt") Page 38
Application Object Reference for Automating JMP Application Object Dim Doc As JMP.Document Set Doc = DT.Document Doc.SaveAs ("c:\myData.jmp") NewDatabaseObject() As AutoDB Creates an object of type AutoDB, which is used for automating ODBC access to data. NewDataFeed() As DataFeed Creates a data feed object used to sample an external instrument hooked up to a serial port. NewDataTable(FileName As String) As DataTable Creates a new JMP data table, and returns the object so that it can be further automated. OpenDocument(FileName As String) As Document Opens a JMP data table as a Document.OpenDocument(FileName As String) As Document is a standard document access routine for automation applications, so it is provided in JMP. If a data table is loaded and the user wishes to manipulate the table contents, the Document method GetDataTable must be called to get a DataTable object. The DataTable object is what allows the contents to be changed. Quit() Shuts down JMP if no other automation applications are using it. Decrements the use count on JMP if other applications are automating it. RunCommand(Command As String) Runs JSL text that is provided in string form. RunJSLFile(FileName As String) Loads a JSL text file from disk given a valid path name, and then submits the text for execution within JMP. SetCurrentDirectory (DirName As String) As Boolean Sets the current directory within JMP. This allows the use of relative file names in other methods. This should be used with caution if existing automation client code assumes the use of the JMP installation directory. ShowLogHonorPreferences() This method is a variation of ShowLog(). The log is normally suppressed for Automation. However, if the JMP preferences indicate that the log should appear on startup, calling this function will show the log. The other log preferences are to show the log only when the user opens it or when JMP writes text to the log. ShowStartupWindow() Shows the JMP startup window (usually the Home window). If the Home Window is already showing, it is brought to the foreground. Page 39
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 7 and 8: Contents Application Object Referen
Page 21 and 22: Application Object Reference for Au
Page 57: Application Object Reference for Au
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

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?