View source for RU/development/qa/vcltesttool/api reference

<section begin=title /><noinclude>{{DISPLAYTITLE:Контроль качества: </noinclude>Приложение А: Справочник команд<noinclude>}}</noinclude><section end=title />{{BreadCrumbL10n}}

{{RUhelpneeded|Перевод на русский язык}} 

{{RU/vcltesttool/vcltesttooltoc
|ShowPrevNext=none
|ShowPrevPage=block
|ShowNextPage=none
|PrevPage=RU/qa/vcltesttool/localisation_tools
|parttitle=[[Apendix]]
}} 
=Internal Commands, Methods and Functions for TestTool=

The programming language used is [http://docs.sun.com/app/docs/doc/819-0439 StarBasic]. In addition to the general commands of StarBasic, the commands on this page work with VCL TestTool.

=Testscript Structure=
{| class="prettytable"
| '''Kontext'''&nbsp;String:Window
| Specifies the dialog or window that you want to test. You can use all of the controls in the dialog or windows, so long as you declared the ''''''Kontext'''''' in the win-files. Furthermore, if you do not declare the ''''''Kontext'''''', you cannot work with the dialog or window. For example, If you want to write to a Writerdocument, you must include the following:<br>'''''Kontext "DokumentWriter"<br>DokumentWriter.TypeKeys "This is a test."'''''

|-
| '''sub main<br>...<br>end sub'''
| Specifies the main routine for the TestTool. Write 'sub main' in lowercase letters with only one space between the two words. As the 'LoadIncludeFiles' routine is called at the start of a test script, the routine must be in the bas-file that contains the 'sub main' routine.

|-
| '''sub LoadIncludeFiles<br>use "inc\gvariabl.inc"<br>use "inc\master.inc"<br>call GetUseFiles ()<br>...'''

'''end sub'''
| This routine must be included in the bas-file that contains the 'sub main' routine.

|-
| '''sub TestEnter'''

'''...'''

'''end sub'''
| The TestEnter routine is located in the master.inc file and is automatically called when the testscript enters a testcase routine.

|-
| '''sub TestExit'''

'''...'''

'''end sub'''
| The TestExit routine is located in the master.inc file and is automatically called when a testscript exits a testcase-routine.

|-
| '''testcase'''<br>'''...<br>endcase'''
| A special test routine that tests one item, such as a control. The words testcase and endcase must be written in lowercase. If an error occurs in a testcase, the testcase ends and OpenOffice.org is reset to a base state. The error is then written to the resultfile.

|-
| '''try<br>...<br>catch<br>...<br>endcatch'''
| If you want to circumvent an error, use the ''try-catch-endcatch'' method. If an error occurs during the try-part, the test breaks and jumps to the catch-part. You can only branch this method once, that is, you can add a try..catch..endcatch in the try- or in the catch-part, but only in one level.

|-
| '''sub startTheOffice<br>...<br>end sub'''
| The startTheOffice routine is located in the master.inc file and is automaticall called when TestTool does not find an running OpenOffice.org to communicate with. It needs to contain at least the command 'start'.

|}

= Global =

{| class="prettytable"
| '''ActivateDocument '''nNr
| Activates the document window that has the number that you specify.'' ''Note: The list of document windows does not correspond to the order in which the windows are opened, that is, you do not know which document corresponds to which number.

|-
| '''AppAbort'''
| Deletes all communication-instructions in the queue between the TestTool and OpenOffice.org.

|-
| '''AppDelay '''nNr 
| Waits in OpenOffice.org (not in TestTool) for the number of milliseconds that you specify.

|-
| ''Boolean'' '''ApplicationBusy'''
| Returns 'FALSE' if the OpenOffice.org is in the ''waitcursor state'', otherwise returns 'TRUE'.

|-
| '''Assert '''<nowiki>[Text] </nowiki>
| Outputs an assertion from TestTool.

|-
| '''AutoExecute''' <nowiki>= Boolean</nowiki>
| If AutoExecute = FALSE, all commands behind it are collected, otherwise the commands are executed. You can also use Execute to run the collected commands.

|-
| '''CaptureAssertions '''<nowiki>[Bool]</nowiki>
| To catch the assertions in TestTool, set this variable to TRUE, otherwise set the variable to FALSE to throw the assertions back to OpenOffice.org.

|-
| '''caselog "" '''
| Stops the output at startup (used behind the win-declaration output)

|-
| '''catchGPF '''<nowiki>[Bool]</nowiki>
| Usually the VCL TestTool Application tries to handle crashes (default: TRUE). With FALSE this is disabled, and the crash is handled by the OpenOffice.org crashreporter.

|-
| '''DialogHandler''' String 
| Old instruction ‚Äì N/A

|-
| '''DisplayHid '''<nowiki>[TRUE]</nowiki>
| Call DisplayHid to display a window in OpenOffice.org that lets you select the windows that you want get the UniqueIDs for. To declare windows, use the '''declare.bas''' script.

|-
| ''Window.'''''DisplayPercent'''
| A method on Windows for returning information about the mouse position in the window. The position is given as a percentage of the distance between the top left corner of the window (0,0) and the bottom (0,100) and right (100,0) edges of the window.

|-
| '''ErrorLog '''
| Writes the last error to the resultfile (without a callstack).

|-
| '''ExceptLog '''
| Writes the last error to the resultfile with a callstack.

|-
| '''Execute'''
| Executes the collected commands when AutoExecute = FALSE

|-
| ''Object '''''findObject '''String
| Returns the object of String. E.g.: x = findObject ‚ÄúFormWizard‚Äù; print x.name

|-
| ''String'' '''GetApplicationPath'''
| Returns the correct path to TestTool.ini / .TestToolrc.

|-
| ''String''''' GetChildEnv''' String



| Gets an environment variable that was previous set by '''''SetChildEnv''.'''

|-
| ''String'' '''GetClipboard'''
| Returns the string from the OpenOffice.org clipboard. If the clipboard contains a picture, nothing is returned.

|-
| <nowiki>[tt_env]</nowiki>'' String'' '''GetClipboardText'''
| Supplies the real string from the clipboard. Use this function to return the information that is selected in a document. This function is not an internal TestTool command, but rather a function from the TestTool Environment.

|-
| ''String'' '''GetCommonApplicationPath'''
| Returns the correct path to sversion.ini / .sversionrc and testtool.ini / .testtoolrc in case of a 'all user installation mode'.

|-
| ''USHORT'' '''GetDocumentCount'''
| Returns the number of open documents in the OpenOffice.org installation that you are testing.

|-
| ''String'' '''GetLinkDestination''' String
| '''Linux/Unix''': Return the destination of a link. '''Win32''': String is returned.

|-
| ''String'' '''getRegistryValue''' (String1, String2)
| '''Win32''': Read a string value from the registry. String1 is a path schemata of either HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE. String2 is the key name to read. '''Linux/Unix''': return string is always empty.

|-
| ''String'' '''GetTestCaseFileName'''
| Returns the file name of the current testcase, otherwise this function returns an empty string. This file name is useful for the statistics output in the recover routine. 

|-
| ''Nr'' '''GetTestCaseLineNr'''
| Returns the line number of the current testcase.

|-
| ''String'' '''GetTestcaseName'''
| Returns the name of the current testcase. Outside a testcase it returns an empty string. The testcase name is useful for the statistics output in the recover routine. 

|-
| '''GPF'''
| Crashes OpenOffice.org.

|-
| ''Integer''''' HTTPSend '''<nowiki>(String Host, String Path, Integer Port [,String Filename])</nowiki>
| Retrieve a web page. For example: to save the page: [http://www.heise.de/ http://www.][http://www.heise.de/ heise.de/]HttpSend(‚Äú[http://www.heise.de/ www.heise.de]‚Äù,‚Äù/‚Äù,80,‚Äù/opt/heise.html‚Äù)<nowiki>; The returnvalue is the HTTP result (200 if OK).</nowiki>

|-
| '''HTTPSetProxy '''(String Host, Integer Port)
| Set a proxy to use by HTTPSend.

|-
| ''Bool'' '''IsProduct'''
| Returns FALSE if OpenOffice.org is a debug / non product build, else TRUE.

|-
| '''KillApp'''
| Kill the OOo application that was started by the command ''Start''.

|-
| ''String'' '''MakeIniFileName''' (String BaseName)
| Returns the correct name of an ''ini''-file on the current operating platform.For example, MakeIniFileName (‚ÄúTestTool‚Äù) returns TestTool.ini on Windows and .TestToolrc on UNIX.

|-
| '''NoDebug / Debug'''
| Deprecated.

|-
| '''PrintLog '''String
| Writes a string to the resultfile

|-
| '''Profile '''<nowiki>[Bool][,nNr1][,nNr2][,nNr3][,nNr4][,String]</nowiki>
| Get system-information. File is written to Resultdirectory with extension ''PRF''.
# profile ' start profiling for every command
# profile ''String'' ' print ''String'' in result file
# profile ''Integer'' ' write result every ''Integer'' ms
# profile true,1,10,100,1000' define time bins in ms and start profiling
# profile false ' stop profiling. print results

|-
| '''RemoteCommandDelay'''<nowiki> [msec][,msec] |TRUE | FALSE</nowiki>
| Delays the execution of OpenOffice.org commands (=remote) (not local BASIC routines).
functions:
*''<nowiki>msec,[msec]</nowiki>'' is the delay range (for example, if you enter 100,100, the delay is always 100 msec, whereas if you enter 100,200, the delay can be 100, 120, ... 130, ...190, 200). The second value is OPTIONAL.
*''TRUE | FALSE'' Boolean expression for enabling or disabling the delay.
Examples:
* ''RemoteCommandDelay 100<br>RemoteCommandDelay TRUE''
* ''RemoteCommandDelay 100,200<br>RemoteCommandDelay TRUE''



|-
| ''String '''''ResetApplication'''
| Returns OpenOffice.org to its base state and returns the taken actions of which windows were closed and how as string. 

|-
| '''SetChildEnv''' String1, String2



| Sets an environment variable that will get passed to the childprocess started by '''''start'''''.

|-
| '''SetClipboard '''String
| Copies a string to the clipboard

|-
| '''Start'''<nowiki> exe-file [, String2 ]</nowiki>
| Starts OpenOffice.org and opens the communication between OpenOffice.org and the TestTool. Use '''''start sAppExe''''' in a script file to specify the OpenOffice.org application that you want to start.

|-
| '''TypeKeysDelay'''<nowiki> Nr1 [,Nr2] | Bool</nowiki>
| Sets a delay in ms between 2 characters typed by the .typeKeys method.
# '''TypeKeysDelay''' 1000 ' 1 second delay
# '''TypeKeysDelay''' 500, 1000 ' randomly delay from 0.5 to 1 second
# '''TypeKeysDelay''' true | false ' enable | disable delay

|-
| '''WarnLog '''String
| Writes a warning to the resultfile.

|-
| '''QAErrorLog '''String
| Writes the string that you specify when this function is encountered in a test script or by internal TestTool code (Example: Extracting an XML package over existing XML files returns a QAError that tells the QA engineer that the directory is not empty). You enable or disabled the logging of these QA errors/notes with ''EnableQAErrors''.

|-
| '''EnableQAErrors'''<nowiki> = [Bool]</nowiki>
| Enables or disables the logging of QAErrorLogs. The default value is TRUE (=on). See the ''QAErrorLog'' command.

|-
| '''WinTree'''
| Shows the complete window hierarchy of OpenOffice.org, so long as you set the output to a variable. Use the following structure to show the complete tree:<br>'''Dim sInterim<br>sInterim = WinTree<br>Printlog sInterim'''

|-
| '''Use''' Include file
| If you want to use inc-file in a subroutine, you must add the files with the '''''use'''''-instruction. If you want, you can use relative pathnames (relative to TestTool path in TestTool.ini/.TestToolrc) or absolute pathnames.

|-
| '''UseBindings = TRUE<br>UseBindings = FALSE'''
| A test script aborts if you call a menu item slot that requires parameters. In this case, set 'UseBindings=TRUE' before the slot call. If the scripts still crashes, write the bug UseBindings => FALSE in each ResetApplication-Routine in TestEnter and TestExit.

|-
| '''usePostEvents '''Bool
| The implementation in the TestTool for .typeKeys, .MouseUp, .MouseDown and .MouseMove changed from OOo 2.1 to 2.2; To change to the old behaviour use FALSE

|-
| ''Ushort '''''waitSlot '''<nowiki>[msec</nowiki>]
| Returns WSTimeout or WSFinished, depending on the state of the last called slot. The command will return after msec or when the slot is finished.

|-
| colspan="2" | 
== Statistic ==


|-
| ''Integer''''' getErrorCount'''
| Returns the matching count of errors in the running test.

|-
| ''Integer''''' getWarningCount'''
| Returns the matching count of warnings in the running test.

|-
| ''Integer''''' getUseFileWarningCount'''
| Returns the matching count of warnings out of the declaration part in the running test.

|-
| ''String''''' getErrorList'''
| Return an array of strings. Each item consists of fields seperated by a colon.The fields are:1. Path to source file where Error ocurs2. Line number in source file3. cvs Revision, if available4. Error message

|-
| ''String''''' getWarningList'''
| Same as above, but for Warnings.

|}

= Commands on The Office Side =
<center>'''These commands work in OpenOffice.org applications and not in TestTool. You can also use them for remote testing. For normal file commands, please use BASIC commands.'''</center>

{| class="prettytable"
| ''String'' '''app.Dir '''Filename
| You can get the information if a file/directory exists or not. For example: for the files: '''''<nowiki>if app.dir ("d:\officedir\program\soffice.exe") <> "" than print "The file exists!"</nowiki>'''''for directories: '''''<nowiki>if app.dir ("d:\officedir\", 16) <> "" than print "the directory exists!"</nowiki>'''''

|-
| '''app.Kill '''Filename 
| Deletes a file.

|-
| '''app.rmDir '''Filename 
| Deletes a directory (only an empty directory)

|-
| '''app.mkDir '''Filename
| Creates a new directory.

|-
| '''app.FileCopy '''Old_filename, New_filename
| Copies a file.

|-
| '''app.Name''' Old_filename, New_filename
| Renames a file.

|-
| ''nSize'' '''app.FileLen''' Filename
| Returns the length of a file.

|-
| Date '''app.FileDateTime''' Filename
| Returns the date that a file was created.

|-
| '''GetSystemLanguage'''
| Returns the ISO language code (Integer) of the system that the OpenOffice.org application is running on.

|}

= Windows, Controls and Objects =
== Any Control, Window, Object ==
{| class="prettytable"
| ''String''''' '''Object'''.Caption'''
| Returns the name of dialogs (name on the titlebar of a dialog) or controls. For controls that do not have a name, the returnvalue is empty. Only the fixedtext belongs to a control.

|-
| ''Bool'' Object.'''Exists'''<nowiki> [Timeout in Sek.]</nowiki>
| Checks to see if a dialog or a control exists.

|-
| ''String'' Window.'''GetFixedText'''<nowiki> [Nr]</nowiki>
| Returns the content of the nth<nowiki> fixed text. If you do not specify the [Nr] parameter, the first fixed text is returned.</nowiki>

|-
| ''Nr'' Window.'''GetFixedTextCount'''
| Returns the number of fixed texts on a given window or control and associated child windows or controls.

|-
| ''Nr ''Object.'''GetRT'''
| Returns the resource type of the object, window, or control

|-
| ''Nr Window''.'''GetPosX'''
| Returns the x-position of the edge at the top left ''(in pixels).''

|-
| ''Nr'' Window.'''GetPosY'''
| Returns the y-position of the edge at the top left ''(in pixels).''

|-
| ''Nr'' Window.'''GetSizeX'''
| Returns the x-size of a dialog ''(in pixels).''

|-
| ''Nr'' Window.'''GetSizeY'''
| Returns the y-size of a dialog ''(in pixels).''

|-
| ''Nr'' Object.'''ID'''
| Returns the UniqueID of a window or a control.

|-
| ''Bool'' Object.'''IsEnabled'''
| Checks if a control is enabled.

|-
| ''Bool'' Object.'''IsVisible'''
| Checks if a control or a window is visible.

|-
| Objekt.'''MouseDown'''<nowiki> x, y [, nButton ] [,Focus]</nowiki>
| Presses the mouse button at the specified x/y-position (in percent) in a window. Ensure that you use the '''''mouseup''''' command after each instance of the '''''mousedown''''' command.'''nButton''' is:
*1 = left mouse button
*2 = middle mouse button
*3 = right mouse
The default (without nButton) is the left mouse button.

If the '''''MouseDown''''' and '''''MouseUp''''' combination does not work like a normal mouse click, then set the Focus parameter to '''''TRUE'''''.
(x,y):= (1,1) top left; (99,99) bottom right

|-
| Objekt.'''MouseDoubleClick '''<nowiki>x, y [, nButton ] [,Focus]</nowiki>
| Double-clicks with a mouse button at the x/y-position (in percent) of a window.If '''''MouseDoubleClick''''' does not work like a normal mouse double click, set the Focus parameter to '''''TRUE'''''.

|-
| Objekt.'''MouseMove'''<nowiki> x, y [, nButton ] [,Focus]</nowiki>
| Moves the mouse. To perform a mouse drag and move or drag and copy, add the '''''MouseDown''''' command before the '''MouseMove'''.

|-
| Objekt.'''MouseUp'''<nowiki> x, y [, nButton ] [,Focus]</nowiki>
| Releases the mouse button.If the '''''MouseDown''''' and '''''MouseUp''''' commands do not work like a normal mouse click, set the Focus parameter to '''''TRUE'''''.

|-
| Autoexecute = FALSE<br>Objekt.'''MouseDown'''<nowiki> x, y [, nButton ] [,Focus]</nowiki><br>Objekt.'''MouseUp'''<nowiki> x, y [,nButton] [,Focus]</nowiki><br>Autoexecute = TRUE
| Use this construction for a rapid mouse click.By setting the appropriate '''gApplication''', you can use the following subroutine for every OpenOffice.org document.'''gMouseClick (x, y)'''

|-
| <nowiki>[nNr.] </nowiki>'''GetMouseStyle'''
| Returns the actual state/look of the cursor, from a list of 85 possible values. Some important states: ARROW = 0, TEXT = 3, MOVE = 6 (moving objects), REFHAND = 28 (links/references) and FILL = 31(fillbox).

|-
| ''String'' Object.'''Name'''
| Returns the name of the object from the declaration.

|-
| ''Bool'' Object.'''NotExists'''<nowiki> [Timeout in Sek.]</nowiki>
| Checks to see if a control or window does not exist.

|-
| Objekt.'''OpenContextMenu''' <nowiki>[Focus]</nowiki>
| Opens the context menu of a window. If you set the Focus parameter to TRUE, the context menu opens at the position of the mouse.To open the context menu at a specific position in a window, you have to first move the mouse to the position before using the OpenContextMenu command.

|-
| Object.'''SnapShot''' String:Dateiname <nowiki>[PosX, PosY, SizeX, SizeY ] </nowiki>
| Takes a screenshot of a control or a window. If you want, you can also specify the position and size of the screenshot in pixels.

|-
| Dokumentobject.'''TypeKeys'''<nowiki> String [Nr.] [, Focus] </nowiki>
| Prints a string on the document, where Nr. is the number of times that you want to print the string.<nowiki>To use special keys, enclose them with "<>". </nowiki>For example: '''''<nowiki>DokumentWriter.TypeKeys "<Shift F1>"</nowiki>'''''

The '''Focus''' parameter is a Boolean expression. Normally, typekeys works without this parameter; however, to set the typekeys command directly in this window, set the Focus parameter to 'TRUE'. Use this parameter only when the normal command does not work correctly.

|}

== CheckBox ==
== Image-CheckBox  ==
[ Restype: 336 ], [ Restype: ??? ]

{| class="prettytable"
| Object.'''Check'''
| Selects the check box.

|-
| Object.'''Click'''
| Changes to the next state of the check box, that is, removes the check mark from a selected check box.

|-
| ''Bool'' Object.'''IsChecked'''
| Returns the state of the check box (TRUE = selected).

|-
| Object.'''UnCheck'''
| Clears the check box.

|}

== ComboBox  ==
<nowiki>[ Restype: 340 ]</nowiki>

{| class="prettytable"
| ''Nr'' Object.'''GetItemCount'''
| Returns the numbers of entries in the combo box.

|-
| ''String'' Object.'''GetItemText''' Nr
| Return the text of Nr. entry that you specify, including an entry that is not selected.

|-
| ''Nr'' Object.'''GetSelCount'''
| Returns the numbers of the entries that are selected in a combo box (You can select more than one entry).

|-
| ''Nr'' Object.'''GetSelIndex'''<nowiki> [Nr]</nowiki>
| Returns the index of the selected entry in the list.

|-
| ''String'' Object.'''GetSelText'''<nowiki> [Nr]</nowiki>
| Returns the text of the selected entry.

|-
| Object.'''Select''' Nr
| Selects an entry with the index number that you specify.

|-
| Object.'''Select''' String
| Selects the entry that has the same text as the String that you specify.

|-
| Object.'''SetNoSelection'''
| Sets no selection in a list (sometimes this corresponds to the first entry in the list).

|-
| Object.'''SetText'''<nowiki> [String]</nowiki>
| Enters the text string that you specify in a combo box. If the combo box contains an entry that matches the string, the entry is selected.

|}

== Dialog ==
== ModelessDialog ==
<nowiki>[ Restype: 314 - 316 ]</nowiki>

{| class="prettytable"
| Dialog.'''Cancel'''
| Closes a dialog by pressing the Cancel button.

|-
| Dialog.'''Close'''
| Closes a dialog with the Close button.

|-
| Dialog.'''Default'''
| Not important

|-
| Dialog.'''Help'''
| Presses the Help button to open the help topic for the dialog.

|-
| Dialog.'''Move''' Nr:x, Nr:y
| Moves a dialog in OpenOffice.org by the number of pixels that you specify.

|-
| Dialog.'''OK'''
| Closes a dialog with the OK button.

|}

== DockingWin ==
<nowiki>[ Restype: 370 ]</nowiki>

{| class="prettytable"
| Window.'''Close'''
| Closes a window by pressing the X button in the title bar of the window.

|-
| Window.'''Dock'''
| Docks a window on one edge of the StarDesktop.

|-
| Window.'''Help'''
| Opens the Help viewer.

|-
| ''Bool'' Window.'''IsDocked'''
| Returns the docking state.

|-
| ''Bool'' Window.'''IsMax'''
| Returns the state of the window (maximize or minimize).

|-
| Window.'''Maximize'''
| Maximizes a window so that the contents of the window are visible.

|-
| Window.'''Minimize'''
| Minimizes a window so that only the title bar of the window is visible.

|-
| Window.'''Move''' Nr:x, Nr:y
| Moves a window.

|-
| Window.'''Size''' Nr:x, Nr:y
| Resizes a window.

|-
| Window.'''Undock'''
| Undocks a window.

|-
| colspan="2" | === Splitting Windows  ===
(in dockingmode)

|-
| ''Bool'' Office.'''IsPin'''<nowiki> [Align] </nowiki>
| Returns the state of the pin.

|-
| ''Bool'' Office.'''IsFadeIn'''<nowiki> [Align] </nowiki>
| Returns the state of a window (visible or not).

|-
| Office.'''Pin'''<nowiki> Bool [Align] </nowiki>
| Presses the pin.

|-
| Office.'''FadeOut'''<nowiki> [Align] </nowiki>
| Fades out a window (visible).

|-
| Office.'''FadeIn'''<nowiki> [Align] </nowiki>
| Fades in a window (not visible).

|-
| colspan="2" | If there is more than one splitting window in a docking window, you must set the following '''Align''' operators. - '''AlignLeft'''- '''AlignRight-''' '''AlignTop'''- '''AlignBottom'''

|}

== EditWindow ==
'''(Documents - the active SDI window)'''
<nowiki>[ Restype: 312 ]</nowiki>

{| class="prettytable"
| colspan="2" | ''Special Note:''The first document is '''not enabled''' for the TestTool - most of the slot (calls of menu items) and ''TypeKeys ''commands do not work. This is a feature and not a bug.

|-
| ''Boolean'' Documentobject.'''HasScrollbar '''<nowiki>[Align]</nowiki>
| If the document has a scrollbar => TRUE

|-
| ''Boolean'' Documentobject.'''IsScrollBarEnabled '''<nowiki>[Align]</nowiki>
| If the document has a scrollbar and it is enabled => TRUE

|-
| If more than one scrollbar is visible, use the following parameters to define the position of the scrollbar. The default is AlignRight. - '''AlignLeft'''- '''AlignRight'''- '''AlignTop'''- '''AlignBottom'''
| For example:if (DocumentWriter.'''IsScrollBarEnabled '''AlignLeft) = TRUE then ...

|-
| '''Documentobject.Close'''
| Close document.

|-
| ''Boolean'' '''Documentobject.IsMax'''
| If document is maximized => TRUE

|-
| ''Boolean'' '''Documentobject.IsMin'''
| If document is minimized => TRUE

|-
| ''Boolean'' '''Documentobject.IsRestore'''
| If document is restored => TRUE

|-
| '''Documentobject.Maximize'''
| Maximize document.

|-
| '''Documentobject.Minimize'''
| Minimize document.

|-
| '''Documentobject.Restore'''
| Restore document.

|}

== Edit-Field ==
== MultiLineEdit-Field ==
[ Restype: 338 ], [ Restype: 339 ]

{| class="prettytable"
| ''String'' Object.'''GetText'''
| Returns the text from the edit field.

|-
| Object.'''SetText '''String
| Enters the text string in the edit field.

|-
| ''Bool'' Object.'''IsWritable'''
| Checks if a control is writable (only for visible Edit- and MultiLine Edit- fields).

|}

== FloatWin (Flyer) ==
<nowiki>[ Restype: 313 ]</nowiki>

{| class="prettytable"
| Window.'''Close'''
| Closes the window (x-button in the title bar of the window).

|-
| Window.'''Help'''
| Opens the help for the current window (help button).

|-
| ''Bool'' Window.'''IsMax'''
| Returns the state of the window (maximize or minimize).

|-
| Window.'''Maximize'''
| Maximizes the window.

|-
| Window.'''Minimize'''
| Minimizes the window so that only the title bar is visible.

|-
| Window.'''Move''' Nr:x, Nr:y
| Moves the window by the number of pixels that you specify.

|-
| Window.'''Size''' Nr:x, Nr:y
| Resizes the window.

|}

== ListBox ==
== MultiListBox ==
<nowiki>[ Restype: 341 ], [ Restype: 342 ]</nowiki>

{| class="prettytable"
| ''Nr'' Object.'''GetItemCount'''
| Returns the number of entries in a list box.

|-
| ''String'' Object.'''GetItemText''' Nr
| Return the text of entry Nr. in the list box.

|-
| ''Nr'' Object.'''GetSelCount'''
| Returns the number of selected entries in a multi-list box (you can select more than one entry).

|-
| ''Nr'' Object.'''GetSelIndex'''<nowiki> [Nr]</nowiki>
| Returns the index number of the selected entry in the list.

|-
| ''String'' Object.'''GetSelText'''<nowiki> [Nr]</nowiki>
| Returns the text of the selected entry. If more than one item is selected, use Nr. to specify which entry to return.

|-
| ''Boolean'' Documentobject.'''HasScrollbar '''<nowiki>[Align]</nowiki>
| If the document has a scrollbar => TRUE

|-
| ''Boolean'' Documentobject.'''IsScrollBarEnabled '''<nowiki>[Align]</nowiki>
| If the document has a scrollbar and it is enabled => TRUE

|-
| If more than one scrollbar is visible, you have to use the following parameters to add the position. The default is AlignRight. - '''AlignLeft'''- '''AlignRight'''- '''AlignTop'''- '''AlignBottom'''
| Example:if (DocumentWriter.'''IsScrollBarEnabled '''AlignLeft) = TRUE then ...

|-
| Object.'''Select''' Nr
| Selects an entry and its index.

|-
| Object.'''Select''' String
| Selects the text of an entry.

|-
| Object.'''SetNoSelection'''
| Set no selection in a list (sometimes this corresponds to the first entry).

|}

== MenuButton ==
<nowiki>[ Restype: 331 ]</nowiki>

{| class="prettytable"
| Button.'''Click'''
| 1. Performs the function that is assigned to a menu button, otherwise the menu of the button is not opened.2. For menu buttons that are accessed through a context menu, use the [all_commands_short.sxw#menu menu-instructions].

|-
| Button.'''Open'''
| Opens the context menu of the menu button so that you can use the [all_commands_short.sxw#menu menu-instructions].

|-
| Button.'''OpenMenu'''
| Opens the context menu of the menu button so that you can use the [all_commands_short.sxw#menu menu-instructions]. To close the menu on a toolbox item, call .openMenu again.

|-
| ''Toolbox''.'''OpenMenu''' ButtonID
| Opens the context menu of the menu button in Toolbars so that you can use the [all_commands_short.sxw#menu menu-instructions].

|}

== Menu and Context Menu ==

{| class="prettytable"
| colspan="2" | ''Special notes:''The following instructions can only be carried out on an open context menu or an open sub context menu, otherwise and error is returned. Only use these instructions if you cannot find an equivalent instruction in the ''menu.inc'' file. Warning: Make sure that you close each context menu after the instruction has been carried out, otherwise the test encounters a GPF (crashes).

|-
| Objekt.'''OpenContextMenu'''<nowiki> [Bool] </nowiki>
| Opens a context menu for a window or a document.The Boolean parameter in StarSchedule and in base documents must be set to TRUE. The default value is FALSE.

|-
| ''nNr'' '''MenuGetItemCount '''
| Returns the numbers of menu entries (including the menu separators)

|-
| ''nID'' '''MenuGetItemID '''nPos 
| Returns the ID of an menu entry (the ID is required for the remaining menu instructions).

|-
| ''nNr'' '''MenuGetItemText '''nID 
| Returns the text of the menu entry that has the same nID as the one that you specify (from MenuGetItemID).

|-
| ''nNr'' '''MenuGetItemPos '''nID 
| Returns the position of the menu entry that has the same nID as the one you specify (from MenugetItemID).

|-
| ''Bool'' '''MenuHasSubMenu''' nID
| Returns TRUE if the menu entry opens a submenu.

|-
| ''Bool'' '''MenuIsItemChecked '''nID 
| Returns the state of a menu entry with a hook (from MenugetItemID).

|-
| ''nNr'' '''MenuIsItemEnabled '''nID 
| Returns the state ‚Äúdisabled‚Äù or ‚Äúenabled‚Äù (from MenugetItemID)

|-
| ''Bool'' '''MenuIsSeperator '''nPos 
| Returns TRUE if the menu entry is a separator.

|-
| '''MenuSelect '''nID 
| Activates the menu item that has the same nID as the one that you specify. If the menu does not automatically close after you activate it, you must close the menu using MenuSelect (0).

|-
| '''MenuSelect (0) '''
| Closes all active menus.

|-
| colspan="2" | === special methods ===


|-
| DocumentWindow.'''UseMenu'''
| Use this method before you activate a menu in a document. For example: '''''Kontext &ldquo;DocumentWriter&rdquo;DocumentWriter.UseMenu'''''After you apply this method, you can then use the normal [all_commands_short.sxw#menu menu-methods].

|-
|  ''String'' '''MenuGetItemCommand '''nItemID
| Reads out the command of a MenuItem. This is useful for determining the UNO URLs so you can declare the UNO Slots.

|-
| colspan="2" | Description: The first menu is the menu bar with the entries (File, Edit, View ...). To open the File-Menu, open the submenu of the first menu entry.

|}

== MessBox / InfoBox ==
== WarningBox / ErrorBox  ==
== QueryBox ==
<nowiki>[ Restype: 304 - 308 ] (Messagebox)</nowiki>'''(these boxes are handled by the active-operator)'''

{| class="prettytable"
| Active.'''Cancel'''
| Closes the box with the Cancel button.

|-
| Active.'''Click''' ButtonID 
| Not important

|-
| Active.'''Default '''
| Closes the box with the Default button (that has the focus).

|-
| Active'''.GetText'''
| Returns the text from the messagebox.

|-
| Active'''.No'''
| Closes the box with the No button.

|-
| Active'''.OK'''
| Closes the box with the OK button.

|-
| Active'''.Repeat'''
| Closes the box with the Repeat button.

|-
| Active.'''Yes'''
| Closes the box with the Yes button.

|-
| colspan="2" |
=== with checkbox(es) ===


|-
| ''String'' Active.'''GetCheckBoxText'''
| Puts the text of the check box into a string.

|-
| ''BOOL'' Active.'''IsChecked'''
| Returns TRUE if the box is checked, otherwise FALSE is returned.

|-
| ''Int'' Active.'''GetState'''
| Returns the state of the checkbox as integer

|-
| Active.'''Check'''
| Selects the check box on the message/info/warning/error/query box.

|-
| Active.'''UnCheck'''
| Clears the check box on the message/info/warning/error/query box.

|}

== MoreButton  ==
'''(for additions in a dialog)''' 

<nowiki>[ Restype: 332 ]</nowiki>

{| class="prettytable"
| ''String'' Object.'''Caption'''
| Returns the text of the button.

|-
| Object.'''Click'''
| Clicks the button.

|-
| Object.'''Close'''
| Closes the addition window.

|-
| ''Bool'' Object.'''IsOpen'''
| Returns the state of the addition window (TRUE == Open).

|-
| Object.'''Open'''
| Opens the addition window.

|}

== PushButton, ImageButton ==
[ Restype: 326 ], [ Restype: 330 ]

{| class="prettytable"
| Object.'''Click'''
| Clicks the button.

|}

== RadioButton, ImageRadioButton ==
[ Restype: 334 ],[ Restype: 335]

{| class="prettytable"
| Object.'''Check'''
| Selects the radio button.

|-
| ''Bool'' Object.'''IsChecked'''
| Returns the state of the radio button (TRUE = checked).

|}

== SpinField ==
== PatternField ==
== NumericField ==
== MetricField ==
== CurrencyField ==
== DateField ==
== TimeField ==
<nowiki>[ Restype: 353 - 359 ]</nowiki>

{| class="prettytable"
| ''String'' Object.'''GetText'''
| Returns the text from the field.

|-
| Object.'''More'''<nowiki> [ Nr ]</nowiki>
| Moves one entry higher.

|-
| Object.'''Less'''<nowiki> [ Nr ]</nowiki>
| Moves one entry lower.

|-
| Object.'''SetText''' String
| Prints text in the field (only in the right format).

|-
| Object.'''ToMax'''
| Goes to the maximum value.

|-
| Object.'''ToMin'''
| Goes to the minimum value.

|}

== StatusBar ==
(on edit-windows - documents)

{| class="prettytable"
| ''Int DocumentWindow''.'''StatusGetItemCount '''
| Returns the number of items on the status bar.

|-
| ''Int'' DocumentWindow.'''StatusGetItemID''' nNr 
| Returns the ItemID of a control on the status bar.

|-
| ''String'' DocumentWindow.'''StatusGetText'''<nowiki> [ ItemID ] </nowiki>
| Returns the text of the status bar or of the item that has the ItemID that is not on the status bar.

|-
| ''Bool'' DocumentWindow.'''StatusIsProgress '''
| Returns true if the status bar is a progress bar.

|}

== System Dialog ==
(system File- or Folder-dialogs - only for Win32)

{| class="prettytable"
| ''Boolean '''''ExistsSysDialog '''(which)
| Returns TRUE if a system dialog is open (which = FolderPicker or FilePicker).

|-
| '''CloseSysDialog''' (which)
| Closes the system dialog (which = FolderPicker or FilePicker).

|-
| 
| 

|-
| '''FolderPicker'''
| If you want to handle a system folder dialog, you have to substitute the FolderPicker method for the 'which' statement in the above methods.

|-
| '''FilePicker'''
| If you want to handle a system file dialog, you have to substitute the FilePicker method for the 'which' statement in the above methods.

|}

== TabPage ==
<nowiki>[ Restype: 372 ]</nowiki>

{| class="prettytable"
| for activating a Tabpage with the 'Active'-Operator (normal TabDialogs)
| for activating a Tabpage with the TabControl-Operator (only special dialogs)

|-
| ''Kontext''

''Active.SetPage TabZeichenKontext "TabZeichen"''
| ''Kontext "XYZ-Dialog" ''

''TabControl.SetPage TabZeichenXYZ'''''Note''': Do not use ''Kontext "Active"'' before Active.SetPage ‚Äì this no longer works.

|-
| colspan="2" | 

|}

{| class="prettytable"
| ''Nr ''Active.'''GetPage'''
| Returns the UniqueID for the active tab page.

|-
| ''Nr'' Active.'''GetPageCount'''
| Returns the number of tab pages in the dialog.

|-
| ''Nr'' Active.'''GetPageId'''<nowiki> [Nr] </nowiki>
| Returns the TabpageID from the dialog. This not the UniqueID and is only needed for the '''''SetPageID''''' instruction.

|-
| Active.'''SetPage '''TabpageObjekt
| Changes to the tab page that you specify.

|-
| Active.'''SetPageId''' Nr
| Changes to the tab page that has the TabpageID that you specify.

|-
| Active.'''SetPageNr''' Nr 
| Not important

|}

== Toolbar ==
<nowiki>[ Restype: 369 ]</nowiki>

{| class="prettytable"
| Button.'''Click'''
| Activates or deactivates a button.

|-
| ''String'' Button.'''GetItemText''' nNr 
| Returns the text of a button (if available).

|-
| ''nNr'' Button.'''GetState''' nType 
| Returns the state of a button in dependent on '''''nType'''''.nType = 0 => HelpID (0 = Separator)nType = 1 => ItemTyp (1=Button, 3=Separator ...)nType = 2 => ItemState (1=pressed, 0=not pressed)nType = 3 => ItemIDelse <nowiki>=> HelpID</nowiki>

|-
| ''String'' Toolbar.'''GetText'''
| Returns the internal name of a toolbar.

|-
| Button.'''TearOff'''
| Tears off a toolbar, but only after a toolbar has been opened by clicking on a button.(You do not need to click click the button a second time)

|-
| ''Nr'' Toolbar.'''GetItemCount'''
| Returns the number of items in a toolbar (buttons and separators).

|-
| ''String'' Toolbar.'''GetNextToolbox '''
| Returns the next toolbar if you can change to another toolbar that has a button on it.

|-
| Toolbar.'''SetNextToolbox '''<nowiki>[ String ] </nowiki>
| Changes to the next toolbar, or to the toolbar whose name you enter.

|}

== ValueSet ==
== BrowseBox ==
== TreeListBox ==
<nowiki>[ Restype: 376 ]</nowiki>

{| class="prettytable"
| colspan="2" | The column number is optional. If it is not given, the first found appropiate column is chosen. If you take an action for a checkbox, the first found checkbox is used. If a checkbox is not found, an error is thrown. If the column number is given, you use an action for a checkbox, the item is no checkbox, an error is thrown.


|-
| ''Integer'' Object.'''GetItemCount '''
| Returns the number of rows.

|-
| ''ItemType'' Object .'''getItemType'''<nowiki> [row Integer [, column Integer]]</nowiki>
| Returns the item type. ItemType can be of the following defined constants:'''
*ItemTypeText
*ItemTypeBMP
*ItemTypeCheckbox
*ItemTypeContextBMP
*ItemTypeUnknown'''

|-
| ''String'' Object.'''GetItemText''' row Integer <nowiki>[, column </nowiki>Integer]
| Returns the text.

|-
| ''Integer'' Object.'''GetSelCount '''
| Returns the number of selected entries.

|-
| ''Integer'' Object.'''GetSelIndex'''<nowiki> [</nowiki>Integer] 
| Returns the index of the selected entry in the list.

|-
| ''String'' Object.'''GetSelText''' (<nowiki>[</nowiki>row Integer<nowiki> [,</nowiki>column Integer]])
| '''GetSelText '''returns the text of the selected entry.'''GetSelText 1,2 '''returns the second text of the first selected entry (if the list box has more than one column.'''GetSelText 2''' returns the first text of the second selected entry.

|-
| ''String'' Objekt.'''GetText'''
| Returns the text of the selected entry.

|-
| Object.'''Select'''<nowiki> Nr [, Bool ] </nowiki>
| Selects an entry by number.

|-
| Object.'''Select''' String 
| Selects an entry by string.

|-
| Object.'''setNoSelection'''
| Unselect all.

|-
| colspan="2" | 
=== with Checkbox(es) ===


|-
| ''Boolean ''Object.'''IsChecked''' <nowiki>Integer row [, Integer column]</nowiki>
| If the check box is selected => TRUE else FALSE

|-
| ''Boolean ''Object.'''IsTriState '''<nowiki>Integer row [, Integer column]</nowiki>
| If the check box is in tri state => TRUE else FALSE

|-
| ''Nr ''Object.'''getState '''<nowiki>Integer row [, Integer column]</nowiki>
| Returns the state of the box: 
Unchecked == 0
Checked == 1
TriState == 2

|-
| Object.'''Check '''<nowiki>Integer row [, Integer column]</nowiki>
| Selects the check box.

|-
| Object.'''Uncheck '''<nowiki>Integer row [, Integer column]</nowiki>
| Clears the check box.

|-
| Object.'''TriState '''<nowiki>Integer row [, Integer column]</nowiki>
| Sets the check box in tri state.

|}

== TriStateBox ==
<nowiki>[ Restype: 337 ]</nowiki>

{| class="prettytable"
| Object.'''Check'''
| Selects the tristatebox.

|-
| Object.'''Click'''
| Changes to the next state of the tristatebox.

|-
| ''Nr ''Object''.'''''GetState'''
| Returns the state of the box: Unchecked == 0 Checked == 1 TriState == 2

|-
| ''Bool'' Object.'''IsChecked'''
| Returns the checkstate (TRUE == checked).

|-
| ''Bool'' Object'''.IsTriState'''
| Returns the tristate (TRUE == in tristate).

|-
| Object.'''TriState'''
| Puts the object in the tristate.

|-
| Object.'''UnCheck'''
| Clears the tristatebox.

|}

== EditBrowseBox ==
<nowiki>[ Restype: </nowiki>]

{| class="prettytable"
| ''String'' Object.'''getSelText'''
| Returns the text of the selected field.

|-
| ''Integer'' Object.'''getColumnCount'''
| Returns the number of columns.

|-
| ''Integer ''Object''.'''''getRowCount'''
| Returns the number of rows.

|-
| ''Bool'' Object'''.isEditing'''
| Returns TRUE if the field is in edit mode.

|-
| Object'''.select '''(Integer Row, Integer Column)
| Go to the given field.

|}

== Roadmap ==
<nowiki>[ Restype: </nowiki>]

{| class="prettytable"
| ''Integer'' Object.'''GetItemCount'''
| Returns the number of entries in a list.

|-
| ''String'' Object.'''GetItemText''' Integer row
| Return the text of entry ''row'' in the list.

|-
| ''Integer'' Object.'''GetSelIndex'''
| Returns the index number of the selected entry in the list.

|-
| ''String'' Object.'''GetSelText'''
| Returns the text of the selected entry.

|-
| ''Boolean'' Object.'''isItemEnabled''' Integer row
| If the item is enabled => TRUE

|-
| Object.'''select '''Integer row
| Select the item in ''row''.

|}


=Working With XML Files=
== Introduction ==
In the SAX interface that is included in OpenOffice.org, you can use the XML parser "eXpat" so that you can easily work with XML files in the TestTool environment. The ''SAXReadFile'' command creates a ''DOM'' (Document Object Model<nowiki>; a tree like 'view') where you can navigate with TestTool commands.</nowiki>

== Main Commands ==

{| class="prettytable"
| SAXReadFile filename
| Recommended command to open the XML file (or stream). The command checks well-formedness and creates a DOM.

|-
| SAXRelease
| After TestTool has finished using the XML file, this command closes the DOM.

|-
| String SAXCheckWelltformed filename
| Opens an XML file, checks the well-formedness of the file, and returns any errors in a string. This command does not create a DOM. Open DOMs are closed after this command is executed.

|}

== Working With Elements, Attributes And Characters ==

{| class="prettytable"
| ''String'' '''SAXGetNodeType'''
| The operations that you can perform with nodes depends on the type of node. There are two types of nodes that are also constants:

# 
## ''NodeTypeElement''
### Includes other nodes and elements (this is the most important function)
### Functions
###* ''SAXGetElementName''
###* ''SAXGetAttributeCount''
###* ''SAXGetAttributeName''
###* ''SAXGetAttributeValue''
## ''NodeTypeCharacter''
### ''SAXGetChars'' is the only function that returns the characters from that node.



|-
| ''String'' '''SAXGetElementName'''
| Returns the name of the XML element at the current 'pointer' location.

|-
| ''String'' '''SAXGetChars'''
| Returns the characters from the node type: ''NodeTypeCharacter.''

|-
| ''String'' '''SAXGetAttributeValue '''''integer''
| Returns the value of the nth attribute in the recent node.

|-
| ''String'' '''SAXGetAttributeValue '''''String'' 
| Returns the value of the named attribute in the recent node.

|-
| ''Integer'' '''SAXGetAttributeCount'''
| Returns the count of attributes in the recent node.

|-
| ''String'' '''SAXGetAttributeName '''''int''
| Returns the name of the nth attribute in the recent node.

|}


== Navigate And Search in The DOM ==

{| class="prettytable"
| ''Integer'' '''SAXGetChildCount'''
| Returns the count of child nodes (XML elements).

|-
| '''SAXSeekElement '''''integer''
| Searches for the nth element in the node.

To go to the parent node, set the integer to 0 (zero).

|-
| '''SAXSeekElement '''''string''
| Searches for the named element in the node. The string can be one of the following:

* "/" go to root node
* "Name" searches in child nodes for named node (element)
* "<nowiki>*..." special string from </nowiki>''SAXGetElementPath''



|-
| ''Boolean'' '''SAXHasElement '''''integer''
| Checks if a child exists at the nth node.

|-
| ''Boolean '''''SAXHasElement '''''string''
| Checks if a child exists at the named node.

|-
| ''String'' '''SAXGetElementPath'''
| Returns a special string for later navigation with the ''SAXSeekElement''.

|}

=Typekeys Instruction=

== Description ==
This list includes all of the keyboard keys that you can use in the '''''typekeys''''' command, provided that you use the following structure:

<center><tt><nowiki>[control].typekeys "<[key(s)]>" </nowiki></tt></center>

<tt>Examples:</tt>

<center><tt><nowiki>DocumentWriter.TypeKeys "<F11>"</nowiki></tt></center>

<nowiki>This method allows you to simulate keyboard events such as [</nowiki>'''ESC'''<nowiki>ape] or [</nowiki>'''C'''on'''TR'''o'''L'''] in the TestTool. For key combinations such as '''Alt''' AND '''F2''', use the following structure:

<center><tt><nowiki>[control].typekeys "<MOD1 F2>" </nowiki></tt></center>

Ensure that you leave a ''blank'' between the keyboard keys.


{| class="prettytable"
| <center>'''Value'''</center>
| <center>'''Key'''</center>
| <center>'''Value'''</center>
| <center>'''Key'''</center>
| <center>'''Value'''</center>
| <center>'''Key'''</center>

|-
| colspan="2" | <center>Characters</center>
| '''Y'''
| Y
| '''UNDO'''
| Undo

|-
| '''0'''
| 0
| '''Z'''
| Z
| '''REPEAT'''
| Repeat

|-
| '''1'''
| 1
| colspan="2" | <center>Cursor Keys</center>
| '''FIND'''
| Find

|-
| '''2'''
| 2
| '''DOWN'''
| Cursor down
| '''PROPERTIES'''
| Properties

|-
| '''3'''
| 3
| '''UP'''
| Cursor up
| '''FRONT'''
| Front

|-
| '''4'''
| 4
| '''LEFT'''
| Cursor left
| '''SHIFT'''
| Shift

|-
| '''5'''
| 5
| '''RIGHT'''
| Cursor right 
| '''MOD1'''
| Ctrl / Strg

|-
| '''6'''
| 6
| '''HOME'''
| Pos 1
| '''MOD2'''
| Alt

|-
| '''7'''
| 7
| '''END'''
| End
| '''MODTYPE'''
| Alt Gr

|-
| '''8'''
| 8
| '''PAGEUP'''
| Page up
| '''F1'''
| F1

|-
| '''9'''
| 9
| '''PAGEDOWN'''
| Page down
| '''F2'''
| F2

|-
| '''A'''
| A
| colspan="2" | <center>Special Keys</center>
| '''F3'''
| F3

|-
| '''B'''
| B
| '''RETURN'''
| Return
| '''F4'''
| F4

|-
| '''C'''
| C
| '''ESCAPE'''
| Escape
| '''F5'''
| F5

|-
| '''D'''
| D
| '''TAB'''
| Tab
| '''F6'''
| F6

|-
| '''E'''
| E
| '''BACKSPACE'''
| Backspace
| '''F7'''
| F7

|-
| '''F'''
| F
| '''SPACE'''
| Space / Blank
| '''F8'''
| F8

|-
| '''G'''
| G
| '''INSERT'''
| Insert
| '''F9'''
| F9

|-
| '''H'''
| H
| '''DELETE'''
| Delete
| '''F10'''
| F10

|-
| '''I'''
| I
| colspan="2" | <center>Arithmetic Keys</center>
| '''F11'''
| F11

|-
| '''J'''
| J
| '''ADD'''
| +
| '''F12'''
| F12

|-
| '''K'''
| K
| '''SUBTRACT'''
| -
| '''F13'''
| F13

|-
| '''L'''
| L
| '''MULTIPLY'''
| <nowiki>*</nowiki>
| '''F14'''
| F14

|-
| '''M'''
| M
| '''DIVIDE'''
| :
| '''F15'''
| F15

|-
| '''N'''
| N
| '''POINT'''
| .
| '''F16'''
| F16

|-
| '''O'''
| O
| '''COMMA'''
| ,
| '''F17'''
| F17

|-
| '''P'''
| P
| '''LESS'''
| <nowiki><</nowiki>
| '''F18'''
| F18

|-
| '''Q'''
| Q
| '''GREATER'''
| >
| '''F19'''
| F19

|-
| '''R'''
| R
| '''EQUAL'''
| <nowiki>=</nowiki>
| '''F20'''
| F20

|-
| '''S'''
| S
| colspan="2" | <center>Function Keys</center>
| '''F21'''
| F21

|-
| '''T'''
| T
| '''OPEN'''
| Open
| '''F22'''
| F22

|-
| '''U'''
| U
| '''CUT'''
| Cut
| '''F23'''
| F23

|-
| '''V'''
| V
| '''COPY'''
| Copy
| '''F24'''
| F24

|-
| '''W'''
| W
| '''PASTE'''
| Paste / Insert
| '''F25'''
| F25

|-
| '''X'''
| X
| 
| 
| '''F26'''
| F26

|}

= GetMouseStyle =

All values of GetMouseStyle command which returns the actual look/state of the cursor. 


<center>''<nowiki>[nNr] GetMouseStyle</nowiki>''</center>


There existing 85 values.


{| class="prettytable"
! <center>Value</center>
! <center>Nr</center>
! <center>Comment</center>

|-
| ARROW
| <div align="right">0</div>
| Arrowcursor

|-
| NULL
| <div align="right">1</div>
| 

|-
| WAIT
| <div align="right">2</div>
| 

|-
| TEXT
| <div align="right">3</div>
| Entering text

|-
| HELP
| <div align="right">4</div>
| 

|-
| CROSS
| <div align="right">5</div>
| 

|-
| MOVE
| <div align="right">6</div>
| Moving objects/images

|-
| NSIZE
| <div align="right">7</div>
| 

|-
| SSIZE
| <div align="right">8</div>
| 

|-
| WSIZE
| <div align="right">9</div>
| 

|-
| ESIZE
| <div align="right">10</div>
| 

|-
| NWSIZE
| <div align="right">11</div>
| 

|-
| NESIZE
| <div align="right">12</div>
| 

|-
| SWSIZE
| <div align="right">13</div>
| 

|-
| SESIZE
| <div align="right">14</div>
| 

|-
| WINDOW_NSIZE
| <div align="right">15</div>
| 

|-
| WINDOW_SSIZE
| <div align="right">16</div>
| 

|-
| WINDOW_WSIZE
| <div align="right">17</div>
| 

|-
| WINDOW_ESIZE
| <div align="right">18</div>
| 

|-
| WINDOW_NWSIZE
| <div align="right">19</div>
| 

|-
| WINDOW_NESIZE
| <div align="right">20</div>
| 

|-
| WINDOW_SWSIZE
| <div align="right">21</div>
| 

|-
| WINDOW_SESIZE
| <div align="right">22</div>
| 

|-
| HSPLIT
| <div align="right">23</div>
| 

|-
| VSPLIT
| <div align="right">24</div>
| 

|-
| HSIZEBAR
| <div align="right">25</div>
| 

|-
| VSIZEBAR
| <div align="right">26</div>
| 

|-
| HAND
| <div align="right">27</div>
| 

|-
| REFHAND
| <div align="right">28</div>
| Links / References

|-
| PEN
| <div align="right">29</div>
| 

|-
| MAGNIFY
| <div align="right">30</div>
| 

|-
| FILL
| <div align="right">31</div>
| Fillbox

|-
| ROTATE
| <div align="right">32</div>
| 

|-
| HSHEAR
| <div align="right">33</div>
| 

|-
| VSHEAR
| <div align="right">34</div>
| 

|-
| MIRROR
| <div align="right">35</div>
| 

|-
| CROOK
| <div align="right">36</div>
| 

|-
| CROP
| <div align="right">37</div>
| 

|-
| MOVEPOINT
| <div align="right">38</div>
| 

|-
| MOVEBEZIERWEIGHT
| <div align="right">39</div>
| 

|-
| MOVEDATA
| <div align="right">40</div>
| 

|-
| COPYDATA
| <div align="right">41</div>
| 

|-
| LINKDATA
| <div align="right">42</div>
| 

|-
| MOVEDATALINK
| <div align="right">43</div>
| 

|-
| COPYDATALINK
| <div align="right">44</div>
| 

|-
| MOVEFILE
| <div align="right">45</div>
| 

|-
| COPYFILE
| <div align="right">46</div>
| 

|-
| LINKFILE
| <div align="right">47</div>
| 

|-
| MOVEFILELINK
| <div align="right">48</div>
| 

|-
| COPYFILELINK
| <div align="right">49</div>
| 

|-
| MOVEFILES
| <div align="right">50</div>
| 

|-
| COPYFILES
| <div align="right">51</div>
| 

|-
| NOTALLOWED
| <div align="right">52</div>
| 

|-
| DRAW_LINE
| <div align="right">53</div>
| 

|-
| DRAW_RECT
| <div align="right">54</div>
| 

|-
| DRAW_POLYGON
| <div align="right">55</div>
| 

|-
| DRAW_BEZIER
| <div align="right">56</div>
| 

|-
| DRAW_ARC
| <div align="right">57</div>
| 

|-
| DRAW_PIE
| <div align="right">58</div>
| 

|-
| DRAW_CIRCLECUT
| <div align="right">59</div>
| 

|-
| DRAW_ELLIPSE
| <div align="right">60</div>
| 

|-
| DRAW_FREEHAND
| <div align="right">61</div>
| 

|-
| DRAW_CONNECT
| <div align="right">62</div>
| 

|-
| DRAW_TEXT
| <div align="right">63</div>
| 

|-
| DRAW_CAPTION
| <div align="right">64</div>
| 

|-
| CHART
| <div align="right">65</div>
| 

|-
| DETECTIVE
| <div align="right">66</div>
| 

|-
| PIVOT_COL
| <div align="right">67</div>
| 

|-
| PIVOT_ROW
| <div align="right">68</div>
| 

|-
| PIVOT_FIELD
| <div align="right">69</div>
| 

|-
| CHAIN
| <div align="right">70</div>
| 

|-
| CHAIN_NOTALLOWED
| <div align="right">71</div>
| 

|-
| TIMEEVENT_MOVE
| <div align="right">72</div>
| 

|-
| TIMEEVENT_SIZE
| <div align="right">73</div>
| 

|-
| AUTOSCROLL_N
| <div align="right">74</div>
| 

|-
| AUTOSCROLL_S
| <div align="right">75</div>
| 

|-
| AUTOSCROLL_W
| <div align="right">76</div>
| 

|-
| AUTOSCROLL_E
| <div align="right">77</div>
| 

|-
| AUTOSCROLL_NW
| <div align="right">78</div>
| 

|-
| AUTOSCROLL_NE
| <div align="right">79</div>
| 

|-
| AUTOSCROLL_SW
| <div align="right">80</div>
| 

|-
| AUTOSCROLL_SE
| <div align="right">81</div>
| 

|-
| AUTOSCROLL_NS
| <div align="right">82</div>
| 

|-
| AUTOSCROLL_WE
| <div align="right">83</div>
| 

|-
| AUTOSCROLL_NSWE
| <div align="right">84</div>
| 

|}


=Resource Types of all Controls and Windows=

To see the internal resource type ID for a control or a window (for example, a dialog) in the declaration window, run the '''''declare.bas''''' script in TestTool. You can then use the ID to identify the correct type of control or window to find the corresponding commands. You can also use '''''window'''''.'''GetRT''' to determine the resource type ID. The ID for ''control'' (324) is often used in OpenOffice.org and represents a special control, such as a ''treelistbox'' or a ''browsbox, ''that was created by a developer. Use trial and error to determine which commands can be used on a control.


{| class="prettytable"
! <center>resource type</center>
! <center>resource-ID</center>
! <center>resource type</center>
! <center>resource-ID</center>

|-
| '''BASE'''
| <center>256</center>
| '''FIXEDTEXT'''
| <center>343</center>

|-
| '''MESSBOX'''
| <center>304</center>
| '''FIXEDLINE'''
| <center>344</center>

|-
| '''INFOBOX'''
| <center>305</center>
| '''FIXEDBITMAP'''
| <center>345</center>

|-
| '''WARNINGBOX '''
| <center>306</center>
| '''FIXEDIMAGE'''
| <center>346</center>

|-
| '''ERRORBOX '''
| <center>307</center>
| '''GROUPBOX'''
| <center>348</center>

|-
| '''QUERYBOX '''
| <center>308</center>
| '''SCROLLBAR'''
| <center>349</center>

|-
| '''WINDOW '''
| <center>309</center>
| '''SCROLLBARBOX'''
| <center>350</center>

|-
| '''SYSWINDOW '''
| <center>310</center>
| '''SPLITTER'''
| <center>351</center>

|-
| '''WORKWINDOW '''
| <center>311</center>
| '''SPLITWINDOW'''
| <center>352</center>

|-
| '''FLOATINGWINDOW '''
| <center>313</center>
| '''SPINFIELD'''
| <center>353</center>

|-
| '''DIALOG '''
| <center>314</center>
| '''PATTERNFIELD'''
| <center>354</center>

|-
| '''MODELESSDIALOG '''
| <center>315</center>
| '''NUMERICFIELD'''
| <center>355</center>

|-
| '''MODALDIALOG '''
| <center>316</center>
| '''METRICFIELD'''
| <center>356</center>

|-
| '''SYSTEMDIALOG '''
| <center>317</center>
| '''CURRENCYFIELD'''
| <center>357</center>

|-
| '''PATHDIALOG '''
| <center>318</center>
| '''DATEFIELD'''
| <center>358</center>

|-
| '''FILEDIALOG'''
| <center>319</center>
| '''TIMEFIELD'''
| <center>359</center>

|-
| '''PRINTERSETUPDIALOG'''
| <center>320</center>
| '''PATTERNBOX'''
| <center>360</center>

|-
| '''PRINTDIALOG'''
| <center>321</center>
| '''NUMERICBOX'''
| <center>361</center>

|-
| '''COLORDIALOG '''
| <center>322</center>
| '''METRICBOX'''
| <center>362</center>

|-
| '''FONTDIALOG '''
| <center>323</center>
| '''CURRENCYBOX'''
| <center>363</center>

|-
| '''CONTROL '''
| <center>324</center>
| '''DATEBOX'''
| <center>364</center>

|-
| '''BUTTON '''
| <center>325</center>
| '''TIMEBOX'''
| <center>365</center>

|-
| '''PUSHBUTTON'''
| <center>326</center>
| '''LONGCURRENCYFIELD'''
| <center>366</center>

|-
| '''OKBUTTON'''
| <center>327</center>
| '''LONGCURRENCYBOX'''
| <center>367</center>

|-
| '''CANCELBUTTON '''
| <center>328</center>
| '''TOOLBOX'''
| <center>369</center>

|-
| '''HELPBUTTON '''
| <center>329</center>
| '''DOCKINGWINDOW'''
| <center>370</center>

|-
| '''IMAGEBUTTON'''
| <center>330</center>
| '''STATUSBAR'''
| <center>371</center>

|-
| '''MENUBUTTON'''
| <center>331</center>
| '''TABPAGE'''
| <center>372</center>

|-
| '''MOREBUTTON'''
| <center>332</center>
| '''TABCONTROL'''
| <center>373</center>

|-
| '''SPINBUTTON'''
| <center>333</center>
| '''TABDIALOG'''
| <center>374</center>

|-
| '''RADIOBUTTON'''
| <center>334</center>
| '''BORDERWINDOW'''
| <center>375</center>

|-
| '''IMAGERADIOBUTTON'''
| <center>335</center>
| '''BUTTONDIALOG'''
| <center>376</center>

|-
| '''CHECKBOX'''
| <center>336</center>
| '''SYSTEMCHILDWINDOW'''
| <center>377</center>

|-
| '''TRISTATEBOX'''
| <center>337</center>
| '''FIXEDBORDER'''
| <center>378</center>

|-
| '''EDIT'''
| <center>338</center>
| '''SLIDER'''
| <center>379</center>

|-
| '''MULTILINEEDIT'''
| <center>339</center>
| '''MENUBARWINDOW'''
| <center>380</center>

|-
| '''COMBOBOX'''
| <center>340</center>
| '''TREELISTBOX'''
| <center>381</center>

|-
| '''LISTBOX'''
| <center>341</center>
| '''HELPTEXTWINDOW'''
| <center>382</center>

|-
| '''MULTILISTBOX'''
| <center>342</center>
| '''INTROWINDOW'''
| <center>383</center>

|}
''Taken from build environment file: 'res_type'''

{{PDL1}}
[[Category:TestAutomation]]