JAWS Built-in Functions

function abs

Description Returns the absolute value of the supplied signed integer.

Example: abs (-35) would return 35, abs (100) would return 100, and abs (0xFFFF) would return 65535.

Returns int the absolute value of the supplied signed integer.

Param int the signed integer.

Category system

function ActivateMenuBar

Description Activates or deactivates the Menu bar for the active program. Same as pressing and releasing the ALT key.

Category Menus

function ActivateOnMouseOver

Synopsis Activates OnMouseOver action at active cursor

Description This function Activates the OnMouseOver action at the active cursor. It is used primarily for the virtual cursor. This function was introduced in JAWS 8.0 update.

Returns int TRUE if successful, FALSE otherwise.

Category Mouse

function ActivateStartMenu

Description Brings up the Start menu in Windows 95/98 or NT. Same as pressing CTRL + ESC.

Category Menus

function AddCustomNodes

Synopsis This is the companion function to OptionsTreeCore, which sets up the optional node structures.

Description This companion function to OptionsTreeCore lives in Default and operates on the string sent to the OptionsTreeCore function, adding node paths where paths did not exist. See the description for OptionsTreeCore for complete examples.

Param string/byRef/sCustomItems The string upon which to operate, adding the node paths where they don't exist.

Param string/strNewNode The node name to explicitly use for all strings not containing node paths. Leave this blank for JAWS to fill in the node name based upon the configuration set which is active at runtime.

Category User Options

function AddHook

Description Installs a hook function. When a hook of type script is in place, it is called right before every script is run, and passed the name of the script which activated the hook, and the frame name if the script is attached to a frame as its two parameters. If the hook function of type script returns TRUE, the script is allowed to execute; if it returns FALSE, the script received by the hook function will not be allowed to run. See the KeyboardHelp script and the KeyboardHelpHook function in DEFAULT.JSS for an example of a script type hook function in action. When a hook of type event trace is in place, it is called before every script event is run. An event trace hook receives as parameters The path and name of the JSB file that will run the event, the name of the event that will run, and any parameters received by this event. The event trace hook is for diagnostic purposes, it does not prevent script events from running.

Param Int The type of hook to be installed. Use HK_SCRIPT for a script type hook, or HK_EVENT_TRACE for an event trace hook. Hook types are defined in HJConst.JSH.

Param string The name of a function to be installed as a hook.

Category Scripts

function AddMarkupForLanguage

Description Marks up a string of text with the specified language code.

Returns string The text marked up with the language code.

Param string The language code to be added as mark up to the text.

Param string The text to be marked up with the language code.

Category Speech Markup

function AddTestSuite

Description Add a suite of tests to the TestRunner.

Param Handle/hRunner The handle of the test runner to be released. This is a handle that was generated in a call to GetTestRunner.

Param String/strTests The name of the test suite to be added.

Category Test

function AllowedToUseSkypeAPI

Synopsis Checks to see if this version of JAWS is allowed to use the Skype API

Description When a program like JAWS first tries to use the Skype API, Skype asks the user to allow or deny that program access. Once access is allowed it remains in place until a new build of the program is put in place, at which time the access check is repeated.

Returns int 0=Access is allowed,1= access is waiting for user approval, 2=Client has explicitly denied access, 3=API unavailable most likely because no user is logged in to Skype, 0x8001=Skype not running

Category System

function AllowFormsModeTransition

Description Used to allow or disallow forms mode transition.

Param int True if JAWS should allow forms mode transition, false otherwise. Assumed to be true by default.

Category HTML

function AlphaNumCombinations

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function AltLeftMouseClick

Description Simulates holding down the ALT key and clicking the left mouse button.

Category Mouse

function AppCommand

Description performs an Windows app-command action.

Param int An app command which is a numeric value corresponding to definition in winuser.h.

Category system

function AppendToClipboard

Synopsis Adds a string of text to the end or the beginning of the Windows Clipboard.

Description The previous clipboard contents are retained and the new text added to the front or end. Appended items are separated by blank line space. Only plain text can be appended to the Clipboard.

Returns Int TRUE if the item was appended. FALSE if there was nothing to append to or if the clipboard update failed.

Param String The string to append.

Param Int TRUE if adding string to the End. FALSE if adding to the front.

Category Clipboard

function AreJAWSFramesActive

Synopsis Returns TRUE if any frames are currently defined and valid

Description This function determines if any frames are currently valid. For example, if three frames are defined for the current application but only one is valid at the moment, this function will return TRUE. If none are valid or none are defined, the function will return FALSE.

Returns int TRUE or FALSE

Category frames

function ArrayLength

Synopsis Obtains the length of one dimension of an array

Returns int the length of a dimension of the array

Param variant/ArrayName the array for which the length is desired

Category Aggregate Data Types

function AttributeEnumerate

Synopsis Finds each field in a window with the specified attribute and calls a callback function with the field's rectangular coordinates.

Description This function provides a quick method of enumerating all fields in a window with a specified attribute. For each field found, the coordinates of the bounding rectangle are passed to the callback function. If the callback function returns false then the enumeration stops. the callback function must take the following parameters: int topLeftX, int topLeftY, int bottomRightX, int bottomRightY. It must return true to continue the enumeration or false to abort the enumeration.

Returns Int the number of fields found in the window.

Param Handle/hWnd the window to enumerate.

Param Int/iAttributes the attributes of the text to find.

Param String/sCallback the callback function name.

Category Text Format

function Beep

Description This is used to make the PC beep. It can be included within an If...Then...Else...statement so that when a certain condition is present, the PC will beep.

Category Sounds

function BottomOfColumn

Description When inside a table or spreadsheet, moves the active cursor to the bottom of the current column.

Returns Int TRUE if the cursor moved, FALSE otherwise.

Category Tables

function BrailleAddBrlCursorLine

Description This function is used To add the contents of the line at the Braille cursor to the display in Structured mode. It is different to BrailleAddFocusLine because it uses the line at the Braille cursor rather than the PC cursor. It is primarily required in virtual documents when Brailling table data.

Returns Int True if successful, false otherwise.

Category Braille Output

function BrailleAddColorField

Description Adds the current color field's line segment range to the Braille display's structured data including cursor tracking within the field. Note that this adds the current line segment falling within the color field, not the entire color field in the event that the color field spans multiple lines.

Optional

Param int/nSearchLeftMax The maximum distance to look left. The default distance is 0 pixels.

Param Int/iBackgroundColor background color of text to include.

Category Braille Output

function BrailleAddString

Description Used with in BrailleBuildLine to add text to the Braille display.

Returns Int TRUE if successful, FALSE otherwise.

Param String/Buffer Text to be added.

Param Int/XPosition The X position for the mouse to click if a routing button is pressed over any of the cells in this string. This value is used along with Y position to determine where to click. Make both values 0 if no click should happen.

Param Int/YPosition the Y position for the mouse to click if a routing button is pressed over any of the cells in this string. This value is used along with X position to determine where to click. Make both values 0 if no click should happen.

Param Int/Attributes Combination of the ATRIB_xxx values from HJCONST.JSH that indicate the attributes of the characters in this string.

Optional

Param int/bNoTranslation output this string directly without translation even if Grade II or UEB is turned on. (Available as of JAWS 10.0.)

Param int/noSegmentDelimiter JAWS 19 and later: Set to true if you do not want the space between segments. If false or not supplied, a segment delimiter space is added.

Category Braille Output

function BrailleAddStringWithCallback

Description Like BrailleAddString, but rather than supplying a click point, supply a function to be executed if a routing button is clicked within this segment. The function may have parameters, e.g. BrailleAddStringWithCallback("hello", "sayString ('hello') ", attrib_highlight)

Returns Int TRUE if successful, FALSE otherwise.

Param string/text the string to Braille.

Param string/funcNameAndParams a function and its parameters.

Optional

Param int attributes such as attrib_highlight, etc.

Param int noTranslation set to true to force no translation for text in the focused item. If false or not supplied, text is translated if appropriate.

Param int noSegmentDelimiter set to true if you do not want the space between segments. If false or not supplied, a segment delimiter space is added.

Category Braille Output

function BrailleAddTextBetween

Synopsis Like BrailleAddFocusItem but allows specification of starting and ending x-coordinate on current line.

Description This function adds the text between the specified coordinates to the Braille display. It is used in situations where you do not wish to show the entire line but do wish to show the cursor context as you edit in this area of the line. It is used for example in MSWord 2000 and above in table cells.

Returns Void

Param Int/x1 the starting coordinate on the line.

Param Int/x2 the ending coordinate on the line.

Category Braille Output

function BrailleAutoAdvanceMode

Synopsis Starts or stops Braille Auto Advance Mode.

Description When Auto Advance Mode is enabled, JAWS will automatically pan through documents at the specified speed. Panning stops either at the bottom of the document, focus changes, a routing button is pressed or this function is called again with the iMode parameter set to FALSE. If a Flash Message is displayed, Auto Advance is paused until the Flash message is manually or automatically cleared. The user may still pan left or right while the mode is active. the timer will be restarted so that the user may reread the new information.

Returns int TRUE if the feature was successfully enabled or disabled.

Param int/iMode Set to TRUE to turn the mode on, FALSE to turn it off.

Optional

Param int/nInterval optional duration between pans, if not supplied, defaults to the value of OPT_BRL_AUTOADVANCE_INTERVAL.

Category Braille Navigation

function BrailleAutoAdvanceModeActive

Synopsis Enables the user to query if the Braille auto Advance mode is active.

Description When Auto Advance Mode is enabled, JAWS will automatically pan through documents at the specified speed. Panning stops either at the bottom of the document, focus changes, a Flash Message is displayed or the feature is explicitly disabled. The user may still pan left or right while the mode is active. the timer will be restarted so that the user may reread the new information.

Returns int TRUE if the feature is active, FALSE otherwise.

Category Braille Navigation

function BrailleBuildStatus

Description Builds the line of Braille to be displayed in the status cells.

Returns Void

Category Braille Output

function BrailleClearMessage

Synopsis Clears the current Flash message.

Description This function clears the current Flash message.

Optional

Param int/iIgnoreIfInfinite if TRUE and the message time is set to infinite, the message will not be cleared, it defaults to FALSE.

Category Braille Output

function BrailleCount

Description Retrieves the number of Braille displays configured in JAWS

Returns Int the number of Braille displays configured in JAWS

Description Retrieves the DOT pattern used to show the active cursor on the Braille display.

Returns String The DOT numbers used to show the active cursor. For example, "78."

Category Braille Output

function BrailleGetDataOffsetFromDisplayOffset

Synopsis Gets the offset into the original data from a display offset.

Description This function gets the offset into the original data (string) from a display offset (the offset as seen on the braille display). This is useful for getting the original position of a character, which is now at a different offset due to braille translation.

Returns int DataOffset the actual offset into the original data (string) sent to the display.

Param int DisplayOffset the offset as seen on the braille display

Category Braille Output

function BrailleGetDeviceInfo

Synopsis Gets the Braille Display's driver name, Model Name and Port string.

Description This function gets the Braille Display's driver library name, its model name and its port string.

Returns Int true if a Braille Display is found, False otherwise.

Param String/ByRef/sDriver Driver name.

Param String/ByRef/sName Display Name.

Param String/ByRef/sPort Port String.

Category Braille Device

function BrailleGetFramePrompt

Synopsis Returns the Braille prompt associated with the frame specified.

Description This function retrieves the Braille prompt of the specified frame. If no frame is specified then the frame at the active cursor location is asumed. Note that a frame's prompt is any string or strings defined as part of any EVENT_Focus/ACTION_BrailleString pairs.

Returns String the Braille prompt.

Optional

Param String/sName the name of the frame whose prompt you want.

Category Frames

function BrailleGetProfileState

Synopsis Gets the current profile's state

Description this function returns The current profile's state.

Returns int One of brlComputerInContractedOut, brlComputerInContractedOut or brlContractedInContractedOut.

Category Braille Settings

function BrailleGetStateString

Synopsis Returns a string defining the state for the specified state flags.

Description This function returns the state string as defined in the app or default jbs for the specified state flags. This may be a combination of strings. The state flags maybe any combinations of the CTRL_XX attributes defined in hjconst.jsh, eg CTRL_CHECKED etc.

Returns String the state string.

Param Int/nState the state flags.

Synopsis Returns the number of Braille Translator modes - this is an optional function for braille translator dlls.

Description Queries the active braille translator to see if it supports mode setting, and if so returns the number of modes.

Returns Int number of modes if braille translator supports modes, 0 otherwise.

Category Braille Settings

function BrailleGetTranslatorModeID

Description Returns the internal ID of the translator mode supplied by index.

Returns int The internal ID of the mode by index.

Param int/Index the index of the Braille rules whose ID to return.

Category Braille Settings

function BrailleGetTranslatorModeName

Synopsis Returns the name of a particular braille translator mode - this is an optional function for braille translator dlls.

Description Queries the active braille translator to see if it supports operating more than one mode. If it does then the function retrieves the name of the mode whose index matches the parameter provided.

function BrailleLongName

Description Retrieves the descriptive name of the Braille display at the specified index

Returns String The descriptive name of the requested Braille display, or " ," if there is not a Braille display at that index.

Param int/nIndex the index of the Braille display whose name is to be retrieved

Category Settings

function BrailleMessage

Synopsis Sends a Flash message to the display.

Description This function sends a Flash message to the display which is held on the display for the specified length of time. You may append messages together by using the second optional parameter. If you do not specify the duration of the message or the append flag, the duration will default to the value of the OPT_BRL_MESSAGE_TIME JCF option and the message will replace any existing message.

Returns void

Param string sMessage the message to send.

Optional

Param int/iAppend if non-zero, the message will be appended to the existing message, if 0, the message will replace the current message.

Param int/tiMS the time in milliseconds to keep the message on the display before restoring the display to the prior content.

Category Braille Output

function BrailleMessageRepeatLast

Synopsis Reshows the last Flash message on the Braille display.

Description This function reshows the last Flash message that was sent to the Braille display. It is shown for the same duration as it was originally shown for and with the same prefix. This works even if Flash Messages have been disabled.

Returns int True if the last message was repeated, False if no messages have yet been shown.

Category Braille Output

function BrailleName

Description Retrieves the name of the Braille display at the specified index

Returns String The name of the requested Braille display, or " ," if there is not a Braille display at that index.

Param int/nIndex the index of the Braille display whose name is to be retrieved

Category Settings

function BrailleNextLine

Description Moves the Braille cursor one line down and shows the new line.

Returns Int "WAS_SUCCESSFUL" = 1,"WAS_NOT_SUCCESSFUL" = 0.

Category Braille Navigation

function BraillePanLeft

Description Displays the prior group of Braille characters from the line with the active cursor. The characters that are displayed when this function is used are those that precede the first character on the current display of Braille characters. For example, the display moves or pans to the left to reveal additional text.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Optional

Param Int true to move to the last segment of the prior line if no more text to the left, default value is false.

Category Braille Navigation

function BraillePanRight

Description Displays the next group of Braille characters from the line with the active cursor. The characters that are displayed when this function is used are those that follow the last character on the current display of Braille characters. For example, the display moves or pans to the right to reveal additional text.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Optional

Param Int true to move to the first segment of the next line if no more text to the right, default value is false.

Category Braille Navigation

function BraillePort

Description Retrieves the port name of the Braille display at the specified index

Returns String The port name of the requested Braille display, or " ," if there is not a Braille display at that index.

Param int/nIndex the index of the Braille display whose port name is to be retrieved

Category Settings

function BraillePortString

Description Retrieves the port string of the Braille display at the specified index

Returns String The port string of the requested Braille display, or " ," if there is not a Braille display at that index.

Param int/nIndex the index of the Braille display whose port string is to be retrieved

Category Settings

function BraillePriorLine

Description Moves the Braille cursor one line up and shows the new line.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Category Braille Navigation

function BrailleRefresh

Description Used to refresh the Braille display and redisplay the appropriate text.

Returns Void

Optional

Param int/whichRange If the entire line will not fit on the Braille display, then this indicates which portion to show. Should be one of the brlShowXXX constants in hjconst.jsh.

Category Braille Output

function BrailleRoutingButton

Description Attempts to move the PC cursor to the location designated by the braille cell.

Param int The 1-based number of a braille cell.

Optional

Param int/routingType 0 route and click, 1 rout only. See constants in hjconst.jsh.

Category Braille Navigation

function BrailleSetColorsToMark

Synopsis Allows user to specify the foreground and background colors of up to 9 color pairs which should be marked in Braille with DOTS 7 and 8.

Description This function allows the user to specify the foreground and background colors of up to 9 color pairs which should be marked in Braille with DOTS 7 and 8. This function also toggles the Braille Mark Colors to on. Supply an empty string to turn off color marking or set the JCF option to exclude marking colors.

Returns Void

Param String up to 9 pairs of text and background colors of the form rgb/rgb,rgb/rgb,... Supply empty string to turn off color marking.

Category Colors

function BrailleSetCurrentProfile

Synopsis Loads a Braille profile.

Description Loads a language specific Braille profile.

Returns int true or false.

Param string three letter language abbreviation or lang ID of the form 0x409.

Optional

Param int destination -1 (default) to not save to JCF, or one of wdUser, wdSession or wdFocus.

Category Braille Settings

function BrailleSetCursorDots

Description Sets the DOT pattern used to represent the active cursor on the Braille display.

Param String/DotPattern The DOT numbers used to show the active cursor. For example, "78."

Category Braille Output

function BrailleSetProfileState

Synopsis Sets the current profile's state

Description The profile's state can be set to one of brlComputerInContractedOut, brlComputerInContractedOut or brlContractedInContractedOut.

Returns int true or false.

Param int state one of the following constants from hjconst.jsh: brlComputerInContractedOut, brlComputerInContractedOut or brlContractedInContractedOut

Optional

Param int destination -1 (default) do not save, or one of wdUser, wdSession or wdFocus.

Category Braille Settings

function BrailleSetStatusCells

Description Puts characters on the status cells of the Braille Display. This function should only be called from within a BrailleBuildStatus function.

Param String/StatusText Characters to be placed in the Braille status cells.

Category Braille Output

function BrailleSetTranslatorMode

Synopsis Sets the braille translator mode - this is an optional function for braille translator dlls.

Description Queries the active braille translator to see if it supports mode setting. If it does then the function sets the mode using the parameter provided.

Returns Int TRUE if switching to the desired braille translator mode was successful, FALSE otherwise.

Param Int The index of the desired mode - the index starts at 0.

Category Braille Settings

function BrailleSetTypeKeysMode

Synopsis Sets the TypeKeys mode to the value specified by bEnable.

Description When TypeKeys mode is enabled, characters typed using the display are inserted into the application with focus.

Returns int TRUE if the value is properly set, FALSE otherwise.

Param int/bEnable Set to TRUE to enable TypeKeys mode, FALSE otherwise.

Category Braille Keyboard

function BrailleString

Description Sends the specified string to the Braille display regardless of whether or not the line is visible.

Param String/strBuffer String to be sent to the Braille display.

Category Braille Output

function BrailleSupportsTypeKeysMode

Description Determines whether or not TypeKeys mode is supported by at least one of the loaded Braille drivers.

Returns int TRUE if the mode is supported, FALSE otherwise.

Category Braille Keyboard

function BrailleSwitchTransLanguage

Description Switches to a Braille Translation engine appropriate for the specified language.

Returns Int true on success, false otherwise.

Param String language abbreviation, eg enu, deu, etc.

Category Braille Output

function BrailleVerbosity

Synopsis Adjusts the Braille verbosity.

Description When in structured mode varies the amount of descriptive information shown on the Braille display.

Returns String description of value to be displayed as value of Braille Verbosity.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category Braille Settings

function CallFunctionByName

Description Allows dynamically calling a function whose name is passed as the first argument. This means that the function name does not need to be known at compile time and can be passed in a variable. Note that using CallFunctionByName bypasses all checking of argument types that happens when a function is invoked normally.

Returns variant whatever the function being called returns

Param String/FunctionName the name of the function to be run

Optional

Param Variant the function's 1st argument

Param Variant the function's second argument

Param Variant the function's third argument

Param Variant the function's 4th argument

Param Variant the function's 5th argument

Param Variant the function's sixth argument

Param Variant the function's seventh argument

Param Variant the function's eighth argument

Param Variant the function's 9th argument

Category Scripts

function CancelLayeredKeySequence

Description Cancels any currently active key layer for both braille and QWERTY keyboards.

Category Keyboard

function CancelOCR

Synopsis If optical character recognition is in progress, cancels the operation.

Description If optical character recognition is in progress (initiated by OCRScreenArea), cancels the operation.

Returns void

Param int a job ID returned from OCRScreenArea identifying the OCR job to cancel.

Category Optical Character Recognition

function CanRecognize

Synopsis Determines if the OCR components are installed.

Description Determine whether the OCR components are installed.

Returns int 1 if OCR components are installed, 0 if OCR components are not installed or configured, and 2 if Convenient OCR Feature is Not supported.

Category Optical Character Recognition

function CapsIndicate

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function CapsIndicateDuringSayAll

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function CaptureAllGestures

Description If enabled, all gestures will be captured by JAWS, so that none will pass through to Windows. If disabled (default), then only gestures bound to scripts will be captured.

Returns void

Param int 1 for enable, 0 for disable

Category Scripts

function CaretVisible

Description Indicates whether an insertion point or a caret is visible in the active window. The function returns a constant value of TRUE to indicate that a caret is visible and a value of FALSE to indicate that it is not visible.

Returns Int "TRUE" = 1, "FALSE" = 0.

Category Cursors

function CenterMouseInView

Synopsis Centers the mouse in the active view.

Description The mouse is centered both horizontally and vertically. If MAGic is running and the screen is magnified, then the mouse is centered in the active view. Otherwise, the mouse is placed in the center of the display.

Category MAGic

function ChangeSystemVolume

Description Changes the system volume.

Param int The direction of volume change, use V_UP or V_DOWN defined in HJConst.jsh.

Param int The amount to change the volume. Volume ranges from 0 to 100.

Category system

function CheckAuthScheme

Description A call to this function determines if JAWS is authorized to run. For the dongle, a check is done to ensure the dongel is installed and that it is the correct one for the product .

Returns Int 0 if dongle is in place and authorized correctly, error code otherwise.

Category FS Product Info

function ClearSavedLocation

Synopsis Clears the prior saved location

Description This function clears the location saved by a prior call to SaveCurrentLocation.

Returns void

Category Cursors

function ClearScriptPerformanceHistory

Description Clears the Script Performance History.

Returns Void

Category Misc

function ClearSpeechHistory

Description Clears the Speech History buffer.

Returns void

Category Speech History

function ClickObjectByName

Description Does a LeftMouse click at the upper lefthand corner of the named object. This function relies on MSAA and is ideal for clicking an object that does not have its own window but for which you know the name.

Returns int TRUE if the object was found and could be clicked, false otherwise.

Param HANDLE/hwnd The window containing the object of interest

Param string/ObjectName The name of the object desired

Optional

Param int/nWhichOccurance If there is more than one object with this name, which one is desired. This parameter defaults to 1.

Category Object Model And MSAA

function ClipboardHasData

Description This function will return true if there is any data at all on the Windows clipboard.

Returns Int True if the clipboard contains data, false otherwise.

Category Clipboard

function CloseOleObject

Description Takes the pass-in IDispatch object, does a QueryInterface on it for IOleObject and if the QueryInterface succeeds, calls IOleObject::Close. This is very rarely used, and if none of the above makes sense assume you don't need to use it.

Returns int TRUE on success, FALSE on failure.

Param object/pObject the object that supports the IOleObject interface.

Category Object Model and MSAA

function CollectionCompare

Synopsis Compares the contents of two collections

Returns int True if the two collections have identical contents, False otherwise

Param collection/Collection1 the first of the collections to compare

Param collection/Collection2 the second of the collections to compare

Category Aggregate Data Types

function CollectionCopy

Synopsis Makes a deep copy of a collection

Description Normally when you assign a variable containing a collection to another variable, both variables then point at the same collection. This function allows making a copy of a collection so that each variable points at a unique copy of the collection. This means that if the elements of one collection are changed, these changes will not be reflected in the contents of the other collection.

Returns Collection a new collection with contents identical to that which was copied

Param collection/CollectionToCopy a variable containing the collection to be coppied

Category Aggregate Data Types

function CollectionItemCount

Synopsis Obtains the number of items contained in a collection

Returns int The number of items in the collection.

Param collection/CollectionName the Collection for which an item count is desired

Category Aggregate Data Types

function CollectionItemExists

Synopsis Determines if a specific item is contained in a collection

Returns int True if ItemName is in the collection, False otherwise.

Param collection/CollectionName the Collection to be searched

Param String/ItemName the name of the item to be looked up

Category Aggregate Data Types

function CollectionRemoveAll

Synopsis Removes all items from a Collection

Returns Void

Param collection/CollectionName the Collection from which all items should be removed

Category Aggregate Data Types

function CollectionRemoveItem

Synopsis Removes an item from a collection

Returns int True if ItemName was in the collection and was removed, False otherwise.

Param collection/CollectionName the Collection from which an item is to be removed

Param String/ItemName the name of the item to be removed

Category Aggregate Data Types

function CollectWindowInfo

Synopsis Collects the technical information about a window.

Description collects the technical information about a window.

Returns string The information retrieved for the window.

Param handle The window for which the information will be collected.

Category Utility

function ColorToRGBString

Description Converts a color value to a string of the form "255255255" where the first three digits represent the proportion of red, the second three digits the proportion of green, and the third three digits the proportion of blue.

Returns String The color value converted to an RGB string.

Param Int The color value to be used.

Category Colors

function ComAttachEvents

Synopsis Attaches script functions to events fired by a specific COM object.

Description For each event that the COM object fires, a script function will be called. If an event named OnBeforeClose is fired and sPrefix is word_ then the function word_OnBeforeClose will be called. This function should be defined with the parameters that the object passes to the event. Failure to add the parameters to the function definition will not cause any problems other than the inability of the function to access the information. No errors will be generated if only certain events have functions defined to handle them. The events will automatically be disconnected when the object to which they are connected goes out of scope or the variable containing the object is set to something else. This means that you should only attach events to objects referenced by global variables.

Returns int TRUE if events have been attached, FALSE otherwise.

Param Object The object for which events are desired

Param string/sPrefix The prefix to be added to the name of the event when constructing the name of the function to be called

Optional

Param string/IIDEventInterface The IID of the outgoing interface to which events are dispatched. This and all subsequent parameters should only be provided if the object does not support IProvideClassInfo2.

Param string/GuidTypeLib The GUID of the typelib in which the interface is described

Param int/TypeLibMajorVersion The major version of the typelib

Param int/TypeLibMinorVersion The minor version of the typelib

Category Object Model and MSAA

function ComDetachEvents

Synopsis Detaches script functions from a COM object.

Description This function only needs to be used if you want to hold on to an object but want the events from that object to stop being fired. If you let go of an object by setting the variable containing it to something else, the events will automatically be detached.

Returns int TRUE if events have been detached, FALSE otherwise.

Param Object The object for which events are no longer desired

Category Object Model and MSAA

function ComGetAvailableNames

Description A method for a script developer to interrogate an object and get back all its methods and properties. Returns the name of each method or property.

Returns string A list of available methods and properties for the supplied object. Items are separated by newlines.

Param object/ComObject The object to be interrogated. The results you get back will depend upon the object and how much of it is outward-facing.

Category Object Model and MSAA

function ComRelease

Synopsis Releases a COM object

Description When called with a single argument, this is equivalent to releasing the object without blocking, even if that means to intercept another process. When the optional second argument is TRUE, the object will be released in a way that there is no chance of the Release call blocking, even if the Release involves calling into another process that isn't responsive. When set to FALSE, the second parameter means set the object to null, releasing the pointer in JAWS. In other words, if the argument references an IDispatch object, that object will be released. The second parameter is set to TRUE by default. This added functionality is less resource efficient and should only be used in those situations where the call is likely to block.

Returns int TRUE if the object has been release, FALSE otherwise.

Param Object/obj The object to release

Optional

Param int/KeepFromBlocking TRUE to take steps to ensure that the call doesn't block, false simply to null the object. If this parameter is not specified, the default is TRUE.

Category Object Model and MSAA

function ContractedBrailleInputAllowedNow

Description Overwrite this function in your script file when you need to turn off Contracted Braille input in a scenario where it would otherwise be enabled. An example would be in Microsoft Word, where Quick Navigation Keys are enabled, CanEditNow should return false so the keyboard is used for navigation rather than editing This is called for the item with focus., and is not called for a window which does not support contracted input to begin with..

Returns int TRUE or False, script method for enabling or disabling contracted Braille input.

Category Braille Keyboard

function ControlCanBeChecked

Description Determines whether or not the current control can be checked.

Returns Int 0 if cannot be checked or 1 can be checked.

Category Dialog Controls

function ControlEnterKey

Synopsis The ControlENTER key is passed to the application.

Description Passes the ControlEnter key through to the application. If the virtual cursor is active and on an element with an OnMouseOver handler then the OnMouseOver handler is activated for that element.

Returns Void

Category Keyboard

function ControlIsChecked

Description Determines whether or not the current control is checked.

Returns Int Returns true or false.

Category Dialog Controls

function ControlLeftMouseClick

Description Sends a Control Left Mouse click to the system, useful for selecting non-contiguous items in a list.

Category Mouse

function ControlShiftEnterKey

Synopsis The Control Shift ENTER key is passed to the application.

Description Passes the Control Shift Enter key through to the application. If the virtual cursor is active and on an element then the focus is set on that element and Control + Shift + Enter key is passed to the application.

Returns Void

Category Keyboard

function ConvertListToNodeList

Synopsis Prepends alist of options with the same node path.

Description When you need to add a whole group of options in the same branch of the tree view, use this function to give each option the same node path. Pass the group in the standard list format using the vertical bar ( ) symbol as the primary array delimitor, and the colon (:) symbol as the divider between the callback function and the display text.

Param string/ByRef/strList The list of list item segments, delivered in the dlgSelect*ToRun format

Param string/sNode The node path explicit to the list you specified in the first parameter.

Category User Options

function ConvertLookupModuleDataToList

Description This list can be used to present to the user via dlgSelectItemInList.

Returns string a UI-capable list, presenting Rule set first, then Lookup Module name. This is the Pretty name assigned to the active rule set.

Param int/nSize The number of items to expect in the subsequent module and rule set lists.

Param string/strModules The list of lookup modules - delimited by LIST_ITEM_SEPARATOR or the bell char ( \007)

Param string/strRuleSets The list of rule sets - delimited by LIST_ITEM_SEPARATOR or the bell char (\007)

Category Research It

function CopyToClipboard

Description Puts a string of text onto the Windows clipboard erasing any previous clipboard contents. In order to copy multiple lines of text, these must be concatenated together into a single string before calling CopyToClipboard. In the concatenated string, lines should be separated with \r \n.

Param String/ClipboardData Text to be copied to the Windows clipboard.

Category Clipboard

function CreateObject

Description In applications such as Internet Explorer or those found in Microsoft Office, launches an application under the control of JAWS, which is the automation object. The difference between CreateObject and GetObject is that GetObject creates a pointer to an automation object that already exists, whereas CreateObject creates the automation object for the application.

Returns Object The automation object associated with the program.

Param String/ApplicationName Name of the COM class that can return an automation object.

Optional

Param string/manifestFile name of the manifest file that contains the Registration Free COM information or the name of a .dll with a manifest embedded as a resource. Providing this parameter allows creation of an object that hasn't been registered. More information can be found at http://msdn.microsoft.com by searching for "Registration Free COM"

Category Object Model And MSAA

function CreateObjectEx

Returns Object The automation object associated with the program.

Param String/ApplicationName Name of the COM class that can return an automation object.

Param Int TRUE = Same behavior as CreateObject. FALSE = Will always force the use of CoCreateInstance instead of using GetObjectHelper when JAWS is running as a service.

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function DebugLookupModuleQueryUsingListOfModules

Description Debug output for rule set. Error codes / text are placed in the Virtual Viewer for developers of rule sets and/or modules. This function only displays what's thrown up by Invoke calls. No parameters, as it runs as a stand-alone providing both a list of available rule sets and a prompt to enter the search term. To make your rule set discoverable first, put at least a dummy version of the files into the RuleSets folder of your subdirectory. Then go to Settings Center Research It and make sure yours is checked, so it's available for listing. When asked for the search term, press ESC to send a blank string, or type the term and press ENTER. Note that in JAWS 12 or later, Settings Center replaces Configuration Manager.

Category Research It

function DecToHex

Synopsis converts a decimal integer to a hex string.

Description This function converts a decimal integer to a hex string.

Returns string The hex value

Param int/iDec decimal value

Category Number conversion

function Delay

Description Makes a script stand still for a specified period of time. It causes a script to stop, wait a period of time, and then resume again. It is different than the Pause function which yields to the processing needs of applications.

Param Int Type a number to indicate the amount of time that the script should be delayed. The number 1 equals one-tenth of a second. The number 10. equals one second. Do not use numbers with decimals, and do not use quotation marks.

Optional

Param Int/nNoEvents TRUE to suppress checking for and processing FocusChangedEvent and NewTextEvent functions before returning from the delay.

Category Scripts

function DeleteFile

Synopsis Deletes a specified file.

Returns int True if the file was successfully deleted, False otherwise

Param string/Filename the name of the file to delete

Category Files

function DescribeAreaEx

Description Describes a screen area.

Returns int 0 on success, any value greater than 0 on error.

Param int/left Screen area left coordinate

Param int/top Screen area top coordinate

Param int/right Screen area right coordinate

Param int/bottom Screen area bottom coordinate

Param int/multiService 0 to use only the Microsoft image recognition service, 1 to use all image recognition services.

Category Picture Smart

function DescribeClipboardEx

Description Describes an image on the clipboard.

Returns int 0 on success, any value greater than 0 on error.

Param int/multiService 0 to use only the Microsoft image recognition service, 1 to use all image recognition services.

Category Picture Smart

function DescribeCursorEx

Description Describes an image at the cursor.

Returns int 0 on success, any value greater than 0 on error.

Param int/multiService 0 to use only the Microsoft image recognition service, 1 to use all image recognition services.

Category Picture Smart

function DescribeSelectedFileEx

Description Describes the currently selected image file.

Returns int 0 on success, any value greater than 0 on error.

Param handle/focusWindow Focus window.

Param int/primaryLang Primary recognition language.

Param int/secondaryLang Secondary recognition language.

Param int/multiService 0 to use only the Microsoft image recognition service, 1 to use all image recognition services.

Param int/globalOcrJobId Recognition identifier.

Category Picture Smart

function DesktopAttachEvent

Synopsis Called right after switching from the security desktop to the user-desktop

Description This is the place for scripts to reconnect any COM events that were previously disconnected in DesktopDetachEvent. This function is only called when JAWS is running as a service.

Category Object Model and MSAA Events

function DesktopDetachEvent

Synopsis Called right before switching from the user-desktop to the Security desktop

Description This is the place for scripts to disconnect any COM events. This function is only called when JAWS is running as a service.

Category Object Model and MSAA Events

function DialogActive

Description Used to determine whether a dialog box is currently active. It returns a constant value to indicate the status: ACTIVE indicates that a dialog box is active, and INACTIVE indicates that a dialog box is not active. These constants can be used in If...Then...Else...statements.

Returns Int "ACTIVE" = 1, "INACTIVE" = 0.

Optional

Param int/useTopWindowControlType Specifies whether the control type of the top level window should be taken into consideration. The default is true.

Category Dialogs

function DisplayShapeOverlapInfo

Synopsis Display overlap information for the selected shape in the virtual buffer.

Description If the selected object is of type WT_SHAPE information about any shapes that overlap the shape are put in the virtual buffer.

Returns int TRUE if information was placed in the virtual buffer else FALSE.

Category Misc

function DlgAriaLiveRegionFilterText

Description Displays the ARIA Live Region dialog.

Returns int 1 if the dialog was opened successfully, regardless of the action performed.

Category HTML

function DlgCustomizeColumns

Synopsis Displays Custom column headers options.

Description Displays a dialog that contains options for indicating how column headers are spoken or brailled. This function requires the caller to supply column header text delimited by a vertical bar character. This function also requires the caller to supply a key in the form of a string to store the custom information. The function also returns the current or modified speech and braille custom column information.

Returns Int FALSE if the DlgCustomizeColumns is already open, TRUE otherwise.

Param String/sColumnHeaders Contains a list of vertical bar character delimited column header text.

Param String/sKey A key to identify specific custom column information.

Optional

Param String/sDialogTitle A string used for the dialog title.

Param String/ByRef/sSpeechColumnRules The current or modified Speech Column information.

Param String/ByRef/sBrailleColumnRules The current or modified Braille Column information.

Category User Interaction

function DlgCustomizeListview

Synopsis Displays Listview column headers options.

Description Displays a dialog that contains options for indicating how Listview column headers are spoken or brailled.

Returns Void

Param Handle/hwnd The handle of the Listview of interest.

Category User Interaction

function DlgGetCustomSummaryInfo

Synopsis Displays dialog for labeling cells.

Description Displays a dialog that contains options for labeling cells and cell ranges in spreadsheets.

Returns Void

Param String/sSection The name of the worksheet.

Param String/sKey The name of the cell or cell range (Example, A1 or A1:B1).

Param String/sValue The description for the cell or cell range.

Param String/sFileName The file name of the JSI file.

Category User Interaction

function DlgListOfDropTargets

Description Displays a list of possible drop targets for a drag and drop operation on a web page.

Returns int 1 if the dialog was opened successfully, regardless of the action performed. 0 if there were no drop targets available.

Category HTML

function DlgListOfLandmarks

Description Displays a list of possible landmarks on a web page.

Returns int 1 if the dialog was opened successfully, regardless of the action performed. 0 if there were no landmarks.

Category HTML

function dlgListOfLinks

Returns int True if links exist, false otherwise.

Optional

Param int linkTypeFlags set of flags specifying which kinds of links to include in the list, see hjconst.jsh for values, use 0xff or leave empty to include all links.

Category HTML

function DlgListOfPlaceMarkers

Synopsis Displays a dialog containing a list of PlaceMarkers.

Description PlaceMarkers dialog provides Add,MoveTo,ChangeName,Remove and RemoveAll PlaceMarker capabilities.

Returns Int TRUE if successful, returns FALSE otherwise.

Param Int/nAdd 1 to pop up Add dialog,bypassing PlaceMarkers dialog, 0 to display PlaceMarkers dialog.

Category HTML

function DlgSelectAVoiceProfile

Description Displays a dialog that contains a set of Voice Profiles. The user can select a voice profile as their default profile or can select a profile to be application specific.

Category User Interaction

function DlgSelectControls

Description Displays a list box containing controls you may want to perform any one of the following actions: right single click, left single click, left double click, or Move To. You may change the dialog window title, display any combinations of the buttons, and specify a default.

Returns Int An integer value indicating what type of mouse action is required to activate the selected task tray icon, whether it be Left Mouse Button, Right Mouse Button, or double click of the left mouse button.

Param String/strGraphicList The list of controls.

Param Int/nIdx/ByRef The number of controls.

Param String/strWindowTitle The new window title.

Param Int/nMask The mask that indicates the buttons desired. See the available buttons in HjConst.jsh with the prefix bt_.

Param Int/nDefault The default button as specified by the mask value.

Optional

Param Int/nDefaultSelectedIndex the index of the item which should have the focus when the dialog is invoked. (JAWS 12.0 and above)

Category User Interaction

function dlgSelectFunctionToRun

Description Presents a list of functions to be run and displays their current value. Pressing the space bar or the Execute button will change the return value of the selected function, based on how the function was written. It is much like dlgSelectScriptToRun except that it does not merely speak, but the new return values are placed in the list box.

Param String strList This is the delimited list to be presented in the list box. It is in the same format as the dlgSelectScriptToRun function.

Param String/strDialogName Enter the string consisting of the Dialog's name.

Param Int/iSort Enter True if the items are to be sorted alphabetically, false otherwise.

Category User Interaction

function DlgSelectItemInList

Description Displays a dialog that contains a set of menu items. When the dialog is okayed, the one based index of the selected item is returned.

Returns Int This is 0 if the dialog was cancelled, otherwise the one based index of the selected item.

Param String/Items A " \007" delimited set of menu items.

Param String/DialogName A string containing the name you want to appear as the title for the Menu Select dialog.

Param Int/nSort If TRUE, then the contents of the list will be sorted.

Optional

Param Int/nDefaultSelectedIndex the index of the item which should have the focus when the dialog is invoked. (JAWS 5.0 and above)

Param string/sButtonList a list of up to 5 button names delimited with the vertical bar character "ButtonCaption1 ButtonCaption2l ...ButtonCaption5"

Param int/byRef/nButtonIndex The 1-based button index of the custom button invoked, 0 for cancel, -1 for OK.

Category User Interaction

function DlgSelectScriptToRun

Description Displays a dialog that contains a set of scripts. Scripts can be performed from this dialog.

Param String/Scripts A " \007" delimited set of script names. Aliases can also be included in this list. Example: ScriptDialog (VerbosityLevel:Verbosity \007ScreenEcho). This would create a listbox containing entries; Verbosity and ScreenEcho.

Param String/DialogName A string containing the name you want to appear as the title for the script dialog. If this parameter is "PerformScript" is used for the title.

Param Int/nSort If TRUE, then the contents of the list will be sorted.

Category User Interaction

function DlgSkimRead

Synopsis Displays Skim Reading options.

Description Displays a dialog that contains options for indicating how Skim Reading is performed.

Returns Void

Category Skim-Reading

function DlgSysTray

Description Displays a list box containing the icons on the System Tray

Param String/strGraphicList The list of Task tray icons.

Param Int/nIdx The number of Task tray icons.

Category User Interaction

function DocumentPresentationSet

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function DoesSelectedShapeOverlap

Description Checks if selected shape is overlapped by another shape

Returns int TRUE or FALSE

Category Misc

function DoesWindowBelongToFocusedThread

Description Determines if hwnd belongs to the same thread as the window with focus.

Returns Int TRUE if hwnd belongs to the same thread as the app with focus, FALSE otherwise

Param handle/hwnd Handle of window to check.

Category Window

function DoFlexibleWebDialog

Description Launches the dialog for flexible web.

Returns int 0 if the dialog failed to launch successfully, non-zero otherwise.

Category HTML Flexible Web

function DownCell

Description When inside a table or spreadsheet, moves the active cursor to the same cell in the next row.

Returns Int TRUE if the cursor moved, FALSE otherwise.

Category Tables

function DragItemWithMouse

Description The drag-and-drop function is used to move the contents of one area of the screen to another area of the screen.

Param Int/SourceX The X coordinate of the item that is to be moved.

Param Int/SourceY The Y coordinate of the item that is to be moved.

Param Int/TargetX The X coordinate of the target location for the item.

Param Int/TargetY The Y coordinate of the target location for the item.

Category Mouse

function EnableFlexibleWeb

Description Enables or disables flexible web.

Param int On or Off.

Category HTML Flexible Web

function EnablePerModeGestures

Description If enabled (default), mode specific gestures will be available. If disabled, only base gestures will be available.

Returns void

Param int 1 for enable, 0 for disable

Category Scripts

function EnableRemoteAccessClient

Description Enable or disable the Remote Access Client component. The Remote Access Client component is typically enabled during product installation. When the component is enabled, %product% is able to recieve speech and Braille through a Citrix or Remote Desktop client session.

Returns Int TRUE if the component is successfully set to the desired state, FALSE otherwise.

Param int Set parameter to TRUE to enable or FALSE to disable.

Category System

function EnableRemoteAccessServer

Description Enable or disable the Remote Access Server component. The Remote Access Server component is typically enabled during product installation. When the component is enabled, %product% is able to run in a Remote Desktop or Citrix session.

Returns Int TRUE if the component is successfully set to the desired state, FALSE otherwise.

Param int Set parameter to TRUE to enable or FALSE to disable.

Category System

function EndOfRow

Description When inside a table or spreadsheet, moves the active cursor to the end of the current row.

Returns Int TRUE if the cursor moved, FALSE otherwise.

Category Tables

function EnterKey

Synopsis The ENTER key is passed to the application.

Description Passes the enter key through to the application. If the Virtual PC cursor is positioned on a link or button, it is activated. If the Virtual PC cursor is on another form control, Forms Mode is activated.

Optional

Param int - 0 no input origin specified. 1 specifies that the command has originated from the keyboard. 2 specifies that the command has originated from a Braille display (i.e. Whiz wheel up/down). 3 specifies that the command has originated from a mouse click. Defaults to 0.

Category Keyboard

function EnumerateChildWindows

Synopsis For each child of the specified window, calls a callback script function which may optionally process the window and either stop or continue the enumeration.

Description This function calls a specified function for each child of the starting window. This function must be defined as: int function SomeName(handle hwnd). This function must return true if the enumeration should continue or false if it should stop.

Returns Int true if the enumeration completed, false if it was terminated by the callback function returning false for a window.

Param Handle/hWnd starting handle.

Param String/sFunctionCallback The name of the script function to call for each child window.

Category Window

function EnumerateTypeAndTextStringsForWindow

Synopsis Calls a specified function with info about each control in a window

Description Information about each control is obtained using MSAA. The order in which items are enumerated is dictated by how they appear in the MSAA hierarchy. The callback function takes the following parameters: int typeCode, int stateCode,string name, string value,string Description. If the callback function returns 0 the enumeration stops, if it returns 1 the enumeration continues.

Returns int Number of controls enumerated.

Param handle/Window The window containing the controls to be enumerated.

Param String/CallbackName Name of the function to be called for each control.

Category Object Model and MSAA

function EscapeKey

Synopsis The ESCAPE key is passed to the application.

Description Passes the ESCAPE key through to the application. If the cursor is in the virtual ribbons, special functionality takes place.

Category Keyboard

function ExecuteZoomTextCommand

Synopsis Executes ZoomText command

Returns int TRUE when the command was successfully passed to ZoomText

Param String/CommandName Name of command to be executed.

Category Scripts

function ExMessageBox

Synopsis Displays a Windows Standard Message Box.

Description This function displays a Windows Standard Message Box. It is very much like the function MessageBox except it allows you to specify the Message Box title and the type of message box (i.e. The buttons that are used and the icon that is to be displayed). This function also returns a value that indicates which button was pressed on the Message Box.

Returns Int Returns an integer value indicating which button was pressed on the message box.

Param String/strMsg The text of the message that you would like to be displayed in the main body of the message box.

Param String/strTitle The text of the Message Box's title.

Param Int/iType One or more of the Message Box type specifiers that are listed in HJConst.jsh, separated by a single vertical bar. An example of such is: MB_YESNOCANCEL MB_DEFBUTTON1 making the Yes button the default.

Category User Interaction

function ExtractLanguageCodeFromMarkup

Description Extracts language code from marked up text, if any exists.

Returns string The language code.

Param string The marked up text from which a language code is to be extracted.

Category Speech Markup

function FetchCollectionProperty

Description A batch method to retrieve all values from an atomic property of a list of objects within a VB collection. This assumes that the collection is indexable, not just accessible by property name. Use this function to save a for loop's worth of round trip calls to access a collection member by index. Since the return is a variantArray, you can index that with a local for loop which will process much faster.

Returns int TRUE if the remote object was accessed, FALSE otherwise. May return TRUE and also supply an array length of 0 if there are no members.

Param object/remoteCollection the VB object collection that can be accessed by index.

Param string/list the property name of the list to be accessed by index. Often item, as it's written. E.g. list.item(i)

Param int/LowerBound Most VB arrays are 1-based.

Param int/upperBound the end point of the search, often a VB collection will have a .count property or method you can use for this.

Param string/methodOrPropertyName The atomic property you want, For example, "name" if the access is expressed like: list.Items(i).name

Param variantArray/byref/items All the values returned as a variant array. Note that even if the function returns TRUE, it may return a 0-length array.

Category Object Model and MSAA

function FetchObjectProperties

Description Retrieve all properties at once for a VB object. This saves round trips to and from the remote object, where you need to access a lot of properties of a particular object. For example, in Excel, the cell object has a lot of properties that are useful, but the round trip cost to get the properties can be expensive. Note that like a VB object itself, you may see the name for the property, but its value may be null or empty.

Returns int TRUE if the remote object was accessed, FALSE otherwise. TRUE does not mean the collection has items or that the items all have values. Only that the remote object was queried successfully.

Param object/remoteObject The object whose collection members to fetch.

Param collection/byref/JAWSLocalCollection a JAWS script language collection a map of the entire collection in one batch.

Category Object Model and MSAA

function FileExists

Description Checks to see if the specified path exists.

Returns Int TRUE if the path exists.

Param String/strFile The file to be checked.

Category Files

function FilenameGetNearestMatch

Synopsis finds a file whose name most closely matches the given name.

Description This function looks for a file whose name most closely matches the supplied name. The function uses the second two parameters to narrow the search. This function is most useful in locating JSI files to associate settings with documents whose settings maybe similar, indicated by similar file names eg Excel monthly reports.

Returns String The nearest matching filename to the one specified.

Param String/sFileToMatch The filename (including optional path). If the path is not specified the script directory is assumed.

Param Int/nMustMatchFirstNChars specifies the minimum number of characters of the filename's prefix which must match, eg if you are only interested in jsi files starting with excel_ then the value of this parameter would be 6.

Param Int/nMustMatchExtention Set this to true if the extention must match.

Category Files

function FileNameList

Synopsis Returns a delimited list of file names matching the specified criteria.

Description This function returns a delimited list of file names matching the specified criteria. For example, to get a list of scheme files, pass in "*.smf" for the first parameter

Returns String a delimited list of file names matching the specified criteria.

Param String sFileNameMask filename mask optionally including path information. If no path is included, the settings/lang path is prepended

Optional

Param String sDelim the delimiter to separate filenames with. If no delimiter is supplied, \007 is used.

Param String callback an optional callback function for filtering each file. The function is passed the basename of the file (i.e. without extension) and it must return true to include it in the list, or false to exclude it.

Category Files

function FindAncestorOfType

Description Searches the ancestors of the current object to find one with the indicated type.

Returns int The level in the ancestry of the current object with the matching type.

Param Int/typeToFind One of the wt_typeCode constants.

Category Object Model And MSAA

function FindCaret

Description allows the user to specify the coordinates of the system caret when JAWS is unable to locate it.

Returns Int TRUE if the function is determining the correct caret location, false otherwise.

Param Int/nX/ByRef set to x coordinate of caret.

Param Int/nY/ByRef set to y coordinate of caret.

Category Cursors

function FindColors

Description Searches for the occurrence of a specific combination of foreground and background colors. If the search is successful, the JAWS cursor is placed at the beginning of the text with the desired combination of colors.

Returns Int The number is 1 if the search was successful, 0 if it was not successful.

Param Int Type in a variable name or function that can provide the color value to be used as the foreground color. RGBStringToColor is often used as a parameter. Use the constant IgnoreColor defined in the file HJConst.jsh to ignore the foreground color and search only for the occurrence of the background color.

Param Int Type in a variable name or function that can provide the color value to be used as the background color. RGBStringToColor is often used as a parameter. Use the constant IgnoreColor defined in the file HJConst.jsh to ignore the background color and search only for the occurrence of the foreground color.

Param Int Type in one of the following constants defined in HJConst.jsh to indicate the direction of the search: s_top, to search from the top of the active window; s_bottom, to search from the bottom of the active window; s_next, to search forward from the position of the active cursor; s_prior, to search backward from the position of the active cursor.

Optional

Param int set this to TRUE to restrict the search to the window containing the active cursor, FALSE for an unrestricted search, if not supplied, defaults to FALSE, ie unrestricted. this optional parameter is only available in JAWS 6.0

Category Colors

function FindDescendantWindow

Description Find the descendant window with the specified Control ID.

Returns Handle The handle of the window that is found. This is 0 if the window is not found.

Param Handle The handle of the parent window that will serve as the starting point for the search.

Param Int The Control ID of the window for which you are searching.

Category Window

function FindDistantAncestorOfType

Description Searches the ancestors of the current object starting from the most distant to find one with the indicated type.

Returns int The level in the ancestry of the current object with the matching type; -1 if type is not found.

Param Int/typeToFind One of the wt_typeCode constants.

Category Object Model And MSAA

function FindFirstAttribute

Description Searches for the first occurrence of text with certain attributes. It begins the search at the upper left corner of the specified window and moves downward. If the search is successful, then the active cursor is placed on the first character that has the desired attributes. Generally, the PC cursor can be successfully moved to attributes within a text window.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Param Int Type the name of the constant value for the attribute that is to be located: ATTRIB_BOLD, ATTRIB_UNDERLINE, ATTRIB_ITALIC, ATTRIB_HIGHLIGHT, and ATTRIB_STRIKEOUT. You can search for a combination of attributes by placing a PLUS SIGN ( + ) between constants. For example, ATTRIB_BOLD + ATTRIB_UNDERLINE.

Optional

Category Text Format

function FindGraphic

Description FindGraphic searches for a graphic in the specified window. If the graphic is found, then the JAWS cursor is placed on it. The graphic must have a text label associated with it because the FindGraphic function searches for text labels. Text labels are assigned by the Graphics Labeler.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Param Handle Specify a window handle. Type the name of a variable or choose a script function that indicates the window that is to be searched.

Param String Type the graphic label that is to be located. The label must be typed exactly as it appears in the graphic label file. Enclose the graphic label within quotation marks.

Param Int Indicate the search direction. Type a constant value to indicate the starting point for the search: S_TOP or S_BOTTOM.

Param Int Indicate search restriction. Type the name of a constant value to indicate whether the search should be restricted to the active window or it should extend into all child windows of the active application. Type S_UNRESTRICTED to search all application windows or S_RESTRICTED to limit the search to the active child window.

Category Graphics

function FindJAWSHelpFile

Description Retrieves the full path to the specified JAWS help file. This will depend in part on the current language.

Returns String Full path to the specified JAWS help file.

Param String/strHelpFile Name of the desired help file.

Description Retrieves the full path to the specified JAWS utility program.

Returns String Full path to the specified JAWS utility program.

Param String/strUtility Name of the desired utility program.

Category JAWS Program

function FindKeyAliasMatch

Description Find the actual key that has the passed in alias.

Returns String The name of the key that matches the Alias. The returned string is empty if no match is found.

Param String/strAlias

Category Keyboard

function FindLastAttribute

Description Searches for the last occurrence of text with certain attributes. It begins the search at the lower right corner of the active window and moves up to the upper left corner of the window. If the search is successful, then the active cursor is placed on the first character that has the desired attributes. Generally, the PC cursor can be successfully moved to attributes within a text window.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0. "FALSE" = search failure.

Param Int Type the name of the constant value for the attribute that is to be included in the search: ATTRIB_BOLD, ATTRIB_UNDERLINE, ATTRIB_ITALIC, ATTRIB_HIGHLIGHT, and ATTRIB_STRIKEOUT. You can search for a combination of attributes by placing a PLUS SIGN ( + ) between constants. For example, ATTRIB_BOLD + ATTRIB_UNDERLINE.

Optional

Category Text Format

function FindNextAttribute

Description Searches for the next occurrence of text with certain attributes. The search begins at the location of the active cursor and moves down through the remainder of the active window. If the search is successful, then the active cursor is placed on the first character that has the desired attributes. Generally, the PC cursor can be successfully moved to attributes within a text window.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Optional

Category Text Format

function FindPriorAttribute

Description Searches for the prior occurrence of text with certain attributes. It begins the search at the location of the active cursor and moves up through the remainder of the active window. If the search is successful, then the active cursor is placed on the first character that has the desired attributes. Generally, the PC cursor can be successfully moved to attributes within a text window.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Optional

Category Text Format

function FindString

Description FindString searches for a string of text in a specified window. If the text is found, then the JAWS cursor is placed at the beginning of the text string

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Param Handle Specify a window handle. Type the name of a variable or choose a script function to provide the handle of the window that is to be searched.

Param String Specify the text that is to be located. Type a text string, or type a variable name or choose a script function that can provide the text. Text strings must be enclosed within quotation marks.

Param Int Indicate the search direction. Type the name of a constant value to indicate the direction of the search: S_TOP or S_BOTTOM.

Optional

Param int/bUseUnderlyingDom set to TRUE to use the ap's underlying DOM to find text even if not onscreen, FALSE to do an onscreen search (for backward script compatibility, defaults to FALSE)

Category Strings

function FindTopLevelWindow

Description Find the top level window with the specified window class and/or window name. If you do not wish to search based on one of the arguments, use " ," for that argument

Returns Handle The handle of the window that is found. This is 0 if the window is not found.

Param String The window class that will be used to find the desired window.

Param String The window name that will be used to find the desired window.

Category Window

function FindWindow

Synopsis finds a window with a specified class or name.

Description This function starts at the specified window and searches all of its children to find one with the specified Class or Window Name. If the handle is 0 then a top level window is sought (ie equivalent to calling FindTopLevelWindow). Leave the name blank to find a window with a class but any name or leave the class blank to find a window with any class but a particular name.

Returns Handle the window handle of the found window.

Param Handle/hStart starting window.

Param String/sClass class name to search for.

Optional

Param String/sWindowName the name of the window to find.

Category Window

function findWindowByType

Synopsis Finds a child window by its type.

Description This function allows the scripter to find a child window of a given window with a specified window type.

Returns handle the handle of the window with the specified type if found, or 0 if no window with the specified type exists under the starting window's hierarchy.

Param handle the starting window

Param int the window type (one of the WT_ constants from hjconst.jsh).

Category Window

function FindWindowsSystemFile

Description Retrieves the full path to the specified Windows system file.

Returns String Full path to the specified WIndows system file.

Param String/strSystemFile Name of the desired file.

Category JAWS Program

function FindWindowWithClassAndId

Synopsis Finds a child window with a given control ID and class

Description this function is useful when control IDs are not unique in an application and you need to find a child window with a given control ID and class name.

Returns handle the handle of the window if found, NULL otherwise

Param handle/hwnd starting handle

Param string/sClass the class name

Param int/ControlID the control ID of the child

Category Window

function FirstCell

Description When inside a table or spreadsheet, moves the active cursor to the first cell.

Returns Int TRUE if the cursor moved, FALSE otherwise.

Category Tables

function FlashMoviesRecognize

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function FlexibleWebGetActiveRulesNumberForSelectedLocation

Description Returns the number of selected rules for the current location, when the Apply Flexible Web rules dialog is active, and the focus is in the Locations tree view.

Returns int The number of active rules for the selected Location

Category HTML Flexible Web

function FocusToLink

Synopsis Causes the system focus to move to a specified link in a document.

Description The first link in the buffer is 1, the second 2, etc.

Returns int The number of the link

Param int/LinkNumber The 1-based number of the link to which focus should move.

Category Object Model and MSAA

function FocusWindowSupportsUIA

Description Determines if the focus window supports UIA.

Returns int

Category Window

function FormatString

Description Formats the string you specify with the messages received as subsequent parameters. The message to be formatted must be delimited with the parameter place holder delimiters, such as %1 %2 %3 %4 %5

Returns String the contents of Message with all place holders replaced by their associated parameters.

Param String/Message string containing text intermingled with parameter place holders.

Optional

Param Variant item to be substituted in place of %1 every time it appears in Message.

Param Variant item to be substituted in place of %2 every time it appears in Message.

Param Variant item to be substituted in place of %3 every time it appears in Message.

Param Variant item to be substituted in place of %4 every time it appears in Message.

Param Variant item to be substituted in place of %5 every time it appears in Message.

Param Variant item to be substituted in place of %6 every time it appears in Message.

Param Variant item to be substituted in place of %7 every time it appears in Message.

Param Variant item to be substituted in place of %8 every time it appears in Message.

Param Variant item to be substituted in place of %9 every time it appears in Message.

Category Strings

function FormatStringWithEmbeddedFunctions

Synopsis Formats a string with embedded functions.

Description This function replaces each occurance of with the result of calling the function func.

Returns String The string with occurances replaced by function result.

Param String/SStr string with embedded functions.

Category Strings

function FormsModeEvent

Synopsis Is activated whenever forms mode is entered or exited.

Description This function is activated whenever forms mode is entered or exited. It is passed a boolean value indicating which of these actions has taken place. If bEntering is equal to true, forms mode has been turned on. If bEntering is equal to false, forms mode has been turned off.

Param Int/bEntering This is the boolean value representing the current state of forms mode.

Optional

Param int/bApplicationMode This is the boolean value representing the current state of application mode. Applicable to JAWS 10 only.

Category HTML Events

function FramesEnumerate

Synopsis Enumerates all frames calling a script function for each frame defined.

Description This function enumerates all defined and valid frames and calls a function for each frame passing in the name and rectangle tlx, tly, brx, bry for the frame.

Returns Void

Param String/Callback script function.

Category Frames

function FrameViewer

Synopsis Launch the Frame Viewer

Description Launch the Frame Viewer with information regarding a possible new frame creation.

Returns void

Param Int/iAction What action should the Frame Viewer perform. Possible values are found in HJConst beginning with FRAMEVIEW_.

Param Int/iEnclosingTop the screen coordinate for the top of the parent window for the new frame.

Param Int/iEnclosingLeft the screen coordinate for the left of the parent window for the new frame.

Param Int/iEnclosingBottom the screen coordinate for the bottom of the parent window for the new frame.

Param Int/iEnclosingRight the screen coordinate for the right of the parent window for the new frame.

Param Int/iFrameTop the screen coordinate for the top of the new frame.

Param Int/iFrameLeft the screen coordinate for the left of the new frame.

Param Int/iFrameBottom the screen coordinate for the bottom of the new frame.

Param Int/iFrameRight the screen coordinate for the right of the new frame.

Param String/strName the title of the parent window.

Param String/strClass the class of the parent window.

Param String/strPrompt the prompt that will be associated with this frame.

Category Frames

function FrameViewerActive

Synopsis Determines whether or not the Frame Viewer is loaded and active.

Description Since multiple instances of the Frame Viewer cannot be simultaneously loaded, this function is usefull for giving the user feedback when a second instance of the Frame Viewer is denied from launching.

Returns Int TRUE if the Frame Viewer is active, otherwise FALSE.

Category Frames

function GetActiveConfiguration

Synopsis retrieves the name of active configuration set.

Description The Name is what is left when all of the path information is stripped away from the Active Configuration path.

Returns String The name of the active configuration set.

Optional

Param int When TRUE, GetActiveConfiguration will return the name of the active domain configuration if applicable. Otherwise, the application configuration is returned.

Category Settings

function GetActiveCursor

Description Returns the type of the active cursor. If the detailed type is requested, and the generic type is CURSOR_PC, the more detailed type of cursor is returned.

Returns Int (JAWS Values) CURSOR_JAWS = 0, CURSOR_PC = 1, CURSOR_INVISIBLE = 2, CURSOR_Braille = 3.

Optional

Param int TRUE-returns the detailed cursor type, FALSE-returns the generic type. Defaults to FALSE.

Category Cursors

function GetActiveCursorName

Synopsis Returns the name of the active cursor.

function GetAlternateUserDirectoryMode

Description Returns the current Alternate User Directory Mode. See the documentation of SetAlternateUserDirectoryMode for information on the various Alternate User Directory Modes.

Returns Int AlternateUserDirMode_Off = 0, AlternateUserDirMode_Default = 1, AlternateUserDirMode_Roam = 2

Category Settings

function GetAncestorCount

Description Gets the hierarchical ancestor count of MSAA objects.

Returns int hierarchical Count of MSAA objects.

Category Object Model And MSAA

function GetAnnotationAtCaret

Description returns ref mark, author, text, date and time, and description of an annotation at the cursor. Note that there may be multiple annotations associated with the character at the cursor, e.g. comment plus comment replies.

Returns int The UIA AnnotationType constant representing the annotation object's type, or 0 if there is no annotation object at the caret.

Param int index 0-based index of annotation to retrieve

Param string/byref/refText the reference mark or name of the annotation

Param string/byref/ author the author of the annotation

Param string/byref/targetText The text of the actual annotation e.g. comment, footnote or endnote text.

Category Window

function GetAppMainWindow

Description Determines the window handle for the Main window of the active application.

Returns Handle Provides the window handle of the application's Main window.

Param Handle This function starts with the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the handle for the starting window. GetCurrentWindow is often used as the parameter.

Category Window

function GetAppTitle

Description This obtains the title of the active application program. To have the application title spoken, you must use this function as a parameter for the SayString function.

Returns String The string is the title of the application.

Category Application Info

function GetAuthCode

Synopsis Obtains the first 7 characters of the authorization code.

function GetBrailleCellRow

Description Retrieves the screen row at which the specified Braille cell is located.

Returns Int The vertical pixel location of the cell.

Param Int The number of the Braille cell of interest.

Category Braille Output

function GetBrailleDisplayName

Description Returns the name of the braille display that is currently in use.

Returns String The name of the braille display that is currently in use. If no braille display is attached, this function returns an empty string.

Category Braille Device

function GetBrailleKeyboardLayout

Description Returns the keyboard layout for the braille display that is currently in use.

Returns String The keyboard layout for the braille display that is currently in use. If no braille display is attached, this function returns an empty string.

Category Braille Device

function GetBrailleModeForModeId

Description Returns the information about the mode or translation rule set associated with the supplied mode ID. it is broken up into parts separated by a (vertical bar). In order, the parts for the mode information are mode ID, mode friendly name, three-letter language abbreviation and language friendly name.

Returns string The information for the mode, or translation rule set, associated with the supplied mode ID.

Param int/ModeID the ID of the mode whose information is to be retrieved.

Category Braille Settings

function GetBrailleModesForLanguage

Description Returns a list of modes, or available sets of rules, for the selected language. List items are separated by # (number sign), and parts of the list item are separated by a (vertical bar). In order, the parts for each list item are mode ID, mode friendly name, three-letter language abbreviation and language friendly name.

Returns string The list of available modes for the selected language.

Param string/TLA The three-letter abbreviation of the language whose modes are to be returned.

Description returns a list of the languages supported by the active Braille translator. The list items are separated by the # (number sign). Each list item is made up of two parts: the three-letter language code and the friendly name for the language. The parts are separated by a vertical bar ( ).

Returns string The number-sign delimited list of languages supported by the Braille translator.

Category Braille Settings

function GetCachedMSAAFocusInfo

function GetCharacterFont

Description Retrieves the name of the font used for the character at the current cursor location.

Returns String The name of the font.

Category Text Format

function GetCharacterPhonetic

Description returns the phonetic rendering of the character at the cursor or an empty string if there is no phonetic rendering.

Returns string The phonetic representation of the character under the cursor.

Category Screen Text

function GetCharacterPoints

Description Retrieves the point size of the character at the current cursor location.

Returns Int The point size of the character, or 0 if the cursor is either not positioned on anything or is positioned on a graphic.

Category Text Format

function GetCharacterValue

Synopsis Returns the numeric value of the character parameter.

Description This function returns the numeric value of the character parameter.

Returns Int the value of the character.

Param string the character whose value is desired.

Category Strings

function GetCharacterValueString

Synopsis returns a string describing the specified character value.

Description This function maybe used with SayCharacter thrice to get an appropriate string to speak describing the character. For example: Character u + 627 or Character 255 plus 248 or Character 1075 etc. Flags maybe used to specify if the value should be converted to hexedecimal or left as decimal and whether or not to markup the character value portion of the string.

Returns string if the character is successfully converted to a multibyte sequence using the specified code page then the string will contain either the hex or decimal values of the characters. If the markup flag was specified, the actual values will be marked up using the toSpell text option.

Optional

Param string/sChar if not supplied, the character at the active cursor is assumed.

Param int/nFlags see HJConst.jsh for supported flags (see CVF constants.

Param int/nCodePage if not specified, the active code page is assumed.

Category Strings

function GetCharacterWidth

Description Retrieves the width of the character or graphic at the current cursor location.

Returns Int The width of the character or graphic, or 0 if the cursor is not positioned on anything.

Category Text Format

function GetChunk_ColorNA

Description Similar to GetChunk, but whereas GetChunk treats sections of text with differing colors as separate chunks, GetChunk_ColorNA disregards color as a factor in sectioning text.

Returns String Provides the color independent chunk of information.

Category Screen Text

function GetChunk

Description Obtains the chunk of information to which the active cursor is pointing. A chunk is text and graphic information that was written to the screen in a single operation. GetChunk is similar to GetField, however, the GetField function uses logic to determine the text that is to be obtained, while GetChunk simply obtains the text that was stored in the off screen model as a single unit.

Returns String Provides the chunk of information.

Category Screen Text

function GetClipboardText

Synopsis Retrieve text from the Windows clipboard.

Description Retrieves text from the clipboard that is in standard ANSI format. Each line ends with a carriage return/linefeed (CR-LF) combination.

Returns STRING The text found on the clipboard, or " ," if the clipboard is empty.

Category Clipboard

function GetColorApproximation

Synopsis Returns the closest color for which we have a name to the color supplied. Also provides information about how the closest color relates to the color supplied.

Description This function takes a COLORREF and finds the closest color in our table for which we have a name. It also provides information as to whether the approximated color is lighter or darker than the color passed in.

Returns int The color approximately the same as the one past in.

Param int/iColor the color to approximate.

Param int/byRef/nComparisonIndicator a positive number is returned if the approximated color is brighter than the original, 0 if it is the same or a negative number to indicate that the approximated color is darker than the original.

Category Colors

function GetColorAtPoint

Description Retrieves the color at the specified location. This is the color RGB value in such as 000000000 or 255255255.

Returns Int The color value at the specified point.

Param Int/nX the column coordinate of the desired location. You can use GetCursorCol() to retrieve this value.

Param Int/nY the row coordinate of the desired location. You can use GetCursorRow() to retrieve this value.

Category Colors

function GetColorBackground

Description Retrieves the background color of the character at the current cursor location.

Returns Int The background color value.

Category Colors

function GetColorField

Description Obtains the color field at the position of the active cursor. A color field is a section of information, usually text, that has a common combination of colors. For example, the combination might be white foreground on blue background. The use of the color combination must be contiguous. GetColorField is similar to GetField. However, the function GetColorField is based on color changes, while GetField is based on attribute changes.

Returns String The color field pointed to by the active cursor.

Optional

Param int/nSearchLeftMax The maximum distince to look left. The default distance is 0 pixels.

Param Int/nSearchRightMax The maximum distance to look right. The default distance is 0 pixels.

Param int/bSearchLeftFirst If True, JAWS looks left first, otherwise JAWS looks right first. The default value is true.

Category Colors

function GetColorName

Description Retrieves the textual name for the given color found in colors.ini.

Returns String The name of the color, or an RGB string if a name is not provided in colors.ini.

Param Int The color value to be used.

Category Colors

function GetColorText

Description Retrieves the text color of the character at the current cursor location.

Returns Int The text color value.

Category Colors

function GetColumnHeader

Description When in a table or spreadsheet, gets the contents of the column header.

Returns String Provides the header of information.

Optional

Param Int/iMarkedHeader Include only headers that are marked in the table

Category Tables

function GetColumnText

Synopsis Gets the text of a range of cells in the current column of a table.

Description This function gets the text of a range of cells in the current column of a table. You can specify the separator string to use between data elements, whether or not to include the coordinates of the active cell immediately before that cell's data and the start and end rows to include.

Returns String The text of the included cells.

Optional

Param String/lpszSeparator string to insert between cell data, defaults to a single space.

Param String/lpszCurrentCoordinateTemplate a string defining how the coordinates of the current cell will be rendered. This string must contain two % style parameters (eg c%1r%2) which will be filled with the numeric value of the current column and row respectively. If this parameter is 0 then no coordinates will be included before the current cell.

Param String/lpszBlankCellText the text to be displayed if the cell is blank.

Param Int/nStartRow the starting row, defaults to the first row (1) of the table.

Param Int/nEndRow the ending row, defaults to the last row of the table.

Category Tables

function GetColumnTextAsArray

Description Returns an array where each element is the text of a cell in the specified range. For example, if you request the entire column, there will be an element for each cell in the column. If you only request rows 3 to 5, there will be three elements, the first for row 3, the 2nd for 4 and the third for 5. In this case you will need to take note of the starting row requested if you wish to map this back to the entire column.

Returns stringArray the array of cells.

Optional

Param int/startRow Defaults to the first row.

Param int/endRow Defaults to the last row.

Category Tables

function GetControlAttributes

Description This function returns an integer value indicating the attributes of the current control.

Returns Int The control attributes, as defined in HJconst.jsh. The values returned may be one of the following; CTRL_NONE = 0, CTRL_CHECKED = 1, CTRL_UNCHECKED = 2, CTRL_GRAYED = 4, CTRL_DISABLED = 8, CTRL_SUBMENU = 16, or CTRL_PRESSED = 32.

Optional

Param Int/BypassMSAACache if TRUE, do not use cached MSAA state

Category Dialog Controls

function GetControlID

Description Determines the Control ID for the specified child window in a dialog box. Each list box, edit field, radio button, etc. in a dialog has a unique control ID number. Child windows that contain static text all have the same control ID.

Returns Int Provides a numeric ID for the specified dialog control, or returns 0 when a dialog box is not active.

Param Handle This function provides information for the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide a window handle.

Category Window

function GetControlIDString

Synopsis Like GetControlID, but for .Net controls

Description Retrieves the ID string for a control on a .Net Windows Form. This string is actually the name of the variable used by the programmer to name the field so it may or may not be useful. GetControlID is not useful in .Net applications because numeric control IDs are automatically assigned by the runtime and are

Returns String a control's ID String

Param Handle This function provides information for the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide a window handle.

Category Window

function GetControlName

Description Gets the name of the current control.

Returns String The name of the control.

Category Dialog Controls

function GetControlTypeName

Description returns a localized string describing the WT_XX HJConst.jsh constant passed in.

function GetCurrentKeyboardLayoutDisplayName

Synopsis Retrieves from the registry the currently active keyboard layout's registry key "Layout Text"

Returns string The registry value for the key HKLM \SYSTEM \CurrentControlSet \Control \Keyboard Layouts <activelayout > \Layout Display Name

Category Scripts

function GetCurrentKeyboardLayoutText

Synopsis Retrieves from the registry the currently active keyboard layout's registry key "Layout Text"

Returns string The registry value for the key HKLM \SYSTEM \CurrentControlSet \Control \Keyboard Layouts <activelayout > \Layout Text

Category Scripts

function GetCurrentLinkIndex

Synopsis Returns the 1-based index of the link on which the PC cursor is positioned in a virtual buffer.

Description The first link in the buffer is 1, the second 2, etc.

Returns int The number of the link

Category Object Model and MSAA

function GetCurrentObject

Description Uses MSAA to obtain the object with focus at the active cursor position.

Returns Object The accessible object at the current cursor location.

Param Int/IDChild ID of child.

Category Object Model And MSAA

function GetCurrentRegionName

Description returns the name of the active Aria region

Returns string The name of the Aria region.

Category HTML

function GetCurrentRegionType

Description returns the type of the active Aria region

Returns string The type string for the Aria region.

Category HTML

function GetCurrentRowColumnCount

Description Returns the physical number of columns in the current table row.

Returns Int 0 if not in a table row or the number of columns in the current row.

Category Tables

function GetCurrentSayAllScheme

Description returns the name of the currently active Speech and Sounds scheme used when performing a SayAll.

Returns string the currently active SayAll scheme.

Category Speech Markup

function GetCurrentSchemeName

Synopsis Gets the name of the currently loaded Speech and Sound Scheme.

Description This function returns the name of the currently loaded Speech and Sounds Scheme.

Returns String the currently active smf file minus the extention .

Category Speech Markup

function GetCurrentScriptKeyName

Description Retrieves the name of the key or gesture used to invoke the currently active script.

Returns String The key or gesture name.

Category Scripts

function GetCurrentWakeWord

Description Retrieves the word or phrase used to wake the JAWS voice assistant.

Returns string The phrase or word used to wake the JAWS voice assistant.

Category Misc

function GetCurrentWindow

Description Determines the window handle for the window that contains the active cursor. In contrast, the GetFocus function uses an analytic process to find the window that currently has the focus, regardless of which cursor is active.

Returns Handle Provides a handle for the active window.

Category Window

function GetCursorCol

Description This determines the horizontal position or column where the active cursor is located. It returns an integer that can be spoken with the SayInteger script function. The value returned is based upon the number of pixels that the active cursor is from the left edge of the screen.

Returns Int the value of the active cursor column position.

Optional

Param Int/nCursorType Optional parameter that designates whose cursor position is to be retrieved. If this parameter is not specified, then the active cursor is used.

Param Int/CoordinateSystem The prefered coordinate system in which the value should be returned This is only a recommendation and will not work in all places. See the COORDSYS_xxx constants in hjconst.jsh.

Category Cursors

function GetCursorColString

Description This gets the appropriate string describing the cursor position relative to the left of the page or sccreen.

Returns string The cursor column position.

Optional

Param int Type the constant value that represents a cursor, type a variable name, or choose a script function. Cursor constants are: CURSOR_JAWS, CURSOR_PC, CURSOR_INVISIBLE, CURSOR_Braille. A script function such as GetActiveCursor also can provide the constant.

Param int desired units of measure, see hjconst.jsh smmUnitsOfMeasure constants.

Category Cursors

function GetCursorPos

Description This gets the cursor position relative to the top of the page or sccreen.

Returns int TRUE if the coordinates were obtained in the desired unit of measure, FALSE otherwise.

Param Int Type the constant value that represents a cursor, type a variable name, or choose a script function. Cursor constants are: CURSOR_JAWS, CURSOR_PC, CURSOR_INVISIBLE, CURSOR_Braille. A script function such as GetActiveCursor also can provide the constant.

Param int desired units of measure, see hjconst.jsh smmUnitsOfMeasure constants.

Param Int/nCol/ByRef set to x coordinate of caret in desired unit of measure (if supported).

Param Int/nRow/ByRef set to y coordinate of caret in desired unit of measure (if supported).

Category Cursors

function GetCursorPosString

Description This gets the appropriate string describing the cursor position relative to the top and left of the page or sccreen.

Returns String The cursor column and row position.

Optional

Param int desired units of measure, see hjconst.jsh smmUnitsOfMeasure constants.

Category Cursors

function GetCursorRow

Description This determines the vertical position or row where the active cursor is located. It returns an integer that can be spoken by the SayInteger script function. The value returned is based upon the number of pixels that the active cursor is from the top of the screen.

Returns Int the value of the active cursor row position.

Optional

Param Int/nCursorType Optional parameter that designates whose cursor position is to be retrieved. If this parameter is not specified, then the active cursor is used.

Category Cursors

function GetCursorRowString

Description This gets the appropriate string describing the cursor position relative to the top of the page or sccreen.

Returns string The cursor row position.

Optional

Param int desired units of measure, see hjconst.jsh smmUnitsOfMeasure constants.

Category Cursors

function GetCursorShape

Category System

function GetDefaultBrailleDisplayInfo

Description Retrieves information about the default braille display.

Returns int True if information about the default braille display could be retrieved, false otherwise.

Param string/byRef braille display short name.

Param string/byRef braille display long name.

Param string/byRef braille display driver.

Category Braille Device

function GetDefaultButtonName

Description Identifies the default button in a dialog box. This is the button that will be chosen when ENTER is pressed.

Returns String Provides the name of the default dialog button.

Category Dialogs

function GetDefaultJCFOption

Description Determines the value of a specified option in the default JAWS configuration file.

Returns Int Returns the numeric Value that has been set for the specified option.

Param Int Type the constant value that names the option that you wish to check. Constant values are listed in HJCONST.JSH, and begin with the prefix "OPT_" or "OPTBRL_." Constants beginning with "OPTBRL_" are for Braille devices.

Category Settings

function GetDefaultProfileIndex

Description Returns the index of the default voice profile.

Returns int The index of the default voice profile.

Category Voices

function GetDefaultProfileName

Description Returns the name of the default voice profile.

Returns string The name of the default voice profile.

Category Voices

function GetDefaultSynthGlobalSectionName

Description retrieves the section name used in default.jcf for the default synthesizer.

Returns string The section name in default.jcf of the default synthisizer.

Category Files

function GetDefaultSynthInfo

Synopsis Returns information about the default synthesizer.

Description This function retrieves the default synthesizer's short name, long name and driver.

Returns Int TRUE if synth information was retrieved, FALSE otherwise.

Param String/byRef/sShortName the short name of the synth as defined in SynthNShortName in JFW.ini.

Param String/byRef/sLongName the long name of the synth as defined in SynthNLongName in JFW.ini.

Param String/byRef/sDriver the driver name of the synth as defined in SynthNDriver in JFW.ini.

Category Voices

function GetDescribedByText

Description Returns the text of any elements that have a describedBy relationship to the current element.

Returns string The descriptive text.

Category HTML

function GetDialogIdentifier

Synopsis Obtains the dialog identifier.

Description This function obtains the dialog identifier. If focus is in a multi-page dialog the Dialog Identifier is the Dialog Page Name. If focus is in a web page dialog or a MSAA window the Dialog Identifier is the name of the object that has the dialog role; this information is obtained from the Cached MSAA Data. Otherwise the Dialog Identifier is the window name of the dialog box.

Returns String The dialog identifier

Category Dialogs

function GetDialogPageName

Description If the active cursor is inside a multi-page dialog, retrieves the name of the current page.

Returns String The name of the current page.

Category Dialogs

function GetDialogStaticText

Description Gets the static text in a dialog box.

Returns String The static text found in a Dialog box.

Category Dialogs

function GetDocumentLoadState

Synopsis Queries the document at the requested window for its load state.

Description This is currently supported in applications that use the Freedom Scientific Document Server module.

Returns int One of the values listed in hjconst.h under Document Load States.

Param HANDLE/hWnd The window at the document whose state is to be queried.

Category Window

Description Returns various document properties for an editable text document. At present this function is only valid for Lotus Notes 8. This function is available in JAWS 8.0 update 1 and higher.

Returns Int 1 for success, 0 for failure

Param string/title The title of the document

Optional

Param string/PageName The number (or letter) of the current page

Param string/PageNumber The number of a page as it relates to all pages. For example, PageNumber would be the number "1" in the text "1 of 3"

Param string/TotalPages The total number of pages in the document

Param string/LineNumber The current line number within a document page

Param string/CharacterPosition The index of a character on a line of text

Param string/ColumnNumber The number of the current text column

Param string/TotalColumns The total number of text columns

Param string/SectionName The name of the current text section

Category Object Model and MSAA

function GetDocumentTitle

Description Retrieves the title of the active html document.

Returns string The title of the active document from its title tag.

Category HTML

function GetDocumentXML

Description This function returns XML for the current virtual document. It obtains well-formed XML from the Dom Server for parsing using the MSXML com object.

Returns string The XML for the current virtual document.

Category HTML XML DOM

function GetDomainName

Synopsis returns the domain for the current document.

Description This allows scripts to obtain the domain of the currently active document. Starting with JAWS 17, called on local files it returns the filename without path or extension --e.g. for f:.html it returns "index".

Returns string The domain of the current document

Category HTML

function GetElementDescription

Synopsis Returns a string describing the current HTML element.

Description This function returns the current HTML element's parameters and their values as a string suitable for speaking or posting to the Virtual Buffer.

Returns String Description of element

Optional

Param Int/nAncestors the number of ancestors to include in the description, the default is 1.

Param Int/bWantTagsOnly true if you only want the tag name(s) and not the parameters as well, default is TRUE.

Category HTML

function GetElementXML

Description This function returns the XML for the element at the virtual cursor. You may also specify the number of ancestors to include.

Returns string The XML for the element at the virtual cursor.

Optional

Param int/ancestorCount 0 for current element only, 1 to include parent, 2 for grandparent etc, -1 for all ancestors.

Category HTML XML DOM

function GetElementXMLAtPoint

Description This function returns the XML for the element at the specified point. You may also specify the number of ancestors to include.

Returns string The XML for the element at the specified point.

Param int/x The X coordinate of the point.

Param int/y The Y coordinate of the point.

Optional

Param int/ancestorCount 0 for current element only, 1 to include parent, 2 for grandparent etc, -1 for all ancestors.

Category HTML XML DOM

function GetEmbeddedObjectDescription

Description Used to get the description of an object embedded within another object. Usually, this applies to objects, such as links, which may be embedded within a text object. Presently, this function will only return success when focus is on a text object with a role of IA2_ROLE_PARAGRAPH. At this time, the only application implementing such objects is in Lotus Notes 8. This function is available after JAWS 8, update 1.

Returns string Description of the embedded object at the cursor position.

Category Object Model And MSAA

function GetEnvironmentVariable

Description Retrieves the value of a Windows environment variable.

Returns STRING

Param string/environmentVariableName

Category system

function GetField

Description Obtains the information in the field where the active cursor is pointing. A field is a section of information (usually text) that has a common attribute. Examples are; bold, underlined, italics, or strikeout. The use of the attribute must be contiguous. GetField is similar to GetChunk, however, the GetField function uses logic to determine the text that is to be obtained, while GetChunk simply obtains the text that was stored in the Off Screen Model as a unit.

Returns String Provides a field of information.

Optional

Param int If true, and the cursor is at the offset just after the last character of text in the field, jaws returns the preceding field.

Category Screen Text

function GetFileDate

Description Used to get the last modified date of a particular file GetAppFilePath can be used to specify the path of the desired application.

Returns Int An integer containing the last modified date in the form of yyyymmdd. For example, the integer 19970911 would specify September 11, 1997.

Param string Enter the fully qualified path name of the desired application. GetAppFilePath can be used to get the path of the currently running application.

Category Files

function GetFirstChild

Description Determines the first child window that may have been created by a specific parent window. This function is useful when you wish to move down through the stack of window handles.

Returns Handle Provides the handle of the first child window or returns a value of 0 when a child window cannot be found.

Category Window

function GetFirstWindow

Description Provides the handle for the first window that is at the same logical level as a specified window handle. It is used to get to the beginning point of a series of windows.

Returns Handle Provides the handle for the first window that is at the same logical level or returns 0 when a window is not found.

Category Window

function GetFixedProductVersion

Description GetFixedProductVersion gets the application's fixed product version.

Returns Void

Param string The path of the program for which you want the information. You can get the path by using GetAppFilePath.

Param Int/nMajorVersion/ByRef Type the variable to receive the major version value.

Param Int/nMinorVersion/ByRef Type the variable to receive the minor version value.

Param Int/nUpdateVersion/ByRef Type the variable to receive the update version value.

Param Int/nBuildNumber/ByRef Type the variable to receive the build number value.

Category Application Info

function GetFocus

Description Obtains the window handle for the window that has the focus. It always seeks the PC cursor or highlighted item that has the focus. It does not take into account which cursor is active. In contrast, the GetCurrentWindow function is less sophisticated. It simply obtains the handle for the window in which the active cursor is located.

Returns Handle Provides the window handle for the window with the focus.

Optional

Param int/byref MSAA object ID for the object with focus. Available in Jaws 11 update 1 and later.

Param int/byref MSAA child ID for the object with focus. Available in Jaws 11 update 1 and later.

Category Window

function GetFocusObject

Description Uses MSAA to get the object with focus.

Returns Object The interface to the Accessible object.

Param Int/IDChild ID of child.

Category Object Model And MSAA

function GetFocusRect

Description Gets the coordinates of a focus rectangle.

Returns Int TRUE if the focus rectangle is successfully retrieved.

Param Int/hWnd the handle of the window containing the focus rectangle.

Param Int/nLeft the left edge of the focus rectangle after the function is called.

Param Int/nRight the right edge of the focus rectangle after the function is called.

Param Int/nTop the top edge of the focus rectangle after the function is called.

Param Int/nBottom the bottom edge of the focus rectangle after the function is called.

Category Window

function GetFocusRectBottom

Description Gets the coordinates of the bottom edge of a focus rectangle.

Returns Int Screen coordinate of bottom edge of focus rectangle.

Param Int Handle of window containing the focus rectangle.

Category Window

function GetFocusRectLeft

Description Gets the coordinates of the left edge of a focused rectangle.

Returns Int Screen coordinate of left edge of focus rectangle.

Param Int Handle of window containing the focus rectangle.

Category Window

function GetFocusRectRight

Description Gets the coordinates of the right edge of a focus rectangle.

Returns Int Screen coordinate of right edge of focus rectangle.

Param Int Handle of window containing the focus rectangle.

Category Window

function GetFocusRectTop

Description Gets the coordinates of the top edge of a focus rectangle.

Returns Int Screen coordinate of top edge of focus rectangle.

Param Int Handle of window containing the focus rectangle.

Category Window

function GetFont

Description Gets font information about the character under the active cursor.

Returns String

Category Text Format

function GetForegroundWindow

Description Retrieves the handle to the current foreground window. This is generally the main window of the active application, but can sometimes be the handle of a dialog box. Marginally faster than GetAppMainWindow.

Returns Handle The handle of the foreground window.

Category Window

function GetFormFieldIndex

Synopsis Returns the 1-based index of the current formfield.

Description This function returns the 1-based index of the current formfield. Note that if the ControlType optional parameter is supplied and specifies a valid WT constant, this function will return the index for that control type only.

Returns Int the 1-based table index or 0.

Optional

Param int/ControlType one of the WT_ constants to match on or wt_unknown (or 0) for all. This enables a list of specific formfield types to be retrieved. Note this extra param is only available in JAWS 6.0 and higher.

Category HTML

function GetFrameDescription

Description Retrieves the description of a specified frame.

Returns String The text of the description.

Param string The frame name of interest.

Category Frames

function GetFrameNameAtCursor

Description Retrieves the name of the frame that surrounds the location of the current cursor.

Returns String The name of the frame containing the cursor. If no such frame exists, the string is empty. An empty string can be tested for by comparing the result with " "

Category Frames

function GetFramePrompt

Synopsis Returns the prompt associated with the frame specified.

Description This function retrieves the prompt of the specified frame. If no frame is specified then the frame at the active cursor location is asumed. Note that a frame's prompt is any string or strings defined as part of any EVENT_Focus/ACTION_SayString pairs.

Returns String the prompt.

Optional

Param String/sName the name of the frame whose prompt you want.

Category Frames

function GetFrameSynopsis

Description Retrieves the synopsis of a specified frame.

Returns String The text of the synopsis.

Param string The frame name of interest.

Category Frames

function GetFrameTutorMessage

Synopsis Returns the tutor message associated with the frame specified.

Description This function retrieves the tutor message of the specified frame. If no frame is specified then the frame at the active cursor location is asumed.

Returns String the tutor message.

Optional

Param String/sName the name of the frame whose tutor message you want.

Category Frames

function GetFromStartOfLine

Description Retrieves text on the current line that is located to the left of the active cursor.

Returns String

Category Screen Text

function GetGestureName

Description Retrieves the name of the gesture attached to the specified script.

Returns String The gesture name.

Param string The name of the script.

Category Scripts

function GetGestureNames

Description Retrieves a \r \n delimited list of the names of all the gestures that are assigned to the specified script.

Returns String A \r \n delimited list of the names of all the gestures that are assigned to the specified script.

Param string The name of the script.

Category Scripts

function GetGraphicID

Description Gets the ID associated with the graphic under the current cursor. If this function fails, then the pointer is not positioned in a valid location on the graphic. Moving into the center of the graphic increases the success of this call.

Returns Int The Graphic ID, or zero if GetGraphicID fails.

Category Graphics

function GetGroupBoxName

Description Gets the name of the current Group box.

Returns String The name of the Group box.

Category Dialogs

function GetHeadingCount

Description Gets the number of headings present on the current Web page at the specified level.

Returns Int The number of headings present.

Param Int/nAtLevel 0 for all headings or 1 through 6 to get the count of levels at that level. These correspond to HTML tags h1 through h6.

Category HTML

function GetHotKey

Description Retrieves the first underlined character in the chunk of text on which the active cursor is positioned. This is especially useful in menus and dialog boxes where an accelerator key for a particular item has been defined and is displayed on the screen as a underlined letter in the name of the control.

Returns String The first underlined character if one exists, otherwise an empty string.

Optional

Param Handle The Handle of the window for which you would like to find the hot key. If a handle is not provided, the handle of the current window will be used.

Category Dialog Controls

Synopsis Returns a delimited list of visible frames currently rendered in the VPC buffer.

Description This function returns a delimited list of visible frames currently rendered in the VPC buffer. Specify the delimiter for the list using the optional string parameter. This is used to ensure that the list of frames presented by the ins + f9 keystroke is consistent with what is in the VPC bbuffer. Note that this function is not used if the VPC cursor is not active.

Returns String the delimited list of frame names.

Optional

Param String/sDelimiter The delimiter to use to separate the frame names.

Category HTML

function GetInputLanguage

Description Returns the name of the active intput language. One can add multiple input languages through Control Panel's Regional and Language Options.

Returns String The name of the active input language.

Category System

function GetIntOptionDefaultSetting

Synopsis retrieves the shipping default settings for a JCF option.

Description Looks in the shared settings directory for the default shipping value of a JCF option. If the application has a JCF file and the option is set there, retrieves the value for the setting; otherwise, retrieves the value from the default.jcf file.

Returns int The default value of the setting in the shipping scripts; otherwise, -1 if the setting could not be retrieved.

Param string The section name to which the JCF setting belongs.

Param string The key name exactly as it appears in the JCF file.

Category Files

function GetItemCount

Description Retrieves a count of items in a ListView, Toolbar, or combobox. This function expands the functionality of lvGetItemCount to also work for comboboxes and ToolBArs.

Returns Int the count of items.

Param Handle The window of interest.

Category Dialog Controls

function GetItemRect

Description Gets the bounding rectangle surrounding the specified item or items. Items can be combined using the bitwise ( ) operator. When two or more items are combined, the resulting rectangle enclosed each of the items.

Returns Int TRUE if the bounding rectangle is successfully retrieved.

Param Int/nX The x coordinate of the point where the target item exists. If nX and nY are 0, then the current item rectangle will be retrieved.

Param Int/nY The y coordinate of the point where the target item exists. If nX and nY are 0, then the current item rectangle will be retrieved.

Param Int/nLeft The left edge of the bounding rectangle after the function is called.

Param Int/nRight The right edge of the bounding rectangle after the function is called.

Param Int/nTop The top edge of the bounding rectangle after the function is called.

Synopsis Retrieves the name of the user currently logged into JAWS.

Description If this instance of JAWS is not network aware, then the function returns " ,"

Returns String the name of the user currently logged into JAWS.

Category JAWS Program

function GetJCFOption

Description Determines the value of a specified option as it is currently set in memory.

Returns Int Returns the numeric value that has been set for the specified option.

Category Settings

function GetJFWLang

Description Gets the three letter abbreviation of the JAWS Language that is currently in use. This is the language of the resource DLLs that are loaded by JAWS. This is not necessarily the same as the current speech synthesizer language.

Returns String Returns a string containing the three letter abbreviation of the JAWS Language that is currently in use.

Category JAWS Program

function GetJFWSerialNumber

Description Used to get the serial number of the currently running JAWS.

Returns Int The serial number of the corrently running JAWS, or 0 if there is an error.

Category FS Product Info

function GetJFWSMACount

Synopsis Returns the SMA count.

Description This function returns the SMA count as an integer.

Returns Int The SMA count.

Category FS Product Info

function GetJFWVersion

Description Used to get the version of the currently running JAWS. Can be used to ensure that a function is only called on versions of JAWS that support it.

Returns Int An integer of the form jjmmbbb where j represents the major version, m represents the minor version, and b represents the build number. For example, the integer 300061 would specify JFW 3.00.61.

Category JAWS Program

function GetKeyState

Description Returns by reference both the up/down state of the key, and the toggle state if applicable. NumLock, ScrollLock, and CapsLock have toggle states.

Returns Int TRUE if the keystate was successfully returned.

Param String/strName The name of the key whose state is to be retrieved. A list of key names is referenced in keycodes.ini.

Param Int/bDown/ByRef Set to true if the key is in a down state.

Param Int/bOn/ByRef Set to true if the toggle state is on. For example, if CapLock is in the on state, then this value will be true.

Category Keyboard

function GetLandmarkCount

Description Retrieves the number of available landmarks on the current web page.

Returns int The number of available landmarks.

Optional

Param Int/landmarkType landmark type to count.

Category HTML

function GetLanguageCodeAtCursor

Synopsis Obtains language code at cursor

Description Returns the language abbreviation of the text at the active cursor or the active JAWS language if the language at the cursor cant be determined.

Returns string the language code

Category System

function GetLastBrailleRoutingKey

Description Retrieves the position of the last routing key pressed on a Braille display.

Returns Int The position of the Braille cell with which the routing key is associated. 1 = "cell 1", 2 = "cell 2", and so on.

Category Braille Output

function GetLastInputSource

Description Used to determine the source of the most recent input.

Returns int The most recent input source: keyboard (1), braille (2) or touch (4). See InputSource constants in HJConst.jsh.

Category Scripts

function GetLastKeyPressTime

Description Returns the tick count of the last keyboard event. This function can be used in conjunction with GetLastMouseMovementTime in cases in which it is necessary to know whether a mouse event or a keyboard event occurred more recently.

Returns int Returns the tick count of the last keyboard event.

Category Keyboard

function GetLastMouseMovementTime

Description Returns the tick count of the last mouse movement event. This function can be used in conjunction with GetLastKeyPressTime in cases in which it is necessary to know whether a mouse event or a keyboard event occurred more recently.

Returns int Returns the tick count of the last mouse movement event.

Category Mouse

function GetLastMSAAAlertInfo

Synopsis retrieves the text and alert level of the last known MSAA alert

Description This function allows the user to retrieve the text and alert level of the last MSAA alert.

Returns int TRUE if there is alert data still in the buffer, FALSE otherwise

Param string/byRef/sText the text of the alert

Param int/byRef/nLevel the priority level of the alert, 1 highest, 3 lowest

Category Object Model and MSAA

function GetLastWindow

Description Provides the handle for the last window that is at the same logical level as a specified window handle. It is used to get to the end point of a series of windows.

Returns Handle Provides the handle for the last window that is at the same logical level or returns 0 when a window is not found.

Category Window

function GetLine

Description Copies the text from the line where the active cursor is positioned. The copied text can then be used by other script functions.

Returns String Provides a line of text.

Category Screen Text

function GetLineBottom

Description Determines the vertical pixel location of the bottom of the line containing the current cursor.

Returns Int The pixel location of the bottom of the current line of text, or 0 if no text is found in this location.

Optional

Param Int/nCursorType Optional parameter that designates whose cursor position is to be retrieved. If this parameter is not specified, then the active cursor is used.

Category Text Format

function GetLineCount

Synopsis Gets the number of lines in the current document .

Description This function returns the number of lines in the current virtual document.

Returns Int the number of lines.

Category HTML

function GetLineTop

Description Determines the vertical pixel location of the top of the tallest character of the line on which the current cursor is positioned. Since the cursor position reported by JAWS is based on the base line of characters, this function is the only way of determining how high up a line of text extends.

Returns Int The pixel location of the top of the tallest character on the current line of text, or 0 if no text is found in this location.

Optional

Param Int/nCursorType Optional parameter that designates whose cursor position is to be retrieved. If this parameter is not specified, then the active cursor is used.

Category Text Format

function GetLinkCount

Description Gets the number of links present on the current Web page.

Returns Int The number of links present.

Category HTML

function GetListIndex

Synopsis Returns the 1-based index of the current list.

Description This function returns the 1-based index of the current list. If the cursor is not within a list, returns 0.

Returns Int the 1-based list index or 0.

Category HTML

function GetListOfFormFields

Synopsis Returns a delimited list of form fields.

Description This function returns a delimited list of form fields currently rendered in the VPC buffer. Specify the delimiter for the list using the optional string parameter.

Returns String the delimited list of form fields.

Optional

Synopsis gets a delimited list of proofreading elements

Description This function is used to obtain a delimited list of proofreading elements to present to the user so that the user can select and move the cursor to a particular element.

Returns string the list of elements found delimitted by the specified delimiter or \007 if none specified.

Param int/nProofreadingElementType see hjconst.jsh for the proofreading element types, peSpellingError, peGrammaticalError, peRevision

Optional

Param string/sDelim the delimiter to use to separate the elements.

Category Proofreading and Annotations

function GetListOfTables

Synopsis Returns a delimited list of tables.

Description This function returns a delimited list of tables currently rendered in the VPC buffer. Specify the delimiter for the list using the optional string parameter. The information for each table will be taken from its caption, Summary, (if no Caption) or text within the table. If the table doesn't have any text then the table entry will be labelled untitled N where N increases from 1 for each untitled table. This function is used in conjunction with MoveToTableByIndex and GetTableIndex to facilitate the listing of tables in a ddocument and the ability for the user to select and move directly to any of the tables listed.

Returns String the delimited list of tables.

Optional

Param String/sDelimiter The delimiter to use to separate the table information for each table in the list.

Category HTML

function GetListOfTags

Synopsis Returns a delimited list of elements with a specified tag.

Description This function returns a delimited list of elements with the specified tag currently rendered in the VPC buffer. Specify the tag and the attributes you wish to be used for information about the tag. If a tag doesn't have any of the attributes in the comma delimited list, the inner text of the tag will be used if possible. Specify the delimiter for the list using the optional string parameter. The information for each table will be taken from its caption, Summary, (if no Caption) or text within the table. If the table doesn't have any text then the table entry will be labelled untitled N where N increases from 1 for each untitled table. This function is used in conjunction with MoveToTableByIndex and GetTableIndex to facilitate the listing of tables in a ddocument and the ability for the user to select and move directly to any of the tables listed.

Returns String the delimited list of tags.

Param string/sTag the UPPERCASE HTML tag to collect.

Param string/sAttrList a comma delimited list of HTML attributes to look for when gathering information about the tag.

Optional

Param String/sDelimiter The delimiter to use to separate the tag information for each tag in the list.

Category HTML

function GetListOfTagsWithAttribute

Synopsis Returns a delimited list of elements with a specified tag. The element must also have the specified attribute

Description This function returns a delimited list of elements with the specified tag currently rendered in the VPC buffer. The element must have the supplied attribute. You may optionally also indicate if the tags may be nested or not (which will affect their index). Specify the delimiter for the list using the optional string parameter. This function is used in conjunction with MoveToTagWithAttributeByIndex and related functions. If you specify that you want the value of the attribute included in each list item (see optional param 6), the list's elements will be divided into two parts, the first part is the value of the supplied attribute followed by a colon. The second part is the inner text of the element. For example, in The AOL AIM Triton History Window, this function may be used to obtain information about the messages. The list will look something like MSGID:text MSGID:text ...

Returns String the delimited list of tags.

Param string/sTag the UPPERCASE HTML tag to collect (maybe empty if you want all tags with a specific attribute such as any element with an onclick).

Param string/sAttr the attribute which each element in the list must have and whose value is optionally included as part of the list items retrieved.

Optional

Param int/iAllowNesting TRUE to allow nested elements, FALSE to disallow nesting. Default is TRUE

Param String/sDelimiter The delimiter to use to separate the tag information for each tag in the list.

Param handle/hwndDoc the handle of the document (may not have focus). If this parameter is not supplied, we assume the document has focus.

Param int/bIncludeAttributeValueInListItems if TRUE, the value of the attribute will be included in each list item, if FALSE, the value of the attribute will not be included.

Category HTML

function GetLiveRegionText

Synopsis Obtains the text of the live region with the given ID from the window.

Description This function returns the text of a live region in a given window. Optionally supply the ID of a particular Live Region, or leave it blank to retrieve the text of the last Live Region updated in the specified window.

Returns string The text.

Param handle The window handle of the window containing the Live Region.

Optional

Param string Optionally supply the ID of the Live Region, or leave blank.

Category screen text

function GetLocaleNameForLangID

Description Given a language abbreviation or language ID, retrieves the locale name of the language.

Returns string The locale name of the language matching the abbreviation or id.

Param string The abbreviation or ID of a language.

Category Misc

function GetLockingCode

Synopsis Obtains the locking code.

Description For versions of JAWS using SENTINEL_LM as the Authorization scheme, this function obtains the JAWS locking code and returns the code as a string.

Returns string The locking code, or null if the locking code could not be obtained.

Category FS Product Info

function GetLotusProgramVersion

Description This function returns the major version of Lotus Notes application. For example, if the full version of Lotus Notes 6.5.20.4091, GetLotusProgramVersion would return 6.

Returns Int An integer specifying the major version of the Lotus Notes program.

Param string The path of the Lotus Notes program for which you want the version. You can get the path by using GetAppFilePath.

Category Application Info

function GetLotusVersionInfoString

Description GetLotusVersionInfoString gets a requested string from the version table of Lotus Notes application. If version is lower than 6, this function get the string from String table of this application.

Synopsis Gets a pointer to the native Object Model of an application using MSAA.

Description This function uses MSAA to get a pointer to the Application's native object model directly. It should be used when other methods fail and will only work for Office 2000 and above. It is particularly useful when running under Windows XP in Excel where all other methods fail. This function should be called when focused on the main work area, ie the Excel7 class window in Excel, the _wwg class window in MSWord etc.

Returns Object a poihnter to the Application Object.

Optional

Param int/ObjectID The object ID to use when requesting the native OM pointer. In most cases this is OBJID_NATIVEOM and that's what is used if this parameter isn't specified.

Category Object Model and MSAA

function GetNavModuleVersionInfo

Description Retrieves information about the nav module responsible for the passed in window handle.

Returns String String describing the nav module that is handling the passed in window.

Param Handle Window of interest

Category Window

function GetNearestGlanceHighlightIndex

Description Retrieves the index of the nearest glance highlight on the page.

Returns int If there are glance highlights on the page, the index of the nearest one; otherwise, 0.

Category HTML

function GetNearestLink

Optional

Param int LinkTypeFlags specifying which link types you want to find.

Category HTML

function GetNextWindow

Description Provides the next window handle in a series of window handles that are all at the same logical level. It is used to move across a list of window handles.

Returns Handle Provides the handle of the next window in the stack or returns a value of 0 when another window cannot be found.

Category Window

function GetObject

Description Looks in the Windows Running Object Table for an instance of an application with the specified COM class name.

Returns Object

Param String/ApplicationName Program to find.

Category Object Model And MSAA

function GetObjectAtPoint

Description Uses MSAA to determine the object at a set of X/Y coordinates.

Returns Object The accessible object at the given point.

Param Int ref data.

Param Int The x coordinate.

Param Int The y coordinate.

Category Object Model And MSAA

function GetObjectAutomationId

Description Retrieves the UIA automation ID of an object in the focus hierarchy. This is much faster than using the UIA Script API.

Returns String the automation ID.

Optional

Param int/nLevel The object in the hierarchy to be used. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectClassName

Description Retrieves the UIA class name of an object in the focus hierarchy. This is much faster than using the UIA Script API.

Returns String the class name.

Optional

Param int/nLevel The object in the hierarchy to be used. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectContainerHelp

Synopsis Returns the description of an MSAA object's container

Description This function returns the AccDescription property of the container of an MSAA object if it has one.

Returns String AccDescription property of accessible object's container.

Category Object Model And MSAA

function GetObjectDescription

Description the description of the object with focus is returned. The value is returned as a string.

Returns String the MSAA description of the object with focus.

Optional

Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.

Param int/nLevel Which object in the hierarchy should be spoken. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectFromEvent

Synopsis retrieves an MSAA object from a window.

Description This function retrieves the specified MSAA object from the given window. This object is generated by an event.

Returns Object the MSAA object.

Param Handle/hWnd the window containing the Object.

Param Int/idObject the id of the object.

Param Int/idChild the id of the child.

Param Int/byRef/v.

Category Object Model And MSAA

function GetObjectHelp

Synopsis Returns the description of an MSAA object.

Description This function returns the AccDescription property of an MSAA object if it has one.

Returns String AccDescription property of accessible object.

Optional

Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.

Param int/Level Which object in the hierarchy should be spoken. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectIA2State

Description Gets the IA2 state of an object in the focus hierarchy.

Returns int the IA2 state bits of the nth object.

Optional

Param int/nLevel The object in the hierarchy to be used. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectIA2UniqueID

Description Gets the IA2 unique ID of an object in the focus hierarchy.

Returns int the IA2 unique ID of the nth object.

Param int/level The object in the hierarchy to be used. 0 refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectInfoByName

Description Given a window handle and the name of an objectt contained in that window, retrieves information about that object. In most cases, this information is obtained using MSAA. Using this function is much faster than directly using MSAA functions to walk the object hierarchy to find the object of interest and then querying the object for the equivalent information. Information is returned in byRef parameters. Not all information is available for all objects.

Returns int TRUE if function was successful, false on failure.

Param HANDLE/hwnd The window containing the object of interest

Param string/ObjectName The name of the object desired

Param int/nWhichOccurance If there is more than one object with this name, which one is desired. To retrieve the first occurance, pass in 1 as the value for this parameter.

Param int/byref/nSubtype On return will contain the object's subtype code.

Optional

Param int/byref/nState On return will contain the object's state flags. This will be a combination of Control Attribute identifiers defined in HJCONST.JSH.

Param String/byRef/Value On return will contain the object's value.

Param String/byRef/Description On return will contain the object's description.

Param String/byRef/HotKey On return will contain the object's HotKey

Param string/ContainerName On return will contain the name of the object that contains this object.

Category Object Model And MSAA

function GetObjectIsEditable

Description whether or not the object with focus is editable.

Returns int true or false according to whether the cursor is in an object which may be edited.

Category Object Model And MSAA

function GetObjectItemStatus

Description Retrieves the UIA ItemStatus property of an object in the focus hierarchy. This is much faster than using the UIA Script API.

Returns String the ItemStatus property

Optional

Param int/nLevel The object in the hierarchy to be used. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectItemType

Description Retrieves the UIA ItemType property of an object in the focus hierarchy. This is much faster than using the UIA Script API.

Returns String the ItemType property

Optional

Param int/nLevel The object in the hierarchy to be used. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectModuleId

Description Determines the type of module currently in focus. The module types are listed in HJConst.jsh.

Returns int One of the module ID type constants listed in HJConst.jsh.

Category Object Model and MSAA

function GetObjectMSAAState

Description Gets the MSAA state of an object in the focus hierarchy.

Returns int the MSAA state bits of the nth object.

Optional

Param int/nLevel The object in the hierarchy to be used. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model And MSAA

function GetObjectName

Description If the Pc Cursor is active, the name of the object with focus is returned. Otherwise, the name of the object at the position of the active cursor is returned. The value is returned as a string.

Returns String the name of the object at the position of the active cursor.

Optional

Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.

Category Object Model And MSAA

function getObjectNameFromEvent

Synopsis retrieves the name of an MSAA object from a window.

Description This function retrieves the name of the specified MSAA object from the given window. This object is generated by an event.

Returns String Object name, help or description (searched in that order).

Param Handle/hWnd the window containing the Object.

Param Int/idObject the id of the object.

Param Int/idChild the id of the child.

Category Object Model And MSAA

function GetObjectNameUnfiltered

Description Unconditionally obtains the name of the object with focus or one of it's ancestors. This is in contrast to GetObjectName which does not return the names of objects of type wt_unknown. Any Objects with MSAA role of Window get mapped to the JAWS type of wt_unknown, which means that it's impossible to use GetObjectName to get the names of windows in the focus hierarchy that don't have a more specific type because the names are returned as empty strings. GetObjectNameUnfiltered does not have the above limitation and provides this functionality without breaking legacy behavior.

Returns String the name of the object in the focus hierarchy.

Optional

Category Object Model And MSAA

function GetObjectPlaceholder

Description If the PC cursor is active, the placeholder value of the object with focus is returned. Otherwise, the placeholder value of the object at the position of the active cursor is returned.

Returns string The placeholder value of the object at the position of the active cursor.

Optional

Param int/alwaysUseMSAA If TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.

Param int/level Which object in the hierarchy should be spoken. 0, which is the default, refers to the object with focus. 1 refers to the parent of the focus object, 2 refers to the grandparent, etc.

Category Object Model and MSAA

function GetObjectProcessName

Description Retrieves process name for current object in cached focus.

Returns string Process name with extension

Category Object Model And MSAA

function GetObjectRect

Synopsis Retrieves the focus rectangle surrounding the object at the position of the active cursor.

Description Will return TRUE if the object has a focus rectangle, FALSE otherwise. This function takes four int parameters. Left, right, top and bottom. Declare, but do not initialize, the int variables for these parameters, as they are passed by reference.

Returns Int True if a focus rectangle was found surrounding the object, false otherwise.

Param Int/iLeft the value for the left-hand edge of the focus rectangle surrounding the object.

Param Int/iRight the value for the right-hand edge of the focus rectangle surrounding the object.

Param Int/iTop the value for the top edge of the focus rectangle surrounding the object.

Param Int/iBottom the value for the bottom edge of the focus rectangle surrounding the object.

Optional

Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.

Category Object Model And MSAA

Description Retrieves the subtype of the object located at the current cursor's location. Because the type is a string that differs across languages, this function should only be used when the objective is to speak the type of the object. GetObjectTypeCode should instead be used in all conditional statements because it provides a language independent solution.

Returns String The subtype of the object at the current cursor's location.

Category Object Model And MSAA

function GetObjectSubTypeCode

Description Retrieves the numeric subtype code of the object located at the current cursor's location. Constants for these type codes all begin with WT_ and are defined in HJCONST.JSH. The numeric values are the same for all languages of JAWS. Using this function in all conditional statements instead of using GetObjectType insures that these statements will function without change in multiple languages. The subtype code is more specific, i.e. a button can have the sub type of WT_CHECKBOX.

Returns Int The type of the object at the current cursor's location.

Optional

Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.

Param Int/nLevel Level of the object from which to get the type. 0 retrieves the type code for the object with focus; 1 refers to the parent, 2 the grand parent, and so on.

Category Object Model And MSAA

function GetObjectType

Description Retrieves the type of the object located at the current cursor's location. Because the type is a string that differs across languages, this function should only be used when the objective is to speak the type of the object. GetObjectTypeCode should instead be used in all conditional statements because it provides a language independent solution.

Returns String The type of the object at the current cursor's location.

Category Object Model And MSAA

function GetObjectTypeCode

Description Retrieves the numeric type code of the object located at the current cursor's location. Constants for these type codes all begin with WT_ and are defined in HJCONST.JSH. The numeric values are the same for all languages of JAWS. Using this function in all conditional statements instead of using GetObjectType insures that these statements will function without change in multiple languages.

Returns Int The type of the object at the current cursor's location.

Optional

Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.

Category Object Model And MSAA

function GetObjectValue

Description If the PC cursor is active, the value of the object with focus is returned. Otherwise, the value of the object at the position of the active cursor is returned. The value is returned as a string.

Returns String the value of the object at the position of the active cursor.

Optional

Param Int/AlwaysUseMSAA if TRUE, always obtains this information via MSAA, even in those situations where other methods would otherwise be used instead.

Category Object Model And MSAA

function GetOCRLanguages

Description These language codes can be used for primary or secondary OCR language settings.

Returns string a bell-char-delimited list of OCR languages

Category Optical Character Recognition

function GetOutputModeName

Synopsis retrieves a human friendly name for an output mode

Description This function retrieves a human friendly output mode name given an output destination. The names can be different for Speech and Braille. For instance, OT_HELP may have a speech name of Help Information while the Braille name might be hlp. this function is used primarily to retrieve an appropriate message to be shown in the Status cells of the Braille Display or prepended to a Flash message for displays with no status cells during the display of a Flash message. This makes it easier to determine where the message is coming from.

Returns string the human friendly name for the given output mode and destination.

Param int/iOutputType one of the OT constants from hjconst.jsh

Param int/IDestination one of the Output Type destinations from hjconst.jsh.

Category Misc

function GetParagraph

Synopsis Gets the paragraph at the cursor.

Description This function returns the text of the paragraph at the cursor.

Returns String The paragraph.

Category Screen Text

function GetParent

Description Determines which window created a specified child window. For Example, when a dialog box pops up, it could be used to determine the window handle of the window that created the dialog box. It can be used to move up through a list of window handles in order to get to a specific window.

Returns Handle This is the handle of the parent window.

Category Window

function GetPhraseByExample

Description Retrieves an example phrase of the supplied string.

Returns String The example phrase for the supplied string parameter.

Optional

Param String phrase to retrieve the example for, otherwise it uses the phrase at the current cursor.

Category IME

function GetPlaceMarkerCount

Synopsis Retrieves the number of PlaceMarkers on the current page or virtual document.

Description Returns the number of available PlaceMarkers on the active page. It does not determine whether or not they are valid.

Returns Int The number of PlaceMarkers found.

Category HTML Placemarkers

function GetPowerACLineStatus

Description Returns the Offline or Online status of AC power. The returned value is 0 for Offline, 1 for Online, or 255 if status is unknown.

Returns int Returns the Offline or Online status of AC power.

Category System

function GetPriorCharacter

Description If this function returns a null string, the cursor is at the beginning of the line.

Returns String the prior character from the cursor position.

Optional

Param Int/IncludeMarkup This optional parameter was added in JAWS 10.0. The default value for the parameter it FALSE. This parameter controls whether markup information is included when the text of the character is returned.

Category Screen Text

function GetPriorWindow

Description Provides the prior window handle in a series of window handles at the same logical level. It is used to move across a list of window handles.

Returns Handle Provides the handle of the prior window in the stack or returns a value of 0 when another window cannot be found.

Category Window

function GetPriorWord

Description gets the word prior to the cursor location without moving the cursor.

Returns string the prior word.

Optional

Param int/bIncludeMarkup FALSE by default.

Category Screen Text

function GetProgramVersion

Description This function returns the major version of an application. For example, if the full version was 3.00.62, Get ProgramVersion would return 3.

Returns Int An integer specifying the major version of the specified program.

Param string The path of the program for which you want the version. You can get the path by using GetAppFilePath.

Category Application Info

function GetProgressBarInfo

Synopsis Returns the handle and the name and value by reference of the first progress bar in the current real window.

Description This function returns the handle, the name and the value of the first progress bar in the current real window.

Returns handle the progress bar handle if any.

Param string/byRef/sName the prompt of the Progress Bar.

Param string/byRef/sValue the value of the progress bar as a percentage.

Category Dialog Controls

function GetProofreadingElementCount

Synopsis gets the number of spelling errors, grammatical errors or revisions in the current document

Description This function returns the number of spelling errors, grammatical errors or revisions in the current document.

Returns int the number of proofreading elements of the specified type.

Param int/nProofreadingElementType see hjconst.jsh for the proofreading element types, peSpellingError, peGrammaticalError, peRevision

Category Proofreading and Annotations

function GetProofreadingElementInfo

Synopsis Gets information about a proofreading element at the current cursor location

Description This function allows the scripter to obtain information about an element at the cursor such as the text, author, initials, type and date of the element (if relevant). Not all components are returned for all element types.

Returns int TRUE if info was obtained for the specified element type, FALSE otherwise

Param int/nProofreadingElementType see HJConst.jsh for types, prefixed by pe.

Param string/byRef/sText text of element

Param string/byRef/sAuthor author's name

Param string/byref/sInitials Author's initials

Param string/byref/sDesc extra descriptive information (such as revision type if element is a revision).

Param string/byref/date date of element creation (such as revision or comment date).

Category Proofreading and Annotations

function GetRangeInconsistencyByIndex

Synopsis obtains information about the specified inconsistency in the requested text range

Description This function obtains information about the inconsistency with the 0-based index in the specified text range at the cursor.

Returns int TRUE or FALSE.

Param int/nRange 0 line, 1 sentence, 2 paragraph

Param int/nIndex 0-based index of inconsistency in range for which you want information

Param int/nInconsistencyTypeFlags The type of inconsistencies bitwise ored together, see hjconst.jsh.

Param int/nPairedSymbolCategoryFlags the flags governing the paired symbols to check, see hjconst.jsh

Param int/byref/nTypeOfInconsistency The inconsistency type see hjconst.jsh

Param string/byref/sChars The characters of the inconsistency (eg the punctuation symbol, miscapitalized letter, etc).

Param int/byref/nOffset The offset of the inconsistency from the start of the specified text range.

Category Proofreading and Annotations

function GetRangeInconsistencyCount

Synopsis returns the number of inconsistencies in the specified text range at the cursor.

Description This function obtains the number of inconsistencies in the specified unit of text. The user can determine what kinds of inconsistencies are detected and thus counted.

Returns int The number of inconsistencies detected in the requested range at the cursor's location.

Param int/nUnit 0 line, 1 sentence, 2 paragraph

Param int/nInconsistencyTypeFlags The type of inconsistencies bitwise ored together, see hjconst.jsh.

Param int/nPairedSymbolCategoryFlags the flags governing the paired symbols to check, see hjconst.jsh

Category Proofreading and Annotations

function GetRealWindow

Description Moves up through the list of window handles in search of a real window. A real window is one that has a title.

Returns Handle Provides the handle of the real window.

Category Window

function GetRegionCount

Description Gets the number of regions of the indicated type. If no type is given, then a count of all types of regions is returned.

Returns int Count of regions of the indicated type or all region types if no type is specified.

Optional

Param Int/regionType one of the wt_typeCode constants.

Category HTML

function GetRegistryEntryDWORD

Synopsis Gets a DWORD entry of the registry, first parameter represents root key.

Description Use to get DWORD entries in registry.

Returns int registry entry, no error checking.

Param int 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE, 3=HKEY_USERS.

Param String/byRef/Name of SubKey

Param String/byRef/Name of Variable

Category System

function GetRegistryEntryString

Synopsis Gets a string entry of the registry, first parameter represents root key.

Description Use to get string entries in registry.

Returns string The string of entry, otherwise an empty string.

Param int 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE, 3=HKEY_USERS.

Param String/byRef/Name of SubKey

Param String/byRef/Name of Variable.

Category System

function GetRelationText

Description Using one of the relation constants specified in hjconst.h, retrieves text associated with the given relation. These relations are specified as part of the IAccessible2 interface.

Returns string Text associated with the requested relation.

Param int Relation type. Only one relation type at a time is valid for this function.

Category Object Model And MSAA

function GetReservedKeystrokes

Description Returns the keystrokes reserved by the currently active web application. This delimited string consists of key;item pairs, where key is the keystroke and item is its action as described by the web application. For example, key;item \n.

Returns String A delimited string containing the keystrokes reserved by the currently active web application in the format keystroke;action \n.

Category Keyboard

function GetRestriction

Description Gets the restriction value for the current cursor. These values are located in HjConst.jsh and start with Restrict.

Category Cursors

function GetRestrictionName

Description Says the current level of restriction for the active cursor. All cursors besides the PC cursor can have their restriction changed.

Returns Void

Param Int/nRestriction The first parameter requires a constant indicating the current level of cursor restriction. The function GetRestriction can provide a constant for this value.

Category Cursors

function GetRibbonStatus

Synopsis returns the state, active tab (if any), active group (if any) and group description (if any).

Description This function returns the status and descriptive information about the Microsoft Ribbon in the current application. It will work with and without the virtual ribbon enabled; but, with the virtual ribbon enabled, unless the real focus is on a lower ribbon item, it will not obtain lower ribbon information when the virtual cursor is reviewing lower ribbon objects since they don't really have focus.

Returns int TRUE or FALSE, depending on whether the ribbon data was obtained for the currently focused application.

Param int/byref/RibbonState The state is 0 when the focus is not in the ribbon but the ribbon is expanded, 1 the focus is in the upper ribbon, 2 the focus is in the lower ribbon, 3 the ribbon is collapsed. If the state is 0, 1 or 2, the ribbon is expanded, if it is 3, it is collapsed.

Param string/byref/tabName The name of the active tab if the upper or lower ribbon has focus.

Param string/byref/groupName The name of the lower ribbon group if a lower ribbon group item has focus.

Param string/byref/groupDesc The description of the group of the lower ribbon item with focus.

Category Window

function GetRichEditDocument

Description Gets a pointer to the ITextDocument interface of the document in the specified window. This only works for windows of class RichEdit20A or RichEdit20W. The ITextDocument Interface allows access to the object model of RichEdit documents in a similar manner to the MSWord object model. For more details, search Microsoft Developer Network for "Text Object Model."

Returns Object A pointer to the ITextDocument interface.

Optional

Param Handle/hRichEdit The handle to the window of interest. It defaults to the window with focus.

Category Object Model and MSAA

function GetRightLeaf

Synopsis Traverses the window tree to find the right-most leaf window, starting from the specified root window.

Description Traverses the window tree to find the right-most leaf window, starting from the specified root window.

Returns handle The right-most leaf window handle.

Param handle The starting window handle, the root position.

Param string ByRef The string describing the path from the root to the leaf.

Param int ByRef The hierarchical x position of the leaf window.

Param int ByRef The hierarchical y position of the leaf window.

Category Utility

function getRoleText

Synopsis Retrieves the localized description of an MSAA role.

Description This function retrieves the description of an MSAA role. MSAA roles can be retrieved by accessing the accRole property of an MSAA object. This function is equivalent to the GetRoleText function in the MSAA SDK.

Returns String The text describing the role.

Param int/sRole The role constant to describe. This should be obtained from the accRole property of an MSAA object.

Category Object Model And MSAA

function GetRowHeader

Description When in a table or spreadsheet, gets the contents of the row header.

Returns String Provides the header of information.

Optional

Param Int/iMarkedHeader Include only headers that are marked in the table

Category Tables

function GetRowSpanInfo

Description When in a table on the web, gets position of the current cell in a rowspan and the total number of cells in the span.

Returns int True if the function succeeded, false otherwise.

Param int/byref/posInSpan When the function returns, contains the position in the span of the current cell.

Param int/byref/totalSpan When the function returns, contains the total number of rows spanned by the rowspan cell.

Category Tables

function GetRowText

Synopsis Gets the text of a range of cells on the current row of a table.

Description This function gets the text of a range of cells on the current row of a table. You can specify the separator string to use between data elements, whether or not to include the coordinates of the active cell immediately before that cell's data and the start and end columns to include.

Returns String The text of the included cells.

Optional

Param String/lpszSeparator string to insert between cell data, defaults to a single space.

Param String/lpszBlankCellText the text to be displayed if the cell is blank.

Param Int/nStartCol the starting column, defaults to the first column (1) of the row.

Param Int/nEndCol the ending column, defaults to the last column of the row.

Category Tables

function GetRowTextAsArray

Description Returns an array where each element is the text of a cell in the specified range. For example, if you request the entire row, there will be an element for each cell in the row. If you only request cells 3 to 5, there will be three elements, the first for column 3, the 2nd for 4 and the third for 5. In this case you will need to take note of the starting column requested if you wish to map this back to the entire row.

Returns stringArray the array of cells.

Optional

Param int/startCol Defaults to the first column.

Param int/endCol Defaults to the last column.

Category Tables

function getRunningFSProducts

Description Returns a bit field listing the running products. Valid options are product_JAWS, product_MAGic, or product_OpenBook

Returns int The bit field listing the running products.

Category FS Product Info

function GetScreenEcho

Description Obtains the current screen echo setting. The screen echo setting determines the amount of information that is to be read as the information is displayed on the desktop. The Say NonHighlighted text and Say Highlighted text functions often check the setting for screen echo before deciding how much information to speak.

Returns Int "ECHO_NONE" = 0, "ECHO_HIGHLIGHTED" = 1, "ECHO_ALL" = 2.

Category Screen Text

function GetScreenXML

Description This function obtains screen content as XML which may be processed by the Microsoft MSXML Com Object. To use this XML, you will first need to create an object instance to Microsoft's XML Com interface. Use the following: CreateObject("msxml2.DOMDocument.6.0"), or take a look at HomeRowUIAObject.jss for code examples using XML.

object function GetUIAXMLObject(string UIAInfoXMLString)
var
    object oMSXML,
    object o
if !UIAInfoXMLString then
    return Null()
EndIf
let oMSXML = CreateObject("msxml2.DOMDocument.6.0")
if !oMSXML then
    if InHomeRowMode() then
        Say(msgErr_NoXMLObject,ot_error)
    EndIf
    return Null()
EndIf
oMSXML.async = false
oMSXML.resolveExternals = false
oMSXML.loadXML(UIAInfoXMLString)
let o = oMSXML.SelectNodes("/item")
if !o then
    if InHomeRowMode() then
        say(msgErr_NoItemsInXMLObject,ot_error)
    EndIf
    return Null()
EndIf
return o.item(0)
EndFunction

Optionally, do a search on the Internet for help on data members for the Microsoft XML object.

Returns string The screen content as XML.

Optional

Param int left

Param int top

Param int right

Param int bottom

Category Screen Text

function GetScriptAssignedTo

Description Looks up the name of the script assigned to the specified key or gesture.

Returns string If the key or gesture name is assigned to a script, the name of the script to which it is assigned; null otherwise.

Param string the key or gesture name for which the script assignment is to be determined.

Category Scripts

function GetScriptCallStack

Synopsis Retrieves the names and parameters of all scripts and functions currently executing.

Description Information is ordered from most recent to least recently called items.

Returns string The contents of the call stack.

Category Scripts

function GetScriptDescription

Description Retrieves the description of a specified script.

Returns String The text of the description.

Param string The script name of interest.

Optional

Param int As of JAWS 14, if true, retrieves the script description from default.jsd.

Category Scripts

function GetScriptFileName

Description Retrieves the name of a currently active default or application script file. For the application script file, this is the same as the executable file name of the application, except in those cases where the originally loaded application script file replaced itself with another one by me and of SwitchToScriptFile. Similarly, for the active default script file, this is the name specified in JFW.INI, except in those cases where the original file replaced itself by means of SwitchToScriptFile.

Returns String The name of the script file. This name can be blank if requesting the application script file name and no application script file is loaded.

Param Int/WantAplication True to obtain the name of the application script file, False to obtain the name of the default script file.

Category Scripts

function GetScriptKeyName

Description Retrieves the name of the key attached to the specified script.

Returns String The key name.

Param string The name of the script.

Category Scripts

function GetScriptKeyNames

Description Retrieves a \r \n delimited list of the names of all the keys that are assigned to the specified script.

Returns String A \r \n delimited list of the names of all the keys that are assigned to the specified script.

Param string The name of the script.

Category Scripts

function GetScriptPerformanceHistory

Description Obtains the Script Performance History.

Returns string

Category Misc

function GetScriptSynopsis

Description Retrieves the synopsis of a specified script.

Returns String The text of the synopsis.

Param string The script name of interest.

Optional

Param int As of JAWS 14, if true, retrieves the script synopsis from default.jsd.

Category Scripts

function GetScrollBarInfo

Description Retrieves information about a ScrollBar

Returns int The current position of the thumb on the ScrollBar

Param Handle/hWnd handle to a ScrollBar window or NULL to use the window containing the active cursor

Param int/byref/MinValue the minimum value of the ScrollBar

Param int/byref/MaxValue the maximum value of the ScrollBar

Category Window

function GetSecondaryFocusSelectionGroupPosition

Description Retrieves the position in group information for the selected item at the secondary focus.

Param int/setLevel/ByRef The level of set in the secondary focus.

Param int/sizeOfSet/ByRef The count of items in the secondary focus.

Param int PositionInSet/ByRef The index of the selected item in the secondary focus.

Category Secondary Focus Events and Helpers

function GetSecondaryFocusSelectionText

Description Retrieved the selected text in the secondary focus.

Returns string The selected text in the secondary focus.

Category Secondary Focus Events and Helpers

function GetSelectedCellsAsArray

Description Returns an array where each element is the text of a cell in the selected range. Note this only works in selected apps supporting the selection of cells.

Returns stringArray the array of selected cells.

Optional

Param int/byref/startCol

Param int/byref/startRow

Param string/byref/startColName

Param int/byref/endCol

Param int/byref/endRow

Param string/byref/endColName

Category Selection

function GetSelectedText

Description Retrieves the currently selected text.

Returns String Provides the selected text.

Optional

Param int/bWantMarkup JAWS 6.0, specify true if you want the text to contain speech markup, defaults to false if not specified.

Param int/bWantAllListViewItemText Set when you want to get all the text for a ListView item across multiple columns. When not set you will only get the text in the first column.

Category Selection

function GetSelectionContext

Synopsis Returns a bit pattern of flags indicating items present at the caret or within the current selection.

Description This function returns the currently detected items at the caret or in the selection as determined by the flags set in SetSelectionContextFlags. For instance, if selCtxSpellingErrors is set, and there is a spelling error at the caret location, this flag will be set in the result returned by this function.

Returns int a bit pattern of the detected items at the caret or within the selection.

Category Speech Markup

function GetSelectionContextFlags

Synopsis Returns the flags set by SetSelectionContextFlags which will determine which items will be detected during document navigation.

Description This function enables the user to determine which flags are currently set and thus which items will be detected during document navigation.

Returns int The flags set by SetSelectionContextFlags.

Category Speech Markup

function GetSentence

Synopsis Gets the sentence at the cursor.

Description This function returns the text of the sentence at the cursor.

Returns String The sentence.

Category Screen Text

function GetSettingsCenterControlDisabledReason

Description Used to retrieve a help message for a disabled Settings Center control, explaining why the control is disabled.

Returns String The help message explaining why the control is disabled.

Param handle The dialog page or a spawned dialog, and where the specified control is located.

Param handle The handle of the disabled control who's disabled reason is to be retrieved.

Category Settings

function GetSettingsCenterControlHelp

Description Retrieves the help text belonging to a specified control in the JAWS Settings Center.

Returns string The help message for the specified control.

Param handle The dialog page or a spawned dialog, and where the specified control is located.

Param handle The control who's help string is to be retrieved.

Category Settings

function GetSharedScriptsDirectory

Description Retrieves the full path to where shared scripts reside.

Returns String The full path without a trailing backslash.

Optional

Param int/LanguageSpecific TRUE to include the language code as part of the path, FALSE otherwise.

Category JAWS Program

function GetSharedSettingsDirectory

Description Retrieves the full path to the shared settings directory currently in use. This depends on which language is being used.

Returns String The shared drive and settings directory without a trailing .

Category JAWS Program

function GetSpeechHistory

Description Obtains the Speech History either as plain text or HTML.

Returns string Either plaintext or HTML of speech history.

Optional

Param int true for HTML, false for plain text. The default is to plain text.

Param string if requesting HTML, the title of the HTML.

Category Speech History

function GetSpellString

Description Adds spaces between characters in a string so that saying the string will result in the characters being spelled out.

Returns String

Param String/sText

Category Strings

function GetStringWidth

Synopsis Returns the length of the string in the given font.

Description This function returns the length of the string in units of 1/100 of an inch using the given font.

Returns Int length of the string in 1/100 of an inch.

Param String/sString The string to be measured

Param String/sFontName the name of the font

Param Int/iPointSize The size in points of the font.

Param Int/iBold True if the font is bold.

Param Int/iItalic True if the font is italic.

Param Int/iUnderline True if the font is underlined.

Param Int/iStrikeout True if the font is strikeout.

Category Text Format

function GetSynthLanguages

Synopsis Retrieves a list of the installed synthesiser languages .

Description This function retrieves a list of the currently active synthesisers supported languages.

Returns String the list of synthesiser languages.

Param String/sDelim the delimiter to use to separate the languages in the list.

Category Voices

function GetSynthPitchRange

Description Assigns the minimum and maximum possible pitch settings to the parameters taken by reference.

Returns Void

Param Int/Min/ByRef Type the variable to receive the minimum pitch seting for your synthesizer.

Param Int/Max/ByRef Type the variable to receive the maximum pitch setting for your synthesizer.

Category Voices

function GetSynthRateRange

Description Returns by reference the coordinates and names of the first and last cells in a selection.

Param int/byRef/StartRow

Param int/byRef/StartCol

Param string/byRef/StartName

Param int/byRef/EndRow

Param int/byRef/EndCol

Param string/byRef/EndName

Category Tables

function GetTableSummary

Description If a table has a summary then this function returns it.

Returns String The Table Summary.

Category Tables

function GetTagIndex

Synopsis Returns the 1-based index of the current tag.

Description This function returns the 1-based index of the current tag. Note that invisible tags are not counted. If the cursor is not within the specified tag, returns 0.

Returns Int the 1-based tag index or 0.

Param string/sTag the tag whose index is required.

Category HTML

function GetTagWithAttributeIndex

Synopsis Returns the 1-based index of the current tag/attribute specified.

Description This function returns the 1-based index of the current tag/attribute supplied, the tag maybe empty in which case the current element or one of its ancestors must have the supplied attribute. Note that invisible tags are not counted. If the cursor is not within the specified tag/attribute, returns 0.

Returns Int the 1-based tag index or 0.

Param string/sTag the tag whose index is required (maybe empty).

Param string/sAttribute the attribute which must be present.

Optional

Param int/bAllowNesting whether tag/attribute elements may be nested. This will affect the index so the same value of this parameter must be present for related getTagWithAttributeXX functions for results to be correct.

Category HTML

function GetTestRunner

Description Used for internal testing. Returns a handle to a test object that will be used to run automated tests.

Returns Handle A handle to the test runner.

Category Test

function GetTextBetween

Description Gets the text between two horizontal points on the screen.

Returns String The text located between the two pixel locations.

Param Int/left coordinate of left edge of text to retrieve.

Param Int/right coordinate of right edge of text to retrieve.

Optional

Param Int/CoordinateSystem The Coordinate System to be used to interpret left and right. The default is to interpret them as pixel locations on the screen. See the COORDSYS_xxx constants in hjconst.jsh.

Category Screen Text

function GetTextFromClipboard

Synopsis Retrieves Text from Windows Clipboard.

Description Retrieves plain text from clipboard.

Returns String

Category Clipboard

function GetTextInFocusRects

Description Retrieves the contents of all focus rectangles into a single buffer.

Returns String The contents of the focus rectangles.

Param Handle Handle of window.

Category Window

function GetTextInFrame

Description Retrieves the text inside a specified frame.

Returns String The frame contents.

Param String/FrameName The name of the frame desired.

Optional

Param Int/bAddLineBreaks whether or not to add line breaks or to get the text as one long string.

Category Frames

function GetTextInRect

Description This function gets text inside a rectangle specified by four points on the screen representing the top, bottom, left, and right boundaries of the rectangle.

Returns String Text inside the rectangle.

Param Int/Left Left edge of rectangle.

Param Int/Top top edge of rectangle.

Param Int/Right right edge of rectangle.

Param Int/Bottom bottom edge of rectangle.

Optional

Param Int/Attributes attributes of text to include. Use 0 to include all text or use a combination of attribute flags to only return text with those attributes.

Param Int/textColor color of text to include, use IgnoreColor constant for any color.

Param Int/backgroundColor background color of text to include.

Param Int/bIncludeLineBreaks Whether or not to add line breaks or to get the text as one long string.

Category Window

function GetThePartOfLineThatChanged

Description Given two strings of text which start with the same text, and where the new string contains additional text at the end which was not present in the old text, returns the newly added text. This is not a StringDiff, rather it is a function to detect newly added text at the end of a string of text.

Returns string The newly added text at the end of a string of old text.

Param string the new text which starts with the same text as the old text, but which may have additional text following the old text.

Param string The old text.

Category Strings

function GetTickCount

Description Retrieves the amount of time that has passed since Windows was started.

Returns Int Number of milliseconds that have passed since Windows was started.

Category System

function GetToEndOfLine

Description Retrieves text on the current line that is located to the right of the current cursor.

Returns String the text to the right of the current cursor.

Category Screen Text

function GetTopLevelWindow

Description Similar to GetAppMainWindow. These two functions differ however in that GetAppMainWindow will always return the handle for the main window of the application. In contrast, the GetTopLevel function can be used within dialog boxes to return the handle of the main dialog window when there may be several child windows which are also real windows. This can be useful when the GetRealWindow function does not return the handle of the main dialog. A real window refers to a window with a title.

Returns Handle The handle of the TopLevel window, as opposed to the AppMainWindow.

Category Window

function GetTreeInfo

Synopsis Used by TreeCapture script to traverse the window tree and retrieve informatin about each window in the tree.

Description Used by TreeCapture script to traverse the window tree and retrieve informatin about each window in the tree.

Returns string The collected technical information about all windows in the tree.

Param handle The starting window, the root of the window tree to be traversed.

Category Utility

function GetTreeViewLevel

Description Obtains the indent level of the item in a tree view that has focus. The root of the tree has the level 0.

Returns Int The level of the item with focus.

Category Dialog Controls

function GetTypeAndTextStringsForObject

Synopsis Uses MSAA to retrieve information about an MSAA object & it's children.

Description Information about each control is similar to that obtained from SayObjectTypeAndText. The order in which items appear is dictated by how they appear in the MSAA hierarchy.

Returns String The contents of the MSAA object hierarchy excluding certain control types.

Param object The object for which the information is to be retrieved.

Optional

Param int/includeInvisibleNodes TRUE if the function should retrieve text for invisible nodes.FALSE if invisible node text should be excluded. The default is true.

Category Object Model and MSAA

function GetTypeAndTextStringsForWindow

Synopsis Uses MSAA to retrieve information about a window & it's children

Description Information about each control is similar to that obtained from SayObjectTypeAndText. The order in which items appear is dictated by how they appear in the MSAA hierarchy.

Returns String The contents of the window

Param handle/Window The window containing the controls to be queried.

Category Object Model and MSAA

function GetUserDefaultLang

Description Gets the three letter abbreviation of the Default language of the Windows User Interface for the user that is currently logged into the system.

Returns String Returns a string containing the three letter abbreviation of the Default language of the Windows User Interface for the user that is currently logged into the system.

Category System

function GetUserLocaleInfo

Synopsis Gets User Locale specific information.

Description this function returns User specific Locale information. You determine what information to return by providing an identifier defined in locale.jsh as a parameter to this function.

Returns String the Locale specific information..

Param Int/iLocaleCType see constants defined in locale.jsh.

Category System

function GetUserSettingsDirectory

Description Retrieves the full path to the user settings directory currently in use. This depends on which language is being used.

Returns String The user drive and settings directory without a trailing .

Category JAWS Program

function GetVariantType

Description Determines the type of a variable. Useful with determining the type of collection members, or variables of type variant.

Returns int An integer designating the type of variable, see hjConst.jsh for the values of the different variable types.

Param variant The variable whose type you want to get.

Category Misc

function GetVerbosity

Description Used to obtain the current setting for verbosity. It returns a constant value to indicate the setting: Beginner means speak maximum information, Intermediate means speak a moderate amount of information, and Advanced means speak a minimum amount of information. These values can be used in If...Then...Else...statements.

Returns Int "BEGINNER" = 0, "INTERMEDIATE" = 1, "ADVANCED" = 2.

Category Settings

function GetVersionInfoString

Description GetVersionInfoString gets a requested string from the version table of an application.

Returns String The requested string.

Param string The path of the program for which you want the information. You can get the path by using GetAppFilePath.

Param string Identifier string specifying which piece of information is requested. Identifiers must be contained within quotation marks. You can use the following identifiers: Comments, CompanyName, FileDescription, FileVersion, InternalName, LegalCopyright, LegalTrademarks, OriginalFilename, PrivateBuild, ProductName, ProductVersion, or SpecialBuild.

Category Application Info

function GetVoiceParameters

Description Retrieves the parameters for the voice context you specify. These include Volume, Rate, Pitch, Punctuation and person.

Returns Void

Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.

Param Int/volume/ByRef Type the variable to receive the voice volume setting.

Param Int/Rate/ByRef Type the variable to receive the voice rate setting.

Param Int/Pitch/ByRef Type the variable to receive the voice pitch setting.

Param Int/Punctuation/ByRef Type the variable to receive the voice punctuation setting.

Param String/Person/ByRef Type the variable to receive the voice person setting.

Category Voices

function GetVoicePerson

Description Using the Voice Context name, the person for the active voice is returned.

Returns String The current voice person setting.

Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.

Optional

Param Int/iSaveWhere This parameter is optional. Setting a value of true, saves the voice settings to the application file. The default is to save it in the default.jcf.

Category Voices

function GetVoicePitch

Description Using the Voice Context name, the pitch setting for the active voice is returned.

Returns Int The current voice pitch setting.

Param String/VoiceContextName The name of the voice context as defined in HjConst.jsh with the prefix VTX_.

Optional

Param Int/iSaveWhere This parameter is optional. Setting a value of true, saves the voice settings to the application file. The default is to save it in the default.jcf.

Category Voices

function GetVoiceProfileCount

Description Returns the count of available voice profiles.

Description Assigns the minimum and maximum possible volume settings to the parameters taken by reference.

Returns Void

Param Int/Min/ByRef Type the variable to receive the minimum volume setting for your synthesizer.

Param Int/Max/ByRef Type the variable to receive the maximum volume setting for your synthesizer.

Category Voices

function GetWindowAtPoint

Description Gets the handle of the window at the specified point. For example, this function can be used with MouseMovedEvent to get the handle of the window containing the mouse pointer.

Returns Handle The handle of the window at the point specified by x and y. The value is 0 if a valid window handle is not found.

Param Int/x The horizontal (x) value of the point.

Param Int/y The vertical (y) value of the point.

Category Window

function GetWindowBottom

Description Gets the screen coordinate for the bottom of the window of interest.

Returns Int Screen coordinate of bottom edge of window.

Param Int Handle of window of interest.

Category Window

Description Gets the screen coordinate for the left of the window of interest.

Returns Int Screen coordinate of left edge of window.

Param Int Handle of window of interest.

Category Window

function GetWindowName

Description Obtains the title of the specified window, such as for a main application window, dialog box, or document window. Not all windows have titles.

Returns String Provides the title of the window when a title is present. When a title is not present, the null value of " ," is returned.

Param Handle Type the name of a variable or choose a script function to specify the window handle title that is desired.

Category Window

function GetWindowOwner

Synopsis Retrieves the name of the application which owns the window.

Description If possible, retrieves the name, including the full path, to the application which owns the window.

Returns string the path and name of the owning application, or null if the application could not be determined.

Param handle Type the name of a variable or choose a script function to specify the window handle title that is desired.

Category Window

function GetWindowRect

Description Gets the bounding rectangle of the window whose handle is specified.

Returns Int TRUE if the bounding rectangle is successfully retrieved.

Param Handle/hwnd The handle of the window for which the rectangle is requested. GetFocus can be used to return this value.

Param Int/nLeft The left edge of the bounding rectangle after the function is called.

Param Int/nRight The right edge of the bounding rectangle after the function is called.

Param Int/nTop The top edge of the bounding rectangle after the function is called.

Param Int/nBottom The bottom edge of the bounding rectangle after the function is called.

Category Window

function GetWindowRight

Description Gets the screen coordinate for the right of the window of interest.

Returns Int Screen coordinate of right edge of window.

Param Int Handle of window of interest.

Category Window

function GetWindowsOS

Description Provides information about which operating system is being used.

Returns Int One of the constants OS_WIN95 or OS_WIN_NT. These constants are defined in HJCONST.jsh.

Category System

function GetWindowsSystemDirectory

Synopsis Returns the current Windows System directory.

Description Returns the path to the Windows System directory as a string.

Returns String the path to the current Windows System Directory.

Category System

function GetWindowStyleBits

Synopsis Returns the Window style bit flags.

Description This function returns the window style bit flags. See the WS constants in the standard winUser.h.

Returns Int the bit flags.

Param Handle/hWnd the window whose style bits are required.

Category Window

function GetWindowSubtypeCode

Description Obtains the window subtype code number for the specified window. This function is similar to GetWindowTypeCode, but attempts to be even more specific. If no more specific information is available, returns the same thing as GetWindowTypeCode. For example, Calling GetWindowTypeCode using the window handle for the Taskbar would return WT_TABCONTROL, and calling GetWindowSubtypeCode would return WT_TASKBAR, a more specific type of tab control. See the documentation for GetWindowTypeCode for more details.

Returns Int The window subtype number for the specified window.

Param Handle This function provides information for the window that is identified by a window handle. Type a variable name or choose a script function to provide the window handle it needs.

Optional

Param int/AlwaysUseOSM TRUE to never use the DOMServer to obtain this info

Category Window

function GetWindowText

Description Retrieves the text contained in a window.

Returns String The retrieved text.

Param Handle/hwnd The handle of the window containing the requested text. GetFocus can be used to return this value.

Param Int/bHighlightOnly TRUE if only highlighted text is requested, otherwise FALSE.

Category Window

function GetWindowTextEx

Description Retrieves the text contained in a window. It functions similar to GetWindowText but allows you to select whether or not to retrieve the text in all child windows.

Returns String The retrieved text.

Param Handle/hwnd The handle of the window containing the requested text. GetFocus can be used to return this value.

Param Int/bHighlightOnly Enter TRUE if only highlighted text is requested, otherwise FALSE.

Param Int/bIncludeChildren Enter TRUE if text within child windows should be included, FALSE if only text from this window should be retrieved.

Optional

Param Int/bInhibitNewTextEvent Enter TRUE to inhibit NewTextEvent's for any new strings returned by this function that have not yet triggered a NewTextEvent. Enter FALSE if this function should not affect NewTextEvent's. The default is TRUE. (Available as of JAWS 10.0 Update 1)

Category Window

function GetWindowTop

Description Gets the screen coordinate for the top of the window of interest.

Returns Int Screen coordinate of top edge of window.

Param Int Handle of window of interest.

Category Window

function GetWindowType

Description Obtains the window type name of a window. Most standard windows (non SDM windows) have a window type name and a window class name. Examples of window types are: static text, edit field, check box, radio button, etc. The same window type names are commonly used in many different Windows applications.

Returns String The string is the window type.

Param Handle This function provides information for the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide the window handle it needs.

Category Window

function GetWindowTypeCode

Description Obtains the window type code number for the specified window. These numbers are the same for English and non-English versions of JAWS. Many window type numbers have constant values assigned to them in the file HJCONST.JSH. The GetWindowType function returns these constants instead of the window type number.

Returns Int The window type number for the specified window.

Param Handle Type a variable name or choose a script function to provide the window handle it needs.

Optional

Param int/AlwaysUseOSM TRUE to never use the DOMServer to obtain this info

Category Window

function GetWord

Description Copies the word where the active cursor is positioned. The copied text can then be used by other script functions

Returns String Provides a word.

Category Screen Text

function GetWordInContext

Description When in a spell check, find, or replace dialog, this function gets the line of text from within a document that contains the active word in the dialog. Used, for example, to speak the context of a particular word which the spell check dialog thinks is misspelled.

Returns String Provides a line of text containing the word in question.

Category Screen Text

function GetWordList

Synopsis retrieves a list of unique words for the current paragraph or document

Description This function retrieves a word list (with optional occurance counts for words which occur more than once) for the current paragraph or document.

Returns string The delimited list of words with an optional occurrence count in parentheses after each word which occurs more than once.

Optional

Param string/sDelim the delimiter to use to separate each list item (defaults to the LIST_ITEM_SEPARATOR defined in hjconst.jsh).

Param int/bIncludeOccurrenceCounts TRUE to include the occurance count for words occurring more than once in the paragraph or document (defaults to FALSE).

Param int/bObtainListForParagraphOnly TRUE to only obtain the word list for the current paragraph, FALSE to retrieve the list for the entire document (defaults to FALSE).

Category Screen Text

function GotoLineNumber

Synopsis Moves the cursor to the specified line number in virtual documents.

Description this function moves the cursor to the specified line number in a virtual document.

Returns Int true if the line was successfully moved to, false otherwise.

Param Int/nLine the line number (starting at 1).

Category Navigation

function GrantAppContainerAccess

Synopsis Grants app container access to a fully qualified file such as a personalized web settings file

Description In Windows 8 and higher, with Enhance Protected Mode enabled, IE always runs so that it can't access files for which access hasn't explicitly been granted to the AppContainer user. This function allows applications running in App Container mode to read from JSI or other files.

Returns int TRUE if the access was granted, FALSE otherwise.

Param string The fully qualified name of the file.

Category System

function GraphicsEnumerate

Description For every graphic contained within a specific window, calls a specified function, passing it the coordinates of the graphic.

Returns Int Count of the number of graphics enumerated.

Param Handle/hwnd The handle of the window containing the graphics of interest.

Param String/strFunctionName The name of the function to be called with information about each graphic in the window. This function should return TRUE if the enumeration is allowed to continue, FALSE if the enumeration should stop immediately. This function should be defined as: int Function SomeName(int nLeft,int nTop,int nRight,int nBottom).

Category Graphics

function GraphicsLabeler

Description Starts the graphics labeler utility that is used to label graphic symbols. The JAWS cursor must be positioned on the graphic symbol that you wish to label before this function is used.

Category Graphics

function GraphicsListHelper

Description Assists the GraphicsList function in creating a string delimitted list of graphics labels.

Category Graphics

function GraphicsShow

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function GraphicsVerbosity

Synopsis Toggles between the graphics verbosity levels.

Description Graphics Verbosity can be set to All Graphics, Labeled Graphics, or No Graphics.

Returns String description of value to be displayed as value of Graphics Verbosity.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category Graphics

function HasFocusRect

Description Determines if the specified window has a focus rectangle (Not implemented currently).

Synopsis Toggles the verbosity for Button elements.

Description Toggles the verbosity for buttons between title, screen text/label, alt, value and longest.

Returns String description of value to be displayed as value of HTML button text verbosity item.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLDecrementLinesPerPageItem

Synopsis Decreases lines per page while in virtual cursor mode.

Description Decreases the number of lines used when the page up or page down is used in virtual cursor mode.

Returns String description of value to be displayed as value of HTML decrement lines per page option.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLDecrementMaxBlockLength

Synopsis Decrements the Max Block Length setting by 10.

Description This keystroke is used to decrement the max block length by 10 in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. This keystroke uses a minimum value of 0. If a successful change in the block length would result in a maximum block length of 0 or less, this value is reset to 255.

Returns String description of value to be displayed as value of HTML decrement max block length.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLDecrementMaxLineLength

Synopsis Increments the Max Line Length setting by 10.

Description This keystroke is used to increment the max line length by 10 in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. This keystroke uses a minimum value of 0. If a successful change in the line length would result in a maximum line length of 0 or less, this value is reset to 255.

Returns String description of value to be displayed as value of HTML decrement max line length.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLFrameIndicationToggle

Synopsis Toggles the Frame Indication Setting.

Description This keystroke is used to toggle the Frame Indication setting in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. The possible values for this JCF option are Give No indication of Frame Change, Say the name of the frame at the beginning and end of each frame, Say New Frame at the beginning of each frame.

Returns String description of value to be displayed as value of HTML frame indication option.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLGraphicReadingVerbosityToggle

Synopsis Toggles the verbosity for image elements.

Description Toggles the verbosity for reading HTML Graphics from longest, OnMouseOver, title and alt tag.

Returns String description of value to be displayed as value of HTML Graphics Reading verbosity item.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIdentifyLinkTypeToggle

Synopsis Toggles the HTML Identify Link Type Setting.

Description This keystroke is used to toggle the identification of link type in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. The possible values for this JCF option are identify link type enabled and nce link only.

Returns String description of value to be displayed as value of HTML link type.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIdentifySamePageLinksToggle

Synopsis Toggles the Identify Same Page Link Setting.

Description This keystroke is used to toggle the identification of same page links in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. The possible values for this JCF option are identify same page links on and identify same page links off.

Returns String description of value to be displayed as value of HTML Same Page Links item.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIncludeGraphicsToggle

Synopsis Toggles the HTML Include Graphics Settings.

Description This keystroke is used to toggle the graphics verbosity setting in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. The possible values for Include HTML Graphics are Labeled, None, and All.

Returns String description of value to be displayed as value of HTML Graphics Toggle.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIncludeImageMapLinksToggle

Synopsis Toggles the HTML Include Image Map Links Setting.

Description This keystroke is used to toggle the Image Map link verbosity setting in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. The possible values for this JCF option are never include image map links, include image map links that have labels, include all image map links.

Returns String description of value to be displayed as value of HTML Image Map Level.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIncludeLinksToggle

Synopsis Toggles the HTML Include Graphical Links Setting.

Description This keystroke is used to toggle the graphical link verbosity setting in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. The possible values for this JCF option are never include graphical links, include graphical links that have labels, and include all graphical links.

Returns String description of value to be displayed as value of HTML Links Level.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIncrementLinesPerPageItem

Synopsis Increases lines per page for virtual cursor mode.

Description Increases the lines per page that is used when the user uses the page up and page down in virtual cursor mode.

Returns String description of value to be displayed as value of HTML increment lines per page.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIncrementMaxBlockLength

Synopsis Increments the Max Block Length setting by 10.

Description This keystroke is used to increment the max block length by 10 in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. This keystroke uses a maximum value of 255. If a successful change in the maximum block length would result in a maximum block length of 155, this value is reset to 10.

Returns String description of value to be displayed as value of HTML increment max block length.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIncrementMaxLineLength

Synopsis Decrements the Max Line Length setting by 10.

Description This keystroke is used to decrement the max line length by 10 in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. This keystroke uses a minum value of 0. If a successful change in the line length would result in a maximum line length of 0 or less, this value is reset to 255.

Returns String description of value to be displayed as value of HTML increment max line length.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIndicateBlockQuotes

Synopsis Toggles whether or not block quotes are indicated in Virtual Cursor.

Description Turns on or off the Block Quotes indication.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIndicateElementAccessKeys

Synopsis Toggles whether or not element Access Keys are indicated in Virtual Cursor.

Description Turns on or off the Element Access Keys indication.

Returns String description of value to be displayed as value of Indicate Element Access Keys option.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLIndicateLists

Synopsis Toggles whether or not lists are indicated in Virtual Cursor.

Description Turns on or off the lists indication.

Returns String description of value to be displayed as value of Indicate lists option.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLScreenFollowsVCursorToggle

Synopsis Toggles the Screen Follows VCursor Setting.

Description This keystroke is used to toggle the Frame follows virtual cursor setting in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. The possible values for this JCF option are will automatically scroll to display the line on which the VCursor is positioned and will not scroll to display the line on which the VCursor is positioned.

Returns String description of value to be displayed as value of HTML Screen Follows Virtual Cursor option.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLSkipPastRepeatedTextToggle

Synopsis Toggles the Skip Past Repeated Text Setting.

Description This keystroke is used to toggle the Skip Past Repeated Text setting in the context of HTML Documents and Web pages. This keystroke is designed to be a part of the HTML Options dialog that is displayed by the script Adjust HTML Settings. The possible values for this JCF option are Virtual Cursor Will Skip Text that was repeated when a new page is loaded and Virtual Cursor Will Not Skip Text that was repeated when a new page is loaded.

Returns String description of value to be displayed as value of HTML Skip Repeated Text option.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLTextLinkVerbosityToggle

Synopsis Toggles the verbosity for text links.

Description Toggles the verbosity for text links between title, screen text, onMouseOver, longest and custom.

Returns String description of value to be displayed as value of HTML text link verbosity item.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLToggleFormsModeAutoOff

Synopsis Toggles the setting of FormsModeAutoOff.

Description This function toggles the setting of the FormsModeAutoOff feature. When on, Forms mode is switched off whenever a new page is loaded provided you weren't in Forms mode in that IE session previously. Forms mode is also turned off if the page is updated by the server. When this setting is off, Forms Mode is never automatically switched off once it has been turned on Unless you switch to an IE session which previously had it turned off.

Returns String description of value to be displayed as value of HTML Toggle Forms Mode Auto Off

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function HTMLToggleIgnoreInlineFrames

Synopsis Toggles the inclusion of inline frames.

Description This function toggles the inclusion of inline frames in the virtual representation of a web page. Inline frames are often used for advertisements so this function provides a way to turn off unwanted ads which are implemented using inline frames.

Returns String description of value to be displayed as value of HTML Ignore Inline Frames.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category HTML User Settings

function IE4GetCurrentDocument

Synopsis Returns an object that represents the HTML document in a given browser window.

Description The document object can be used to retrieve information about the document, to examine and modify the HTML elements and text within the document, and to process events. This function obtains the document object of the document in the current window.

Returns Object An object that represents the HTML document in a given browser window.

Category Object Model And MSAA

function IE4GetFocus

Description Returns the index of the focus object in Internet Explorer in the context of the entire collection of objects in the current document object.

Returns Int The value indicating the index of the focus object in Internet Explorer.

Category HTML

function IEGetCurrentDocument

Description This function returns an object that represents the HTML document in a given browser window. The document object can be used to retrieve information about the document, to examine and modify the HTML elements and text within the document, and to process events. This function obtains the document object of the document in the current window.

Returns Object An object that represents the HTML document in a given browser window.

Category HTML

function IEGetFocus

Description Returns the index of the focus object in Internet Explorer in the context of the entire collection of objects in the current document object

Returns Int The value indicating the index of the focus object in Internet Explorer.

Category HTML

function IEGetUnrestrictedWindow

Description Gets the Internet Explorer window with full read access.

Returns Object Window with full read access.

Param object/FrameWindow

Category HTML

function IEReformatBody

Synopsis Used to reformat documents displayed in Internet Explorer_Server Windows.

Description Used to reformat an internet Web page that is composed of many graphics and multiple columns and / or frames. It reformats the Web page by converting to a single column of text. The reformatted Web page contains no graphics. However, if the graphic was related to a hyperlink, that hyperlink is included in the reformatted document. It then displays the reformatted document in the active window.

Returns Int Returns 1 if the reformatting was successful, returns 0 otherwise.

Param Handle/hndIESrvWindow The window handle of the Internet Explorer_Server Window

Category HTML

function IMEGetCharAtCursor

Description Retrieves the character under the cursor in the IME composition buffer.

Returns String

Category IME

function IMEGetCompositionString

Description Retrieves the contents of the string being composed in the IME.

Returns String

Category IME

function ImeGetConversionStatus

Synopsis Gets the IME status

Description Gets the IME status for the window that currently has focus.

Returns Int Returns and integer value that indicates the current conversion mode of the Input Method Editor. The possible return values are as follows: imeCModeUnknown (=0), imeCModeInactive (=1), imeCModeOff (=2), imeCModeAlphaHalf (=3), imeCModeAlphaFull (=4), imeCModeKatakanaHalf (=5), imeCModeKatakanaFull (=6), imeCModeHiraganaHalf (=7), and imeCModeHiraganaFull (=8).

Optional

Param Int/bRomanMode/ByRef An integer that is used to specify the current state of the Roman Mode Flag for the IME associated with the focused window. This value is set to be equal to 0 if the Roman Mode Flag is not set and 1 if the Roman Mode Flag is set. See the documentation on ImmGetConversionStatus and the IME Conversion Mode Values in Microsoft's MSDN Library for more information.

Param Int/iConversionMode/ByRef An integer that is used to specify the current conversion mode of the IME associated with the focused window. This is the unparsed value that is obtained from the Win32 API function ImmGetConversionStatus. See the documentation on ImmGetConversionStatus and the IME Conversion Mode Values in Microsoft's MSDN Library for more information.

Param Int/iSentenceMode/ByRef An integer that is used to specify the current sentence mode of the IME associated with the given window. This is the unparsed value that is obtained from the Win32 API function ImmGetConversionStatus. See the documentation on ImmGetConversionStatus and the IME Conversion Mode Values in Microsoft's MSDN Library for more information.

Category IME

function ImeGetDescription

Description Gets the name of the active IME for this window if there is one, otherwise the name of the keyboard layout being used.

Returns String Name of the active IME for this window if there is one, otherwise the name of the keyboard layout being used.

Param Handle/hWnd Which window to check.

Category IME

function ImeGetGuideLine

Description Gets Ime error message.

Returns String

Param Handle/Window The window associated with the Ime of interest.

Category IME

function ImeIsActive

Description Determines whether or not an Ime is associated with the passed window handle.

Returns Int True if an Ime is associated, False otherwise.

Param Handle/window Window to check

Category IME

function InARIAGrid

Description Used to determine if the cursor is inside an ARIA grid on a web page. An ARIA grid is generated by the role="grid" attribute on an HTML element.

Returns Int 1 (True) or 0 (false).

Category Cursors

function IndentationIndicate

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function IndicateControlState

Synopsis Identifies the scontrol state using the Speech Markup rules.

Description Allows your custom scripts to take advantage of the scheme the user has set up.

Returns Void

Param Int/iType Enter the JFW Subtype Code for which this applies. See WT_ constants in HjConst.jsh.

Param int nState Either use GetControlAttributes function or one of the CTRL_ constants from HjConst.jsh if you need to specify the state yourself.

Optional

Param String/sOptionalText If for some reason, you need to have different text spoken you can use this parameter to enter text to be spoken. It will be marked up as any other text would be.

Category Speech Markup

function IndicateControlType

Synopsis Indicates the control type using Speech Markup.

Description Pass the correct control type you want to be spoken for the window or control to speak. This will honor the speech markup.

Returns Void

Param Int/iType Enter the type of control to be spoken.

Optional

Param string sControlName Enter the name of the control to be spoken, if you have a custom name for this control. This would be true if the wrong name is spoken, or perhaps none at all, and you are customizing this control to speak. An example would be an edit that just says Edit without the control's name.

Param String/ControlText Enter the text or value of the control to be spoken, if it doesn't happen already. Most edits, lists, etc. already do it, but if you need to change this here's where.

Category Speech Markup

function InFSVoiceSettingsDialogBox

Description Used to determine whether or not one of the dialog boxes that are used to modify the voice settings is currently open.

Returns Int 1 if one of the dialog boxes that are used to modify the voice settings is currently open. 0 otherwise.

Category Voices

function InHJDialog

Description Checks to see if one of the dialog boxes generated by JFW is active. These include JAWSFind, GraphicsLabeler, DlgSelectItemInList, and DlgSysTray.

Returns Int TRUE if a dialog is active, FALSE otherwise.

Category User Interaction

function IniFlush

Returns String The key names from the given section as a list of strings delimited by the " " character. If there no keys, an empty string is returned.

Param String/strSection The name of the section containing the desired key value. This value must either be a variable or contained in quotes.

Category Files

function IniReadSectionKeysEx

Description Retrieves the keys from a section in an ini style file. An ini style file is a file containing sections of keys with their values.

Returns String The key names from the given section as a list of strings delimited by the " " character. If there no keys, an empty string is returned.

Param String/strSection The name of the section containing the desired key value. This value must either be a variable or contained in quotes.

Param Int/iLocationCode Determines the directory where the file is located.

Category Files

function IniReadSectionNames

Description Retrieves the section names from an ini style file. An ini style file is a file containing sections of keys with their values.

Returns String The section names as a list of strings delimited by the " " character. If there no sections, a empty string is returned.

Category Files

function IniReadSectionNamesEx

Description Retrieves the section names from an ini style file. An ini style file is a file containing sections of keys with their values.

Returns String The section names as a list of strings delimited by the " " character. If there no sections, a empty string is returned.

Param Int/iLocationCode Determines the directory where the file is located.

Category Files

function IniReadString

Description Reads a string value from an ini style file. An ini style file is a file containing sections of keys with their values.

Returns String The retrieved value or the default value if the key does not exist in the given section.

Param String/strSection The name of the section containing the desired key value. This value must either be a variable or contained in quotes.

Param String/strKey The name of the key whose value is to be retrieved. This value must either be a variable or contained in quotes.

Param String/strDefault The value that will be returned if the key cannot be retrieved. This value must either be a variable or contained in quotes.

Optional

Category Files

function IniReadStringEx

Description Reads a string value from an ini style file. An ini style file is a file containing sections of keys with their values.

Returns String The retrieved value or the default value if the key does not exist in the given section.

Param String/strSection The name of the section containing the desired key value. This value must either be a variable or contained in quotes.

Param String/strKey The name of the key whose value is to be retrieved. This value must either be a variable or contained in quotes.

Param String/strDefault The value that will be returned if the key cannot be retrieved. This value must either be a variable or contained in quotes.

Param Int/iLocationCode Determines the directory where the file is located.

Optional

Category Files

function IniRemoveKey

Description Removes a key and its value from an ini style file. An ini style file is a file containing sections of keys with their values.

Returns Int TRUE if the key is successfully removed, otherwise FALSE.

Param String/strSection The name of the section from which the key and its value will be removed. This value must either be a variable or contained in quotes.

Param String/strKey The name of the key that will be removed. This value must either be a variable or contained in quotes.

Optional

Param Int/bFlush Optional parameter. Starting with JAWS 6.2, this flag must be set to true to flush write immediately to disk. True will flush the current write and all previous writes specified for the file indicated by strFile. Flushing will be slower. Not flushing will allow the write function to return quicker, but new data may not be available for subsequent read functions. Not supplying this parameter will behave as if set to true.

Category Files

function IniRemoveKeyEx

Description Removes a key and its value from an ini style file. An ini style file is a file containing sections of keys with their values.

Returns Int TRUE if the key is successfully removed, otherwise FALSE.

Param String/strSection The name of the section from which the key and its value will be removed. This value must either be a variable or contained in quotes.

Param String/strKey The name of the key that will be removed. This value must either be a variable or contained in quotes.

Param Int/iLocationCode Determines the directory where the file is located.

Category Files

function IniRemoveSection

Description Removes an entire section an ini style file. An ini style file is a file containing sections of keys with their values.

Returns Int TRUE if the section is successfully removed, otherwise FALSE.

Param String/strSection The name of the section that will be removed. This value must either be a variable or contained in quotes.

Optional

Category Files

function IniRemoveSectionEx

Description Removes an entire section an ini style file. An ini style file is a file containing sections of keys with their values.

Returns Int TRUE if the section is successfully removed, otherwise FALSE.

Param String/strSection The name of the section that will be removed. This value must either be a variable or contained in quotes.

Param Int/iLocationCode Determines the directory where the file is located.

Category Files

function IniWriteInteger

Description Writes an integer value to an ini style file. An ini style file is a file containing sections of keys with their values.

Returns Int The total number of characters written to the file when the write is successful. False if the value is not written successfully. If the file, section, or key does not already exist, it will be created.

Param String/strSection The name of the section where the key and value will be written. This value must either be a variable or contained in quotes.

Param String/strKey The name of the key that will hold the value. This value must either be a variable or contained in quotes.

Param Int/nValue The value that will be written to the given key.

Optional

Param Int/bFlush Optional parameter. Starting with JAWS 6.0, this flag must be set to true to flush write immediately to disk. True will flush the current write and all previous writes specified for the file indicated by strFile. Flushing will be slower. Not flushing will allow the write function to return quicker, but new data may not be available for subsequent read functions. Not supplying this parameter will behave as if set to true.

Param int/WriteDestination One of the WriteDestination (wd) constants defined in HJConst.JSH. The possible values are as follows: wdUser - indicates that the setting should be saved to the user settings file; wdSession - indicates that the setting should be saved to the transient session settings file; wdFocus - indicates that the setting should be saved to the transient focus settings file. Note that this parameter is ignored if the FileType parameter is FT_JSI. If this parameter is not specified the default value of wdUser will be used.

Category Files

function IniWriteIntegerEx

Description Writes an integer value to an ini style file. An ini style file is a file containing sections of keys with their values.

Returns Int TRUE if the value is successfully written. If the file, section, or key does not already exist, it will be created.

Param String/strSection The name of the section where the key and value will be written. This value must either be a variable or contained in quotes.

Param String/strKey The name of the key that will hold the value. This value must either be a variable or contained in quotes.

Param Int/nValue The value that will be written to the given key.

Param Int/iLocationCode Determines the directory where the file is located.

Optional

Category Files

function IniWriteString

Description Writes a string value to an ini style file. An ini style file is a file containing sections of keys with their values.

Param String/strSection The name of the section where the key and value will be written. This value must either be a variable or contained in quotes.

Param String/strKey The name of the key that will hold the value. This value must either be a variable or contained in quotes.

Param String/strValue The value that will be written to the given key. This value must either be a variable or contained in quotes.

Optional

Category Files

function IniWriteStringEx

Description Writes a string value to an ini style file. An ini style file is a file containing sections of keys with their values.

Returns Int TRUE if the value is successfully written. If the file, section, or key does not already exist, it will be created.

Param String/strSection The name of the section where the key and value will be written. This value must either be a variable or contained in quotes.

Param String/strKey The name of the key that will hold the value. This value must either be a variable or contained in quotes.

Param String/strValue The value that will be written to the given key. This value must either be a variable or contained in quotes.

Param Int/iLocationCode Determines the directory where the file is located.

Optional

Category Files

function InList

Synopsis determines whether the active cursor is within a List.

Description Note this function is currently only implemented to return TRUE in an HTML list.

Returns Int True if in a list, false otherwise.

Category HTML

function InputBox

Synopsis Displays a dialog box containing an edit field in which you can enter information.

Description This function displays a simple dialog box containing four controls. One control is an edit box in which you can enter information. Another control is a Static Text window containing the prompt of the edit box. The other two controls are the OK and Cancel buttons. If you enter text into the Edit box and press the OK button, the text you typed in the Edit box is returned to the calling function by way of the third variable of the function, which is a string variable that is passed by reference to the calling function.

Returns Int Returns 1 if the OK button was pressed. Returns 0 if the cancel button was pressed.

Param String/strMsg The text of the message that you would like to be displayed in the prompt of the Edit Box.

Param String/strTitle The text of the Dialog Box's title.

Param String/strInputText/ByRef This parameter is passed to the calling funcction or script by reference. If you type text in the Edit box and press the OK button, this parameter returns the text that you typed to JFW. If you do not enter text into the Edit box or you press the Cancel button, this parameter contains a NULL string,

Category User Interaction

function InsertCustomNodesInBranch

Description Inserts a node list at the beginning of the list of nodes under the branch.

Returns string The branch with the new nodes inserted at the beginning of the list of nodes under the branch name.

Param string/sBranch The branch into which you want to insert a node list.

Param string/sNewNodes The new nodes which you want to inserts. The Node list must be in the form node pipe node pipe . . . node pipe.

Category User Options

function InTable

Description Determines whether or not the active cursor is inside of a table.

Returns Int TRUE if in a table, FALSE otherwise.

Category Tables

function inTableCell

Description Returns TRUE if the cursor is in a table cel (as opposed to being anywhere in a table, e.g. the start or end string).

Returns int TRUE or FALSE.

Category Tables

function IntToPaddedString

Description pads an integer with zeros for the given width.

Returns string the padded string

Param int/val the number to pad

Param int/width the width to pad

Category Strings

function IntToString

Description Converts an integer value to a string and returns the string value.

Returns String The newly created string.

Param Int The number to be converted to a string.

Category Strings

function InvalidateCachedCursor

Description Invalidates the cached cursor to force a new cursor to be created. This affects the application's internal state and does not need to be called from the scripts.

Category Optical Character Recognition

function InvalidateRect

Synopsis The InvalidateRect function adds a rectangle to the specified window's update region.

Description The InvalidateRect function adds a rectangle to the specified window's update region. The update region represents the portion of the window's client area that must be redrawn.

Returns int If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.

Param handle/hwnd of window.

Param int/nLeft Rectangle left.

Param int/nTop Rectangle top.

Param int/nRight Rectangle right.

Param int/nBottom Rectangle bottom.

Category Window

function InvisibleCursor

Description Activates the Invisible cursor and deactivates other cursors. The mouse pointer does not move along with the Invisible cursor. The Invisible cursor can be used in situations where movements of the JAWS cursor and mouse pointer can cause the window display to change.

Optional

Param int/AllowScanCursor If true, allows activation of the Invisible Scan cursor; otherwise, the OSM Invisible cursor will be activated.

Category Cursors

function inWebDialog

Description determines if the virtual cursor is within a web dialog. Note that physical focus may or may not be in the dialog since the virtual cursor may roam away from the focus.

Returns int true or false.

Category html

function IsBrailleCursor

Description Determines whether the Braille cursor is active. It can be used in an If...Then...Else...statement to verify the active status of a cursor.

Returns Int "ACTIVE" = 1, "INACTIVE" = 0.

Category Cursors

function IsBrailleViewerEnabled

Description Determines if the Braille Viewer is enabled.

Returns int TRUE if the viewer is enabled, FALSE if disabled.

Category Braille and Text Viewer

function IsContractedBrailleInputSupported

Description Returns TRUE or FALSE whether the control with focus supports Contracted Braille input in JAWS. Use ContractedBrailleInputAllowedNow function in the scripts to return control whether or not contracted input support should be allowable.

Returns int TRUE or FALSE whether or not contracted input is supported in JAWS

Category Braille Keyboard

function IsFlexibleWebEnabled

Description Used to test if flexible web is enabled.

Returns int True if on, false if off.

Category HTML Flexible Web

function IsFormsModeActive

Synopsis Tests to see if Forms Mode is active.

Description Determines if the supplied keystroke has been reserved by the currently active web application. The keystroke is a single letter or shift + letter combination.

Returns int TRUE if the supplied keystroke is reserved by the currently active web application, FALSE otherwise.

Param string/KeyName The string name for the key to be checked, usually a single letter or the text "shift + " followed by the letter.

Category Keyboard

function IsKeyWaiting

Description Indicates if there are other keys in the buffer that need to be processed.

Returns Int Returns TRUE if there is a key waiting to be processed, otherwise, returns FALSE.

Category Keyboard

function IsLastKeyRepeating

Synopsis Determines if the last key is still being held down.

Description This function is useful if you need to avoid running a script until the last key has actually been released . This is particularly important if the script calls into an application's object model and thus would take a long time to complete., slowing response time down.

Returns Int True the keystroke has repeated, false means it has not repeated.

Category Keyboard

function IsLeftButtonDown

Description Checks to see if the left mouse button is locked down.

Returns Int TRUE if left button is locked, FALSE otherwise.

Category Mouse

function IsMetroApp

Description Determines if the current application is a Universal, Modern or Metro app. (They're all different names for the same thing.)

Returns int True if it's a Universal app, false otherwise.

Category system

function IsMSAAWindow

Description Indicates whether or not JAWS is using MSAA to gather information about the contents of this window.

Returns Int TRUE if MSAA is used for this window, FALSE otherwise.

Param Handle/hWnd The window to check

Category Object Model And MSAA

function IsMultiPageDialog

Description Checks to see if the active cursor is positioned inside a multi-page dialog box.

Returns Int TRUE if this is a multipage dialog, FALSE otherwise.

Category Dialogs

function IsNotificationManagerEnabled

Description Tests whether or not Notification Manager is enabled.

Returns int True if Notification Manager is enabled, false otherwise.

Category Notification Manager

function IsOBUtil

Description Determines whether the script context pertains to OpenBook's OBUtil. It can be used in an If...Then...Else...statement for verification.

Returns Int "ACTIVE" = 1, "INACTIVE" = 0.

Category JAWS Program

function IsPCCursor

Description Determines whether the PC cursor is active. It can be used in an If...Then...Else...statement to verify the active status of a cursor.

Returns Int "ACTIVE" = 1, "INACTIVE" = 0.

Category Cursors

function IsRemoteAccessClientEnabled

Description Determines whether the Freedom Scientific Remote Access Client component is installed. The Remote Access Client component is typically enabled during product installation. When the component is enabled, %product% is able to recieve speech and Braille through a Citrix or Remote Desktop client session.

Returns Int TRUE if the component is installed, FALSE otherwise.

Category System

function IsRemoteAccessServerEnabled

Description Determines whether the Freedom Scientific Remote Access Server component is installed. The Remote Access Server component is typically enabled during product installation. When the component is enabled, %product% is able to run in a Remote Desktop or Citrix session.

Returns Int TRUE if the component is installed, FALSE otherwise.

Category System

function IsRightButtonDown

Description Checks to see if the right mouse button is locked down.

Returns Int TRUE if right button is locked, FALSE otherwise.

Category Mouse

function IsRtlChar

Synopsis Determines if a character is a Right to Left reading character.

Description Determines if a character is a Right to Left reading character.

Returns int true if the character is a Right to Left reading character, false otherwise.

Param string The character to be tested.

Category Text Format

function IsRTLLanguageProcessorLoaded

Description Used to detect if a Right to Left aware language processor is loaded.

Returns Int True if RTL language processor is loaded, false otherwise.

Category Misc

function IsRtlReading

Synopsis Determines if the text in the supplied window reads from right to left.

Description This function Determines if the text in the supplied window reads from right to left.

Returns int true if the window contains text which reads right to left, false otherwise.

Param handle The handle of the window to test for Right to Left reading.

Category Text Format

function IsSameKey

Description Physical keys on the keyboard can have more than one name or alias. This function determines whether two key names are referring to the same physical key.

Returns Int TRUE if both keys refer to the same physical key.

Param String/strKey1 The name of the first key.

Param String/strKey2 The name of the second key.

Category Keyboard

function IsSameScript

Description Determines if the current script has been called two or more times in a row without any intervening scripts being called and with no more than 500 milliseconds between each call. Using this function allows a script to act differently depending upon the number of consecutive times it has been called. A script is called whenever a key assigned to it has been pressed.

Returns Int The number of times the script has repeated, 0 means it has not repeated.

Category Scripts

function IsScanCursorClass

Description Tests if the supplied class name is recognized as one which is valid for the JAWS Scan or Invisible Scan cursor. The GenericUIAClasses section in the JCF file specifies class names which are used to allow scan cursor versions of the review cursors.

Returns int True if the supplied class name is valid for scan cursor activation, false otherwise.

Param string/ClassName The window class name to test. To be a valid class name for the scan cursors, the supplied class name must start with one of the class names listed as valid in the GenericUIAClasses section of the JCF file.

Category Window

function IsScriptingEditionAuthorized

Description Determines whether or not the Script Edition option is enabled.

Returns Int TRUE if the Scripting Edition option is enabled, FALSE otherwise.

Category MAGic

function IsScriptKey

Description Determines if a key is asigned to a script.

Returns int True if the passed string is the name of a key assigned to a script, false otherwise.

Param string The name of a key, including any modifiers. See the JKM files for examples of key names.

Category Scripts

function IsSecondaryFocusActive

Description Tests whether a secondary focus is active. A list of suggestions which appears for the primary focus is an example of a secondary focus.

Returns int True if a secondary focus is active, false otherwise.

Category Secondary Focus Events and Helpers

function IsSecureDesktop

Synopsis Determines if the current desktop is a secure desktop.

Description Secure desktops encompass UAC, Lock Screen, and Login Screen desktops. This function determines whether any of these desktops are active.

Returns int True if the current desktop is a secure desktop, false otherwise.

Category System

function IsSpeechOff

Description Used to determine if the synthesizer is muted.

Returns Int TRUE if the synthesizer is muted. False if the synthesizer is not muted.

Category Voices

function IsTandemInstalled

Description Checks to determine if the Tandem feature is installed.

Returns int Returns one if the Tandem feature is installed, zero otherwise.

Category Connection

function IsTextViewerEnabled

Description Determines if the Text Viewer is enabled.

Returns int TRUE if the viewer is enabled, FALSE if disabled.

Category Braille and Text Viewer

function IsTouchCapable

Description Determines if the current device is capable of supporting JAWS touch input.

Returns int True if JAWS is running on a device capable of supporting JAWS touch input, false otherwise.

Category Scripts

function IsUIAReviewCursor

Description Determines whether the active cursor is the JAWS or invisible cursor supported by UIA, otherwise known as the JAWS Scan cursor or Invisible Scan cursor.

Returns int True if the active cursor is either the JAWS Scan cursor or Invisible Scan cursor, false otherwise.

Category Cursors

function IsUnicodeJAWS

Synopsis determines if the build of JAWS is Unicode or ANSI.

Description This function determines if the build of JAWS is Unicode or ANSI.

Returns int TRUE if JAWS is a Unicode build, FALSE otherwise.

Category JAWS Program

function IsVirtualCursorOnAnnotationString

Description This function determines if the virtual cursor is on a start or end string of a table, list, region, object, or any text aded by JAWS as an annotation to the virtual buffer.

Returns int true or false.

Category HTML

function IsVirtualDocumentViewRestricted

Description Determines if the current virtual document has been restricted to a web dialog.

Returns int true or false.

Category html

function IsVirtualPCCursor

Synopsis Tests to see if the Virtual PC cursor is enabled.

Description Checks to see if the Virtual PC cursor is being used to navigate within the window with focus.

Returns Int TRUE if the Virtual PC cursor is active, FALSE otherwise.

Category Cursors

function IsVisperoConnectEnabledForSite

Description Tests whether Vispero Connect is enabled for a site, and retrieves the connected link used to send feedback if it is enabled.

Description Determines if the Reader feature is currently enabled in ZoomText.

Returns int true or false.

Category FS Product Info

function IterateLookupModules

Description Retrieves all active lookup modules and rule set combinations. Both lists are delimited by the constant LIST_ITEM_SEPARATER, found in hjConst.jsh

Returns int the number of items in the lists

Param string/byRef/szModuleNames string to receive the list of lookup modules. This may contain duplicate entries, as more than one rule set would correspond to the same lookup module. Just use iteration to walk through this bell-char-delimited list.

Param string/byRef/szRuleSets The delimited list of rule sets corresponding to the list of modules.

Param String/ByRef/szPrimary The Primary lookup module defined in Default.jcf file.

Category Research It

function JavaObjectChanged

Synopsis Event fired when a Java object changes name, value or description.

Description Since The Java UI does not lend itself to easy scripting like other UI elements this event has been created to monitor in particular, other non-focusable object changes so that these changes may be conveyed to the user.

Returns Void

Param String/lpszRole Java role of object generating change notification.

Param String/lpszName AccessibleContextInfo name.

Param String/lpszDescription AccessibleContextInfo description.

Param String/lpszValue AccessibleValue

Param String/lpszStates string of all states applicable to the object.

Category HTML Events

function JAWSBottomOfFile

Synopsis Moves to bottom of file.

Description Performs standard behavior of the control + end keystroke combination. In most cases, moves the focus to the bottom of the open file, list or document.

Category Navigation

function JAWSCursor

Description This activates the JAWS cursor and deactivates other cursors.

Optional

function JAWSVerbosityCore

Synopsis Helper to the AdjustJAWSVerbosity script.

Description Use in your own AdjustJAWSVerbosity script and pass your own delimited string in the format shown in common.jsm represented by the constant cStrDefaultList. Hj Dialogs, muted synthesizers and Virtual Cursor are all handled automatically. Just pass your list of items for your convenience.

Param String/sCustomItems Your specific list of items to go at the top of the AdjustJAWSVerbosity list.

Category Settings

function JAWSWindow

Description This switches the focus away from the current application and makes JAWS the active application. This is equivalent to choosing JAWS from the Windows taskbar.

Category JAWS Program

function KeyboardHelp_LaunchWindowsShortcut

Description keyboard help for Windows Shortcut.

Returns string the shortcut text

Param string The fully qualified path of a windows shortcut.

Category system

function KeyboardHelp_WindowsCmd

Description keyboard help for Windows Shortcut.

Returns string the command text

Param string The windows command number.

Category system

function LanguageDetectChange

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function LastCell

Description When inside a table or spreadsheet, moves the active cursor to the last cell.

Returns Int TRUE if the cursor moved, FALSE otherwise.

Category Tables

function LaunchCommandsSearchViewer

Description Launches JAWS Search for the window of interest or the focused window. JAWS Search provides the user with a way to search JAWS commands to find that forgotten keystroke or command.

Optional

Param handle The window for the application whose configuration to use for JAWS Search. If no window is supplied, the focused window is used, using the currently loaded JAWS configuration.

Category Settings

function LaunchQuickSettings

Synopsis Launches the QuickSettings dialog.

Description Launches the QuickSettings dialog. The QuickSettings dialog uses the xml described in the application and default qs and qsm files.

Category Settings

function LaunchShortcut

Description Invokes an Windows Shortcut.

Param string The fully qualified path of a windows shortcut.

Category system

function LeftMouseButton

Description Used to simulate the clicking of the left button on a mouse. If the function is assigned to a script key and is pressed twice within one second, then this simulates a double click of the mouse button.

Category Mouse

function LeftMouseButtonLock

Description Attaches the mouse pointer to an object so that the object can be dragged to a new location. This is equivalent to holding down the left mouse button and moving the mouse. The first use of the function attaches the JAWS cursor and the mouse pointer to the object. The object is moved with the arrow keys, and is dropped at the new location by using the function again.

Returns Int "POINTER_ATTACHED" =1, "POINTER_DETACHED" = 0.

Category Mouse

function LevenshteinDistance

Description Computes the LevenshteinDistance between two strings. This is the number of additions, deletions, and changes in order to transform string1 into string2.

Returns int the number of changes

Param string/string1 The first string

Param string/string2 The second string

Category Strings

function LoadKeymapSection

Description Loads a key map section from the key map file. The key map remains loaded until it is unloaded by calling UnloadKeymapSection, or until the configuration changes--whichever happens first.

Returns void

Param string The name of the key map section to load. The name must match a section in the JKM file, excluding the trailing portion of the section name that specifies the section as a key map. For example, "Custom" specifies the key map section called "[Custom Keys]" in the JKM file.

Category Keyboard

function LowWord

Description retrieves the low-order word from the specified value.

Returns Int The low-order word from the specified value.

Param Int/dwValue Specifies the value to be converted.

Category Number conversion

function LRL_Dialog

Description LRL_Dialog Displays the Research It dialog.

Synopsis Returns the column header for the specified listview column.

Description This function enables you to obtain the header for a given listview column.

Returns string

Param handle/ hwnd of listview.

Param int/nCol the column of the listview whose header you want.

Category Screen Text

function lvGetCRC

Synopsis Calculates a unique CRC for a listview.

Description This function is used for listview customization. This hex value corresponds to the [Listview Options] section's keys.

Returns string a unique hex string for a listview.

Param handle/hListview the handle to the listview.

Category Dialog Controls

function lvGetFocusItem

Description Retrieves the 1-based index of the item in a ListView which has focus. (Superceeded by GetCurrentItem.)

Returns Int index number of the focused item.

Param Handle The ListView window.

Category Dialog Controls

function lvGetGroupName

Description Retrieves the name of the grouping that contains an item in a listview.

Returns String The name of the group

Param Handle to the window containing a ListView.

Param Int 1-based index of the item in the ListView of interest.

Category Dialog Controls

function lvGetItemColumnRect

Description Gets the bounding rectangle of the item in specific column of listview or listcontrol.

Returns Int TRUE if the bounding rectangle is successfully retrieved.

Param Handle/hwnd The handle of the window for which the rectangle is requested.

Param Int/Index of column, starting at zero.

Param Int/nLeft The left edge of the bounding rectangle after the function is called.

Param Int/nRight The right edge of the bounding rectangle after the function is called.

Param Int/nTop The top edge of the bounding rectangle after the function is called.

Param Int/nBottom The bottom edge of the bounding rectangle after the function is called.

Category Window

function lvGetItemCount

Description Retrieves a count of items in a ListView. (Superceeded by GetItemCount.)

Returns Int the count of items.

Param Handle The ListView window

Category Dialog Controls

function lvGetItemRect

Description Gets the bounding rectangle of the specified item in a listview.

Returns Int TRUE if the bounding rectangle is successfully retrieved.

Param Handle/hwnd The handle of the ListView of interest.

Param Int/Item index of the item desired.

Param Int/nLeft The left edge of the bounding rectangle after the function is called.

Param Int/nRight The right edge of the bounding rectangle after the function is called.

Param Int/nTop The top edge of the bounding rectangle after the function is called.

Param Int/nBottom The bottom edge of the bounding rectangle after the function is called.

Category Dialog Controls

function lvGetItemState

Description Detects the current selection state of the item within a ListView. Refer to the return states for more information.

Returns Int LVIS_FOCUSED = 1. The item has the focus, so it is surrounded by a standard focus rectangle. Although more than one item may be selected, only one item can have the focus. LVIS_SELECTED = 2. The item is selected. The appearance of a selected item depends on whether it has the focus and also on the system colors used for selection. LVIS_CUT = 4. The item is marked for a cut-and-paste operation. LVIS_DROPHILITED = 8. The item is highlighted as a drag-and-drop target.

Param Handle/hwnd window handle of the List View.

Param Int/item 1-based index of the item.

Category Dialog Controls

function lvGetItemText

Description Retrieves the text of an item in a ListView. Does not work for Owner-Drawn items.

Returns String The contents of the requested item.

Param Handle to the window containing a ListView.

Param int/nTable 0 for speech, 1 for Braille, if not present, defaults to speech.

Category Dialog Controls

function lvIsReportListStyle

Description Identifies the style of list control or list view.

Returns Int TRUE if style is Report or list, otherwise FALSE.

Param Handle/hwnd The handle of the list control or list view.

Category Window

function lvSelectItem

Description Select an item within the listview.

Returns Int True indicates that the item was selected successfully and FALSE indicates that the action failed.

Param Handle/hWnd Handle of list view.

Param Int/item 1-based index of the item.

Param Int/select 1 to select, 0 to unselect.

Category Dialog Controls

function lvSetFocusItem

Description Moves focus to a specified item in a ListView. Note that this does not bring the ListView window into focus, it simply causes a specific item within a ListView to be the focused item in that window. (Superceeded by SetCurrentItem.)

Returns Int TRUE if successful, FALSE otherwise.

Param Handle The window containing a ListView.

Param Int The 1-based index of the row in the ListView to receive focus.

Optional

Param Int/bClearAllStates TRUE-Clears focus and selection states of all items before setting focus. FALSE-leaves states untouched. Defaults to TRUE.

Category Dialog Controls

function MagGetMagnifiedRect

Description Gets the MAGic magnified rectangle

Returns Int TRUE if the magnified rectangle is successfully retrieved. FALSE otherwise.

Param Int/ByRef/nLeft The left edge of the magnified rectangle.

Param Int/ByRef/nTop The top edge of the magnified rectangle.

Param Int/ByRef/nRight The right edge of the magnified rectangle.

Param Int/ByRef/nBottom The bottom edge of the magnified rectangle.

Category MAGic

function MagGetMagnifiedView

Description Used to get current view mode in MAGic.

Returns Int One of the following constants from Magcodes.jsh: mv_Invalid, mv_Full, mv_Split, mv_Overlay, mv_Lens, or mv_Dynamic_Lens. A return value of mv_Invalid is used to indicate that an error occurred while requesting the information from MAGic.

Category MAGic

function MagGetOption

Synopsis Gets an option that is used by MAGic.

Description Options that can be retrieved are listed in MagCodes.jsh. Options are MID_ON, MID_LEVEL, MID_VIEW, LOC_ON, TID_ON, and SMOOTH_ON.

Returns Int -1 if the option value cannot be retrieved, otherwise the option value.

Param Int/nCode the code of the option to be retrieved. Codes are listed in MagCodes.jsh.

Category MAGic

function MagSendKeyEvent

Synopsis Sends a key event to the MAGic UI for processing.

Description If a MAGic key event is attached to a key in a key map file, then you can use this function to send the key event on to the MAGic Interface. For example, when the key is pressed to toggle magnification, the KI_MAGONOFF needs to be passed on to the MAGic user interface for processing.

Returns Int If MAGic is not running, or nKICode is out of range, then the function will return FALSE. Otherwise, TRUE is returned.

Param Int/nKICode The code for the key event. These codes can be found in magcodes.jsh.

Optional

Param int/codeSecondary If applicable, a secondary parameter used with the key event code.

Category MAGic

function MagSetFocusToPoint

Description Causes MAGic to set focus to a given point. If the point is not visible, then the screen is panned to make the point visible.

Returns Int TRUE if MagSetFocusToPoint is successful.

Param Int/x Horizontal (x) coordinate of the point.

Param Int/y Vertical (y) coordinate of the point.

Category MAGic

function MagSetFocusToRect

Description Causes MAGic to set focus to a given rectangle. If any point in the rectangle is not visible on the screen, the screen is panned to make that point visible.

Param Int/nLeft The left edge of the rectangle.

Param Int/nRight The right edge of the rectangle.

Param Int/nTop The top edge of the rectangle.

Param Int/nBottom The bottom edge of the rectangle.

Optional

Param Int/nType The type of control that is being tracked. Can be MTO_MOUSE, MTO_GENERIC, MTO_CARET, MTO_MENUS, or MTO_DIALOG. If nType is set to MTO_GENERIC, then view will always shift to the rectangle unless tracking is turned off. These types, and this parameter, are not supported in MAGic 10 or later. Hence this parameter is optional.

Category MAGic

function MagSetMagnifiedView

Description Used to set current view mode in MAGic.

Returns Int TRUE if the mode was set.

Param Int/nArea The requested mode. Can be one of mv_Full, mv_Split, mv_Overlay, mv_Lens, or mv_Dynamic_Lens.

Category MAGic

function MagTrackingToggle

Description Toggles MAGic tracking ON and OFF. The MAGic interface is not updated when this function is used. When the function is used, it returns a constant value representing the new setting. ON means tracking on, and OFF means tracking off.

Returns Int "ON" = 1, "OFF" = 0.

Category MAGic

function MakeCharacterFromValue

Synopsis Returns the character whose numeric value is represented by the int parameter.

Description This function returns the character whose numeric value is represented by the int parameter.

Returns String that contain the single character whose numeric value is given.

Param Int the numeric value of the desired character.

Category Strings

function MakeLong

Description creates a LONG value by concatenating the specified values

Returns Int The return value is a LONG value.

Param Int/wLow Specifies the low-order word of the new value.

Param Int/wHigh Specifies the high-order word of the new value.

Category Number conversion

function Max

Description Returns the maximum between two integers. Useful when comparing variables.

Returns Int the maximum between two integers.

Param Int Type a variable of type int to be compared.

Param Int Type the second variable or integer to be compared.

Category Misc

function MenusActive

Description This determines whether a menu is currently active. It returns a constant value of ACTIVE to indicate a menu is active and a value of INACTIVE to indicate that it is not active. These constants can be used in If...Then...Else...statements.

Returns Int "ACTIVE" = 1, "INACTIVE" = 0.

Category Menus

function MessageBox

Description This is used to make a message box pop up on the desktop. It can be included within an If...Then...Else...statement so that when a certain event occurs, the needed message pops up.

Param string This parameter must be either a text string enclosed in quotes, a variable name that contains a string value, or a script function that returns a string value.

Category User Interaction

function Min

Description Returns the minimum between two integers. Useful when comparing variables.

Returns Int the minimum between two integers.

Param Int Type a variable of type int to be compared.

Param Int Type the second variable or integer to be compared.

Category Misc

function MinimizeAllApps

Description Minimizes all windows on the Win95/98 or NT desktop. Same as WINDOWS KEY + M.

Category Misc

function MouseDown

Description Moves the Mouse Down by the specified number of pixels.

Returns Int TRUE if successful, FALSE if already at bottom of screen.

Param Int Number of pixels to move.

Category Mouse

function MouseLeft

Description Moves the Mouse Left by the specified number of pixels.

Param Int Number of pixels to move.

Category Mouse

function MouseRight

Description Moves the Mouse Right by the specified number of pixels.

Returns Int TRUE if successful, FALSE if already at right of screen.

Param Int Number of pixels to move.

Category Mouse

function MouseUp

Description Moves the Mouse Up by the specified number of pixels.

Returns Int TRUE if successful, FALSE if already at top of screen.

Param Int Number of pixels to move.

Category Mouse

function MoveSliderPos

Description Moves the position of a slider control to a different value.

Param Handle/hWnd windows handle to the slider control that you want to change the value on.

Param Int/iValue the PERCENTAGE to increase from the present position too. Negative percentages decrease the slider control.

Category Dialog Controls

function MoveTo

Description Moves the active cursor to the specified location on the screen. The location is specified in the form of a pixel position, where the top left hand corner of the screen is the point (0,0) and any point to the right and/or down has a positive x and y value. It is wise to be careful when using this function. This is because the pixel position of items in an application vary widely, depending upon the screen resolution on the computer that is running the application and the restored or maximized state of the application. It is always best to obtain the parameters that this function requires by searching for a particular object or string of text in the application and using GetCursorCol and GetCursorRow to store its position information in variables. Pass those variables to the function rather than a set integer value.

Returns Int TRUE if move was successful, FALSE if one or both coordinates are off the edge of the screen.

Param Int X-coordinate.

Param Int Y-Coordinate.

Optional

Param Int/CoordinateSystem The Coordinate System to be used to interpret X and Y. The default is to interpret them as pixel locations on the screen. See the COORDSYS_xxx constants in hjconst.jsh.

Category Cursors

function MoveToAnyLink

Description Moves to the first, last, next or prior link regardless of whether or not the link has been marked as visited.

Returns Int true if a link was found, false otherwise.

Param Int one of s_top, s_bottom, s_next or s_prior defined in hjconst.jsh.

Category HTML Navigation

function MoveToControl

Description Moves the active cursor to a specific control within a window. Although primarily useful inside dialog boxes, the function can be used in any window where child controls have unique identifiers obtained with GetControlID. It can also be used in SDM windows with the identifiers obtained using SDMGetFirstControl, SDMGetLastControl, SDMGetFocus, and so on. If the PC cursor is on when this function is called, the JAWS cursor is turned on automatically. Otherwise, the active cursor is used

Returns Int TRUE if successful, FALSE otherwise.

Param Handle Handle of window containing the control of interest.

Param Int ID of desired control.

Category Dialog Controls

function MoveToControlledTarget

Synopsis If the focused element on a webpage has an aria-controls target this moves to that element

Description If an element on a web page has an aria-controls relationship with another element on the page, this function will cause focus to be moved to that controlled target

Returns Int TRUE if the focus was moved to the target, FALSE otherwise.

Category HTML Navigation

function MoveToControlType

Synopsis Moves the cursor to the next, prior, first or last instance of the specified control type.

Description This function Moves the cursor to the next, prior, first or last instance of the specified control type.

Synopsis Moves to a particular form field by index.

Description This function moves to a specified form field on a webpage. Specify the 1-based index of the form field to move to. This is primarily used with the GetListOfFormFields function which returns a delimited string containing the prompt, type and text of all formfields.

Returns Int true if the virtual cursor was moved to a form field, false otherwise.

Param Int/index of form field.

Optional

Category HTML Navigation

function MoveToFrame

Description Moves the active cursor to the top left corner of the specified frame. If the PC cursor is active when this function is used, then the JAWS cursor is activated and it is moved to the new position. Otherwise, the active cursor is moved.

Returns Int "WAS_SUCCESSFUL" = 1 (frame was found), "WAS_NOT_SUCCESSFUL" = 0 (frame was not found).

Param string The name of a frame.

Category Frames

function MoveToGlanceHighlight

Description This function Moves the cursor to the next, prior, first or last instance of a glance highlight.

Returns int True if a glance highlight could be found and moved to, false otherwise.

Param int/searchType one of S_TOP, S_BOTTOM, S_NEXT or S_PRIOR as defined in hjconst.jsh.

Optional

Param int/timeBased True if searching for a glance highlight based on time of last modification, false if searching by order of appearance on the page.

Category HTML Navigation

function MoveToGlanceHighlightByIndex

Description This function Moves the cursor to a glance highlight based on the index of its appearance on the page.

Returns int True if a glance highlight of the given index could be found and moved to, false otherwise.

Param int/index The 1-based index of the glance highlight.

Category HTML Navigation

function MoveToGraphic

Description Moves the JAWS cursor, invisible cursor, or Braille cursor in a specific direction to find a graphic symbol in the active window.

Returns Int "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Param Int Type one of the constants to indicate the direction that the cursor is to move as it searches for a graphic: GRAPHIC_FIRST, GRAPHIC_NEXT, GRAPHIC_PRIOR, or GRAPHIC_LAST.

Optional

Category Graphics

function MoveToHeading

Synopsis Moves the virtual cursor to a Heading.

Synopsis moves the cursor to the first, next, previous or last proofreading element in the document.

Description This function moves the cursor to the first, next, previous or last proofreading element in the document.

Returns int TRUE for success, FALSE otherwise.

Param int/nProofreadingElementType see hjconst.jsh for the proofreading element types, peSpellingError, peGrammaticalError, peRevision

Param int/nSearchTypeFlags, see hjconst.jsh, s_top, s_bottom, s_next, s_prior

Param string/byref/sElementFound on success, is filled with the text of the element found

Category Proofreading and Annotations

function MoveToProofreadingElementByIndex

Synopsis moves to a proofreading element by its 1-based index

Description This function is used in conjunction with GetListOfProofreadingElements to move the cursor to the selected element from the list via its index.

Returns int TRUE if the move was successful, FALSE otherwise.

Param int/nProofreadingElementType see hjconst.jsh for the proofreading element types, peSpellingError, peGrammaticalError, peRevision

Param int/nIndex 1-based index

Param string/byref/sElementFound on success, is filled with the text of the element found

Category Proofreading and Annotations

function MoveToRangeInconsistency

Synopsis moves to and obtains information about an inconsistency in the requested text range

Description This function moves to and obtains information about an inconsistency in the specified text range relative to the current cursor location.

Returns int TRUE or FALSE depending on whether the move was successful.

Param int/nRange 0 line, 1 sentence, 2 paragraph

Param int/nDirection one of s_top, s_bottom, s_next or s_prior.

Param int/nInconsistencyTypeFlags The type of inconsistencies bitwise ored together that should be detected, see hjconst.jsh.

Param int/nPairedSymbolCategoryFlags the flags governing the paired symbols to check, see hjconst.jsh

Param int/byref/nTypeOfInconsistency The inconsistency type found in the specified direction, see hjconst.jsh

Param string/byref/sChars The characters of the inconsistency (eg the punctuation symbol, miscapitalized letter, etc).

Param int/byref/nOffset The offset of the inconsistency relative to the start of the line containing the inconsistency just moved to.

Category Proofreading and Annotations

function MoveToRegion

Synopsis Move the virtual cursor to an occurance of the indicated region type.

Description This function moves the virtual cursor to another occurance of the indicated region type. The first parameter determines the direction of the move, valid direction constants are listed in hjconst.jsh and include s_top, s_bottom, s_next and s_prior. The second parameter (if given) indicates the type of region to move to. If not given, then a region of any type in the indicated direction is located.

Returns Int true if a region was found, false otherwise.

Param Int/searchDirection one of s_top, s_bottom, s_next or s_prior as defined in hjconst.jsh.

Optional

Param Int/regionType one of the wt_typeCode constants.

Category HTML Navigation

function MoveToTable

Synopsis Moves the virtual cursor to a table.

Description Depending on the value of SearchOption, positions to the first, last, next, or prior table on the current web page.

Returns Int TRUE if a table was found, FALSE otherwise.

Param Int/SearchOption one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first, last, next or prior table respectively.

Category HTML Navigation

function MoveToTableByIndex

Synopsis Moves to a particular table by index.

Description This function moves to a specified table on a webpage. Specify the 1-based index of the table to move to. This is primarily used with the GetListOfTables function which returns a delimited string containing table information for each table currently rendered in the virtual document.

Returns Int true if the virtual cursor was moved to a table, false otherwise.

Param Int/index of table

Category HTML Navigation

function MoveToTableCell

Synopsis Moves the cursor to the specified table cell.

Description This function moves the cursor to the specified table cell. The parameters specify the column and row to move to (in 1-based coordinates).

Returns Int true if successful, false otherwise.

Param Int/nCol the column number

Param Int/nRow the row number

Category Tables

function MoveToTag

Synopsis Moves the cursor to the next, prior, first or last instance of the specified tag.

Description This function Moves the cursor to the next, prior, first or last instance of the specified tag. It is primarily useful in HTML documents.

Returns Int true or false.

Param Int/iSearchType one of S_TOP, S_BOTTOM, S_NEXT or S_PRIOR as defined in hjconst.jsh

Param String/sTag the HTML or other textual tag to locate

Category HTML Navigation

function MoveToTagByIndex

Synopsis Moves to a particular tag by its index.

Description This function moves to a specified tag on a webpage. Specify the 1-based index of the particular tag to move to. This is primarily used with the GetListOfTags function which returns a delimited string containing tag information for each tag currently rendered in the virtual document.

Returns Int true if the virtual cursor was moved to a tag, false otherwise.

Param Int/iIndex index of table

Param string/sTag the tag to move to

Category HTML Navigation

function MoveToTagWithAttribute

Synopsis Moves the cursor to the next, prior, first or last instance of the specified element with the specified attribute.

Description This function Moves the cursor to the next, prior, first or last instance of the specified element with the specified attribute. It is primarily useful in HTML documents. For example, it maybe used to move to instances of an element with an onclick or onmouseover handler.

Returns Int true or false.

Param Int/iSearchType one of S_TOP, S_BOTTOM, S_NEXT or S_PRIOR as defined in hjconst.jsh

Param String/sTag the HTML or other textual tag to locate (maybe empty).

Param string/sAttribute the attribute which must be present in the element, eg "onclick".

Optional

Param int/bAllowNesting TRUE to find nested instances, FALSE to disallow nested instances.

Category HTML Navigation

function MoveToTagWithAttributeByIndex

Synopsis Moves to a particular tag by its index.

Description This function moves to a specified tag on a webpage. Specify the 1-based index of the particular tag to move to In order for the index to correctly match elements retrieved with GetListOfTagsWithAttribute, the same attribute and nesting parameter must be supplied. This is primarily used with the GetListOfTagsWithAttribute function which returns a delimited string containing tag information for each tag currently rendered in the virtual document with the specified attribute. The page must have focus for this function to work.

Returns Int true if the virtual cursor was moved to a tag, false otherwise.

Param Int/iIndex index of tag relative to collection of tags with specified attribute present.

Param int/MaxMillisecondsToWait If bSynchronous is True, then MaxMillisecondsToWait determines how much time to wait for completion before returning failure. If bSynchronous is False, then this parameter is ignored.

Category Object Model and MSAA

function MSOGetMenuBarObject

Description Gets the Menu bar object in MS Office 97/2000 applications.

Returns Object The Menu bar of the current Office application.

Category Object Model And MSAA

function MuteSynthesizerToggle

Synopsis Calls for JAWS to be silent when the synthesizer is muted.

Description If using a software synthesizer, it maybe a good idea to mute JAWS when using applications such as VoiceChat programs. This will allow the sound card to be available. Running the script once will cause JAWS to be silenced. Running the script the second time will turn the speech back on. You can use the "Adjust JAWS Verbosity" dialog to mute JAWS. Next time you press the keystroke to open the dialog, it will unmute JAWS without bringing up the dialog.

Returns String description of value to be displayed as value of Mute Synth option.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category Voices

function navGetAppMainObjectID

Description Determines the object ID for the Main object of the active application.

Returns Handle Provides the object ID of the application's Main object.

Param Handle This function starts with the object that is identified by an object ID. Type the name of a variable or choose a script function that can provide the handle for the starting object.

Optional

Param Handle Type a variable name or choose a script function that can provide the window handle for the parent window. If a window handle is not provided, then GetCurrentWindow() will be used to provide a default handle.

Category Window

function navGetCurrentObjectID

Description Retrieves the Object ID of the object at the location of the active cursor. The object ID is used in a number of functions to retrieve information about objects.

Returns Handle the Object ID or 0 if the Object ID cannot be retrieved.

Category Window

function navGetFirstChildObjectID

Description Determines the first child object of a specific parent object. This function is useful when you wish to move down through the stack of object IDs.

Returns Handle Provides the handle of the first child object or returns a value of 0 when a child object cannot be found.

Param Handle This function starts with the object that is identified by an object ID. Type the name of a variable or choose a script function that can provide the handle for the starting object.

Optional

Category Window

function navGetFirstObjectID

Description Obtains the Object ID of the first Object in a series of objects. It can provide the object ID that is needed by other object navigation functions.

Returns Int Provides Object ID.

Optional

Category Window

function navGetFocusObjectID

Description Retrieves the Object ID of the object at the focus point. The object ID is used in a number of functions to retrieve information about objects.

Returns Handle the Object ID at the focus point, or 0 if the Object ID cannot be retrieved.

Category Window

Description Retrieves the help string of the object with the specified parent window and Object ID. If a parent window and object ID is not defined, then the object at the active cursor is used.

Returns String the help string of the specified object.

Optional

Category Window

function navGetObjectName

Description Retrieves the name of the object with the specified parent window and Object ID. If a parent window and object ID is not defined, then the object at the active cursor is used.

Returns String the name of the specified object.

Optional

Category Window

function navGetObjectTypeCode

Description Retrieves the object type code of the object with the specified parent window and Object ID. If a parent window and object ID is not defined, then the object at the active cursor is used.

Returns Int the object type code of the specified object.

Optional

Category Window

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function navSayObjectTypeAndText

Description Speaks the name and type of the object indicated by the function's parameters or, if called with no parameters, located at the current cursor's location. This function is similar to SayWindowTypeAndText, except that it is more specific. If a particular window contains multiple objects, this function will speak information about the one at the cursor, while SayWindowTypeAndText will speak information about the enclosing window. If the window does not contain multiple objects, then the functions operate identically. When this function is used, it marks the text it reads so that the Say Highlighted Text and Say NonHighlighted Text functions do not repeat the same information when they are triggered.

Optional

Category Window

function NavToFlowRelations

Synopsis If the focused element on a webpage has either a FlowFrom or FlowTo IAccessible2 relationship this moves to that related element

Description If an element on a web page has either a FlowTo or FlowFrom IAccessible2 relationship to other elements on the current web page, this function will cause focus to be moved to that related element

Returns Int TRUE if the focus was moved to the target, FALSE otherwise.

Param int/flowTo 0=flowFrom;1=FlowTo

Category HTML Navigation

function NextBrailleString

Description When the Braille device is in string mode, it displays the next string of Braille characters that are in the queue of strings that have been received by the Braille device.

Returns Int "WAS_SUCCESSFUL" = 1 (another string was available for display), "WAS_NOT_SUCCESSFUL" = 0 (another string was not displayed).

Category Braille Output

function NextCell

Description When inside a table or spreadsheet, moves the active cursor to the same cell in the next column.

Returns Int TRUE if the cursor moved, FALSE otherwise.

Optional

Param int/wrapNavigation Set to true to wrap to the next row at the end of the current row. Default is not to wrap.

Category Tables

function NextCharacter

Description This performs a special version of the RIGHT ARROW or Next Character keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, then JAWS tries to move the cursor to the next character or graphic it finds to the right of the current cursor location. To speak the character at the new location, place a SayCharacter function after the NextCharacter function. Note: Once the cursor has moved to the next character, it is not spoken.

Category Navigation

function NextChunk

Description This moves the active cursor to the next chunk of text. A chunk of text is a section or block of text that is written to the screen at one time, with one function call. This would typically indicate a phrase or description that should be spoken as one unit. This is useful in reading blocks of static text, control prompts, and field names.

Category Navigation

function NextLine

Description This moves the active cursor down to the next line. In many situations, Windows does not display information in perfect horizontal rows, and the cursor may not move a uniform distance each time this function is used. To speak the information immediately after the NextLine function is used, place a SayLine function after the NextLine function.

Returns Int

Optional

Category Navigation

function NextNonLink

Synopsis Positions the Virtual cursor at the next large block of nonlink text.

Description Often useful for moving past advertisement text on a Web page.

Category HTML

function NextParagraph

Description Moves the active cursor to the beginning of the next paragraph. If the PC cursor is active and the next paragraph is not already visible, then text in the window will automatically scroll to bring it into view.

Returns Int TRUE if the next paragraph was found, FALSE otherwise.

Optional

Category Navigation

function NextSentence

Description Moves the active cursor to the beginning of the next sentence. If the PC cursor is active and the next sentence is not already visible, then text in the window will automatically scroll to bring it into view.

Returns Int TRUE if the next sentence was found, FALSE otherwise.

Optional

Category Navigation

function NextWord

Description This performs a special version of the CONTROL + RIGHT ARROW or Next Word keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, then JAWS tries to move the cursor to the next word or graphic it finds to the right of the cursor's current location. To speak the word at the new cursor location, place a SayWord function after the NextWord function. Note: Once the cursor has moved to the next word, it is not spoken.

Category Navigation

function NotifyTouchInteraction

Description Informs windows that the user has just used touch to activate the control at the specified location on the screen. This is required in order for the system to activate the onscreen keyboard if appropriate. This is a wrapper of the Windows accNotifyTouchInteractionFunction.

Returns int True if successful, false otherwise

Param handle/window The window containing the touch point

Param int/x The x coordinate of the touch point

Param int/y The y coordinate of the touch point

Category Scripts

function Null

Synopsis Use this function to set any type of variable to its null state.

Description Returns null, allowing any type of variable to be set to null when assigned to the return value of this function.

Returns variant A null value.

Category Scripts

function OCRPdf

Description Performs OCR on the PDF document attached to the specified window, using the specified primary and secondary oCR languages.

Returns int The Job ID associated with the scheduled OCR.

Param handle/hwnd The window containing the PDF document. It must be open in Adobe Acrobat.

Param int/PrimaryLanguage The primary recognition language to use.

Param int/SecondaryLanguage The secondary language to use.

Category Optical Character Recognition

function OCRScreenArea

Synopsis Performs optical character recognition on a given rectangular area of the screen.

Description Performs optical character recognition on a given rectangular area of the screen. The OCR processing is asynchronus. When the OCR operation is complete, the OCRCompletedEvent will be sent. The OCR data is then available to the JAWS cursor.

Returns Int a job ID. This ID may be used to cancel the OCR operation in progress, or to identify a specific OCRScreenArea call in the OCRCompletedEvent function. If the OCR is not successfully initiated, the returned job ID is 0.

Param int left edge of the requested screen area.

Param int top edge of the requested screen area.

Param int right edge of the requested screen area.

Param int bottom edge of the requested screen area.

Param int primary language code. (English is 1033)

Param int secondary language code. (English is 1033)

Optional

Param int/EnableMicrosoftOcr Flag set to use the Microsoft OCR Engine

Param int/MicrosoftOcrLanguageCode Microsoft OCR language code. (English is 1033)

Category Optical Character Recognition

function OpenQuickAccessBar

Description Open Quick Access Bar on Windows 10 if ZoomText/Fusion is running.

Returns Void

Category Misc

function OptionsTreeCore

Synopsis Creates formatted string and presents the "Adjust JAWS Options" dialog box.

Description This function is equivalent to VerbosityCore, except that it formats the string for and presents the "Adjust JAWS Options" (Insert + v) dialog box.

Param string/sCustomItems List of items, wherein the list is segmented using the vertical bar ( ) symbol. Each segment is divided with the colon (:) symbol, where segment 1 is the callback function name and segment 2 is the display text, which may or may not contain a node path. You must have a callback function and a corresponding hlp callback function with the same name as segment 1 of each array slice. See UserOptions.jss and accompanying files for string and function format.

Optional

Param int/iRetNodeSettings Enter TRue for this optional parameter, if you do not want this function to update item strings which do not have node paths. If you ignore or leave this parameter FALSe, your items will be formatted with the node you specify in the strNewNode parameter. Ignoring these parameters is the fastest way to get your items in in their own group.

Param string/strNewNode Enter the explicit path in which to place all items in your list which do not have nodes.

Category User Options

function OutlookGetDisplayedDates

Synopsis Retrieves a list of dates currently displayed in the Outlook 2007 calendar.

Description This function only works in Outlook 2007 SP1 and later when a Day/Week/Month view is visible.

Returns string A list of dates separated by a .

Param object/View an instance of the active calendar view object in Outlook which must be one of Day/Week/Month

Category Object Model and MSAA

function OutputDebugString

Synopsis Sends a string to the debugger for display.

Description Sends a string to the debugger for display. The debugger may be a utility program such as DBGVIEW.EXE.

Returns Void

Param string String to be displayed.

Category Utility

function PageRefresh

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function PageSectionColumnChangedEvent

Synopsis For apps supporting SelectionContext events such as MSWord, announces changes in page, section, etc.

Description For apps supporting SelectionContext events such as MSWord, announces changes in page, section, text columns, and text column counts.

Returns Void

Param int/nPageNumber

Param int/nPrevPageNumber

Param int/nSectionNumber

Param int/nPrevSectionNumber

Param int/nTextColumnNumber

Param int/nPrevTextColumnNumber

Param int/nTextColumnCount

Param int/nPrevTextColumnCount

Category Screen Text Events

function PanTextLeft

Synopsis Pans MAGic's text viewer left.

Description Moves the MAGic Text Viewer left.

Category MAGic

function PanTextRight

Synopsis Pans MAGic's text viewer left.

Description Moves the MAGic Text Viewer right.

Category MAGic

function PanTextViewerLeft

Description If there is more text to the left on the current line, display it.

Returns int TRUE if the viewer is panned, FALSE otherwise.

Category Braille and Text Viewer

function PanTextViewerRight

Description If there is more text to the right on the current line, display it.

Returns int TRUE if the viewer is panned, FALSE otherwise.

Category Braille and Text Viewer

function ParseDateString

Description Convert a date string into month, day, year as integers in out parameters.

Param String/Date The date string formatted for the current locale. Must be formatted as Month, Day and year in the local system format as GetUserLocaleInfo (LOCALE_ILANGUAGE)

Param int/ByRef/Month Receives the month as number.

Param int/ByRef/Day Receives the day as number.

Param int/ByRef/Year Receives the year as number.

Category System

function ParseLongDate

Description Formats a locale-specific date string in a long date format into a string in the standard form YYYY/MM/DD.

Returns String The formatted date.

Param String/strDate a date string in a Locale specific format

Optional

Param String/locale The LCID representing the format of strDate. Defaults to the system LCID.

Category System

function ParseLongDateToShortDate

Description Formats a locale-specific date string in a long date format into the corresponding short date format.

Returns String The formatted date in short date format.

Param String/strDate a date string in a Locale specific long date format

Optional

Param String/locale The LCID representing the format of strDate. Defaults to the system LCID.

Category System

function ParseOutlookCalendarUIAText

Description The string is formatted with each field on its own line, and the name and field separated by a colon. When parsing each field, segment 1 where colon is the delimiter is the field, segments 2-end are the field contents. Field 1 is Status, value is Success or Failure. This is meant to be locale-agnostic in implementation, since each locale orders the string differently. To that end, the second parameter to this function provides the locale to use when creating the list of fields.

Returns string the fields in the calendar string as supplied by UIA (GetObjectName (TRUE,0)) function call in Outlook Calendar.

Param string/UIAText the text from UIA, e.g. getObjectName (TRUE,0) from calendar view.

Param string/LangTLA the language abbreviation for the regional language in use, e.g. GetUserLocaleInfo (LOCALE_SABBREVLANGNAME) where Locale.jsh is included in your source file.

Category Strings

function ParseShortDate

Description Formats a locale-specific date string in a short date format into a string in the standard form YYYY/MM/DD.

Returns String The formatted date.

Param String/strDate a short date string in a Locale specific format

Optional

Param String/strYear A year to be added to the shortDateString. If not provided then the shortDateString is assumed to be fully qualified

Param String/locale The LCID representing the format of strDate. Defaults to the system LCID.

Category System

function PassKeyThrough

Description Passes a keystroke on to the active application program without activating a JAWS script. This function is used when a JAWS script key and an application keyboard command are the same. It prevents JAWS from intercepting a keystroke so that the application program can respond.

Category Keyboard

function PathAddExtension

Description Adds a file extension to a path string.

Returns String Path with specified extension appended.

Param String/strPath Path to be modified.

Param String/strExt Extension to be appended.

Category JAWS Program

function PathFindExtension

Description Searches a path for an extension.

Returns String Extension, or empty string (",") if not found.

Param String/strPath Path to be searched.

Category JAWS Program

function PathRemoveExtension

Description Removes the file extension from a path, if there is one.

Returns String Path with extension removed.

Param String/strPath Path to be modified.

Category JAWS Program

function PathRenameExtension

Description Replaces the extension of a file name with a new extension. If the file name does not contain an extension, the extension will be attached to the end of the string.

Returns String Path with specified extension appended.

Param String/strPath Path to be modified.

Param String/strExt Replacement extension.

Category JAWS Program

function Pause

Description Stops the processing of a script so that other applications can complete tasks. When a pause function is placed in a script, JAWS yields to the time needs of other applications. Once other applications have been given the opportunity to use processing time, then JAWS resumes the script. The pause function is equivalent to using the Delay function with a value of 1. Do not place a pause command in a While loop, because this will cause the computer to freeze up.

Category Scripts

function PausePACMateRemote

Synopsis Allows use of the PAC Mate during a PAC Mate Remote session

Description While controlling a desktop session using a PAC Mate Remote session, use PausePACMateRemote to allow access to the PAC Mate without closing the active sync connection.

Returns int TRUE if in a PAC Mate Remote session and the session is paused.

Category Keyboard

function PCCursor

Description This activates the PC cursor and deactivates other cursors.

Category Cursors

function PerformActionOnElementWithID

Description This function finds an element in the DOM by its unique ID and performs an action on it such as setFocus, makeVisible or doDefaultAction.

Returns int TRUE if the element is found and the action applied, FALSE otherwise.

Param int action setFocus, makeVisible or doDefaultAction, see hjConst.jsh.

Param int uniqueID must correspond with the fsID attribute of the XML converted from hextToDec. the FSID must be obtained for the current session of the page. It is a dynamically changing value much like a window handle that changes each time the Web page loads. For an example, see the ListWebAppToolbarControls script in SharePointWeb.jss.

Optional

Param int/byref left screen left coordinate.

Param int/byref top screen top coordinate.

Param int/byref right screen right coordinate.

Param int/byref bottom screen bottom coordinate.

Category HTML XML DOM

function PerformActionOnElementWithTagAndAttribute

Description This function finds an element in the DOM by tag and attrib/value pair and performs an action on it such as setFocus, makeVisible or doDefaultAction.

Returns int TRUE if the element is found and the action applied, FALSE otherwise.

Param int action setFocus, makeVisible or doDefaultAction, see hjConst.jsh.

Param string fsTag must correspond to fsTag attribute of xml, not XML tag.

Param string attribName an attribute which must be present.

Param string attribValue the value of the attribute specified in attribName which must match.

Optional

Param int/byref left screen left coordinate.

Param int/byref top screen top coordinate.

Param int/byref right screen right coordinate.

Param int/byref bottom screen bottom coordinate.

Category HTML XML DOM

function PerformScriptByName

Description Allows dynamically calling a script whose name is passed as the first argument. This means that the script name does not need to be known at compile time and can be passed in a variable.

Returns void

Param String/ScriptName the name of the script to be run

Optional

Param Variant the script's 1st argument

Param Variant the script's second argument

Param Variant the script's third argument

Param Variant the script's 4th argument

Param Variant the script's 5th argument

Param Variant the script's sixth argument

Param Variant the script's seventh argument

Param Variant the script's eighth argument

Param Variant the script's 9th argument

Category Scripts

function PlaceMarkersEnumerate

Synopsis enumerates the placemarkers in a virtual document calling a user defined callback function for each marker.

Description this function enumerates the placemarkers in a virtual document calling a user supplied callback function for each marker. the callback function is passed the index of the marker, the marker's name and the text at the marker. The text at the marker is optionally marked up if the second parameter to this function is true. The enumeration continues until either all markers have been visited or the callback returns false. Note this is only available in JAWS 5.00.758 or higher.

Returns int true if the enumeration visited all markers, false if the enumeration failed or the callback returned false for any marker.

Param string/sCallbackFunctionName the name of the function to be called for each marker. The function must be defined as func(int nIndex, string sMarkerName, sMarkerText), where func maybe any legal function name.

Param int/bUseMarkupForMarkerText must be set to true if the text at the marker is to be passed with markup, false for no markup.

Category HTML Placemarkers

function PlayKeys

Description This function simulates the key sequence previously created by calls to PressKey and ReleaseKey. This allows for complex sequences of keystrokes to be executed by JAWS.

Returns Void

Category Keyboard

function PlaySound

Description Plays a wave file through the computer sound system. Requires one parameter, the wave filename. Use the FindJAWSSoundFile function to search JAWS sound folders in the user and shared spaces for the desired file. If a complete path is not specified, JAWS will search the system path specified in Environment Variables for the file.

Param string Includes the wave filename. Use the FindJAWSSoundFile function to search JAWS sound folders in the user and shared spaces for the desired file. If a complete path is not specified, JAWS will search the system path specified in Environment Variables for the file.

Category Sounds

function PositionInGroup

Synopsis Returns the string usually spoken on output type OT_POSITION, ie the position string for the focused control.

Description returns a string describing the focused control's selection's position relative to the collection, eg 1 of 10 items etc.

Returns String of the format 1 of 10 or 0 items.

Optional

Param handle/hwnd As of JAWS 12.0, Handle to the window for which information is desired. If not provided, defaults to the focussed control.

Category Dialog Controls

function PostMessage

Description Provides limited access to the Windows PostMessage function (See the Windows Platform SDK or a Windows programming book for details) It is only possible to use numeric values for wParam and lParam. No strings or other structures can be passed.

Param Handle/hWnd Window to which the message should be posted.

Param Int/Message Message to be sent.

Optional

Param Int/wParam wParam value for the message, defaults to 0.

Param Int/lParam lParam value for the message, defaults to 0.

Category Window

function PrependItemWithNode

Synopsis Adds node or tree branch path to traditional listitem.

Description Prepares list item string segment to be used in an array passed to the dlgSelectTreeFunctionToRun function.

Returns string the modified string segment with the path string.

Param string/strItem This is the string segment which contains the function callback, a colon, and the list item display text.

Param string/strNode This is the branch, or path of branches. Note that it should not end with the node path separator. Examples of nodes would be "General Options" or "Reading Options.Sayall Options" (note noperiod at end of example; this is added by the function.)

Category User Options

function PresentAllOccurrences

Description Presents all of the occurrences of a specified string in the current document in a virtual view for navigation and instant location.

Returns int the number of occurrences of the specified string presented.

Param string/sText the word whose occurrences and context you want displayed.

Optional

Param int/nUnit 0 line, 1 sentence, 2 paragraph: the unit of context to show for each word (defaults to line) occurrence.

Category Screen Text

function PressKey

Description Simulates pressing a key down on the keyboard. This function should be paired with calls to ReleaseKey. Once a sequence of PressKey and ReleaseKey calls is complete, call PlayKeys to have JAWS simulate the entire key sequence.

Returns Void

Param string A string value for the key name, these can include alt, control and shift.

Category Keyboard

function PriorBrailleString

Description Displays the prior string of Braille characters that are in the queue of strings that have been received by the Braille device. This function is used when the Braille device is in string mode.

Returns Int WAS_SUCCESSFUL = 1 (another string was available for display),"WAS_NOT_SUCCESSFUL = 0" (another string was not displayed).

Category Braille Output

function PriorCell

Description When inside a table or spreadsheet, moves the active cursor to the same cell in the prior column.

Returns Int TRUE if the cursor moved, FALSE otherwise.

Optional

Param int/wrapNavigation Set to true to wrap to the prior row at the start of the current row. Default is not to wrap.

Category Tables

function PriorCharacter

Description This performs a special version of the LEFT ARROW or Prior Character keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, JAWS tries to move the cursor to the prior character or graphic it finds to the left of the cursor's current location. To speak the information at the new cursor location, place a SayCharacter function after the PriorCharacter function.

Category Navigation

function PriorChunk

Description This moves the active cursor to the prior chunk. A chunk of text is a section or block of text that is written to the screen at one time, that is, with one function call. This would typically indicate a phrase or description that should be spoken as one unit. This is useful in reading blocks of static text, control prompts, and field names.

Category Navigation

function PriorLine

Description This performs a special version of the UP ARROW keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, then JAWS tries to move the cursor up to the line above its current position. To speak the line of information at the new location, place a SayLine function after the PriorLine function.

Returns Int

Optional

Category Navigation

function PriorNonLink

Synopsis Positions the Virtual cursor at the prior large block of nonlink text.

Description Often useful for moving back past advertisement text on a Web page.

Category HTML

function PriorParagraph

Description Moves the active cursor to the beginning of the prior paragraph. If the PC cursor is active and the prior paragraph is not already visible, then text in the window will automatically scroll to bring it into view.

Returns Int TRUE if the prior paragraph was found, FALSE otherwise.

Optional

Category Navigation

function PriorSentence

Description Moves the active cursor to the beginning of the prior sentence. If the PC cursor is active and the prior sentence is not already visible, then text in the window will automatically scroll to bring it into view.

Returns Int TRUE if the prior sentence was found, FALSE otherwise.

Optional

Category Navigation

function PriorWord

Description This performs a special version of the CONTROL + LEFT ARROW or Prior Word keyboard command. When the PC cursor is active, JAWS allows the application to move the cursor. When other cursors are active, JAWS tries to move the cursor to the prior word or graphic it finds to the left of the cursor's current location. To speak the word at the new location, place a SayWord function after the PriorWord function.

Category Navigation

function ProcessNewText

Description Used to force a NewTextEvent call. Can be useful if you need to call NewTextEvent before FocusChangedEvent.

Category Screen Text

function ProcessNotification

Description Retrieves the collection representing the action rules for this notification.

Returns collection The collection representing the action rules for this notification.

Param string/notificationText The text of the notification.

Param string/AppName The name of the application which sent the notification.

Category Notification Manager

function ProgressBarAnnouncementToggle

Synopsis Toggles progress bar announcement on and off.

Description Used to toggle the announcement of the progress bar. The status will revert to the default setting when JAWS is restarted.

Returns string the state of the progress bar announcement after the toggle.

Param int true if current value is to be returned, false if value is to be updated and returned.

Category Settings

function ProgressBarSetAnnouncement

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function PunctuationSetLevel

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function PunctuationToggle

Synopsis Toggles the punctuation between the choices available.

Description Changes the punctuation spoken by JFW such as: All, Some, Most, and None.

Returns String description of value to be displayed as value of Punctuation Level.

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned.

Category Settings

function PushBrailleMathString

Synopsis Pushes math text to be shown on the braille display. Only valid in Braille Push mode.

Description This function is identical to PushBrailleString; however, the text is flagged as Math text, instead of plain text. The effect of this is that the braille translator will translate the string using special math rules, instead of the regular ones.

Returns void

Param string Text the text to push to the braille display.

Param int CursorPosition the position of the cursor in the text.

Optional

Param string BreakableOffsets A string containing a comma delimited list of offsets at which the string can be broken for panning (i.e. "2,5,6").

Category Braille Output

function PushBrailleString

Synopsis Pushes text to be shown on the braille display. Only valid in Braille Push mode.

Description This function will push the given text to the braille display to be shown, setting the cursor at the given position. Strings can only be pushed to the display if the active braille mode is the Push mode. While in Push mode, only text sent by PushBraille methods will be shown on the display. Push mode can be enabled by calling SetJCFOption(OPT_BRL_MODE, BRL_MODE_PUSH). Make sure it is disabled appropriately, or else the user will be stuck in a mode where their normal braille isn't displayed.

Returns void

Param string Text the text to push to the braille display.

Param int CursorPosition the position of the cursor in the text.

Optional

Param string BreakableOffsets A string containing a comma delimited list of offsets at which the string can be broken for panning (i.e. "2,5,6").

Category Braille Output

function QueueFunction

Synopsis schedules the given function to run the next time jaws stops speaking.

Description The given function will run the next time jaws stops speaking. Multiple functions may be queued. Functions are run in the order they are added to the queue. Stopping speech by pressing control or performing another such action will clear the queue.

Returns int 1 if the function was queued, 0 otherwise

Param string A string containing a function name. The function name should be followed by parentheses like a normal function call. integers and quoted strings may be included in the parameter list inside the parentheses

Category Scripts

function QuickKeyNavigationModeActive

Description Determines if the Quick Key Navigation mode is on or off.

Returns Int TRUE if on, false otherwise

Category HTML

function ReadSettingInteger

Synopsis Reads an integer value from an ini style file.

Description Reads an integer value from an ini style file or one of the transient settings files for the specified file. An ini style file is a file containing sections of keys with their values. The file that is read from is identified by the FileType parameter and an optional FileName parameter. For some values of the FileType parameter, FT_CURRENT_JCF, FT_SHARED_CURRENT_JCF, and FT_JSI, for which a file name is required, the value returned by GetActiveConfiguration will be used if a file name is not provided via the FileName parameter. When FT_CURRENT_JCF is the file type, and no file name is supplied, the domain-specific file will be used if available.

Returns int The retrieved value or the default value if the key does not exist in the given section. Before using the default value, the value from default.jcf will be checked first, if the file type is FT_CURRENT_JCF is used.

Param string/sectionName The name of the section containing the desired key value. This value must either be a variable or contained in quotes.

Param string/keyName The name of the key whose value is to be retrieved. This value must either be a variable or contained in quotes.

Param int/Default The value that will be returned if the key cannot be retrieved.

Param int/FileType One of the FileType (FT_) constants that identify the type of file and its location. The currently supported file types for reading are as follows: FT_MODULE_INI: The INI file for the current product. For JAWS this file is named JFW.INI. The module INI file is always located in the same directory in which the product is installed. The FileName parameter is ignored for this file type. FT_DEFAULT_JCF: The file Default.JCF. The FileName parameter is ignored for this file type. When reading from this file, the settings stored in the Default.JCF file found in the user settings directory will be layered over the settings stored in the Default.JCF file found in the shared settings directory. FT_CURRENT_JCF: If available, the domain-specific jcf file. Otherwise, any application JCF file. If the FileName parameter is not specified, the value returned by GetActiveConfiguration will be used. When reading from this file, the settings stored in the JCF file found in the user settings directory will be layered over the settings stored in the JCF file found in the shared settings directory. FT_JSI: A JSI file. If the FileName parameter is not specified, the name of the current application will be used. FT_SHARED_DEFAULT_JCF: The file Default.JCF found in the shared settings directory. The FileName parameter is ignored for this file type. When this file type is specified settings will only be read from the copy of the file found in the shared settings directory. FT_SHARED_CURRENT_JCF: Any application JCF file found in the shared settings directory. If the FileName parameter is not specified, the value returned by GetActiveConfiguration will be used. When this file type is specified settings will only be read from the copy of the file found in the shared settings directory.

Optional

Param string/FileName The name of file to read. This value must either be a variable or contained in quotes. It is unnecessary to specify the full path of the file, only the file name need be specified, since the file used will always be located in either the shared settings directory, the user settings directory, or the personalized settings directory. The FileType parameter is used to determine in which directory the file will be searched for. If this parameter is not specified and a file name is required for the specified file type, the value returned by GetActiveConfiguration will be used. It is not necessary to specify the file extension since the file extension that is appropriate for the specified file type will be added automatically.

Category Files

function ReadSettingString

Synopsis Reads a string value from an ini style file.

Description Reads a string value from an ini style file or one of the transient settings files for the specified file. An ini style file is a file containing sections of keys with their values. The file that is read from is identified by the FileType parameter and an optional FileName parameter. For some values of the FileType parameter, FT_CURRENT_JCF, FT_SHARED_CURRENT_JCF, and FT_JSI, for which a file name is required, the value returned by GetActiveConfiguration will be used if a file name is not provided via the FileName parameter.

Returns string The retrieved value or the default value if the key does not exist in the given section.

Param string/sectionName The name of the section containing the desired key value. This value must either be a variable or contained in quotes.

Param string/keyName The name of the key whose value is to be retrieved. This value must either be a variable or contained in quotes.

Param string/Default The value that will be returned if the key cannot be retrieved. This value must either be a variable or contained in quotes.

Param int/FileType One of the FileType (FT_) constants that identify the type of file and its location. The currently supported file types for reading are as follows: FT_MODULE_INI: The INI file for the current product. For JAWS this file is named JFW.INI. The module INI file is always located in the same directory in which the product is installed. The FileName parameter is ignored for this file type. FT_DEFAULT_JCF: The file Default.JCF. The FileName parameter is ignored for this file type. When reading from this file, the settings stored in the Default.JCF file found in the user settings directory will be layered over the settings stored in the Default.JCF file found in the shared settings directory. FT_CURRENT_JCF: Any application JCF file. If the FileName parameter is not specified, the value returned by GetActiveConfiguration will be used. When reading from this file, the settings stored in the JCF file found in the user settings directory will be layered over the settings stored in the JCF file found in the shared settings directory. FT_JSI: A JSI file. If the FileName parameter is not specified, the name of the current application will be used. FT_SHARED_DEFAULT_JCF: The file Default.JCF found in the shared settings directory. The FileName parameter is ignored for this file type. When this file type is specified settings will only be read from the copy of the file found in the shared settings directory. FT_SHARED_CURRENT_JCF: Any application JCF file found in the shared settings directory. If the FileName parameter is not specified, the value returned by GetActiveConfiguration will be used. When this file type is specified settings will only be read from the copy of the file found in the shared settings directory.

Optional

Category Files

function RedirectToUserBuffer

Synopsis Formats and sends text to the User Buffer and initiates a sayAll.

Description This function formats and sends text to the User Buffer and initiates a sayAll. %modifiers are processed.

Returns Void

Param String/the string to format and send to the User Buffer.

Category Virtual Viewer

function ReformatKeyName

Synopsis Reformats a valid script key name for message output.

Description Takes a valid script key name to reformat and returns a string that contains the reformatted name to use in a message.

Returns String The formatted script key name according to Documentation standards for script key names in messages.

Param string a valid script key name.

Category Scripts

function Refresh

Description Refreshes the screen.

Returns Void

Optional

Param Int/forced 1 means force the refresh, 0, only if needed.

Category Window

function RefreshWindow

Description Refreshes the contents of a window and all windows contained within it. This is much faster than refreshing the entire screen.

Returns Void

Param Handle Handle of window to be refreshed.

Category Window

function RegisterWindowMessage

Description Passes the call through to the Windows API function RegisterWindowMessage.

Returns int A system-wide unique identifier for the message.

Param string String to be registered as a defined windows message.

Category Window

function ReleaseKey

Description Simulates releasing a previously pressed key on the keyboard. This function should be proceeded with a call to PressKey. Once a sequence of PressKey and ReleaseKey calls is complete, call PlayKeys to have JAWS simulate the entire key sequence.

Returns Void

Param string A string value for the key name, these can include alt, control and shift.

Category Keyboard

function ReleaseTestRunner

Description Releases a TestRunner object that was allocated using GetTestRunner.

Param Handle/hRunner The handle of the test runner to be released. This is a handle that was generated in a call to GetTestRunner.

Category Test

function ReloadAllConfigs

Synopsis Reloads all of the current configuration files

Description This function reloads all the current configuration files. This function is useful for instance when you manually make adjustments too default.jss or default.jcf and recompile using the command line compiler and then wish to see the effects without having to restart JAWS.

Category Settings

function ReloadSystemColors

Synopsis Configure JAWS recognition of colors based on the present palette and system colors.

Description JAWS monitors for palette change messages and reloads the system colors appropriately when this message is sent. If, however, an application changes the palette or system colors without broadcasting notification, this function can be used to force JAWS to recognize the modified colors.

Category Colors

function RemoteAccessIsConnected

Synopsis Returns True if JAWS is running in a remote session. Returns FALSE otherwise.

Description This function returns JAWS is running in a remote session such as a Terminal Services session or a Citrix session or is being controlled via PAC Mate Remote. This function returns FALSE otherwise. returns int True if JAWS is running in a remote session. Returns FALSE otherwise.

Category Connection

function RemoveHook

Description Removes a hook function put in place by AddHook.

Param Int The type of hook to be removed. Use the same hook type that was used by AddHook for this parameter. Hook types are defined in HJConst.JSH.

Param string The name of the function to be removed as a hook.

Category Scripts

function ResetEmailInformation

Description Forces the email finder to reset itself. It'll now re-initialize itself when you try to move to the next email.

Returns int 1 is successful, 0 is not.

Category html

function ResetKeyboard

Description When a sequence of PressKey and ReleaseKey calls have been made this function allows the queue of keys to be cleared without executing the key sequence.

Returns Void

Category Keyboard

function ResetSpeechMarkupAttributes

Description This function resets the supplied speech attributes for the last item spoken. After this call, all supplied attributes of the next spoken item are announced.

Optional

Param int/fieldsToReset this is a combination of the attribField constants in hjconst. AttribFields values included here will be reset. Other attributes will be left at their current state.

Category Speech Markup

function ResetSynth

Description Reinitializes the synthesizer with the proper volume, rate, and pitch settings. Used to bring the synthesizer back to normal if it has gotten out of sync with JAWS.

Category Voices

function RestoreCursor

Description Reactivates the cursor that was saved when the SaveCursor function was last used. If the cursor being restored is the JAWS cursor, Invisible cursor, or Braille cursor, then the cursor is also returned to its previous position on the desktop. If the cursor currently in use is different than the cursor that was in use when the SaveCursor function was used, then it is deactivated and the previous cursor is reactivated.

Category Cursors

function RestoreSoundBalance

Description Restores sound balance, so both JAWS and other sounds come from both channels again

Returns int 0 if the operation failed, 1 if it succeeds

Category Sounds

function RestrictViewToEnclosingType

Description Restricts the virtual cursor to the enclosing type.

Returns int True if the virtual cursor was restricted, false otherwise.

Param int The enclosing type to which the virtual cursor will be restricted.

Category HTML

function RGBDecToHex

Synopsis Converts an RGB decimal string to an RGB hex string, eg "240241242" to "#f0f1f2"

Description This function converts a Decimal RGB string to a Hex RGB string.

Returns string The Hex RGB string.

Param string/sRGBDec the Decimal RGB string.

Category Colors

function RGBHexToColor

Synopsis Converts a hex RGB string to its int equivalent.

Description This function converts a hex RGB string to its int color value.

Returns int the color

Param string/sRGBHex the hex string eg "#rrggbb" or "rrggbb"

Category Colors

function RGBHexToDec

Synopsis Converts an RGB Hex string to an RGB Decimal string, eg "#f0f1f2" or "f0f1f2" to "240241242".

Description This function converts a Hex RGB string to a Decimal RGB string.

Returns string the decimal string.

Param string/sRGBHex the hex string to convert.

Category Colors

function RGBStringToColor

Description Converts a 9-digit string of the form "255255255" to a color value.

Returns Int A color value suitable for comparison with the values returned by GetColorText or GetColorBackground.

Param string The 9-digit RGB value to be converted.

Category Colors

function RightMouseButton

Description Used to simulate the clicking of the right button on a mouse. If the function is assigned to a script key and is pressed twice within one second, then this simulates a double click of the mouse button.

Category Mouse

function RightMouseButtonLock

Description This is equivalent to holding down the right mouse button and moving the mouse. It locks the right button down while other tasks are carried out.

function RouteJAWSSoundRight

Description Routes JAWS sound to the right, and all other sounds to the left.

Category Research It

function RunSelectionContextEvents

Synopsis enables the scripter to force the selection context events to be rerun

Description This function may be called from SayFocusedWindow or other places when it is necessary for the Selection Context Events to be rerun

Returns void

Category Object Model and MSAA

function RunTestSuite

Description Run a suite of automated tests.

Param Handle/hRunner The handle of the test runner to be released. This is a handle that was generated in a call to GetTestRunner.

Category Test

function SALModeButton

Description Speaks the appropriate "SAL mode" representation of a braille cell

Param Int/Column number Number of the braille cell to speak

Param Int/Type 0 to speak the character at the cell location, 1 to speak and spell the word at the location.

Category Braille Keyboard

function SaveCurrentLocation

Synopsis Remembers the current location for a subsequent operation

Description This function remembers the current location for a subsequent operation such as selection between this and a subsequent location.

Returns void

Category Cursors

function SaveCursor

Description Saves the name of the active cursor. If the JAWS cursor, Invisible cursor, or Braille cursor is being used, then the position of the cursor is also saved. Scripts that use the SaveCursor function usually use the RestoreCursor function.

Category Cursors

function Say

Description Speak a string of text using a specific set of speech characteristics called output modes. It is possible to use separate output modes to speak title lines, dialog controls, menu items, etc. By using the SayMessage function instead, you will be able to assign short and long messages to many output types for JAWS Help and other information. With Desktop JAWS 5 and later, we suggest that you no longer speak control type and state information with this function. Instead, use IndicateControlType and IndicateControlState. Type information includes messages such as "edit" or "button." State information includes messages such as "checked" or "not checked." Note that in JAWS 12 or later, Settings Center replaces Configuration Manager.

Param string Type the text that is to be spoken, or specify a variable name or script function that can provide the required text string. Text strings that are typed must be enclosed within quotation marks.

Param Int Type the constant name that represents the output mode to be used when speaking this text. See the JFW documentation for specific uses of different output modes. In many cases, these are specific, and can be disabled from within Settings Center, should the user select not to hear a specific type of information. Examples of output modes are: OT_HELP, OT_JAWS_MESSAGE or OT_STATUS. Note that in JAWS 12 or later, Settings Center replaces Configuration Manager.

Optional

Param Int With Desktop JAWS 5 or later, enter TRUE if your string is marked up with behaviors, e.g. you used any of the SMM functions.

Category Say

function SayActiveCursor

Description This speaks the name of the active cursor, for example, PC, JAWS, Invisible, or Braille.

Category Cursors

function SayAll

Description This says the active window from the position of the active cursor to the bottom of the window. The cursors move as text is read. If the PC cursor is active the window will scroll to display additional text.

Optional

Param Int/bUseSayAllSynthesizer This parameter may be used to indicate whether or not the Say All speech synthesizer should be used. The default value of this parameter if FALSE which causes JAWS to use the primary speech synthesizer for the Say All operation.

Category Screen Text

function SayAllBy

Synopsis Determines what method of Say All is used.

Description Determines whether say all will read by line, sentence, or paragraph.

Returns String description of value to be displayed as value of SayAllBy

Param Int/iRetCurVal true if current value is to be returned, false if value is to be updated and returned

Category Screen Text

function SayAllInProgress

Description determines if sayAll is active.

Returns Int TRUE or FALSE

Category Voices

function SayAllReadsBy

Description Callback function for the dlgSelectTreeFunctionToRun function. The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.

Returns string The human-readable string name of the new setting.

Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function. 0 = change setting, 1 = retain current setting.

Category User Options

function SayCell

Description When in a table or spreadsheet, speaks the contents of the current cell.

Returns Int TRUE if in a table, FALSE otherwise

Category Tables

function SayCharacter

Description This says the character or graphic located at the position of the active cursor.

Optional

Param Int/IncludeMarkup This optional parameter was added in JAWS 10.0. The default value for the parameter is TRUE. This parameter controls whether markup information is included when the text of the character is returned.

Category Screen Text

function SayCharacterByExample

Description Says a character by example.

Optional

Param String character to speak. If not provided, speaks the character at the current cursor.

Category IME

function SayCharacterPhonetic

Description Uses special pronunciation rules to read the character located at the position of the active cursor. For example, A is pronounced alpha, B bravo, etc. The association between characters and their phonetic pronunciations are made in the [PhoneticSpell] section of .JCF files.

Category Screen Text

function SayChunk

Description Says the chunk of information to which the active cursor is pointing. A chunk is text and graphic information that was written to the screen in a single operation. SayChunk is similar to SayField. However, the SayField function uses logic to determine the text that is to be spoken, while SayChunk simply reads the text that was stored in the off screen model as a single unit.

Returns Void

Category Screen Text

function SayColor

Description Speaks the names of the foreground and background colors of the text at the location of the active cursor.

Returns Int "TRUE" = 1, Text was found. "FALSE" = 0, cursor was not pointing to text.

Optional

Param int/bSpeakRGB if true, speaks the RGB value of the colors, otherwise speaks the name. If an exact match on name isn't found, an approximation is used. This optional parameter is only available in JAWS 5.10 or higher.

Category Colors

function SayColumnHeader

Description When in a table or spreadsheet, speaks the contents of the column header.

Returns Int TRUE if in a table, FALSE otherwise.

Category Tables

function SayControl

Description Used in dialog boxes to speak the contents of a child window along with its prompt. It reads Edit fields, list boxes, check boxes, radio buttons, etc.

Param Handle The information that is spoken by this function is determined by the window handle that is used as a parameter. Type a variable name or choose a script function that can provide a window handle.

Category Dialog Controls

function SayControlEx

Synopsis Handles the speaking of controls for which SayWindowTypeAndText and related functions do not sufficiently describe the control.

Description This function is designed to be used in the script language to speak a control that requires custom processing (any control for which SayWindowTypeAndText does not properly speak the name and type of the control). This function is designed to honor the user's output mode settings for each component of the control's description. This function takes nine parameters, eight of which are string parameters. The first parameter is the window handle of the control that is to be spoken. The next eight parameters include one parameter for each component of a control's description. Each string parameter has a corresponding Output Mode. The eight string parameters are String strControlName = Either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken, String strControlType = OT_CONTROL_TYPE, String strControlState = OT_ITEM_STATE, String strContainerName = OT_CONTROL_GROUP_NAME, String strContainerType = OT_CONTROL_TYPE, String strValue = OT_SELECTED_ITEM, String strPosition = OT_POSITION, String strDialogText = OT_DIALOG_TEXT. This function works by building a string based upon the five components of the control description, adding each component only if the user has specified that this item should speak in the current verbosity level. Then this function calls Say with the constructed string as the first parameter and OT_NO_DISABLE as the second parameter. If any portion of the control description is not specified, JFW will obtain the default value for that component of the control description and will add the default value of that component to the control description string. Therefore, if SayWindowTypeAndText speaks every part of a control correctly other than the Control Type, you can call SayControlEx and pass it the Window Handle and the text you would like to be spoken and pass a null string (",") to the function for the remainder of the parameters. SayControlEx will obtain the default values for the control type, control st. ate, container name, container type, control value, control positional information, and the dialog text if the specified window is the top level window of a dialog box using the same methods as SayWindowTypeAndText and it will include these values in the control description string that is spoken.

Returns Int Returns 1 if the function sucessfully assembled the control description string and spoke the control description (i.e. the length of the control description string was equal to 0). If for some reason the function failed to assemble the control description string, the function returns 0. One reason why this function would return 0 is that the user has specified that all the output modes be turned off in the current verbosity level.

Param Handle/hwndControl The window handle of the control.

Optional

Param String/strControlName The name of the control. This parameter is assigned an Output Mode of either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken. If the window that is to be spoken has a window type of WT_DIALOG, this parameter is assigned an Output Mode of OT_DIALOG_NAME. If the specified window is the App Main Window or Real Window, it is assigned an Output Mode of OT_DOCUMENT_NAME. Otherwise it is assigned an Output Mode of OT_CONTROL_NAME.

Param String/strControlType The control type. This parameter is assigned an Output Mode of OT_CONTROL_TYPE.

Param String/strControlState The control state. This parameter is assigned an Output Mode of OT_ITEM_STATE.

Param String/strContainerName The name of the control container box. For example, if this control is part of a group box, this paramater would be the name of the group box. This parameter is assigned an Output Mode of OT_CONTROL_GROUP_NAME.

Param String/strContainerType The control type of the control container. This parameter is assigned an Output Mode of OT_CONTROL_TYPE. It is only spoken if the user has specified that both OT_CONTROL_GROUP_NAME and OT_CONTROL_TYPE are enabled.

Param String/strValue The current value of the control. For example, if the specified control is a list box, the current value of the control is the text of the selected item in the list box. This parameter is assigned an output mode of OT_SELECTED_ITEM.

Param String/strPosition Any relevant positional information for the control. For example if the specified control is a list box, the relevant positional information for the control is the index of the selected item in the list box. This parameter is assigned an output mode of OT_POSITION.

Param String/strDialogText If the specified control is the top level window of a dialog box, this parameter specifies the text that is to be spoken as the static text of the dialog box. This parameter is assigned an output mode of OT_DIALOG_TEXT.

Category Dialog Controls

function SayControlExWithMarkup

Synopsis Handles the speaking of controls for which SayWindowTypeAndText and related functions do not sufficiently describe the control. this function however uses Speech Markup and assumes all parameters are correctly marked up.

Description This function is designed to be used in the script language to speak a control that requires custom processing (any control for which SayWindowTypeAndText does not properly speak the name and type of the control). This function is designed to honor the user's output mode settings for each component of the control's description. This function takes nine parameters, eight of which are string parameters. The first parameter is the window handle of the control that is to be spoken. The next eight parameters include one parameter for each component of a control's description. Each string parameter has a corresponding Output Mode. The eight string parameters are String strControlName = Either OT_DIALOG_NAME, OT_DOCUMENT_NAME, or OT_CONTROL_NAME, depending on the type of window that is to be spoken, String strControlType = OT_CONTROL_TYPE, String strControlState = OT_ITEM_STATE, String strContainerName = OT_CONTROL_GROUP_NAME, String strContainerType = OT_CONTROL_TYPE, String strValue = OT_SELECTED_ITEM, String strPosition = OT_POSITION, String strDialogText = OT_DIALOG_TEXT. This function works by building a string based upon the five components of the control description, adding each component only if the user has specified that this item should speak in the current verbosity level. Then this function calls Say with the constructed string as the first parameter, OT_NO_DISABLE as the second parameter and specifies that the string contains Speech Markup. If any portion of the control description is not specified, JFW will obtain the default value for that component of the control description and will add the default value of that component to the control description string. Therefore, if SayWindowTypeAndText speaks every part of a control correctly other than the Control Type, you can call SayControlExWithMarkup and pass it the Window Handle and the text you would like to be spoken and pass a null string (",") to the function for the remainder of the parameters. SayControlExWithMarkup will obtain the default values for the control type, control state, container name, container type, control value, control positional information, and the dialog text if the specified window is the top level window of a dialog box using the same methods as SayWindowTypeAndText and it will include these values in the control description string that is spoken. Note that this version of the function assumes that all parameters are using speech markup, ie they contain correct xml markup including symbol replacement (eg < with < etc. This allows a control's type or state or value to be marked up to play sounds, change voice etc.

Returns Int Returns 1 if the function successfully assembled the control description string and spoke the control description (i.e. the length of the control description string was equal to 0). If for some reason the function failed to assemble the control description string, the function returns 0. One reason why this function would return 0 is that the user has specified that all the output modes be turned off in the current verbosity level.

Param Handle/hwndControl The window handle of the control.

Optional

Param String/strControlType The control type. This parameter is assigned an Output Mode of OT_CONTROL_TYPE.

Param String/strControlState The control state. This parameter is assigned an Output Mode of OT_ITEM_STATE.

Category Dialog Controls

function SayControlInformation

Synopsis Handles the speaking of controls for which SayWindowTypeAndText and related functions do not sufficiently describe the control.

Optional

Param String/strControlType The control type. This parameter is assigned an Output Mode of OT_CONTROL_TYPE.

Param String/strControlState The control state. This parameter is assigned an Output Mode of OT_ITEM_STATE

Category Dialog Controls

function SayCurrentScriptKeyLabel

Synopsis Speaks the key name attached to the script.

Description Speaks the Key Name attached to the current script, honoring both the typing echo setting and the label as defined in DEFAULT.JCF.

Category Scripts

function SayCursorPos

Description This speaks the row and column position of a cursor. The row and column spoken is based upon the number of pixels of the active cursor position from the top left corner of the screen.

Optional

Param int desired units of measure, see hjconst.jsh smmUnitsOfMeasure constants. (This optional parameter added in JAWS 9.0.

Category Cursors

function SayDebugger

Synopsis Used to debug various say functions.

Description Call SayDebugger in various say functions to add the debug info to the say debug log when it is on.

Param string The name of the function calling the debugger.

Optional

Param variant/Param1, the first parameter used by the calling function.

Param variant/Param2, the second parameter used by the calling function.

Param variant/Param3, the third parameter used by the calling function.

Param variant/Param4, the fourth parameter used by the calling function.

Param variant/Param5, the fifth parameter used by the calling function.

Param variant/Param6, the sixth parameter used by the calling function.

Param variant/Param7, the seventh parameter used by the calling function.

Param variant/Param8, the eighth parameter used by the calling function.

Param variant/Param9, the ninth parameter used by the calling function.

Category Utility

function SayField

Description This says the field of text where the active cursor is pointing. A field of text is a section or block of text that has a common attribute such as bold, underlined, italics, or strikeout. The use of the attribute must be contiguous. The SayField function uses logic to determine the text that is to be spoken, while the SayChunk function simply says what JAWS considers to be a single block of text.

Optional

Param int If true, and the cursor is at the offset just after the last character of text in the field, jaws speaks the preceding field.

Category Screen Text

function SayFocusRect

Description Says the contents of focus rectangle. Returns TRUE if any text was spoken, FALSE otherwise.

Returns Int "True" or "False", 1 or 0.

Param Handle Handle of window.

Category Window

function SayFocusRects

Description Says the contents of focus rectangles. If there is only one such rectangle, this acts like SayFocusRect, which says only the first one. If there is more than one, says the contents of all of them.

Returns Int TRUE if text was spoken, FALSE otherwise.

Param Handle Handle of window.

Category Window

function SayFont

Description Identifies the font name, font size, and font attributes (For example: bold, underline, italic) that are associated with the character at the active cursor. The information that is reported is for the font that appears on the desktop, and usually does not correspond to the size of the font that will be printed on a printer. Refer to "FONTSIZE.TXT" in the \JFWxx \TECNOTES subdirectory for tips on working with fonts.

Category Text Format

function SayFormattedMessage

Synopsis Formats the messages which are passed, and speaks a message based on the specified output type.

Description This function takes short and long messages and speaks the appropriate message based on the given output type. The messages which are passed may have formatting strings such as %KeyFor() in them, as they will be formatted by the function. If using the output mode OT_USER_BUFFER, to place text in the User Buffer, do not include the short message as it will be ignored. With Desktop JAWS 5 and later, we suggest that you no longer speak control type and state information with this function. Instead, use IndicateControlType and IndicateControlState. Type information includes messages such as "edit" or "button." State information includes messages such as "checked" or "not checked."

Param Int/iOutputType The constant representing the desired output type for the given set of messages. A list of available output type constants can be found in hjconst.jsh.

Param String/sLong A quoted string of text, a message constant, or a string variable containing the desired long message. If you require only one message, enter it for this parameter and leave the third parameter blank

Optional

Param String/sShort A quoted string of text, a message constant, or a string variable containing the desired short message. If you would like the short message to speak nothing, enter the constant msgSilent for this parameter. If using the output type OT_USER_BUFFER, enter nothing at all.