CONTENTS

Script Basics
Scripting JAWS for Pocket PC
Download PAC Mate Scripts
If
ElIf
Else
EndIf
While
EndWhile
Not
Return
AppendToClipboard
ClipboardChangedEvent
ClipboardHasData
CopySelectedTextToClipboard
CopyToClipboard
CutToClipboard
GetClipboardText
GetTextFromClipboard
PasteFromClipboard
Replace
WasTextAlreadyAppended
WillOverwriteClipboard
AppendSelectedTextToClipboard
AddBrailleColors
BackgroundColorChanges
BrailleColorMarkingAssign
BrailleSetColorsToMark
ColorToRGBString
FindColors
GetColorApproximation
GetColorAtPoint
GetColorBackground
GetColorField
GetColorName
GetColorText
ReloadSystemColors
RGBDecToHex
RGBHexToColor
RGBHexToDec
RGBStringToColor
SayColor
SayColor
TextColorChanges
ActiveMovesBraille
BottomEdgeEvent
BrailleCursor
BrailleMovesActive
BrailleToggleCursor
CaretVisible
ConvertCursorShape
CursorShapeChangedEvent
FindCaret
FocusPointMovedEvent
GetActiveCursor
GetActiveCursorName
GetBrailleRestriction
GetCursorCol
GetCursorRow
GetCursorShape
GetRestriction
GetRestrictionName
InvisibleCursor
IsBrailleCursor
IsInvisibleCursor
IsJAWSCursor
IsPCCursor
IsVirtualPCCursor
JAWSCursor
JAWSCursor
MoveTo
PCCursor
PCCursor
ProcessBoundaryStrike
RestoreCursor
RestrictBrailleCursor
RestrictCurrentCursor
RestrictCursor
RestrictJAWSCursor
RouteBrailleToActiveCursor
RouteBrailleToJAWS
RouteBrailleToJAWS
RouteBrailleToPc
RouteBrailleToPC
RouteInvisibleToJAWS
RouteInvisibleToPc
RouteJAWSCursorToPc
RouteJAWSToBraille
RouteJAWSToInvisible
RouteJAWSToPc
RoutePCCursorToJAWS
RoutePCToBraille
RoutePCToInvisible
RoutePcToJAWS
RouteVirtualToMouse
RouteVirtualToPc
SaveCursor
SayActiveCursor
SayActiveCursor
SayCursorPos
SayCursorType
SetActiveCursor
SetBrailleRestriction
SetRestriction
SetRestrictionToFrame
SetRestrictionToRect
TetherJAWSToPC
ToggleRestriction
TopEdgeEvent
VirtualPCCursorToggle
IsFormsModeActive
RoutePCToVirtual
RoutePCToVirtual
TULSwitchToRuleSet
DialogActive
DialogList
DialogListHelper
DialogPageChangedEvent
GetDefaultButtonName
GetDialogPageName
GetDialogStaticText
GetGroupBoxName
IsMultiPageDialog
NextDocumentWindow
PreviousDocumentWindow
ReadBoxInTabOrder
SayDefaultButton
FileExists
FilenameGetNearestMatch
FileNameList
GetFileDate
IniFlush
IniFlushEx
IniReadInteger
IniReadIntegerEx
IniReadSectionKeys
IniReadSectionKeysEx
IniReadSectionNames
IniReadSectionNamesEx
IniReadString
IniReadStringEx
IniRemoveKey
IniRemoveKeyEx
IniRemoveSection
IniRemoveSectionEx
IniWriteInteger
IniWriteIntegerEx
IniWriteString
IniWriteStringEx
BrailleGetFramePrompt
CreatePrompt
FrameClearValues
FrameGetBottomRight
FrameGetTopLeft
FrameManager
FrameManagerRun
FrameMoveHelper
FramesEnumerate
FrameSetOnObject
FrameSetOnWindow
FramesListHelper
FrameViewer
FrameViewerActive
GetFrameDescription
GetFrameNameAtCursor
GetFramePrompt
GetFrameSynopsis
GetFrameTutorMessage
GetTextInFrame
MoveToFrame
SayFrame
SayFrame
SayFrameAtCursor
SayFrameAtCursor
SelectAFrame
ShowFrameText
ShowFrameTextHelper
AutoGraphicsLabelerHelper
AutoLabelGraphics
FindGraphic
GetGraphicID
GetGraphicNameAtPoint
GraphicsEnumerate
GraphicsLabeler
GraphicsLabeler
GraphicsList
GraphicsListHelper
GraphicsMode
GraphicsVerbosity
MoveToGraphic
SetGraphicLabel
AddEditLayerLinksToHelpScreen
AddedShortcutAvailable
AddHTMLLayerLinksToHelpScreen
AddShortcutLayerLinksToHelpScreen
AppFileTopic
BasicHelpTopic
DisplayPacMateHelp
GeneralJAWSHotKeys
GetCorrespondingHelpFile
GetCustomTutorMessage
HotKeyHelp
IsWinKeyHelp
JAWSHotKeys
KeyboardHelp
KeyboardHelpHook
SayExtendedHelpHotKey
ScreenSensitiveHelp
ScreenSensitiveHelpForColorsDialog
ScreenSensitiveHelpForJAWSDialogs
ScreenSensitiveHelpForJAWSManager
ScreenSensitiveHelpForKnownClasses
ScreenSensitiveHelpForSelectVoiceAliasDialog
ScreenSensitiveHelpForSysTray
ScreenSensitiveHelpForUnknownClasses
ScreenSensitiveHelpVirtualCursor
ScreenSensitiveHelpWindowList
ShowAdvancedLayerHelpScreen
ShowCapsLockLayerHelpScreen
ShowEditLayerHelpScreen
ShowHelpByID
ShowHelpByName
ShowHelpLayerHelpScreen
ShowHTMLLayerHelpScreen
ShowInformationLayerHelpScreen
ShowSettingsLayerHelpScreen
ShowShortcutLayerHelpScreen
ShowStartAppLayerHelpScreen
ShowWriteMacroLayerHelpScreen
TutorMessageEvent
WindowKeysHelp
WindowKeysHelpDefault
PAC MateKeystrokesTopic
ShowScreenSensitiveHelp
AdjustHTMLSettings
BrailleToggleTableReading
DefineATempPlaceMarker
DetectTableWhenNavigating
DisplayAdvancedElementInfo
DisplayBasicElementInfo
DlgListOfPlaceMarkers
DocumentLoadedEvent
ExitFormsMode
FocusToFirstField
FocusToLastField
FocusToNextField
FocusToPriorField
FormsModeEvent
GetCurrentHeading
GetCurrentHeadingLevel
GetCurrentPlaceMarker
GetDocumentPercentage
GetElementDescription
GetFormFieldIndex
GetHeadingCount
GetHTMLFrameCount
GetHTMLFrameIndex
GetHTMLFrameName
GetHTMLFrameNames
GetLinkCount
GetListOfFormFields
GetListOfTables
GetListOfTags
GetPlaceMarkerCount
GetTableIndex
GetTagIndex
GoBackAPage
GoToAddressBar
GoToFavourites
GoToHomePage
HidePictures
HTMLButtonTextVerbosityToggle
HTMLDecrementLinesPerPageItem
HTMLDecrementMaxBlockLength
HTMLDecrementMaxLineLength
HTMLDetectTables
HTMLFrameIndicationToggle
HTMLGraphicReadingVerbosityToggle
HTMLIdentifyLinkTypeToggle
HTMLIdentifySamePageLinksToggle
HTMLIncludeGraphicsToggle
HTMLIncludeImageMapLinksToggle
HTMLIncludeLinksToggle
HTMLIncrementLinesPerPageItem
HTMLIncrementMaxBlockLength
HTMLIncrementMaxLineLength
HTMLIndicateBlockQuotes
HTMLIndicateElementAccessKeys
HTMLIndicateLists
HTMLIndicateTablesToggle
HTMLScreenFollowsVCursorToggle
HTMLSkipPastRepeatedTextToggle
HTMLTextLinkVerbosityToggle
HTMLToggleFormsModeAutoOff
HTMLToggleIgnoreInlineFrames
IE4GetFocus
IEFind
IEGetCurrentDocument
IEGetFocus
IEGetUnrestrictedWindow
IEReformatBody
InList
JumpReturnFromLine
JumpTo
JumpToLine
MoveToControlType
MoveToElementOfDifferentType
MoveToElementOfSameType
MoveToFirstHeading
MoveToFirstHeadingLevelN
MoveToFirstSameElement
MoveToFirstTable
MoveToFormField
MoveToFormFieldByIndex
MoveToHeading
MoveToHTMLFrame
MoveToHTMLFrameByIndex
MoveToLastHeading
MoveToLastHeadingLevelN
MoveToLastSameElement
MoveToLastTable
MoveToList
MoveToNextDifferentElement
MoveToNextHeading
MoveToNextHeadingLevelN
MoveToNextNonLinkText
MoveToNextPlaceMarker
MoveToNextSameElement
MoveToNextTable
MoveToPriorDifferentElement
MoveToPriorHeading
MoveToPriorHeadingLevelN
MoveToPriorNonLinkText
MoveToPriorPlaceMarker
MoveToPriorSameElement
MoveToPriorTable
MoveToTable
MoveToTableByIndex
MoveToTag
MoveToTagByIndex
MoveToUnvisitedLink
MoveToVisitedLink
NextNonLink
PriorNonLink
QuickKeyNavigationModeActive
ReadAddressBar
RefreshPage
SayNextRow
SayPriorRow
SelectaHeading
SelectALink
SelectAPlaceMarker
SelectHierarchicalElement
SelectHTMLElement
SetQuickKeyNavigationMode
SpeakPlaceMarkerByIndex
StepOutOfCurrentElement
StepToEndOfElement
StepToStartOfElement
ToggleExpandAbbreviations
ToggleExpandAcronyms
ToggleUseVirtualInfoInFormsMode
TurnOffFormsMode
TurnOnFormsMode
VirtualHTMLFeatures
AnnounceDocumentElements
CustomPageSummaryReported
DocumentLoadedAtFormField
GetListOfTagsWithAttribute
MoveToTagWithAttributeByIndex
PageChangedEvent
AddHook
AltLeftMouseClick
AltPlus
BackspaceMSDos
BXBuildFKeyModifyer
BXBuildModifyer
CancelLayeredKeySequence
CapsLockKey
CapsLockOff
CapsLockOn
ClickOnFocus
ClickOnWindow
ControlBackSpace
ControlDelete
ControlDownArrow
ControlDownArrowPCCursor
ControlEnter
ControlEnterKey
ControlUpArrow
ControlUpArrowPCCursor
DoBXModifiedKey
DPadEnter
DPadEnter
EnableBrailleOnQwerty
Enter
EnterKey
GetKeyState
IsKeyWaiting
IsLastKeyRepeating
IsSameKey
JAWSBackspace
JAWSDelete
JAWSKey
KeyboardManager
KeyPressedEvent
PassKeyThrough
PassKeyThrough
PausePACMateRemote
PausePACMateRemote
PerformAdvancedLayerKey
PerformLayeredKey
PressAppButton
RemoveHook
SetTypingEcho
SetTypingEchoLanguage
ShiftEnterKey
ShiftTab
ShiftTabKey
ShortcutAvailable
SimulateKey
SwitchInputLanguage
Tab
TabKey
ToggleCapsLockState
ToggleKeyboardLogging
ToggleKeyboardLogging
ToggleOneHandedBrailleMode
TrapKeys
TypeKey
TypingEcho
UpALevel
UsingRemotePACMateBX
ControlShiftEnterKey
ControlShiftEnter
DoNativeKey
FindKeyAliasMatch
LockKeyboard
OnMouseOver
CenterMouseInView
IsHJTrackEngine
LowerMAGicViewMagLevel
MagGetArea
MagGetOption
MAGicKey
MagResetArea
MagSayNextCharacter
MagSayNextLine
MagSayPriorCharacter
MagSayPriorLine
MagSelectFromStartOfLine
MagSelectNextCharacter
MagSelectPriorCharacter
MagSelectToEndOfLine
MagSendKeyEvent
MagSetArea
MagSetBorder
MagSetFocus
MagSetFocusToPoint
MagSetFocusToRect
MagSetMagnifiedColorMask
MagSetTrackAlignment
MagSetTrackingObjects
MagTrackingToggle
RaiseMAGicViewMagLevel
ShutDownMAGic
ToggleLocatorMode
MagGetMagnifiedRect
MagGetMagnifiedView
MagSetMagnifiedView
ActivateAppMenu
ActivateMenuBar
ActivateStartMenu
ContextMenuProcessed
DoExtraMenuProcessing
EditAvailable
GetMenuMode
GetMenuName
MenuActiveProcessed
MenuBar
MenuBarActiveProcessed
MenuInactiveProcessed
MenuModeEvent
MenuModeHook
MenusActive
PocketMenuAdd
PocketMenuAddWithCallback
PocketMenuExecute
ShortcutToEdit
ShortcutToModemConnection
ShortcutToNew
ShortcutToTools
ShortcutToView
ShortcutToVoiceBar
StartMenu
AppearPhantomWindow
DecToHex
DisappearPhantomWindow
GetCustomLabelKey
GetDocumentPath
GetDomainName
GetLineCount
GetOutputModeName
HiWord
LoWord
Max
Min
MinimizeAllApps
MinimizeAllApps
PlaceMarkersEnumerate
QuitApplication
ReadContextLine
SpeakPlaceMarkers
toggleAllowJAWSMenuSelectionApplet
Undo
VirtualClearTimeOrDate
VirtualShowTimeOrDate
AltLeftMouseClick
ClearValues
ClickAtPoint
ControlLeftMouseClick
ControlLeftMouseClick
DragAndDrop
DragAndDropClearValues
DragItemWithMouse
IsLeftButtonDown
IsRightButtonDown
LeftMouseButton
LeftMouseButton
LeftMouseButtonLock
LeftMouseButtonLock
MouseButtonEvent
MouseDown
MouseDown
MouseLeft
MouseLeft
MouseMovedEvent
MouseMovementDecrement
MouseMovementDefault
MouseMovementIncrement
MouseRight
MouseRight
MouseUp
MouseUp
RightMouseButton
RightMouseButton
RightMouseButtonLock
RightMouseButtonLock
SayMouseAndAnsiSettings
ShiftLeftMouseClick
ShiftLeftMouseClick
ProcessWasNonFocusedItemClicked
BottomOfFile
GotoLineNumber
HomeEndMovement
JAWSBottomOfFile
JAWSEnd
JAWSEnd
JAWSHome
JAWSHome
JAWSPageDown
JAWSPageDown
JAWSPageUp
JAWSPageUp
JAWSTopOfFile
NextCharacter
NextChunk
NextLine
NextParagraph
NextSentence
NextWord
NumericDataSayNextAsSingleUnit
NumericDataSayPriorAsSingleUnit
PriorCharacter
PriorChunk
PriorLine
PriorParagraph
PriorSentence
PriorWord
SayCharacterUnitMovement
SayLineUnitMovement
SayNextCharacter
SayNextCharacterPCCursor
SayNextLine
SayNextLinePCCursor
SayNextParagraph
SayNextSentence
SayNextWord
SayNextWordPCCursor
SayPriorCharacter
SayPriorCharacterPCCursor
SayPriorLine
SayPriorLinePCCursor
SayPriorParagraph
SayPriorSentence
SayPriorWord
SayPriorWordPCCursor
SayWordUnitMovement
SkimReadMoveToDocLine
SpeakNthPlaceMarker
SwitchDocumentWindow
SwitchToPriorApp
SwitchToRecentApp
ToggleOutlookReminder
TopOfFile
SayCharacterUnit
&&
Function: &&
&
Function: &
/
Function: /
==
Function: ==
>=
Function: >=
>
Function: >
Function:
Function:
-
Function: -
%
Function: %
*
Function: *
!=
Function: !=
+
Function: +
SayCharacterUnit
SayLineUnit
SayWordUnit
HomeEndMovement
SayPageUpDownUnit
SayTopBottomUnit
GetScriptAssignedTo
IsScript
ProcessBXModifiedKey
SetLastScriptKey
cstrBrailleMarkingList
cStrDefaultHTMLList
cStrDefaultList
cStrTableBrailleList
Delay
GetCurrentScriptKeyName
GetScriptDescription
GetScriptFileName
GetScriptKeyName
GetScriptKeyNames
GetScriptSynopsis
IsSameScript
Pause
ReformatKeyName
RefreshScripts
SayCurrentScriptKeyLabel
ScheduleFunction
ScriptAndAppNames
ScriptFileName
ScriptManager
ScriptManagerDefault
SkimReadShouldSpeakText
SwitchToScriptFile
TypeCurrentScriptKey
Unknown
UnScheduleFunction
cStrBrailleList
GetScriptAssignedTo
IsScript
ProcessBXModifiedKey
SetLastScriptKey
CustomHighlightAssign
DoCustomHighlightColors
DragDialogWindow
GetSelectedText
Mark
ProcessSelectText
ReadWordInContext
SayHighLightedText
SaySelectedText
SelectAll
SelectAllItems
SelectCurrentItem
SelectFromStartOfLine
SelectFromStartOfLine
SelectFromTop
SelectFromTop
SelectingText
SelectNextCharacter
SelectNextCharacter
SelectNextLine
SelectNextLine
SelectNextParagraph
SelectNextScreen
SelectNextScreen
SelectNextSentence
SelectNextWord
SelectNextWord
SelectPriorCharacter
SelectPriorCharacter
SelectPriorLine
SelectPriorLine
SelectPriorParagraph
SelectPriorScreen
SelectPriorScreen
SelectPriorSentence
SelectPriorWord
SelectPriorWord
SelectToBottom
SelectToBottom
SelectToEndOfLine
SelectToEndOfLine
SelectToMark
TextSelectedEvent
UnselectAllButCurrent
AdjustJAWSVerbosity
AnsiCharsDecrement
BrailleCount
BrailleDisplayLoadErrors
BrailleDriver
BrailleDriverInformation
BrailleLongName
BrailleName
BraillePort
BraillePortString
ConfigManager
CreateDictionaryCommandLine
DictionaryManager
GetActiveConfiguration
GetDefaultJCFOption
GetJCFOption
GetSettingInformation
GetVerbosity
JAWSVerbosityCore
ProgressBarAnnouncementToggle
PunctuationToggle
ReloadAllConfigs
RunJAWSManager
SelectALanguage
SetAnsiCharsIncrement
SetDefaultJCFOption
SetGraphicsVerbosity
SetJAWSLanguage
SetJCFOption
SetPunctuationLevel
SetVerbosityLevel
ShouldItemBraille
ShouldItemSpeak
SwitchLanguage
SwitchToConfiguration
SynthCount
SynthDisplayLoadErrors
SynthDriver
SynthDriverInformation
SynthLongName
SynthName
SynthPort
SynthPortString
ToggleLanguageDetection
ToggleMuteSynthesizer
TogglePunctuation
ToggleSALMode
VerbosityLevel
VerbosityLevelToggle
Beep
PlaySound
FindString
FormatString
FormatStringWithEmbeddedFunctions
GetCharacterValue
GetCharacterValueString
GetSpellString
IntToString
IsWordDelimiter
LookupBXKeyNames
MagSay
Say
SayFormattedMessage
SayFormattedMessageWithVoice
SayInteger
SayMessage
SayString
SpellString
stringChopLeft
stringChopRight
StringCompare
StringContains
StringContainsChars
StringDiff
StringIsBlank
StringLeft
StringLength
StringLower
StringMixedCaseToMultiword
StringReplaceChars
StringReplaceSubstrings
StringReverse
StringRight
StringSegment
StringSegmentCount
StringSegmentIndex
StringStrip
stringStripAllBlanks
StringToHandle
StringToInt
StringTrimCommon
StringTrimLeadingBlanks
StringTrimTrailingBlanks
StringUpper
StripBXKeyNamePrefix
SubString
TypeFormattedString
TypeString
GetInputLanguage
GetRegistryEntryDWORD
GetRegistryEntryString
GetSystemDefaultLang
GetSystemLocaleInfo
GetSystemVolume
GetSystemVolumeRange
GetTickCount
GetUserDefaultLang
GetUserLocaleInfo
GetWindowsOS
GetWindowsSystemDirectory
IsWinNtOr95
LastBootType
ListTaskTrayIcons
Run
SayBatteryLevel
SayDriveLetter
SaySystemTime
SaySystemTray
SayTaskBar
ScreenGetHeight
ScreenGetWidth
SetRegistryEntryDWORD
SetRegistryEntryString
SetSystemVolume
StartJAWSTaskList
SwitchToPreviousApp
SysGetDate
SysGetTime
SysTrayGetItemCount
SysTrayGetItemToolTip
SysTrayMoveToItem
UseAlternateLanguage
ViewSysTrayItems
BottomOfColumn
DownCell
DownCell
EndOfRow
FirstCell
FirstCellInTable
GetCell
GetCellCoordinates
GetColumnHeader
GetColumnText
GetCurrentRowColumnCount
GetRowHeader
GetRowText
GetTableCaption
GetTableNestingLevel
GetTableSummary
InTable
JumpReturnFromTableCell
JumpToTableCell
LasstCell
LastCellInTable
MoveToBottomOfColumn
MoveToEndOfRow
MoveToStartOfRow
MoveToTableCell
MoveToTopOfColumn
NextCell
NextCell
PriorCell
PriorCell
ReadCurrentColumn
ReadCurrentRow
ReadFromCurrentCell
ReadFromTopOfColumn
ReadToBottomOfColumn
ReadToCurrentCell
SayCell
SayCell
SayColumnHeader
SayRowHeader
SayTableCellCoordinates
SetTableTitleReading
SpeakTableCells
StartOfRow
TopOfColumn
UpCell
UpCell
GetCellSpan
GetTableName
GetTableSelectionRange
SetColumnHeader
SetRowHeader
CollectWindowInfo
GetRightLeaf
GetTreeInfo
GoToBatteryLevel
GoToRunningProgramsInMemory
HomeRowToggle
NetworkAdaptersIPAddressInfo
OpenControlPanelApplet
OutputDebugString
RunCalendar
RunContacts
RunFExplore
RunFSCalc
RunFSEdit
RunStopwatch
RunTasks
RunTMail
ScreenSensitiveHelpTechnical
ToggleHomeRow
TreeCapture
UtilityCopyInfo
UtilityCopyMSAAObjectInfo
UtilityFindFirstAttribute
UtilityFindLastAttribute
UtilityHelp
UtilityInitializeHomeRowPosition
UtilityJumpToOutputMode
UtilityJumpToOutputModeReverseOrder
UtilityMoveToChild
UtilityMoveToNextWindow
UtilityMoveToParent
UtilityMoveToPriorWindow
UtilityNextAttribute
UtilityPriorAttribute
UtilityPutInfoInBox
UtilityPutMSAAObjectInfoInBox
UtilityResetOutputMode
UtilityRouteJAWSCursorToPc
UtilitySayInfo
UtilitySayInfoAccess
UtilitySayMSAAObjectInfo
UtilitySayMSAAObjectInfoAccess
UtilitySayMSAAObjectOutputMode
UtilitySayOutputMode
UtilitySayWindow
UtilitySayWindowPromptAndText
UtilitySetFocusToHomeRowPosition
UtilitySetFontMode
UtilitySetMSAAObjectOutputMode
UtilitySetMSAAObjectOutputModeReverseOrder
UtilitySetOutputMode
UtilitySetOutputModeReverseOrder
UtilitySpeakWindowVisibility
UtilityToggleSpeakWindowVisibility
UtilityWindowClassReassign
UtilityNodeCapture
UtilityShowObjectHierarchyInfo
UtilityShowObjectListInfoByName
UtilityShowObjectList
UtilityTreeCapture
ChangeVoiceSetting
DecreaseVoicePitch
DecreaseVoicePitchSayAll
DecreaseVoiceRate
DecreaseVoiceRateSayAll
DecreaseVoiceVolume
DecreaseVoiceVolumeSayAll
GetActiveSynthInfo
GetActiveSynthLanguage
GetDefaultSynthInfo
GetSynthLanguages
GetSynthPitchRange
GetSynthRateRange
GetVoiceParameters
GetVoicePerson
GetVoicePitch
GetVoicePunctuation
GetVoiceRate
GetVoiceVolume
GetVoiceVolumeRange
IncreaseVoicePitch
IncreaseVoicePitchSayAll
IncreaseVoiceRate
IncreaseVoiceRateSayAll
IncreaseVoiceVolume
IncreaseVoiceVolumeSayAll
InitializeGlobalVoiceSettings
IsSpeaking
IsSpeechOff
MuteSynthesizer
MuteSynthesizerToggle
NullAllGlobalSettings
ResetSynth
ResetVoiceSettings
RestoreVoiceSettings
SayAllInProgress
SayUsingVoice
SelectASynthesizer
SetAllVoicesToGlobals
SetSynth
SetSynthLanguage
SetVoiceGlobalSettings
SetVoiceParameters
SetVoicePerson
SetVoicePitch
SetVoicePunctuation
SetVoiceRate
SetVoiceSetting
SetVoiceVolume
SpeechInUse
SpeechOff
SpeechOn
StopSpeech
StopSpeech
GetVoiceProfileNames
HasUserDefinedVoiceProfiles
SetActiveVoiceProfileByIndex
SpeechToggledEvent
CheckForReminderDialog
CloseButton
CloseDocumentWindow
DoChildWindows
EnumerateChildWindows
FindDescendantWindow
FindSelectedRadioButton
FindTopLevelWindow
FindWindow
findWindowByType
FindWindowWithClassAndId
FocusChangedEvent
ForegroundIconicEvent
ForegroundWindowChangedEvent
GetAppletName
GetAppMainWindow
GetControlID
GetCurrentControlID
GetCurrentWindow
GetFirstChild
GetFirstFocusableChild
GetFirstWindow
GetFocus
GetFocusRect
GetFocusRectBottom
GetFocusRectLeft
GetFocusRectRight
GetFocusRectTop
GetForegroundWindow
GetHHTaskBarWnd
GetItemRect
GetLastWindow
GetNavModuleVersionInfo
GetNextWindow
GetOwner
GetParent
GetPriorWindow
GetRealWindow
GetTextInFocusRects
GetTextInRect
GetTopLevelWindow
GetWindowAtPoint
GetWindowBottom
GetWindowClass
GetWindowHierarchyX
GetWindowHierarchyY
GetWindowLeft
GetWindowName
GetWindowOwner
GetWindowRect
GetWindowRight
GetWindowStyleBits
GetWindowSubtypeCode
GetWindowText
GetWindowTextEx
GetWindowTop
GetWindowType
GetWindowTypeCode
HandleCustomAppWindows
HandleCustomRealWindows
HandleCustomWindows
HasFocusRect
HasTitleBar
HelpBalloonEvent
InternalFrameChangedEvent
InTextWindow
InvalidateRect
IsDescendedFromWindow
IsLiteraryWindow
IsPegHelpWindow
IsPointInWindow
IsSelectedRadioButton
isSystemDialog
IsWindowDisabled
IsWindowObscured
IsWindowVisible
JavaFocusChangedEvent
lvGetItemColumnRect
lvGetNumOfColumns
lvIsReportListStyle
MoveToWindow
navGetAppMainObjectID
navGetCurrentObjectID
navGetFirstChildObjectID
navGetFirstObjectID
navGetFocusObjectID
navGetLastObjectID
navGetNextObjectID
navGetObjectContainerHelp
navGetObjectHelp
navGetObjectName
navGetObjectTypeCode
navGetObjectTypeString
navGetParentObjectID
navGetPrevObjectID
navGetRealObjectID
navGetTopLevelObjectID
navSayObjectTypeAndText
PostMessage
RefocusToForegroundDialog
Refresh
RefreshScreen
RefreshWindow
SayBottomLineOfWindow
SayFocusedWindow
SayFocusRect
SayFocusRects
SaySpecialWindowClasses
SayToBottom
SayTopLineOfWindow
SayWindow
SayWindowPromptAndText
SayWindowTitle
SayWindowTypeAndText
SendMessage
SetFocus
SetFocusToFirstFocusableControl
SetForegroundWindow
SetParentDims
SpeakWindowInformation
ToolTipEvent
VirtualizeWindow
WindowActivatedEvent
WindowClassReassign
WindowCreatedEvent
WindowDestroyedEvent
WindowMinMaxEvent
WindowResizedEvent
WmGetText
FocusChangedEventEx
GetDocumentLoadState
GetOwningAppName
ProcessSayAppWindowOnFocusChange
ProcessSayFocusWindowOnFocusChange
ProcessSayRealWindowOnFocusChange
RegisterWindowMessage
Scripting Standards
FS Braille Display API
fbBeep
fbClose
fbConfigure
fbGetCellCount
fbGetDisplayName
fbGetFirmwareVersion
fbOpen
fbSetVariBraille
fbWrite
HighWord
IsReadWordInContextValid
LowWord
MakeLong
UseDocumentServerReadingFunctionality
AppWillNotSpeakEvent
AutoFinishEvent
AutoStartEvent
GetAppFileName
GetAppFilePath
GetAppTitle
GetFixedProductVersion
GetLotusProgramVersion
GetLotusVersionInfoString
GetProgramVersion
GetVersionInfoString
SayAppVersion
SayProgramComments
BrailleGetCurrentTranslatorMode
BrailleGetTranslatorModeCount
BrailleGetTranslatorModeName
BrailleSetTranslatorMode
BrailleGetCellCount
BrailleGetDeviceInfo
BrailleGetStatusCellCount
BrailleInUse
BrailleAltTab
BrailleControlLeftMouseClick
BrailleEnter
BrailleEscape
BrailleGetTypeKeysMode
BrailleRightMouseClick
BrailleRouting
BrailleSelectBlock
BrailleSelectTextClearValues
BrailleSelectText
BrailleSetTypeKeysMode
BrailleShiftTab
BrailleSupportsTypeKeysMode
BrailleTab
FHPActivateTaskList
FHPBrailleEnter
FHPBrailleEscape
FHPBrailleManager
FHPBrailleSelectText
FHPBrailleShiftTab
FHPBrailleTab
FHPToggleCursorMode
FHP_RunJAWSManager
SALModeButton
SetBrailleControlKeyProcessingMode
SetBraillePanSize
SetBrailleTriKeyProcessingMode
SetOneHandedBrailleMode
ToggleTypeKeysMode
BrailleAutoAdvanceModeActive
BrailleAutoAdvanceMode
BrailleAutoAdvance
BrailleBottom
BrailleMoveLeft
BrailleMoveRight
BrailleNextLine
BrailleNextLine
BraillePanLeft
BraillePanLeft
BraillePanRight
BraillePanRight
BraillePriorLine
BraillePriorLine
BrailleRoutingButton
BrailleTop
ContinuousBraillePanNext
ContinuousBraillePanPrev
DecreaseBrailleAutoAdvanceSpeed
FHPBrailleNextLine
FHPBraillePanLeft
FHPBraillePanRight
FHPBraillePriorLine
FHPBrailleShowWindowsBottom
FHPBrailleShowWindowsTop
FHPBrailleSpeechNextLine
FHPBrailleSpeechPanLeft
FHPBrailleSpeechPanRight
FHPBrailleSpeechPriorLine
FHPBraillexEL1D
FHPBraillexEL1L
FHPBraillexEL1R
FHPBraillexEL1U
FHPBraillexEL2D
FHPBraillexEL2L
FHPBraillexEL2R
FHPBraillexEL2U
FHPcursordown
FHPcursorleft
FHPcursorright
FHPcursorup
FHPLineRouting
FHPRoutingAux
FHPRouting
FSLeftRockerDown
FSLeftRockerUp
FSRightRockerDown
FSRightRockerUp
IncreaseBrailleAutoAdvanceSpeed
LeftFocusWhizWheelDown
LeftFocusWhizWheelUp
LeftWhizWheelDown
LeftWhizWheelUp
RightFocusWhizWheelDown
RightFocusWhizWheelUp
RightWhizWheelDown
RightWhizWheelUp
BrailleAddBrlCursorLine
BrailleAddFocusItem
BrailleAddFocusLine
BrailleAddFrame
BrailleAddString
BrailleAddTextBetween
BrailleBuildLine
BrailleBuildStatus
BrailleClearMessage
BrailleDescribeFont
BrailleDescribeItem
BrailleG2StringLength
BrailleGetCursorDots
BrailleGetStateString
BrailleGetSubtypeDisplayName
BrailleGetSubtypeString
BrailleGrade2ExpandCurrentWord
BrailleIsMessageBeingShown
BrailleIsStructuredLine
BrailleLine
BrailleMessageRepeatLast
BrailleMessage
BrailleRefresh
BrailleSetCursorDots
BrailleSetStatusCells
BrailleString
BrailleSwitchTransLanguage
BrlTranslateWindowText
ContainsBrlText
FocusGDBHelpMessage
FocusGeneralDisplayButtons
GetBrailleCellColumn
GetBrailleCellRow
GetLastBrailleRoutingKey
NextBrailleString
PointNeedsMarking
PriorBrailleString
RepeatLastFlashMessage
SetBrailleMessageStatusText
ShouldSetTranslation
ToggleContinuousBraille
TranslateText
BrailleChangeCursorShape
BrailleGrade2Translation
BrailleLineCursorShapeOff
BrailleSet6DOTS
BrailleSet8DOTS
BrailleSet8PixelsPerSpace
BrailleSetUnlimittedPixelsPerSpace
BrailleToggle8DOTS
BrailleToggle8PixelsPerSpace
BrailleToggleBrailleLineMode
BrailleToggleCharactersAndAttributes
BrailleToggleMarking
BrailleToggleMode
BrailleToggleSpeechHistory
BrailleToggleSpeechInterrupt
BrailleToggleTableHeaders
BrailleTurnMarkingOff
BrailleVerbosity
FHPAttributSettings
FHPBraille2DTogglePCMode
FHPBraille2DToggleReadingMode
FHPBrailleActiveCursorTracking
FHPBrailleKeyBrailleMode
FHPBrailleKeyBrailleSpeechMode
FHPBrailleKeyNavigationMode
FHPBrailleKeyPCMode
FHPBrailleKeyReadingMode
FHPBrailleKeySpeechMode
FHPBrailleLineMode
FHPBrailleSettings
FHPBrailleShowAllMarking
FHPBrailleShowBoldMarking
FHPBrailleShowHighlightMarking
FHPBrailleShowItalicMarking
FHPBrailleShowUnderlineMarking
FHPBrailleStructuredMode
FHPBrailleToggle68DOTS
FHPBrailleToggleAttributeDown
FHPBrailleToggleAttributeUp
FHPBrailleToggleCharactersAndAttributes
FHPBrailleToggleCursorShape
FHPBrailleToggleVertical
FHPBrailleTurnMarkingOff
FHPWorkingMode
GetBrailleMode
PressLeftFocusWheel
PressLeftWhizWheel
PressRightFocusWheel
PressRightWhizWheel
SetBrailleMode
SetBrailleVerbosity
ToggleGrade
ToggleOutputType
UseSecondaryBrailleLanguage
WhizWheelsOnOff
CloseListBox
ControlCanBeChecked
ControlIsChecked
dtpGetSubfield
GetControlAttributes
GetControlName
GetCurrentItem
GetCurrentListViewItemName
GetHotKey
GetItemCount
GetListViewText
GetProgressBarInfo
GetTreeViewLevel
HotKeyHelpDefaultLoopHelper
HotKeyHelpDefaultLoop
lvGetCRC
lvGetFocusItem
lvGetItemCount
lvGetItemRect
lvGetItemState
lvGetItemText
lvGetUserDefinedItemText
lvIsCustomized
lvSelectItem
lvSetFocusItem
MoveSliderPos
MoveToControl
MoveToFirstSdmControl
MoveToNextSdmControl
OpenListBox
PositionInGroup
ReadListviewColumn
SayControlExWithMarkup
SayControlEx
SayControlInformation
SayControl
SayCurrentAccessKey
SayLVItemCheckStatus
SayTreeViewItem
SayTreeViewLevel
SayTVFocusItemExpandState
SDMGetCurrentControl
SDMGetFirstControl
SDMGetFocus
SDMGetLastControl
SDMGetNextControl
SDMGetPrevControl
SDMSayControl
SDMSayStaticText
SDMSayWindowTypeAndText
SetCurrentItem
SpeakNewStateAfterFocusChange
SpeakProgressBarInfo
tbGetItemRect
tbGetItemState
tbGetItemText
tvCollapse
tvExpand
tvGetFocusItemExpandState
tvGetFocusItemText
tvGetItemStateImageIndex
tvSelectNextItem
tvSelectPriorItem
AboutBox
CheckAuthScheme
GetAuthCode
GetAuthLanguageCat
GetAuthScheme
GetAuthScriptLanguageCat
GetJFWSerialNumber
GetJFWSMACount
GetLockingCode
GetPMProductCategory
GetPMProductID
IsTNS
FindJAWSHelpFile
FindJAWSHomeFile
FindJAWSPersonalizedSettingsFile
FindJAWSSettingsFile
FindJAWSSoundFile
FindJAWSUtilityProgram
FindWindowsSystemFile
GetJAWSDirectory
GetJAWSHelpDirectory
GetJAWSMode
GetJAWSSettingsDirectory
GetJAWSUserName
GetJFWLang
GetJFWVersion
GetSharedSettingsDirectory
GetUserSettingsDirectory
IsJFWInstall
IsUnicodeJAWS
JAWSWindow
JAWSWindow
PathAddExtension
PathFindExtension
PathRemoveExtension
PathRenameExtension
ShutDownJAWS
ShutDownJAWS
SwitchRemoteMode
SwitchRemoteMode
ActiveItemChangedEvent
ClickObjectByName
ComAttachEvents
ComDetachEvents
CreateObjectEx
CreateObject
DescriptionChangedEvent
FocusToLink
GetCurrentLinkIndex
GetCurrentObject
GetFocusObject
GetLastMSAAAlertInfo
GetListOfObjects
GetNativeOMFromMSAA
GetObjectAtPoint
GetObjectContainerHelp
GetObjectDescription
GetObjectFromEvent
GetObjectHelp
GetObjectInfoByName
getObjectNameFromEvent
GetObjectName
GetObjectRect
GetObjectState
GetObjectSubTypeCode
GetObjectSubtype
GetObjectTypeCode
GetObjectType
GetObjectValue
GetObject
GetRichEditDocument
getRoleText
HJDialogObjStateChangeSpoken
IE4GetCurrentDocument
IsMSAAWindow
JavaObjectChanged
MSAAGetDialogStaticText
MSAARefresh
MSOGetMenuBarObject
NameChangedEvent
ObjStateChangedEvent
SayFocusedObject
SayObjectActiveItem
SayObjectTypeAndText
ValueChangedEvent
WindowVirtualView
AddTextAtPointToUserBuffer
DoJAWSFind
GetCharacter
GetChunk
GetField
GetFromStartOfLine
GetJAWSFindText
GetLine
GetParagraph
GetPriorCharacter
GetPriorWord
GetScreenEcho
GetSentence
GetTextBetween
GetToEndOfLine
GetWord
ItemNotFoundEvent
JAWSFindNext
JAWSFindNext
JAWSFindPrior
JAWSFind
JAWSFind
lvGetColumnHeader
NewTextEvent
NewTextGetRect
PhoneticSpellHook
ProcessNewText
SayAllBy
SayAllSayCaps
SayAllStoppedEvent
SayAll
SayAll
SayCharacterPhonetic
SayCharacter
SayCharacter
SayChunk
SayField
SayFromCursor
SayFromCursor
SayFromTopOfFile
SayLine
SayLine
SayNonHighlightedText
SayParagraph
SayParagraph
SaySentence
SaySentence
SayTextBetween
SayToCursor
SayToCursor
SayToPunctuation
SayToPunctuation
SayWord
SayWord
ScreenEchoToggle
ScreenEcho
ScreenStabilizedEvent
SetJAWSFindText
SetScreenEcho
SkimReadSummary
SkimRead
SpellFromCursor
SpellLine
SpellModeToggle
SpellMode
SpellToCursor
SpellWordHook
SpellWordPhonetic
SpellWord
StartSkimRead
ToggleSayCaps
GetCurrentSchemeName
IndicateControlState
IndicateControlType
SelectAScheme
smmGetBehaviorForControlState
smmGetBehaviorForControlType
smmGetBehavior
smmGetEndMarkupForAllCaps
smmGetEndMarkupForAttributes
smmGetEndMarkupForColor
smmGetEndMarkupForControlState
smmGetEndMarkupForControlType
smmGetEndMarkupForFontName
smmGetEndMarkupForFontSize
smmGetEndMarkupForSingleCap
smmGetMarkupForSymbol
smmGetSpeechMarkupTextOptions
smmGetStartMarkupForAllCaps
smmGetStartMarkupForAttributes
smmGetStartMarkupForColor
smmGetStartMarkupForControlState
smmGetStartMarkupForControlType
smmGetStartMarkupForFontName
smmGetStartMarkupForFontSize
smmGetStartMarkupForSingleCap
smmGetSymbolForMarkup
smmMarkupString
smmReplaceSymbolsWithMarkup
smmSchemeDefinesBehaviorFor
smmSetBehavior
smmSetDesiredUnitsOfMeasure
smmStripMarkup
smmToggleTrainingMode
smmTrainingModeActive
SwitchToScheme
ToggleSMMTrainingMode
AttributeEnumerate
AttributesChanged
AttributesChanges
FindFirstAttribute
FindLastAttribute
FindNextAttribute
FindPriorAttribute
FontChanges
FormatAndText
GetCharacterAttributes
GetCharacterFont
GetCharacterPoints
GetCharacterWidth
GetFont
GetLineBottom
GetLineTop
GetParagraphFormatInfo
GetStringWidth
GetWordWidth
IntToAttribName
IsRtlChar
IsRtlReading
PointSizeChanges
ProcessRepetitions
SayAttributesChanges
SayControlAttribBits
SayFont
SayFont
SayFormatAndText
SayTextAndAttributes
ActivateRunDialog
DlgCustomizeListview
DlgGetCustomSummaryInfo
DlgSelectControls
dlgSelectFunctionToRun
DlgSelectItemInList
DlgSelectScriptToRun
DlgSkimRead
DlgSysTray
ExMessageBox
InHJDialog
InputBox
IsSelectItemDlg
IsSelectScriptDlg
MessageBox
SkimReadDialog
SmartMinimize
StartJAWSTaskList
TimedMessageBox
AddHotKeyLinks
RedirectToUserBuffer
RedisplayPrevField
UserBufferActivateEx
UserBufferActivate
UserBufferAddText
UserBufferClear
UserBufferDeactivate
UserBufferGetFontInfo
UserBufferGetLength
UserBufferGetText
UserBufferIsActive
UserBufferIsTrappingKeys
UserBufferPrevWindowName
userBufferPrevWindowType
UserBufferSetFontInfo
UserBufferWindowName
userBufferWindowType

----------
Script Basics

Writing Script Files

Editing

Edit JAWS Script Source (.JSS) files from within any text editor. Those new to
scripting may find it easiest to use the JAWS Script Manager. The Script
Manager provides many helpful tools for navigating through a script file,
providing script language help, formatting scripts, inserting built in
functions, writing the script documentation, and so on. To get started using
the JAWS script manager, choose the "Help Topics" item from the "Help" menu.
Activate the Script Manager from within any application by pressing insert+0,
or from the "Run JAWS Manager" Dialog.

Naming

Script files follow the same naming and location conventions as all *Add JAWS
Settings Files. Storing script files in the Jaws\Settings\(Language) directory
insures that all necessary include files are present at compile time. By
default, the JAWS Script Manager creates files with the same root name as the
active application executable, and places them into the
Jaws\Settings\(Language) directory.

Compiling Script Files

The JAWS Script Manager compiles an active script file whenever the "Save"
option is selected from the "File" menu. The compiler gives the resulting
binary file the same root name as the script source file, and places it in the
same directory. JAWS will load the new binary file the next time the
application with the same root name receives focus by moving into the Windows
foreground.

Those who choose to edit script source files with a text editor can use the
application "SCompile.exe", located in the JAWS root directory, to compile
them from the command line. Call "SCompile", passing in script source file
names. The compiler accepts wild cards, so that many source files may be
compiled with one command.

----------
Scripting JAWS for Pocket PC

Basics

Scripting JAWS for Pocket PC is essentially the same as scripting for desktop
JAWS. However, in order to conserve space, the script source files are not
included on the PAC Mate unit itself. Choose Download PAC Mate Script Source
to download the script source for JAWS for Pocket PC. To make changes or
additions, unzip the source archive to a working area on the desktop PC. Once
scripts have been editted and compiled on the desktop, copy the resulting
binary files into the \Windows\Settings\(language) directory on the device.

Important: These scripts must be compiled with the command line utility
"SCompile.exe", which, is available from the Download PAC Mate Script Source
page.

Pocket PC specific functions

Some functions listed in the reference section of this SDK may not be
compatible with JAWS for Pocket PC. Please check the help topic of a function
to insure the function's compatibility with PAC Mate.

Tips

Reloading script binaries

Unlike the desktop, scripting for a Pocket PC application may occur without
focus ever leaving the app. JAWS for Pocket PC provides a keystroke to reload
all the script binaries from the "Settings" directory. Using this keystroke,
scripters don't have to leave the application, and then come back, to make
JAWS reload the script binary.

Keystrokes:
	* PAC Mate QX - JawsKey+Control+Escape
	* PAC Mate BX - Dot 8 Chord &F1 Chord

Advanced layer BX keystrokes

On the PAC Mate BX, advanced commands commonly used for scripting and JAWS
customization have been placed into an Advanced layer. Activate the layer by
pressing Dot 8 Chord. Once the layer is active, type a question mark (Dots
1-4-5-6) for a list of commands.

Home Row on the PAC Mate QX

Please note that the keystroke to toggle Home Row mode on the QX has changed
from desktop versions of JAWS, to JawsKey+equals.

----------
Download PAC Mate Scripts

Click a version number in the following table to download a zip archive
containing the script source for that version of JAWS for Pocket PC.

Sscripts listed on this page from PAC Mate versions 2.01 and earlier must be
compiled using the following command line utility: SCompile.

Scripts from PAC Mate versions 2.2 and later may be compiled using the JAWS
Script Manager or SCompile utilities from JAWS 5.0 or later.
Product Version
PAC Mate	1.0
PAC Mate	1.1
PAC Mate	2.0
PAC Mate	2.01
PAC Mate	2.2
PAC Mate	2.5
PAC Mate	3.0
PAC Mate	4.0
PAC Mate	4.1

----------
If

Keyword: If

Description

The If keyword marks the beginning of an If...Then...Else... statement. A
fully formulated statement includes: If...Then...Else...EndIf. The script
functions that appear between the If and the Then are used to evaluate whether
a certain condition is present. For example, can a certain graphics character
be found in the active window? Every statement must include If...Then...EndIf.
The Else is optional

----------
ElIf

Keyword: ElIf

Description

Instead of using the Else keyword in an If...Then...Else...statement, you may
want to use the ElIf keyword. The statement could then be reconstructed as an
If...Then...ElIf...Then...Else...statement. The script functions that appear
between the ElIf and the Then are used to evaluate whether a certain condition
is present

----------
Else

Keyword: Else

Description

The Else keyword is an optional part of an If...Then...Else... statement.
If...Then...Else...statements always ask a question about whether something is
true or false, That is, is a condition present or not present. When the
condition is not present (false), then the actions that follow the Else are
performed. An If...Then...Else...statement must always include:
If...Then...EndIf. The Else is optional

----------
EndIf

Keyword: EndIf

Description

The EndIf keyword marks the end of an If...Then...statement. A fully
formulated If...Then...statement includes the keywords If, Then, and EndIf.
Each of these keywords is required.

----------
While

Keyword: While

Description

The While keyword marks the beginning of a While loop. The While keyword must
be followed by a conditional statement enclosed in parenthesis. While loops
allow a given set of actions to be performed repeatedly as long as the
conditions specified after the While keyword return true. Every While loop
must end with the EndWhile keyword. Loops may be used to save space and
programming time. However they can also be dangerous. It is important to
ensure that the tested condition is met at least once. Otherwise, the code
between While and EndWhile will never be run. Furthermore, the tested
condition must eventually return false. Otherwise an infinite loop will be
created at runtime.

----------
EndWhile

Keyword: EndWhile

Description

The EndWhile operator marks the end of a While loop. The script functions that
are to be repeated must be placed between While and EndWhile.

----------
Not

Keyword: Not

Description

The Not keyword reverses the question asked by an If...Then...Else...
statement. It is placed immediately after the If. It says, "If the specified
condition is not present, then perform the following actions"

----------
Return

Keyword: Return

Description

The Return keyword terminates execution of the function in which it appears
and returns control (and the value of an expression, if given) to the calling
function. To define return values, the name of the function is preceded by the
return type. Since a script cannot return a value, a Return keyword that is
used from within a script should never be followed by a value

----------
AppendToClipboard

Function: AppendToClipboard

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

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

Parameters

Param 1:

Type: String
Description: The string to append.
Include: Required

Param 2:

Type: Int
Description: TRUE if adding string to the End.  FALSE if adding to the front.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
ClipboardChangedEvent

Function: ClipboardChangedEvent

Description

This event is called whenever the contents of the Windows clipboard is
replaced.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ClipboardHasData

Function: ClipboardHasData

Description

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

Returns

Type: Int
Description: True if the clipboard contains data, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
CopySelectedTextToClipboard

Script: CopySelectedTextToClipboard

Description

Standard Windows copy command, usually found in the Edit menu, any selected
text or items will be copied to the Windows Clipboard.  The selected items or
text can then be pasted into another window or application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
CopyToClipboard

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.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Text to be copied to the Windows clipboard.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
CutToClipboard

Script: CutToClipboard

Description

Standard Windows cut command, usually found in the Edit menu, any selected
text or items will be deleted and placed in the Windows Clipboard. Note that
after doing so use paste command to move the items or text elsewhere.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetClipboardText

Function: GetClipboardText

Description

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

Returns

Type: STRING
Description: The text found on the clipboard, or "" if the clipboard is empty.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
GetTextFromClipboard

Function: GetTextFromClipboard

Description

Retrieves plain text from clipboard.

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
PasteFromClipboard

Script: PasteFromClipboard

Description

Standard Windows Paste command, usually found in the Edit menu, any text or
items currently in the Clipboard is inserted at the position of the PC cursor.
Note that you must have previously used the copy or cut commands to place the
items on the Clipboard before using the paste command.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Replace

Script: Replace

Description

Activates the Replace menu item in the application, used to find and replace
text.  May not be available in every application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
WasTextAlreadyAppended

Function: WasTextAlreadyAppended

Description

Checks if text is already in the clipboard.

Returns

Type: Int
Description: TRUE if already exists.

Parameters

Param 1:

Type: String
Description: The current collection of appended text.
Include: Required

Param 2:

Type: String
Description: The text that is about to be appended.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
WillOverwriteClipboard

Function: WillOverwriteClipboard

Description

If the clipboard has text resulting from an append to clipboard operation,
asks the user if the clipboard text should be overwritten.

Returns

Type: int
Description: True if the clipboard does not has text resulting from an append
operation or if the user answers yes to the query asking if they want to
overwrite the clipboard text, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
AppendSelectedTextToClipboard

Script: AppendSelectedTextToClipboard

Description

With the Freedom clipboard, text will be appended to the clipboard, adding it
to the clipboard at the end of the previous clipboard content. Using a Copy To
Clipboard command instead of an Append To Clipboard command will erase any
previous clipboard content and replace it with the new content.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
AddBrailleColors

Function: AddBrailleColors

Description

Brings up a dialog for the user to assign the colors on the screen to Braille
marking.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Enter the variable containing the RGB string for the foreground
color.
Include: Required

Param 2:

Type: String
Description: Enter the RGB string for the background color.
Include: Required

Param 3:

Type: String
Description: Enter the value for the app file name to be used.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BackgroundColorChanges

Script: BackgroundColorChanges

Description

Speaks the color changes of the background when encountered. Useful for
proofreading documents.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51-5.20 and later

----------
BrailleColorMarkingAssign

Script: BrailleColorMarkingAssign

Description

Brings up a dialog for you to assign the colors on the screen to Braille
marking.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSetColorsToMark

Function: BrailleSetColorsToMark

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

Type: Void

Parameters

Param 1:

Type: String
Description: up to 9 pairs of text and background colors of the form
rgb/rgb,rgb/rgb,... Supply empty string to turn off color marking.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ColorToRGBString

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

Type: String
Description: The color value converted to an RGB string.

Parameters

Param 1:

Type: Int
Description: The color value to be used.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindColors

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

Type: Int
Description: The number is 1 if the search was successful, 0 if it was not
successful.

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Required

Param 3:

Type: Int
Description: 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.
Include: Required

Param 4:

Type: int
Description: 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
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetColorApproximation

Function: GetColorApproximation

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

Type: int
Description: The color approximately the same as the one past in.

Parameters

Param 1:

Type: int
Description: the color to approximate.
Include: Required

Param 2:

Type: int
Description: 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.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
GetColorAtPoint

Function: GetColorAtPoint

Description

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

Returns

Type: Int
Description: The color value at the specified point.

Parameters

Param 1:

Type: Int
Description: the column coordinate of the desired location. You can use
GetCursorCol() to retrieve this value.
Include: Required

Param 2:

Type: Int
Description: the row coordinate of the desired location. You can use
GetCursorRow() to retrieve this value.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetColorBackground

Function: GetColorBackground

Description

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

Returns

Type: Int
Description: The background color value.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetColorField

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

Type: String
Description: The color field pointed by the active cursor.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetColorName

Function: GetColorName

Description

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

Returns

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

Parameters

Param 1:

Type: Int
Description: The color value to be used.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetColorText

Function: GetColorText

Description

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

Returns

Type: Int
Description: The text color value.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ReloadSystemColors

Function: ReloadSystemColors

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
RGBDecToHex

Function: RGBDecToHex

Description

This function converts a Decimal RGB string to a Hex RGB string.

Returns

Type: string
Description: The Hex RGB string.

Parameters

Param 1:

Type: string
Description: the Decimal RGB string.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
RGBHexToColor

Function: RGBHexToColor

Description

This function converts a hex RGB string to its int color value.

Returns

Type: int
Description: the color

Parameters

Param 1:

Type: string
Description: the hex string eg "#rrggbb" or "rrggbb"
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
RGBHexToDec

Function: RGBHexToDec

Description

This function converts a Hex RGB string to a Decimal RGB string.

Returns

Type: string
Description: the decimal string.

Parameters

Param 1:

Type: string
Description: the hex string to convert.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
RGBStringToColor

Function: RGBStringToColor

Description

Converts a 9-digit string of the form "255255255" to a color value.

Returns

Type: Int
Description: A color value suitable for comparison with the values returned by
GetColorText or GetColorBackground.

Parameters

Param 1:

Type: string
Description: The 9-digit RGB value to be converted.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayColor

Function: SayColor

Description

Speaks the names of the foreground and background colors of the text at the
location of the active cursor.

Returns

Type: Int
Description: "TRUE" = 1, Text was found. "FALSE" = 0, cursor was not pointing
to text.

Parameters

Param 1:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayColor

Script: SayColor

Description

It says the color of the text at the active cursor position.  This keystroke
uses the values indicated in colors.ini to define the colors from the RGB
values.  If you hear numbers instead of colors, add a corresponding entry to
the colors.ini file and define its color.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TextColorChanges

Script: TextColorChanges

Description

Speaks the color changes of the text when encountered. Useful for proofreading
documents.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51-5.20 and later

----------
ActiveMovesBraille

Script: ActiveMovesBraille

Description

By default the Braille display will follow the active cursor. If this feature
is turned Off, the Braille display can be left in one location.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BottomEdgeEvent

Function: BottomEdgeEvent

Description

When the active cursor attempts to move beyond the bottom edge of the active
window, this function is called and receives the window handle as a parameter.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of the window whose bottom boundary was reached.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleCursor

Function: BrailleCursor

Description

Turns on the Braille cursor. This cursor is only used internally by the
Braille scripts and should never be left on after a script completes its work.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleMovesActive

Script: BrailleMovesActive

Description

Toggles whether or not the active cursor follows the Braille cursor when the
front panel keys on a Braille display are pressed.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleCursor

Script: BrailleToggleCursor

Description

Sets the opposite cursor active.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
CaretVisible

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

Type: Int
Description: "TRUE" = 1, "FALSE" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ConvertCursorShape

Function: ConvertCursorShape

Description

Takes the cursor shapes reported by MSAA and converts them to more meaningful
names.

Returns

Type: String
Description: Returns name of the cursor as a string.

Parameters

Param 1:

Type: string
Description: takes the name of the type of cursor.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
CursorShapeChangedEvent

Function: CursorShapeChangedEvent

Description

The name of the new shape is passed to this function via a string variable.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: the string value for the current cursor type.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindCaret

Function: FindCaret

Description

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

Returns

Type: Int
Description: TRUE if the function is determining the correct caret location,
false otherwise.

Parameters

Param 1:

Type: Int
Description: set to x coordinate of caret.
Include: Required
* Returns data by reference

Param 2:

Type: Int
Description: set to y coordinate of caret.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
FocusPointMovedEvent

Function: FocusPointMovedEvent

Description

It is called when the pixel location of the blinking caret or highlight
changes. Note that the pixel location is determined by video resolution as in
row and column coordinates.  Because this function will be called quite
frequently, it is recommended that you avoid from intensive tasks that will be
performed each time the PC cursor moves. For a list of parameters received by
FocusPointMovedEvent and their descriptions, look at the Existing Parameters
List box on the Parameters page.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Current horizontal coordinate of the PC cursor.
Include: Required

Param 2:

Type: Int
Description: Current vertical coordinate of the PC cursor.
Include: Required

Param 3:

Type: Int
Description: Previous horizontal coordinate of the PC cursor.
Include: Required

Param 4:

Type: Int
Description: Previous vertical coordinate of the PC cursor.
Include: Required

Param 5:

Type: Int
Description: The unit of movement as constant variables defined in
HJConst.jsh.
Include: Required

Param 6:

Type: Int
Description: The direction of movement as constant variables defined in
HJConst.jsh.
Include: Required

Param 7:

Type: Int
Description: The amount of time (milliseconds)that has elapsed since the
movement occurred.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetActiveCursor

Function: GetActiveCursor

Description

This determines which cursor is active.

Returns

Type: Int
Description: CURSOR_JAWS = 0, CURSOR_PC = 1, CURSOR_INVISIBLE = 2,
CURSOR_Braille = 3.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetActiveCursorName

Function: GetActiveCursorName

Description

This function returns the name of the active cursor.

Returns

Type: string
Description: the name of the active cursor.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetBrailleRestriction

Function: GetBrailleRestriction

Description

Gets the restriction value for the Braille cursor.  These values are located
in HjConst.jsh and start with Restrict.

Returns

Type: Int
Description: a constant representing the current level of cursor restriction.
These constants begin uncder the heading Restriction types, and can be found
in hjconst.jsh. They are: RestrictNone to allow the cursor to roam the screen,
RestrictAppWindowto restrict to the application window, RestrictRealWindow to
restrict to the real window or RestrictWindow to restrict to the current
window.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetCursorCol

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

Type: Int
Description: the value of the active cursor column position.

Parameters

Param 1:

Type: Int
Description: Optional parameter that designates whose cursor position is to be
retrieved.  If this parameter is not specified, then the active cursor is
used.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCursorRow

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

Type: Int
Description: the value of the active cursor row position.

Parameters

Param 1:

Type: Int
Description: Optional parameter that designates whose cursor position is to be
retrieved.  If this parameter is not specified, then the active cursor is
used.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCursorShape

Function: GetCursorShape

Description

Gets the current shape of the mouse cursor.

Returns

Type: String
Description: The shape of the current cursor. It may be one of the following
values; Arrow Cursor, I beam cursor, Hour Glass, or cross hair cursor.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetRestriction

Function: GetRestriction

Description

Gets the restriction value for the current cursor.  These values are located
in HjConst.jsh and start with Restrict.

Returns

Type: Int
Description: a constant representing the current level of cursor restriction.
These constants begin uncder the heading Restriction types, and can be found
in hjconst.jsh. They are: RestrictNone to allow the cursor to roam the screen,
RestrictAppWindowto restrict to the application window, RestrictRealWindow to
restrict to the real window or RestrictWindow to restrict to the current
window.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetRestrictionName

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

Type: Void

Parameters

Param 1:

Type: Int
Description: The first parameter requires a constant indicating the current
level of cursor restriction. The function GetRestriction can provide a
constant for this value.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
InvisibleCursor

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsBrailleCursor

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

Type: Int
Description: "ACTIVE" = 1, "INACTIVE" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsInvisibleCursor

Function: IsInvisibleCursor

Description

Used to determine whether the invisible cursor is active. It can be used in an
If...Then...Else...statement to verify the active status of a cursor.

Returns

Type: Int
Description: "ACTIVE" = 1, "INACTIVE" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsJAWSCursor

Function: IsJAWSCursor

Description

Determines whether the JAWS cursor is active. It can be used in an
If...Then...Else...statement to verify the active status of a cursor.

Returns

Type: Int
Description: "ACTIVE" = 1, "INACTIVE" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsPCCursor

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

Type: Int
Description: "ACTIVE" = 1, "INACTIVE" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsVirtualPCCursor

Function: IsVirtualPCCursor

Description

Checks to see if the Virtual PC cursor is being used to navigate within the
window with focus.

Returns

Type: Int
Description: TRUE if the Virtual PC cursor is active, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSCursor

Function: JAWSCursor

Description

This activates the JAWS cursor and deactivates other cursors.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSCursor

Script: JAWSCursor

Description

Deactivates other cursors.  If pressed twice quickly, it will activate the
Invisible cursor.  The JAWS cursor has similar functionality as the mouse
pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveTo

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

Type: Int
Description: TRUE if move was successful, FALSE if one or both coordinates are
off the edge of the screen.

Parameters

Param 1:

Type: Int
Description: X-coordinate.
Include: Required

Param 2:

Type: Int
Description: Y-Coordinate.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PCCursor

Function: PCCursor

Description

This activates the PC cursor and deactivates other cursors.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PCCursor

Script: PCCursor

Description

The PC cursor can be used for editing purposes, maneuvering menus, and using
other specific controls depending on the active application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ProcessBoundaryStrike

Function: ProcessBoundaryStrike

Description

This function is called by TopEdgeEvent and BottomEdgeEvent to perform an
action when a user tries to move past a boundary.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: The handle of the window where the edge was reached.
Include: Required

Param 2:

Type: int
Description: The boundary edge which was reached. Currently TopEdge and
BottomEdge are defined in HJConst.jsh.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
RestoreCursor

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RestrictBrailleCursor

Script: RestrictBrailleCursor

Description

Toggles on and off the restriction of the Braille cursor.  This is similar to
the restriction of the JAWS cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RestrictCurrentCursor

Script: RestrictCurrentCursor

Description

If the JAWS or Invisible cursor is on, you can toggle between Current Window
Restriction, Unrestricted, Frame restriction and Application Window
restriction

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RestrictCursor

Function: RestrictCursor

Description

It is now recommended when restricting the JAWS or Invisible cursors, to use
the SetRestriction function. This function has been kept to avoid causing
errors in older JFW scripts

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Determines whether restriction should be turned Off or On.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RestrictJAWSCursor

Script: RestrictJAWSCursor

Description

Sometimes you want to read only within a small window or control, like a list
box, and sometimes you need to read all around the application window or a
dialog box.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteBrailleToActiveCursor

Script: RouteBrailleToActiveCursor

Description

Repositions the Braille cursor so that it is in the same position as the
active cursor.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteBrailleToJAWS

Function: RouteBrailleToJAWS

Description

Repositions the Braille cursor so that it is in the same position as the JAWS
cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteBrailleToJAWS

Script: RouteBrailleToJAWS

Description

Repositions the Braille cursor so that it is in the same position as the JAWS
cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteBrailleToPc

Function: RouteBrailleToPc

Description

Repositions the Braille cursor so that it is in the same position as the PC
cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteBrailleToPC

Script: RouteBrailleToPC

Description

Repositions the Braille cursor so that it is in the same position as the PC
cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteInvisibleToJAWS

Function: RouteInvisibleToJAWS

Description

Moves the Invisible cursor to the location of the JAWS cursor and activates
the Invisible cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteInvisibleToPc

Function: RouteInvisibleToPc

Description

Moves the Invisible cursor to the location of the PC cursor and activates the
Invisible cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteJAWSCursorToPc

Script: RouteJAWSCursorToPc

Description

Routes the JAWS cursor, or the Invisible cursor if it is active, to the
location of the PC cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteJAWSToBraille

Function: RouteJAWSToBraille

Description

Repositions the JAWS cursor so that it is in the same position as the Braille
cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteJAWSToInvisible

Function: RouteJAWSToInvisible

Description

Moves the JAWS cursor to the location of the Invisible cursor and activates
the JAWS cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteJAWSToPc

Function: RouteJAWSToPc

Description

This repositions the JAWS cursor so that it is in the same position as the PC
cursor. The JAWS cursor is usually connected to the mouse pointer, so when
this function is used, it places the mouse pointer on top of the caret or the
highlighted selection cursor, or on whatever other type of pointer that is
currently being used.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RoutePCCursorToJAWS

Script: RoutePCCursorToJAWS

Description

Routes the PC cursor to the location of the JAWS cursor. The PC cursor is
controlled by the application and it usually cannot go everywhere in the
window as the JAWS cursor can.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RoutePCToBraille

Function: RoutePCToBraille

Description

Repositions the PC cursor so that it is in the same position as the Braille
cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RoutePCToInvisible

Function: RoutePCToInvisible

Description

Turns on the PC Cursor and moves it, if possible, to the position of the
invisible cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RoutePcToJAWS

Function: RoutePcToJAWS

Description

This attempts to move the PC cursor to the position of the JAWS cursor. This
function is the same as a single click of the left mouse button, which
instructs Windows to move its insertion point to the position of the mouse
pointer. The successful use of this function is related to the Windows
operating system. There are often situations where Windows cannot move the PC
cursor to the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RouteVirtualToMouse

Function: RouteVirtualToMouse

Description

This function moves the Virtual cursor to the position of the Mouse cursor in
documents that are supported by the FS DOM Server.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
RouteVirtualToPc

Function: RouteVirtualToPc

Description

This function moves the Virtual cursor to the position of the PC cursor in an
HTML document. For example, when a new page loads and a SayAll is initiated
and you want to move back to the formfield with the focus, use this function.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SaveCursor

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayActiveCursor

Function: SayActiveCursor

Description

This speaks the name of the active cursor, for example, PC, JAWS, Invisible,
or Braille.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayActiveCursor

Script: SayActiveCursor

Description

Says the name of the active cursor and its position by pixel.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCursorPos

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.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCursorType

Script: SayCursorType

Description

The shape of the mouse pointer indicates what the mouse can do at the current
location.  For example, if JAWS cursor is active and the mouse pointer shape
is a hand pointing to a link, clicking the left mouse button opens the item at
the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetActiveCursor

Function: SetActiveCursor

Description

According to the constant definition defined in the HJCONST.JSH file, sets the
active cursor.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: uses constant variable defined in the HJCONST.JSH file for
setting the cursor.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetBrailleRestriction

Function: SetBrailleRestriction

Description

selects the area within which the Braille cursor is fre to move. Note has no
effect if Tether Braille To Active is on.

Returns

Type: Int
Description: TRUE if the resttriction was set, false if the Braille cursor is
tethered to another cursor.

Parameters

Param 1:

Type: Int
Description: one of  the constants beginning with Restrict defined in
hjconst.jsh.   Use RestrictNone to allow the cursor to roam the screen,
RestrictAppWindowto restrict to the application window, RestrictRealWindow to
restrict to the real window or RestrictWindow to restrict to the current
window.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SetRestriction

Function: SetRestriction

Description

For all cursors except the PC cursor, selects the area within which the cursor
is fre to move.

Returns

Type: Int
Description: FALSE when the PC cursor is on, TRUE otherwise.

Parameters

Param 1:

Type: Int
Description: one of  the constants beginning with Restrict defined in
hjconst.jsh.   Use RestrictNone to allow the cursor to roam the screen,
RestrictAppWindowto restrict to the application window, RestrictRealWindow to
restrict to the real window or RestrictWindow to restrict to the current
window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetRestrictionToFrame

Function: SetRestrictionToFrame

Description

For all cursors except the PC cursor, selects the area within which the cursor
is fre to move.

Returns

Type: Int
Description: FALSE if the PC cursor is on or if the specified frame does not
exist, TRUE otherwise.

Parameters

Param 1:

Type: String
Description: The name of the frame whose borders will serve as restricting
boundaries for the cursor.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SetRestrictionToRect

Function: SetRestrictionToRect

Description

For all cursors except the PC cursor, selects the area within which the cursor
is fre to move.

Returns

Type: Int
Description: FALSE if the PC cursor is on or if the  rectangle is invalid,
TRUE otherwise.

Parameters

Param 1:

Type: Int
Description: Left edge of rectangle.
Include: Required

Param 2:

Type: Int
Description: top edge of rectangle.
Include: Required

Param 3:

Type: Int
Description: right edge of rectangle.
Include: Required

Param 4:

Type: Int
Description: bottom edge of rectangle.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TetherJAWSToPC

Script: TetherJAWSToPC

Description

If the Tether option is on, the JAWS Cursor will follow the PC cursor as it
moves.  You can still navigate and explore with the JAWS Cursor independently,
but if the PC cursor moves, the JAWS Cursor will follow.  To save your current
setting so JFW will remember it the next time you restart, press twice quickly
within a second.  When you save, JAWS will announce the current setting being
stored.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ToggleRestriction

Function: ToggleRestriction

Description

This toggles JAWS between restricted and unrestricted mode. These modes do not
affect the movement of the PC cursor. When unrestricted mode is used, the
other cursors can be freely moved within the active application window. When
restricted mode is used, the movement of these cursors is limited to a child
window. When the function is used, it returns a constant value representing
the new setting. ON indicates that the restriction is on, and OFF indicates
that the restriction is off.

Returns

Type: Int
Description: "ON" = 1, "OFF" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TopEdgeEvent

Function: TopEdgeEvent

Description

When the active cursor attempts to move beyond the top edge of the current
window, this function is called and receives the window handle as a parameter.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of the window whose top boundary was reached.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
VirtualPCCursorToggle

Script: VirtualPCCursorToggle

Description

When in a web document this command toggles between the classic style
interface and the virtual cursor interface.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsFormsModeActive

Function: IsFormsModeActive

Description

Checks to determine if Forms Mode is active within the window containing the
active cursor.

Returns

Type: Int
Description: TRUE if the Forms Mode is active, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
RoutePCToVirtual

Function: RoutePCToVirtual

Description

This function moves the location of the aplication focus to the location of
the virtual cursor.

Returns

Type: Int
Description: TRUE if the PC cursor's location was successfully moved, FALSE
otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
RoutePCToVirtual

Script: RoutePCToVirtual

Description

This function moves the location of the aplication focus to the location of
the virtual cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
TULSwitchToRuleSet

Function: TULSwitchToRuleSet

Description

This function switches the TextUnitLocator module to use the named rule set
for the currently active cursor. If the name is empty, the default rules set
for the current cursor and window class will be used. When switching to the
default, the following search is performed: attempt to switch to a set for the
current cursor and window class, if not found, switch to the rule for the
current cursor, if not found, switch to the default rule. See default.jcf
sections whose names begin with TextUnitRuleSet for details. The string
following the first part of the section name is used as the rule set name for
this function. For example, to switch to the rule set for the section whose
name is "TextUnitRuleSet joe", use TULSwitchToRuleSet("joe"). See default.jcf
for details about the keys for a rule.

Returns

Type: int
Description: TRUE or FALSE depending on whether the switch succeeded.

Parameters

Param 1:

Type: string
Description: of rule to switch active cursor to or empty string to switch back
to default for current situation.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
DialogActive

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

Type: Int
Description: "ACTIVE" = 1, "INACTIVE" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DialogList

Function: DialogList

Description

This function, if activated from within a dialog, will present a list box
containing the controls of the dialog box. Select a dialog control and press
Enter to move to it, or press Alt+L to perform a left mouse click on the
desired item. Note: This function is designed for use within standard Windows
dialogs. It may not return complete information for nonstandard dialog boxes.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DialogListHelper

Function: DialogListHelper

Description

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description:
Include: Required
* Returns data by reference

Param 2:

Type: string
Description:
Include: Required
* Returns data by reference

Param 3:

Type: string
Description:
Include: Required
* Returns data by reference

Param 4:

Type: int
Description:
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DialogPageChangedEvent

Function: DialogPageChangedEvent

Description

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: the handle of the window containing the page of the dialog that
is currently active.
Include: Required

Param 2:

Type: Handle
Description: the handle of the window containing the page of the dialog that
was previously active.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetDefaultButtonName

Function: GetDefaultButtonName

Description

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

Returns

Type: String
Description: Provides the name of the default dialog button.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetDialogPageName

Function: GetDialogPageName

Description

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

Returns

Type: String
Description: The name of the current page.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetDialogStaticText

Function: GetDialogStaticText

Description

Gets the static text in a dialog box.

Returns

Type: String
Description: The static text found in a Dialog box.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetGroupBoxName

Function: GetGroupBoxName

Description

Gets the name of the current Group box.

Returns

Type: String
Description: The name of the Group box.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsMultiPageDialog

Function: IsMultiPageDialog

Description

Checks to see if the active cursor is positioned inside a multi-page dialog
box.

Returns

Type: Int
Description: TRUE if this is a multipage dialog, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NextDocumentWindow

Script: NextDocumentWindow

Description

Used to switch between document windows or group windows, also switches
between the different page tabs in Multi-page Dialog boxes.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PreviousDocumentWindow

Script: PreviousDocumentWindow

Description

Used to switch between document windows or group windows also switches between
the different page tabs in Multi-page Dialog boxes

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ReadBoxInTabOrder

Script: ReadBoxInTabOrder

Description

May not work in every dialog box, especially those that are non-standard
windows, such as SDM controls.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayDefaultButton

Script: SayDefaultButton

Description

Dialog boxes usually have a button that is the default, such as Okay or No.
This button indicates the function that will be performed when you press the
ENTER key, unless focus is on another button. Use This keystroke to determine
which function will be performed.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FileExists

Function: FileExists

Description

Checks to see if the specified path exists.

Returns

Type: Int
Description: TRUE if the path exists.

Parameters

Param 1:

Type: String
Description: The file to be checked.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FilenameGetNearestMatch

Function: FilenameGetNearestMatch

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

Type: String
Description: The nearest matching filename to the one specified.

Parameters

Param 1:

Type: String
Description: The filename (including optional path). If the path is not
specified the script directory is assumed.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Required

Param 3:

Type: Int
Description: Set this to true if the extention must match.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
FileNameList

Function: FileNameList

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

Type: String
Description: a delimited list of file names matching the specified criteria.

Parameters

Param 1:

Type: String
Description: sFileNameMask filename mask optionally including path
information. If no path is included, the settings/lang path is prepended
Include: Required

Param 2:

Type: String
Description: sDelim the delimiter to separate filenames with. If no delimiter
is supplied, \007 is used.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetFileDate

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

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

Parameters

Param 1:

Type: string
Description: Enter the fully qualified path name of the desired application.
GetAppFilePath can be used to get the path of the currently running
application.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IniFlush

Function: IniFlush

Description

Flushes all previous writes by IniWriteInteger or IniWriteString specified for
the file indicated by strFile. Not flushing will not guarantee that the newly
written will be available for subsequent reading functions.

Returns

Type: Int
Description: FALSE is always returned regardless if flushing is successful for
not.

Parameters

Param 1:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniFlushEx

Function: IniFlushEx

Description

Flushes all previous writes by IniWriteInteger or IniWriteString specified for
the file indicated by strFile. Not flushing will not guarantee that the newly
written will be available for subsequent reading functions.

Returns

Type: Int
Description: FALSE is always returned regardless if flushing is successful for
not.

Parameters

Param 1:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 2:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniReadInteger

Function: IniReadInteger

Description

Reads an integer value from an ini style file.  An ini style file is a file
containing sections of keys with their values.

Returns

Type: Int
Description: The retrieved value or the default value if the key does not
exist in the given section.

Parameters

Param 1:

Type: String
Description: The name of the section containing the desired key value.  This
value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The name of the key whose value is to be retrieved.  This value
must either be a variable or contained in quotes.
Include: Required

Param 3:

Type: Int
Description: The value that will be returned if the key cannot be retrieved.
Include: Required

Param 4:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IniReadIntegerEx

Function: IniReadIntegerEx

Description

Reads an integer value from an ini style file.  An ini style file is a file
containing sections of keys with their values.

Returns

Type: Int
Description: The retrieved value or the default value if the key does not
exist in the given section.

Parameters

Param 1:

Type: String
Description: The name of the section containing the desired key value.  This
value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The name of the key whose value is to be retrieved.  This value
must either be a variable or contained in quotes.
Include: Required

Param 3:

Type: Int
Description: The value that will be returned if the key cannot be retrieved.
Include: Required

Param 4:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 5:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniReadSectionKeys

Function: IniReadSectionKeys

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

Type: String
Description: 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.

Parameters

Param 1:

Type: String
Description: The name of the section containing the desired key value.  This
value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IniReadSectionKeysEx

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

Type: String
Description: 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.

Parameters

Param 1:

Type: String
Description: The name of the section containing the desired key value.  This
value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 3:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniReadSectionNames

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

Type: String
Description: The section names as a list of strings delimited by the '|'
character.  If there no sections, a empty string is returned.

Parameters

Param 1:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IniReadSectionNamesEx

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

Type: String
Description: The section names as a list of strings delimited by the '|'
character.  If there no sections, a empty string is returned.

Parameters

Param 1:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 2:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniReadString

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

Type: String
Description: The retrieved value or the default value if the key does not
exist in the given section.

Parameters

Param 1:

Type: String
Description: The name of the section containing the desired key value.  This
value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The name of the key whose value is to be retrieved.  This value
must either be a variable or contained in quotes.
Include: Required

Param 3:

Type: String
Description: The value that will be returned if the key cannot be retrieved.
This value must either be a variable or contained in quotes.
Include: Required

Param 4:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IniReadStringEx

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

Type: String
Description: The retrieved value or the default value if the key does not
exist in the given section.

Parameters

Param 1:

Type: String
Description: The name of the section containing the desired key value.  This
value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The name of the key whose value is to be retrieved.  This value
must either be a variable or contained in quotes.
Include: Required

Param 3:

Type: String
Description: The value that will be returned if the key cannot be retrieved.
This value must either be a variable or contained in quotes.
Include: Required

Param 4:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 5:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniRemoveKey

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

Type: Int
Description: TRUE if the key is successfully removed, otherwise FALSE.

Parameters

Param 1:

Type: String
Description: 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.
Include: Required

Param 2:

Type: String
Description: The name of the key that will be removed.  This value must either
be a variable or contained in quotes.
Include: Required

Param 3:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Param 4:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IniRemoveKeyEx

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

Type: Int
Description: TRUE if the key is successfully removed, otherwise FALSE.

Parameters

Param 1:

Type: String
Description: 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.
Include: Required

Param 2:

Type: String
Description: The name of the key that will be removed.  This value must either
be a variable or contained in quotes.
Include: Required

Param 3:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 4:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniRemoveSection

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

Type: Int
Description: TRUE if the section is successfully removed, otherwise FALSE.

Parameters

Param 1:

Type: String
Description: The name of the section that will be removed.  This value must
either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Param 3:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IniRemoveSectionEx

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

Type: Int
Description: TRUE if the section is successfully removed, otherwise FALSE.

Parameters

Param 1:

Type: String
Description: The name of the section that will be removed.  This value must
either be a variable or contained in quotes.
Include: Required

Param 2:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 3:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniWriteInteger

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

Type: Int
Description: 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.

Parameters

Param 1:

Type: String
Description: The name of the section where the key and value will be written.
This value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The name of the key that will hold the value.  This value must
either be a variable or contained in quotes.
Include: Required

Param 3:

Type: Int
Description: The value that will be written to the given key.
Include: Required

Param 4:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Param 5:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IniWriteIntegerEx

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

Type: Int
Description: TRUE if the value is successfully written.  If the file, section,
or key does not already exist, it will be created.

Parameters

Param 1:

Type: String
Description: The name of the section where the key and value will be written.
This value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The name of the key that will hold the value.  This value must
either be a variable or contained in quotes.
Include: Required

Param 3:

Type: Int
Description: The value that will be written to the given key.
Include: Required

Param 4:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 5:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Param 6:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
IniWriteString

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.

Returns

Type: Int
Description: 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.

Parameters

Param 1:

Type: String
Description: The name of the section where the key and value will be written.
This value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The name of the key that will hold the value.  This value must
either be a variable or contained in quotes.
Include: Required

Param 3:

Type: String
Description: The value that will be written to the given key. This value must
either be a variable or contained in quotes.
Include: Required

Param 4:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Param 5:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IniWriteStringEx

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

Type: Int
Description: TRUE if the value is successfully written.  If the file, section,
or key does not already exist, it will be created.

Parameters

Param 1:

Type: String
Description: The name of the section where the key and value will be written.
This value must either be a variable or contained in quotes.
Include: Required

Param 2:

Type: String
Description: The name of the key that will hold the value.  This value must
either be a variable or contained in quotes.
Include: Required

Param 3:

Type: String
Description: The value that will be written to the given key. This value must
either be a variable or contained in quotes.
Include: Required

Param 4:

Type: Int
Description: Determines the directory where the file is located.
Include: Required

Param 5:

Type: String
Description: The path to the ini style file.  This value must either be a
variable or contained in quotes.  If a directory is not specified, it will
write the file under the \Settings directory.
Include: Required

Param 6:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.0 and later

----------
BrailleGetFramePrompt

Function: BrailleGetFramePrompt

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

Type: String
Description: the Braille prompt.

Parameters

Param 1:

Type: String
Description: the name of the frame whose prompt you want.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
CreatePrompt

Script: CreatePrompt

Description

Use this keystroke to create a custom label or prompt for a control whose
prompt is either misleading or missing.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FrameClearValues

Function: FrameClearValues

Description

Useful when setting or resetting frames.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FrameGetBottomRight

Script: FrameGetBottomRight

Description

Place the cursor where you want the bottom right corner of the frame to be and
then activate this function. If the top left corner has already been defined,
this activates Frame Viewer to give the frame a name and other
characteristics.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FrameGetTopLeft

Script: FrameGetTopLeft

Description

Place the cursor where you want the top left corner of the frame to be and
then activate This keystroke. When This keystroke is activated twice quickly,
it will position the new frame on the current control and start the Frame
Viewer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FrameManager

Function: FrameManager

Description

Used to name frames, adjust their size and position, and determine their
behavior.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FrameManagerRun

Function: FrameManagerRun

Description

Used to name frames, adjust their size and position, and determine their
behavior.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: What action should the Frame Viewer perform.  Possible values are
found in HJConst beginning with FRAMEVIEW_.
Include: Required

Param 2:

Type: Int
Description: Enter > 0 to determine that we're in a menu, false or leave blank
otherwise
Include: Optional

Param 3:

Type: Handle
Description: Enter the handle of the menu itself
Include: Optional

Param 4:

Type: String
Description: Enter the class name for the menu.  Most drop-down menus possess
the class #32768 which is represented by the constant cWcMenuClass defined in
the common.jsm file.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FrameMoveHelper

Function: FrameMoveHelper

Description

The JAWS Cursor is placed in the specified frame and a message is announced
accordingly.  This message uses the Smart Help Messages output mode, and can
be easily suppressed by deselecting this message type in your Verbosity
settings.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Enter the name of the frame in which to place the JAWS Cursor.
Remember that the JAWS cursor is left on.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FramesEnumerate

Function: FramesEnumerate

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

Type: Void

Parameters

Param 1:

Type: String
Description: script function.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
FrameSetOnObject

Function: FrameSetOnObject

Description

Useful when determining and building frames in small windows, especially SDM
windows.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
FrameSetOnWindow

Function: FrameSetOnWindow

Description

Useful when determining and building frames in small windows.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The window in which to set the frame.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FramesListHelper

Function: FramesListHelper

Description

Builds the string containing the names of all the active frames on the screen.

Returns

Type: Int
Description: True if successful.

Parameters

Param 1:

Type: String
Description: Receives the name of the frame.
Include: Required

Param 2:

Type: Int
Description: Receives the top left edge of the frame.
Include: Required

Param 3:

Type: Int
Description: Receives the top right edge of the frame.
Include: Required

Param 4:

Type: Int
Description: Receives the bottom left edge of the frame.
Include: Required

Param 5:

Type: Int
Description: Receives the bottom right edge of the frame.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FrameViewer

Function: FrameViewer

Description

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

Returns

Type: void

Parameters

Param 1:

Type: Int
Description: What action should the Frame Viewer perform.  Possible values are
found in HJConst beginning with FRAMEVIEW_.
Include: Required

Param 2:

Type: Int
Description: the screen coordinate for the top of the parent window for the
new frame.
Include: Required

Param 3:

Type: Int
Description: the screen coordinate for the left of the parent window for the
new frame.
Include: Required

Param 4:

Type: Int
Description: the screen coordinate for the bottom of the parent window for the
new frame.
Include: Required

Param 5:

Type: Int
Description: the screen coordinate for the right of the parent window for the
new frame.
Include: Required

Param 6:

Type: Int
Description: the screen coordinate for the top of the new frame.
Include: Required

Param 7:

Type: Int
Description: the screen coordinate for the left of the new frame.
Include: Required

Param 8:

Type: Int
Description: the screen coordinate for the bottom of the new frame.
Include: Required

Param 9:

Type: Int
Description: the screen coordinate for the right of the new frame.
Include: Required

Param 10:

Type: String
Description: the title of the parent window.
Include: Required

Param 11:

Type: String
Description: the class of the parent window.
Include: Required

Param 12:

Type: String
Description: the prompt that will be associated with this frame.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
FrameViewerActive

Function: FrameViewerActive

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

Type: Int
Description: TRUE if the Frame Viewer is active, otherwise FALSE.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetFrameDescription

Function: GetFrameDescription

Description

Retrieves the description of a specified frame.

Returns

Type: String
Description: The text of the description.

Parameters

Param 1:

Type: string
Description: The frame name of interest.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetFrameNameAtCursor

Function: GetFrameNameAtCursor

Description

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

Returns

Type: String
Description: 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 .""

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetFramePrompt

Function: GetFramePrompt

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

Type: String
Description: the prompt.

Parameters

Param 1:

Type: String
Description: the name of the frame whose prompt you want.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetFrameSynopsis

Function: GetFrameSynopsis

Description

Retrieves the synopsis of a specified frame.

Returns

Type: String
Description: The text of the synopsis.

Parameters

Param 1:

Type: string
Description: The frame name of interest.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetFrameTutorMessage

Function: GetFrameTutorMessage

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

Type: String
Description: the tutor message.

Parameters

Param 1:

Type: String
Description: the name of the frame whose tutor message you want.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetTextInFrame

Function: GetTextInFrame

Description

Retrieves the text inside a specified frame.

Returns

Type: String
Description: The frame contents.

Parameters

Param 1:

Type: String
Description: The name of the frame desired.
Include: Required

Param 2:

Type: Int
Description: whether or not to add line breaks or to get the text as one long
string.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToFrame

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1 (frame was found), "WAS_NOT_SUCCESSFUL" = 0
(frame was not found).

Parameters

Param 1:

Type: string
Description: The name of a frame.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SayFrame

Function: SayFrame

Description

Speaks the contents of a specific frame.

Returns

Type: Int
Description: TRUE if the desired frame exists, FALSE otherwise.

Parameters

Param 1:

Type: string
Description: The name of the frame to speak.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SayFrame

Script: SayFrame

Description

A frame is not valid unless certain things about it are true, such as the name
of its real window, the class of its real window, and the search string, if
any.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the frame that is to be spoken.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFrameAtCursor

Function: SayFrameAtCursor

Description

Speaks the contents of the frame that surrounds the location of the current
cursor.

Returns

Type: Int
Description: TRUE if a frame surrounds the current cursor, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SayFrameAtCursor

Script: SayFrameAtCursor

Description

All text within the boundaries of the frame that contains the active cursor is
spoken.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectAFrame

Script: SelectAFrame

Description

Make your selection in the list and press enter.  The JAWS cursor will be
positioned in the frame you selected and left on so you can read the frame.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShowFrameText

Script: ShowFrameText

Description

The name of each active frame is displayed as a link.  Below each frame name,
or title, is the text in that frame.  Press enter on the title or name of the
frame, and the JAWS Cursor will be placed in that frame.  If you name your
frames meaningfully, the text for the frame title will make for easier
reading.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShowFrameTextHelper

Function: ShowFrameTextHelper

Description

As active frames are found, their title and text is passed into the User
Buffer.  The name, or title, is posted as a link to the FrameMoveHelper
function which will place the JAWS cursor in the specified frame and announce
accordingly.  This announcement can be turned off by suppressing Smart Help
Messages in your Verbosity profile.

Returns

Type: Int
Description: True if successful

Parameters

Param 1:

Type: String
Description: Receives the name of the frame.
Include: Required

Param 2:

Type: Int
Description: Receives the top left edge of the frame.
Include: Required

Param 3:

Type: Int
Description: Receives the top right edge of the frame.
Include: Required

Param 4:

Type: Int
Description: Receives the bottom left edge of the frame.
Include: Required

Param 5:

Type: Int
Description: Receives the bottom right edge of the frame.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AutoGraphicsLabelerHelper

Function: AutoGraphicsLabelerHelper

Description

Returns

Type: Void

Parameters

Param 1:

Type: int
Description:
Include: Required

Param 2:

Type: int
Description:
Include: Required

Param 3:

Type: int
Description:
Include: Required

Param 4:

Type: int
Description:
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AutoLabelGraphics

Script: AutoLabelGraphics

Description

Only unlabeled graphics are labeled. JFW starts with the App main window and
moves from graphic to graphic. If a tooltip is displayed, then the tooltip
text is used to label the graphic. Active Accessibility is used to determine
if the graphic is in a disabled state. If so, then the word "grayed" is
appended to the tooltip text.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindGraphic

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

Param 1:

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

Param 2:

Type: String
Description: 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.
Include: Required

Param 3:

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

Param 4:

Type: Int
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetGraphicID

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

Type: Int
Description: The Graphic ID, or zero if GetGraphicID fails.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetGraphicNameAtPoint

Function: GetGraphicNameAtPoint

Description

This function is used to return the name of the graphic located at the point
specified by the functions two parameters.

Returns

Type: String
Description: Returns the name of the graphic located at the specified point.

Parameters

Param 1:

Type: Int
Description: No Description
Include: Required

Param 2:

Type: Int
Description: No Description
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GraphicsEnumerate

Function: GraphicsEnumerate

Description

For every graphic contained within a specific window, calls a specified
function, passing it the coordinates of the graphic.

Returns

Type: Int
Description: Count of the number of graphics enumerated.

Parameters

Param 1:

Type: Handle
Description: The handle of the window containing the graphics of interest.
Include: Required

Param 2:

Type: String
Description: 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).
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GraphicsLabeler

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GraphicsLabeler

Script: GraphicsLabeler

Description

Gets the graphic or symbol that the mouse or JAWS cursor was on and lets you
assign it a text label. Labels can be stored in the application specific
graphics file or the default graphics file.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GraphicsList

Script: GraphicsList

Description

When This keystroke is invoked a list will be presented with all the visible
graphics.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GraphicsListHelper

Function: GraphicsListHelper

Description

Returns

Type: Void

Parameters

Param 1:

Type: int
Description:
Include: Required

Param 2:

Type: int
Description:
Include: Required

Param 3:

Type: int
Description:
Include: Required

Param 4:

Type: int
Description:
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GraphicsMode

Script: GraphicsMode

Description

Active graphics mode is used when Standard graphics mode does not accurately
recognize some graphics, such as tool bar items that are pushed, not pushed,
or grayed.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GraphicsVerbosity

Function: GraphicsVerbosity

Description

Graphics Verbosity can be set to All Graphics, Labeled Graphics, or No
Graphics.

Returns

Type: String
Description: description of value to be displayed as value of Graphics
Verbosity.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToGraphic

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: int
Description: 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
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetGraphicLabel

Function: SetGraphicLabel

Description

Adds a graphic label to the specified graphics file (jgf).

Returns

Type: Int
Description: TRUE if the label is successfully added.

Parameters

Param 1:

Type: Int
Description: The ID of the graphic. GetGraphicID returns this value.
Include: Required

Param 2:

Type: String
Description: The label to be assigned to the graphic.
Include: Required

Param 3:

Type: Int
Description: If bApp is TRUE, then the graphic label is added to the
application-specific graphic file. If FALSE, then it is added to the default
graphic file.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AddEditLayerLinksToHelpScreen

Function: AddEditLayerLinksToHelpScreen

Description

Use this function in application-specific files to add the
application-specific links to the Edit layer help screen. Use the same format
for adding links as is used in script ShowEditLayerHelpScreen.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: a flagset containing the currently available edit commands.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
AddedShortcutAvailable

Function: AddedShortcutAvailable

Description

Use this function to test if links will be added to the edit layer help
screen. If no links are to be added, then it must return 0; otherwise, it can
return any integer value which evaluates to true.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
AddHTMLLayerLinksToHelpScreen

Function: AddHTMLLayerLinksToHelpScreen

Description

Use this function in application-specific files to add the
application-specific links to the HTML layer help screen. Use the same format
for adding links as is used in script ShowHTMLLayerHelpScreen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
AddShortcutLayerLinksToHelpScreen

Function: AddShortcutLayerLinksToHelpScreen

Description

Use this function in application-specific files to add the
application-specific links to the shortcut layer help screen. Use the same
format for adding links as is used in script ShowShortcutLayerHelpScreen.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: a flagset containing the currently available shortcuts.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
AppFileTopic

Function: AppFileTopic

Description

Activates the corresponding Help application in the Popular Applications
section of the jfw.hlp file. To create your own topic, using a Help File
creation environment, create an hlp file whose name corresponds with the
executable file for your application. Place this file in the help\enu folder
in JFW.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the constant for the help topic iD as found in HjHelp.jsh.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BasicHelpTopic

Script: BasicHelpTopic

Description

Brings up the basic help for PAC Mate.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
DisplayPacMateHelp

Script: DisplayPacMateHelp

Description

When this keystroke is pressed once, the Pac Mate speaks control help. When
pressed twice quickly, context help is displayed in the virtual viewer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later

----------
GeneralJAWSHotKeys

Function: GeneralJAWSHotKeys

Description

This function uses GetScriptKeyName to insure that as you remap these keys
using Keyboard Manager, they are still reported properly when this function is
called.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCorrespondingHelpFile

Function: GetCorrespondingHelpFile

Description

Useful to review Help information in text about a specific application.

Returns

Type: String
Description: the path and fileName for the corresponding JFW Help file.

Parameters

Param 1:

Type: String
Description: the name of the application that will serve as the base name.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCustomTutorMessage

Function: GetCustomTutorMessage

Description

Retrieves a custom tutor message to be spoken by SayTutorialHelp. Overwrite
this function in applications where you want a custom tutor message to be
substituted instead of the usual tutor message. This function is processed
after GetFrameTutorMessage and before any of the usual tutor messages are
processed.

Returns

Type: string
Description: Null if no custom tutor message is to be spoken, otherwise the
custom tutor message.:Version JAWS/7.00

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
HotKeyHelp

Script: HotKeyHelp

Description

JAWS Hot Keys are keystrokes in JAWS which we provide. Most of the time, they
do not conflict with keystrokes in your applications.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsWinKeyHelp

Function: IsWinKeyHelp

Description

This function decides whether or not WindowKeysHelp makes sense.  If you have
written WindowKeysHelp, do not use this function to determine whether it makes
sense to call it, but use your own code.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSHotKeys

Function: JAWSHotKeys

Description

Speaks the JAWS-specific hot keys for dialogs.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
KeyboardHelp

Script: KeyboardHelp

Description

When this is On and a key is pressed, the synopsis describing the key will be
spoken. If the key is pressed twice quickly, a longer description will be
spoken.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
KeyboardHelpHook

Function: KeyboardHelpHook

Description

This hook is set when KeyboardHelp is called. It unhooks itself when
KeyboardHelp is called again.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the script.
Include: Required

Param 2:

Type: String
Description: The name of the Frame.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayExtendedHelpHotKey

Function: SayExtendedHelpHotKey

Description

Tells the user how to bring up the Help topic for the running application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelp

Script: ScreenSensitiveHelp

Description

Tells the type of the current window or control, what it is used for, and what
keys to use within it.  If JAWS does not recognize the type, then it will say,
"custom."  You might use the class synonym  to reclass it.  Use this
frequently when learning windows.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelpForColorsDialog

Function: ScreenSensitiveHelpForColorsDialog

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelpForJAWSDialogs

Function: ScreenSensitiveHelpForJAWSDialogs

Description

Specific help for the JAWS dialogs.

Returns

Type: Int

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelpForJAWSManager

Function: ScreenSensitiveHelpForJAWSManager

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelpForKnownClasses

Function: ScreenSensitiveHelpForKnownClasses

Description

Information on the standard window class, such as the name, what it is used
for, and what keys to use.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The TypeCode of the window
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelpForSelectVoiceAliasDialog

Function: ScreenSensitiveHelpForSelectVoiceAliasDialog

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
ScreenSensitiveHelpForSysTray

Function: ScreenSensitiveHelpForSysTray

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelpForUnknownClasses

Function: ScreenSensitiveHelpForUnknownClasses

Description

This function checks that the current focus item is valid and announces the
control ID and actual window class of the item.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelpVirtualCursor

Function: ScreenSensitiveHelpVirtualCursor

Description

Known window types need different ScreenSensitiveHelp when the Virtual Cursor
is active.  Pass the window SubType code for the window to be acted upon as
int parameter

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The TypeCode of the window
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenSensitiveHelpWindowList

Function: ScreenSensitiveHelpWindowList

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShowAdvancedLayerHelpScreen

Script: ShowAdvancedLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the Advanced
layer. Pressing Enter on any of the keys listed will perform the function of
the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowCapsLockLayerHelpScreen

Script: ShowCapsLockLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the Caps
Lock layer. Pressing Enter on any of the keys listed will perform the function
of the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowEditLayerHelpScreen

Script: ShowEditLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the Edit
layer. Pressing Enter on any of the keys listed will perform the function of
the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowHelpByID

Function: ShowHelpByID

Description

Opens up WinHelp using a specified file and topic ID.

Returns

Type: Int
Description: TRUE if the help file was successfully displayed.

Parameters

Param 1:

Type: String
Description: The name of a help file. If a complete path is given, then it is
used. If only a file name is given, then the default JFW help path is build
around it and used.
Include: Required

Param 2:

Type: Int
Description: The ID of the help topic.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ShowHelpByName

Function: ShowHelpByName

Description

Opens up WinHelp using a specified file and index topic.

Returns

Type: Int
Description: TRUE if the Help file was successfully displayed.

Parameters

Param 1:

Type: String
Description: The name of a help file. If a complete path is given, then it is
used. If only a file name is given, then the default JFW help path is build
around it and used.
Include: Required

Param 2:

Type: String
Description: The index string of the Help topic.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShowHelpLayerHelpScreen

Script: ShowHelpLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the Help
layer. Pressing Enter on any of the keys listed will perform the function of
the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowHTMLLayerHelpScreen

Script: ShowHTMLLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the HTML
layer. Pressing Enter on any of the keys listed will perform the function of
the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowInformationLayerHelpScreen

Script: ShowInformationLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the
Information layer. Pressing Enter on any of the keys listed will perform the
function of the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowSettingsLayerHelpScreen

Script: ShowSettingsLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the Settings
layer. Pressing Enter on any of the keys listed will perform the function of
the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowShortcutLayerHelpScreen

Script: ShowShortcutLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the Shortcut
layer. Pressing Enter on any of the keys listed will perform the function of
the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowStartAppLayerHelpScreen

Script: ShowStartAppLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the Start
Application layer. Pressing Enter on any of the keys listed will perform the
function of the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowWriteMacroLayerHelpScreen

Script: ShowWriteMacroLayerHelpScreen

Description

This keystroke lists and describes the keys available from within the Write
Macro layer. Pressing Enter on any of the keys listed will perform the
function of the chosen key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
TutorMessageEvent

Function: TutorMessageEvent

Description

this event is triggered after the FocusChangedEvent and when the focus moves
between menu items. It is always called after NewTextEvent and hence
SayHighlightedText.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: the focus window.
Include: Required

Param 2:

Type: Int
Description: the menu mode.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
WindowKeysHelp

Script: WindowKeysHelp

Description

Press this keystroke to read Windows shortcut keys, keyboard help, and other
information that is important when using Windows without a mouse.  This
information will be placed in the Virtual Viewer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
WindowKeysHelpDefault

Function: WindowKeysHelpDefault

Description

The default or standard Windows Keys help are keys that are usually available
from the operating system.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PAC MateKeystrokesTopic

Script: PAC MateKeystrokesTopic

Description

Brings up the PAC Mate Keystrokes help topic.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShowScreenSensitiveHelp

Function: ShowScreenSensitiveHelp

Description

Use this function if you want to add extra information to the screen-sensitive
help message.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The help message.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
AdjustHTMLSettings

Script: AdjustHTMLSettings

Description

This keystroke displays a dialog box which is similar in nature to the JAWS
Verbosity dialog that provided a quick and easy method of changing various
HTML Options on the fly in JFW 3.5

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleTableReading

Script: BrailleToggleTableReading

Description

Toggles between Current Cell, Current Row and Current Column.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
DefineATempPlaceMarker

Script: DefineATempPlaceMarker

Description

A temporary PlaceMarker will last until the page changes.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
DetectTableWhenNavigating

Function: DetectTableWhenNavigating

Description

Detects if the focus has moved into or out of a table after nivagation has
occurred, and speaks information about the change if navigation has moved the
focus into or out of a table.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: The table index before the navigation.
Include: Required

Param 2:

Type: int
Description: The table level before the navigation.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
DisplayAdvancedElementInfo

Script: DisplayAdvancedElementInfo

Description

Starting with the current element, the entire HTML hierarchy is displayed in
the Virtual Viewer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
DisplayBasicElementInfo

Script: DisplayBasicElementInfo

Description

An HTML element can be text, graphics or form controls.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
DlgListOfPlaceMarkers

Function: DlgListOfPlaceMarkers

Description

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

Returns

Type: Int
Description: TRUE if successful, returns FALSE otherwise.

Parameters

Param 1:

Type: Int
Description: 1 to pop up Add dialog,bypassing PlaceMarkers dialog, 0 to
display PlaceMarkers dialog.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
DocumentLoadedEvent

Function: DocumentLoadedEvent

Description

When an internet explorer document is loaded it will automatically  begin
reading.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ExitFormsMode

Script: ExitFormsMode

Description

After using a web form, press this keystroke to turn off Forms Mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 7.00 and later

----------
FocusToFirstField

Script: FocusToFirstField

Description

Moves to the first input field on the page and speaks it. If no form field is
found, reports "Input Field Not Found." Only available in IE4.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FocusToLastField

Script: FocusToLastField

Description

Moves to the last input field on the page and speaks it. If no form field is
found, reports "Input Field Not Found." Only available in the Virtual PC
Cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FocusToNextField

Script: FocusToNextField

Description

Moves to the next input field on the page and speaks it. If no form field is
found, reports "Input Field Not Found." Only available in the Virtual PC
Cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FocusToPriorField

Script: FocusToPriorField

Description

Moves to the previous input field on the page and speaks it. If no form field
is found, reports "Input Field Not Found." Only available in the Virtual PC
Cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FormsModeEvent

Function: FormsModeEvent

Description

This function is activated whenever forms mode is entered or exited. It is
passed a boolian 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.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: This is the boolian value representing the current state of forms
mode
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCurrentHeading

Function: GetCurrentHeading

Description

Returns

Type: String
Description: the text of the heading at the virtual cursor if any.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCurrentHeadingLevel

Function: GetCurrentHeadingLevel

Description

Returns

Type: Int
Description: The heading level (if the cursor is on a heading) or 0 otherwise.
The heading level is 1 for h1, ... 6 for h6.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCurrentPlaceMarker

Function: GetCurrentPlaceMarker

Description

This function returns the PlaceMarker at the position of the Virtual Cursor.
If the Virtual Cursor is not positioned on a PlaceMarker, an empty (null)
string is returned.

Returns

Type: String
Description: The current PlaceMarker.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetDocumentPercentage

Function: GetDocumentPercentage

Description

This function returns the position of the cursor as a percentage of the entire
document.

Returns

Type: Int
Description: percentage

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetElementDescription

Function: GetElementDescription

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

Type: String
Description: Description of element

Parameters

Param 1:

Type: Int
Description: the number of ancestors to include in the description, the
default is 1.
Include: Optional

Param 2:

Type: Int
Description: true if you only want the tag name(s) and not the parameters as
well, default is TRUE.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetFormFieldIndex

Function: GetFormFieldIndex

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

Type: Int
Description: the 1-based table index or 0.

Parameters

Param 1:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetHeadingCount

Function: GetHeadingCount

Description

Returns

Type: Int
Description: The number of headings present.

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetHTMLFrameCount

Function: GetHTMLFrameCount

Description

Gets the number of HTML frames present on the current Web page or html
document.

Returns

Type: Int
Description: The number of frames present.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetHTMLFrameIndex

Function: GetHTMLFrameIndex

Description

This function returns the 1-based index of the current frame. Note that
invisible frames are not counted.

Returns

Type: Int
Description: the frame index.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetHTMLFrameName

Function: GetHTMLFrameName

Description

This function returns the name of the current HTML frame. This is either taken
from the title or if no title, the name attribute.

Returns

Type: String
Description: the name of the frame.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetHTMLFrameNames

Function: GetHTMLFrameNames

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

Type: String
Description: the delimited list of frame names.

Parameters

Param 1:

Type: String
Description: The delimiter to use to separate the frame names.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetLinkCount

Function: GetLinkCount

Description

Returns

Type: Int
Description: The number of links present.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetListOfFormFields

Function: GetListOfFormFields

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

Type: String
Description: the delimited list of form fields.

Parameters

Param 1:

Type: String
Description: The delimiter to use to separate the form fields
Include: Optional

Param 2:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetListOfTables

Function: GetListOfTables

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

Type: String
Description: the delimited list of tables.

Parameters

Param 1:

Type: String
Description: The delimiter to use to separate the table information for each
table in the list.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetListOfTags

Function: GetListOfTags

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

Type: String
Description: the delimited list of tags.

Parameters

Param 1:

Type: string
Description: the UPPERCASE HTML tag to collect.
Include: Required

Param 2:

Type: string
Description: a comma delimited list of HTML  attributes to look for when
gathering information about the tag.
Include: Required

Param 3:

Type: String
Description: The delimiter to use to separate the tag information for each tag
in the list.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetPlaceMarkerCount

Function: GetPlaceMarkerCount

Description

Returns the number of available PlaceMarkers on the active page.  It does not
determine whether or not they are valid.

Returns

Type: Int
Description: The number of PlaceMarkers found.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetTableIndex

Function: GetTableIndex

Description

This function returns the 1-based index of the current table. Note that
invisible tables are not counted. If the cursor is not within a table, returns
0.

Returns

Type: Int
Description: the 1-based table index or 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetTagIndex

Function: GetTagIndex

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

Type: Int
Description: the 1-based tag index or 0.

Parameters

Param 1:

Type: string
Description: the tag whose index is required.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GoBackAPage

Script: GoBackAPage

Description

Go back one web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GoToAddressBar

Script: GoToAddressBar

Description

After pressing this keystroke, type the address of a web page and press enter.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GoToFavourites

Script: GoToFavourites

Description

Go to Favorites menu.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GoToHomePage

Script: GoToHomePage

Description

The Home Page is the page that loads when you first start Internet Explorer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
HidePictures

Script: HidePictures

Description

Activates the Hide Pictures menu option.  Hiding pictures may cause web pages
to load more quickly.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
HTMLButtonTextVerbosityToggle

Function: HTMLButtonTextVerbosityToggle

Description

Toggles the verbosity for buttons between title, screen text/label, alt, value
and longest.

Returns

Type: String
Description: description of value to be displayed as value of HTML button text
verbosity item.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HTMLDecrementLinesPerPageItem

Function: HTMLDecrementLinesPerPageItem

Description

Decreases the number of lines used when the page up or page down is used in
virtual cursor mode.

Returns

Type: String
Description: description of value to be displayed as value of HTML decrement
lines per page option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLDecrementMaxBlockLength

Function: HTMLDecrementMaxBlockLength

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

Type: String
Description: description of value to be displayed as value of HTML decrement
max block length.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLDecrementMaxLineLength

Function: HTMLDecrementMaxLineLength

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

Type: String
Description: description of value to be displayed as value of HTML decrement
max line length.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLDetectTables

Function: HTMLDetectTables

Description

Toggles whether to indicate data tables only, or all tables.

Returns

Type: String
Description: description of value to be displayed as value of HTML Detect
Tables option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00-4.51 and later

----------
HTMLFrameIndicationToggle

Function: HTMLFrameIndicationToggle

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

Type: String
Description: description of value to be displayed as value of HTML frame
indication option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLGraphicReadingVerbosityToggle

Function: HTMLGraphicReadingVerbosityToggle

Description

Toggles the verbosity for reading HTML Graphics from longest, OnMouseOver,
title and alt tag.

Returns

Type: String
Description: description of value to be displayed as value of HTML Graphics
Reading verbosity item.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HTMLIdentifyLinkTypeToggle

Function: HTMLIdentifyLinkTypeToggle

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

Type: String
Description: description of value to be displayed as value of HTML link type.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLIdentifySamePageLinksToggle

Function: HTMLIdentifySamePageLinksToggle

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

Type: String
Description: description of value to be displayed as value of HTML Same Page
Links item.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLIncludeGraphicsToggle

Function: HTMLIncludeGraphicsToggle

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

Type: String
Description: description of value to be displayed as value of HTML Graphics
Toggle.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLIncludeImageMapLinksToggle

Function: HTMLIncludeImageMapLinksToggle

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

Type: String
Description: description of value to be displayed as value of HTML Image Map
Level.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLIncludeLinksToggle

Function: HTMLIncludeLinksToggle

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

Type: String
Description: description of value to be displayed as value of HTML Links
Level.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLIncrementLinesPerPageItem

Function: HTMLIncrementLinesPerPageItem

Description

Increases the lines per page that is used when the user uses the page up and
page down in virtual cursor mode.

Returns

Type: String
Description: description of value to be displayed as value of HTML increment
lines per page.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLIncrementMaxBlockLength

Function: HTMLIncrementMaxBlockLength

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

Type: String
Description: description of value to be displayed as value of HTML increment
max block length.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLIncrementMaxLineLength

Function: HTMLIncrementMaxLineLength

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

Type: String
Description: description of value to be displayed as value of HTML increment
max line length.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLIndicateBlockQuotes

Function: HTMLIndicateBlockQuotes

Description

Turns on or off the Block Quotes indication.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HTMLIndicateElementAccessKeys

Function: HTMLIndicateElementAccessKeys

Description

Turns on or off the Element Access Keys indication.

Returns

Type: String
Description: description of value to be displayed as value of Indicate Element
Access Keys option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HTMLIndicateLists

Function: HTMLIndicateLists

Description

Turns on or off the lists indication.

Returns

Type: String
Description: description of value to be displayed as value of Indicate lists
option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HTMLIndicateTablesToggle

Function: HTMLIndicateTablesToggle

Description

When the indication of tables is toggled to the on position, JAWS will
indicate when a table is encountered in virtual cursor mode.

Returns

Type: String
Description: description of value to be displayed as value of HTML Indicate
Tables option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.00-4.51 and later

----------
HTMLScreenFollowsVCursorToggle

Function: HTMLScreenFollowsVCursorToggle

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

Type: String
Description: description of value to be displayed as value of HTML Screen
Follows Virtual Cursor option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLSkipPastRepeatedTextToggle

Function: HTMLSkipPastRepeatedTextToggle

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

Type: String
Description: description of value to be displayed as value of HTML Skip
Repeated Text option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLTextLinkVerbosityToggle

Function: HTMLTextLinkVerbosityToggle

Description

Toggles the verbosity for text links between title, screen text, onMouseOver,
longest and custom.

Returns

Type: String
Description: description of value to be displayed as value of HTML text link
verbosity item.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HTMLToggleFormsModeAutoOff

Function: HTMLToggleFormsModeAutoOff

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

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
HTMLToggleIgnoreInlineFrames

Function: HTMLToggleIgnoreInlineFrames

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

Type: String
Description: description of value to be displayed as value of HTML Ignore
Inline Frames.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IE4GetFocus

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

Type: Int
Description: The value indicating the index of the focus object in Internet
Explorer.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IEFind

Script: IEFind

Description

Activates JAWSFind when the Virtual Cursor is active.  Otherwise, passes the
keystroke through to the application.  Do not assign to CTRL+F in Outlook,
Outlook Express or other e-mail software that uses CTRL+F as Forward Message.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IEGetCurrentDocument

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

Type: Object
Description: An object that represents the HTML document in a given browser
window.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IEGetFocus

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

Type: Int
Description: The value indicating the index of the focus object in Internet
Explorer.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IEGetUnrestrictedWindow

Function: IEGetUnrestrictedWindow

Description

Returns

Type: Object
Description: Window with full read access.

Parameters

Param 1:

Type: object
Description:
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IEReformatBody

Function: IEReformatBody

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

Type: Int
Description: Returns 1 if the reformatting was successful, returns 0
otherwise.

Parameters

Param 1:

Type: Handle
Description: The window handle of the Internet Explorer_Server Window
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
InList

Function: InList

Description

Note this function is currently only implemented to return TRUE in an HTML
list.

Returns

Type: Int
Description: True if in a list, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
JumpReturnFromLine

Script: JumpReturnFromLine

Description

Press this keystroke to return to the prior line following a JumpToLine in the
Virtual document.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
JumpTo

Script: JumpTo

Description

When in a table, press this keystroke to jump to a cell.  Otherwise, press to
jump to a line in the document.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
JumpToLine

Script: JumpToLine

Description

Press this keystroke to jump to a line in the Virtual document.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
MoveToControlType

Function: MoveToControlType

Description

This function Moves the cursor to the next, prior, first or last instance of
the specified control type.

Returns

Type: Int
Description: true or false.

Parameters

Param 1:

Type: Int
Description: one of S_TOP, S_BOTTOM, S_NEXT or S_PRIOR as defined in
hjconst.jsh.
Include: Required

Param 2:

Type: Int
Description: One of the WT_ window type constants defined in hjconst.jsh.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
MoveToElementOfDifferentType

Function: MoveToElementOfDifferentType

Description

This function will move the virtual cursor to the next or prior element
different to the current. Pass in True to move in a reverse direction or
nothing or false to move forward.

Returns

Type: Int
Description: true if the cursor was moved.

Parameters

Param 1:

Type: Int
Description: true to go backward, false or leave blank to go forward.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToElementOfSameType

Function: MoveToElementOfSameType

Description

This function will move the virtual cursor to another occurance of the same
element. The 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. For example, if you are on the header of a list you can move to the
next, prior, first or last list in the document.

Returns

Type: Int
Description: true if another element with the same tag was located, false
otherwise.

Parameters

Param 1:

Type: Int
Description: one of s_top, s_bottom, s_next or s_prior as defined in
hjconst.jsh.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToFirstHeading

Script: MoveToFirstHeading

Description

Moves to the first heading on an html page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToFirstHeadingLevelN

Script: MoveToFirstHeadingLevelN

Description

Moves to the first heading at the specified level.  Use alt+ctrl+1 through 6
to specify the level.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToFirstSameElement

Script: MoveToFirstSameElement

Description

When the Virtual Cursor is active, it is moved to the first instance of the
type of control where the Virtual Cursor is located.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToFirstTable

Script: MoveToFirstTable

Description

When the Virtual Cursor is active, it is moved to the first table in the
document or web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToFormField

Function: MoveToFormField

Description

Depending on the value of SearchOption, positions to the first, last, next, or
prior form field on the current web page.

Returns

Type: Int
Description: TRUE if a form field was found, FALSE otherwise.

Parameters

Param 1:

Type: Int
Description: one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first,
last, next or prior form field respectively.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToFormFieldByIndex

Function: MoveToFormFieldByIndex

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

Type: Int
Description: true if the virtual cursor was moved to a form field, false
otherwise.

Parameters

Param 1:

Type: Int
Description: of form field.
Include: Required

Param 2:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
MoveToHeading

Function: MoveToHeading

Description

Depending on the value of SearchOption, and nLevel, positions to the first,
last, next, or prior heading on the current web page.

Returns

Type: Int
Description: TRUE if a heading was found, FALSE otherwise.

Parameters

Param 1:

Type: Int
Description: one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first,
last, next or prior form field respectively.
Include: Required

Param 2:

Type: Int
Description: 0 to find any heading, 1 through 6 to find a heading at levels 1
through 6.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToHTMLFrame

Function: MoveToHTMLFrame

Description

This function moves to the first, last, next or prior frame in an HTML
document depending on the search type parameter. See hjconst.jsh for a list of
constants, these constants are prefixed with s_

Returns

Type: Int
Description: true if the virtual cursor was moved to a frame, false otherwise.

Parameters

Param 1:

Type: Int
Description:
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToHTMLFrameByIndex

Function: MoveToHTMLFrameByIndex

Description

This function moves to a specified frame on a webpage. Specify the 1-based
index of the frame to move to.

Returns

Type: Int
Description: true if the virtual cursor was moved to a frame, false otherwise.

Parameters

Param 1:

Type: Int
Description: of frame
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToLastHeading

Script: MoveToLastHeading

Description

Moves to the last heading on an html page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToLastHeadingLevelN

Script: MoveToLastHeadingLevelN

Description

Moves to the last heading at the specified level.  Use alt+ctrl+shift+1
through 6 to specify the level.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToLastSameElement

Script: MoveToLastSameElement

Description

When the Virtual Cursor is active, it is moved to the last instance of the
type of control where the Virtual Cursor is located.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToLastTable

Script: MoveToLastTable

Description

When the Virtual Cursor is active, it is moved to the last table in the
document or web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToList

Function: MoveToList

Description

Depending on the value of SearchOption, positions to the first, last, next, or
prior list on the current web page.

Returns

Type: Int
Description: TRUE if a list was found, FALSE otherwise.

Parameters

Param 1:

Type: Int
Description: one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first,
last, next or prior list respectively.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToNextDifferentElement

Script: MoveToNextDifferentElement

Description

Moves the Virtual Cursor to the next control of a different type than the one
currently at the Virtual Cursor position.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToNextHeading

Script: MoveToNextHeading

Description

Moves to the next heading on an html page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToNextHeadingLevelN

Script: MoveToNextHeadingLevelN

Description

Moves to the next html heading at the specified level.  Use 1 through 6 to
move forward through the headings at the specified level.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: iLevel The specified level.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToNextNonLinkText

Script: MoveToNextNonLinkText

Description

Moves to the next block of nonlink text which is larger than 25 characters.
You can increase or decrease the amount from 25 in the AdjustJAWSVerbosity
dialog box when in the Virtual Cursor, or in the HTML Options dialog box in
Configuration Manager.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToNextPlaceMarker

Script: MoveToNextPlaceMarker

Description

Moves to the next PlaceMarker and reads it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
MoveToNextSameElement

Script: MoveToNextSameElement

Description

When the Virtual Cursor is active, it is moved to the next instance of the
type of control where the Virtual Cursor is located.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToNextTable

Script: MoveToNextTable

Description

When the Virtual Cursor is active, it is moved to the next table in the
document or web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToPriorDifferentElement

Script: MoveToPriorDifferentElement

Description

Moves the Virtual Cursor to the prior control of a different type than the one
currently at the Virtual Cursor position.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToPriorHeading

Script: MoveToPriorHeading

Description

Moves to the prior heading on an html page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToPriorHeadingLevelN

Script: MoveToPriorHeadingLevelN

Description

Moves to the prior html heading at the specified level.  Use shift+1 through 6
to move backward through the headings at the specified level.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: the specified level.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToPriorNonLinkText

Script: MoveToPriorNonLinkText

Description

Moves to the previous block of nonlink text which is larger than 25
characters.  You can increase or decrease the amount from 25 in the
AdjustJAWSVerbosity dialog box when in the Virtual Cursor, or in the HTML
Options dialog box in Configuration Manager.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later
	2. JAWS 4.51 and later

----------
MoveToPriorPlaceMarker

Script: MoveToPriorPlaceMarker

Description

Moves to the previous PlaceMarker and reads it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
MoveToPriorSameElement

Script: MoveToPriorSameElement

Description

When the Virtual Cursor is active, it is moved to the previous instance of the
type of control where the Virtual Cursor is located.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToPriorTable

Script: MoveToPriorTable

Description

When the Virtual Cursor is active, it is moved to the previous table in the
document or web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToTable

Function: MoveToTable

Description

Depending on the value of SearchOption, positions to the first, last, next, or
prior table on the current web page.

Returns

Type: Int
Description: TRUE if a table was found, FALSE otherwise.

Parameters

Param 1:

Type: Int
Description: one of S_TOP, S_BOTTOM, S_NEXT, or S_PRIOR to move to the first,
last, next or prior table respectively.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToTableByIndex

Function: MoveToTableByIndex

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

Type: Int
Description: true if the virtual cursor was moved to a table, false otherwise.

Parameters

Param 1:

Type: Int
Description: of table
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
MoveToTag

Function: MoveToTag

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

Type: Int
Description: true or false.

Parameters

Param 1:

Type: Int
Description: one of S_TOP, S_BOTTOM, S_NEXT or S_PRIOR as defined in
hjconst.jsh
Include: Required

Param 2:

Type: String
Description: the HTML or other textual tag to locate
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
MoveToTagByIndex

Function: MoveToTagByIndex

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

Type: Int
Description: true if the virtual cursor was moved to a tag, false otherwise.

Parameters

Param 1:

Type: Int
Description: index of table
Include: Required

Param 2:

Type: string
Description: the tag to move to
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
MoveToUnvisitedLink

Function: MoveToUnvisitedLink

Description

Returns

Type: Int
Description: true if an unvisited link was found, false otherwise.

Parameters

Param 1:

Type: Int
Description: one of s_top, s_bottom, s_next or s_prior defined in hjconst.jsh.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToVisitedLink

Function: MoveToVisitedLink

Description

Returns

Type: Int
Description: true if a visited link was found, false otherwise.

Parameters

Param 1:

Type: Int
Description: one of s_top, s_bottom, s_next or s_prior defined in hjconst.jsh.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
NextNonLink

Function: NextNonLink

Description

Often useful for moving past advertisement text on a Web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PriorNonLink

Function: PriorNonLink

Description

Often useful for moving back past advertisement text on a Web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later
	2. PAC Mate 2.50 and later

----------
QuickKeyNavigationModeActive

Function: QuickKeyNavigationModeActive

Description

Returns

Type: Int
Description: TRUE if on, false otherwise

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ReadAddressBar

Script: ReadAddressBar

Description

Read the address of the current web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
RefreshPage

Script: RefreshPage

Description

Refreshes, or reloads, the current web page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SayNextRow

Script: SayNextRow

Description

Moves the Virtual Cursor to the next row in the table and reads it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SayPriorRow

Script: SayPriorRow

Description

Moves the Virtual Cursor to the previous row in the table and reads it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SelectaHeading

Script: SelectaHeading

Description

Displays a dialog containing a list of the html headings on the page.  You can
select a heading from the list and move to it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectALink

Script: SelectALink

Description

Displays a dialog containing a list of the links on an html page.  You can
move to or click on the links in the list.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectAPlaceMarker

Script: SelectAPlaceMarker

Description

In this dialog, you can add, change, remove and go to PlaceMarkers.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
SelectHierarchicalElement

Function: SelectHierarchicalElement

Description

this function selects the text contained in an HTML element. For example, if
you are on the table introduction (table with x columns and y rows) and you
call this function then the entire table will be selected. If however you are
in a table cell then just the table cell will be selected.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SelectHTMLElement

Script: SelectHTMLElement

Description

This keystroke will select the contents of the current HTML element. For
example, you can select an entire table by moving the Virtual Cursor to the
start of the table, i.e. the line which says Table with x columns and y rows
and invoke This keystroke. If you were just in a table cell then only that
cell would be selected.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SetQuickKeyNavigationMode

Function: SetQuickKeyNavigationMode

Description

The Quick Key Navigation mode is linked to the Virtual Cursor automatically
however it may be manually turned on in other applications which don't use the
Virtual cursor. Applications which use this mode must have overriding scripts
to handle the movement and reading functions supported by this mode. this mode
is linked to the JCF option OPT_QUICK_KEY_NAVIGATION_MODE so turning it on
manually when the jcf option is set to 0 will have no effect.

Returns

Type: Int
Description: true if the mode was enabled or false otherwise.

Parameters

Param 1:

Type: Int
Description: true to turn the mode on, false to turn it off.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SpeakPlaceMarkerByIndex

Function: SpeakPlaceMarkerByIndex

Description

This functionspeaks the text at the nth placemarker and optionally moves the
cursor to the placemarker.

Returns

Type: Int
Description: True or False, depending if the nth placemarker was found.

Parameters

Param 1:

Type: Int
Description: the 1-based index of the place marker to speak and optionally
move to.
Include: Required

Param 2:

Type: Int
Description: True if the cursor should be reloacated to the placemarker, False
to speak but not move to the placemarker.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
StepOutOfCurrentElement

Function: StepOutOfCurrentElement

Description

This function moves to the beginning or end of the ancestor element,
effectively stepping out of the element or moving up one level in the element
hierarchy. This can be used for stepping out of a nested list either to the
beginning or end of the nested list. Repeated calls will keep stepping out of
the element at that level until you reach the top level body. The single
parameter specifies whether you are moved to the end or beginning of the
element. A second optional parameter allows you to specify how many levels you
are stepped out. The default is 0 which means the function will determine the
appropriate number of levels for the current element.

Returns

Type: Int
Description: true if the function relocated the virtual cursor, false
otherwise.

Parameters

Param 1:

Type: Int
Description: true to move to the end or false to move to the beginning.
Include: Required

Param 2:

Type: Int
Description: how many levels to step out. Use a value of 0 to force the
function to automatically determine the appropriate number of levels to step
out. For example, if you are in a table cell and you want to step out of the
table then nLevels should be at least 2 because the first level will only
refer to the row containing the cell element.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
StepToEndOfElement

Script: StepToEndOfElement

Description

Moves forward and up one level in the element hierarchy.  This means you will
be taken to the end of the current table, list, or nested list.  From there
you will be taken to the next level up.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
StepToStartOfElement

Script: StepToStartOfElement

Description

Moves backward and up one level in the element hierarchy.  This means you will
be taken to the beginning of the current table, list, or nested list.  From
there you will be taken to the next level up.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ToggleExpandAbbreviations

Function: ToggleExpandAbbreviations

Description

This function toggles the expansion of abbreviations on web pages (using the
abbr tag) on and off.

Returns

Type: String
Description: description of value to be displayed as value of Expand
abbreviations.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ToggleExpandAcronyms

Function: ToggleExpandAcronyms

Description

This function toggles the expansion of acronyms on web pages (using the
acronym tag) on and off.

Returns

Type: String
Description: description of value to be displayed as value of Expand acronyms.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ToggleUseVirtualInfoInFormsMode

Function: ToggleUseVirtualInfoInFormsMode

Description

This function toggles the use of information from the Virtual Document when in
Forms Mode. There are times when the Virtual Document and real document get
out of synchronization due to errors in the HTML which will cause erroneous
information in Forms Mode when this setting is enabled. If the HTML is correct
however, this setting will ensure that prompts spoken for controls in Forms
Mode will be identical to the prompts spoken in Virtual Mode.

Returns

Type: String
Description: description of value to be displayed as value of Use Virtual info
for Forms Mode Labels.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
TurnOffFormsMode

Function: TurnOffFormsMode

Description

Used to turn off forms mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TurnOnFormsMode

Function: TurnOnFormsMode

Description

Used to turn on forms mode after it has been manually turned off. Unlike
calling EnterKey, this function simply re-enables forms mode regardless of
what kind of control currently has focus. Note this is only available in JAWS
5.0 international, build 5.00.760 or higher.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
VirtualHTMLFeatures

Script: VirtualHTMLFeatures

Description

This list contains features you can use when viewing web pages or reading
other html documents such as the JAWS Help system.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
AnnounceDocumentElements

Function: AnnounceDocumentElements

Description

Used by DocumentLoadedEvent to announce the number of frames, heading and
links on the current HTML page.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
CustomPageSummaryReported

Function: CustomPageSummaryReported

Description

Speak or shows the custom page summary, based on the user's setting for custom
page summary.

Returns

Type: int
Description: True if the custom page summary was spoken or shown, false
otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
DocumentLoadedAtFormField

Function: DocumentLoadedAtFormField

Description

Used by DocumentLoadedEvent to determine if the focus was on a form field when
the document laoded.

Returns

Type: int
Description: True if the focus is on a form field, false otherwise

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
GetListOfTagsWithAttribute

Function: GetListOfTagsWithAttribute

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. The list's elements are in 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

Type: String
Description: the delimited list of tags.

Parameters

Param 1:

Type: string
Description: the UPPERCASE HTML tag to collect.
Include: Required

Param 2:

Type: string
Description: the attribute which each element in the list must have and whose
value is included as part of the list items retrieved.
Include: Required

Param 3:

Type: int
Description: TRUE to allow nested elements, FALSE to disallow nesting. Default
is TRUE
Include: Optional

Param 4:

Type: String
Description: The delimiter to use to separate the tag information for each tag
in the list.
Include: Optional

Param 5:

Type: handle
Description: the handle of the document (may not have focus). If this
parameter is not supplied, we assume the document has focus.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
MoveToTagWithAttributeByIndex

Function: MoveToTagWithAttributeByIndex

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

Type: Int
Description: true if the virtual cursor was moved to a tag, false otherwise.

Parameters

Param 1:

Type: Int
Description: index of tag relative to collection of tags with specified
attribute present.
Include: Required

Param 2:

Type: string
Description: the tag to move to
Include: Required

Param 3:

Type: string
Description: the attribute which must be present in order to count the tag as
being included in the index
Include: Required

Param 4:

Type: int
Description: TRUE to allow nesting when determining the instance of the
element to move to, must match the value used when obtaining the list of tags
with the specified attribute.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
PageChangedEvent

Function: PageChangedEvent

Description

This event fires when Internet Explorer switches to a new page tab.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: The handle of the page.
Include: Required

Param 2:

Type: string
Description: The name of the page of the foreground tab.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
AddHook

Function: AddHook

Description

Installs a hook function. When a hook 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 returns TRUE, the script is allowed to execute. If the
hook returns FALSE, the script will not be allowed to run. See the
KeyboardHelp script and the KeyboardHelpHook function in DEFAULT.JSS for an
example of a hook function in action.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The type of hook to be installed. Use HK_SCRIPT for this
parameter. Hook types are defined in HJConst.JSH.
Include: Required

Param 2:

Type: string
Description: The name of a function to be installed as a hook.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AltLeftMouseClick

Script: AltLeftMouseClick

Description

Unselects all previously selected items.  Sends an ALT+LEFT MOUSE BUTTON to
the system.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AltPlus

Script: AltPlus

Description

Used to send the ALT modifier along with a key to the system.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The key which is sent.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
BackspaceMSDos

Function: BackspaceMSDos

Description

Performs the Backspace function, speaking the prior character, for MS-Dos
windows.  Acts as a helper function to the JAWSBackspace script.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BXBuildFKeyModifyer

Script: BXBuildFKeyModifyer

Description

The dot combination is used determines what modifyers will be applied to the
function key. The key which follows must be "a" through "l", to perform F1
through F12. To indicate a simple function key, use Dots 1+8 chord. Add any of
the following dot to the chord to add the coresponding modifyer: 2=Insert,
3=Control, 7=Shift, 4=Windows, 5=JAWSKey, 6=Alt.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
BXBuildModifyer

Script: BXBuildModifyer

Description

The dot combination is used determines what modifyers will be applied to the
next key pressed. All modifyers will include the Dot8 chord, and must include
any combination of the following dots to form the modifyer: 2=Insert,
3=Control, 7=Shift, 4=Windows, 5=JAWSKey, 6=Alt.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
CancelLayeredKeySequence

Function: CancelLayeredKeySequence

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later

----------
CapsLockKey

Script: CapsLockKey

Description

Toggles and announces the state of CAPS LOCK key when it is not being used as
a JAWSKey in a JAWSKey combo.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
CapsLockOff

Script: CapsLockOff

Description

Turns off CAPS LOCK.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
CapsLockOn

Script: CapsLockOn

Description

Turns on CAPS LOCK.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ClickOnFocus

Function: ClickOnFocus

Description

Uses the invisible cursor to click on the focus window. If the focus window is
a populated treeview or listview, then it clicks on the current item.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
ClickOnWindow

Function: ClickOnWindow

Description

Uses the invisible cursor to click on the specified window. If the specified
window is a populated listview, or if the window is the focus window and is a
treeview window, then it clicks on the current item.

Returns

Type: int
Description: true if the window was clicked, false otherwise.

Parameters

Param 1:

Type: handle
Description: the specified window to be clicked on.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later

----------
ControlBackSpace

Script: ControlBackSpace

Description

Not all applications support the CTRL+BACKSPACE.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ControlDelete

Script: ControlDelete

Description

After deleting the current word, the next word is spoken.  May not be
available in every application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ControlDownArrow

Script: ControlDownArrow

Description

This keystroke depends on the application and the current item: in some edit
windows it moves to the next paragraph, in some list boxes or list views it
moves the focus down without removing the selection in order to select
non-contiguous items.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ControlDownArrowPCCursor

Script: ControlDownArrowPCCursor

Description

This function depends on the application and the current item: in some edit
windows it moves to the next paragraph, in some list boxes or list views it
moves the focus down without removing the selection in order to select
non-contiguous items.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ControlEnter

Script: ControlEnter

Description

This script passes control enter directly to the application so that the
application can perform the associated action. For example, when you press
this keystroke within Firefox on a link, it creates a tab for the link in
Firefox.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
ControlEnterKey

Function: ControlEnterKey

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

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ControlUpArrow

Script: ControlUpArrow

Description

This function depends on the application and the current item: in some edit
windows it moves to the prior paragraph, in some list boxes or list views it
moves the focus up without removing the selection in order to select
non-contiguous items.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ControlUpArrowPCCursor

Script: ControlUpArrowPCCursor

Description

This function depends on the application and the current item: in some edit
windows it moves to the prior paragraph, in some list boxes or list views it
moves the focus up without removing the selection in order to select
non-contiguous items.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DoBXModifiedKey

Function: DoBXModifiedKey

Description

If the qwerty key is mapped to a script, performs the script; otherwise, sends
the qwerty key to the application.

Returns

Type: Int
Description: true if the modified BX key could be successfully simulated into
a qwerty key, false otherwise.

Parameters

Param 1:

Type: string
Description: The BX key to be modified.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
DPadEnter

Function: DPadEnter

Description

Simulates the pressing of the center of the rocker pad on an iPAQ or similar
PDA.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later

----------
DPadEnter

Script: DPadEnter

Description

Simulates the pressing of the center of the rocker pad on an iPAQ or similar
PDA.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
EnableBrailleOnQwerty

Function: EnableBrailleOnQwerty

Description

Enables and disables braille keyboard input on a qwerty keyboard.

Returns

Type: Int
Description: Non-zero if the functionality is supported by the device, else
zero.

Parameters

Param 1:

Type: Int
Description: Non-zero to turn on, zero to turn off.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.01 and later

----------
Enter

Script: Enter

Description

Performs the standard behavior of the enter key unless in Internet Explorer
where it will activate the highlighted link.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
EnterKey

Function: EnterKey

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetKeyState

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

Type: Int
Description: TRUE if the keystate was successfully returned.

Parameters

Param 1:

Type: String
Description: The name of the key whose state is to be retrieved.  A list of
key names is referenced in keycodes.ini.
Include: Required

Param 2:

Type: Int
Description: Set to true if the key is in a down state.
Include: Required
* Returns data by reference

Param 3:

Type: Int
Description: Set to true if the toggle state is on.  For example, if CapLock
is in the on state, then this value will be true.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsKeyWaiting

Function: IsKeyWaiting

Description

Indicates if there are other keys in the buffer that need to be processed.

Returns

Type: Int
Description: Returns TRUE if there is a key waiting to be processed,
otherwise, returns FALSE.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsLastKeyRepeating

Function: IsLastKeyRepeating

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

Type: Int
Description: True the keystroke has repeated, false means it has not repeated.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
IsSameKey

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

Type: Int
Description: TRUE if both keys refer to the same physical key.

Parameters

Param 1:

Type: String
Description: The name of the first key.
Include: Required

Param 2:

Type: String
Description: The name of the second key.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSBackspace

Script: JAWSBackspace

Description

BACKSPACE (or delete), says the character or item to the left that has just
been deleted. The result is controlled by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSDelete

Script: JAWSDelete

Description

Deletes  the item at the caret or focus, then says the next character or item
gaining focus. The result is controlled by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSKey

Script: JAWSKey

Description

If the JAWS Key is the Caps Lock or Scroll Lock key, pressing twice quickly
will indicate the new state.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
KeyboardManager

Script: KeyboardManager

Description

Used to assign keystrokes to scripts.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
KeyPressedEvent

Function: KeyPressedEvent

Description

All key presses cause this function to fire.  If the key is assigned to a
script, then KeyPressedEvent is called before the script itself.  Because this
function will be called quite frequently, it is recommended that you refrain
from intensive tasks that will be performed each time a keystroke is pressed.
For a list of parameters received by KeyPressedEvent and their descriptions,
look at the Existing Parameters List box on the Parameters page.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: the numeric keycode.
Include: Required

Param 2:

Type: String
Description: the name as it would be used in a keymap.
Include: Required

Param 3:

Type: Int
Description: 1 if this was a key on the Braille Display.
Include: Required

Param 4:

Type: Int
Description: nIsScriptKey 1 if This keystroke is assigned to a script.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PassKeyThrough

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PassKeyThrough

Script: PassKeyThrough

Description

JAWS will not use or process the following key, it will be sent directly to
the application, as if JAWS were not loaded.  This is very useful if you have
a key conflict.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PausePACMateRemote

Function: PausePACMateRemote

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

Type: int
Description: TRUE if in a PAC Mate Remote session and the session is paused.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
PausePACMateRemote

Script: PausePACMateRemote

Description

If the user is in a PACMate remote session and it is successfully paused,	the
PACMate will speak appropriate text there.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
PerformAdvancedLayerKey

Function: PerformAdvancedLayerKey

Description

This function is called by function PerformLayeredKey to perform keys in the
Advanced layer.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The assigned key code constant to perform.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
PerformLayeredKey

Function: PerformLayeredKey

Description

Use this function to perform a script associated with a key from within a
layer. This function is used by the help screens for the various layers to
perform scripts from within the help screen virtual buffer.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The code representing one of the keys for the currently active
layer. See the key integer constants in HJConst.jsh for codes of keys in each
layer.
Include: Required

Param 2:

Type: Int
Description: The constant representing the currently active layer. See layer
constants in HJConst.jsh.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
PressAppButton

Function: PressAppButton

Description

Simulates pressing one of the Program Buttons as defined in the PocketPC
Program Buttoms Control Panel Applet.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The index of the button from 1 to 16.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
RemoveHook

Function: RemoveHook

Description

Removes a hook function put in place by AddHook.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The type of hook to be installed. Use HK_SCRIPT for this
parameter. Hook types are defined in HJConst.JSH.
Include: Required

Param 2:

Type: string
Description: The name of a function to be installed as a hook.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetTypingEcho

Script: SetTypingEcho

Description

The four available choices for Typing Echo are characters, words, both
characters and words, or none.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetTypingEchoLanguage

Function: SetTypingEchoLanguage

Description

This function allows the user to change the language JAWS uses for typing
echo. If a valid language abbreviation is supplied, that language will be used
(if supported by the Synthesiser in use) otherwise the global language will be
used.  Note this is only available in JAWS 5.0 International (v 5.00.709 or
higher).

Returns

Type: int
Description: True if we were able to switch the typing echo language, FALSE
otherwise.

Parameters

Param 1:

Type: string
Description: any language code for which a language alias is defined for the
current synth or a language string understood by the current synth. Note this
function only supports aliases which map to an actual language switch (rather
than a voice switch).
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
ShiftEnterKey

Function: ShiftEnterKey

Description

Passes the SHIFT+ENTER key through to the application. If the Virtual PC
cursor is active and on a link then the link is opened in a new browser
window.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ShiftTab

Script: ShiftTab

Description

Performs the standard behavior of the shift tab keystroke unless in
InternetExplorer where it will move to the previous link or control in the tab
order

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShiftTabKey

Function: ShiftTabKey

Description

The SHIFT+TAB keystroke is passed to the application. If the Virtual PC cursor
is active, it is moved to the previous link or control in the tab order.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShortcutAvailable

Function: ShortcutAvailable

Description

This function is used to determine the currently available global shortcuts.
Overwrite this function in applications where the currently available
shortcuts may not be the default.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SimulateKey

Function: SimulateKey

Description

If the key name is attached to a script, performs the script; otherwise, sends
the key to the application.

Returns

Type: int
Description: if the key simulation was successful, false otherwise.

Parameters

Param 1:

Type: string
Description: the key name to be performed.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
SwitchInputLanguage

Script: SwitchInputLanguage

Description

In Control Panel's Regional and Language Options, one can add additional input
languages.  Typically, ALT+SHIFT is the keystroke used to switch between
multiple language inputs.  This keystroke speaks the new layout.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
Tab

Script: Tab

Description

Performs the standard behavior of the tab key unless in InternetExplorer where
it will move to the next link or control in the tab order

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TabKey

Function: TabKey

Description

The TAB key is passed to the application. If the Virtual PC cursor is active,
it is moved to the next link or control in the tab order.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ToggleCapsLockState

Function: ToggleCapsLockState

Description

Toggles and announces the state of Caps lock.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ToggleKeyboardLogging

Function: ToggleKeyboardLogging

Description

Logs key messages as they are processed by our keyboard engine.  The log
output is dumped into the JAWS directory keystrokes.log file.

Returns

Type: Int
Description: TRUE if keyboard logging is turned on, otherwise FALSE.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ToggleKeyboardLogging

Script: ToggleKeyboardLogging

Description

If you are experiencing sticky or malfunctioning keys, use this keystroke to
turn on Keyboard Logging.  Turn it off when finished and then check your JAWS
directory for a file called keystrokes.log.  Steps are as follows.  Navigate
to the area in question, turn on Keyboard Logging and then press the keystroke
or sequence of keystrokes that causes the problem.  If you can, turn off
Keyboard Logging.  If not, do not turn it on again when you restart your
computer as the keystrokes.log file will be overwritten.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ToggleOneHandedBrailleMode

Script: ToggleOneHandedBrailleMode

Description

Press all of these keys together to turn one-handed braille input mode on.
One-handed braille input will remain on until turned off by pressing the keys
in sequence, starting with the space bar. Press SpaceBar after entering all
keys in the sequence to terminate the key combination and turn braille
one-handed input off.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
TrapKeys

Function: TrapKeys

Description

Turns Trap key mode On or Off. When Trap Key mode is on, any keys not attached
to scripts are simply ignored and not passed on to the current application.
The primary use for this feature is in the Keyboard Help, where keys not
attached to scripts should be ignored.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: TRUE to enable trapping, FALSE to disable it.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TypeKey

Function: TypeKey

Description

Simulates a keystroke.  Unlike TypeString, TypeKey translates the message
constant at runtime.

Returns

Type: Int
Description: TRUE if the string is successfully simulated.

Parameters

Param 1:

Type: string
Description: A message constant containing a keystroke name.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TypingEcho

Function: TypingEcho

Description

JAWS will echo or speak each character as you type, or just the complete word
when you press the space bar, or nothing.

Returns

Type: String
Description: description of value to be displayed as value of Typing Echo.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UpALevel

Script: UpALevel

Description

In menus, This keystroke will close the menu and place the focus on the menu
bar. In Combo List boxes This keystroke will exit the Combo List box returning
focus to the Combo box without making a selection. This keystroke will also
close a Context menu.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
UsingRemotePACMateBX

Function: UsingRemotePACMateBX

Description

Returns

Type: int
Description: TRUE if running in a remote PAC Mate BX session.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
ControlShiftEnterKey

Function: ControlShiftEnterKey

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

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
ControlShiftEnter

Script: ControlShiftEnter

Description

This script passes control shift enter directly to the application so that the
application can perform the associated action. For example, when you press
this keystroke within IE7 on a link, it creates a tab for the link in IE.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
DoNativeKey

Script: DoNativeKey

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
FindKeyAliasMatch

Function: FindKeyAliasMatch

Description

Returns

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

Parameters

Param 1:

Type: String
Description:
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
LockKeyboard

Script: LockKeyboard

Description

This keystroke locks the keyboard and only allows navigation and some
informational keystrokes to b used.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 3.00 and later

----------
OnMouseOver

Script: OnMouseOver

Description

Many elements contain more options available by moving the mouse over the
element or with the press of the control enter keystroke.  Press this
keystroke to access these OnMouseOver options.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
CenterMouseInView

Function: CenterMouseInView

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IsHJTrackEngine

Function: IsHJTrackEngine

Description

This function is used to determine if JFW is running as the HJTrackEngine
under MAGic.  This is done by searching for the existence of the MAGic UI
window.  If this window exists and both Speech and Braille are off, this
function assumes JFW is running as the HJTrack Engine.  Otherwise, JFW assumes
it is the full talking version of JFW.  This function returns 1 if JFW is
running as the HJTrack Engine.  It returns 0 otherwise.

Returns

Type: Int
Description: This function returns 1 if JFW is running as the HJTrack Engine.
It returns 0 otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LowerMAGicViewMagLevel

Script: LowerMAGicViewMagLevel

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagGetArea

Function: MagGetArea

Description

Used to get area mode in MAGic.

Returns

Type: Int
Description: One of: MA_VERTICAL, MA_HORIZONTAL, MA_FULL_SCREEN, MA_OVERLAY,
MA_LENS, or MA_TRLENS.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagGetOption

Function: MagGetOption

Description

Options that can be retrieved are listed in MagCodes.jsh.

Returns

Type: Int
Description: -1 if the option value cannot be retrieved, otherwise the option
value.

Parameters

Param 1:

Type: Int
Description: the code of the option to be retrieved. Codes are listed in
MagCodes.jsh.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MAGicKey

Script: MAGicKey

Description

If the MAGic Key is the Caps Lock or Scroll Lock key, pressing twice quickly
will indicate the new state.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagResetArea

Function: MagResetArea

Description

Resets the color masks of both magnified and unmagnified areas. Also resets to
default Area mode and Default Area window sizes.

Returns

Type: Int
Description: TRUE if the function succeeds.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSayNextCharacter

Script: MagSayNextCharacter

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagSayNextLine

Script: MagSayNextLine

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagSayPriorCharacter

Script: MagSayPriorCharacter

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagSayPriorLine

Script: MagSayPriorLine

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagSelectFromStartOfLine

Script: MagSelectFromStartOfLine

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagSelectNextCharacter

Script: MagSelectNextCharacter

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagSelectPriorCharacter

Script: MagSelectPriorCharacter

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagSelectToEndOfLine

Script: MagSelectToEndOfLine

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MagSendKeyEvent

Function: MagSendKeyEvent

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

Type: Int
Description: If MAGic is not running, or nKICode is out of range, then the
function will return FALSE. Otherwise, TRUE is returned.

Parameters

Param 1:

Type: Int
Description: The code for the key event. These codes can be found in
magcodes.jsh.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSetArea

Function: MagSetArea

Description

Used to set area mode in MAGic.

Returns

Type: Int
Description: TRUE if the mode was set.

Parameters

Param 1:

Type: Int
Description: The requested mode. Can be one of MA_VERTICAL, MA_HORIZONTAL,
MA_FULL_SCREEN, MA_OVERLAY, MA_LENS, or MA_TRLENS.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSetBorder

Function: MagSetBorder

Description

Used to set the color and width of borders surrounding magnification areas.

Returns

Type: Int
Description: TRUE if the function succeeds.

Parameters

Param 1:

Type: Int
Description: Value from 1 to 256, specifying the one based index of the system
palette color to which you want the border set.
Include: Required

Param 2:

Type: Int
Description: Value from 1 to 25, specifying the width of the border.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSetFocus

Function: MagSetFocus

Description

Causes MAGic to set focus. How this is accomplished is defined by the
FocusType parameter.

Returns

Type: Int
Description: The function returns 0 if the function could not be performed,
otherwise it returns 1.

Parameters

Param 1:

Type: Int
Description: Screen coordinate of left edge of rectangle.
Include: Required

Param 2:

Type: Int
Description: Screen coordinate of right edge of rectangle.
Include: Required

Param 3:

Type: Int
Description: Screen coordinate of top edge of rectangle.
Include: Required

Param 4:

Type: Int
Description: Screen coordinate of bottom edge of rectangle.
Include: Required

Param 5:

Type: Int
Description: The specified focus command. Can be one of MF_OVERLAY, MF_LENS,
MF_VERTICAL_SPLIT, MF_HORIZONTAL_SPLIT, MF_OVERLAY_OVER_RECT,
MF_LENS_OVER_RECT, MF_TRACK_LENS_OVER_RECT, or MF_TRACK_LENS.
Include: Required

Param 6:

Type: Int
Description: 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 the view will always shift to the rectangle unless tracking
is turned off.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSetFocusToPoint

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

Type: Int
Description: TRUE if MagSetFocusToPoint is successful.

Parameters

Param 1:

Type: Int
Description: Horizontal (x) coordinate of the point.
Include: Required

Param 2:

Type: Int
Description: Vertical (y) coordinate of the point.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSetFocusToRect

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.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The left edge of the rectangle.
Include: Required

Param 2:

Type: Int
Description: The right edge of the rectangle.
Include: Required

Param 3:

Type: Int
Description: The top edge of the rectangle.
Include: Required

Param 4:

Type: Int
Description: The bottom edge of the rectangle.
Include: Required

Param 5:

Type: Int
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSetMagnifiedColorMask

Function: MagSetMagnifiedColorMask

Description

Used to mask out a particular color in the magnified area.

Returns

Type: Int
Description: TRUE if the function succeeds.

Parameters

Param 1:

Type: Int
Description: Value from 0 to 255, specifying the 0 based index of the system
palette color that is to be masked.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSetTrackAlignment

Function: MagSetTrackAlignment

Description

Tracking alignment can be set to TRACK_ALIGNMENT_EDGE, TRACK_ALIGNMENT_CENTER,
TRACK_ALIGNMENT_CONTINUOUS, or TRACK_ALIGNMENT_PREDICTIVE.

Returns

Type: Int
Description: TRUE if tracking alignment is successfully set, otherwise FALSE.

Parameters

Param 1:

Type: Int
Description: One of the four alignment modes.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagSetTrackingObjects

Function: MagSetTrackingObjects

Description

Toggles ON/OFF specific tracking objects. These objects are listed under MAGic
Tracking Objects in HJConst.jsh.

Returns

Type: Int
Description: TRUE if Tracking Objects is successfully modified.

Parameters

Param 1:

Type: Int
Description: Identifies which specific objects are to be modified. If a
tracking object is not included in nFlags, then the item's state will not be
changed. You can "or" objects together using the | operator.
Include: Required

Param 2:

Type: Int
Description: Tracking objects that are included in this value are turned On.
If an object is included in nFlags and in nStates, then the item will be
turned On. If the item is included in nFlags, but not in nStates, the item
will be turned Off.  items that are not included in nFlags are not modified.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagTrackingToggle

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

Type: Int
Description: "ON" = 1, "OFF" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
RaiseMAGicViewMagLevel

Script: RaiseMAGicViewMagLevel

Description

This key is only active when the MAGic Keyboard layout is selected from the
File menu in JAWS.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShutDownMAGic

Function: ShutDownMAGic

Description

Finds the MAGic window and sends a WM_CLOSE to it.

Returns

Type: Int
Description: FALSE if the MAGic window could not be shut down. Otherwise TRUE.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ToggleLocatorMode

Function: ToggleLocatorMode

Description

Toggles the current state of the MAGic Locator.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: 1 if MAGic  should restore the original cursor position if
exiting the locator.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MagGetMagnifiedRect

Function: MagGetMagnifiedRect

Description

Gets the MAGic magnified rectangle

Returns

Type: Int
Description: TRUE if the magnified rectangle is successfully retrieved.  FALSE
otherwise.

Parameters

Param 1:

Type: Int
Description: The left edge of the magnified rectangle.
Include: Required
* Returns data by reference

Param 2:

Type: Int
Description: The top edge of the magnified rectangle.
Include: Required
* Returns data by reference

Param 3:

Type: Int
Description: The right edge of the magnified rectangle.
Include: Required
* Returns data by reference

Param 4:

Type: Int
Description: The bottom edge of the magnified rectangle.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
MagGetMagnifiedView

Function: MagGetMagnifiedView

Description

Used to get current view mode in MAGic.

Returns

Type: Int
Description: One of: Can be one of 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.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
MagSetMagnifiedView

Function: MagSetMagnifiedView

Description

Used to set current view mode in MAGic.

Returns

Type: Int
Description: TRUE if the mode was set.

Parameters

Param 1:

Type: Int
Description: The requested mode. Can be one of mv_Full, mv_Split, mv_Overlay,
mv_Lens, or mv_Dynamic_Lens.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ActivateAppMenu

Script: ActivateAppMenu

Description

After pressing this keystroke, use the up and down arrow keys to review the
options and press enter on your selection.  To exit the menu without selecting
an option, press this keystroke again.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ActivateMenuBar

Function: ActivateMenuBar

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ActivateStartMenu

Function: ActivateStartMenu

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ContextMenuProcessed

Function: ContextMenuProcessed

Description

Returns

Type: int
Description: True if in a context menu and the actions for the context menu
were performed, false otherwise.

Parameters

Param 1:

Type: handle
Description: The handle of the window passed to MenuModeEvent.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
DoExtraMenuProcessing

Function: DoExtraMenuProcessing

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
EditAvailable

Function: EditAvailable

Description

This function is used to determine the currently available edit commands.
Overwrite this function in applications where the currently available edit
commands may not be the default.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GetMenuMode

Function: GetMenuMode

Description

Gets the mode of a menu, active or inactive.

Returns

Type: Int
Description: The Menu mode returned.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetMenuName

Function: GetMenuName

Description

Gets the name of the active menu.

Returns

Type: String
Description: The name of the active menu.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MenuActiveProcessed

Function: MenuActiveProcessed

Description

Returns

Type: int
Description: True if menus are inactive and the actions for the menu mode were
performed, false otherwise.

Parameters

Param 1:

Type: int
Description: The current menu mode.
Include: Required

Param 2:

Type: handle
Description: The handle of the window passed to MenuModeEvent.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
MenuBar

Script: MenuBar

Description

After Menu bar gains focus the screen is refreshed in order to ensure that it
reads properly. The same as pressing the Alt key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MenuBarActiveProcessed

Function: MenuBarActiveProcessed

Description

Returns

Type: int
Description: True if the menu bar is active and the actions for the menu mode
were performed, false otherwise.

Parameters

Param 1:

Type: int
Description: The current menu mode.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
MenuInactiveProcessed

Function: MenuInactiveProcessed

Description

Returns

Type: int
Description: True if menus are inactive and the actions for the menu mode were
performed, false otherwise.

Parameters

Param 1:

Type: int
Description: The current menu mode.
Include: Required

Param 2:

Type: int
Description: The previous menu mode.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
MenuModeEvent

Function: MenuModeEvent

Description

There are three menu modes as defined in HJCONST.JSH.  They are:
MENU_INACTIVE, MENUBAR_ACTIVE, and MENU_ACTIVE.  This event receives the
Handle of the menu and the mode of the menu as parameters.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of the menu
Include: Required

Param 2:

Type: Int
Description: The mode of the menu whose status has just changed
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MenuModeHook

Function: MenuModeHook

Description

Can be used in situations in which the application needs to perform specific
actions when the menu mode changes.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MenusActive

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

Type: Int
Description: "ACTIVE" = 1, "INACTIVE" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PocketMenuAdd

Function: PocketMenuAdd

Description

Adds an option to a dynamicly created menu.  Used multiple times prior to
calling PocketMenuExecute.  Can be intermixed with calls to
PocketMenuAddWithCallback.  You should either provide nonzero values for both
nX and nY or just for hWnd.  If all three parameters are nonzero, then hWnd is
used and nX and nY are ignored.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: X coordinate of the point to be clicked if this option is
selected from the menu.
Include: Required

Param 2:

Type: Int
Description: Y coordinate of the point to be clicked if this option is
selected from the menu.
Include: Required

Param 3:

Type: Handle
Description: Window to which focus should be switched if this option is
selected.
Include: Required

Param 4:

Type: String
Description: Text to be displayed for this menu option. an & before a
character makes that character the hotkey for the item
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
PocketMenuAddWithCallback

Function: PocketMenuAddWithCallback

Description

Adds an option to a dynamicly created menu.  Used multiple times prior to
calling PocketMenuExecute.  Can be intermixed with calls to PocketMenuAdd.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Name of the function to be called if this option is selected from
the menu.
Include: Required

Param 2:

Type: Int
Description: Value which will be passed as a parameter to the callback
function if this option is selected.
Include: Required

Param 3:

Type: String
Description: Text to be displayed for this menu option. an & before a
character makes that character the hotkey for the item
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
PocketMenuExecute

Function: PocketMenuExecute

Description

Uses the information provided by previous calls to PocketMenuAdd and
PocketMenuAddWithCallback to prsent a menu from which the user can select an
option.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShortcutToEdit

Script: ShortcutToEdit

Description

Activates the Edit menu item if available.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShortcutToModemConnection

Script: ShortcutToModemConnection

Description

Activates the Modem Connection dialog if the Modem Connection icon is
available.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShortcutToNew

Script: ShortcutToNew

Description

Activates the New menu item if available.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShortcutToTools

Script: ShortcutToTools

Description

Activates the Tools menu item if available.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShortcutToView

Script: ShortcutToView

Description

Activates the View menu item if available.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ShortcutToVoiceBar

Script: ShortcutToVoiceBar

Description

Activates the Voice Bar menu item if available.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
StartMenu

Script: StartMenu

Description

This keystroke is the same as pressing CTRL+ESC or using one of the Windows
Logo keys.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AppearPhantomWindow

Function: AppearPhantomWindow

Description

Displays a virtual window for a specific duration of time. The function
DisappearPhantomWindow is scheduled to make the virtual window go away. The
virtual window may be dismissed early using the Close button.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The window text, including any line breaks, to be displayed in
the virtual window.
Include: Required

Param 2:

Type: int
Description: The duration of time in tenths of a second for the window to
appear if not dismissed early using the Close button.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
DecToHex

Function: DecToHex

Description

This function converts a decimal integer to a hex string.

Returns

Type: string
Description: The hex value

Parameters

Param 1:

Type: int
Description: decimal value
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later
	2. PAC Mate 4.0 and later

----------
DisappearPhantomWindow

Function: DisappearPhantomWindow

Description

Dismisses the virtual window created by AppearPhantomWindow.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
GetCustomLabelKey

Function: GetCustomLabelKey

Description

This allows scripts used in the process of creating a custom label to obtain
the unique key for the current object. this key is used to map the object to
the custom label.

Returns

Type: string
Description: the key used to map the object to the custom label.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
GetDocumentPath

Function: GetDocumentPath

Description

This allows scripts to obtain the path or URL of the currently active document

Returns

Type: string
Description: The path of the current document

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
GetDomainName

Function: GetDomainName

Description

This allows scripts to obtain the domain of the currently active document

Returns

Type: string
Description: The domain of the current document

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
GetLineCount

Function: GetLineCount

Description

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

Returns

Type: Int
Description: the number of lines.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetOutputModeName

Function: GetOutputModeName

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

Type: string
Description: the human friendly name for the given output mode and
destination.

Parameters

Param 1:

Type: int
Description: one of the OT constants from hjconst.jsh
Include: Required

Param 2:

Type: int
Description: one of the Output Type destinations from hjconst.jsh.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later
	2. PAC Mate 2.50 and later

----------
HiWord

Function: HiWord

Description

Returns

Type: int
Description: the high-order 16-bits of the number.

Parameters

Param 1:

Type: int
Description: a 32-bit number which for the purposes of this function is always
treated as unsigned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later
	2. PAC Mate 2.50 and later

----------
LoWord

Function: LoWord

Description

Returns

Type: int
Description: the low-order 16-bits of the number.

Parameters

Param 1:

Type: int
Description: a 32-bit number which for the purposes of this function is always
treated as unsigned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later
	2. PAC Mate 2.50 and later

----------
Max

Function: Max

Description

Returns the maximum between two integers.  Useful when comparing variables.

Returns

Type: Int
Description: the maximum between two integers.

Parameters

Param 1:

Type: Int
Description: Type a variable of type int to be compared.
Include: Required

Param 2:

Type: Int
Description: Type the second variable or integer to be compared.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Min

Function: Min

Description

Returns the minimum between two integers.  Useful when comparing variables.

Returns

Type: Int
Description: the minimum between two integers.

Parameters

Param 1:

Type: Int
Description: Type a variable of type int to be compared.
Include: Required

Param 2:

Type: Int
Description: Type the second variable or integer to be compared.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MinimizeAllApps

Function: MinimizeAllApps

Description

Minimizes all windows on the Win95/98 or NT desktop. Same as WINDOWS KEY+M.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MinimizeAllApps

Script: MinimizeAllApps

Description

Minimizes all application windows, so the Desktop gains the focus and is not
obscured by any open windows.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PlaceMarkersEnumerate

Function: PlaceMarkersEnumerate

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

Type: int
Description: true if the enumeration visited all markers, false if the
enumeration failed or the callback returned false for any marker.

Parameters

Param 1:

Type: string
Description: 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.
Include: Required

Param 2:

Type: int
Description: must be set to true if the text at the marker is to be passed
with markup, false for no markup.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
QuitApplication

Script: QuitApplication

Description

Quits the current application and removes it from memory.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.10 and later

----------
ReadContextLine

Function: ReadContextLine

Description

This function moves the JAWSCursor to the line of text that is highlighted
when a dialog moves through a document, such as SpellCheck or Find.  If the
highlighted line is found, TRUE is returned.  If not true, try using the
DragDialogWindow to pull the dialog window out of the way.

Returns

Type: Int
Description: TRUE if word in Context found, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SpeakPlaceMarkers

Script: SpeakPlaceMarkers

Description

This script speaks the name and text of each placemarker in the current
virtual document. If its keystroke is pressed twice quickly, this information
will be displayed in the virtual viewer. The user may then navigate the
important information from the original document in a summarized view. The
user may press Enter on the name of any of the placemarkers in this virtual
view and they'll be positioned on the text of that placemarker in the real
document. Note it is only available in JAWS 5.00.772 or higher

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
toggleAllowJAWSMenuSelectionApplet

Script: toggleAllowJAWSMenuSelectionApplet

Description

When toggled on, the JAWS Menu Selection applet may appear in the list of the
Personal tab of Settings. When toggled off, the JAWS Menu Selection applet may
not appear in Settings.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later

----------
Undo

Script: Undo

Description

This command is usually found in the Edit menu of the application. Useful when
an action had inadvertenly been performed to revert back to the original
state.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
VirtualClearTimeOrDate

Function: VirtualClearTimeOrDate

Description

Clears the time or date from the braille display. The function
VirtualShowTimeOrDate and VirtualClearTimeOrDate are companion functions.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.10 and later

----------
VirtualShowTimeOrDate

Function: VirtualShowTimeOrDate

Description

Displays the time or date in braille. The function VirtualShowTimeOrDate and
VirtualClearTimeOrDate are companion functions.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The time or date to be shown in braille.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.10 and later

----------
AltLeftMouseClick

Function: AltLeftMouseClick

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ClearValues

Script: ClearValues

Description

Allows you to start over or cancel in defining a frame or dragging an object.
If you have moved the cursor, it will remain in its new location. Clears the
global variables used when defining frames or in drag and drop.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ClickAtPoint

Function: ClickAtPoint

Description

Performs a mouse click at the point with the X and Y coordinates passed in the
parameter list.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: The X coordinate of the point.
Include: Required

Param 2:

Type: int
Description: The Y coordinate of the point.
Include: Required

Param 3:

Type: int
Description: true if the JAWS cursor must be used for the click, false
otherwise. In most applications, RoutePCToInvisible will click the graphic.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.20 and later
	2. PAC Mate 2.00 and later

----------
ControlLeftMouseClick

Function: ControlLeftMouseClick

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ControlLeftMouseClick

Script: ControlLeftMouseClick

Description

This keystroke provides a method for selecting items non-contiguously An
example is selecting items non-contiguously in a list view.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DragAndDrop

Script: DragAndDrop

Description

The first time the script is executed, the JAWS cursor must be pointing at the
object to be dragged. When the script is activated again, the object is
dragged to the position of the active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DragAndDropClearValues

Function: DragAndDropClearValues

Description

Allows you to cancel the drag and drop action by reinitializing the global
variables used in this procedure.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DragItemWithMouse

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.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The X coordinate of the item that is to be moved.
Include: Required

Param 2:

Type: Int
Description: The Y coordinate of the item that is to be moved.
Include: Required

Param 3:

Type: Int
Description: The X coordinate of the target location for the item.
Include: Required

Param 4:

Type: Int
Description: The Y coordinate of the target location for the item.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsLeftButtonDown

Function: IsLeftButtonDown

Description

Checks to see if the left mouse button is locked down.

Returns

Type: Int
Description: TRUE if left button is locked, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsRightButtonDown

Function: IsRightButtonDown

Description

Checks to see if the right mouse button is locked down.

Returns

Type: Int
Description: TRUE if right button is locked, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LeftMouseButton

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LeftMouseButton

Script: LeftMouseButton

Description

Press twice for a double click. The position of the JAWS cursor is the same as
the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LeftMouseButtonLock

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

Type: Int
Description: "POINTER_ATTACHED" =1, "POINTER_DETACHED" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LeftMouseButtonLock

Script: LeftMouseButtonLock

Description

Locks the left mouse button down, in order to drag items across the screen.
Press it again to unlock it, in order to drop the item.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseButtonEvent

Function: MouseButtonEvent

Description

This function is passed an event identifier. See HJConst.h for a list of
possible MouseButtonEvent identifiers.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The event identifier of the event.
Include: Required

Param 2:

Type: Int
Description: The horizontal position of the mouse pointer in pixels.
Include: Required

Param 3:

Type: Int
Description: The vertical position of the mouse pointer.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
MouseDown

Function: MouseDown

Description

Moves the Mouse Down by the specified number of pixels.

Returns

Type: Int
Description: TRUE if successful, FALSE if already at bottom of screen.

Parameters

Param 1:

Type: Int
Description: Number of pixels to move.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseDown

Script: MouseDown

Description

The number of pixels for mouse movement is determined by the mouse movement
variable. The value of the mouse movement variable is set in default JCF. It
can be modified by using home row utility scripts This keystroke is useful for
accurately positioning the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseLeft

Function: MouseLeft

Description

Moves the Mouse Left by the specified number of pixels.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Number of pixels to move.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseLeft

Script: MouseLeft

Description

The number of pixels for mouse movement is determined by the mouse movement
variable.  The value of the mouse movement variable is set in default JCF.  It
can be modified by using home row utility scripts.  This keystroke is useful
for accurately positioning the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseMovedEvent

Function: MouseMovedEvent

Description

This function is passed two integers. The first value specifies the
x-coordinate at the position of the mouse pointer. The second parameter
specifies the y-coordinate and the position of the mouse pointer.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The horizontal position of the mouse pointer in pixels.
Include: Required

Param 2:

Type: Int
Description: The vertical position of the mouse pointer.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseMovementDecrement

Script: MouseMovementDecrement

Description

The mouse movement distance is the number of pixels that the mouse moves for
each mouse movement.  If the current setting is 1, the new setting will be 50.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseMovementDefault

Script: MouseMovementDefault

Description

The default value is three pixels.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseMovementIncrement

Script: MouseMovementIncrement

Description

The mouse movement distance is the number of pixels that the mouse moves for
each mouse movement.  If the current setting is 50, the new setting will be 1.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseRight

Function: MouseRight

Description

Moves the Mouse Right by the specified number of pixels.

Returns

Type: Int
Description: TRUE if successful, FALSE if already at right of screen.

Parameters

Param 1:

Type: Int
Description: Number of pixels to move.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseRight

Script: MouseRight

Description

The number of pixels for mouse movement is determined by the mouse movement
variable. The value of the mouse movement variable is set in default JCF. It
can be modified by using home row utility scripts  This is useful for
accurately positioning the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseUp

Function: MouseUp

Description

Moves the Mouse Up by the specified number of pixels.

Returns

Type: Int
Description: TRUE if successful, FALSE if already at top of screen.

Parameters

Param 1:

Type: Int
Description: Number of pixels to move.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MouseUp

Script: MouseUp

Description

The number of pixels for mouse movement is determined by the mouse movement
variable. The value of the mouse movement variable is set in default JCF. It
can be modified by using home row utility scripts  This is useful for
accurately positioning the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RightMouseButton

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RightMouseButton

Script: RightMouseButton

Description

Press twice for a double click.  The position of the JAWS cursor is the same
as the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RightMouseButtonLock

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.

Returns

Type: Int
Description: "POINTER_ATTACHED" = 1, "POINTER_DETACHED" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RightMouseButtonLock

Script: RightMouseButtonLock

Description

Locks the right mouse button down, in order to drag items across the screen.
Press it again to unlock it, in order to drop the item.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayMouseAndAnsiSettings

Script: SayMouseAndAnsiSettings

Description

These settings are the number of pixels in the Mouse Movement variable and
what level of ANSI characters are spoken.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShiftLeftMouseClick

Function: ShiftLeftMouseClick

Description

Sends a SHIFT+LEFT Mouse Click to the system, useful for selecting contiguous
text or items in a list with the mouse pointer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShiftLeftMouseClick

Script: ShiftLeftMouseClick

Description

This keystroke provides a method for selecting items contiguously An example
is selecting items contiguously in a list view or an edit control.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ProcessWasNonFocusedItemClicked

Function: ProcessWasNonFocusedItemClicked

Description

This function should be used to perform any special processing necessary when
the mouse clicks on a location different than the PC cursor. Typically, this
means that the mouse will be in a different window than the PC cursor, but
this can be overwritten as needed.

Returns

Type: int
Description: true if the mouse and cursor are at the same location, false
otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.11 and later

----------
BottomOfFile

Script: BottomOfFile

Description

If the active item is an edit box the caret or focus will move to the end of
the open document. Otherwise, moves to the bottom of the current control.
Windows command for moving the cursor to the bottom of the file, if supported
by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GotoLineNumber

Function: GotoLineNumber

Description

this function moves the cursor to the specified line number in a virtual
document.

Returns

Type: Int
Description: true if the line was successfully moved to, false otherwise.

Parameters

Param 1:

Type: Int
Description: the line number (starting at 1).
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
HomeEndMovement

Function: HomeEndMovement

Description

Performs processing for the movement assigned to the Home and End keys.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement direction, UnitMove_First or UnitMove_Last.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
JAWSBottomOfFile

Function: JAWSBottomOfFile

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
JAWSEnd

Function: JAWSEnd

Description

This performs a special version of the END keyboard command. When the PC
cursor is active, the script function performs the home function for the
application. When other cursors are active, the cursor moves to the last text
character or graphic on the line within either the active application window
or active child window (depending on the setting for cursor restriction).

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
JAWSEnd

Script: JAWSEnd

Description

If JAWS cursor or invisible cursor are active, will move the cursor to the
right edge of the active window. If PC cursor is active the results are
dependent on the application for specific controls such as a List box.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSHome

Function: JAWSHome

Description

This performs a special version of the HOME keyboard command. When the PC
cursor is active, the script function performs the home function for the
application. When other cursors are active, the cursor moves to the first text
character or graphics on the line within either the active application window
or child window (depending on the setting for cursor restriction).

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSHome

Script: JAWSHome

Description

If JAWS cursor or invisible cursor are active, will move the cursor to the
left edge of the active window.  If PC cursor is active, the results are
dependent on the application for specific controls such as a List box.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSPageDown

Function: JAWSPageDown

Description

This performs a special version of the PAGE DOWN keyboard command. When the PC
cursor is active, the script function performs the standard Page Down function
for the application. When other cursors are active, the cursor moves to the
bottom of the active application window or to the bottom of the active child
window, depending on the setting for JAWS cursor restriction.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSPageDown

Script: JAWSPageDown

Description

Moves the JAWS or Invisible cursor, if active, to the bottom of the active
window, does not move left or right.  If the PC cursor is active, JAWS sends a
PAGE DOWN to the system.  The result is controlled by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSPageUp

Function: JAWSPageUp

Description

This performs a special version of the PAGE UP keyboard command. When the PC
cursor is active, the script function performs the standard PAGE UP command
for the application. When other cursors are active, the cursor moves to the
top of the active application window or to the top of the active child window
(depending on the setting for JAWS cursor restriction).

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSPageUp

Script: JAWSPageUp

Description

Moves the JAWS or Invisible cursor, if active, to the top of the active
window, does not move left or right.  If the PC cursor is active, JAWS sends a
PAGE UP to the system.  The result is controlled by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSTopOfFile

Function: JAWSTopOfFile

Description

Performs standard behavior of the control+home keystroke combination.  In most
cases, moves the focus to the top of the open file, list or document.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
NextCharacter

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NextChunk

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NextLine

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

Type: Int

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NextParagraph

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

Type: Int
Description: TRUE if the next paragraph was found, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NextSentence

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

Type: Int
Description: TRUE if the next sentence was found, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NextWord

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NumericDataSayNextAsSingleUnit

Script: NumericDataSayNextAsSingleUnit

Description

Press this keystroke to move past large number and punctuation sequences such
as IP addresses and order numbers.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
NumericDataSayPriorAsSingleUnit

Script: NumericDataSayPriorAsSingleUnit

Description

Press this keystroke to move past large number and punctuation sequences such
as IP addresses and order numbers.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
PriorCharacter

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PriorChunk

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PriorLine

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

Type: Int

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PriorParagraph

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

Type: Int
Description: TRUE if the prior paragraph was found, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PriorSentence

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

Type: Int
Description: TRUE if the prior sentence was found, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PriorWord

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCharacterUnitMovement

Function: SayCharacterUnitMovement

Description

Performs processing for the movement assigned to the prior and next character
keys.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement direction, UnitMove_Prior or UnitMove_Next.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SayLineUnitMovement

Function: SayLineUnitMovement

Description

Performs processing for the movement assigned to the prior and next line.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement direction, UnitMove_Prior or UnitMove_Next.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SayNextCharacter

Script: SayNextCharacter

Description

Uses the active cursor, JAWS or PC.  If the PC cursor is active, it sends a
RIGHT ARROW to the application.  PC cursor movement is controlled by the
application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayNextCharacterPCCursor

Script: SayNextCharacterPCCursor

Description

This keystroke is assigned to the Extended right arrow key by default.  Using
the Configuration Manager you can separate the numpad keys from the extended
keys and then use This keystroke to speak the next character with the PC
Cursor regardless of which cursor is active.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayNextLine

Script: SayNextLine

Description

If the JAWS cursor is active, the column position remains the same.  If the PC
cursor is active, the application determines the column. The PC cursor is
limited by the movement of the caret, the menu,  or selected item. The JAWS
cursor is limited by the JAWS Cursor Restriction and by the borders of the
active window.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayNextLinePCCursor

Script: SayNextLinePCCursor

Description

This keystroke is assigned to the Extended down arrow key by default.  Using
the Configuration Manager you can separate the numpad keys from the extended
keys and then use This keystroke to speak the next line with the PC Cursor
regardless of which cursor is active.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayNextParagraph

Script: SayNextParagraph

Description

Moves to and reads the next paragraph.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayNextSentence

Script: SayNextSentence

Description

Moves to and reads the next sentence, only if edit type controls, otherwise
the keystroke is controlled by the specific applications.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayNextWord

Script: SayNextWord

Description

Uses the active cursor, JAWS or PC.  If the PC cursor is active, it sends a
CONTROL+RIGHT ARROW. PC cursor movement is controlled by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayNextWordPCCursor

Script: SayNextWordPCCursor

Description

Using the Configuration Manager you can separate the numpad keys from the
extended keys and then use This keystroke to speak the next word with the PC
Cursor regardless of which cursor is active.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayPriorCharacter

Script: SayPriorCharacter

Description

Uses the active cursor, JAWS or PC.  If the PC cursor is active, it sends a
LEFT ARROW to the application.  PC cursor movement is controlled by the
application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayPriorCharacterPCCursor

Script: SayPriorCharacterPCCursor

Description

This keystroke is assigned to the Extended left arrow key by default.  Using
the Configuration Manager you can separate the numpad keys from the extended
keys and then use This keystroke to speak the prior character with the PC
Cursor regardless of which cursor is active.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayPriorLine

Script: SayPriorLine

Description

If the JAWS cursor is active, the column position remains the same.  If the PC
cursor is active, the application determines the column position. The PC
cursor is limited by the movement of the caret, the menu,  or selected item.
The JAWS cursor is limited by the JAWS Cursor Restriction and by the borders
of the active window.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayPriorLinePCCursor

Script: SayPriorLinePCCursor

Description

This keystroke is assigned to the Extended up arrow key by default.  Using the
Configuration Manager you can separate the numpad keys from the extended keys
and then use This keystroke to speak the prior line with the PC Cursor
regardless of which cursor is active.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayPriorParagraph

Script: SayPriorParagraph

Description

Moves to and reads the prior paragraph.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayPriorSentence

Script: SayPriorSentence

Description

Moves to and reads the prior sentence, only if edit type controls, otherwise
the keystroke is controlled by the specific applications.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayPriorWord

Script: SayPriorWord

Description

Uses the active cursor, JAWS or PC.  If the PC cursor is active, it sends a
CONTROL+LEFT ARROW. PC cursor movement is controlled by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayPriorWordPCCursor

Script: SayPriorWordPCCursor

Description

Using the Configuration Manager you can separate the numpad keys from the
extended keys and then use This keystroke to speak the prior word with the PC
Cursor regardless of which cursor is active.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayWordUnitMovement

Function: SayWordUnitMovement

Description

Performs processing for the movement assigned to the prior and next word.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement direction, UnitMove_Prior or UnitMove_Next.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SkimReadMoveToDocLine

Function: SkimReadMoveToDocLine

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
SpeakNthPlaceMarker

Script: SpeakNthPlaceMarker

Description

To speak the PlaceMarker, press CTRL, SHIFT and its number.  For example, to
speak the third PlaceMarker, press CTRL+SHIFT+3.  To move to the PlaceMarker,
press the same key combination twice quickly.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
SwitchDocumentWindow

Function: SwitchDocumentWindow

Description

Does the equivalent of CTRL+TAB or SHIFT+CTRL+TAB, depending on the value of
bReverse.  This function is necessary because of a problem with how Ctrl+Tab
is processed internally by Windows CE.  It should not be used on Desktop
Windows.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: TRUE to go to the previous document, FALSE to go to the next one.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SwitchToPriorApp

Script: SwitchToPriorApp

Description

Press this keystroke to switch to the previous program.  If you press it
multiple times, you will be taken to each of the programs that are currently
running.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SwitchToRecentApp

Script: SwitchToRecentApp

Description

Use the up and down arrow keys to explore the list of running programs, and
press enter on your selection.  To exit the menu without making a selection,
press this keystroke again.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ToggleOutlookReminder

Script: ToggleOutlookReminder

Description

If the Outlook Reminder dialog is visible, toggles focus between the current
window and Reminder dialog.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
TopOfFile

Script: TopOfFile

Description

If the active item is an edit box the caret or focus will move to the
beginning of the open document. Otherwise, moves to the top of the current
control. Windows command for moving the cursor to the top of the file, if
supported by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCharacterUnit

Function: SayCharacterUnit

Description

Moves to the character specified by the unit movement and then speaks.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement unit. The movement unit defines the type of movement
to be performed before speaking. See HJConst.jsh for unit movement constants,
all prefixed by UnitMove_.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later
	2. JAWS 7.10 and later

----------
&&

Function: &&

Description

The && (ampersand ampersand) operator asks whether the first condition is
true, and additionally is the second condition true.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
&

Function: &

Description

The & (bitwise ampersand) operator compares each bit of its first operand to
the corresponding bit of its second operand. If both bits are 1, the
corresponding result bit is set to 1. Otherwise, the corresponding result bit
is set to 0. The best example of how this operator can be used is in the
NewTextEvent function in default.jss. There it is used for a binary comparison
of two binary numerical values. The value of nAttibutes is a multiple digit
binary numerical value that indicates all the attributes that apply to the
buffer string. Each attribute is indicated by whether or not a certain bit in
the byte is turned on. The & operator will return all values that exist in
both numerical values. For example, if the value of nAttributes is 01001010
then the seventh bit in the result byte of nAttributes & ATTRIB_HIGHLIGHT will
be set to one 1 (ATTRIB_HIGHLIGHT = 64 or 01000000 binary), the second bit in
the result byte of nAttributes & ATTRIB_BOLD will be set to 1 (ATTRIB_BOLD = 2
or 00000010 binary), and the fourth bit in the result byte of nAttributes &
ATTRIB_UNDERLINE will be set to 1 (ATTRIB_UNDERLINE = 8 or 00001000 binary)
while the third bit in the result byte of nAttributes & ATTRIB_ITALIC will be
set to 0 since ATTRIB_ITALIC is 4 or 00000100 binary and the third bit in the
nAttributes byte is 0.

Returns

Type: Int
Description: The result of the bitwise &.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
|

Function: |

Description

The | (bitwise vertical bar) operator compares each bit of its first operand
to the corresponding bit of its second operand. If either bit is 1, the
corresponding result bit is set to 1. Otherwise, the corresponding result bit
is set to 0. This function does a bit-by-bit comparison of two numerical
values which is similar to that of the & operator. The statement 00100110 |
11000000 will return 11100110.

Returns

Type: Int
Description: The result of the bitwise |.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
/

Function: /

Description

The / slash operator is used in equations to indicate division.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
==

Function: ==

Description

The == (equal equal) operator asks whether the first condition is equal to the
second condition.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
>=

Function: >=

Description

The >= (greater than or equal to) operator asks whether the first condition is
greater than or equal to the second condition.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
>

Function: >

Description

The > (greater than) operator asks whether the first condition is greater than
the second condition.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Function:

Description

The

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Function:

Description

The

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
-

Function: -

Description

The (-) minus operator is used in equations to indicate subtraction.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
%

Function: %

Description

The result of the modulus operator (%) is the remainder when the first operand
is divided by the second.

Returns

Type: Int
Description: The remainder when the first operand is divided by the second.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
*

Function: *

Description

The * asterisk operator is used in equations to indicate multiplication.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
!=

Function: !=

Description

The !=  (exclamation mark equal to) operator asks whether the first condition
is not equal to the second condition.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
||

Function: ||

Description

The || vertical bar vertical bar ) operator asks whether the first condition
is true, or if the second condition is true. If the first condition is true,
the second condition is not evaluated. It does not matter which condition is
true

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
+

Function: +

Description

The + (plus) operator is used in equations to indicate addition.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCharacterUnit

Function: SayCharacterUnit

Description

Moves to the character specified by the unit movement and then speaks the
line.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement unit. The movement unit defines the type of movement
to be performed before the character is spoken. See HJConst.jsh for unit
movement constants, all prefixed by UnitMove_.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later
	2. JAWS 7.10 and later

----------
SayLineUnit

Function: SayLineUnit

Description

Moves to the line specified by the unit movement and then speaks. For JAWS 8.0
and later, only speaks the line, the calling script must perform the movement
first.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: The movement unit. The movement unit defines the type of movement
which was performed before speaking. See HJConst.jsh for unit movement
constants, all prefixed by UnitMove_.
Include: Required

Param 2:

Type: int
Description: Boolean denoting whether or not a navigation movement occured
triggering the call to speak the line. This parameter is only valid for JAWS
8.0 and later.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later
	2. JAWS 7.10 and later

----------
SayWordUnit

Function: SayWordUnit

Description

Moves to the word specified by the unit movement and then speaks.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement unit. The movement unit defines the type of movement
to be performed before speaking. See HJConst.jsh for unit movement constants,
all prefixed by UnitMove_.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later
	2. JAWS 7.10 and later

----------
HomeEndMovement

Function: HomeEndMovement

Description

Performs processing for the movement assigned to the Home and End keys then
speaks.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement direction, UnitMove_First or UnitMove_Last.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SayPageUpDownUnit

Function: SayPageUpDownUnit

Description

Performs processing for the movement assigned to the PageUp and PageDown keys
then speaks.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement direction, UnitMove_Next or UnitMove_Prior.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SayTopBottomUnit

Function: SayTopBottomUnit

Description

Moves to the top or bottom, specified by the unit movement and then speaks.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: the movement unit. The movement unit defines the type of movement
to be performed before speaking. See HJConst.jsh for unit movement constants,
all prefixed by UnitMove_.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
GetScriptAssignedTo

Function: GetScriptAssignedTo

Description

Looks up the name of the script assigned to the specified key.

Returns

Type: string
Description: If the key name is assigned to a script, the name of the script
to which it is assigned; null otherwise.

Parameters

Param 1:

Type: string
Description: the key name for which the script assignment is to be determined.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
IsScript

Function: IsScript

Description

Determines if a string is the name of a script.

Returns

Type: int
Description: True if the passed string is the name of a script, false
otherwise.

Parameters

Param 1:

Type: string
Description: The name of a script or function.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
ProcessBXModifiedKey

Function: ProcessBXModifiedKey

Description

This function is called by KeyPressedEvent to process modified keys for the BX
when running JAWS remotely.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: the name of the key received by KeyPressedEvent.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SetLastScriptKey

Function: SetLastScriptKey

Description

Sets the name of the last key used for a script. Useful when it is necessary
to assign a specific key name to be retrieved by GetCurrentScriptKeyName.

Returns

Type: int
Description: True if the set was successful, false otherwise.

Parameters

Param 1:

Type: string
Description: The key name to use.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
cstrBrailleMarkingList

Function: cstrBrailleMarkingList

Description

This function returns the default Braille marking verbosity list.

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
cStrDefaultHTMLList

Function: cStrDefaultHTMLList

Description

This function returns the default HTML verbosity list.

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
cStrDefaultList

Function: cStrDefaultList

Description

This function returns the default verbosity dialog list.

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
cStrTableBrailleList

Function: cStrTableBrailleList

Description

This function returns the default Braille HTML table verbosity list.

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
Delay

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.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: 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 withdecimals, and do not use quotation
marks.
Include: Required

Param 2:

Type: Int
Description: TRUE to suppress checking for and processing FocusChangedEvent
and NewTextEvent functions before returning from the delay.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCurrentScriptKeyName

Function: GetCurrentScriptKeyName

Description

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

Returns

Type: String
Description: The key name.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetScriptDescription

Function: GetScriptDescription

Description

Retrieves the description of a specified script.

Returns

Type: String
Description: The text of the description.

Parameters

Param 1:

Type: string
Description: The script name of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetScriptFileName

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

Type: String
Description: 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.

Parameters

Param 1:

Type: Int
Description: True to obtain the name of the application script file, False to
obtain the name of the default script file.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetScriptKeyName

Function: GetScriptKeyName

Description

Retrieves the name of the key attached to the specified script.

Returns

Type: String
Description: The key name.

Parameters

Param 1:

Type: string
Description: The name of the script.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetScriptKeyNames

Function: GetScriptKeyNames

Description

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

Returns

Type: String
Description: A \r\n delimited list of the names of all the keys that are
assigned to the specified script.

Parameters

Param 1:

Type: string
Description: The name of the script.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetScriptSynopsis

Function: GetScriptSynopsis

Description

Retrieves the synopsis of a specified script.

Returns

Type: String
Description: The text of the synopsis.

Parameters

Param 1:

Type: string
Description: The script name of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsSameScript

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

Type: Int
Description: The number of times the script has repeated, 0 means it has not
repeated.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Pause

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ReformatKeyName

Function: ReformatKeyName

Description

Takes a valid script key name to reformat and returns a string that contains
the reformatted name to use in a message.

Returns

Type: String
Description: The formatted script key name according to Documentation
standards for script key names in messages.

Parameters

Param 1:

Type: string
Description: a valid script key name.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 7.10 and later

----------
RefreshScripts

Script: RefreshScripts

Description

This reinitializes the default script set as if JAWS were shut down and then
restarted.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.00 and later
	2. JAWS 6.00 and later

----------
SayCurrentScriptKeyLabel

Function: SayCurrentScriptKeyLabel

Description

Speaks the Key Name attached to the current script, honoring both the typing
echo setting and the label as defined in DEFAULT.JCF.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScheduleFunction

Function: ScheduleFunction

Description

Runs a user defined function in a set period of time. Useful when you want to
perform a task and then check on the results at a later time. Once this
function is used, you can call UnScheduleFunction to cause the user-defined
event not to run.

Returns

Type: Int
Description: An ID that can be used to call UnScheduleFunction. If 0 is
returned, then the timer was not successfully set.

Parameters

Param 1:

Type: String
Description: Name of function to be executed.
Include: Required

Param 2:

Type: Int
Description: Amount of time to elapse before the function is executed. Time is
measured in tenths of a second. A value of 10 is one second.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScriptAndAppNames

Function: ScriptAndAppNames

Description

Needs to be the name of the application executable, this information can be
obtained with Insert + Q.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: contains the name of the currently running script file
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScriptFileName

Script: ScriptFileName

Description

Used to identify the script file being used, and the application currently
active.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScriptManager

Script: ScriptManager

Description

Used to edit and compile JAWS script files. Scripts are small computer
programs that control JAWS activities and are usually run with a single
keystroke.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScriptManagerDefault

Script: ScriptManagerDefault

Description

Starts the Script Manager with the default file loaded.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SkimReadShouldSpeakText

Function: SkimReadShouldSpeakText

Description

This function is only used when skimreading is being controlled externally by
scripts as in MSWord.

Returns

Type: int
Description: true or false

Parameters

Param 1:

Type: string
Description: text of unit to be checked against the current skimreading
parameters. If skimreading is set to srmTextMatchesRegularExpression then the
regular expression will be applied to this text and the function will return
true if it should be spoken, false otherwise. If the skimreading mode is set
to anything other than srmTextMatchesRegularExpression, the function will
return TRUE unless a skimread is not in progress.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SwitchToScriptFile

Function: SwitchToScriptFile

Description

When this function is called, the currently loaded binary script file (A file
with a .JSB extension) is unloaded from memory and one of the two script files
specified by the functions parameters is loaded in its place. The first
parameter to the function is the name of the first JSB file you wish for JFW
to attempt to load into memory and the second parameter gives the name of an
alternative binary script file that will only be loaded if the first file
cannot be found.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the binary script file you wish to be loaded into
memory.  This parameter must be a script file name in quotes or the name of a
variable in which the script file name is stored.  This parameter must be the
script file name with or without a .jsb extension.  An attempt to use a .jss
extension in the file name will result in an error and a warning dialog box.
Include: Required

Param 2:

Type: String
Description: The name of the binary script file you wish to be loaded into
memory if the first file does not exist.  This parameter must be a script file
name in quotes or the name of a variable in which the script file name is
stored.  This parameter must contain the script file name with or without a
.jsb extension.  An attempt to use a .jss extension in the file name will
result in an error and a warning dialog box.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TypeCurrentScriptKey

Function: TypeCurrentScriptKey

Description

The key attached to the current script is passed through to the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Unknown

Function: Unknown

Description

Will speak the name of the function or script.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Contains the name of the unknown script or function.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UnScheduleFunction

Function: UnScheduleFunction

Description

Used to cancel a ScheduleFunction call.

Returns

Type: Int
Description: TRUE if the call was found and cancelled, otherwise returns
FALSE.

Parameters

Param 1:

Type: Int
Description: The value returned by the ScheduleFunction call.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
cStrBrailleList

Function: cStrBrailleList

Description

This function returns the default Braille verbosity list.

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
GetScriptAssignedTo

Function: GetScriptAssignedTo

Description

Looks up the name of the script assigned to the specified key.

Returns

Type: string
Description: If the key name is assigned to a script, the name of the script
to which it is assigned; null otherwise.

Parameters

Param 1:

Type: string
Description: the key name for which the script assignment is to be determined.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
IsScript

Function: IsScript

Description

Determines if a string is the name of a script.

Returns

Type: int
Description: True if the passed string is the name of a script, false
otherwise.

Parameters

Param 1:

Type: string
Description: The name of a script or function.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
ProcessBXModifiedKey

Function: ProcessBXModifiedKey

Description

This function is called by KeyPressedEvent to process modified keys for the BX
when running JAWS remotely.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: the name of the key received by KeyPressedEvent.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SetLastScriptKey

Function: SetLastScriptKey

Description

Sets the name of the last key used for a script. Useful when it is necessary
to assign a specific key name to be retrieved by GetCurrentScriptKeyName.

Returns

Type: int
Description: True if the set was successful, false otherwise.

Parameters

Param 1:

Type: string
Description: The key name to use.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
CustomHighlightAssign

Script: CustomHighlightAssign

Description

The Configuration Manager will be opened and the foreground and background
colors at the active cursor will be passed to it.  The Configuration Manager
will open automatically into the Custom Highlight Colors dialog where the
assignment and be saved or cancelled.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DoCustomHighlightColors

Function: DoCustomHighlightColors

Description

This is used in the RunJAWSManager keystroke to perform the
CustomHighlightAssign and use the correct colors.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Enter the variable containing the RGB string for the foreground
color.
Include: Required

Param 2:

Type: String
Description: Enter the RGB string for the background color.
Include: Required

Param 3:

Type: String
Description: Enter the value for the app file name to be used.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DragDialogWindow

Function: DragDialogWindow

Description

Useful to get the dialog out of the way so you can view the text underneath
the dialog window.  Of course, if the application won't let you drag the
dialog, this function won't work.  Most Find and SpellCheck dialog boxes will
allow themselves to be moved.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetSelectedText

Function: GetSelectedText

Description

Retrieves the currently selected text.

Returns

Type: String
Description: Provides the selected text.

Parameters

Param 1:

Type: int
Description: JAWS 6.0, specify true if you want the text to contain speech
markup, defaults to false if not specified.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Mark

Script: Mark

Description

Activates the Mark item from the menu.  May not be available with every
application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ProcessSelectText

Function: ProcessSelectText

Description

Called at the beginning of the NewTextEvent to determine if text is being
selected/unselected.

Returns

Type: Int
Description: This function is called by NewTextEvent so that when text is
selected or unselected it will be properly spoken.

Parameters

Param 1:

Type: Int
Description: The character attributes of the text being processed.
Include: Required

Param 2:

Type: String
Description: The text to be processed.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ReadWordInContext

Script: ReadWordInContext

Description

Sometimes a word needs to be reviewed in its context, in order to see if it is
really misspelled or if it is the correct occurrence of the word you are
searching for.  Press this keystroke in the Spell Check or Find dialog, or
when doing a search and replace for specific text or items.  You will hear the
line spoken in the JAWSCursor voice, because the JAWSCursor was placed on that
line.  Simply turn on the JAWSCursor to review the line of text word by word,
character by character, or read more text around the line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayHighLightedText

Function: SayHighLightedText

Description

Can be modified for application specific needs in many cases. Example:
Non-standard list boxes, spell checkers and flashing title bars.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: handle of the window in which the text was written.
Include: Required

Param 2:

Type: String
Description: String containing the text that was written.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SaySelectedText

Script: SaySelectedText

Description

This provides an easy way to check to see if you have selected the correct
text, in preparation for other actions, such as deleting, copying, bolding,
underlining, etcetera.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectAll

Script: SelectAll

Description

When available allows CTRL+A to select the entire document.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectAllItems

Script: SelectAllItems

Description

Useful in preparation for copying, cutting, and pasting, and other similar
editing functions supported by the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectCurrentItem

Script: SelectCurrentItem

Description

Useful for marking a list item for copying, cutting, and pasting.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectFromStartOfLine

Function: SelectFromStartOfLine

Description

When the PC cursor is active, JAWS allows the application to select from the
start of the current line to the PC cursor. When a portion of text is
selected, JAWS automatically speaks the newly highlighted text if screen echo
is set to Highlighted or All

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectFromStartOfLine

Script: SelectFromStartOfLine

Description

Sends a SHIFT+HOME to the system.  The result is controlled by the
application.  In most edit controls, all text from the start of the line to
the PC cursor is selected.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectFromTop

Function: SelectFromTop

Description

When the PC cursor is active, JAWS allows the application to select from the
top of the document to the PC cursor. When a portion of text is selected, JAWS
automatically speaks the newly highlighted text if screen echo is set to
Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectFromTop

Script: SelectFromTop

Description

Sends a CTRL+SHIFT+HOME to the system.  The result is controlled by the
application.  In most edit controls, all text from the top of the document to
the PC cursor is selected. This keystroke can also be used to select all items
from the currently selected item to the first item in most list boxes and list
views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectingText

Function: SelectingText

Description

Handles setting up for and finishing the process of selecting text. This
function is called by each of the scripts that is used for selecting text.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Mode param indicates whether you are selecting or not selecting
text.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectNextCharacter

Function: SelectNextCharacter

Description

When the PC cursor is active, JAWS allows the application to select the next
character. When a character is selected, JAWS automatically speaks the
character if screen echo is set to Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectNextCharacter

Script: SelectNextCharacter

Description

Sends a SHIFT+RIGHT ARROW to the system.  The result is controlled by the
application.  In most edit controls, the character to the right of the PC
cursor is selected. This keystroke can also be used for selecting items in
multiple column list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectNextLine

Function: SelectNextLine

Description

When the PC cursor is active, JAWS allows the application to select the next
line. When a line is selected, JAWS automatically speaks the line if screen
echo is set to Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectNextLine

Script: SelectNextLine

Description

Sends a SHIFT+DOWN ARROW to the system.  The result is controlled by the
application.  In most edit controls, the line below the PC cursor is selected.
This keystroke can also be used for selecting contiguous items in list boxes
or list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectNextParagraph

Script: SelectNextParagraph

Description

Selects next paragraph and announces newly selected text.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SelectNextScreen

Function: SelectNextScreen

Description

When the PC cursor is active, JAWS allows the application to select the next
page beginning at the PC cursor. When a portion of text is selected, JAWS
automatically speaks the newly highlighted text if screen echo is set to
Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectNextScreen

Script: SelectNextScreen

Description

Sends a SHIFT+PAGE DOWN to the system.  The result is controlled by the
application.  In most edit controls, The next screen of text is selected. This
keystroke can also be used for selecting contiguous items in list boxes or
list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectNextSentence

Script: SelectNextSentence

Description

Selects next sentence and announces newly selected text.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SelectNextWord

Function: SelectNextWord

Description

When the PC cursor is active, JAWS allows the application to select the next
word. When a word is selected, JAWS automatically speaks the word if screen
echo is set to Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectNextWord

Script: SelectNextWord

Description

Sends a CTRL+SHIFT+RIGHT ARROW to the system.  The result is controlled by the
application.  In most edit controls, the word to the right of the PC cursor is
selected. This keystroke can also be used for selecting items in multiple
column list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectPriorCharacter

Function: SelectPriorCharacter

Description

When the PC cursor is active, JAWS allows the application to select the prior
character. When a character is selected, JAWS automatically speaks the
character if screen echo is set to Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectPriorCharacter

Script: SelectPriorCharacter

Description

Sends a SHIFT+LEFT ARROW to the system.  The result is controlled by the
application.  In most edit controls, the character to the left of the PC
cursor is selected. This keystroke can also be used for selecting items in
multiple column list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectPriorLine

Function: SelectPriorLine

Description

When the PC cursor is active, JAWS allows the application to select the prior
line. When a line is selected, JAWS automatically speaks the line if screen
echo is set to Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectPriorLine

Script: SelectPriorLine

Description

Sends a SHIFT+UP ARROW to the system.  The result is controlled by the
application.  In most edit controls, the line above the PC cursor is selected.
This keystroke can also be used for selecting contiguous items in list boxes
or list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectPriorParagraph

Script: SelectPriorParagraph

Description

Selects prior paragraph and announces newly selected text.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SelectPriorScreen

Function: SelectPriorScreen

Description

When the PC cursor is active, JAWS allows the application to select the prior
page ending at the PC cursor. When a portion of text is selected, JAWS
automatically speaks the newly highlighted text if screen echo is set to
Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectPriorScreen

Script: SelectPriorScreen

Description

Sends a SHIFT+PAGE UP to the system.  The result is controlled by the
application.  In most edit controls, the prior screen of text is selected.
This keystroke can also be used for selecting contiguous items in list boxes
or list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectPriorSentence

Script: SelectPriorSentence

Description

Selects prior sentence and announces newly selected text.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SelectPriorWord

Function: SelectPriorWord

Description

When the PC cursor is active, JAWS allows the application to select the prior
word. When a word is selected, JAWS automatically speaks the word if screen
echo is set to Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectPriorWord

Script: SelectPriorWord

Description

Sends a CTRL+SHIFT+LEFT ARROW to the system.  The result is controlled by the
application.  In most edit controls, the word to the left of the PC cursor is
selected. This keystroke can also be used for selecting items in multiple
column list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectToBottom

Function: SelectToBottom

Description

When the PC cursor is active, JAWS allows the application to select from the
PC cursor to the end of the document. When a portion of text is selected, JAWS
automatically speaks the newly highlighted text if screen echo is set to
Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectToBottom

Script: SelectToBottom

Description

Sends a CTRL+SHIFT+END to the system.  The result is controlled by the
application.  In most edit controls, all text from the PC cursor to the bottom
of the document is selected. This keystroke can also used for selecting all
items from the currently selected item to the last item in most list boxes or
list views.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectToEndOfLine

Function: SelectToEndOfLine

Description

When the PC cursor is active, JAWS allows the application to select to the end
of the current line starting at the PC cursor. When a portion of text is
selected, JAWS automatically speaks the newly highlighted text if screen echo
is set to Highlighted or All.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectToEndOfLine

Script: SelectToEndOfLine

Description

Sends a SHIFT+END to the system.  The result is controlled by the application.
In most edit controls, all text from the PC cursor to the end of the line is
selected. This keystroke can be used in various list views and list boxes.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectToMark

Script: SelectToMark

Description

Select from cursor to mark or mark to cursor.  May not be available in every
application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
TextSelectedEvent

Function: TextSelectedEvent

Description

Returns

Type: Void

Parameters

Param 1:

Type: string
Description:
Include: Required

Param 2:

Type: int
Description:
Include: Required

Param 3:

Type: int
Description:
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UnselectAllButCurrent

Script: UnselectAllButCurrent

Description

Useful in multi-select controls such as a list box, list view, combo box, etc.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AdjustJAWSVerbosity

Script: AdjustJAWSVerbosity

Description

ANSI and graphics are some of the choices you can set verbosity levels for in
this list.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AnsiCharsDecrement

Script: AnsiCharsDecrement

Description

The settings for ANSI characters are all, most, more, some, and none. If the
current level is none, all is selected.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleCount

Function: BrailleCount

Description

Returns

Type: Int
Description: the number of Braille displays configured in JAWS

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleDisplayLoadErrors

Function: BrailleDisplayLoadErrors

Description

Returns

Type: Int
Description: TRUE if the error should be displayed, FALSE otherwise

Parameters

Param 1:

Type: int
Description: the index of the Braille display
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleDriver

Function: BrailleDriver

Description

Returns

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

Parameters

Param 1:

Type: int
Description: the index of the Braille display whose driver name is to be
retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleDriverInformation

Function: BrailleDriverInformation

Description

Returns

Type: String
Description: The driver information string of the requested Braille display,
or "" if there is not a Braille display at that index.

Parameters

Param 1:

Type: int
Description: the index of the Braille display whose driver information string
is to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleLongName

Function: BrailleLongName

Description

Returns

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

Parameters

Param 1:

Type: int
Description: the index of the Braille display whose name is to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleName

Function: BrailleName

Description

Returns

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

Parameters

Param 1:

Type: int
Description: the index of the Braille display whose name is to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BraillePort

Function: BraillePort

Description

Returns

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

Parameters

Param 1:

Type: int
Description: the index of the Braille display whose port name is to be
retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BraillePortString

Function: BraillePortString

Description

Returns

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

Parameters

Param 1:

Type: int
Description: the index of the Braille display whose port string is to be
retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
ConfigManager

Script: ConfigManager

Description

Used to set JAWS options like keyboard echo, speaking of graphic symbols, and
cursor blink rate.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
CreateDictionaryCommandLine

Function: CreateDictionaryCommandLine

Description

The Dictionary Manager can be started with the following parameters:
a[currently running application] -r[rule] -d. If -d is present, the Dictionary
Manager is started in Add Dialog mode. If bDoAddDialog is true, the -d
parameter is added.

Returns

Type: String
Description: the string found to be added as a dictionary rule.

Parameters

Param 1:

Type: Int
Description: Flag specifying whether the command line should include a switch
to open with the add dialog.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DictionaryManager

Script: DictionaryManager

Description

Used to add special string pronunciations to the JAWS dictionary.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: Command line for dictionary manager.  If blank, the script builds
one.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetActiveConfiguration

Function: GetActiveConfiguration

Description

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

Returns

Type: String
Description: The name of the active configuration set.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetDefaultJCFOption

Function: GetDefaultJCFOption

Description

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

Returns

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

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetJCFOption

Function: GetJCFOption

Description

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

Returns

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

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetSettingInformation

Function: GetSettingInformation

Description

Retrieves the setting for the given voice parameter and context name.  The
minimum and maximum settings for the range of the parameter are passed to the
min and max parameters by reference.

Returns

Type: Int
Description: The current setting for the given voice parameter and context

Parameters

Param 1:

Type: Int
Description: Enter the constant representing the voice parameter from which to
retrieve the settings.  These are found in HjConst.jsh.  Examples of such are
V_RATE and V_PITCH.
Include: Required

Param 2:

Type: String
Description: Enter a variable, string literal or constant representing the
voice context whose parameter is to be checked.
Include: Required

Param 3:

Type: Int
Description: Enter the int variable to receive the minimum for the range of
the parameter you wish to set.
Include: Required
* Returns data by reference

Param 4:

Type: Int
Description: Enter the int variable to receive the maximum for the range of
the parameter you wish to set.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVerbosity

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

Type: Int
Description: "BEGINNER" = 0, "INTERMEDIATE" = 1, "ADVANCED" = 2.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSVerbosityCore

Function: JAWSVerbosityCore

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.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Your specific list of items to go at the top of the
AdjustJAWSVerbosity list.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ProgressBarAnnouncementToggle

Function: ProgressBarAnnouncementToggle

Description

Used to toggle the announcement of the progress bar. The status will revert to
the default setting when JAWS is restarted.

Returns

Type: string
Description: the state of the progress bar announcement after the toggle.

Parameters

Param 1:

Type: int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
PunctuationToggle

Function: PunctuationToggle

Description

Changes the punctuation spoken by JFW such as:  All, Some, Most, and None.

Returns

Type: String
Description: description of value to be displayed as value of Punctuation
Level.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ReloadAllConfigs

Function: ReloadAllConfigs

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
RunJAWSManager

Script: RunJAWSManager

Description

Builds a list of the JAWS managers that can be quickly started from a list.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectALanguage

Script: SelectALanguage

Description

Select a language for JAWS to use when speaking.  By default, JAWS installs
all languages for Eloquence.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
SetAnsiCharsIncrement

Script: SetAnsiCharsIncrement

Description

The settings for ANSI characters are: all, most, more, some, and none. If the
current level is all, none is selected.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetDefaultJCFOption

Function: SetDefaultJCFOption

Description

Changes the default value for an option in the default JAWS configuration
file. Settings in DEFAULT.JCF are used until a JCF is loaded for an
application. When a JCF is not available for the application, then settings in
the default JCF continue to be used. The function SetJcfOption is used to set
a value in the JCF for an active application.

Returns

Type: Int
Description: "WAS_SUCCESSFUL" = 1 (the value was changed),
"WAS_NOT_SUCCESSFUL" = 0 (it was not changed).

Parameters

Param 1:

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

Param 2:

Type: Int
Description: Type the number to be used as the setting for the option.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetGraphicsVerbosity

Script: SetGraphicsVerbosity

Description

Cycles through the three graphics verbosity levels: none , labeled and all.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. Pac Mate 1.00 and later

----------
SetJAWSLanguage

Function: SetJAWSLanguage

Description

In the international versions of JFW, changes the JAWS operating environment
to the specified language.

Returns

Type: Int
Description: TRUE if change was successful, FALSE otherwise.

Parameters

Param 1:

Type: string
Description: A 3-character Windows language abbreviation (ENU for English, DEU
for German, and so on.)
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetJCFOption

Function: SetJCFOption

Description

Changes a value in the JAWS configuration file for the active application. A
new JCF file is loaded each time a different application is used. When a JCF
is not available for the application, then the settings in the DEFAULT.JCF are
used. The SetDefaultOption is used to change a default JCF option.

Returns

Type: Int
Description: "WAS_SUCCESSFUL" = 1 (the value was changed),
"WAS_NOT_SUCCESSFUL" = 0 (it was not changed).

Parameters

Param 1:

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

Param 2:

Type: Int
Description: Type the number to be used as the setting for the option.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetPunctuationLevel

Script: SetPunctuationLevel

Description

Switches between all, most, some or no punctuation.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SetVerbosityLevel

Script: SetVerbosityLevel

Description

Controls how much JFW will say when the focus changes or other events occur on
the screen or in response to key strokes.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShouldItemBraille

Function: ShouldItemBraille

Description

This function is used to determine whether or not the user has specified that
items spoken with a given Output Mode should also be Brailled in the current
Braille verbosity level.

Returns

Type: Int
Description: Returns 0 if the item should not be Brailled.  Returns a non 0
value if the item should be Brailled.

Parameters

Param 1:

Type: Int
Description: The Output Mode of the item you wish to determine if it should be
Brailled.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
ShouldItemSpeak

Function: ShouldItemSpeak

Description

This function is used to determine whether or not the user has specified that
items spoken with a given Output Mode should be spoken in the current
verbosity level.

Returns

Type: Int
Description: Returns 0 if the item should not be spoken.  Returns a non 0
value if the item should be spoken.

Parameters

Param 1:

Type: Int
Description: The Output Mode of the item you wish to determine if it should be
spoken.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SwitchLanguage

Script: SwitchLanguage

Description

This keystroke switches between primary and secondary languages on the Pac
Mate.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later

----------
SwitchToConfiguration

Function: SwitchToConfiguration

Description

When this function is called, the currently loaded set of configuration files
is unloaded from memory and the specified set of configuration files is loaded
in its place.

Returns

Type: Int
Description: TRUE if the argument passed in is a valid string (not "").  FALSE
if an invalid string is passed into the function.

Parameters

Param 1:

Type: String
Description: The base name of the set of Configuration files to load.  Calling
this function with "MyConfigurations" for example, would load the
Configuration, Keymap, Script, Dictionary, Graphics, Symbols, and Frame files
that have base name "MyConfiguration."
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SynthCount

Function: SynthCount

Description

Returns

Type: Int
Description: the number of synthesizers configured in JAWS

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SynthDisplayLoadErrors

Function: SynthDisplayLoadErrors

Description

Returns

Type: Int
Description: TRUE if the error should be displayed, FALSE otherwise

Parameters

Param 1:

Type: int
Description: the index of the synthesizer
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SynthDriver

Function: SynthDriver

Description

Returns

Type: String
Description: The driver name of the requested synthesier, or "" if there is
not a synthesizer at that index.

Parameters

Param 1:

Type: int
Description: the index of the synthesizer whose driver name is to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SynthDriverInformation

Function: SynthDriverInformation

Description

Returns

Type: String
Description: The driver information string of the requested synthesier, or ""
if there is not a synthesizer at that index.

Parameters

Param 1:

Type: int
Description: the index of the synthesizer whose driver information string is
to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SynthLongName

Function: SynthLongName

Description

Returns

Type: String
Description: The descriptive name of the requested synthesier, or "" if there
is not a synthesizer at that index.

Parameters

Param 1:

Type: int
Description: the index of the synthesizer whose name is to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SynthName

Function: SynthName

Description

Returns

Type: String
Description: The name of the requested synthesier, or "" if there is not a
synthesizer at that index.

Parameters

Param 1:

Type: int
Description: the index of the synthesizer whose name is to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SynthPort

Function: SynthPort

Description

Returns

Type: String
Description: The port name of the requested synthesier, or "" if there is not
a synthesizer at that index.

Parameters

Param 1:

Type: int
Description: the index of the synthesizer whose port name is to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
SynthPortString

Function: SynthPortString

Description

Returns

Type: String
Description: The port string of the requested synthesier, or "" if there is
not a synthesizer at that index.

Parameters

Param 1:

Type: int
Description: the index of the synthesizer whose port string is to be retrieved
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
ToggleLanguageDetection

Function: ToggleLanguageDetection

Description

Toggles whether JAWS recognizes language changes.

Returns

Type: String
Description: description of value to be displayed as value of Language
Detection.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ToggleMuteSynthesizer

Script: ToggleMuteSynthesizer

Description

Toggles the synthesizer on and off. Use this keystroke when you want to use
your Pac Mate with Braille only.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. Pac Mate 2.50 and later

----------
TogglePunctuation

Script: TogglePunctuation

Description

Punctuation can be set to all, most, some or none.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ToggleSALMode

Script: ToggleSALMode

Description

Toggles the Braille study mode on and off. To use this keystroke, you must be
editing or viewing a contracted Braile file in FS Edit.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. Pac Mate 2.50 and later

----------
VerbosityLevel

Function: VerbosityLevel

Description

Changes the verbosity setting. Settings include Beginner, Intermediate, and
Advanced. The verbosity setting determines how much descriptive information is
to be spoken as you use Windows.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
VerbosityLevelToggle

Function: VerbosityLevelToggle

Description

Controls how much JFW will say when the focus changes or other events occur on
the screen or in response to key strokes.

Returns

Type: String
Description: description of value to be displayed as value of Verbosity Level
setting.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Beep

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PlaySound

Function: PlaySound

Description

Plays a wave file through the computer sound system. Requires one parameter
that specifies the wave filename. If a complete path is not specified, JAWS
will search the path for the file.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: Includes the wave filename. If a complete path is not specified,
JAWS will search the path for the file. To get the \ into the path name, you
must actually use two \ characters. For example, write
C:\\WINNT\\Media\\chimes.wav.  This is very important. Failure to include two
\ characters will cause the compiler to fail and jscript.exe to perform an
illegal operation.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindString

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Param 2:

Type: String
Description: 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.
Include: Required

Param 3:

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

Param 4:

Type: Int
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FormatString

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

Type: String
Description: the contents of Message with all place holders replaced by their
associated parameters.

Parameters

Param 1:

Type: String
Description: string containing text intermingled with parameter place holders.
Include: Required

Param 2:

Type: String
Description: item to be substituted in place of %1 every time it appears in
Message.
Include: Optional

Param 3:

Type: String
Description: item to be substituted in place of %2 every time it appears in
Message.
Include: Optional

Param 4:

Type: String
Description: item to be substituted in place of %3 every time it appears in
Message.
Include: Optional

Param 5:

Type: String
Description: item to be substituted in place of %4 every time it appears in
Message.
Include: Optional

Param 6:

Type: String
Description: item to be substituted in place of %5 every time it appears in
Message.
Include: Optional

Param 7:

Type: String
Description: item to be substituted in place of %6 every time it appears in
Message.
Include: Optional

Param 8:

Type: String
Description: item to be substituted in place of %7 every time it appears in
Message.
Include: Optional

Param 9:

Type: String
Description: item to be substituted in place of %8 every time it appears in
Message.
Include: Optional

Param 10:

Type: String
Description: item to be substituted in place of %9 every time it appears in
Message.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FormatStringWithEmbeddedFunctions

Function: FormatStringWithEmbeddedFunctions

Description

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

Returns

Type: String
Description: The string with  occurances replaced by function result.

Parameters

Param 1:

Type: String
Description: string with embedded functions.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCharacterValue

Function: GetCharacterValue

Description

This function returns the numeric value of the character parameter.

Returns

Type: Int
Description: the value of the character.

Parameters

Param 1:

Type: string
Description: the character whose value is desired.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetCharacterValueString

Function: GetCharacterValueString

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

Type: string
Description: 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.

Parameters

Param 1:

Type: string
Description: if not supplied, the character at the active cursor is assumed.
Include: Optional

Param 2:

Type: int
Description: see HJConst.jsh for supported flags (see CVF constants.
Include: Optional

Param 3:

Type: int
Description: if not specified, the active code page is assumed.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.10 and later
	2. PAC Mate 4.0 and later

----------
GetSpellString

Function: GetSpellString

Description

Returns

Type: String

Parameters

Param 1:

Type: String
Description:
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IntToString

Function: IntToString

Description

Converts an integer value to a string and returns the string value.

Returns

Type: String
Description: The newly created string.

Parameters

Param 1:

Type: Int
Description: The number to be converted to a string.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsWordDelimiter

Function: IsWordDelimiter

Description

Looks to see if the given character is contained in STRWordDelmiters. If so,
then returns TRUE. STRWordDelimiters is defined in HJConst.jsh.

Returns

Type: Int
Description: true if is word delimiter, false otherwise

Parameters

Param 1:

Type: String
Description: Gets the current character.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LookupBXKeyNames

Function: LookupBXKeyNames

Description

Returns

Type: string
Description: If a match was found, returns the qwerty name; otherwise, returns
null

Parameters

Param 1:

Type: string
Description: The BX key name after being stripped of its prefix.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
MagSay

Function: MagSay

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.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: 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.
Include: Required

Param 2:

Type: Int
Description: 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 Configuration Manager, 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.
Include: Required

Param 3:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
Say

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."

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: 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.
Include: Required

Param 2:

Type: Int
Description: 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 Configuration Manager, 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.
Include: Required

Param 3:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFormattedMessage

Function: SayFormattedMessage

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."

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: String
Description: 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
Include: Required

Param 3:

Type: String
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFormattedMessageWithVoice

Function: SayFormattedMessageWithVoice

Description

Use this function to specify a voice to use when speaking a message based on
output type and the user's preference for message length.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The voice to use when speaking the message.
Include: Required

Param 2:

Type: int
Description: The output type of the message to be spoken.
Include: Required

Param 3:

Type: string
Description: The long message to be spoken.
Include: Required

Param 4:

Type: string
Description: the short message to be spoken.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00-5.20 and later

----------
SayInteger

Function: SayInteger

Description

This speaks a string of numeric data.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Type a variable name or choose a script function that will
provide numeric data.
Include: Required

Param 2:

Type: int
Description: Allows the number to be spoken in something other than base 10.
Acceptable values are 2 through 16.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayMessage

Function: SayMessage

Description

This function takes short and long messages and speaks the appropriate message
based on the given output type.  If using the output type of OT_USER_BUFFER,
which is designed to present text in the User buffer, do not use 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"

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: String
Description: 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
Include: Required

Param 3:

Type: String
Description: 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 cmsgSilent for this parameter.  For the user
buffer (OT_USER_BUFFER), enter nothing at all.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayString

Function: SayString

Description

The SayString makes the speech synthesizer speak a message. This function is
now obsolete since the implementation of the sayMessage function. This
function remains for the purpose of testing and debugging. If you are
developing new scripts, it is recommended that you do not use this function.
Instead, use the SayMessage function.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: This parameter must be either a text string enclosed in quotes, a
variable name that contains a string value, or a  function that returns a
string value.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SpellString

Function: SpellString

Description

Spells a string of text. This is similar to the SayString function. However,
it spells the string letter by letter instead of speaking words.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: Type the text that is to be spelled, 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
stringChopLeft

Function: stringChopLeft

Description

This function chops the first part of a string by the specified number of
characters and returns the remainder.

Returns

Type: String
Description: chopped by supplied number of characters.

Parameters

Param 1:

Type: String
Description: string to chop.
Include: Required

Param 2:

Type: Int
Description: by how many characters.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
stringChopRight

Function: stringChopRight

Description

This function chops the last part of a string by the specified number of
characters and returns the remainder, ie the first part.

Returns

Type: String
Description: chopped by supplied number of characters.

Parameters

Param 1:

Type: String
Description: string to chop.
Include: Required

Param 2:

Type: Int
Description: by how many characters.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringCompare

Function: StringCompare

Description

Returns

Type: int
Description: 0 if the two strings are equal, a negative number if the first
string is less than the second, or a number greater than 0 if the first string
is greater than the second.

Parameters

Param 1:

Type: string
Description: the first string in the comparison.
Include: Required

Param 2:

Type: string
Description: the second string in the comparison.
Include: Required

Param 3:

Type: int
Description: true if the compare is to be case sensitive, false otherwise.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
StringContains

Function: StringContains

Description

Determines whether a specified text string is contained within another text
string.

Returns

Type: Int
Description: An integer is returned to indicate the position in string 1,
where the two strings begin to match. If a value of 5 is returned, this means
that the string in parameter 2 is present in parameter 1 and the matching
characters begin at the fifth character in the string. If a value of 0 is
returned, this means that the string in parameter 2 is not contained within
the string in parameter 1.

Parameters

Param 1:

Type: string
Description: This parameter specifies the string that is to be searched. The
search starts at the beginning of this string. Type the text string, type a
variable name, or choose a script function. Text strings must be enclosed
within quotation marks.
Include: Required

Param 2:

Type: string
Description: This parameter contains the string you are trying to locate. Type
the text string, type a variable name, or choose a script function. Text
strings must be enclosed within quotation marks.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringContainsChars

Function: StringContainsChars

Description

this function returns TRUE if any of the characters in string 2 appear in
string 1.

Returns

Type: int
Description: True if string1 contains any of the characters in string2

Parameters

Param 1:

Type: string
Description: the string to search
Include: Required

Param 2:

Type: string
Description: the list of characters to look for in sStr
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
StringDiff

Function: StringDiff

Description

Returns

Type: String
Description: A concatenation of the parts of s1 which come before and after
the contents of s2.  If s2 is not contained within s1, then the empty string
is returned.

Parameters

Param 1:

Type: String
Description: The string to be searched.
Include: Required

Param 2:

Type: String
Description: The string to search for.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringIsBlank

Function: StringIsBlank

Description

This function returns true if the specified string only contains spaces, tabs
or newline characters. It returns false if the string contains any printable
character. This is useful for determining if strings returned from the object
model of an application are blank as far as JAWS speaking is concerned.

Returns

Type: Int
Description: true or false.

Parameters

Param 1:

Type: String
Description: the string to test.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringLeft

Function: StringLeft

Description

Extracts a specified number of leftmost characters from a string.

Returns

Type: String
Description: The string that is extracted from strString.

Parameters

Param 1:

Type: String
Description: The string from which the leftmost characters will be extracted.
Include: Required

Param 2:

Type: Int
Description: The number of leftmost characters that will be extracted.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringLength

Function: StringLength

Description

Used to find the length of a string.

Returns

Type: Int
Description: Returns an integer value specifying the length of the string.

Parameters

Param 1:

Type: String
Description: The string for which the length is requested.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringLower

Function: StringLower

Description

Converts a mixed case string to all lower case.

Returns

Type: String
Description: The converted string.

Parameters

Param 1:

Type: String
Description: The string to be converted.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringMixedCaseToMultiword

Function: StringMixedCaseToMultiword

Description

This function converts a mixed case string to multiple words. For example
ScreenSensitiveHelp is converted to Screen Sensitive Help.

Returns

Type: String
Description: the mixed case string with spaces inserted before each capital
letter.

Parameters

Param 1:

Type: String
Description: the string containing mixed case words.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringReplaceChars

Function: StringReplaceChars

Description

For example stringReplaceChars("hello", "lo","-") would result in he---

Returns

Type: string
Description: the resultant string

Parameters

Param 1:

Type: string
Description: the string to search
Include: Required

Param 2:

Type: string
Description: string of characters you want to replace occurrances of.
Include: Required

Param 3:

Type: string
Description: the char to replace each of the characters in sCharList if found.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
StringReplaceSubstrings

Function: StringReplaceSubstrings

Description

For example, StringReplaceSubstrings("hello there everyone", "there", "")
would result in hello everyone.

Returns

Type: string
Description: the resultant string

Parameters

Param 1:

Type: string
Description: source string
Include: Required

Param 2:

Type: string
Description: the substring in source to replace.
Include: Required

Param 3:

Type: string
Description: the string to replace any occurances of above string with (maybe
null to remove occurances).
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
StringReverse

Function: StringReverse

Description

This function reverses a string, useful when you need to look at the
differences between the ends of two strings.

Returns

Type: String
Description: the reversed string.

Parameters

Param 1:

Type: String
Description: string to reverse.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringRight

Function: StringRight

Description

Extracts a specified number of rightmost characters from a string.

Returns

Type: String
Description: The string that is extracted from strString..

Parameters

Param 1:

Type: String
Description: The string from which the rightmost characters will be extracted.
Include: Required

Param 2:

Type: Int
Description: The number of rightmost characters that will be extracted.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringSegment

Function: StringSegment

Description

When a string contains delimiters, StringSegment can be called to extract a
segment of the string. One is the index of the first string. As of JAWS 7.0,
negative numbers extract segments from the right end of the string.  So -1
will return the last segment, -2 the second to the last etc.

Returns

Type: String
Description: The string segment specified by nIndex.

Parameters

Param 1:

Type: String
Description: The string that is delimited by some character or characters.
Include: Required

Param 2:

Type: String
Description: The delimiter or set of delimiters. This string must be enclosed
in quotation marks.
Include: Required

Param 3:

Type: Int
Description: The index of the segment to be retrieved. One is the index of the
first segment. -1 is the index of the last segment
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringSegmentCount

Function: StringSegmentCount

Description

Retrieves a count of  segments in a string.

Returns

Type: Int
Description: The count of segments in the string

Parameters

Param 1:

Type: String
Description: The string that is delimited by some character or characters.
Include: Required

Param 2:

Type: String
Description: The delimiter or set of delimiters. This string must be enclosed
in quotation marks.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
StringSegmentIndex

Function: StringSegmentIndex

Description

When a string contains delimiters, StringSegmentIndex can be called to
determine the index of a particular segment.

Returns

Type: Int
Description: the 1-based index of the specified segment (0 if the segment
wasn't found).

Parameters

Param 1:

Type: String
Description: The string that is delimited by some character or characters.
Include: Required

Param 2:

Type: String
Description: The delimiter or set of delimiters. This string must be enclosed
in quotation marks.
Include: Required

Param 3:

Type: String
Description: the segment whose index you want.
Include: Required

Param 4:

Type: Int
Description: true if the segment should match exactly, false to just check
that the segment contains the specified string.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
StringStrip

Function: StringStrip

Description

Returns

Type: String
Description: If successful, returns a string containing the text from the
beginning of string 1 to where the match occured. Otherwise, returns and null.

Parameters

Param 1:

Type: String
Description: The string to be searched.
Include: Required

Param 2:

Type: String
Description: The string to search for.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
stringStripAllBlanks

Function: stringStripAllBlanks

Description

this function strips leading, embedded and trailing blanks from a string.

Returns

Type: String
Description: The string without blanks.

Parameters

Param 1:

Type: String
Description: string containing blanks to strip.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringToHandle

Function: StringToHandle

Description

Converts a string value to a handle.  It is assumed that the string contains
atextual representation of an actual handle value.

Returns

Type: Handle
Description: The converted string.

Parameters

Param 1:

Type: string
Description: The string to be converted to a handle.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringToInt

Function: StringToInt

Description

Converts a string value to an integer and returns the integer value.

Returns

Type: Int
Description: The newly created integer.

Parameters

Param 1:

Type: string
Description: The string to be converted to an integer.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringTrimCommon

Function: StringTrimCommon

Description

This function compares two strings and trims the common characters from either
the start, the end or both the start and end. The user specifies which end to
trim by setting the third parameter to 0 for both ends, 1 for the start or 2
for the end. For example, if string 1 is "hello world" and string 2 is "hello
fred", StringTrimCommon(s1, s2, 1) would return world in s1 and fred in s2 and
the return value would be 1. If the strings are identical then the function
returns FALSE since there is nothing left after trimming common characters.

Returns

Type: int
Description: TRUE if the function trimmed common characters and either s1 or
s2 contain something after the comparison, FALSE if s1 and s2 are identical.

Parameters

Param 1:

Type: string
Description: the first string to compare. Note after calling this function
this parameter is replaced by the piece of s1 which is not contained in s2.
Include: Required
* Returns data by reference

Param 2:

Type: string
Description: the second string to compare. Note after calling this function,
s2 is replaced by the piece of s2 which is not contained in s1.
Include: Required
* Returns data by reference

Param 3:

Type: int
Description: 0 both start and end, (default), 1 trim start, 2 trim end.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
StringTrimLeadingBlanks

Function: StringTrimLeadingBlanks

Description

strips leading blanks from a string.

Returns

Type: String
Description: the string with leading blanks trimmed.

Parameters

Param 1:

Type: String
Description: string to trim.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringTrimTrailingBlanks

Function: StringTrimTrailingBlanks

Description

strips trailing blanks from a string.

Returns

Type: String
Description: the string with trailing blanks trimmed.

Parameters

Param 1:

Type: String
Description: string to trim.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StringUpper

Function: StringUpper

Description

Converts a mixed case string to all upper case.

Returns

Type: String
Description: The converted string.

Parameters

Param 1:

Type: String
Description: the string to be converted.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StripBXKeyNamePrefix

Function: StripBXKeyNamePrefix

Description

Returns

Type: String
Description: the stripped BX key name

Parameters

Param 1:

Type: string
Description: the BX key name
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
SubString

Function: SubString

Description

Extracts part of a string from another string. It could be used to read a
portion of the information that appears on a status line.

Returns

Type: String
Description: Provides a substring of text for use by other functions.

Parameters

Param 1:

Type: string
Description: Type a string to be processed, or specify a variable name or
script function that can provide the text string. Text strings must be
enclosed within quotation marks.
Include: Required

Param 2:

Type: Int
Description: Type a number to indicate the position of the first character in
the substring which is to be extracted. The index number of the first
character in the string is 1.
Include: Required

Param 3:

Type: Int
Description: Type an integer to indicate the number of characters that are to
be extracted from the string. If the int is greater than the number of
characters remaining in the string, then the number is silently rounded down.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TypeFormattedString

Function: TypeFormattedString

Description

Types a Formatted 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

Type: Int
Description: The number of keystrokes simulated.

Parameters

Param 1:

Type: String
Description: string containing text intermingled with parameter place holders.
Include: Required

Param 2:

Type: String
Description: item to be substituted in place of %1 every time it appears in
Message.
Include: Optional

Param 3:

Type: String
Description: item to be substituted in place of %2 every time it appears in
Message.
Include: Optional

Param 4:

Type: String
Description: item to be substituted in place of %3 every time it appears in
Message.
Include: Optional

Param 5:

Type: String
Description: item to be substituted in place of %4 every time it appears in
Message.
Include: Optional

Param 6:

Type: String
Description: item to be substituted in place of %5 every time it appears in
Message.
Include: Optional

Param 7:

Type: String
Description: item to be substituted in place of %6 every time it appears in
Message.
Include: Optional

Param 8:

Type: String
Description: item to be substituted in place of %7 every time it appears in
Message.
Include: Optional

Param 9:

Type: String
Description: item to be substituted in place of %8 every time it appears in
Message.
Include: Optional

Param 10:

Type: String
Description: item to be substituted in place of %9 every time it appears in
Message.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later
	2. JAWS 7.10 and later

----------
TypeString

Function: TypeString

Description

Used to simulate a string of keystrokes. For example: to send a group of
keystrokes through to the application simulating the string "test," you could
either enter the line {t}{e}{s}{t}, or you could use TypeString ("test").

Returns

Type: Int
Description: The number of keystrokes simulated.

Parameters

Param 1:

Type: string
Description: The string of characters that will be sent to the underlying
application. This parameter must be enclosed in quotation marks.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetInputLanguage

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

Type: String
Description: The name of the active input language.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetRegistryEntryDWORD

Function: GetRegistryEntryDWORD

Description

Use to get DWORD entries in registry.

Returns

Type: int
Description: registry entry, no error checking.

Parameters

Param 1:

Type: int
Description: 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE,
3=HKEY_USERS.
Include: Required

Param 2:

Type: String
Description: of SubKey
Include: Required
* Returns data by reference

Param 3:

Type: String
Description: of Variable
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later
	2. JAWS 5.10 and later

----------
GetRegistryEntryString

Function: GetRegistryEntryString

Description

Use to get string entries in registry.

Returns

Type: string
Description: The string of entry, otherwise an empty string.

Parameters

Param 1:

Type: int
Description: 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE,
3=HKEY_USERS.
Include: Required

Param 2:

Type: String
Description: of SubKey
Include: Required
* Returns data by reference

Param 3:

Type: String
Description: of Variable.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later
	2. JAWS 5.10 and later

----------
GetSystemDefaultLang

Function: GetSystemDefaultLang

Description

Gets the three letter abbreviation of the System Default language of the
Windows User Interface.

Returns

Type: String
Description: Returns a string containing the three letter abbreviation of the
System Default language of the Windows User Interface.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetSystemLocaleInfo

Function: GetSystemLocaleInfo

Description

this function returns Default System specific Locale information. You
determine what information to return by providing an identifier defined in
locale.jsh as a parameter to this function.

Returns

Type: String
Description: the Locale specific information

Parameters

Param 1:

Type: Int
Description: see constants defined in locale.jsh.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetSystemVolume

Function: GetSystemVolume

Description

Returns

Type: Int
Description: The current system volume setting.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
GetSystemVolumeRange

Function: GetSystemVolumeRange

Description

Assigns the minimum and maximum possible volume settings to the parameters
taken by reference.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Type the variable to receive the minimum system volume.
Include: Required
* Returns data by reference

Param 2:

Type: Int
Description: Type the variable to receive the maximum system volume.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
GetTickCount

Function: GetTickCount

Description

Retrieves the amount of time that has passed since Windows was started.

Returns

Type: Int
Description: Number of milliseconds that have passed since Windows was
started.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.00 and later

----------
GetUserDefaultLang

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

Type: String
Description: 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.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetUserLocaleInfo

Function: GetUserLocaleInfo

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

Type: String
Description: the Locale specific information..

Parameters

Param 1:

Type: Int
Description: see constants defined in locale.jsh.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowsOS

Function: GetWindowsOS

Description

Provides information about which operating system is being used.

Returns

Type: Int
Description: One of the constants OS_WIN95 or OS_WIN_NT. These constants are
defined in HJCONST.jsh.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowsSystemDirectory

Function: GetWindowsSystemDirectory

Description

Returns the path to the Windows System directory as a string.

Returns

Type: String
Description: the path to the current Windows System Directory.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IsWinNtOr95

Function: IsWinNtOr95

Description

This function returns true if the OS in use is either Windows 95 or Windows NT
4.0.

Returns

Type: Int
Description: true or false.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LastBootType

Function: LastBootType

Description

Determines if a cold or warm boot has just been performed.

Returns

Type: Int
Description: TRUE for a Warm boot and a FALSE for a cold boot.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ListTaskTrayIcons

Script: ListTaskTrayIcons

Description

The user can then select the icon from the list box and JFW will simulate
either a left mouse button click, a right mouse button click, or a double left
mouse button click on the icon, depending on which is appropriate for that
icon.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
Run

Function: Run

Description

The Run function is used as if you had entered its name and parameters in the
Windows Run dialog. If the file name passed as an argument is the name of a
program, then that program is run. If it is the name of a directory, then
Windows Explorer is run to explore that directory. If the file is not a
program but has an extension associated with a particular application, then
that application is run to display the file. For example, passing changes.txt
as the parameter to the Run function will open Notepad to edit the file
changes.txt.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: 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. In any case, the string needs to be the name of the program
you wish to run. It may be necessary to include a path and filename extension.
To get the \ into the path name, you must actually use two \ characters. For
example, write c:\\jfw32\\jframe.exe. This is very important. Failure to
include two \ characters will cause the compiler to fail and jscript.exe to
perform an illegal operation.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayBatteryLevel

Script: SayBatteryLevel

Description

On laptops, when the battery is being used, its status is generally available
on the screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayDriveLetter

Script: SayDriveLetter

Description

Says the name of the disk drive or network drive that has the focus in Windows
Explorer in order to provide the correct drive letter.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SaySystemTime

Script: SaySystemTime

Description

If pressed twice quickly, This keystroke will say the date.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SaySystemTray

Script: SaySystemTray

Description

Helpful for closing applications on the System tray.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayTaskBar

Script: SayTaskBar

Description

Uses FindTopLevelWindow to find the Grand Parent of the TaskBar.  While
statements are then used to find the parent and eventually the TaskBar itself.
Once found, the TaskBar is spoken. It is not spoken if it cannot be found or
if it is obscured by another window or if it is hidden.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenGetHeight

Function: ScreenGetHeight

Description

Gets the height of the screen in pixels.

Returns

Type: Int
Description: The height of the screen in pixels.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenGetWidth

Function: ScreenGetWidth

Description

Gets the width of the screen in pixels.

Returns

Type: Int
Description: The width of the screen in pixels.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetRegistryEntryDWORD

Function: SetRegistryEntryDWORD

Description

Use to set DWORD entries in registry.

Returns

Type: int
Description: 1 if successful, otherwise 0.

Parameters

Param 1:

Type: int
Description: 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE,
3=HKEY_USERS.
Include: Required

Param 2:

Type: String
Description: of SubKey.
Include: Required
* Returns data by reference

Param 3:

Type: String
Description: of Variable
Include: Required
* Returns data by reference

Param 4:

Type: int
Description: to be Assigned variable.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later
	2. JAWS 5.10 and later

----------
SetRegistryEntryString

Function: SetRegistryEntryString

Description

Use to set string entries in registry.

Returns

Type: int
Description: 1 if successful, otherwise 0.

Parameters

Param 1:

Type: int
Description: 0=HKEY_CLASSES_ROOT, 1=HKEY_CURRENT_USER, 2=HKEY_LOCAL_MACHINE,
3=HKEY_USERS.
Include: Required

Param 2:

Type: String
Description: of SubKey.
Include: Required
* Returns data by reference

Param 3:

Type: String
Description: of Variable.
Include: Required
* Returns data by reference

Param 4:

Type: String
Description: to be Assigned variable.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later
	2. JAWS 5.10 and later

----------
SetSystemVolume

Function: SetSystemVolume

Description

Sets the system volume.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The new value to which you wish to set the volume.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
StartJAWSTaskList

Script: StartJAWSTaskList

Description

The JAWS Task List allows the user to minimize, maximize, close, start, and
switch to applications.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SwitchToPreviousApp

Function: SwitchToPreviousApp

Description

This simulates holding down the ALT key and pressing TAB a specified number of
times.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: The number of times the Tab key should be simulated.  This
defaults to 1, which which is the equivalent of pressing ALT+TAB.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SysGetDate

Function: SysGetDate

Description

Obtains a string representing the given date in the specified format.

Returns

Type: String
Description: A string representing the given date, or the current system date
if no month, day and year are provided.

Parameters

Param 1:

Type: String
Description: The desired date format. For example "dd/MM/yyyy."
Include: Optional

Param 2:

Type: Int
Description: A value between 1 and 12.
Include: Optional

Param 3:

Type: Int
Description: A value between 1 and the number of days in the month of
interest.
Include: Optional

Param 4:

Type: Int
Description: Four digits year number.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SysGetTime

Function: SysGetTime

Description

Obtains a string representing the given time in the specified format.

Returns

Type: String
Description: A string representing the given time, or the current system time
if no hour, minute and second are provided.

Parameters

Param 1:

Type: String
Description: The desired time format. For example "hh:mm tt."
Include: Optional

Param 2:

Type: Int
Description: A value between 0 and 23.
Include: Optional

Param 3:

Type: Int
Description: A value between 0 and 59.
Include: Optional

Param 4:

Type: Int
Description: A value between 0 and 59.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SysTrayGetItemCount

Function: SysTrayGetItemCount

Description

Obtains the number of items in the System Tray.

Returns

Type: Int
Description: iIem count.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SysTrayGetItemToolTip

Function: SysTrayGetItemToolTip

Description

This function is used in ListTaskTrayIcons to obtain the ToolTip that
corresponds to a specific Task tray icon. This function takes a single
parameter, the index of the Task tray icon for which the ToolTip is desired.
It returns a string value that is the text of the ToolTip in question.

Returns

Type: String
Description: The text of the tool tip of the specified Task tray icon.

Parameters

Param 1:

Type: Int
Description: The index of the Task tray icon in question.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SysTrayMoveToItem

Function: SysTrayMoveToItem

Description

Moves the JAWS cursor to the location of an item in the System Tray.

Returns

Type: Int
Description: TRUE if Successful.

Parameters

Param 1:

Type: Int
Description: the index number of the item.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
UseAlternateLanguage

Function: UseAlternateLanguage

Description

Switches JAWS between using its primary and alternate synthesizer language.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Non-zero to use alternate, zero to use primary.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
ViewSysTrayItems

Script: ViewSysTrayItems

Description

You may be asked to press this keystroke when on the phone with Technical
Support or with a technician in the Software Test department.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BottomOfColumn

Function: BottomOfColumn

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
DownCell

Function: DownCell

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DownCell

Script: DownCell

Description

When inside a table or spreadsheet, moves the active cursor to the same cell
in the next row.  JAWS will speak the row header followed by the content of
the current cell.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
EndOfRow

Function: EndOfRow

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
FirstCell

Function: FirstCell

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FirstCellInTable

Script: FirstCellInTable

Description

Moves to the first cell in a table and reads all relevant row and column
information.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCell

Function: GetCell

Description

When in a table or spreadsheet, gets the contents of the current cell.

Returns

Type: String
Description: Provides the Cell of information.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCellCoordinates

Function: GetCellCoordinates

Description

Gets the coordinates of the current cell in a table and passes them by
reference to the variables specified in the parameter list.

Returns

Type: Int
Description: TRUE if the current cursor is positioned inside of a table.  In
this case, the Row and Column  parameters will have meaningful information
placed in them.

Parameters

Param 1:

Type: Int
Description: References the  current cell column on return.
Include: Required
* Returns data by reference

Param 2:

Type: Int
Description: References the  current cell row on return.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetColumnHeader

Function: GetColumnHeader

Description

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

Returns

Type: String
Description: Provides the header of information.

Parameters

Param 1:

Type: Int
Description: Include only headers that are marked in the table
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetColumnText

Function: GetColumnText

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

Type: String
Description: The text of the included cells.

Parameters

Param 1:

Type: String
Description: string to insert between cell data, defaults to a single space.
Include: Optional

Param 2:

Type: String
Description: 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.
Include: Optional

Param 3:

Type: String
Description: the text to be displayed if the cell is blank.
Include: Optional

Param 4:

Type: Int
Description: the starting row, defaults to the first row (1) of the table.
Include: Optional

Param 5:

Type: Int
Description: the ending row, defaults to the last row of the table.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCurrentRowColumnCount

Function: GetCurrentRowColumnCount

Description

Returns

Type: Int
Description: 0 if not in a table row or the number of columns in the current
row.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetRowHeader

Function: GetRowHeader

Description

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

Returns

Type: String
Description: Provides the header of information.

Parameters

Param 1:

Type: Int
Description: Include only headers that are marked in the table
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetRowText

Function: GetRowText

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

Type: String
Description: The text of the included cells.

Parameters

Param 1:

Type: String
Description: string to insert between cell data, defaults to a single space.
Include: Optional

Param 2:

Type: String
Description: 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.
Include: Optional

Param 3:

Type: String
Description: the text to be displayed if the cell is blank.
Include: Optional

Param 4:

Type: Int
Description: the starting column, defaults to the first column (1) of the row.
Include: Optional

Param 5:

Type: Int
Description: the ending column, defaults to the last column of the row.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetTableCaption

Function: GetTableCaption

Description

Returns

Type: String
Description: The Table Caption

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetTableNestingLevel

Function: GetTableNestingLevel

Description

This function returns the nesting level of the current table. If the table is
not nested then the value will be 0.

Returns

Type: Int
Description: The nesting level (top level table has nesting level 0).

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetTableSummary

Function: GetTableSummary

Description

Returns

Type: String
Description: The Table Summary.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
InTable

Function: InTable

Description

Determines whether or not the active cursor is inside of a table.

Returns

Type: Int
Description: TRUE if in a table, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JumpReturnFromTableCell

Script: JumpReturnFromTableCell

Description

This keystroke returns the cursor to the prior table cell.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
JumpToTableCell

Script: JumpToTableCell

Description

This keystroke moves the cursor to the specified table cell.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
LasstCell

Function: LasstCell

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LastCellInTable

Script: LastCellInTable

Description

Moves to the last cell in a table and reads all relevant row and column
information.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToBottomOfColumn

Script: MoveToBottomOfColumn

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToEndOfRow

Script: MoveToEndOfRow

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToStartOfRow

Script: MoveToStartOfRow

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MoveToTableCell

Function: MoveToTableCell

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

Type: Int
Description: true if successful, false otherwise.

Parameters

Param 1:

Type: Int
Description: the column number
Include: Required

Param 2:

Type: Int
Description: the row number
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
MoveToTopOfColumn

Script: MoveToTopOfColumn

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
NextCell

Function: NextCell

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NextCell

Script: NextCell

Description

When inside a table or spreadsheet, moves the active cursor to the same cell
in the next column.  JAWS will speak the column header, followed by the
current cell

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PriorCell

Function: PriorCell

Description

When inside a table or spreadsheet, moves the active cursor to the same cell
in the prior column.

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PriorCell

Script: PriorCell

Description

When inside a table or spreadsheet, moves the active cursor to the same cell
in the prior column.  JAWS will speak the column header, followed by the
contents of the current cell

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ReadCurrentColumn

Script: ReadCurrentColumn

Description

This keystroke reads the current table column.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ReadCurrentRow

Script: ReadCurrentRow

Description

This keystroke reads the current table row.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ReadFromCurrentCell

Script: ReadFromCurrentCell

Description

This keystroke reads from the current cell to the end of the table row.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ReadFromTopOfColumn

Script: ReadFromTopOfColumn

Description

This keystroke reads from the top of the current table column to the current
cell.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ReadToBottomOfColumn

Script: ReadToBottomOfColumn

Description

This keystroke reads from the current cell to the bottom of the current table
column.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ReadToCurrentCell

Script: ReadToCurrentCell

Description

This keystroke reads from the start of the current table row to the current
cell.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SayCell

Function: SayCell

Description

When in a table or spreadsheet, speaks the contents of the current cell.

Returns

Type: Int
Description: TRUE if in a table, FALSE otherwise

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCell

Script: SayCell

Description

When the cursor is in a table or spreadsheet, JAWS speaks the row and column
headers followed by the contents of the current cell

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayColumnHeader

Function: SayColumnHeader

Description

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

Returns

Type: Int
Description: TRUE if in a table, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayRowHeader

Function: SayRowHeader

Description

When in a table or spreadsheet, speaks the contents of the row header.

Returns

Type: Int
Description: TRUE if in a table, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayTableCellCoordinates

Function: SayTableCellCoordinates

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SetTableTitleReading

Function: SetTableTitleReading

Description

The Table Title Reading option allows either column titles, row titles, both
or none to be spoken.

Returns

Type: String
Description: the new value for the element in the list.

Parameters

Param 1:

Type: Int
Description: Passed by JAWS to instruct the function whether or not to update.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SpeakTableCells

Function: SpeakTableCells

Description

Honors the verbosity settings used in INSERT+V to support table speaking.
Make sure to enter the correct value for the first parameter to support the
correct reading method for the direction you are moving.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the direction you are moving.  Use TABLE_NAV_NONE to speak
the current cell, TABLE_NAV_VERTICAL when moving by row and
TABLE_NAV_HORIZONTAL when moving by column.
Include: Required

Param 2:

Type: Int
Description: Enter the previous number of columns in the table row.  This is
used when navigating by row, but always enter it to update.  This way, on
tables on the internet, you will hear column changes take effect when a table
has a variable number of columns.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
StartOfRow

Function: StartOfRow

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
TopOfColumn

Function: TopOfColumn

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
UpCell

Function: UpCell

Description

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

Returns

Type: Int
Description: TRUE if the cursor moved, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UpCell

Script: UpCell

Description

When inside a table or spreadsheet, moves the active cursor to the same cell
in the prior row.  JAWS will speak the row header followed by the content of
the current cell

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCellSpan

Function: GetCellSpan

Description

When in a table or spreadsheet, gets the number of rows and columns spanned by
the current cell.

Returns

Type: int
Description: True if the function succeeded, false otherwise.

Parameters

Param 1:

Type: int
Description: When the function returns, contains the number of rows spanned by
the current table cell.
Include: Required
* Returns data by reference

Param 2:

Type: int
Description: When the function returns, contains the number of columns spanned
by the current table cell.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 8.0 and later

----------
GetTableName

Function: GetTableName

Description

Returns

Type: String
Description: The Table name

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.0 and later

----------
GetTableSelectionRange

Function: GetTableSelectionRange

Description

Returns

Type: Void

Parameters

Param 1:

Type: int
Description:
Include: Required
* Returns data by reference

Param 2:

Type: int
Description:
Include: Required
* Returns data by reference

Param 3:

Type: string
Description:
Include: Required
* Returns data by reference

Param 4:

Type: int
Description:
Include: Required
* Returns data by reference

Param 5:

Type: int
Description:
Include: Required
* Returns data by reference

Param 6:

Type: string
Description:
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 8.0 and later

----------
SetColumnHeader

Function: SetColumnHeader

Description

Sets the row to be used when announcing column headers.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: Specifies the row containing column headers.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 8.0 and later

----------
SetRowHeader

Function: SetRowHeader

Description

Sets the column to be used when announcing row headers.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: Specifies the column containing row headers.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 8.0 and later

----------
CollectWindowInfo

Function: CollectWindowInfo

Description

collects the technical information about a window.

Returns

Type: string
Description: The information retrieved for the window.

Parameters

Param 1:

Type: handle
Description: The window for which the information will be collected.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later
	2. JAWS 8.00 and later

----------
GetRightLeaf

Function: GetRightLeaf

Description

Traverses the window tree to find the right-most leaf window, starting from
the specified root window.

Returns

Type: handle
Description: The right-most leaf window handle.

Parameters

Param 1:

Type: handle
Description: The starting window handle, the root position.
Include: Required

Param 2:

Type: string
Description: ByRef The string describing the path from the root to the leaf.
Include: Required

Param 3:

Type: int
Description: ByRef The hierarchical x position of the leaf window.
Include: Required

Param 4:

Type: int
Description: ByRef The hierarchical y position of the leaf window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later
	2. JAWS 8.00 and later

----------
GetTreeInfo

Function: GetTreeInfo

Description

Used by TreeCapture script to traverse the window tree and retrieve informatin
about each window in the tree.

Returns

Type: string
Description: The collected technical information about all windows in the
tree.

Parameters

Param 1:

Type: handle
Description: The starting window, the root of the window tree to be traversed.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later
	2. JAWS 8.00 and later

----------
GoToBatteryLevel

Script: GoToBatteryLevel

Description

Displays the current battery level.  The battery level is indicated by the
percentage remaining.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later

----------
GoToRunningProgramsInMemory

Script: GoToRunningProgramsInMemory

Description

Brings up the currently running programs list. Currently running programs may
be activated or stopped. Stopping a program quits the program and removes it
from memory.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
HomeRowToggle

Script: HomeRowToggle

Description

When home row mode is on, all keys can have different functions, it is another
level or group in the Keyboard Manager.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NetworkAdaptersIPAddressInfo

Script: NetworkAdaptersIPAddressInfo

Description

Brings up the dialog displaying the IP address of the installed network
addapter.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 3.00 and later

----------
OpenControlPanelApplet

Function: OpenControlPanelApplet

Description

Opens a control panel applet and positions to a specific tab

Returns

Type: int
Description: Non-zero if function succeeds, else zero

Parameters

Param 1:

Type: Int
Description: Number of applet to start (zero based)
Include: Required

Param 2:

Type: Int
Description: Number of tab to position to (zero based)
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
OutputDebugString

Function: OutputDebugString

Description

Sends a string to the debugger for display. The debugger may be a utility
program such as DBGVIEW.EXE.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: String to be displayed.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
RunCalendar

Script: RunCalendar

Description

This keystroke runs Calendar from the currently running application or from
the Today screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
RunContacts

Script: RunContacts

Description

This keystroke runs Contacts from the currently running application or from
the Today screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
RunFExplore

Script: RunFExplore

Description

This keystroke runs File Explorer from the currently running application or
from the Today screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
RunFSCalc

Script: RunFSCalc

Description

This keystroke runs FS calculator from the currently running application or
from the Today screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
RunFSEdit

Script: RunFSEdit

Description

This keystroke runs FSEdit from the currently running application or from the
Today screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
RunStopwatch

Script: RunStopwatch

Description

This keystroke runs stopwatch from the currently running application or from
the Today screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
RunTasks

Script: RunTasks

Description

Press this key to run Tasks from the currently running application or from the
Today screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
RunTMail

Script: RunTMail

Description

This keystroke runs Inbox from the currently running application or from the
Today screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
ScreenSensitiveHelpTechnical

Script: ScreenSensitiveHelpTechnical

Description

This keystroke provides useful information when writing scripts.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ToggleHomeRow

Function: ToggleHomeRow

Description

Toggles Home Row mode ON/OFF. Home Row mode is a shifted state for the
keyboard. It is analogous to the NUM LOCK on the numeric keypad. When it is
on, the alphabet keys and number keys can be used to perform script functions.
When Home Row mode is turned OFF, the keys perform their standard functions.

Returns

Type: Int
Description: "ON" = 1, "OFF" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
TreeCapture

Script: TreeCapture

Description

Captures window information for the window tree, starting at the current
homerow position, and displays the results in the user buffer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
UtilityCopyInfo

Script: UtilityCopyInfo

Description

This command copies the information spoken by the F1 key to the clipboard.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityCopyMSAAObjectInfo

Script: UtilityCopyMSAAObjectInfo

Description

This command will copy to the clipboard the information currently returned by
the keystroke F9.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityFindFirstAttribute

Script: UtilityFindFirstAttribute

Description

Attributes are defined using the UtilitySetFontMode Script.  The attributes
are cycled in the following order: bold, italic, underline, strikeout, and
highlight.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityFindLastAttribute

Script: UtilityFindLastAttribute

Description

Attributes are defined using the UtilitySetFontMode Script.  The attributes
are cycled in the following order: bold, italic, underline, strikeout, and
highlight.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityHelp

Script: UtilityHelp

Description

These functions are designed to aid in writing scripts and functions.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityInitializeHomeRowPosition

Script: UtilityInitializeHomeRowPosition

Description

This command allows you to set the current position in the window hierarchy
referenced by the HomeRow utilities to the window containing the active cursor

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityJumpToOutputMode

Script: UtilityJumpToOutputMode

Description

When repeatedly selected, jumps to the first item of each group in the utility
output modes. The modes jumped to are: Window handle, window type and real
window name.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
UtilityJumpToOutputModeReverseOrder

Script: UtilityJumpToOutputModeReverseOrder

Description

When repeatedly selected, jumps to the first item of each group in the utility
output modes. The modes jumped to are: Window handle, window type and real
window name.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
UtilityMoveToChild

Script: UtilityMoveToChild

Description

The first child window is usually the first control in the tab order for the
dialog.  JAWS speaks the required information according to the Output Mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityMoveToNextWindow

Script: UtilityMoveToNextWindow

Description

Useful for moving through the items at a given level, following the tab order.
Speaks information according to the output mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityMoveToParent

Script: UtilityMoveToParent

Description

Information about the parent window is spoken according to the Output Mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityMoveToPriorWindow

Script: UtilityMoveToPriorWindow

Description

Useful for moving through the items at a given level, following the tab order.
Speaks information according to the output mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityNextAttribute

Script: UtilityNextAttribute

Description

Attributes are defined using the UtilitySetFontMode Script. The attributes are
cycled in the following order: bold, italic, underline, strikeout, and
highlight.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityPriorAttribute

Script: UtilityPriorAttribute

Description

Attributes are defined using the UtilitySetFontMode Script.  The attributes
are cycled in the following order: bold, italic, underline, strikeout, and
highlight.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityPutInfoInBox

Script: UtilityPutInfoInBox

Description

This does not apply to integers.  If the requested information returns an
integer, a call to This keystroke will be ignored.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityPutMSAAObjectInfoInBox

Script: UtilityPutMSAAObjectInfoInBox

Description

This command is similar to the INSERT+F1 keystroke. It will put the
information indicated by the F10 keystroke into a message box

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityResetOutputMode

Script: UtilityResetOutputMode

Description

The utility output modes are SayTypeAndText, focus window handle, control ID,
window class, window type, Sub Type, and first real window name.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityRouteJAWSCursorToPc

Script: UtilityRouteJAWSCursorToPc

Description

When the window currently referenced by the HomeRow utilities is visible, this
command will route the JAWS or Invisible cursor to that window

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySayInfo

Function: UtilitySayInfo

Description

The information spoken is useful for writing scripts and functions in
customizing an application.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Indicates whether spell mode is on or off.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.00-4.51 and later

----------
UtilitySayInfoAccess

Script: UtilitySayInfoAccess

Description

The Output Mode is defined by using the UtilitySetOutputMode.  The Output Mode
is cycled in the following order: window handle, control ID, window class,
window type, and first real window name.  When UtilitySayInfoAccess is
selected twice in quick succession, the requested information is spelled.
Spell Mode does not apply to integers.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySayMSAAObjectInfo

Function: UtilitySayMSAAObjectInfo

Description

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: No Description
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.00-4.51 and later

----------
UtilitySayMSAAObjectInfoAccess

Script: UtilitySayMSAAObjectInfoAccess

Description

This command is similar to the F1 HomeRow command, except the information
returned refers to the object which currently has the focus of the PC or JAWS
Cursor. You cannot move between objects using the HomeRow

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySayMSAAObjectOutputMode

Script: UtilitySayMSAAObjectOutputMode

Description

You can set the output mode for MSAA objects by pressing Home-Row+F10.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySayOutputMode

Script: UtilitySayOutputMode

Description

Says the current setting for the output mode such as: real window name, window
subtype code, Window type, window class, control ID, window handle, and
SayTypeAndText.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySayWindow

Script: UtilitySayWindow

Description

This command will read all the text contained within the window currently
referenced by the HomeRow.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySayWindowPromptAndText

Script: UtilitySayWindowPromptAndText

Description

This command is similar to the regular INSERT+Tab key command, except it
returns information for the window currently referenced by the home row.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySetFocusToHomeRowPosition

Script: UtilitySetFocusToHomeRowPosition

Description

Attempts to set focus to the current homerow position.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
UtilitySetFontMode

Script: UtilitySetFontMode

Description

When selected repeatedly, the attributes are cycled in the following order:
bold, italic, underline, strikeout, and highlight.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySetMSAAObjectOutputMode

Script: UtilitySetMSAAObjectOutputMode

Description

Use the F9 keystroke to hear the information indicated by the output mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySetMSAAObjectOutputModeReverseOrder

Script: UtilitySetMSAAObjectOutputModeReverseOrder

Description

Use the F9 keystroke to hear the information indicated by the output mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySetOutputMode

Script: UtilitySetOutputMode

Description

When repeatedly selected, the Output Mode is cycled in the following order:
Window handle, control ID, window class, window type, window subtype code,
window style bits,  real window name, window name, window text restricted,
window text inclusive, highlighted text and SayTypeAndText.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySetOutputModeReverseOrder

Script: UtilitySetOutputModeReverseOrder

Description

When repeatedly selected, the Output Mode is cycled in the following order:
Window handle, control ID, window class, window type, window subtype code,
window style bits,  real window name, window name, window text restricted,
window text inclusive, highlighted text and SayTypeAndText.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilitySpeakWindowVisibility

Script: UtilitySpeakWindowVisibility

Description

This command will speak the visibility status of the window currently
referenced by the Home Row.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityToggleSpeakWindowVisibility

Script: UtilityToggleSpeakWindowVisibility

Description

When this function is turned on, you will hear the status of a window's
visibility as you tab through the window hierarchy.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityWindowClassReassign

Script: UtilityWindowClassReassign

Description

This is similar to the regular window class reassign dialog. This command
opens the window class reassign dialog containing the class for the window
currently referenced by the HomeRow utilities.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UtilityNodeCapture

Script: UtilityNodeCapture

Description

Use NodeCapture in home row mode to review the collection of information about
the current home row window. Pressing Escape dismisses the virtual viewer and
returns you to the home row utility.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
UtilityShowObjectHierarchyInfo

Script: UtilityShowObjectHierarchyInfo

Description

Displays information about the focus object and its hierarchical ancestors.
Level 0 is the current focus object, level 1 is its parent, 2 its grand
parent, etc.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
UtilityShowObjectListInfoByName

Script: UtilityShowObjectListInfoByName

Description

Shows information about each object in the current home row window in the
virtual viewer. Press Escape to dismiss the virtual viewer and return to home
row.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
UtilityShowObjectList

Script: UtilityShowObjectList

Description

Shows the list of objects for the current home row window in the virtual
viewer. Press Escape to dismiss the virtual viewer and return to home row.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
UtilityTreeCapture

Script: UtilityTreeCapture

Description

Use NodeCapture in home row mode to review the collection of information about
the window structure starting with the current home row window. Pressing
Escape dismisses the virtual viewer and returns you to the home row utility.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later
	2. JAWS 8.00 and later

----------
ChangeVoiceSetting

Function: ChangeVoiceSetting

Description

Changes the setting for the active voice.  This depends on the voice parameter
and direction (up or down) in which to change the setting.  The setting will
be increased or decreased by 10 percent of the range for the given parameter.
If True is passed to the SayAll parameter, there will be an audible indication
that the setting has changed.  This is the main control center for changing
voice parameters.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the constant definition for the voice parameter to set.
These are found in HjConst.jsh.  Examples of such are V_RATE and V_PITCH.
Include: Required

Param 2:

Type: Int
Description: Enter the constant definition for the direction to change the
setting.  These are found in HjConst.jsh and are V_UP and V_DOWN.
Include: Required

Param 3:

Type: Int
Description: Enter true to bypass the audio indication, or false to have the
function announce the setting change.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DecreaseVoicePitch

Script: DecreaseVoicePitch

Description

When this key is pressed, the pitch of the active voice will be decreased.
JAWS will announce "Lower" with each press of the keystroke.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DecreaseVoicePitchSayAll

Script: DecreaseVoicePitchSayAll

Description

During SayAll, the pitch for the active voice will be decreased.  JAWS will
repeat the current SayAll unit with the new setting.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DecreaseVoiceRate

Script: DecreaseVoiceRate

Description

When this key is pressed, the rate of the active voice will be decreased.
JAWS will announce "Slower" with each press of the keystroke.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DecreaseVoiceRateSayAll

Script: DecreaseVoiceRateSayAll

Description

During SayAll, the rate for the active voice will be decreased.  JAWS will
repeat the current SayAll unit with the new setting.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DecreaseVoiceVolume

Script: DecreaseVoiceVolume

Description

When this key is pressed, the volume of the active voice will be decreased.
JAWS will announce "Softer" with each press of the keystroke.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DecreaseVoiceVolumeSayAll

Script: DecreaseVoiceVolumeSayAll

Description

During SayAll, the volume for the active voice will be decreased.  JAWS will
repeat the current SayAll unit with the new setting.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetActiveSynthInfo

Function: GetActiveSynthInfo

Description

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

Returns

Type: Int
Description: TRUE if synth information was retrieved, FALSE otherwise.

Parameters

Param 1:

Type: String
Description: the short name of the synth as defined in SynthNShortName in
JFW.ini.
Include: Required
* Returns data by reference

Param 2:

Type: String
Description: the long name of the synth as defined in SynthNLongName in
JFW.ini.
Include: Required
* Returns data by reference

Param 3:

Type: String
Description: the driver name of the synth as defined in SynthNDriver in
JFW.ini.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetActiveSynthLanguage

Function: GetActiveSynthLanguage

Description

This function gets the name of the synth language in use.

Returns

Type: String
Description: the language name.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetDefaultSynthInfo

Function: GetDefaultSynthInfo

Description

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

Returns

Type: Int
Description: TRUE if synth information was retrieved, FALSE otherwise.

Parameters

Param 1:

Type: String
Description: the short name of the synth as defined in SynthNShortName in
JFW.ini.
Include: Required
* Returns data by reference

Param 2:

Type: String
Description: the long name of the synth as defined in SynthNLongName in
JFW.ini.
Include: Required
* Returns data by reference

Param 3:

Type: String
Description: the driver name of the synth as defined in SynthNDriver in
JFW.ini.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
GetSynthLanguages

Function: GetSynthLanguages

Description

This function retrieves a list of the currently active synthesisers supported
languages.

Returns

Type: String
Description: the list of synthesiser languages.

Parameters

Param 1:

Type: String
Description: the delimiter to use to separate the languages in the list.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetSynthPitchRange

Function: GetSynthPitchRange

Description

Assigns the minimum and maximum possible pitch settings to the parameters
taken by reference.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Type the variable to receive the minimum pitch seting for your
synthesizer.
Include: Required
* Returns data by reference

Param 2:

Type: Int
Description: Type the variable to receive the maximum pitch setting for your
synthesizer.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetSynthRateRange

Function: GetSynthRateRange

Description

Assigns the minimum and maximum possible rate settings to the parameters taken
by reference.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Type the variable to receive the minimum rate setting for your
synthesizer.
Include: Required
* Returns data by reference

Param 2:

Type: Int
Description: Type the variable to receive the maximum rate setting for your
synthesizer.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVoiceParameters

Function: GetVoiceParameters

Description

Retrieves the parameters for the voice context you specify.  These include
Volume, Rate, Pitch, Punctuation and person.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: Type the variable to receive the voice volume setting.
Include: Required
* Returns data by reference

Param 3:

Type: Int
Description: Type the variable to receive the voice rate setting.
Include: Required
* Returns data by reference

Param 4:

Type: Int
Description: Type the variable to receive the voice pitch setting.
Include: Required
* Returns data by reference

Param 5:

Type: Int
Description: Type the variable to receive the voice punctuation setting.
Include: Required
* Returns data by reference

Param 6:

Type: String
Description: Type the variable to receive the voice person setting.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVoicePerson

Function: GetVoicePerson

Description

Using the Voice Context name, the person for the active voice is returned.

Returns

Type: String
Description: The current voice person setting.

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVoicePitch

Function: GetVoicePitch

Description

Using the Voice Context name, the pitch setting for the active voice is
returned.

Returns

Type: Int
Description: The current voice pitch setting.

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVoicePunctuation

Function: GetVoicePunctuation

Description

Using the Voice Context name, the punctuation setting for the active voice is
returned.

Returns

Type: Int
Description: The current voice punctuation setting.

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVoiceRate

Function: GetVoiceRate

Description

Using the Voice Context name, the rate setting for the active voice is
returned.

Returns

Type: Int
Description: The current voice rate setting.

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVoiceVolume

Function: GetVoiceVolume

Description

Using the Voice Context name, the volume setting for the active voice is
returned.

Returns

Type: Int
Description: The current voice volume setting.

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVoiceVolumeRange

Function: GetVoiceVolumeRange

Description

Assigns the minimum and maximum possible volume settings to the parameters
taken by reference.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Type the variable to receive the minimum volume setting for your
synthesizer.
Include: Required
* Returns data by reference

Param 2:

Type: Int
Description: Type the variable to receive the maximum volume setting for your
synthesizer.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IncreaseVoicePitch

Script: IncreaseVoicePitch

Description

When this key is pressed, the pitch of the active voice will be increased.
JAWS will announce "Higher" with each press of the keystroke.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IncreaseVoicePitchSayAll

Script: IncreaseVoicePitchSayAll

Description

During SayAll, the pitch for the active voice will be increased.  JAWS will
repeat the current SayAll unit with the new setting.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IncreaseVoiceRate

Script: IncreaseVoiceRate

Description

When this key is pressed, the rate of the active voice will be increased.
JAWS will announce "Faster" with each press of the keystroke.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IncreaseVoiceRateSayAll

Script: IncreaseVoiceRateSayAll

Description

During SayAll, the rate for the active voice will be increased.  JAWS will
repeat the current SayAll unit with the new setting.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IncreaseVoiceVolume

Script: IncreaseVoiceVolume

Description

When this key is pressed, the volume of the active voice will be increased.
JAWS will announce "Louder" with each press of the keystroke.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IncreaseVoiceVolumeSayAll

Script: IncreaseVoiceVolumeSayAll

Description

During SayAll, the volume for the active voice will be increased.  JAWS will
repeat the current SayAll unit with the new setting.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
InitializeGlobalVoiceSettings

Function: InitializeGlobalVoiceSettings

Description

Each global setting variable will take on the corresponding voice setting for
the global voice context.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the constant definition or a variable to represent the
voice parameter to set.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsSpeaking

Function: IsSpeaking

Description

Checks to see if any text is currently being spoken.

Returns

Type: Int
Description: TRUE if synthesizer is speaking, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
IsSpeechOff

Function: IsSpeechOff

Description

Used to determine if the synthesizer is muted.

Returns

Type: Int
Description: TRUE if the synthesizer is muted. False if the synthesizer is not
muted.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MuteSynthesizer

Script: MuteSynthesizer

Description

Useful when using a software synthesizer with a single channel sound card.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MuteSynthesizerToggle

Function: MuteSynthesizerToggle

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

Type: String
Description: description of value to be displayed as value of Mute Synth
option.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NullAllGlobalSettings

Function: NullAllGlobalSettings

Description

By default, this function is used to reset all the settings for all the
voices.  When set to true, the voices will all take on the setting of the
voice parameter for the voice whose context you specify.  See its use in
SetGlobalVoiceSettings and ResetVoiceSettings.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The voice parameter to be reset.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ResetSynth

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ResetVoiceSettings

Function: ResetVoiceSettings

Description

Resets the voice setting back to its normal state prior to manipulation of the
voice.  This is only true if you have taken care to call the
SetVoiceGlobalSettings before you started manipulating the voice.  After the
settings are restored, the globals are set to null.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RestoreVoiceSettings

Script: RestoreVoiceSettings

Description

If you changed your voice setting with a keystroke, such as Alt+Control+PAGE
UP or Alt+Control+PAGE DOWN for voice rate, press this keystroke to restore
your voice setting to its normal state.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayAllInProgress

Function: SayAllInProgress

Description

Returns

Type: Int
Description: TRUE or FALSE;

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SayUsingVoice

Function: SayUsingVoice

Description

Speak a string of text using a specific synthisizer voice.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Type in the constant representing the voice to be used. These
constants are defined in the file hjconst.jsh and are listed below:
VCTX_GLOBAL, VCTX_MESSAGE, VCTX_KEYBOARD, VCTX_SCREEN, VCTX_PCCURSOR,
VCTX_JAWSCURSOR
Include: Required

Param 2:

Type: String
Description: 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.
Include: Required

Param 3:

Type: Int
Description: Type in one of the following constants that represent the output
mode to be used: OT_STRING, OT_LINE, OT_WORD, OT_CHAR, OT_FIELD, OT_CHUNK,
OT_SAYALL, OT_SPELL, OT_PHONEMIC, OT_APP_NAME, OT_DIALOG_NAME,
OT_CONTROL_NAME, OT_MDI_NAME, OT_WINDOW_NAME, OT_GRAPHIC, OT_HELP, OT_STATUS,
OT_SELECTED, OT_TEXT, OT_POSITION, OT_STATIC, OT_FONT, OT_KEYBOARD, OT_CURSOR,
OT_DEBUG.
Include: Required

Param 4:

Type: Int
Description: Not available yet
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SelectASynthesizer

Script: SelectASynthesizer

Description

All the synthesizers you have selected to install, Eloquence and the No Speech
driver will be presented in a list.  Make your selection and press enter.
This works like the Change Synthesizer option in the JAWS User Interface.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetAllVoicesToGlobals

Function: SetAllVoicesToGlobals

Description

Resets all voice parameters to their former position.  Pass the parameter
whose settings you wish to reset.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Type the constant definition representing the voice parameter to
be reset.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetSynth

Function: SetSynth

Description

Causes JFW to switch to the specified synthesizer.

Returns

Type: Int
Description: TRUE if change was successful, FALSE otherwise.

Parameters

Param 1:

Type: String
Description: The short name of the synthesizer found in JFW.INI. This name
must be in quotes. For example, you can find the short name for Eloquence by
looking in JFW.INI for the entry "Synth1Name=eloq." You would then use the
line SetSynth("eloq") in your script or function.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetSynthLanguage

Function: SetSynthLanguage

Description

For synthesizers that support multiple languages, changes the synthesizer to
the specified language.

Returns

Type: Int
Description: TRUE if change was successful, FALSE otherwise.

Parameters

Param 1:

Type: String
Description: Enter the language to be switched to, exactly as it appears in
the Synthesizer Language submenu of the Language menu. Example;
SetSynthLanguage ("American English")
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetVoiceGlobalSettings

Function: SetVoiceGlobalSettings

Description

The setting for the given parameter and voice context are stored in global
variables.  If this is not done before manipulating the given parameter for
the given voice context, it will be impossible to restore it.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the constant representing the voice parameter to be stored.
These are found in HjConst.jsh.  Examples of such are V_RATE and V_PITCH
Include: Required

Param 2:

Type: String
Description: Enter a variable, string literal or constant definition
representing the voice context name to be stored.
Include: Required

Param 3:

Type: Int
Description: Enter a variable or integer representing the current setting for
the parameter of the given voice context.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetVoiceParameters

Function: SetVoiceParameters

Description

sets the parameters for the voice context you specify.  These include Volume,
Rate, Pitch, Punctuation and person.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: Type the variable to setthe voice volume setting.
Include: Required

Param 3:

Type: Int
Description: Type the variable to set the voice rate setting.
Include: Required

Param 4:

Type: Int
Description: Type the variable to set the voice pitch setting.
Include: Required

Param 5:

Type: Int
Description: Type the variable to set the voice punctuation setting.
Include: Required

Param 6:

Type: String
Description: Type the variable to set the voice person setting.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetVoicePerson

Function: SetVoicePerson

Description

Sets the person of the voice you specify to the amount passed to the second
parameter.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: String
Description: The new person to which you wish to set the voice context.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetVoicePitch

Function: SetVoicePitch

Description

Sets the pitch of the voice you specify to the amount passed to the second
parameter.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: The new value to which you wish to set the pitch.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetVoicePunctuation

Function: SetVoicePunctuation

Description

Sets the punctuation of the voice you specify to the amount passed to the
second parameter.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: The new value to which you wish to set the punctuation.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetVoiceRate

Function: SetVoiceRate

Description

Sets the rate of the voice you specify to the amount passed to the second
parameter.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: The new value to which you wish to set the rate.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetVoiceSetting

Function: SetVoiceSetting

Description

Sets the parameter of the voice context you specify to the desired setting.
It is recommended that you use ChangeVoiceSetting if you simply wish to change
the setting.  See ChangeVoiceSetting if you want to use this function in
another script or function.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the constant definition for the voice parameter you wish to
set.  A listing of these are found in HjConst.jsh.  Examples of such are:
V_PITCH and V_RATE
Include: Required

Param 2:

Type: Int
Description: Enter a variable or the integer for the new setting for your
parameter.  See ChangeVoiceSetting to see the calculations we use for voice
changes.
Include: Required

Param 3:

Type: String
Description: Enter a variable or the string literal representing the Voice
Context name.
Include: Required

Param 4:

Type: Int
Description: Enter the value V_UP or V_DOWN to alert the function in which
direction this setting is moving.  This is only used to speak the appropriate
message as the setting changes.
Include: Required

Param 5:

Type: Int
Description: Enter true if you want the function to perform as though SayAll
were in progress, false otherwise.  If true, no announcement will be spoken
when the voice changes.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetVoiceVolume

Function: SetVoiceVolume

Description

Sets the volume of the voice you specify to the amount passed to the second
parameter.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the voice context as defined in HjConst.jsh with the
prefix VTX_.
Include: Required

Param 2:

Type: Int
Description: The new value to which you wish to set the volume.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SpeechInUse

Function: SpeechInUse

Description

Checks to see if speech output is being used.

Returns

Type: Int
Description: TRUE if synthesizer is active, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SpeechOff

Function: SpeechOff

Description

Causes the synthesizer to be muted. This is particularly useful when you need
to free the synthesizer so that a wave file can be played. You can reverse
this action with SpeechOn

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SpeechOn

Function: SpeechOn

Description

UnMutes the synthesizer. Reverses the action of SpeechOff.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StopSpeech

Function: StopSpeech

Description

Silences the synthesizer. Same as pressing the CTRL key.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StopSpeech

Script: StopSpeech

Description

Silences speech.  If you press this keystroke during SayAll, speech is stopped
and the cursor will land on the last word spoken.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.20 and later

----------
GetVoiceProfileNames

Function: GetVoiceProfileNames

Description

Returns

Type: string
Description: The delimited list of voice profile names.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
HasUserDefinedVoiceProfiles

Function: HasUserDefinedVoiceProfiles

Description

Returns

Type: Int
Description: Returns TRUE if there are user defined voice profiles.  Returns 0
otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SetActiveVoiceProfileByIndex

Function: SetActiveVoiceProfileByIndex

Description

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: The index of a voice profile.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SpeechToggledEvent

Function: SpeechToggledEvent

Description

This function is called whenever speech is turned on or off.  It is passed a
boolean value indicating whether speech has been turned on or off.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: This is the boolean value whether speech has been turned on or
off.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
CheckForReminderDialog

Function: CheckForReminderDialog

Description

If the window handle received is the Reminder dialog, then it is assigned to a
global variable for use by the ToggleOutlookReminder script.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Enter the handle of the window to check.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
CloseButton

Script: CloseButton

Description

If a menu is active, it is exited.  Otherwise, the current window or screen is
closed.  Closing most windows causes changes to be saved.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
CloseDocumentWindow

Script: CloseDocumentWindow

Description

Applications with a Multiple Document Interface can have more than one
document or workspace open.  This keystroke closes one of these windows
without exiting the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DoChildWindows

Function: DoChildWindows

Description

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The handle of the starting window or a function that can provide
it.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
EnumerateChildWindows

Function: EnumerateChildWindows

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

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

Parameters

Param 1:

Type: Handle
Description: starting handle.
Include: Required

Param 2:

Type: String
Description: The name of the script function to call for each child window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindDescendantWindow

Function: FindDescendantWindow

Description

Find the descendant window with the specified Control ID.

Returns

Type: Handle
Description: The handle of the window that is found. This is 0 if the window
is not found.

Parameters

Param 1:

Type: Handle
Description: The handle of the parent window that will serve as the starting
point for the search.
Include: Required

Param 2:

Type: Int
Description: The Control ID of the window for which you are searching.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindSelectedRadioButton

Function: FindSelectedRadioButton

Description

Starting with the given window handle, searches the given number of
consecutive windows for the selected radio button.

Returns

Type: handle
Description: the selected radio button if found, null otherwise.

Parameters

Param 1:

Type: Handle
Description: The first radio button in a group of consecutive radio button
windows.
Include: Required

Param 2:

Type: int
Description: The number of radio buttons in the group.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
FindTopLevelWindow

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

Type: Handle
Description: The handle of the window that is found. This is 0 if the window
is not found.

Parameters

Param 1:

Type: String
Description: The window class that will be used to find the desired window.
Include: Required

Param 2:

Type: String
Description: The window name that will be used to find the desired window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindWindow

Function: FindWindow

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

Type: Handle
Description: the window handle of the found window.

Parameters

Param 1:

Type: Handle
Description: starting window.
Include: Required

Param 2:

Type: String
Description: class name to search for.
Include: Required

Param 3:

Type: String
Description: the name of the window to find.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
findWindowByType

Function: findWindowByType

Description

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

Returns

Type: handle
Description: 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.

Parameters

Param 1:

Type: handle
Description: the starting window
Include: Required

Param 2:

Type: int
Description: the window type (one of the WT_ constants from hjconst.jsh).
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
FindWindowWithClassAndId

Function: FindWindowWithClassAndId

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

Type: handle
Description: the handle of the window if found, NULL otherwise

Parameters

Param 1:

Type: handle
Description: starting handle
Include: Required

Param 2:

Type: string
Description: the class name
Include: Required

Param 3:

Type: int
Description: the control ID of the child
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
FocusChangedEvent

Function: FocusChangedEvent

Description

The window handles of the previous and current windows are passed to this
function. This function calls either SayWindowTypeAndText SayFocusedWindow or
SayFocusedObject in order to ensure that the active control is properly
spoken.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: the handle of the window that has received the focus.
Include: Required

Param 2:

Type: Handle
Description: the handle of the window that previously had the focus.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ForegroundIconicEvent

Function: ForegroundIconicEvent

Description

This event function is fired when all apps are minimized or closed and the
focus is not placed on the desktop.  More testing is needed before it is
implemented.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of current Foregound Window, not focus.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ForegroundWindowChangedEvent

Function: ForegroundWindowChangedEvent

Description

A real window is a window which has a title. Real windows are often
application main windows, and dialog main windows.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of the new window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetAppletName

Function: GetAppletName

Description

Retrieves the name of the applet of the requested window handle.

Returns

Type: String
Description: The name of the applet.

Parameters

Param 1:

Type: Handle
Description: Window of interest.  If not included, then the current window is
used.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetAppMainWindow

Function: GetAppMainWindow

Description

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

Returns

Type: Handle
Description: Provides the window handle of the application's Main window.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetControlID

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

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

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCurrentControlID

Function: GetCurrentControlID

Description

Determines the control ID of the active child window in a dialog box. Each
list box, edit field, radio button, and so on, in a dialog has a unique
control ID number. Child windows that contain static text all have the same
control ID. This function performs the same task as GetControlID but it does
not require a window handle.

Returns

Type: Int
Description: Provides a numeric ID for the active dialog control, or returns 0
when a dialog box is not active.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCurrentWindow

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

Type: Handle
Description: Provides a handle for the active window.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFirstChild

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

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

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFirstFocusableChild

Function: GetFirstFocusableChild

Description

Determines the first child window that is not a static control. This function
is useful when you wish to determine the first focusable control in a dialog.

Returns

Type: Handle
Description: Provides the handle of the first non-static child window or
returns a value of 0 when such a child window cannot be found.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later

----------
GetFirstWindow

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

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

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFocus

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

Type: Handle
Description: Provides the window handle for the window with the focus.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFocusRect

Function: GetFocusRect

Description

Gets the coordinates of a focus rectangle.

Returns

Type: Int
Description: TRUE if the focus rectangle is successfully retrieved.

Parameters

Param 1:

Type: Int
Description: the handle of the window containing the focus rectangle.
Include: Required

Param 2:

Type: Int
Description: the left edge of the focus rectangle after the function is
called.
Include: Required

Param 3:

Type: Int
Description: the right edge of the focus rectangle after the function is
called.
Include: Required

Param 4:

Type: Int
Description: the top edge of the focus rectangle after the function is called.
Include: Required

Param 5:

Type: Int
Description: the bottom edge of the focus rectangle after the function is
called.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFocusRectBottom

Function: GetFocusRectBottom

Description

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

Returns

Type: Int
Description: Screen coordinate of bottom edge of focus rectangle.

Parameters

Param 1:

Type: Int
Description: Handle of window containing the focus rectangle.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFocusRectLeft

Function: GetFocusRectLeft

Description

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

Returns

Type: Int
Description: Screen coordinate of left edge of focus rectangle.

Parameters

Param 1:

Type: Int
Description: Handle of window containing the focus rectangle.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFocusRectRight

Function: GetFocusRectRight

Description

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

Returns

Type: Int
Description: Screen coordinate of right edge of focus rectangle.

Parameters

Param 1:

Type: Int
Description: Handle of window containing the focus rectangle.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFocusRectTop

Function: GetFocusRectTop

Description

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

Returns

Type: Int
Description: Screen coordinate of top edge of focus rectangle.

Parameters

Param 1:

Type: Int
Description: Handle of window containing the focus rectangle.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetForegroundWindow

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

Type: Handle
Description: The handle of the foreground window.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetHHTaskBarWnd

Function: GetHHTaskBarWnd

Description

Use this method to get the window handle for the window with the class
HHTaskBar. There will be only one of these windows.

Returns

Type: Handle
Description: If successful, the handle of the window with the class HHTaskBar;
otherwise, returns null.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GetItemRect

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

Type: Int
Description: TRUE if the bounding rectangle is successfully retrieved.

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Required

Param 3:

Type: Int
Description: The left edge of the bounding rectangle after the function is
called.
Include: Required

Param 4:

Type: Int
Description: The right edge of the bounding rectangle after the function is
called.
Include: Required

Param 5:

Type: Int
Description: The top edge of the bounding rectangle after the function is
called.
Include: Required

Param 6:

Type: Int
Description: The bottom edge of the bounding rectangle after the function is
called.
Include: Required

Param 7:

Type: Int
Description: The item type. Can be IT_CHUNK, IT_WORD, IT_CHAR, IT_FIELD,
IT_COLORFIELD, IT_PROMPT, IT_CARET, IT_BOUNDINGRECT, IT_MAGNIFIED, IT_LINE,
IT_PRIOR_WORD, IT_NEXT_WORD, or IT_HIGHLIGHT. Types can be combined using the
bitwise (|) operator. For example, if you want to get the rectangle that
surrounds an edit control and its prompt, use IT_BOUNDINGRECT | IT_PROMPT for
this parameter.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetLastWindow

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

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

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later
	2. PAC Mate 2.01 and later

----------
GetNavModuleVersionInfo

Function: GetNavModuleVersionInfo

Description

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

Returns

Type: String
Description: String describing the nav module that is handling the passed in
window.

Parameters

Param 1:

Type: Handle
Description: Window of interest
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetNextWindow

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

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

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetOwner

Function: GetOwner

Description

Returns

Type: Handle

Parameters

Param 1:

Type: Handle
Description:
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GetParent

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

Type: Handle
Description: This is the handle of the parent window.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetPriorWindow

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

Type: Handle
Description: Provides the handle of the prior window in the stack or returns a
value of 0 when another window cannot be found.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetRealWindow

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

Type: Handle
Description: Provides the handle of the real window.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetTextInFocusRects

Function: GetTextInFocusRects

Description

Retrieves the contents of all focus rectangles into a single buffer.

Returns

Type: String
Description: The contents of the focus rectangles.

Parameters

Param 1:

Type: Handle
Description: Handle of window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetTextInRect

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

Type: String
Description: Text   inside the rectangle.

Parameters

Param 1:

Type: Int
Description: Left edge of rectangle.
Include: Required

Param 2:

Type: Int
Description: top edge of rectangle.
Include: Required

Param 3:

Type: Int
Description: right edge of rectangle.
Include: Required

Param 4:

Type: Int
Description: bottom edge of rectangle.
Include: Required

Param 5:

Type: Int
Description: 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.
Include: Optional

Param 6:

Type: Int
Description: color of text to include, use IgnoreColor constant for any color.
Include: Optional

Param 7:

Type: Int
Description: background color of text to include.
Include: Optional

Param 8:

Type: Int
Description: Whether or not to add line breaks or to get the text as one long
string.
Include: Optional

Param 9:

Type: Int
Description: Whether or not to add Braille graphic labels or to get the text
as it would be spoken.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetTopLevelWindow

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

Type: Handle
Description: The handle of the TopLevel window, as opposed to the
AppMainWindow.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowAtPoint

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

Type: Handle
Description: 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.

Parameters

Param 1:

Type: Int
Description: The horizontal (x) value of the point.
Include: Required

Param 2:

Type: Int
Description: The vertical (y) value of the point.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowBottom

Function: GetWindowBottom

Description

Gets the screen coordinate for the bottom of the window of interest.

Returns

Type: Int
Description: Screen coordinate of bottom edge of window.

Parameters

Param 1:

Type: Int
Description: Handle of window of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowClass

Function: GetWindowClass

Description

This obtains the window class name of a window. Most standard windows (non SDM
windows) have a window class name and a window type name. Window class names
are generally unique to specific windows in specific applications.

Returns

Type: String
Description: The string is the class name.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowHierarchyX

Function: GetWindowHierarchyX

Description

This function gets the hierarchical position of the supplied window relative
to the first window at the same level, ie it counts the windows at the same
level and returns this window's position.

Returns

Type: Int
Description: The position of the window relative to the first at the same
level.

Parameters

Param 1:

Type: Handle
Description: handle of starting window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowHierarchyY

Function: GetWindowHierarchyY

Description

This function gets the hierarchical position of the supplied window relative
to the first ancestor for this window, ie counts the parent, grandparent,
great grandparent etc.

Returns

Type: Int
Description: The position of the window relative to the first existing
ancestor.

Parameters

Param 1:

Type: Handle
Description: handle of starting window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowLeft

Function: GetWindowLeft

Description

Gets the screen coordinate for the left of the window of interest.

Returns

Type: Int
Description: Screen coordinate of left edge of window.

Parameters

Param 1:

Type: Int
Description: Handle of window of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowName

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

Type: String
Description: Provides the title of the window when a title is present. When a
title is not present, the null value of "" is returned.

Parameters

Param 1:

Type: Handle
Description: Type the name of a variable or choose a script function to
specify the window handle title that is desired.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowOwner

Function: GetWindowOwner

Description

If possible, retrieves the name, including the full path, to the application
which owns the window.

Returns

Type: string
Description: the path and name of the owning application, or null if the
application could not be determined.

Parameters

Param 1:

Type: handle
Description: Type the name of a variable or choose a script function to
specify the window handle title that is desired.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
GetWindowRect

Function: GetWindowRect

Description

Gets the bounding rectangle of the window whose handle is specified.

Returns

Type: Int
Description: TRUE if the bounding rectangle is successfully retrieved.

Parameters

Param 1:

Type: Handle
Description: The handle of the window for which the rectangle is requested.
GetFocus can be used to return this value.
Include: Required

Param 2:

Type: Int
Description: The left edge of the bounding rectangle after the function is
called.
Include: Required

Param 3:

Type: Int
Description: The right edge of the bounding rectangle after the function is
called.
Include: Required

Param 4:

Type: Int
Description: The top edge of the bounding rectangle after the function is
called.
Include: Required

Param 5:

Type: Int
Description: The bottom edge of the bounding rectangle after the function is
called.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowRight

Function: GetWindowRight

Description

Gets the screen coordinate for the right of the window of interest.

Returns

Type: Int
Description: Screen coordinate of right edge of window.

Parameters

Param 1:

Type: Int
Description: Handle of window of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowStyleBits

Function: GetWindowStyleBits

Description

This function returns the window style bit flags. See the WS constants in the
standard winUser.h.

Returns

Type: Int
Description: the bit flags.

Parameters

Param 1:

Type: Handle
Description: the window whose style bits are required.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowSubtypeCode

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

Type: Int
Description: The window subtype number for the specified window.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowText

Function: GetWindowText

Description

Retrieves the text contained in a window.

Returns

Type: String
Description: The retrieved text.

Parameters

Param 1:

Type: Handle
Description: The handle of the window containing the requested text. GetFocus
can be used to return this value.
Include: Required

Param 2:

Type: Int
Description: TRUE if only highlighted text is requested, otherwise FALSE.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowTextEx

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

Type: String
Description: The retrieved text.

Parameters

Param 1:

Type: Handle
Description: The handle of the window containing the requested text. GetFocus
can be used to return this value.
Include: Required

Param 2:

Type: Int
Description: Enter TRUE if only highlighted text is requested, otherwise
FALSE.
Include: Required

Param 3:

Type: Int
Description: Enter TRUE if text within child windows should be included, FALSE
if only text from this window should be retrieved.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowTop

Function: GetWindowTop

Description

Gets the screen coordinate for the top of the window of interest.

Returns

Type: Int
Description: Screen coordinate of top edge of window.

Parameters

Param 1:

Type: Int
Description: Handle of window of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowType

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

Type: String
Description: The string is the window type.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWindowTypeCode

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

Type: Int
Description: The window type number for the specified window.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function to provide the
window handle it needs.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HandleCustomAppWindows

Function: HandleCustomAppWindows

Description

You can use this function instead of modifying the FocusChangedEvent function
when modifying scripts.  The AppWindow is the top frame window, and most of
the time you won't need to modify it.  Some wizard dialogs, among other
things, present themselves as problems here.

Returns

Type: Int
Description: Return true when your logic is successful, FALSE when you want
the default behavior of the FocusChangedEvent function at appWindow.

Parameters

Param 1:

Type: Handle
Description: Enter the handle to the window which is the Application Window.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HandleCustomRealWindows

Function: HandleCustomRealWindows

Description

You can use this function instead of modifying the FocusChangedEvent function
when modifying scripts.  This can be convenient for wizard dialogs and other
places where dialog and document name speaking is pretty ugly.

Returns

Type: Int
Description: Return true when your logic is successful, FALSE when you want
the default behavior of the FocusChangedEvent function at RealWindow.

Parameters

Param 1:

Type: Handle
Description: Enter the handle to the window which is the Real Window.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HandleCustomWindows

Function: HandleCustomWindows

Description

You can use this function instead of modifying the FocusChangedEvent or
SayFocusedWinow function when modifying scripts.  This will also prevent you
from having to worry about insert tab, because if you use this function insert
tab and the focus logic will now become seamlessly consistent.

Returns

Type: Int
Description: Return true when your logic is successful, FALSE when you want
the default behavior of the FocusChangedEvent or SayFocusedWindow functions or
the SayWindowPromptAndText script.

Parameters

Param 1:

Type: Handle
Description: Enter the handle to the window which is the current window.  Note
that in FocusChangedEvent, we pass FocusWindow.  In the SayWindowPromptAndText
script, we use GetCurrentWindow, which respects the active cursor.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HasFocusRect

Function: HasFocusRect

Description

Determines if the specified window has a focus rectangle (Not implemented
currently).

Returns

Type: Int
Description: "True" or "False", 1 or 0.

Parameters

Param 1:

Type: Handle
Description: Handle of window to check
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HasTitleBar

Function: HasTitleBar

Description

Determines whether a window has a title bar. If the window has a title bar,
then the function returns a constant value of TRUE. If the window does not
have a title bar, then a constant value of FALSE is returned. Windows that
typically have title bars are dialog boxes and main application windows.

Returns

Type: Int
Description: "TRUE" = 1, "FALSE" = 0.

Parameters

Param 1:

Type: Handle
Description: This function examines 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HelpBalloonEvent

Function: HelpBalloonEvent

Description

In Windows XP two kinds of bubbles pop up displaying help, the first is a
tooltip which is picked up by the ToolTipEvent and the second is a Help
Balloon which triggers this event.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: the handle to the Help Balloon window.
Include: Required

Param 2:

Type: String
Description: the text of the help balloon.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
InternalFrameChangedEvent

Function: InternalFrameChangedEvent

Description

This function is used to speak the frame name before FocusChangedEvent is
called to speak the FocusObject

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: handle of the window to check.
Include: Required

Param 2:

Type: Handle
Description: Handle of the window containing the frame.
Include: Required

Param 3:

Type: String
Description: The name of the frame.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
InTextWindow

Function: InTextWindow

Description

Determines if the focus is in a window which may contain selectable text, such
as an edit window.

Returns

Type: int
Description: true if in a window where text may be selected and copied, false
otherwise

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
InvalidateRect

Function: InvalidateRect

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

Type: int
Description: If the function succeeds, the return value is nonzero. If the
function fails, the return value is zero.

Parameters

Param 1:

Type: handle
Description: of window.
Include: Required

Param 2:

Type: int
Description: Rectangle left.
Include: Required

Param 3:

Type: int
Description: Rectangle top.
Include: Required

Param 4:

Type: int
Description: Rectangle right.
Include: Required

Param 5:

Type: int
Description: Rectangle bottom.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
IsDescendedFromWindow

Function: IsDescendedFromWindow

Description

Tests to see if the two windows have an ancestor/descendant relationship.

Returns

Type: int
Description: True The windows have an ancestor/descendant relationship.

Parameters

Param 1:

Type: handle
Description: The window which is to be tested for ancestory over the
descendant window.
Include: Required

Param 2:

Type: handle
Description: The window which is to be tested for descendancy from the
ancestor window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later
	2. JAWS 7.00 and later

----------
IsLiteraryWindow

Function: IsLiteraryWindow

Description

Returns

Type: int
Description: true if window may contain literary constructs such as sentences
and paragraphs, false otherwise.

Parameters

Param 1:

Type: handle
Description: The handle of the window to test.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later

----------
IsPegHelpWindow

Function: IsPegHelpWindow

Description

tests to determine if focus is in the main window of Help.

Returns

Type: int
Description: True if in the main window of Help, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
IsPointInWindow

Function: IsPointInWindow

Description

Compares the specified pixel coordinates with the window boundaries of the
window whose handle is indicated in the perimeter hwnd to determine whether it
is within the boundaries of that window.

Returns

Type: Int
Description: Returns one if the specified point is contained in the indicated
window. Returns zero otherwise.

Parameters

Param 1:

Type: Handle
Description: The handle of the window of interest.
Include: Required

Param 2:

Type: Int
Description: The horizontal coordinate of the pixel location of interest.
Include: Required

Param 3:

Type: Int
Description: The vertical coordinate of the pixel location of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsSelectedRadioButton

Function: IsSelectedRadioButton

Description

Looks to see if the window is a radio button and also if it is selected.

Returns

Type: int
Description: True if the radio button is selected, false otherwise.

Parameters

Param 1:

Type: Handle
Description: The radio button.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
isSystemDialog

Function: isSystemDialog

Description

Tests to determine if focus is on a system dialog.

Returns

Type: int
Description: True if in a system dialog, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.00 and later

----------
IsWindowDisabled

Function: IsWindowDisabled

Description

Checks the status of the current window or control. Returns FALSE if the
window is active; TRUE if the window is disabled.

Returns

Type: Int
Description: TRUE if window is disabled, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: Handle of window to check. This can be obtained through the
GetFocus or GetCurrentWindow functions.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsWindowObscured

Function: IsWindowObscured

Description

Checks to see if this window is covered by any others and therefore cannot be
entirely seen.

Returns

Type: Int
Description: TRUE if window is at least partially covered, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: Handle of window to check. This can be obtained through the
GetFocus or GetCurrentWindow functions.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsWindowVisible

Function: IsWindowVisible

Description

Checks the visual status of the window. This function will return true even if
the window is completely covered by other windows. See function
IsWindowObscured for a way to find out if a particular window is covered.
Returns TRUE if the Window is visible on the screen, FALSE if the window is
not visible on the screen.

Returns

Type: Int
Description: TRUE if window on screen, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: Handle of window to check. This can be obtained through the
GetFocus or GetCurrentWindow functions.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JavaFocusChangedEvent

Function: JavaFocusChangedEvent

Description

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The window that has received focus.
Include: Required

Param 2:

Type: Handle
Description: The window that previously had focus.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
lvGetItemColumnRect

Function: lvGetItemColumnRect

Description

Gets the bounding rectangle of the item in specific column of listview or
listcontrol.

Returns

Type: Int
Description: TRUE if the bounding rectangle is successfully retrieved.

Parameters

Param 1:

Type: Handle
Description: The handle of the window for which the rectangle is requested.
Include: Required

Param 2:

Type: Int
Description: of column, starting at zero.
Include: Required

Param 3:

Type: Int
Description: The left edge of the bounding rectangle after the function is
called.
Include: Required

Param 4:

Type: Int
Description: The right edge of the bounding rectangle after the function is
called.
Include: Required

Param 5:

Type: Int
Description: The top edge of the bounding rectangle after the function is
called.
Include: Required

Param 6:

Type: Int
Description: The bottom edge of the bounding rectangle after the function is
called.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later
	2. JAWS 5.10 and later

----------
lvGetNumOfColumns

Function: lvGetNumOfColumns

Description

Gets the number of columns(if any) of a list control or listview.

Returns

Type: Int
Description: Number of columns in a list control or list view.

Parameters

Param 1:

Type: Handle
Description: The handle of the list control or list view.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later
	2. JAWS 5.10 and later

----------
lvIsReportListStyle

Function: lvIsReportListStyle

Description

Identifies the style of list control or list view.

Returns

Type: Int
Description: TRUE if style is Report or list, otherwise FALSE.

Parameters

Param 1:

Type: Handle
Description: The handle of the list control or list view.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later
	2. JAWS 5.10 and later

----------
MoveToWindow

Function: MoveToWindow

Description

Moves the active cursor to the specified window. If the window contains text,
then the cursor is positioned on the first character. Otherwise, it is
positioned at the center of the window. 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.

Returns

Type: Int
Description: "WAS_SUCCESSFUL" = 1 (window was found), "WAS_NOT_SUCCESSFUL" = 0
(window was not found).

Parameters

Param 1:

Type: Handle
Description: Type the name of a variable or choose a script function that
indicates the window handle where the active cursor is to be moved.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
navGetAppMainObjectID

Function: navGetAppMainObjectID

Description

Determines the object ID for the Main object of the active application.

Returns

Type: Handle
Description: Provides the object ID of the application's Main object.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetCurrentObjectID

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

Type: Handle
Description: the Object ID or 0 if the Object ID cannot be retrieved.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetFirstChildObjectID

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

Type: Handle
Description: Provides the handle of the first child object or returns a value
of 0 when a child object cannot be found.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetFirstObjectID

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

Type: Int
Description: Provides Object ID.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetFocusObjectID

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

Type: Handle
Description: the Object ID at the focus point, or 0 if the Object ID cannot be
retrieved.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetLastObjectID

Function: navGetLastObjectID

Description

Obtains the Object ID of the last Object in a series of objects. It can
provide the object ID that is needed by other object navigation functions.

Returns

Type: Int
Description: Provides Object ID.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetNextObjectID

Function: navGetNextObjectID

Description

Provides the next Object ID in a series of Object IDs that are all at the same
logical level. It is used to move across a list of control objects.

Returns

Type: Handle
Description: Provides the Object ID of the next object in the stack or returns
a value of 0 when another object cannot be found.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetObjectContainerHelp

Function: navGetObjectContainerHelp

Description

Retrieves the container 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

Type: String
Description: the container help string of the specified object.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the Object ID for object whose information is to be retrieved. If a an object
ID is not provided, navGetCurrentObjectID will be used to provide a default
ID.
Include: Optional

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetObjectHelp

Function: navGetObjectHelp

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

Type: String
Description: the help string of the specified object.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the Object ID for object whose information is to be retrieved. If a an object
ID is not provided, navGetCurrentObjectID will be used to provide a default
ID.
Include: Optional

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetObjectName

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

Type: String
Description: the name of the specified object.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the Object ID for object whose information is to be retrieved. If a an object
ID is not provided, navGetCurrentObjectID will be used to provide a default
ID.
Include: Optional

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetObjectTypeCode

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

Type: Int
Description: the object type code of the specified object.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the Object ID for object whose information is to be retrieved. If a an object
ID is not provided, navGetCurrentObjectID will be used to provide a default
ID.
Include: Optional

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetObjectTypeString

Function: navGetObjectTypeString

Description

Retrieves the object type 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

Type: String
Description: the object type string of the specified object.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the Object ID for object whose information is to be retrieved. If a an object
ID is not provided, navGetCurrentObjectID will be used to provide a default
ID.
Include: Optional

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetParentObjectID

Function: navGetParentObjectID

Description

Determines which object is directly above the specified child object. 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 object IDs in order to get to a specific object.

Returns

Type: Handle
Description: This is the handle of the parent object.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetPrevObjectID

Function: navGetPrevObjectID

Description

Provides the previous Object ID in a series of Object IDs that are all at the
same logical level. It is used to move across a list of control objects.

Returns

Type: Handle
Description: Provides the Object ID of the prior object in the stack or
returns a value of 0 when another object cannot be found.

Parameters

Param 1:

Type: Handle
Description: 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 last object.
Include: Required

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetRealObjectID

Function: navGetRealObjectID

Description

Moves up through the list of objects in search of a real object. A real object
is one that has a title.

Returns

Type: Handle
Description: Provides the object ID of the real object.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navGetTopLevelObjectID

Function: navGetTopLevelObjectID

Description

Similar to navGetAppMainObjectID.  These two functions differ however in that
navGetAppMainObjectID will always return the object ID for the highest level
object in the application.  In contrast, navGetTopLevelObjectID can be used
within dialog boxes to return the object ID of the main dialog object when
there may be several child windows which are also real windows. This can be
useful when the navGetRealWindowObjectID function does not return the object
ID of the main dialog.  A real object refers to a object with a title.

Returns

Type: Handle
Description: The handle of the TopLevel object, as opposed to the AppMain
Object.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
navSayObjectTypeAndText

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.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the Object ID for object whose information is to be retrieved. If a an object
ID is not provided, navGetCurrentObjectID will be used to provide a default
ID.
Include: Optional

Param 2:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
PostMessage

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.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Window to which the message should be posted.
Include: Required

Param 2:

Type: Int
Description: Message to be sent.
Include: Required

Param 3:

Type: Int
Description: wParam value for the message, defaults to 0.
Include: Optional

Param 4:

Type: Int
Description: lParam value for the message, defaults to 0.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
RefocusToForegroundDialog

Function: RefocusToForegroundDialog

Description

attempts to set foreground focus to a visible dialog on top of other
applications yet not in focus.

Returns

Type: handle
Description: If successful, the handle of the dialog to which the foreground
focus was set.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later

----------
Refresh

Function: Refresh

Description

Refreshes the screen.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: 1 means force the refresh, 0, only if needed.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RefreshScreen

Script: RefreshScreen

Description

Refreshes the screen and updates the state of information of the Off Screen
Model.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RefreshWindow

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

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of window to be refreshed.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayBottomLineOfWindow

Script: SayBottomLineOfWindow

Description

The bottom line is usually the status line of the active window.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFocusedWindow

Function: SayFocusedWindow

Description

Called by the focus changed event or keys that report the item that has focus
such as INSERT+TAB.  Designed to be replaced by application specific script
files that may want to do special handling for the window with focus without
replacing the entire focus changed event.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFocusRect

Function: SayFocusRect

Description

Says the contents of focus rectangle. Returns TRUE if any text was spoken,
FALSE otherwise.

Returns

Type: Int
Description: "True" or "False", 1 or 0.

Parameters

Param 1:

Type: Handle
Description: Handle of window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFocusRects

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

Type: Int
Description: TRUE if text was spoken, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: Handle of window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SaySpecialWindowClasses

Script: SaySpecialWindowClasses

Description

Cycles through 4 groups: parent windows, child windows, previous and next
windows.  Just keep pressing the CTRL+INSERT+F2 and it will say the window
classes.  For more info on windows use the homerow utility functions.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayToBottom

Function: SayToBottom

Description

Says the active window from the position of the active cursor to the bottom of
the window. The cursors do not move as text is read, the window will not
scroll to display additional text.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayTopLineOfWindow

Script: SayTopLineOfWindow

Description

The top line is usually the title of the active window.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayWindow

Function: SayWindow

Description

Reads the specified window. It reads either highlighted text or all text in
the window.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Type the name of a variable or choose a script function that
provides the handle of the window that is to be spoken.
Include: Required

Param 2:

Type: Int
Description: Type a constant to determine how much information is to be read:
READ_EVERYTHING" = 0, "READ_HIGHLIGHTED" = 1.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayWindowPromptAndText

Script: SayWindowPromptAndText

Description

Says the prompt and type of the window or control as well as the text in the
window that has focus. When the virtual cursor is active and in a web page,
JAWS speaks the control information using the current verbosity setting for
the control the first time this keystroke is pressed.  Subsequent presses of
this keystroke cause JAWS to speak the control again, which may or may not
sound different, followed by a message in the message voice which tells you
the setting being used.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayWindowTitle

Script: SayWindowTitle

Description

Says the application title, dialog box title, and item with focus.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayWindowTypeAndText

Function: SayWindowTypeAndText

Description

Reads a specified series of information from a window. It reads the window
title (when one is present), the window type, the contents in the window, and
provides related information about the current dialog option. This function
marks the text it reads so that the Say NonHighlighted text and Say
Highlighted text functions do not repeat the same information when they are
triggered.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Type the name of a variable or choose a script function that
provides the handle of the window that is to be read.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SendMessage

Function: SendMessage

Description

Provides limited access to the Windows SendMessage 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.  The return value is always treated as an integer.

Returns

Type: Int
Description: result of the SendMessage call.

Parameters

Param 1:

Type: Handle
Description: Window to which the message should be sent.
Include: Required

Param 2:

Type: Int
Description: Message to be sent.
Include: Required

Param 3:

Type: Int
Description: wParam value for the message, defaults to 0.
Include: Optional

Param 4:

Type: Int
Description: lParam value for the message, defaults to 0.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
SetFocus

Function: SetFocus

Description

Moves the focus to a specified window.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of window to which focus should be moved.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetFocusToFirstFocusableControl

Function: SetFocusToFirstFocusableControl

Description

Searches the immediate child windows of the starting window for a focusable
contro. If no child window is found, then a window of type control tab is
searched for. If a window is found which it is believed can gain focus, then
attempts to set the focus to the found window.

Returns

Type: int
Description: tru if a focusable control could be found and focus was set,
false otherwise.

Parameters

Param 1:

Type: handle
Description: The starting position from which to search for the first
focusable control.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.10 and later

----------
SetForegroundWindow

Function: SetForegroundWindow

Description

Makes the application that created the specified window the foreground
application.  The window which has focus will be the same one that had focus
when this aplication was last in the foreground.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of a window
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SetParentDims

Function: SetParentDims

Description

The top, left, bottom, and right values of the current application main window
are assigned to variables. These variables are used by Frame Viewer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SpeakWindowInformation

Function: SpeakWindowInformation

Description

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The handle of the window whose information is desired.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ToolTipEvent

Function: ToolTipEvent

Description

Will tell the user the tool tip. Also used for the Auto Graphics Labeler.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
VirtualizeWindow

Script: VirtualizeWindow

Description

this keystroke adds the text in the current window to the User Virtual Buffer
for easier navigation and so that the text or parts thereof maybe copied to
the clipboard. this is useful in error dialogs.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
WindowActivatedEvent

Function: WindowActivatedEvent

Description

This function is generally triggered when focus changes because of the opening
or closing of a top-level window, such as when a dialog appears or disappears.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: Handle of the window just activated.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
WindowClassReassign

Script: WindowClassReassign

Description

Gets the class of the current window and lets you equate it to a known class,
so JAWS can speak it properly.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
WindowCreatedEvent

Function: WindowCreatedEvent

Description

You should not include processor consuming code within this function. The code
within this function is processed very frequently.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of the window just created.
Include: Required

Param 2:

Type: Int
Description: left edge of the window.
Include: Required

Param 3:

Type: Int
Description: top edge of the window.
Include: Required

Param 4:

Type: Int
Description: right edge of the window.
Include: Required

Param 5:

Type: Int
Description: bottom edge of the window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
WindowDestroyedEvent

Function: WindowDestroyedEvent

Description

Can be modified for application specific needs.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The handle of the window that is about to be destroyed.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
WindowMinMaxEvent

Function: WindowMinMaxEvent

Description

nMinMaxRest gives general information about what is happening to the window.
It can be WE_MINIMIZE, WE_MAXIMIZE, or WE_RESTORE. nShow is more specific. For
a complete list of nShow values, look for "SW_" in hjconst.jsh.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The handle of the window whose status is about to change.
Include: Required

Param 2:

Type: Int
Description: Describes the general action taking place on the window.
Include: Required

Param 3:

Type: Int
Description: Describes the specific action taking place on the window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.100 and later
	2. JAWS 4.51 and later

----------
WindowResizedEvent

Function: WindowResizedEvent

Description

Can be modified for application specific needs.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of the window about to be resized.
Include: Required

Param 2:

Type: Int
Description: The left edge of the window that is about to be resized.
Include: Required

Param 3:

Type: Int
Description: The top edge of the window that is about to be resized.
Include: Required

Param 4:

Type: Int
Description: The right edge of the window that is about to be resized.
Include: Required

Param 5:

Type: Int
Description: The bottom edge of the window that is about to be resized.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
WmGetText

Function: WmGetText

Description

Sends a Windows WM_GETTEXT message to the window with focus  or a specified
window.  This function almost never needs to be used.  It is reserved for
those cases where JAWS standard methods of obtaining a Windows's contents
using the OSM does not retrieve the proper information.  This function asks
the window for its text rather than finding the text on the screen.

Returns

Type: String
Description: result of the WM_GETTEXT message.

Parameters

Param 1:

Type: Handle
Description: Window of interest.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
FocusChangedEventEx

Function: FocusChangedEventEx

Description

Processes all types of focus change, and calls the proper event to handle the
change according to the type of focus change which occurred.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: The handle of the window that has received the focus.
Include: Required

Param 2:

Type: int
Description: The number of the object that has received the focus.
Include: Required

Param 3:

Type: int
Description: The number of the current child object.
Include: Required

Param 4:

Type: handle
Description: The handle of the window that previously had the focus.
Include: Required

Param 5:

Type: int
Description: The number of the object that previously had the focus.
Include: Required

Param 6:

Type: int
Description: The number of the child object which previously had focus.
Include: Required

Param 7:

Type: int
Description: The change depth, or number of levels effected by the change.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
GetDocumentLoadState

Function: GetDocumentLoadState

Description

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

Returns

Type: int
Description: One of the values listed in hjconst.h under Document Load States.

Parameters

Param 1:

Type: HANDLE
Description: The window at the document whose state is to be queried.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
GetOwningAppName

Function: GetOwningAppName

Description

Determines the executable name and extension of the application to which a
window belongs.

Returns

Type: string
Description: the executable name and extension of the application which owns
the window.

Parameters

Param 1:

Type: handle
Description: The window to test for its owning application.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
ProcessSayAppWindowOnFocusChange

Function: ProcessSayAppWindowOnFocusChange

Description

All FocusChangedEvent logic for testing and speaking the application window
during a focus change are located in this function.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: The application window of the focus window received by
FocusChangedEvent.
Include: Required

Param 2:

Type: handle
Description: The focus window received by FocusChangedEvent.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
ProcessSayFocusWindowOnFocusChange

Function: ProcessSayFocusWindowOnFocusChange

Description

All FocusChangedEvent logic for testing and speaking the focus window during a
focus change are located in this function.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The name of the real window of the focus window received by
FocusChangedEvent.
Include: Required

Param 2:

Type: handle
Description: The focus window received by FocusChangedEvent.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
ProcessSayRealWindowOnFocusChange

Function: ProcessSayRealWindowOnFocusChange

Description

All FocusChangedEvent logic for testing and speaking the real window during a
focus change are located in this function.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: The application window of the focus window received by
FocusChangedEvent.
Include: Required

Param 2:

Type: handle
Description: The real window of the focus window received by
FocusChangedEvent.
Include: Required

Param 3:

Type: string
Description: The name of the real window of the focus window received by
FocusChangedEvent.
Include: Required

Param 4:

Type: handle
Description: The focus window received by FocusChangedEvent.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
RegisterWindowMessage

Function: RegisterWindowMessage

Description

Returns

Type: int
Description: A system-wide unique identifier for the message.

Parameters

Param 1:

Type: string
Description: String to be registered as a defined windows message.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
Scripting Standards

Freedom Scientific BLV
May 2004

This document contains a set of standards which is required for all script
submissions to Freedom Scientific. Because failure to comply with these
standards results in scripts which contain bugs, suffer from degraded
performance, or which are not localizable to multiple languages, all script
submissions are required to conform to the following standards before they are
considered for acceptance.
	* Define all Script constants and globals in the .jsh file. The only
exceptions to this are constants or globals which must be strictly local to
the current script file and which should not be exposed to other script files.
	* Define all messages to be spoken in the .jsm file and use only the message
name in the .jss file.
	* Define all strings used for comparison or for identification in the .jsm
file and use only the constant string in the .jss file. Also, comment the
string in the .jsm file explaining to the localizer where in the program to
find the text in the comparison or where the identification string is used.
	* Define all window names and classes in the .jsm file and use only the
defined constant representing the name or class in the .jss file.
	* Define all strings which consist of variables formatted to a specific
pattern in the .jsm file. Each variable should use a variable placeholder in
the formatted message. Use FormatString or SayFormattedMessage in the .jss
file to format the message.
	* In the .jsm file, for each message with replaceable parameters, document
all replaceable parameters with comments explaining the information that goes
into the replaceable parameters.
	* Document each function and script in the .jsd file and make sure that for
each function or script, the synopsis, description, and any parameters or
return types are well documented. Be sure that the Synopsis and Description
fields for scripts contain appropriate text to be spoken for Keyboard Help.
	* Do not attach the SPACEBAR or any alphanumeric keys to scripts. If special
behavior is required for these keys then use KeyPressedEvent instead of
attaching scripts to them.
	* Use the SayString function only as a debugging tool during scripting, and
do not use it to speak anything in the finished product.
	* Do not use braces ("{" and "}") to simulate keystrokes.
	* Structure your code so that it tests and executes in the most efficient
manner possible. Be especially careful when adding code to frequently-run
events that your code does not introduce unnecessary sluggishness.
	* Where possible, use window or object information as opposed to screen
information. Use the JAWS or Invisible cursors to obtain information only when
no other method will work. In this case, the Invisible cursor should always be
used unless the JAWS cursor is required to perform the job because the
Invisible cursor cannot.
	* Never use SpeechOff as a means to temporarily suppress speech output. If
speech must be suppressed for specific purposes, then a global variable may be
used for the suppression.
	* Always respect the active cursor when defining behavior in a script or
function. Do not break the functionality of the JAWS or Invisible cursor.
Li>Always consider whether the behavior you are scripting for should regard
the status of the user buffer or the menu state as special or exceptional
cases and code accordingly.
	* Always script so that the user's speech output configuration is respected
and always honor speech and sound scheme functionality for controls and for
text properties.
	* Keep all global variables up to date. If you overwrite a function which has
global variables, be sure to update the necessary variables before returning
from the function.
	* When overwriting the behavior of an existing function or script, overwrite
for the specific circumstance, then call the default for all non-overwritten
circumstances. Wherever possible, do not simply copy the entire default
function or script to your script file and then add exception cases, since
doing so will render your code obsolete if the default code changes. Always
use the same name for your script or function as is used by the default script
or function.
	* Use event-driven code where appropriate. For instance, in lists or trees
where first-letter navigation is possible, make sure that any code for
outputting speech during navigation uses appropriate event-driven code such as
SayHighlightedText (called by NewTextEvent), ActiveItemChangedEvent, or
ValueChangedEvent instead of key-driven code like SayNextLine or SayPriorLine.
	* If overwriting the functionality of a keystroke native to the application,
be sure to evaluate whether or not the keystroke should be passed through to
the application in the event that conditions do not meet any test code in the
script and then code accordingly. Assign a constant to the key name you want
to pass through and make the constant name meaningful so that it explains the
keystroke's functionality. For example, do not use ksAltI, use ksIgnoreButton.
This makes it easier for localizers to identify the keystroke, which may have
been changed in a localized version of the application.
	* If overwriting the functionality of a key combination already defined in
the Default.jkm file, do not make any entry in the application-specific .jkm
file for the key combination.
	* Make sure that hot key help includes all new non-application and
non-standard windows key maps added to the .jkm file.
	* Make sure that ScriptFileName outputs relevant information for the current
application and script file.
	* Do not output any special messages for scripts attached to native Windows
keystrokes.
	* Make sure that the appropriate information (application window information,
real window information, and focus window information) is spoken when focus
changes. Eliminate any double-speaking and speak the relevant changes.
	* Make sure that SayWindowPromptAndText speaks the same information about the
focus window as was spoken when the window gained focus. In addition,
SayWindowPromptAndText must temporarily toggle on training mode when speaking
the focus window so that training information can be spoken when appropriate.
	* When designing help messages to be shown in the virtual viewer, place a
statement at the top of the virtual viewer telling the user where they are. In
the case where the help screen lists commands in a layer, state what key was
pressed to start the layer. If a list of commands and their associated
keystrokes is to be displayed, always make each command in the list a  link.
For each command link, follow the format which describes the command first and
then shows the keystroke. Any more general information should be shown in
paragraph form and must not contain links. Always end each virtual help screen
with a message telling the user how to close the virtual viewer. This message
may or may not be a link.
	* When scripting for special behavior, script both for speech and for Braille
behaviors.
	* Do not break any currently existing features or intended functionality!

The following are guidelines for writing and formatting code so that it can be
most easily maintained. The development staff at Freedom Scientific thanks you
very much for following these guidelines when writing your code.
	* Write self-documenting code by using meaningful script, function, variable,
and constant names. Self-documenting code is much easier to understand,
maintain, and debug.
	* Modularize code so that your scripts or functions do not become large and
unwieldy. It is much more time-efficient to maintain and debug modular,
smaller scripts and functions than to step through a large section of code
line-by-line.
	* Capitalize script, function, variable, and constant names so that JAWS
reads them in a recognizable manner. This is best accomplished by either
capitalizing the individual "words" of the name, or by using underscore ("_")
to separate the component "words" of the name. This will make the name easier
to understand when reading the code with JAWS.
	* Use Hungarian notation for variable and constant names. Precede handle
variable names with "h," string variable names with "s," integer variable
names with "i," and object variable names with "o." To expand on this
convention, precede global variable names with "g," so that (for instance) a
global integer variable name is preceded with "gi." When naming constants,
precede window names with "wn," and window classes with "wc." Be consistent
with your convention and choose a meaningful convention if an appropriate one
does not already exist. Using this type of notation makes it easier to
instantly know what type of variable is being used without having to refer
back to the declaration list.
	* If a message that is being spoken is declared as a constant rather than a
message, precede it with "msg" so that it is clear that it is not on-screen
text.
	* Because the compiler does not allow for nested c-format comments, do not
use c-format comments ("/*" "*/") to comment code. Instead, use semicolon
(";"). This will make it easier to use c-format comments as a temporary means
of commenting out code since the scripter will not need to look for already
existing c-format comment markers inside of the code to be temporarily
commented out.
	* When defining local variables, place "var" on a line by itself at the left
margin and then place each succeeding local variable on a line by itself
indented one tab stop. This makes the variable list easy to read through
quickly and to modify by adding or deleting items.
	* Place all level-0 statements at the left margin and indent once using tab
(not spaces) for each level. Line up the matching components of If-Else-EndIf
statements and of While-EndWhile statements. When an If or While statement
contains compound conditions, place each condition on a line by itself. Align
the operator for each line of the compound test with the If, the ElIf, or the
While statement. Following this convention makes it easy to find code blocks
both when using Braille and when using indentation announcement.
	* Please comment your code judiciously. If the code itself is
self-documenting, then comments are unnecessary. If, however, you are coding
in a specific manner or using a particular technique to avoid causing a
specific problem, and if the reasons for using the technique you chose are not
readily apparent by simply reading the code, please state this information in
your comments. Remember that your code and comments may be read by anyone, so
please keep the comments professional and appropriate for all readers.

----------
FS Braille Display API

Description

FSBrlDspAPI provides a high-level API for communicating with Freedom
Scientific's current line of Braille displays.

Installation Instructions

FSBrlDspAPI.DLL should be installed into the Windows system directory as a
shared component.  The DLL contains an accurate version resource.  You should
never install an older version of this DLL on top of one that already exists
in the System directory.

FSBrlDspAPI supports displays connected via serial or USB.  USB connections
require the existance of FSBRLDSP.SYS for Windows 2000/XP and FSBRLD98.SYS for
Windows 98 or ME.

The Focus Braille display requires Firmware 1.05 or later in order to function
properly with USB.

DLL Functions

	* fbOpen
	* fbClose
	* fbConfigure
	* fbWrite
	* fbGetCellCount
	* fbGetDisplayName
	* fbGetFirmwareVersion
	* fbBeep
	* fbSetVariBraille

Note: All functions support GetLastError to obtain more information about the
cause of errors. Standard Windows error codes are used exclusively.

----------
fbBeep

Description

Sounds the speaker on the Focus display. Note: This function only works on the
Focus.

Usage

FSBRLAPI BOOL WINAPI fbBeep(HANDLE hDisplay);

Parameters

HANDLE hDisplay

A handle  previously obtained from fbOpen.

Returns

BOOL: TRUE on success, FALSE on failure.

----------
fbClose

Description

Closes the display

Usage

FSBRLAPI BOOL WINAPI fbClose(HANDLE hDisplay);

Parameters

HANDLE hDisplay

hDisplay - a handle  previously obtained from fbOpen.

Returns

BOOL: TRUE on success, FALSE on failure.

----------
fbConfigure

Description

Configures the Focus 2 to return extended key events.

Example to identify Focus 2:
if (strcmp(displayName, "Focus") == 0 && '3' <= fwVersion[0]){ // Is Focus 2 }

See fbGetDisplayName and fbGetFirmwareVersion.

Usage

FSBRLAPI BOOL WINAPI fbConfigure(HANDLE hDevice,BYTE byValue);

Parameters

HANDLE hDevice

A handle previously obtained from fbOpen.

BYTE byValue

byValue - configuration bit flags, currently only the value of 0x02 (configure
extended keys) is supported.

Returns

BOOL: TRUE on success, FALSE on failure.

----------
fbGetCellCount

Description

Obtains the number of cells on the display.

Usage

FSBRLAPI int WINAPI fbGetCellCount(HANDLE hDisplay);

Parameters

HANDLE hDisplay

A handle  previously obtained from fbOpen.

Returns

INT: The number of cells on the display, 0 if error.

----------
fbGetDisplayName

Description

Obtains the name of the display

Usage

FSBRLAPI BOOL WINAPI fbGetDisplayName(HANDLE hDisplay,LPSTR lpszName, int
nMaxChars);

Parameters

HANDLE hDisplay

A handle  previously obtained from fbOpen.

LPSTR lpszName

lpszName - buffer to receive the name of the display

INT nMaxChars

nMaxChars - space available in lpszName.  This should be set to at least 16.

Returns

BOOL: TRUE on success, FALSE on failure.

----------
fbGetFirmwareVersion

Description

Obtains the firmware version

Usage

FSBRLAPI BOOL WINAPI fbGetFirmwareVersion(HANDLE hDisplay,LPSTR
lpszVersion,int nMaxChars);

Parameters

HANDLE hDisplay

A handle  previously obtained from fbOpen.

LPSTR lpszVersion

lpszVersion - buffer to receive the version info

INT nMaxChars

nMaxChars - space available in lpszVersion.  This should be set to at least
16.

Returns

BOOL: TRUE on success, FALSE on failure.

----------
fbOpen

Description

Initializes display for communications

Usage

FSBRLAPI HANDLE WINAPI fbOpen(LPCSTR lpszPort,HWND hwndNotify,UINT
umsgNotify);

Parameters

LPCSTR lpszPort

lpszPort-  indicates the port to which a Braille display is connected. it
should be the name of a Communications port e.g. COM1, or USB. If this
parameter is NULL or contains an empty string, the system will search for a
display, first trying USB and then trying com ports (COM1 through COM4).

HWND hwndNotify

hwndNotify - the handle of a window to which braille display input and
disconnect information should be posted.

UINT umsgNotify

umsgNotify - a Windows message number which should be used when posting
messages.

Returns

HANDLE: On success, this function returns a handle to the opened Display.  On
failure, it returns INVALID_HANDLE_VALUE.

Messages

the hwndNotify and umsgNotify passed in to fbOpen are used to notify the
application of events related to the display.  The event type is indicated in
wParam and the event details in lParam.  The event types currently defined are
FB_DISCONNECTED which means that the display has been disconnected, FB_INPUT
which indicates that a key or button on the display has been pressed or
released, and FB_EXT_KEY which indicates a Focus 2 extended key was pressed or
released. FB_DISCONNECTED provides no additional information in lParam. The
lParam of FB_INPUT should be cast to a LPBYTE and processed as a sequence of
four bytes, the details of which are described below. The lParam of FB_EXT_KEY
is an extended key state bit mask value also described below. The FB_EXT_KEY
message is only received if the Focus 2 has been configured for extended keys.
See fbConfigure.

Key Event

	* byte0=3 (3 indicates a key event)
	* BYTE1=Braille keys.
	* BYTE2=assorted keys.
	* BYTE3= GDF keys.

BYTE 1: Braille keys (1=key down, 0=key up).
Bit Description Supported Displays
0 Braille dot 1 key Focus (1 & 2)
1 Braille dot 2 key Focus (1 & 2)
2	Braille dot 3 key Focus (1 & 2)
3 Braille dot 4 key Focus (1 & 2)
4 Braille dot 5 key Focus (1 & 2)
5 Braille dot 6 key Focus (1 & 2)
6 Braille dot 7 key Focus (1 & 2)
7 Braille dot 8 key	Focus (1 & 2)

BYTE 2: Assorted keys (1=key down, 0=key up).
Bit Description Supported Displays
0 Left Whiz Wheel press all
1 Right Whiz Wheel press all
2 Left shift key Focus (1 & 2)
3 Right shift key Focus (1 & 2)
4 Left advance bar Focus (1 & 2)
5 Right advance bar Focus (1 & 2)
6 undefined n/a
7 Braille spacebar Focus (1 & 2)

BYTE 3: GDF keys (1=key down, 0=key up).
Bit Description Supported Displays
0 Left GDF button Focus
1 Right GDF button Focus
2-3 undefined n/a
4 Left Bumper Bar Up Focus 2 configured for extended keys (80 cell only)
5	Left Bumper Bar Down Focus 2 configured for extended keys (80 cell only)
6	Right Bumper Bar Up Focus 2 configured for extended keys (80 cell only)
7	Right Bumper Bar Down Focus 2 configured for extended keys (80 cell only)

Cursor Router Buttons

	* BYTE0=4 (4 indicates cursor router button)
	* BYTE1=button number 0-40
	* BYTE2: state (1=key down, 0=key up).
	* BYTE3:row (0=bottom, 1=top).

BYTE 2: state

Bit 0 is set to 1 when the button is pressed, and 0 when the button is
released. This is the same for all displays.

BYTE 3: row

This byte denotes the router button row number. The default is 0, which
indicates the 1st row.  Currently there are devices that have one or two rows
hence this value is limited to 0 or 1. In the future there may be more rows.

Whiz Wheels

Note: The "up" direction on the left wheel is away from the operator. The
"down" direction on the right wheel is away from the operator.

	* BYTE0=5 (5 indicates Whiz Wheel)
	* BYTE1=unit number, direction, count.

BYTE 1:
Bit Description	Supported Displays
0-2 Pulses (1-7, number of clicks the wheel was moved) all
3 Direction (0 = up, 1 = down). all
4-5 Whiz Wheel (0 = left, 1 = right). all
6-7 undefined n/a

Extended Keys (Focus 2 configured for extended keys)

Bit masks for 32-bit value (1=key down / 0 = key up):
Bit Mask	Description
0x00000010	Left Rocker Up
0x00000020	Left Rocker Down
0x00000040	Right Rocker Up
0x00000080	Right Rocker Down

All other bits are reserved and set to zero.

----------
fbSetVariBraille

Description

Sets the firmness of dots on the display

Usage

FSBRLAPI BOOL WINAPI fbSetVariBraille(HANDLE hDisplay,BYTE byFirmness);

Parameters

HANDLE hDisplay

A handle  previously obtained from fbOpen.

BYTE byFirmness

byFirmness - a value between 0 and 255.  Larger values make the dots more
pronounced.

Returns

BOOL: TRUE on success, FALSE on failure.

----------
fbWrite

Description

Writes information in Braille on the display

Usage

FSBRLAPI BOOL WINAPI fbWrite(HANDLE hDisplay,int nStart,int nLen,LPBYTE
lpbyDots);

Parameters

HANDLE hDisplay

hDisplay - a handle  previously obtained from fbOpen.

INT nStart

nStart - a 0-based offset from the beginning of the display at which to begin
writing.

INT nLen

nLen - the number of cells to write.

LPBYTE lpbyDots

lpbyDots - an array of dot patterns nLen bytes long.  Each byte of this
pattern represents Braille dots in the standard notation where bit0
corresponds to dot1, bit 1 to dot2, etc.

Returns

BOOL: TRUE on success, FALSE on failure.  The most likely cause of error is
that the combination of the nStart and nLen parameters are such that more
cells are being output than will fit on the display.

----------
HighWord

Function: HighWord

Description

retrieves the high-order word from the specified value

Returns

Type: Int
Description: The high-order word from the specified value

Parameters

Param 1:

Type: Int
Description: Specifies the value to be converted.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
IsReadWordInContextValid

Function: IsReadWordInContextValid

Description

The ReadWordInContext script is intended to be used in dialog such as
Spellchecker, Find, Replace, etc. where the dialog refers to text in a
document.

Returns

Type: Int
Description: true if in a dialog where the ReadWordInContext script should be
allowed to run, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:

----------
LowWord

Function: LowWord

Description

retrieves the low-order word from the specified value

Returns

Type: Int
Description: The low-order word from the specified value

Parameters

Param 1:

Type: Int
Description: Specifies the value to be converted.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
MakeLong

Function: MakeLong

Description

creates a LONG value by concatenating the specified values

Returns

Type: Int
Description: The return value is a LONG value.

Parameters

Param 1:

Type: Int
Description: Specifies the low-order word of the new value.
Include: Required

Param 2:

Type: Int
Description: Specifies the high-order word of the new value.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
UseDocumentServerReadingFunctionality

Function: UseDocumentServerReadingFunctionality

Description

The window first must be determined.  If the mouse or JAWS cursor was the last
to move, then the window at the mouse or JAWS cursor is used.  Otherwise, the
current focus window is utilized.  The window is then tested to see if it is a
type that can be handled by the FSDOM.

Returns

Type: int
Description: TRUE if FSDOM can handle the window, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
AppWillNotSpeakEvent

Function: AppWillNotSpeakEvent

Description

Produces the "Cannot speak in Restricted Mode" message when authorization is
either not found or inaccurate.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: the name of the application that will not speak in restricted
mode.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AutoFinishEvent

Function: AutoFinishEvent

Description

The function is invoked when the application is closed by loosing focus when
F4 is pressed. It also gets performed when the application is switched from or
looses focus, as with ALT+TAB.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AutoStartEvent

Function: AutoStartEvent

Description

When the application is started this event gets performed.  It also gets
performed when the application is switched to or gets focus, as with ALT+TAB.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetAppFileName

Function: GetAppFileName

Description

Determines the file name of the active application program or an active
component of that program that was subsequently executed. These file names are
the actual program files that are executed by Windows. The file name of the
application is used when naming script files.

Returns

Type: String
Description: Provides a filename.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetAppFilePath

Function: GetAppFilePath

Description

The GetAppFilePath is used to get the fully qualified path name of the
currently running application. When used in combination with GetFileDate, the
results can be used to surmise an application version.

Returns

Type: String
Description: A string containing the fully qualified path name of the
currently running application. This includes drive, directory, file name, and
extension.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetAppTitle

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

Type: String
Description: The string is the title of the application.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFixedProductVersion

Function: GetFixedProductVersion

Description

GetFixedProductVersion gets the application's fixed product version.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The path of the program for which you want the information. You
can get the path by using GetAppFilePath.
Include: Required

Param 2:

Type: Int
Description: Type the variable to receive the major version value.
Include: Required
* Returns data by reference

Param 3:

Type: Int
Description: Type the variable to receive the minor version value.
Include: Required
* Returns data by reference

Param 4:

Type: Int
Description: Type the variable to receive the update version value.
Include: Required
* Returns data by reference

Param 5:

Type: Int
Description: Type the variable to receive the build number value.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
GetLotusProgramVersion

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

Type: Int
Description: An integer specifying the major version of the Lotus Notes
program.

Parameters

Param 1:

Type: string
Description: The path of the Lotus Notes program for which you want the
version. You can get the path by using GetAppFilePath.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
GetLotusVersionInfoString

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.

Returns

Type: String
Description: The requested string.

Parameters

Param 1:

Type: string
Description: The path of the Lotus Notes program for which you want the
information. You can get the path by using GetAppFilePath.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
GetProgramVersion

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

Type: Int
Description: An integer specifying the major version of the specified program.

Parameters

Param 1:

Type: string
Description: The path of the program for which you want the version. You can
get the path by using GetAppFilePath.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetVersionInfoString

Function: GetVersionInfoString

Description

GetVersionInfoString gets a requested string from the version table of an
application.

Returns

Type: String
Description: The requested string.

Parameters

Param 1:

Type: string
Description: The path of the program for which you want the information. You
can get the path by using GetAppFilePath.
Include: Required

Param 2:

Type: string
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayAppVersion

Script: SayAppVersion

Description

Useful if you are running multiple versions of an application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayProgramComments

Script: SayProgramComments

Description

Useful if you are running multiple versions of an application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGetCurrentTranslatorMode

Function: BrailleGetCurrentTranslatorMode

Description

Queries the active braille translator to see if it supports modes.  If it does
then the function gets the current mode setting.

Returns

Type: Int
Description: current mode of the braille translator if it supports modes, -1
otherwise.  The first mode is always 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
BrailleGetTranslatorModeCount

Function: BrailleGetTranslatorModeCount

Description

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

Returns

Type: Int
Description: number of modes if braille translator supports modes, 0
otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
BrailleGetTranslatorModeName

Function: BrailleGetTranslatorModeName

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.

Returns

Type: String
Description: copy of the braille translator mode name from the braille
translator, empty string otherwise.

Parameters

Param 1:

Type: Int
Description: The index of the mode name desired - the index starts at 0.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
BrailleSetTranslatorMode

Function: BrailleSetTranslatorMode

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

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

Parameters

Param 1:

Type: Int
Description: The index of the desired mode - the index starts at 0.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
BrailleGetCellCount

Function: BrailleGetCellCount

Description

this function returns the number of cells on the installed and active Braille
display.

Returns

Type: Int
Description: The number of cells.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGetDeviceInfo

Function: BrailleGetDeviceInfo

Description

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

Returns

Type: Int
Description: true if a Braille Display is found, False otherwise.

Parameters

Param 1:

Type: String
Description: Driver name.
Include: Required
* Returns data by reference

Param 2:

Type: String
Description: Display Name.
Include: Required
* Returns data by reference

Param 3:

Type: String
Description: Port String.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGetStatusCellCount

Function: BrailleGetStatusCellCount

Description

Returns the number of status cells on the currently attached Braille display.

Returns

Type: Int
Description: The number of status cells, or 0 if no Braille display is
connected.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleInUse

Function: BrailleInUse

Description

Checks to see if a Braille display is in use.

Returns

Type: Int
Description: TRUE if Braille display is being used, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleAltTab

Script: BrailleAltTab

Description

Allows you to control the Braille display.  Passes the alt tab key combination
to the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleControlLeftMouseClick

Script: BrailleControlLeftMouseClick

Description

Does a control left mouse click at the point of the Braille cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
BrailleEnter

Script: BrailleEnter

Description

Lets you control the Braille display. Passes the Enter key to the application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleEscape

Script: BrailleEscape

Description

Lets you control the Braille display. Passes the Escape key to the
application.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGetTypeKeysMode

Function: BrailleGetTypeKeysMode

Description

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

Returns

Type: int
Description: TRUE if TypeKeys mode is enabled, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleRightMouseClick

Script: BrailleRightMouseClick

Description

Useful for activating context menus.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleRouting

Script: BrailleRouting

Description

Press a routing button over any cell to click there.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSelectBlock

Script: BrailleSelectBlock

Description

Start by using the keyboard to find the first character you want to select.
Move the Braille Cursor to the last character and press this keystroke.   All
text must be visible on screen and in the same document window.   The mouse
pointer will select the text between the start and end position.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
BrailleSelectTextClearValues

Function: BrailleSelectTextClearValues

Description

Turns off Braille selection and returns the cursor shape to its default.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSelectText

Script: BrailleSelectText

Description

The first time This keystroke is invoked, the coordinates of the beginning of
the block of text to be selected are stored and remarked with a eight DOT
Braille cursor. Then the user can move the Braille line to the end of the
block and press the keystroke again to select. This action can be canceled by
using the ClearValues script.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSetTypeKeysMode

Function: BrailleSetTypeKeysMode

Description

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

Returns

Type: int
Description: TRUE if the value is properly set, FALSE otherwise.

Parameters

Param 1:

Type: int
Description: Set to TRUE to enable TypeKeys mode, FALSE otherwise.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleShiftTab

Script: BrailleShiftTab

Description

Performs a SHIFT+TAB and lets you control the Braille display.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSupportsTypeKeysMode

Function: BrailleSupportsTypeKeysMode

Description

Returns

Type: int
Description: TRUE if the mode is supported, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleTab

Script: BrailleTab

Description

Performs a tab and allows you control the Braille display.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPActivateTaskList

Script: FHPActivateTaskList

Description

Activate JAWS task list.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleEnter

Script: FHPBrailleEnter

Description

Simulate enter on Braillex EL displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleEscape

Script: FHPBrailleEscape

Description

Simulate escape on Braillex EL displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleManager

Script: FHPBrailleManager

Description

Activate BDAS configuration manager.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleSelectText

Script: FHPBrailleSelectText

Description

Select text using the routing keys.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleShiftTab

Script: FHPBrailleShiftTab

Description

Simulate a SHIFT+TAB on Braillex EL displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleTab

Script: FHPBrailleTab

Description

Simulate a tab on Braillex EL display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPToggleCursorMode

Script: FHPToggleCursorMode

Description

Toggle between PC and JAWS cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHP_RunJAWSManager

Script: FHP_RunJAWSManager

Description

Run JAWS managers.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SALModeButton

Function: SALModeButton

Description

Speaks the appropriate "SAL mode" representation of a braille cell

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: number	Number of the braille cell to speak
Include: Required

Param 2:

Type: Int
Description: 0 to speak the character at the cell location, 1 to speak and
spell the word at the location.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later

----------
SetBrailleControlKeyProcessingMode

Function: SetBrailleControlKeyProcessingMode

Description

Puts the braille keyboard driver into control key processing mode. In that
state the next key pressed is sent to the OS as a control character.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Non-zero to turn the mode on, zero to turn mode off.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
SetBraillePanSize

Function: SetBraillePanSize

Description

Sets the amount of text that is passed to the braille logic that the user can
pan around.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: 0-Display current line. 1-Start at current line and go to the end
of the current paragraph.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later

----------
SetBrailleTriKeyProcessingMode

Function: SetBrailleTriKeyProcessingMode

Description

Puts the braille keyboard driver into "tri-key" processing mode. In that state
the next three numeric keys are combined into an ascii code and sent to the
OS.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Non-zero to turn the mode on, zero to turn mode off.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later

----------
SetOneHandedBrailleMode

Function: SetOneHandedBrailleMode

Description

Changes the braille keyboard driver one-handed mode state.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Non-zero to turn one-handed mode on, zero to turn mode off.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
ToggleTypeKeysMode

Script: ToggleTypeKeysMode

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.20 and later

----------
BrailleAutoAdvanceModeActive

Function: BrailleAutoAdvanceModeActive

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

Type: int
Description: TRUE if the feature is active, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
BrailleAutoAdvanceMode

Function: BrailleAutoAdvanceMode

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

Type: int
Description: TRUE if the feature was successfully enabled or disabled.

Parameters

Param 1:

Type: int
Description: Set to TRUE to turn the mode on, FALSE to turn it off.
Include: Required

Param 2:

Type: int
Description: optional duration between pans, if not supplied, defaults to the
value of OPT_BRL_AUTOADVANCE_INTERVAL.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
BrailleAutoAdvance

Script: BrailleAutoAdvance

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 or a routing button is pressed. 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

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later
	2. PAC Mate 3.00 and later

----------
BrailleBottom

Script: BrailleBottom

Description

In Line mode, switches to the Braille cursor and goes to the bottom of the
window. When in a structured line, pans right to show the end of the line.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleMoveLeft

Script: BrailleMoveLeft

Description

Moves the Braille display to the left without leaving the current line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleMoveRight

Script: BrailleMoveRight

Description

Moves the Braille display to the right without leaving the current line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleNextLine

Function: BrailleNextLine

Description

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

Returns

Type: Int
Description: "WAS_SUCCESSFUL" = 1,"WAS_NOT_SUCCESSFUL" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleNextLine

Script: BrailleNextLine

Description

If Structured mode is active, forces the braille display into line mode and
moves the braille cursor to the next line. If line mode is active, moves the
braille cursor to the next line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BraillePanLeft

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

Param 1:

Type: Int
Description: true to move to the last segment of the prior line if no more
text to the left, default value is false.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BraillePanLeft

Script: BraillePanLeft

Description

If there is more text to the left on the current line, display it. If not,
display the final segment of the previous line.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BraillePanRight

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

Param 1:

Type: Int
Description: true to move to the first segment of the next line if no more
text to the right, default value is false.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BraillePanRight

Script: BraillePanRight

Description

If there is more text to the right on the current line, display it.  If not,
display the first segment of the next line.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BraillePriorLine

Function: BraillePriorLine

Description

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

Returns

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BraillePriorLine

Script: BraillePriorLine

Description

If Structured mode is active, forces the braille display into line mode and
moves the braille cursor to the prior line. If line mode is active, moves the
braille cursor to the prior line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleRoutingButton

Function: BrailleRoutingButton

Description

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

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: The 1-based number of a braille cell.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleTop

Script: BrailleTop

Description

In Line mode, switches to the Braille cursor and goes to the top of the
window. When in a structured line, pans left to the beginning of the line.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ContinuousBraillePanNext

Function: ContinuousBraillePanNext

Description

Displays the next set of braille data in continuous braille mode

Returns

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later

----------
ContinuousBraillePanPrev

Function: ContinuousBraillePanPrev

Description

Displays the previous set of braille data in continuous braille mode

Returns

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later

----------
DecreaseBrailleAutoAdvanceSpeed

Script: DecreaseBrailleAutoAdvanceSpeed

Description

This script decreases the Braille Auto Advance speed by half a second to a
minimum of ten seconds.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later
	2. PAC Mate 3.00 and later

----------
FHPBrailleNextLine

Script: FHPBrailleNextLine

Description

Move Braille display to next line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBraillePanLeft

Script: FHPBraillePanLeft

Description

Move Braille display left.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBraillePanRight

Script: FHPBraillePanRight

Description

Move Braille display right.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBraillePriorLine

Script: FHPBraillePriorLine

Description

Move Braille display to previous line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleShowWindowsBottom

Script: FHPBrailleShowWindowsBottom

Description

Show last line of window and speak it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleShowWindowsTop

Script: FHPBrailleShowWindowsTop

Description

Show first line of window and speak it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleSpeechNextLine

Script: FHPBrailleSpeechNextLine

Description

Move cursor to next line and read it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleSpeechPanLeft

Script: FHPBrailleSpeechPanLeft

Description

Move Braille left and read it when leaving the line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleSpeechPanRight

Script: FHPBrailleSpeechPanRight

Description

Move Braille right and read it when leaving the line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleSpeechPriorLine

Script: FHPBrailleSpeechPriorLine

Description

Move cursor to previous line and read it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBraillexEL1D

Script: FHPBraillexEL1D

Description

Function on easy access bar one step down.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBraillexEL1L

Script: FHPBraillexEL1L

Description

Function on easy access bar one step left.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBraillexEL1R

Script: FHPBraillexEL1R

Description

Function on easy access bar one step right.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBraillexEL1U

Script: FHPBraillexEL1U

Description

Function on easy access bar one step up.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBraillexEL2D

Script: FHPBraillexEL2D

Description

Function on easy access bar two steps down.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBraillexEL2L

Script: FHPBraillexEL2L

Description

Function on easy access bar two steps left.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBraillexEL2R

Script: FHPBraillexEL2R

Description

Function on easy access bar two steps right.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBraillexEL2U

Script: FHPBraillexEL2U

Description

Function on easy access bar two steps up.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPcursordown

Script: FHPcursordown

Description

Simulate a cursor down in PC mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPcursorleft

Script: FHPcursorleft

Description

Simulate a cursor left in PC mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPcursorright

Script: FHPcursorright

Description

Simulate a cursor right in PC mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPcursorup

Script: FHPcursorup

Description

Simulalte a cursor up in PC mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPLineRouting

Script: FHPLineRouting

Description

Route Braille display to selected line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPRoutingAux

Script: FHPRoutingAux

Description

Route cursor to status (not used).

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPRouting

Script: FHPRouting

Description

Route cursor to Braille cell.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FSLeftRockerDown

Script: FSLeftRockerDown

Description

If the active cursor is not following the display, the display will move away
from it.  Otherwise, the active cursor will follow.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FSLeftRockerUp

Script: FSLeftRockerUp

Description

If the active cursor is not following the display, the display will move away
from it.  Otherwise, the active cursor will follow.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FSRightRockerDown

Script: FSRightRockerDown

Description

The Braille display and active cursor will both move at the same time, leaving
the Braille display at the position of the active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FSRightRockerUp

Script: FSRightRockerUp

Description

The Braille display and active cursor will both move at the same time, leaving
the Braille display at the position of the active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IncreaseBrailleAutoAdvanceSpeed

Script: IncreaseBrailleAutoAdvanceSpeed

Description

This script increases the Braille Auto Advance speed by half a second to a
maximum of half a second.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later
	2. PAC Mate 3.00 and later

----------
LeftFocusWhizWheelDown

Script: LeftFocusWhizWheelDown

Description

Moves down when List Mode is on, or forwards through controls by use of tab.
Also performs line, sentence, paragraph or display navigation.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later
	2. PAC Mate 1.10 and later

----------
LeftFocusWhizWheelUp

Script: LeftFocusWhizWheelUp

Description

Moves up when List Mode is on, or backward through controls by use of Shift
tab.  Also performs line, sentence, paragraph or display navigation.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later
	2. PAC Mate 1.10 and later

----------
LeftWhizWheelDown

Script: LeftWhizWheelDown

Description

Select the movement unit by pressing down on the whiz wheel.  Each wheel's
settings are stored and remembered separately, as they are locally in your
note taker.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
LeftWhizWheelUp

Script: LeftWhizWheelUp

Description

Select the movement unit by pressing down on the whiz wheel.  Each wheel's
settings are stored and remembered separately, as they are locally in your
note taker.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RightFocusWhizWheelDown

Script: RightFocusWhizWheelDown

Description

Moves down when List Mode is on, or forwards through controls by use of tab.
Also performs line, sentence, paragraph or display navigation.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later
	2. PAC Mate 1.10 and later

----------
RightFocusWhizWheelUp

Script: RightFocusWhizWheelUp

Description

Moves up when List Mode is on, or backward through controls by use of Shift
tab.  Also performs line, sentence, paragraph or display navigation.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later
	2. PAC Mate 1.10 and later

----------
RightWhizWheelDown

Script: RightWhizWheelDown

Description

Select the movement unit by pressing down on the whiz wheel.  Each wheel's
settings are stored and remembered separately, as they are locally in your
note taker.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RightWhizWheelUp

Script: RightWhizWheelUp

Description

Select the movement unit by pressing down on the whiz wheel.  Each wheel's
settings are stored and remembered separately, as they are locally in your
note taker.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleAddBrlCursorLine

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

Type: Int
Description: True if successful, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
BrailleAddFocusItem

Function: BrailleAddFocusItem

Description

Used from within the BrailleBuildLine function to add the contents of the
current control to the data to be shown on the Braille display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleAddFocusLine

Function: BrailleAddFocusLine

Description

Used from within the BrailleBuildLine function to add the contents of the
current line to the data to be shown on the Braille display.

Returns

Type: Int
Description: True if successful, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleAddFrame

Function: BrailleAddFrame

Description

Used to Braille a frame.

Returns

Type: Int
Description: TRUE if the frame exists and was added, FALSE otherwise.

Parameters

Param 1:

Type: String
Description: the name of the frame  to be added.
Include: Required

Param 2:

Type: Int
Description: attributes of text to include.
Include: Optional

Param 3:

Type: Int
Description: text color of text to include.
Include: Optional

Param 4:

Type: Int
Description: background color of text to include.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
BrailleAddString

Function: BrailleAddString

Description

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

Returns

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: String
Description: Text to be added.
Include: Required

Param 2:

Type: Int
Description: 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.
Include: Required

Param 3:

Type: Int
Description: 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.
Include: Required

Param 4:

Type: Int
Description: Combination of the ATRIB_xxx values from HJCONST.JSH that
indicate the attributes of the characters in this string.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleAddTextBetween

Function: BrailleAddTextBetween

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

Type: Void

Parameters

Param 1:

Type: Int
Description: the starting coordinate on the line.
Include: Required

Param 2:

Type: Int
Description: the ending coordinate on the line.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleBuildLine

Function: BrailleBuildLine

Description

Build the line to be displayed on the Braille display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleBuildStatus

Function: BrailleBuildStatus

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleClearMessage

Function: BrailleClearMessage

Description

This function clears the current Flash message.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: if TRUE and the message time is set to infinite, the message will
not be cleared, it defaults to FALSE.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 2.50 and later
	2. JAWS 6.00 and later

----------
BrailleDescribeFont

Script: BrailleDescribeFont

Description

This is the font style name and character size of the character corresponding
to the routing key pressed.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleDescribeItem

Script: BrailleDescribeItem

Description

Similar to screen sensitive help.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleG2StringLength

Function: BrailleG2StringLength

Description

Determines the length of the translation to grade two Braille of a given
string.

Returns

Type: Int
Description: The length of the given string when translated to grade two
Braille.

Parameters

Param 1:

Type: string
Description: String of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGetCursorDots

Function: BrailleGetCursorDots

Description

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

Returns

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

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGetStateString

Function: BrailleGetStateString

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

Type: String
Description: the state string.

Parameters

Param 1:

Type: Int
Description: the state flags.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGetSubtypeDisplayName

Function: BrailleGetSubtypeDisplayName

Description

This function returns the type display name as defined in the app or default
jbs for the specified type constant. Note that if no value is defined for a
standard window type's displayname key in the jbs, the default string spoken
for that type will be returned.

Returns

Type: String
Description: the type display name.

Parameters

Param 1:

Type: Int
Description: either one of the wt_typeCode constants or a constant
representing a custom control ie wt_custom_control_base+customControlCode.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGetSubtypeString

Function: BrailleGetSubtypeString

Description

This function returns the type string as defined in the app or default jbs for
the specified type constant.

Returns

Type: String
Description: the type string

Parameters

Param 1:

Type: Int
Description: either one of the wt_typeCode constants or a constant
representing a custom control ie wt_custom_control_base+customControlCode.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGrade2ExpandCurrentWord

Script: BrailleGrade2ExpandCurrentWord

Description

This is only relevant when Braille grade two translation is active. When this
option is turned on, the current line will be in grade two, with the exception
of the current word, which will remain expanded. This option is On by default.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleIsMessageBeingShown

Function: BrailleIsMessageBeingShown

Description

This function Determines if a Flash message is currently being shown on the
display, ie if the user has called BrailleMessage or internal code has called
ShowMessage.

Returns

Type: int
Description: true or false.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later
	2. PAC Mate 2.50 and later

----------
BrailleIsStructuredLine

Function: BrailleIsStructuredLine

Description

Determines if the Braille line is a structured line. Only applicable when
using Structured mode.

Returns

Type: Int
Description: True if line is structured, false otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleLine

Function: BrailleLine

Description

Sends the current line of text to a Braille display. It is automatically
executed ten times per second and does not need to be routinely used by a
script. It can be used in a script after the BrailleString function has been
used and you are ready to display a line of information from the desktop.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleMessageRepeatLast

Function: BrailleMessageRepeatLast

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

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

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
BrailleMessage

Function: BrailleMessage

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

Type: void

Parameters

Param 1:

Type: string
Description: sMessage the message to send.
Include: Required

Param 2:

Type: int
Description: if non-zero, the message will be appended to the existing
message, if 0, the message will replace the current message.
Include: Optional

Param 3:

Type: int
Description: the time in milliseconds to keep the message on the display
before restoring the display to the prior content.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
BrailleRefresh

Function: BrailleRefresh

Description

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

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSetCursorDots

Function: BrailleSetCursorDots

Description

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

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The DOT numbers used to show the active cursor. For example,
"78."
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSetStatusCells

Function: BrailleSetStatusCells

Description

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

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Characters to be placed in the Braille status cells.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleString

Function: BrailleString

Description

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

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: String to be sent to the Braille display.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSwitchTransLanguage

Function: BrailleSwitchTransLanguage

Description

Returns

Type: Int
Description: true on success, false otherwise.

Parameters

Param 1:

Type: String
Description: language abbreviation, eg enu, deu, etc.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
BrlTranslateWindowText

Function: BrlTranslateWindowText

Description

If the text is Grade 2, it will back translate. Otherwise, it will translate
the text to grade 2.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Enter the handle of the window whose text is to be translated.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ContainsBrlText

Function: ContainsBrlText

Description

Checks the window you specify to ensure that it indeed contains Braille text.

Returns

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: The handle of the window to be checked.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
FocusGDBHelpMessage

Script: FocusGDBHelpMessage

Description

Provides help for the user definable General Display Buttons located between
the advance bars on your Focus Braille display. Press this keystroke to learn
about using Keyboard Manager to assign commands to these buttons.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
FocusGeneralDisplayButtons

Script: FocusGeneralDisplayButtons

Description

The General Display buttons are located between the advance bars on the Focus
Braille displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GetBrailleCellColumn

Function: GetBrailleCellColumn

Description

Retrieves the screen column at which the specified Braille cell is located.

Returns

Type: Int
Description: The horizontal pixel location of the cell.

Parameters

Param 1:

Type: Int
Description: The number of the Braille cell of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetBrailleCellRow

Function: GetBrailleCellRow

Description

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

Returns

Type: Int
Description: The vertical pixel location of the cell.

Parameters

Param 1:

Type: Int
Description: The number of the Braille cell of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetLastBrailleRoutingKey

Function: GetLastBrailleRoutingKey

Description

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

Returns

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

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NextBrailleString

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1 (another string was available for display),
"WAS_NOT_SUCCESSFUL" = 0 (another string was not displayed).

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PointNeedsMarking

Function: PointNeedsMarking

Description

This function determines if a character at a point on the screen should be
marked. It is only called if the JCF Option OPT_BRL_CHECK_EXT_MARKING is on.

Returns

Type: Int
Description: True or False

Parameters

Param 1:

Type: Int
Description:
Include: Required

Param 2:

Type: Int
Description:
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
PriorBrailleString

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

Type: Int
Description: WAS_SUCCESSFUL = 1 (another string was available for
display),"WAS_NOT_SUCCESSFUL = 0 (another string was not displayed).

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RepeatLastFlashMessage

Script: RepeatLastFlashMessage

Description

This script shows the last Flash message sent to the Braille display for the
duration of the original message. This script may be called even with Flash
messages disabled.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SetBrailleMessageStatusText

Function: SetBrailleMessageStatusText

Description

This function enables the user to define the text to be shown either in the
status area of the Braille display or prepended to a Flash message during the
display of a Flash message. If the string parameter is not supplied or is
NULL, the default status message as defined in the jcf file will be restored
and used.

Returns

Type: int
Description: TRUE if the function succeeds, false otherwise.

Parameters

Param 1:

Type: string
Description: sStatusMsg the text to be shown in the status cell area of the
display or prepended to a Flash message if the display has no status cells.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later
	2. PAC Mate 2.50 and later

----------
ShouldSetTranslation

Function: ShouldSetTranslation

Description

Certain windows can automatically input in Grade 2 Braille.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Enter the handle for the focus point.
Include: Required

Param 2:

Type: Int
Description: enter TRUE to disregard the state of the TransAllow setting,
FALSE to respect its setting.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ToggleContinuousBraille

Script: ToggleContinuousBraille

Description

When on, continuous Braille mode displays text in paragraph sized blocks
instead of line sized blocks. The text block begins at the first character on
the line containing the cursor and ends at the paragraph boundary. The
paragraph boundary is shown as a blank line  while new line characters are
shown as a space.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later

----------
TranslateText

Script: TranslateText

Description

If the document you are in is in Grade two Braille, this will translate the
file to Computer Braille and reset your keyboard so you can type in the new
translation mode.  For example, if the file was Grade Two and you translated
it to Computer Braille, your keyboard would be set for you to type in Computer
Braille.  Only do this when you are finished with a document, such as after
you finish typing in the body of a message and wish to send it.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
BrailleChangeCursorShape

Script: BrailleChangeCursorShape

Description

If the Braille cursor is set to DOT 7 and 8, then DOTS 7 and 8 will be raised
to indicate the location of the cursor. If all DOTS cursor is set, then all
the DOTS in the cell are raised to indicate the cursor position.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleGrade2Translation

Script: BrailleGrade2Translation

Description

Turns On or Off grade 2 Translation when you desire.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: index of the braille display routing button assigned to this
script
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleLineCursorShapeOff

Script: BrailleLineCursorShapeOff

Description

Turns off all DOTS or DOTS 7 and 8 in the Braille display depending on what
mode you are in as far as the cursor is concerned.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSet6DOTS

Script: BrailleSet6DOTS

Description

This keystroke sets six DOTS mode on a Braille display  Usful for older
Braille displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSet8DOTS

Script: BrailleSet8DOTS

Description

Sets 8 DOT mode on the Braille display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSet8PixelsPerSpace

Script: BrailleSet8PixelsPerSpace

Description

Show one empty space on the Braille display for each 8 pixels of blank space
on the screen.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleSetUnlimittedPixelsPerSpace

Script: BrailleSetUnlimittedPixelsPerSpace

Description

Shows one empty space on the Braille display for every group of consecutive
blank pixels on the screen, regardless of how wide that space is.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggle8DOTS

Script: BrailleToggle8DOTS

Description

8 DOT Braille indicates upper case and highlighted text with DOTS 7 and 8.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggle8PixelsPerSpace

Script: BrailleToggle8PixelsPerSpace

Description

With 8 pixels per space, you will see the formatting as it appears on the
screen or in the document.  With unlimited pixels per space, you will see all
the text conveniently lined up on your display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleBrailleLineMode

Script: BrailleToggleBrailleLineMode

Description

Line mode is useful for reviewing text on the current line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleCharactersAndAttributes

Script: BrailleToggleCharactersAndAttributes

Description

When attributes is selected, the Braille display shows the attributes of each
character instead of the actual characters. The patterns for each attribute
are set up in the Configuration Manager. When characters is selected the
Braille display shows regular characters.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleMarking

Script: BrailleToggleMarking

Description

Attributes are marked with DOTS seven and eight.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleMode

Script: BrailleToggleMode

Description

Line mode displays text that is on the current line. Structured mode allows
having information from different parts on the screen displayed in a single
Braille line. Attributes mode shows the attributes of the current line. Speech
History mode displays whatever was spoken.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleSpeechHistory

Script: BrailleToggleSpeechHistory

Description

Speech History mode allows you to review what was previously spoken.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleSpeechInterrupt

Script: BrailleToggleSpeechInterrupt

Description

Toggles speech interrupt for the Braille device.  When Speech interrupt is
toggled to the on position, JAWS will interrupt the Braille display when a new
action is performed so that the Braille display reflects the new action.  This
is similar to the Speech interrupt for normal speech without Braille.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleToggleTableHeaders

Script: BrailleToggleTableHeaders

Description

Toggles whether to display row titles, column titles, both or none.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
BrailleTurnMarkingOff

Script: BrailleTurnMarkingOff

Description

Turns Off displaying of the markings in DOTS seven and eight.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
BrailleVerbosity

Function: BrailleVerbosity

Description

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

Returns

Type: String
Description: description of value to be displayed as value of Braille
Verbosity.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPAttributSettings

Script: FHPAttributSettings

Description

Opens a dialog to control attribute presentation on your Braillex display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBraille2DTogglePCMode

Script: FHPBraille2DTogglePCMode

Description

On a Braillex 2D-Screen toggle between PC mode and Navigation mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBraille2DToggleReadingMode

Script: FHPBraille2DToggleReadingMode

Description

On a Braillex 2D-Screen toggle between Combined and Navigation mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleActiveCursorTracking

Script: FHPBrailleActiveCursorTracking

Description

Toggle Braille cursor tracking.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleKeyBrailleMode

Script: FHPBrailleKeyBrailleMode

Description

Switch to Braille mode on Braillex EL displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleKeyBrailleSpeechMode

Script: FHPBrailleKeyBrailleSpeechMode

Description

Switch to combined speech mode on Braillex EL displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleKeyNavigationMode

Script: FHPBrailleKeyNavigationMode

Description

Switch to Navigation mode on a Braillex EL display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleKeyPCMode

Script: FHPBrailleKeyPCMode

Description

Switch to PC mode on Braillex EL displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleKeyReadingMode

Script: FHPBrailleKeyReadingMode

Description

Switch to combined mode on Braillex EL displays.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleKeySpeechMode

Script: FHPBrailleKeySpeechMode

Description

Switch to Speech mode on Braillex EL display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleLineMode

Script: FHPBrailleLineMode

Description

Switch to Line mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleSettings

Script: FHPBrailleSettings

Description

Opens a dialog to change settings of your Braillex display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FHPBrailleShowAllMarking

Script: FHPBrailleShowAllMarking

Description

Braille mark all.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleShowBoldMarking

Script: FHPBrailleShowBoldMarking

Description

Braille mark bold.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleShowHighlightMarking

Script: FHPBrailleShowHighlightMarking

Description

Braille mark highlight.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleShowItalicMarking

Script: FHPBrailleShowItalicMarking

Description

Braille mark italic.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleShowUnderlineMarking

Script: FHPBrailleShowUnderlineMarking

Description

Braille mark underline.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleStructuredMode

Script: FHPBrailleStructuredMode

Description

Switch to Structured mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleToggle68DOTS

Script: FHPBrailleToggle68DOTS

Description

Toggle between 8 DOT and 6 DOT Braille.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleToggleAttributeDown

Script: FHPBrailleToggleAttributeDown

Description

Toggle backward through attribute marking.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleToggleAttributeUp

Script: FHPBrailleToggleAttributeUp

Description

Toggle forward through attribute marking.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleToggleCharactersAndAttributes

Script: FHPBrailleToggleCharactersAndAttributes

Description

Toggle between character and attribute mode.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleToggleCursorShape

Script: FHPBrailleToggleCursorShape

Description

Toggle between underline and block cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleToggleVertical

Script: FHPBrailleToggleVertical

Description

Show vertical display overlay on horizontal line for BDAS and non 2D displays
only.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPBrailleTurnMarkingOff

Script: FHPBrailleTurnMarkingOff

Description

Turn Braille marking off.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FHPWorkingMode

Script: FHPWorkingMode

Description

Opens a dialog to select one out of three working modes for your Braillex
display.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
GetBrailleMode

Function: GetBrailleMode

Description

Can be either line, structured, or speech box modes.

Returns

Type: Int
Description: An integer value that signifies the current Braille mode of JFW.
The return value is equal to one of the Braille Mode constants defined in
HJConst.jsh.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PressLeftFocusWheel

Script: PressLeftFocusWheel

Description

List Mode affects both wheels simultaneously.  When sentence, paragraph and
display panning navigation is possible, pressing this wheel only affects those
settings for the left whiz wheel.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
PressLeftWhizWheel

Script: PressLeftWhizWheel

Description

Pressing this wheel only affects those settings for the left whiz wheel.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PressRightFocusWheel

Script: PressRightFocusWheel

Description

List Mode affects both wheels simultaneously.  When sentence, paragraph and
display panning  navigation is possible, pressing this wheel only affects
those settings for the right whiz wheel.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
PressRightWhizWheel

Script: PressRightWhizWheel

Description

Pressing this wheel only affects those settings for the right whiz wheel.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetBrailleMode

Function: SetBrailleMode

Description

Can be either line, structured, or speech box modes.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: The mode that you wish to set.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetBrailleVerbosity

Script: SetBrailleVerbosity

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ToggleGrade

Script: ToggleGrade

Description

Allows use of Grade two input in document and notes windows.  You can enter
your text in Grade two Braille and then press the keystroke for TranslateText
if you wish to translate it back to Grade 0.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
ToggleOutputType

Function: ToggleOutputType

Description

This function cycles the spoken or Brailled output type message length from 0
(don't speak/Braille, 1 use long messages or 2 use short messages). You
determine whether the cycling affects Speech or Braille by using the second
optional parameter. If this parameter is not specified the function defaults
to cycling the Speech message length.

Returns

Type: int
Description: the new value

Parameters

Param 1:

Type: int
Description: the Output Type to cycle.
Include: Required

Param 2:

Type: int
Description: 0 speech, 1 Braille
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
UseSecondaryBrailleLanguage

Function: UseSecondaryBrailleLanguage

Description

This function sets JAWS braille support to use either its primary or secondary
braille language.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: to use the secondary braille language, FALSE to use the primary
language
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 4.00 and later

----------
WhizWheelsOnOff

Script: WhizWheelsOnOff

Description

Press to turn the whiz wheels on and off.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
CloseListBox

Script: CloseListBox

Description

Sends an ALT+UP ARROW to the system, which usually closes a list.  When in an
edit control moves to and says the prior sentence.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ControlCanBeChecked

Function: ControlCanBeChecked

Description

Determines whether or not the current control can be checked.

Returns

Type: Int
Description: 0 if cannot be checked or 1 can be checked.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ControlIsChecked

Function: ControlIsChecked

Description

Determines whether or not the current control is checked.

Returns

Type: Int
Description: Returns true or false.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
dtpGetSubfield

Function: dtpGetSubfield

Description

This function will return an index number (1-4) that indicates what date\time
subfield the specified control is on.  If it cannot determine what the
subfield is, it will return 0.

Returns

Type: Int
Description: The index of the subfield (1-4).  If it cannot determine what the
subfield is, it will return 0.

Parameters

Param 1:

Type: Handle
Description: The Date/Time picker control. 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GetControlAttributes

Function: GetControlAttributes

Description

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

Returns

Type: Int
Description: 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.

Parameters

Param 1:

Type: Int
Description: if TRUE, do not use cached MSAA state
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetControlName

Function: GetControlName

Description

Gets the name of the current control.

Returns

Type: String
Description: The name of the control.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCurrentItem

Function: GetCurrentItem

Description

Retrieves the 1-based index of the item in a ListView or combobox which has
focus.  This function expands the functionality of lvGetFocusItem to also work
for comboboxes.

Returns

Type: Int
Description: index number of the Current item.

Parameters

Param 1:

Type: Handle
Description: The ListView or combobox window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
GetCurrentListViewItemName

Function: GetCurrentListViewItemName

Description

Attempts to determine and return the name of the current item in the focus
listview, based on whether the listview is customized, and on whether MSAA is
being used for the focus listview.

Returns

Type: string
Description: the name of the current item in the focus listview.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
GetHotKey

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

Type: String
Description: The first underlined character if one exists, otherwise an empty
string.

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetItemCount

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

Type: Int
Description: the count of items.

Parameters

Param 1:

Type: Handle
Description: The window of interest.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GetListViewText

Function: GetListViewText

Description

Retrieves into a string the text for all items in a listview.

Returns

Type: string
Description: The retrieved list text.

Parameters

Param 1:

Type: handle
Description: the window handle of a listview.
Include: Required

Param 2:

Type: int
Description: a 32-bit flagset specifying which columns to retrieve, default is
all if flagset is 0.
Include: Optional

Param 3:

Type: int
Description: Boolean specifying whether an empty list item should be skipped
in the output. A list item can be empty if only certain columns are specified
for output and not all listview items contain text in the specified columns.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
GetProgressBarInfo

Function: GetProgressBarInfo

Description

This function returns the handle, the name and the value of the first progress
bar in the current real window.

Returns

Type: handle
Description: the progress bar handle if any.

Parameters

Param 1:

Type: string
Description: the prompt of the Progress Bar.
Include: Required
* Returns data by reference

Param 2:

Type: string
Description: the value of the progress bar as a percentage.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetTreeViewLevel

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

Type: Int
Description: The level of the item with focus.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HotKeyHelpDefaultLoopHelper

Function: HotKeyHelpDefaultLoopHelper

Description

This function is called by HotKeyHelpDefaultLoop to return the text from the
dialog windows.

Returns

Type: String
Description: The string to post to the user buffer.

Parameters

Param 1:

Type: Handle
Description: The handle of the starting child window in the dialog.
Include: Required

Param 2:

Type: Int
Description: True if intro is to be spoken, false otherwise.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
HotKeyHelpDefaultLoop

Function: HotKeyHelpDefaultLoop

Description

Loops through all the controls in a dialog box, reads the underlined hot key
letter associated with the control.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
lvGetCRC

Function: lvGetCRC

Description

This function is used for listview customization. This hex value corresponds
to the [Listview Options] section's keys.

Returns

Type: string
Description: a unique hex string for a listview.

Parameters

Param 1:

Type: handle
Description: the handle to the listview.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
lvGetFocusItem

Function: lvGetFocusItem

Description

Retrieves the 1-based index of the item in a ListView which has focus.
(Superceeded by GetCurrentItem.)

Returns

Type: Int
Description: index number of the focused item.

Parameters

Param 1:

Type: Handle
Description: The ListView window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
lvGetItemCount

Function: lvGetItemCount

Description

Retrieves a count of items in a ListView.  (Superceeded by GetItemCount.)

Returns

Type: Int
Description: the count of items.

Parameters

Param 1:

Type: Handle
Description: The ListView window
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
lvGetItemRect

Function: lvGetItemRect

Description

Gets the bounding rectangle of the specified item in a listview.

Returns

Type: Int
Description: TRUE if the bounding rectangle is successfully retrieved.

Parameters

Param 1:

Type: Handle
Description: The handle of the ListView of interest.
Include: Required

Param 2:

Type: Int
Description: index of the item desired.
Include: Required

Param 3:

Type: Int
Description: The left edge of the bounding rectangle after the function is
called.
Include: Required

Param 4:

Type: Int
Description: The right edge of the bounding rectangle after the function is
called.
Include: Required

Param 5:

Type: Int
Description: The top edge of the bounding rectangle after the function is
called.
Include: Required

Param 6:

Type: Int
Description: The bottom edge of the bounding rectangle after the function is
called.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
lvGetItemState

Function: lvGetItemState

Description

Detects the current selection state of the item within a ListView.  Refer to
the return states for more information.

Returns

Type: Int
Description: 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.

Parameters

Param 1:

Type: Handle
Description: window handle of the List View.
Include: Required

Param 2:

Type: Int
Description: 1-based index of the item.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
lvGetItemText

Function: lvGetItemText

Description

Retrieves the text of an item in a ListView.  Does not work for Owner-Drawn
items.

Returns

Type: String
Description: The contents of the requested item.

Parameters

Param 1:

Type: Handle
Description: to the window containing a ListView.
Include: Required

Param 2:

Type: Int
Description: 1-based index of the item in the ListView of interest.
Include: Required

Param 3:

Type: Int
Description: 1-based index of the column of interest (applies only to
multicolumn ListViews).
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
lvGetUserDefinedItemText

Function: lvGetUserDefinedItemText

Description

If a listview has been customized to speak or be Brailled in a particular
manner, this function retrieves the text of the specified item as rendered by
the customization.

Returns

Type: string
Description: the user selected column headers and column data.

Parameters

Param 1:

Type: handle
Description: the handle to the listview.
Include: Required

Param 2:

Type: int
Description: a 1-based item whose text you want.
Include: Required

Param 3:

Type: int
Description: use 0 for speech customization, 1 for Braille customization, if
not present, assumes speech.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
lvIsCustomized

Function: lvIsCustomized

Description

this function determines if the listview pointed to by the hwnd parameter has
a speech or Braille customization defined for it, this includes whether there
is a default customization defined as well. This function is used to determine
whether or not SayHighlightedText should be used to speak a listview or
whether custom code should be executed.

Returns

Type: int
Description: true or false.

Parameters

Param 1:

Type: handle
Description: the handle to the window.
Include: Required

Param 2:

Type: int
Description: 0 for speech, 1 for Braille, if not present, defaults to speech.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
lvSelectItem

Function: lvSelectItem

Description

Select an item within the listview.

Returns

Type: Int
Description: True indicates that the item was selected successfully and FALSE
indicates that the action failed.

Parameters

Param 1:

Type: Handle
Description: Handle of list view.
Include: Required

Param 2:

Type: Int
Description: 1-based index of the item.
Include: Required

Param 3:

Type: Int
Description: 1 to select, 0 to unselect.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
lvSetFocusItem

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

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: The window containing a ListView.
Include: Required

Param 2:

Type: Int
Description: The 1-based index of the row in the ListView to receive focus.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
MoveSliderPos

Function: MoveSliderPos

Description

Moves the position of a slider control to a different value.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: windows handle to the slider control that you want to change the
value on.
Include: Required

Param 2:

Type: Int
Description: the PERCENTAGE to increase from the present position too.
Negative percentages decrease the slider control.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
MoveToControl

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

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: Handle of window containing the control of interest.
Include: Required

Param 2:

Type: Int
Description: ID of desired control.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToFirstSdmControl

Function: MoveToFirstSdmControl

Description

Moves the focus to the first SDM control that is found within a dialog box.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MoveToNextSdmControl

Function: MoveToNextSdmControl

Description

Moves the focus to the next SDM control within a dialog box.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
OpenListBox

Script: OpenListBox

Description

Sends an ALT+DOWN ARROW to the system which usually opens a list.  When in an
edit control moves to and says the next sentence.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PositionInGroup

Function: PositionInGroup

Description

returns a string describing the focused control's selection's position
relative to the collection, eg 1 of 10 items etc.

Returns

Type: String
Description: of the format 1 of 10 or 0 items.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ReadListviewColumn

Script: ReadListviewColumn

Description

This keystroke reads the current column header  (from 1 to 9, 0 for colum 10)
for the currently selected multi-column listview item.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SayControlExWithMarkup

Function: SayControlExWithMarkup

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

Returns

Type: Int
Description: 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.

Parameters

Param 1:

Type: Handle
Description: The window handle of the control.
Include: Required

Param 2:

Type: String
Description: 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.
Include: Optional

Param 3:

Type: String
Description: The control type.  This parameter is assigned an Output Mode of
OT_CONTROL_TYPE.
Include: Optional

Param 4:

Type: String
Description: The control state.  This parameter is assigned an Output Mode of
OT_ITEM_STATE.
Include: Optional

Param 5:

Type: String
Description: 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.
Include: Optional

Param 6:

Type: String
Description: 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.
Include: Optional

Param 7:

Type: String
Description: 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.
Include: Optional

Param 8:

Type: String
Description: 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.
Include: Optional

Param 9:

Type: String
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
SayControlEx

Function: SayControlEx

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

Type: Int
Description: 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.

Parameters

Param 1:

Type: Handle
Description: The window handle of the control.
Include: Required

Param 2:

Type: String
Description: 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.
Include: Optional

Param 3:

Type: String
Description: The control type.  This parameter is assigned an Output Mode of
OT_CONTROL_TYPE.
Include: Optional

Param 4:

Type: String
Description: The control state.  This parameter is assigned an Output Mode of
OT_ITEM_STATE.
Include: Optional

Param 5:

Type: String
Description: 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.
Include: Optional

Param 6:

Type: String
Description: 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.
Include: Optional

Param 7:

Type: String
Description: 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.
Include: Optional

Param 8:

Type: String
Description: 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.
Include: Optional

Param 9:

Type: String
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayControlInformation

Function: SayControlInformation

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 six parameters, five of which are
string parameters.  The first parameter is the window handle of the control
that is to be spoken. The next five parameters include one parameter for each
component of a control's description.  Each string parameter has a
corresponding Output Mode.  The 5 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, and String strContainerType =
OT_CONTROL_TYPE.  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.

Returns

Type: Int
Description: 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.:Optional

Parameters

Param 1:

Type: String
Description: 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.
Include: Optional

Param 2:

Type: String
Description: The control type.  This parameter is assigned an Output Mode of
OT_CONTROL_TYPE.
Include: Optional

Param 3:

Type: String
Description: The control state.  This parameter is assigned an Output Mode of
OT_ITEM_STATE
Include: Optional

Param 4:

Type: String
Description: 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.
Include: Optional

Param 5:

Type: String
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayControl

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.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCurrentAccessKey

Script: SayCurrentAccessKey

Description

Says the underlined letter in the name or prompt for the current item in a
dialog box or window.  Use this letter with the Alt key to choose that item
even when it does not have the focus.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayLVItemCheckStatus

Function: SayLVItemCheckStatus

Description

If the listview contains checkable items, determines and says the check status
of the listview item which has focus in the list.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: The listview handle.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
SayTreeViewItem

Function: SayTreeViewItem

Description

Speaks the active tree view item without the level or position information.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SayTreeViewLevel

Function: SayTreeViewLevel

Description

This function announces new tree view levels as they are encountered. 0
represents the left-most level of the tree view. This is usually the highest
level in a tree view

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: If true, only announces position information if treeview level
has changed since previous call to SayTreeViewLevel.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayTVFocusItemExpandState

Function: SayTVFocusItemExpandState

Description

Announces the open/closed state of the focus item of a treeview.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: The handle of a treeview.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 3.00 and later
	2. JAWS 7.00 and later

----------
SDMGetCurrentControl

Function: SDMGetCurrentControl

Description

Retrieves the ID of the control on which the active cursor is positioned
inside an SDM dialog box.

Returns

Type: Int
Description: The ID of the SDM control in which the active cursor is
positioned, or 0 if not inside an SDM dialog box.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SDMGetFirstControl

Function: SDMGetFirstControl

Description

Obtains the control ID of the first dialog option in an SDM dialog box. It can
provide the control ID that is needed by the SDMSayControl function.

Returns

Type: Int
Description: Provides control ID.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the window handle for the SDM dialog box. The GetFocus function is often used
to provide the handle.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SDMGetFocus

Function: SDMGetFocus

Description

Used to get the control ID of the active dialog option or control in an SDM
dialog box. This function is most often used as a parameter for the
SDMSayWindowTypeAndText function to provide it with a control ID.

Returns

Type: Int
Description: Provides The control ID within an SDM dialog.

Parameters

Param 1:

Type: Handle
Description: Use the GetFocus function to obtain the handle of the current SDM
window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SDMGetLastControl

Function: SDMGetLastControl

Description

Provides the control ID for the last option in an SDM dialog box. It can
provide the control ID that is needed by the SDMSayControl function.

Returns

Type: Int
Description: Provides control ID.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the window handle of the SDM dialog. The GetFocus function is often used to
provide the handle.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SDMGetNextControl

Function: SDMGetNextControl

Description

Obtains the control ID for the next option in an SDM dialog box. It can
provide the control ID that is needed by the SDMSayControl function.

Returns

Type: Int
Description: A control ID is returned when the next control ID is found, 0 is
returned when a control ID does not exist.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the window handle of the SDM dialog box. The GetFocus function is often used
to provide the handle.
Include: Required

Param 2:

Type: Int
Description: Type a variable name or choose a script function that indicates
the control ID for the child window which is the starting point for the script
function in the SDM dialog.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SDMGetPrevControl

Function: SDMGetPrevControl

Description

Provides the control ID for the previous option in an SDM dialog box. It can
provide the control ID that is needed by the SDMSayControl function.

Returns

Type: Int
Description: A control ID is returned when the previous control ID is found, 0
is returned when a control ID does not exist.

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the window handle of the SDM dialog box. The GetFocus function is often used
to provide the handle.
Include: Required

Param 2:

Type: Int
Description: Type a variable name or choose a script function that indicates
the control ID for the child window which is the starting point for the script
function in the SDM dialog.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SDMSayControl

Function: SDMSayControl

Description

Speaks the contents of a child window along with its prompt in an SDM dialog
box. It reads edit fields, list boxes, check boxes, radio buttons, etc. This
function is equivalent to SayControl, but is exclusively designed for SDM
dialog boxes. All child windows in an SDM dialog box have the same window
handle, and the control ID is used to distinguish between the various options
in the dialog box.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Type a variable name or choose a script function that can provide
the window handle for the dialog box. The GetFocus function is often used to
provide the handle.
Include: Required

Param 2:

Type: Int
Description: Type a variable name or choose a script function that can provide
the control ID for the child window which is to be spoken. Various SDM control
ID functions can be used to identify the child window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SDMSayStaticText

Function: SDMSayStaticText

Description

Reads a type of text called static text that may be displayed in an SDM dialog
box. It does not read the text in edit fields, check boxes, and so on, or the
titles or prompts that are often associated with dialog options

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Use the GetFocus function to obtain the handle of the current SDM
window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SDMSayWindowTypeAndText

Function: SDMSayWindowTypeAndText

Description

Used with SDM windows to read the window title (when one is present), the
window type, the contents in the window, and related information about the
current dialog box option. When this function is used, it marks the text it
reads so that the SayNonHighlightedText and SayHighlightedText functions do
not repeat the same information when they are triggered. This function is only
used with SDM windows and not with regular dialog windows.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Type the name of a variable or choose a script function that
provides the handle of the window that is to be read. The GetFocus function is
often used to provide the handle of the SDM window.
Include: Required

Param 2:

Type: Int
Description: Use the SDMGetFocus function to provide the control ID for the
active child window of the dialog box.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetCurrentItem

Function: SetCurrentItem

Description

Moves focus to a specified item in a ListView or combobox.  Note that this
does not bring the ListView or combobox window into focus, it simply causes a
specific item to be the focused item in that window.  This function expands
the functionality of lvSetFocusItem to also work for comboboxes.

Returns

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: The window containing a ListView or combobox.
Include: Required

Param 2:

Type: Int
Description: The 1-based index of the row in the ListView or combobox to
receive focus.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
SpeakNewStateAfterFocusChange

Function: SpeakNewStateAfterFocusChange

Description

Call this function to speak a state change if it is necessary to delay the
speaking of the state. For instance, if clicking on a checkbox which is not in
focus, you should schedule this function to speak the new state after the
focus has changed.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
SpeakProgressBarInfo

Function: SpeakProgressBarInfo

Description

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: Enter TRUE to speak the progress bar's prompt text.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
tbGetItemRect

Function: tbGetItemRect

Description

Gets the bounding rectangle of the specified item in a ToolBar.

Returns

Type: Int
Description: TRUE if the bounding rectangle is successfully retrieved.

Parameters

Param 1:

Type: Handle
Description: The handle of the ToolBar of interest.
Include: Required

Param 2:

Type: Int
Description: index of the item desired.
Include: Required

Param 3:

Type: Int
Description: The left edge of the bounding rectangle after the function is
called.
Include: Required
* Returns data by reference

Param 4:

Type: Int
Description: The right edge of the bounding rectangle after the function is
called.
Include: Required
* Returns data by reference

Param 5:

Type: Int
Description: The top edge of the bounding rectangle after the function is
called.
Include: Required
* Returns data by reference

Param 6:

Type: Int
Description: The bottom edge of the bounding rectangle after the function is
called.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
tbGetItemState

Function: tbGetItemState

Description

Retrieves the state of an item on a ToolBar.  Refer to the return states for
more information.

Returns

Type: Int
Description: a combination of state flags.   See the TBSTATE_* values in
HJCONST.JSH.

Parameters

Param 1:

Type: Handle
Description: window handle of the ToolBar.
Include: Required

Param 2:

Type: Int
Description: 1-based index of the item.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
tbGetItemText

Function: tbGetItemText

Description

Retrieves the text of an item in a Toolbar.

Returns

Type: String
Description: The contents of the requested item.  If the item is a graphic,
text will only be returned if that graphic has a JAWS graphic label.

Parameters

Param 1:

Type: Handle
Description: to the window containing a ToolBar.
Include: Required

Param 2:

Type: Int
Description: 1-based index of the item in the ToolBAr.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
tvCollapse

Function: tvCollapse

Description

Collapses the currently selected treeview node.

Returns

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: The TreeView window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
tvExpand

Function: tvExpand

Description

Expands the currently selected treeview node.

Returns

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: The TreeView window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
tvGetFocusItemExpandState

Function: tvGetFocusItemExpandState

Description

Use this function to get the expanded/collapsed state of the focus item in a
treeview. This function does not use MSAA for determining the treeview item
state.

Returns

Type: int
Description: -1 if the focus treeview item has no children, 1 if the focus
treeview item is expanded, 0 if the focus treeview item is collapsed.

Parameters

Param 1:

Type: handle
Description: The handle of a treeview.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 3.0 and later
	2. JAWS 7.00 and later

----------
tvGetFocusItemText

Function: tvGetFocusItemText

Description

Retrieves the text of the focus item for a treeview.

Returns

Type: string
Description: The text of the focus item in the tree view.

Parameters

Param 1:

Type: handle
Description: The handle of a treeview.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 3.0 and later
	2. JAWS 7.00 and later

----------
tvGetItemStateImageIndex

Function: tvGetItemStateImageIndex

Description

Use this function to distinguish between the differring state graphics that
may be placed beside items in a tree view.

Returns

Type: int
Description: the state image index for the currently active treeview item.
This value should change as the state graphic changes on the screen.

Parameters

Param 1:

Type: handle
Description: The handle of the treeview window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later
	2. JAWS 5.10 and later

----------
tvSelectNextItem

Function: tvSelectNextItem

Description

Selects the next visible item depending on the current selected item.

Returns

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: The TreeView window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
tvSelectPriorItem

Function: tvSelectPriorItem

Description

Selects the prior visible item depending on the current selected item.

Returns

Type: Int
Description: TRUE if successful, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: The TreeView window.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 5.10 and later

----------
AboutBox

Script: AboutBox

Description

Brings up the About dialog box for PAC Mate, displaying serial number and
other information.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
CheckAuthScheme

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

Type: Int
Description: 0 if dongle is in place and authorized correctly, error code
otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetAuthCode

Function: GetAuthCode

Description

For versions of JAWS using SENTINEL_LM as the Authorization scheme, this
function obtains the first 7 characters of the JAWS authorization code and
returns the characters as a string.

Returns

Type: string
Description: The first 7 characters of the authorization code, or null if the
authorization code could not be obtained.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
GetAuthLanguageCat

Function: GetAuthLanguageCat

Description

A call to this function determines what languages are authorized for JAWS. The
values are found in HjConst.jsh and start with the prefix AUTHCAT_.

Returns

Type: Int
Description: value for the language category.  The possible values are found
in HjConst.jsh and start with the prefix AUTHCAT_.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetAuthScheme

Function: GetAuthScheme

Description

A call to this function determines what authorization scheme is being used by
JAWS. An empty string indicates no authorization scheme was found.

Returns

Type: String
Description: The authorization scheme currently in use. Authorization schemes
are found in HjConst.jsh and start with the prefix SCHEME_.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetAuthScriptLanguageCat

Function: GetAuthScriptLanguageCat

Description

This function is used by developers of JAWS scripts who are concerned with use
of the dongle.  A flag is returned and execution of code can be based upon a
registered language.

Returns

Type: Int
Description: The value of the language registered in the dongle.  These are
registered in HjConst.jsh with the prefix AUTHCAT_SCRIPT_.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetJFWSerialNumber

Function: GetJFWSerialNumber

Description

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

Returns

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

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetJFWSMACount

Function: GetJFWSMACount

Description

This function returns the SMA count as an integer.

Returns

Type: Int
Description: The SMA count.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetLockingCode

Function: GetLockingCode

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

Type: string
Description: The locking code, or null if the locking code could not be
obtained.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
GetPMProductCategory

Function: GetPMProductCategory

Description

determines if the current product belongs to the TNS or to the BNS category of
PACMate.

Returns

Type: int
Description: PM_Unknown if the category was not determined, PM_ProductTNS or
PM_ProductBNS if the category was determined. See constant definitions in
HJConst.jsh.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later

----------
GetPMProductID

Function: GetPMProductID

Description

This function is called the first time focus is gained, and we store the value
in the global GI_Product_ID.  The possibilities are:  PM_UNKNOWN, PM_BNS OR
PM_TNS.

Returns

Type: Int
Description: the Device ID for the PAC Mate, bns, tns or unknown.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
IsTNS

Function: IsTNS

Description

Useful for determining if the current unit is a TNS to avoid DOT problems.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
FindJAWSHelpFile

Function: FindJAWSHelpFile

Description

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

Returns

Type: String
Description: Full path to the specified JAWS help file.

Parameters

Param 1:

Type: String
Description: Name of the desired help file.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
FindJAWSHomeFile

Function: FindJAWSHomeFile

Description

Retrieves the full path to the specified file in the JAWS home directory.

Returns

Type: String
Description: Full path to the specified JAWS file.

Parameters

Param 1:

Type: String
Description: Name of the desired file.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
FindJAWSPersonalizedSettingsFile

Function: FindJAWSPersonalizedSettingsFile

Description

Retrieves the full path to the specified JAWS personalized settings file. This
will depend in part on the current language; it may also depend on the current
logged-in user.

Returns

Type: String
Description: Full path to the specified JAWS personalized settings file.

Parameters

Param 1:

Type: String
Description: Name of the desired personalized settings file.
Include: Required

Param 2:

Type: Int
Description: TRUE if the file is to be created in the user's personalized
settings directory.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
FindJAWSSettingsFile

Function: FindJAWSSettingsFile

Description

Retrieves the full path to the specified JAWS settings file. This will depend
in part on the current language; it may also depend on the current logged-in
user.

Returns

Type: String
Description: Full path to the specified JAWS settings file.

Parameters

Param 1:

Type: String
Description: Name of the desired settings file.
Include: Required

Param 2:

Type: Int
Description: TRUE if the file is to be created in the user's settings
directory.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
FindJAWSSoundFile

Function: FindJAWSSoundFile

Description

Retrieves the full path to the specified JAWS sound file. This will depend in
part on the current language; it may also depend on the current logged-in
user.

Returns

Type: String
Description: Full path to the specified JAWS settings file.

Parameters

Param 1:

Type: String
Description: Name of the desired settings file.
Include: Required

Param 2:

Type: Int
Description: TRUE if the file is to be created in the user's settings
directory.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
FindJAWSUtilityProgram

Function: FindJAWSUtilityProgram

Description

Retrieves the full path to the specified JAWS utility program.

Returns

Type: String
Description: Full path to the specified JAWS utility program.

Parameters

Param 1:

Type: String
Description: Name of the desired utility program.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
FindWindowsSystemFile

Function: FindWindowsSystemFile

Description

Retrieves the full path to the specified Windows system file.

Returns

Type: String
Description: Full path to the specified WIndows system file.

Parameters

Param 1:

Type: String
Description: Name of the desired file.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetJAWSDirectory

Function: GetJAWSDirectory

Description

Retrieves the full path to the directory in which JAWS is running.

Returns

Type: String
Description: The JAWS drive and directory without a trailing \.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetJAWSHelpDirectory

Function: GetJAWSHelpDirectory

Description

Retrieves the full path to the JAWS help directory currently in use. This
depends on which language is being used.

Returns

Type: String
Description: The JAWS drive and help directory without a trailing \.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later
	2. PAC Mate 1.10 and later

----------
GetJAWSMode

Function: GetJAWSMode

Description

Returns

Type: int
Description: One of the JAWS modes listed in HJConst.jsh.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
GetJAWSSettingsDirectory

Function: GetJAWSSettingsDirectory

Description

Retrieves the full path to the JAWS settings directory currently in use. This
depends on which language is being used.

Returns

Type: String
Description: The JAWS drive and settings directory without a trailing \.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetJAWSUserName

Function: GetJAWSUserName

Description

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

Returns

Type: String
Description: the name of the user currently logged into JAWS.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetJFWLang

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

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

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetJFWVersion

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

Type: Int
Description: 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.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later
	2. PAC Mate 3.0 and later

----------
GetSharedSettingsDirectory

Function: GetSharedSettingsDirectory

Description

Retrieves the full path to the shared settings directory currently in use.
This depends on which language is being used.

Returns

Type: String
Description: The shared drive and settings directory without a trailing \.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetUserSettingsDirectory

Function: GetUserSettingsDirectory

Description

Retrieves the full path to the user settings directory currently in use. This
depends on which language is being used.

Returns

Type: String
Description: The user drive and settings directory without a trailing \.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
IsJFWInstall

Function: IsJFWInstall

Description

Checks to see if JFW is running in Installation mode (with the /install flag).

Returns

Type: Int
Description: TRUE if in install mode, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsUnicodeJAWS

Function: IsUnicodeJAWS

Description

This function determines if the build of JAWS is Unicode or ANSI.

Returns

Type: int
Description: TRUE if JAWS is a Unicode build, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
JAWSWindow

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSWindow

Script: JAWSWindow

Description

Activates the JAWS window, from anywhere else in Windows, so you can read the
online help, change synthesizers, and many other features.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
PathAddExtension

Function: PathAddExtension

Description

Adds a file extension to a path string.

Returns

Type: String
Description: Path with specified extension appended.

Parameters

Param 1:

Type: String
Description: Path to be modified.
Include: Required

Param 2:

Type: String
Description: Extension to be appended.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
PathFindExtension

Function: PathFindExtension

Description

Searches a path for an extension.

Returns

Type: String
Description: Extension, or empty string ("") if not found.

Parameters

Param 1:

Type: String
Description: Path to be searched.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
PathRemoveExtension

Function: PathRemoveExtension

Description

Removes the file extension from a path, if there is one.

Returns

Type: String
Description: Path with extension removed.

Parameters

Param 1:

Type: String
Description: Path to be modified.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
PathRenameExtension

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

Type: String
Description: Path with specified extension appended.

Parameters

Param 1:

Type: String
Description: Path to be modified.
Include: Required

Param 2:

Type: String
Description: Replacement extension.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
ShutDownJAWS

Function: ShutDownJAWS

Description

Closes or quits the JAWS application. The JAWS user is automatically prompted
to confirm the intention to terminate JAWS before speech stops.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ShutDownJAWS

Script: ShutDownJAWS

Description

JAWS cannot speak after it is unloaded.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SwitchRemoteMode

Function: SwitchRemoteMode

Description

Switches the PAC Mate between normal mode and remote mode.  If not in Remote
mode, it is turned on.  Else, if in Remote mode, it is turned off.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 3.0 and later

----------
SwitchRemoteMode

Script: SwitchRemoteMode

Description

Switches the PAC Mate between normal mode and remote mode.  If not in Remote
mode, it is turned on.  Else, if in Remote mode, it is turned off.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 3.00 and later

----------
ActiveItemChangedEvent

Function: ActiveItemChangedEvent

Description

The MSAAMode flag must be set to 2 in the [Options] section of your
application-specific jcf file to enable this function.  This function receives
the following parameters: the handle for the window containing the current
object, the iD of the object, the iD of the child object, the handle of the
previous window, the iD of the previous object, and the iD of the previous
child object.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: the handle of the window containing the current object.
Include: Required

Param 2:

Type: Int
Description: the iD of the current object.
Include: Required

Param 3:

Type: Int
Description: the iD of the current child.
Include: Required

Param 4:

Type: Handle
Description: the handle of the window containing the previous object.
Include: Required

Param 5:

Type: Int
Description: The iD or the previous object.
Include: Required

Param 6:

Type: Int
Description: the iD of the previous child.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ClickObjectByName

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

Type: int
Description: TRUE if the object was found and could be clicked, false
otherwise.

Parameters

Param 1:

Type: HANDLE
Description: The window containing the object of interest
Include: Required

Param 2:

Type: string
Description: The name of the object desired
Include: Required

Param 3:

Type: int
Description: If there is more than one object with this name, which one  is
desired.  This parameter defaults to 1.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
ComAttachEvents

Function: ComAttachEvents

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

Type: int
Description: TRUE if events have been attached, FALSE otherwise.

Parameters

Param 1:

Type: Object
Description: The object for which events are desired
Include: Required

Param 2:

Type: string
Description: The prefix to be added to the name of the event when constructing
the name of the function to be called
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
ComDetachEvents

Function: ComDetachEvents

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

Type: int
Description: TRUE if events have been detached, FALSE otherwise.

Parameters

Param 1:

Type: Object
Description: The object for which events are no longer desired
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
CreateObjectEx

Function: CreateObjectEx

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

Type: Object
Description: The automation object associated with the program.

Parameters

Param 1:

Type: String
Description: Name of the COM class that can return an automation object.
Include: Required

Param 2:

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

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
CreateObject

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

Type: Object
Description: The automation object associated with the program.

Parameters

Param 1:

Type: String
Description: Name of the COM class that can return an automation object.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
DescriptionChangedEvent

Function: DescriptionChangedEvent

Description

This function receives the following parameters: The window handle of the
window containing the current object, The ID number of the Object, The ID
number of the Child Object, The type of the Object, The old Description of the
object, and The current Description of the Object.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The window handle of the window containing the current object.
Include: Required

Param 2:

Type: Int
Description: The ID number of the Object.
Include: Required

Param 3:

Type: Int
Description: The ID number of the Child Object.
Include: Required

Param 4:

Type: Int
Description: The type of the Object.
Include: Required

Param 5:

Type: String
Description: The old Description of the object.
Include: Required

Param 6:

Type: String
Description: The current Description of the object.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
FocusToLink

Function: FocusToLink

Description

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

Returns

Type: int
Description: The number of the link

Parameters

Param 1:

Type: int
Description: The 1-based number of the link to which focus should move.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
GetCurrentLinkIndex

Function: GetCurrentLinkIndex

Description

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

Returns

Type: int
Description: The number of the link

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 8.00 and later

----------
GetCurrentObject

Function: GetCurrentObject

Description

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

Returns

Type: Object
Description: The accessible object at the current cursor location.

Parameters

Param 1:

Type: Int
Description: ID of child.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetFocusObject

Function: GetFocusObject

Description

Uses MSAA to get the object with focus.

Returns

Type: Object
Description: The interface to the Accessible object.

Parameters

Param 1:

Type: Int
Description: ID of child.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetLastMSAAAlertInfo

Function: GetLastMSAAAlertInfo

Description

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

Returns

Type: int
Description: TRUE if there is alert data still in the buffer, FALSE otherwise

Parameters

Param 1:

Type: string
Description: the text of the alert
Include: Required
* Returns data by reference

Param 2:

Type: int
Description: the priority level of the alert, 1 highest, 3 lowest
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
GetListOfObjects

Function: GetListOfObjects

Description

Given a window handle, retrieves the names of all objects contained in that
window.  This function is intended primarily as a tool for script developers
to explore a new aplication and find out the names of objects contained
therein. This info can be used in crafting scripts to use calls to
GetObjectInfoByName.

Returns

Type: String
Description: A delimited list of object names.

Parameters

Param 1:

Type: HANDLE
Description: The window containing the objects of interest
Include: Required

Param 2:

Type: String
Description: Character to be used as the delimiter between object names.  If
not provided, defaults to \007.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
GetNativeOMFromMSAA

Function: GetNativeOMFromMSAA

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

Type: Object
Description: a poihnter to the Application Object.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectAtPoint

Function: GetObjectAtPoint

Description

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

Returns

Type: Object
Description: The accessible object at the given point.

Parameters

Param 1:

Type: Int
Description: ref data.
Include: Required

Param 2:

Type: Int
Description: The x coordinate.
Include: Required

Param 3:

Type: Int
Description: The y coordinate.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectContainerHelp

Function: GetObjectContainerHelp

Description

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

Returns

Type: String
Description: AccDescription property of accessible object's container.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectDescription

Function: GetObjectDescription

Description

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

Returns

Type: String
Description: the MSAA description of the object with focus.

Parameters

Param 1:

Type: Int
Description: if TRUE, always obtains this information via MSAA, even in those
situations where other methods would otherwise be used instead.
Include: Optional

Param 2:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
GetObjectFromEvent

Function: GetObjectFromEvent

Description

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

Returns

Type: Object
Description: the MSAA object.

Parameters

Param 1:

Type: Handle
Description: the window containing the Object.
Include: Required

Param 2:

Type: Int
Description: the id of the object.
Include: Required

Param 3:

Type: Int
Description: the id of the child.
Include: Required

Param 4:

Type: Int
Description:
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectHelp

Function: GetObjectHelp

Description

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

Returns

Type: String
Description: AccDescription property of accessible object.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectInfoByName

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

Type: int
Description: TRUE if function was successful, false on failure.

Parameters

Param 1:

Type: HANDLE
Description: The window containing the object of interest
Include: Required

Param 2:

Type: string
Description: The name of the object desired
Include: Required

Param 3:

Type: int
Description: 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.
Include: Required

Param 4:

Type: int
Description: On return will contain the object's subtype code.
Include: Required
* Returns data by reference

Param 5:

Type: int
Description: On return will contain the object's state flags.  This will be a
combination of Control Attribute identifiers defined in HJCONST.JSH.
Include: Optional
* Returns data by reference

Param 6:

Type: String
Description: On return will contain the object's value.
Include: Optional
* Returns data by reference

Param 7:

Type: String
Description: On return will contain the object's description.
Include: Optional
* Returns data by reference

Param 8:

Type: String
Description: On return will contain the object's HotKey
Include: Optional
* Returns data by reference

Param 9:

Type: string
Description: On return will contain the name of the object that contains this
object.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
getObjectNameFromEvent

Function: getObjectNameFromEvent

Description

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

Returns

Type: String
Description: Object name, help or description (searched in that order).

Parameters

Param 1:

Type: Handle
Description: the window containing the Object.
Include: Required

Param 2:

Type: Int
Description: the id of the object.
Include: Required

Param 3:

Type: Int
Description: the id of the child.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectName

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

Type: String
Description: the name of the object at the position of the active cursor.

Parameters

Param 1:

Type: Int
Description: if TRUE, always obtains this information via MSAA, even in those
situations where other methods would otherwise be used instead.
Include: Optional

Param 2:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetObjectRect

Function: GetObjectRect

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

Type: Int
Description: True if a focus rectangle was found surrounding the object, false
otherwise.

Parameters

Param 1:

Type: Int
Description: the value for the left-hand edge of the focus rectangle
surrounding the object.
Include: Required

Param 2:

Type: Int
Description: the value for the right-hand edge of the focus rectangle
surrounding the object.
Include: Required

Param 3:

Type: Int
Description: the value for the top edge of the focus rectangle surrounding the
object.
Include: Required

Param 4:

Type: Int
Description: the value for the bottom edge of the focus rectangle surrounding
the object.
Include: Required

Param 5:

Type: Int
Description: if TRUE, always obtains this information via MSAA, even in those
situations where other methods would otherwise be used instead.
Include: Optional

Param 6:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectState

Function: GetObjectState

Description

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

Returns

Type: String
Description: The state of the object.

Parameters

Param 1:

Type: Int
Description: if TRUE, always obtains this information via MSAA, even in those
situations where other methods would otherwise be used instead.
Include: Optional

Param 2:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectSubTypeCode

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

Type: Int
Description: The type of the object at the current cursor's location.

Parameters

Param 1:

Type: Int
Description: if TRUE, always obtains this information via MSAA, even in those
situations where other methods would otherwise be used instead.
Include: Optional

Param 2:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectSubtype

Function: GetObjectSubtype

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

Type: String
Description: The subtype of the object at the current cursor's location.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectTypeCode

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

Type: Int
Description: The type of the object at the current cursor's location.

Parameters

Param 1:

Type: Int
Description: if TRUE, always obtains this information via MSAA, even in those
situations where other methods would otherwise be used instead.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectType

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

Type: String
Description: The type of the object at the current cursor's location.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetObjectValue

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

Type: String
Description: the value of the object at the position of the active cursor.

Parameters

Param 1:

Type: Int
Description: if TRUE, always obtains this information via MSAA, even in those
situations where other methods would otherwise be used instead.
Include: Optional

Param 2:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetObject

Function: GetObject

Description

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

Returns

Type: Object

Parameters

Param 1:

Type: String
Description: Program to find.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
GetRichEditDocument

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

Type: Object
Description: A pointer to the ITextDocument interface.

Parameters

Param 1:

Type: Handle
Description: The handle to the window of interest.  It defaults to the window
with focus.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
getRoleText

Function: getRoleText

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

Type: String
Description: The text describing the role.

Parameters

Param 1:

Type: int
Description: The role constant to describe. This should be obtained from the
accRole property of an MSAA object.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
HJDialogObjStateChangeSpoken

Function: HJDialogObjStateChangeSpoken

Description

called by ObjStateChangedEvent to perform any special processing of object
state change occuring in an HJDialog.

Returns

Type: int/true
Description: if any special handling of state change was processed for an
HJDialog, false otherwise.

Parameters

Param 1:

Type: Handle
Description: Handle of the window whose state, or whose child object's state,
has changed.
Include: Required

Param 2:

Type: int
Description: The type of the object.
Include: Required

Param 3:

Type: int
Description: The changed state, which is the difference between the old state
and the current state.
Include: Required

Param 4:

Type: int
Description: The current state.
Include: Required

Param 5:

Type: int
Description: The old state.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 8.10 and later

----------
IE4GetCurrentDocument

Function: IE4GetCurrentDocument

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

Type: Object
Description: An object that represents the HTML document in a given browser
window.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
IsMSAAWindow

Function: IsMSAAWindow

Description

Indicates whether or not JAWS is using MSAA to gather information about the
contents of this window.

Returns

Type: Int
Description: TRUE if MSAA is used for this window, FALSE otherwise.

Parameters

Param 1:

Type: Handle
Description: The window to check
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
JavaObjectChanged

Function: JavaObjectChanged

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

Type: Void

Parameters

Param 1:

Type: String
Description: Java role of object generating change notification.
Include: Required

Param 2:

Type: String
Description: AccessibleContextInfo name.
Include: Required

Param 3:

Type: String
Description: AccessibleContextInfo description.
Include: Required

Param 4:

Type: String
Description: AccessibleValue
Include: Required

Param 5:

Type: String
Description: string of all states applicable to the object.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MSAAGetDialogStaticText

Function: MSAAGetDialogStaticText

Description

This function is useful for getting descriptive static text from dialogs which
support MSAA when the dialog doesn't contain child windows for each child
object.

Returns

Type: String
Description: The dialog static text.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
MSAARefresh

Function: MSAARefresh

Description

This function is only needed in situations where the object with focus changes
without firing MSAA events to let JAWS know to update it's cached data.

Returns

Type: int
Description: TRUE if successful, FALSE otherwise

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
MSOGetMenuBarObject

Function: MSOGetMenuBarObject

Description

Gets the Menu bar object in MS Office 97/2000 applications.

Returns

Type: Object
Description: The Menu bar of the current Office application.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
NameChangedEvent

Function: NameChangedEvent

Description

This function receives the following parameters: The window handle of the
window containing the current object, The ID number of the Object, The ID
number of the Child Object, The type of the Object, The old name of the
object, and The current name of the Object.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The window handle of the window containing the current object.
Include: Required

Param 2:

Type: Int
Description: The ID number of the Object.
Include: Required

Param 3:

Type: Int
Description: The ID number of the Child Object.
Include: Required

Param 4:

Type: Int
Description: The type of the Object.
Include: Required

Param 5:

Type: String
Description: The old name of the object.
Include: Required

Param 6:

Type: String
Description: The current name of the object.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
ObjStateChangedEvent

Function: ObjStateChangedEvent

Description

By default, this function will now speak the checked and not checked status as
the object's state changes.  In doing so, we are no longer reliant on the
KeyPressedEvent function.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of the window whose state, or whose child object's state,
has changed.
Include: Required

Param 2:

Type: int
Description: The type of the object.
Include: Optional

Param 3:

Type: int
Description: The changed state, which is the difference between the old state
and the current state.
Include: Optional

Param 4:

Type: int
Description: The current state.
Include: Optional

Param 5:

Type: int
Description: The old state.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SayFocusedObject

Function: SayFocusedObject

Description

Called by the FocusChangedEvent when the focus changes from an object to
another object inside the same window.  This functionality is enabled by
Microsoft Active Accessibility.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayObjectActiveItem

Function: SayObjectActiveItem

Description

Says the active element in certain controls. For example in a list view, it
will say the selected item. In a menu, it will say the active menu item. In a
dialog box, it will say the selected tab.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: As of JAWS 8.0, TRUE if you wish to have JAWS announce positional
information such as n of m items, FALSE otherwise.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SayObjectTypeAndText

Function: SayObjectTypeAndText

Description

Speaks the name and type of the object located at the current cursor's
location. It is the most reliable way of obtaining such information.  It
should be used instead of SayWindowTypeAndText which has been retained for
backward compatibility. The two functions are similar, but
SayObjectTypeAndText is able to handle objects supported by MSAA, and the case
where multiple objects are contained within the same window.  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.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ValueChangedEvent

Function: ValueChangedEvent

Description

The MSAA flag must be turned on in your application-specific jcf file to
enable this function.  This function receives the following parameters: The
window handle of the window containing the current MSAA object, The ID number
of the MSAA Object, The ID number of the MSAA Child Object, The type of the
MSAA Object, The name of the MSAA object, and The current value assigned to
the MSAA Object.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The window handle of the window containing the current MSAA
object.
Include: Required

Param 2:

Type: Int
Description: The ID number of the MSAA Object.
Include: Required

Param 3:

Type: Int
Description: The ID number of the MSAA Child Object.
Include: Required

Param 4:

Type: Int
Description: The type of the MSAA Object.
Include: Required

Param 5:

Type: String
Description: The name of the MSAA object.
Include: Required

Param 6:

Type: String
Description: The current value assigned to the MSAA Object.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
WindowVirtualView

Function: WindowVirtualView

Description

This function turns the virtual view for a window on or off. The virtual view
is presented as a virtual document as implemented by one of the FSDomSrv dlls.

Returns

Type: int
Description: true if the window was successfully virtualized or restored,
FALSE otherwise

Parameters

Param 1:

Type: handle
Description: the window handle you wish to virtualize or restore to
non-virtual view
Include: Required

Param 2:

Type: int
Description: TRUE to enable the virtual view, FALSE to restore the view
Include: Required

Param 3:

Type: string
Description: the name of the DLL to use with the Document Server, if not
specified, the MSAA dll wil be used.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
AddTextAtPointToUserBuffer

Function: AddTextAtPointToUserBuffer

Description

This function will add text to the user buffer as either a link or as just
plain text. Make sure that the cursor is on the text to be added, since we
will need to get the text color, and the x,y coordinates if adding the text as
a link.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The on-screen text to be added.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 2.20 and later

----------
DoJAWSFind

Function: DoJAWSFind

Description

Searches the current screen area to find any instance of the text or graphics
that you enter. To search for graphics, enter the text label of the graphic.
Use the application's find or search feature for more extensive searches.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: True if the JAWSFind direction is set to reverse by default,
false otherwise.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
GetCharacter

Function: GetCharacter

Description

Copies the character or graphic label where the active cursor is positioned.
The copied text can then be used by other script functions.

Returns

Type: String
Description: Provides a character or graphic label.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetChunk

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

Type: String
Description: Provides the chunk of information.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetField

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

Type: String
Description: Provides a field of information.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFromStartOfLine

Function: GetFromStartOfLine

Description

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

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetJAWSFindText

Function: GetJAWSFindText

Description

Gets the text to be located when JAWSFindNext runs.

Returns

Type: string
Description: the text which JAWSFindNext will use when searching

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
GetLine

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

Type: String
Description: Provides a line of text.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetParagraph

Function: GetParagraph

Description

This function returns the text of the paragraph at the cursor.

Returns

Type: String
Description: The paragraph.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetPriorCharacter

Function: GetPriorCharacter

Description

If this function returns a null string, the cursor is at the beginning of the
line.

Returns

Type: String
Description: the prior character from the cursor position.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetPriorWord

Function: GetPriorWord

Description

Copies the word preceeding the word where the active cursor is positioned. The
copied text can then be used by other script functions.

Returns

Type: String
Description: Provides a word.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GetScreenEcho

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

Type: Int
Description: "ECHO_NONE" = 0, "ECHO_HIGHLIGHTED" = 1, "ECHO_ALL" = 2.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetSentence

Function: GetSentence

Description

This function returns the text of the sentence at the cursor.

Returns

Type: String
Description: The sentence.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetTextBetween

Function: GetTextBetween

Description

Gets the text between two horizontal points on the screen.

Returns

Type: String
Description: The text located between the two pixel locations.

Parameters

Param 1:

Type: Int
Description: Screen coordinate of left edge of text to retrieve.
Include: Required

Param 2:

Type: Int
Description: Screen coordinate of right edge of text to retrieve.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetToEndOfLine

Function: GetToEndOfLine

Description

Retrieves text on the current line that is located to the right of the current
cursor.

Returns

Type: String
Description: the text to the right of the current cursor.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetWord

Function: GetWord

Description

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

Returns

Type: String
Description: Provides a word.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ItemNotFoundEvent

Function: ItemNotFoundEvent

Description

Event called by JAWS when information can not be found in the Off Screen
Model.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Integer argument. Handle of the window where the item was not
found.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSFindNext

Function: JAWSFindNext

Description

Finds text on the screen after a successful initial find search.

Returns

Type: Int
Description: TRUE if successful, FALSE if not.

Parameters

Param 1:

Type: Int
Description: set this to true to find the prior occurance.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSFindNext

Script: JAWSFindNext

Description

Searches the current screen or virtual document for the next instance of the
text or graphic last entered in the JAWS Find dialog. Use the application's
Find or Search feature for more extensive searches.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSFindPrior

Script: JAWSFindPrior

Description

Searches the current screen or virtual document for the prior instance of the
text or graphic last entered in the JAWS Find dialog. Use the application's
Find or Search feature for more extensive searches.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
JAWSFind

Function: JAWSFind

Description

Finds text on the screen by presenting a dialog for input of text, direction,
and choice to search for graphic or text.

Returns

Type: Int
Description: True if the search item was found, false otherwise.

Parameters

Param 1:

Type: int
Description: True if the find direction should be set to reverse by default,
false otherwise.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
JAWSFind

Script: JAWSFind

Description

Searches the current screen area to find any instance of the text or graphics
that you enter. To search for graphics, enter the text label of the graphic.
Use the application's find or search feature for more extensive searches.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
lvGetColumnHeader

Function: lvGetColumnHeader

Description

This function enables you to obtain the header for a given listview column.

Returns

Type: string

Parameters

Param 1:

Type: handle
Description: hwnd of listview.
Include: Required

Param 2:

Type: int
Description: the column of the listview whose header you want.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
NewTextEvent

Function: NewTextEvent

Description

When this function is called, it receives information pertaining to the newly
written text.  If the text was written in a frame, then the text is spoken
according to the frame's echo setting.  Otherwise the text is sent to
SayHighlightedText() or SayNonHighlightedText.  For a list of parameters
received by NewTextEvent and their descriptions, look at the Existing
Parameters List box on the Parameters page.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: Handle of the window containing the text that was written.
Include: Required

Param 2:

Type: String
Description: String containing the text that was written.
Include: Required

Param 3:

Type: Int
Description: The attributes of the text that was written.
Include: Required

Param 4:

Type: Int
Description: The foreground color of the text that was written.
Include: Required

Param 5:

Type: Int
Description: The background color of the text that was written.
Include: Required

Param 6:

Type: Int
Description: The echo setting associated with this text.
Include: Required

Param 7:

Type: String
Description: The name of the frame containing the newly written text if
applicable.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
NewTextGetRect

Function: NewTextGetRect

Description

Retrieves the coordinates of the rectangle containing the text being processed
by the NewTextEvent function.  NewTextGetRect is only usable from within
NewTextEvent or a function called from that event.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Left edge of rectangle.
Include: Required

Param 2:

Type: Int
Description: top edge of rectangle.
Include: Required

Param 3:

Type: Int
Description: right edge of rectangle.
Include: Optional

Param 4:

Type: Int
Description: bottom edge of rectangle.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
PhoneticSpellHook

Function: PhoneticSpellHook

Description

For more information on how this process works, see the built in AddHook
documentation.  You can view this by using the Insert Function dialog and
selecting AddHook in the function list.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Receives the name of the script that is about to be called
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ProcessNewText

Function: ProcessNewText

Description

Used to force a NewTextEvent call. Can be useful if you need to call
NewTextEvent before FocusChangedEvent.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayAllBy

Function: SayAllBy

Description

Determines whether say all will read by line, sentence, or paragraph.

Returns

Type: String
Description: description of value to be displayed as value of SayAllBy

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayAllSayCaps

Function: SayAllSayCaps

Description

Determines whether initial caps or capitalized words will be indicated during
SayAll.

Returns

Type: String
Description: description of value to be displayed as value of SayAllSayCaps.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51-5.20 and later

----------
SayAllStoppedEvent

Function: SayAllStoppedEvent

Description

User-defined code can be added to an overwritten version of this function to
run every time SayAll stops.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayAll

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.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayAll

Script: SayAll

Description

If the PC cursor is active, JAWS scrolls the screen by moving the PC cursor
down. If the JAWS cursor is active, the rest of the window is read by moving
the JAWS cursor down a line at a time if reading manually.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCharacterPhonetic

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCharacter

Function: SayCharacter

Description

This says the character or graphic located at the position of the active
cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayCharacter

Script: SayCharacter

Description

Reads the character or graphic symbol at the active cursor.  If the PC cursor
is active, JAWS looks for the visible caret or the light bar.  If the JAWS
cursor is active, it speaks the character or graphic at the mouse pointer.
Press twice quickly for phonetic representation. Press three times quickly to
hear the ASCII value of the character.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayChunk

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

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayField

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFromCursor

Function: SayFromCursor

Description

Reads text on the current line that is located to the right of the current
cursor. It will read the character that is being pointed to by the insertion
point or active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFromCursor

Script: SayFromCursor

Description

Says the text from the cursor to the end of the line, includes the current
character.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFromTopOfFile

Script: SayFromTopOfFile

Description

Reads from the top of the file to the current cursor location.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
SayLine

Function: SayLine

Description

This says a line of text where the active cursor is located. JAWS must
interpret whether text that has a similar vertical position is on the same
line. When the PC cursor is active, it only reads the information that is
within the active child window. When it is used with other cursors, then it
reads from one edge of the application window to the other.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Optional parameter added in JAWS 7.1 / MAGic 10.0.  Used to
indicate whether or not the line should be highlighted by the MAGic engine as
the text is being spoken.  The possible values are as follows:  If the
parameter is not present or is equal to 0, do nothing; If the parameter is
equal to 1, highlight each word as it is being spoken; If the parameter is
equal to 2, highlight the entire line.  NOTES: (1) This functionality is not
currently supported in all applications.  (2) The highlight rectangles will
only be drawn if MAGic is running.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayLine

Script: SayLine

Description

If the PC cursor is active, reading will be restricted to the current item or
window.  Otherwise, reading will include all the text on approximately the
same line, even if it is outside the current control or window, unless JAWS
cursor Restriction is on.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayNonHighlightedText

Function: SayNonHighlightedText

Description

Can be modified for application specific cases. Example: Reading of static
text in dialog boxes.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: handle of the window in which the new text was written
Include: Required

Param 2:

Type: String
Description: string containing the text that was written
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayParagraph

Function: SayParagraph

Description

Reads the paragraph containing the character on which the active cursor is
positioned.

Returns

Type: Int
Description: TRUE if a paragraph was found at the current cursor location,
FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayParagraph

Script: SayParagraph

Description

Reads the current paragraph with the active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SaySentence

Function: SaySentence

Description

Reads the sentence containing the character on which the active cursor is
positioned.

Returns

Type: Int
Description: TRUE if a sentence was found at the current cursor location,
FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SaySentence

Script: SaySentence

Description

Say the current sentence with the active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayTextBetween

Function: SayTextBetween

Description

Says the text between two points on the screen.

Returns

Type: Int
Description: TRUE if text spoken, FALSE otherwise.

Parameters

Param 1:

Type: Int
Description: Screen coordinate of left edge of area to speak.
Include: Required

Param 2:

Type: Int
Description: Screen coordinate of right edge of area to speak.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayToCursor

Function: SayToCursor

Description

Reads text on the current line that is located to the left of the active
cursor. It does not read the character that is being pointed to by the
insertion point or active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayToCursor

Script: SayToCursor

Description

Says the text from the start of the line up to the cursor, not including the
current character.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayToPunctuation

Function: SayToPunctuation

Description

Speaks  text between the current cursor and the end of the line or the next
punctuation symbol, which ever comes first.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayToPunctuation

Script: SayToPunctuation

Description

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayWord

Function: SayWord

Description

This says the word or graphic located at the position of the active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayWord

Script: SayWord

Description

Reads the word or graphic symbol at the active cursor.  If the PC cursor is
active, JAWS looks for the visible caret or the light bar.  If the JAWS cursor
is active, it speaks the word or graphic at the mouse pointer. If pressed
twice quickly the word at the active cursor will be spelled.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenEchoToggle

Function: ScreenEchoToggle

Description

Toggles the screen echo. The default is Highlighted, which speaks only
highlighted text when it appears on the screen. "All" speaks all the text that
gets written to the screen, and "None" speaks none of the text.:Returns String
description of value to be displayed as value of Screen Echo.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenEcho

Function: ScreenEcho

Description

Cycles through the various settings for screen echo. 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

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ScreenStabilizedEvent

Function: ScreenStabilizedEvent

Description

This event is triggered after no screen writes have occured within a
reasonable amount of time. The window handle of the last window to which text
was written is passed as the parameter to this event.

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: the window handle where the last text write occured.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SetJAWSFindText

Function: SetJAWSFindText

Description

Sets the text to be located when JAWSFindNext runs.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The text to be used with JAWSFindNext.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
SetScreenEcho

Script: SetScreenEcho

Description

Toggles the screen echo. The default is Highlighted, which speaks only
highlighted text when it appears on the screen. "All" speaks all the text that
gets written to the screen, and "None" speaks none of the text.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SkimReadSummary

Script: SkimReadSummary

Description

Skimreading allows the user to read out certain portions of a document while
skipping over irrelevant information. The Skimreading mode maybe specified
along with an optional text expression which determines which information is
read. This keystroke displays a summary of all text that matches the criteria
used in your skim read in the virtual viewer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SkimRead

Function: SkimRead

Description

Skimreading allows the user to read out certain portions of a document while
skipping over irrelevant information. The Skimreading mode maybe specified
along with an optional text expression which determines which information is
read.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: Modes are defined in HJConst.jsh and include srmOff (equivalent
to a SayAll), srmFirstLineOfParagraph (just read the first line of each
paragraph), srmFirstSentenceOfParagraph (just the first sentence of each
paragraph) or srmTextMatchingRegularExpression (read just the units of text
which match the supplied Regular Expression.
Include: Optional

Param 2:

Type: int
Description: TRUE to indicate JAWS is skimming, a beep will be heard every 20
units skimmed. The unit will depend on the current SayAll mode.
Include: Optional

Param 3:

Type: string
Description: Is a regular expression defining what text should be present or
absent in the text unit in order for it to be spoken. Some examples include
Joe|Blogs|Fred (read units including the names Joe, Blogs or Fred), Joe&~BLogs
(text units containing Joe but not Blogs), etc. See the documentation for the
full regular expression syntax as it is very powerful.
Include: Optional

Param 4:

Type: int
Description: when srmTextMatchingRegularExpression is used, the text unit to
which the rule is applied and the unit spoken on a match.
Include: Optional

Param 5:

Type: int
Description: if true, does not read each match but adds the text to the User
Buffer and presents all matches at once when the SkimRead is stopped or
completes (JAWS 6.10 and higher) defaults to FALSE.
Include: Optional

Param 6:

Type: int
Description: use attrib constants in hjConst.jsh
Include: Optional

Param 7:

Type: string
Description: use empty string (or don't pass) for any text color
Include: Optional

Param 8:

Type: string
Description: use empty string (or don't pass) for any back color
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SpellFromCursor

Function: SpellFromCursor

Description

This function spells the contents of the current line from the cursor to the
end  of the line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SpellLine

Function: SpellLine

Description

This function spells the contents of the current line.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SpellModeToggle

Function: SpellModeToggle

Description

Sets the OPT_SPELL_PHONETIC JCF option monitored by internal spell functions.

Returns

Type: String
Description: The new option (text).

Parameters

Param 1:

Type: Int
Description: Pass True to keep the value the same, false to update it.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SpellMode

Script: SpellMode

Description

Phonetic will speak each character's phonetic expression.  Example, alpha for
a, etc.  Capital letters are announced using the word Cap in front of them.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SpellToCursor

Function: SpellToCursor

Description

This function spells the contents of the current line upto the cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
SpellWordHook

Function: SpellWordHook

Description

SayWord sets this hook when it is called twice quickly.  The hook is in effect
until a script other than SayNextWord or SayPriorWord is called.  When
SayNextWord or SayPriorWord is called, SpellWordHook runs its special code and
aborts the call, otherwise, it unhooks itself and passes on the call.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: Name of the script that is being intercepted.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SpellWordPhonetic

Function: SpellWordPhonetic

Description

This function spells the word at the active cursor using Phonetic alphabet.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SpellWord

Function: SpellWord

Description

Spells the word at the active cursor.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
StartSkimRead

Script: StartSkimRead

Description

Skimreading allows the user to read out certain portions of a document while
skipping over irrelevant information. The Skimreading mode maybe specified
along with an optional text expression which determines which information is
read.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
ToggleSayCaps

Function: ToggleSayCaps

Description

Determines whether initial caps or capitalized words will be indicated using
Pitch change or announcement of the word Cap and when the announcement occurs.

Returns

Type: String
Description: description of value to be displayed as value of SayCaps.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51-5.20 and later

----------
GetCurrentSchemeName

Function: GetCurrentSchemeName

Description

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

Returns

Type: String
Description: the currently active smf file minus the extention .

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
IndicateControlState

Function: IndicateControlState

Description

Allows your custom scripts to take advantage of the scheme the user has set
up.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the JFW Subtype Code for which this applies.  See WT_
constants in HjConst.jsh.
Include: Required

Param 2:

Type: int
Description: nState Either use GetControlAttributes function or one of the
CTRL_ constants from HjConst.jsh if you need to specify the state yourself.
Include: Required

Param 3:

Type: String
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
IndicateControlType

Function: IndicateControlType

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

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the type of control to be spoken.
Include: Required

Param 2:

Type: string
Description: 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.
Include: Optional

Param 3:

Type: String
Description: 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.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
SelectAScheme

Script: SelectAScheme

Description

This keystroke presents a list of schemes from which the user may select. The
selected scheme is then loaded.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.0 and later

----------
smmGetBehaviorForControlState

Function: smmGetBehaviorForControlState

Description

See hjconst.jsh for the list of valid behavior constants.

Returns

Type: Int
Description: a constant representing the behavior.

Parameters

Param 1:

Type: Int
Description: the control state whose behavior you want.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetBehaviorForControlType

Function: smmGetBehaviorForControlType

Description

See hjconst.jsh for the list of valid behavior constants.

Returns

Type: Int
Description: a constant representing the behavior.

Parameters

Param 1:

Type: Int
Description: the control type whose behavior you want.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetBehavior

Function: smmGetBehavior

Description

This function allows the scripter to obtain a scheme behavior.

Returns

Type: int
Description: the behavior for the given table and key.

Parameters

Param 1:

Type: string
Description: the category of behaviors you wish too query. This is taken from
the section name in the SMF file (minus the "Behavior table" suffix), for
example, if you wish to query an Attribute behavior, the value of this
parameter should be set to "Attribute".
Include: Required

Param 2:

Type: string
Description: the key from the behavior table you wish to query.
Include: Required

Param 3:

Type: string
Description: the data for the behavior. This piece of data will correspond to
data1 through data4 for that given table and key, see the smf files for more
detail. for example, if the behavior is speak item then the data will contain
the optional text and voice alias used to speak the item. If the behavior is
to change language then the data will contain the language alias etc.
Include: Required
* Returns data by reference

Param 4:

Type: string
Description: the second set of data for the behavior. For example, if you are
retrieving data for the behavior speak and play sound, the behavior may
contain both overriding text for the speak behavior and a sound file for the
sound behavior. When the bahavior is set to speak and play sound sData will
contain the overriding text stored in data1 and sData2 will contain the sound
file stored in data2.
Include: Optional
* Returns data by reference

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
smmGetEndMarkupForAllCaps

Function: smmGetEndMarkupForAllCaps

Description

This function returns the end markup which will be used for a capitalized
word.

Returns

Type: String
Description: the end Speech Markup which will be used to indicate a
capitalized word. Note that some behaviors don't require an end tag and hence
this will be blank.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetEndMarkupForAttributes

Function: smmGetEndMarkupForAttributes

Description

If an attribute or set of attributes is mapped to a Speech Behavior, this
function returns the end markup for the font name. See the Attribute Behavior
Table in default.jcf. Note some mappings don't require an end markup tag hence
the mapping will be blank.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the end of text
in this attribute.

Parameters

Param 1:

Type: Int
Description: this int must represent the attributes to lookup ored together.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetEndMarkupForColor

Function: smmGetEndMarkupForColor

Description

If a text/background color combination is mapped to a Speech Behavior, this
function returns the end markup for the color. See the Color Behavior Table in
default.jcf.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the end of text
in this color. Note that not all behaviors require an end tag.

Parameters

Param 1:

Type: Int
Description:
Include: Required

Param 2:

Type: Int
Description:
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetEndMarkupForControlState

Function: smmGetEndMarkupForControlState

Description

If a control state is mapped to a Speech Behavior, this function returns the
end markup for the control state. See the ControlState Behavior Table in
default.jcf. Note that since only sounds or speak item maybe assigned to a
control state, you never need to use or get the end markup for control state
behaviors.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the control
state. Note that it is generally unlikely that a control state will be mapped
to a behavior requiring an end markup tag.

Parameters

Param 1:

Type: Int
Description: (required to determine the appropriate state)
Include: Required

Param 2:

Type: Int
Description: state of control, see hjconst.jsh for control states.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetEndMarkupForControlType

Function: smmGetEndMarkupForControlType

Description

If a control type is mapped to a Speech Behavior, this function returns the
end markup for the control type. See the ControlTypes Behavior Table in
default.jcf.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the end of the
control. Note that not all behaviors require an end tag.

Parameters

Param 1:

Type: Int
Description: (must match one of the WT_ constants in hjconst.jsh).
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetEndMarkupForFontName

Function: smmGetEndMarkupForFontName

Description

If a font is mapped to a Speech Behavior, this function returns the end markup
for the font name. See the Font Name Behavior Table in default.jcf. Note some
mappings don't require an end markup tag hence the mapping will be blank.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the end of text
in this font.

Parameters

Param 1:

Type: String
Description: the font name
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetEndMarkupForFontSize

Function: smmGetEndMarkupForFontSize

Description

If a font size is mapped to a Speech Behavior, this function returns the end
markup for the font size. See the Font Size Behavior Table in default.jcf.
Note some mappings don't require an end markup tag hence the mapping will be
blank.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the end of text
in this font.

Parameters

Param 1:

Type: Int
Description: the font size marking the upper bound of a given range of font
sizes.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetEndMarkupForSingleCap

Function: smmGetEndMarkupForSingleCap

Description

This function returns the end markup which will be used for a single
capitalized letter.

Returns

Type: String
Description: the end Speech Markup which will be used to indicate a single
capital letter. Note that some behaviors don't require an end tag and hence
this will be blank.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetMarkupForSymbol

Function: smmGetMarkupForSymbol

Description

for example, this function will return & for the & sign.

Returns

Type: String
Description: the markup for the given symbol.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetSpeechMarkupTextOptions

Function: smmGetSpeechMarkupTextOptions

Description

When using the smmMarkupString function, the result of this function maybe
used as the TextOptions parameter. This function sets the text options
appropriately according to the currently selected jcf option values and Output
type.

Returns

Type: Int
Description: the bit flags of the appropriate text options for the given
output type.

Parameters

Param 1:

Type: Int
Description: the output type to use to retrieve the appropriate text options.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetStartMarkupForAllCaps

Function: smmGetStartMarkupForAllCaps

Description

This function returns the markup which will be used to introduce a capitalized
word or letter group.

Returns

Type: String
Description: the Speech Markup which will be used to indicate a capitalized
word.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetStartMarkupForAttributes

Function: smmGetStartMarkupForAttributes

Description

If an attribute or  set of attributes is mapped to a Speech Behavior, this
function returns the start markup for the attributes. See the attributes
Behavior Table in default.jcf.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the beginning of
text in this attribute.

Parameters

Param 1:

Type: Int
Description: this int must represent the attributes to lookup ored together.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetStartMarkupForColor

Function: smmGetStartMarkupForColor

Description

If a text/background color combination is mapped to a Speech Behavior, this
function returns the start markup for the color. See the Color Behavior Table
in default.jcf.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the beginning of
text in this color.

Parameters

Param 1:

Type: Int
Description:
Include: Required

Param 2:

Type: Int
Description:
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetStartMarkupForControlState

Function: smmGetStartMarkupForControlState

Description

If a control state is mapped to a Speech Behavior, this function returns the
start markup for the control state. See the ControlState Behavior Table in
default.jcf.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the control
state.

Parameters

Param 1:

Type: Int
Description: (required to determine the appropriate state).
Include: Required

Param 2:

Type: Int
Description: state of control, see hjconst.jsh for control states.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetStartMarkupForControlType

Function: smmGetStartMarkupForControlType

Description

If a control type is mapped to a Speech Behavior, this function returns the
start markup for the control type. See the ControlTypes Behavior Table in
default.jcf

Returns

Type: String
Description: the Speech Markup which will be used to identify this control
type.

Parameters

Param 1:

Type: Int
Description: (must map to one of the WT_ constants in hjconst.jsh
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetStartMarkupForFontName

Function: smmGetStartMarkupForFontName

Description

If a font is mapped to a Speech Behavior, this function returns the start
markup for the font name. See the Font Name Behavior Table in default.jcf.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the beginning of
text in this font.

Parameters

Param 1:

Type: String
Description: the font name.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetStartMarkupForFontSize

Function: smmGetStartMarkupForFontSize

Description

If a font size is mapped to a Speech Behavior, this function returns the start
markup for the font size. See the Font Size Behavior Table in default.jcf.
Note that the entries mark the upperbound for the font size, so, if there are
two consequtive entries, one for 10 points and the next for 20, the first
entry means 0 to 10 and the next means 11 to 20.

Returns

Type: String
Description: the Speech Markup which will be used to indicate the beginning of
text in this font size.

Parameters

Param 1:

Type: Int
Description: point size marking upper bound of sizes in this range.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetStartMarkupForSingleCap

Function: smmGetStartMarkupForSingleCap

Description

This function returns the markup which will be used for a single capitalized
letter.

Returns

Type: String
Description: the Speech Markup which will be used to indicate a single capital
letter.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmGetSymbolForMarkup

Function: smmGetSymbolForMarkup

Description

For example, this function will return the & sign for the markup &

Returns

Type: String
Description: the symbol for the given markup.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmMarkupString

Function: smmMarkupString

Description

This function marks up a string using information supplied as optional
parameters.

Returns

Type: String
Description: the string marked up ready for speaking with the say command
specifying true for the ContainsMarkup optional parameter

Parameters

Param 1:

Type: String
Description: text to mark up
Include: Required

Param 2:

Type: Int
Description: see bit flags defined in hjconst.jsh, TextOptions.
Include: Optional

Param 3:

Type: Int
Description: see wt_ constants.
Include: Optional

Param 4:

Type: Int
Description: see control states in hjconst.jsh.
Include: Optional

Param 5:

Type: Int
Description: bit flags specifying the attributes of this text, see
hjconst.jsh.
Include: Optional

Param 6:

Type: String
Description: the font name of all characters in the string.
Include: Optional

Param 7:

Type: Int
Description: the size of the font for this text.
Include: Optional

Param 8:

Type: Int
Description: the color of the text.
Include: Optional

Param 9:

Type: Int
Description: the backround color of this text.
Include: Optional

Param 10:

Type: String
Description: the language code for this text.
Include: Optional

Param 11:

Type: string
Description: The style description (eg heading 1, normal, etc) for this text
(only optional in 5.10)
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmReplaceSymbolsWithMarkup

Function: smmReplaceSymbolsWithMarkup

Description

This function processes a string containing symbols and replaces each
occurance of a symbol with the correct markup so that the string maybe
enhanced with other markup tags and spoken obeying the markup.

Returns

Type: String
Description: the original string with all symbols replaced by appropriate
markup.

Parameters

Param 1:

Type: string
Description: Enter the text whose symbols should be replaced by markup
symbols.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmSchemeDefinesBehaviorFor

Function: smmSchemeDefinesBehaviorFor

Description

This function is used to determine if the current scheme defines a behavior
for any of the specified text option flags. For example, calling this function
with a parameter of toAttributes will return 0 for classic since the classic
scheme ignores any text attributes. Calling this function with a parameter of
toAttributes with the Proofreading or Classic with Attributes schemes loaded
however will return 1.

Returns

Type: int
Description: true if the current scheme will act upon the supplied text
options, false otherwise.

Parameters

Param 1:

Type: int
Description: iTextOptions any number of text options bitwise ored together
(see HJConst.jsh) for the list of text options.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
smmSetBehavior

Function: smmSetBehavior

Description

This function allows the scripter to change a scheme behavior on the fly. the
setting is only temporary similar to SetJCFOption  however it is very useful
when you need to change the behavior of a scheme programmatically.

Returns

Type: int
Description: true if the behavior was successfully changed, false otherwise.

Parameters

Param 1:

Type: string
Description: the category of behaviors you wish too change. this is taken from
the section name in the SMF file (minus the "Behavior table" suffix), for
example, if you wish to change an Attribute behavior, the value of this
parameter should be set to "Attribute".
Include: Required

Param 2:

Type: string
Description: the key from the behavior table you wish to modify (or add).
Include: Required

Param 3:

Type: int
Description: the new behavior, 0 ignore, 1 speak item, 2 play sound, 3 change
voice, 4 change language, or 5 speak and play sound. (See hjconst.jsh).
Include: Required

Param 4:

Type: string
Description: the new data for the behavior. For example, if you are changing
the behavior to change language and you wish to specify the new language, use
this parameter to provide the data for the behavior. Note this data
corresponds to data1 through data4 in the SMF file depending on the behavior
you set. If you do not provide the data, the behavior will inherit the current
data from the active scheme.
Include: Optional

Param 5:

Type: string
Description: a second set of new data for the behavior. For example, if you
are changing the behavior to speak and play sound, you may need to supply
overriding text for the speak behavior and will need to supply a sound file
for the sound behavior. When the bahavior is set to speak and play sound sData
will correspond to data1 and sData2 will correspond to data2.
Include: Optional

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
smmSetDesiredUnitsOfMeasure

Function: smmSetDesiredUnitsOfMeasure

Description

This function is used to set the units of measure JAWS uses for speaking
measurements such as indentation etc.

Returns

Type: void

Parameters

Param 1:

Type: int
Description: iUnit one of smmPixels, smmSpaces, smmPoints, smmMM, smmCM or
smmInches.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
smmStripMarkup

Function: smmStripMarkup

Description

This function strips all speech markup commands and replaces all markup
symbols with their correct symbols.

Returns

Type: String
Description: the original string with all markup removed and all &sym;
replaced with the correct symbols.

Parameters

Param 1:

Type: String
Description: the string containing markup.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
smmToggleTrainingMode

Function: smmToggleTrainingMode

Description

When the Speech and Sounds Manager Training Mode is on, any item which is
indicated by a sound or voice change also speaks the item as with the classic
scheme. This enables a user of a new scheme to familiarize themself with the
sounds and voices chosen to indicate a particular item.

Returns

Type: void

Parameters

Param 1:

Type: int
Description: set to 1 to turn training mode on, set to 0 to turn it off.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
smmTrainingModeActive

Function: smmTrainingModeActive

Description

This function returns 1 if the training mode is on, 0 if it is off.

Returns

Type: int
Description: 1 or 0

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
SwitchToScheme

Function: SwitchToScheme

Description

This function switches to the specified Speech Manager Scheme. If the scheme
exists then the function returns TRUE, if it doesn't it returns FALSE and no
scheme change occurs.

Returns

Type: Int
Description: TRUE or FALSE.

Parameters

Param 1:

Type: string
Description: sScheme the scheme name (no extention or path required).
Include: Required

Version

This function is available in the following releases:
	1. JAWS 5.00 and later

----------
ToggleSMMTrainingMode

Function: ToggleSMMTrainingMode

Description

This function is called from the Select A Scheme dialog to toggle the Speech
and Sounds Manager training Mode on and off.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 5.10 and later

----------
AttributeEnumerate

Function: AttributeEnumerate

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

Type: Int
Description: the number of fields found in the window.

Parameters

Param 1:

Type: Handle
Description: the window to enumerate.
Include: Required

Param 2:

Type: Int
Description: the attributes of the text to find.
Include: Required

Param 3:

Type: String
Description: the callback function name.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AttributesChanged

Function: AttributesChanged

Description

Announces the change of attribute to Bold, Highlight, Italic etc.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: the value of the attributes to be searched for.
Include: Required

Param 2:

Type: Int
Description: The value of the attributes found during the search.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
AttributesChanges

Script: AttributesChanges

Description

Speaks the changes of attributes when encountered while navigating through the
text. Useful for proofreading documents.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51-5.20 and later

----------
FindFirstAttribute

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: int
Description: 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
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindLastAttribute

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0. "FALSE" = search
failure.

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: int
Description: 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
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindNextAttribute

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: int
Description: 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
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FindPriorAttribute

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

Type: Int
Description: "WAS_SUCCESSFUL" = 1, "WAS_NOT_SUCCESSFUL" = 0.

Parameters

Param 1:

Type: Int
Description: 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.
Include: Required

Param 2:

Type: int
Description: 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
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
FontChanges

Script: FontChanges

Description

Will announce the changing of font while navigating text. Useful for
proofreading documents.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51-5.20 and later

----------
FormatAndText

Function: FormatAndText

Description

When the format of the text changes the new format will be spoken. Useful for
proofreading documents.

Returns

Type: String
Description: description of value to be displayed as value of Text
Format/Attribute announcement.

Parameters

Param 1:

Type: Int
Description: true if current value is to be returned, false if value is to be
updated and returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51-5.20 and later

----------
GetCharacterAttributes

Function: GetCharacterAttributes

Description

Retrieves the text attributes of the character at the current cursor location.
The returned value is a combination of the same bit fields used in
FindFirstAttribute, FindNextAttribute, etc. To test for the presence of a
particular attribute, use code of the form: if (GetAttributes) &
ATTRIB_UNDERLINE) then...

Returns

Type: Int
Description: The attributes of the current character.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCharacterFont

Function: GetCharacterFont

Description

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

Returns

Type: String
Description: The name of the font.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCharacterPoints

Function: GetCharacterPoints

Description

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

Returns

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

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetCharacterWidth

Function: GetCharacterWidth

Description

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

Returns

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

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetFont

Function: GetFont

Description

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetLineBottom

Function: GetLineBottom

Description

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

Returns

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

Parameters

Param 1:

Type: Int
Description: Optional parameter that designates whose cursor position is to be
retrieved.  If this parameter is not specified, then the active cursor is
used.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetLineTop

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

Type: Int
Description: 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.

Parameters

Param 1:

Type: Int
Description: Optional parameter that designates whose cursor position is to be
retrieved.  If this parameter is not specified, then the active cursor is
used.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
GetParagraphFormatInfo

Function: GetParagraphFormatInfo

Description

Returns

Type: String

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later

----------
GetStringWidth

Function: GetStringWidth

Description

This function returns the length of the string in units of 1/100 of an inch
using the given font.

Returns

Type: Int
Description: length of the string in 1/100 of an inch.

Parameters

Param 1:

Type: String
Description: The string to be measured
Include: Required

Param 2:

Type: String
Description: the name of the font
Include: Required

Param 3:

Type: Int
Description: The size in points of the font.
Include: Required

Param 4:

Type: Int
Description: True if the font is bold.
Include: Required

Param 5:

Type: Int
Description: True if the font is italic.
Include: Required

Param 6:

Type: Int
Description: True if the font is underlined.
Include: Required

Param 7:

Type: Int
Description: True if the font is strikeout.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.10 and later

----------
GetWordWidth

Function: GetWordWidth

Description

Determines how many pixels that a word is wide.

Returns

Type: int
Description: the width of the word in pixels.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IntToAttribName

Function: IntToAttribName

Description

The converted integer to an attribute name will then be returned.

Returns

Type: String
Description: The name of the attribute.

Parameters

Param 1:

Type: Int
Description: integer of the attribute to be returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsRtlChar

Function: IsRtlChar

Description

Determines if a character is a Right to Left reading character.

Returns

Type: int
Description: true if the character is a Right to Left reading character, false
otherwise.

Parameters

Param 1:

Type: string
Description: The character to be tested.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
IsRtlReading

Function: IsRtlReading

Description

This function Determines if the text in the supplied window reads from right
to left.

Returns

Type: int
Description: true if the window contains text which reads right to left, false
otherwise.

Parameters

Param 1:

Type: handle
Description: The handle of the window to test for Right to Left reading.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.10 and later

----------
PointSizeChanges

Script: PointSizeChanges

Description

Speaks the changing point size as it is encountered while navigating through
text. Useful for proofreading documents.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51-5.20 and later

----------
ProcessRepetitions

Function: ProcessRepetitions

Description

Character or characteristic repetitions are spoken; Example: 2 indentations.

Returns

Type: Int
Description: 1 if repetitions are found, 0 otherwise.

Parameters

Param 1:

Type: String
Description: the string to be searched.
Include: Required

Param 2:

Type: Int
Description: the number of repetitions to be found.
Include: Required

Param 3:

Type: Int
Description: The value of the output type.
Include: Required

Param 4:

Type: Int
Description: No Description.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51-5.20 and later

----------
SayAttributesChanges

Function: SayAttributesChanges

Description

When an attribute for given text is changed, this function announces the
change. This function compares a current attribute with the previous text
attributes

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: the previous attribute.
Include: Required

Param 2:

Type: Int
Description: current attribute to be returned.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayControlAttribBits

Function: SayControlAttribBits

Description

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: True if the hex value for each bit flag is to be returned, false
if the number of each bit flag is to be returned.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SayFont

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.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFont

Script: SayFont

Description

Says the font style name and character size.  Also will speak the attributes
such as bold, underline, and italics.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SayFormatAndText

Function: SayFormatAndText

Description

This function is called by JAWS when executing a reading function and the jcf
option FormatAndText is activated. It processes and speaks text along with its
corresponding format information. This function can be called several times
during the execution of a single reading operation. For example, during the
execution of SayLine, if the current line contains text with more than one
attribute combination, SayFormatAndText will be called once per segment of the
line with the same attribute combination.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: the string to be searched for attributes and spoken.
Include: Required

Param 2:

Type: Int
Description: the value of the attribute to be searched for, such as
Attrib_Italic.
Include: Required

Param 3:

Type: Int
Description: the value of the attribute that was found.
Include: Required

Param 4:

Type: String
Description: the string name for the attribute that was found.
Include: Required

Param 5:

Type: Int
Description: the value of the point size.
Include: Required

Param 6:

Type: Int
Description: the int value of the foreground (text) color.
Include: Required

Param 7:

Type: Int
Description: the int value of the background color.
Include: Required

Param 8:

Type: Int
Description: the value of the number of repetitions found.
Include: Required

Param 9:

Type: Int
Description: the int value of cap type.
Include: Required

Param 10:

Type: Int
Description: the int value of the output type.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51-5.20 and later

----------
SayTextAndAttributes

Script: SayTextAndAttributes

Description

Reads the visible text in the active window without moving the cursor. As it
passes over changes in attributes, they are announced.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
ActivateRunDialog

Function: ActivateRunDialog

Description

Activates a Dialog box for entering the name of a program to run.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.0 and later

----------
DlgCustomizeListview

Function: DlgCustomizeListview

Description

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

Returns

Type: Void

Parameters

Param 1:

Type: Handle
Description: The handle of the Listview of interest.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
DlgGetCustomSummaryInfo

Function: DlgGetCustomSummaryInfo

Description

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

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The name of the worksheet.
Include: Required

Param 2:

Type: String
Description: The name of the cell or cell range (Example, A1 or A1:B1).
Include: Required

Param 3:

Type: String
Description: The description for the cell or cell range.
Include: Required

Param 4:

Type: String
Description: The file name of the JSI file.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 7.00 and later

----------
DlgSelectControls

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

Type: Int
Description: 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.

Parameters

Param 1:

Type: String
Description: The list of controls.
Include: Required

Param 2:

Type: Int
Description: The number of controls.
Include: Required
* Returns data by reference

Param 3:

Type: String
Description: The new window title.
Include: Required

Param 4:

Type: Int
Description: The mask that indicates the buttons desired.  See the available
buttons in HjConst.jsh with the prefix bt_.
Include: Required

Param 5:

Type: Int
Description: The default button as specified by the mask value.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
dlgSelectFunctionToRun

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.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: strList This is the delimited list to be presented in the list
box.  It is in the same format as the dlgSelectScriptToRun function.
Include: Required

Param 2:

Type: String
Description: Enter the string consisting of the Dialog's name.
Include: Required

Param 3:

Type: Int
Description: Enter True if the items are to be sorted alphabetically, false
otherwise.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DlgSelectItemInList

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

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

Parameters

Param 1:

Type: String
Description: A "/007" delimited set of menu items.
Include: Required

Param 2:

Type: String
Description: A string containing the name you want to appear as the title for
the Menu Select dialog.
Include: Required

Param 3:

Type: Int
Description: If TRUE, then the contents of the list will be sorted.
Include: Required

Param 4:

Type: Int
Description: the index of the item which should have the focus when the dialog
is invoked. (JAWS 5.0 and above)
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DlgSelectScriptToRun

Function: DlgSelectScriptToRun

Description

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

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: 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.
Include: Required

Param 2:

Type: String
Description: A string containing the name you want to appear as the title for
the script dialog. If this parameter is "", "Perform Script" is used for the
title.
Include: Required

Param 3:

Type: Int
Description: If TRUE, then the contents of the list will be sorted.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
DlgSkimRead

Function: DlgSkimRead

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
DlgSysTray

Function: DlgSysTray

Description

Displays a list box containing the icons on the System Tray

Returns

Type: Int
Description: 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.

Parameters

Param 1:

Type: String
Description: The list of Task tray icons.
Include: Required

Param 2:

Type: Int
Description: The number of Task tray icons.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
ExMessageBox

Function: ExMessageBox

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

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

Parameters

Param 1:

Type: String
Description: The text of the message that you would like to be displayed in
the main body of the message box.
Include: Required

Param 2:

Type: String
Description: The text of the Message Box's title.
Include: Required

Param 3:

Type: Int
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
InHJDialog

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

Type: Int
Description: TRUE if a dialog is active, FALSE otherwise.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
InputBox

Function: InputBox

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

Type: Int
Description: Returns 1 if the OK button was pressed.  Returns 0 if the cancel
button was pressed.

Parameters

Param 1:

Type: String
Description: The text of the message that you would like to be displayed in
the prompt of the Edit Box.
Include: Required

Param 2:

Type: String
Description: The text of the Dialog Box's title.
Include: Required

Param 3:

Type: String
Description: 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,
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsSelectItemDlg

Function: IsSelectItemDlg

Description

First check the focus to see if it is in the JFW application.  Then check for
control ID to see if it is the select item in the dialog list.

Returns

Type: Int
Description: Returns zero if it is false and one if it is true.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
IsSelectScriptDlg

Function: IsSelectScriptDlg

Description

First check the focus to see if it is in the JFW application.  Then check for
control ID to see if it is the SelectScriptList control.

Returns

Type: Int
Description: Returns zero if it is false and one if it is true.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
MessageBox

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.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: 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.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
SkimReadDialog

Script: SkimReadDialog

Description

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

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 6.00 and later

----------
SmartMinimize

Function: SmartMinimize

Description

Closes the foreground window.  When in a dialog box, equivalent to pressing
the OK button.  When in a window that has an X in the upper right-hand corner,
equivalent to tapping the X.  This also works to close some TopMost windows
like Owner Information that do not respond to the escape key and which do not
have an X in the upper right-hand corner.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 2.01 and later

----------
StartJAWSTaskList

Function: StartJAWSTaskList

Description

The JTL allows the user to minimize, maximize, close, start, and switch to
applications

Returns

Type: Int
Description: The value is 0 if JAWSTaskList.dll can not be loaded, or 1 if the
function is called from the dll successfully.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
TimedMessageBox

Function: TimedMessageBox

Description

Use to assert a message box for a given amount of time while awaiting
processing.

Returns

Type: Void

Parameters

Param 1:

Type: Int
Description: Enter the desired MB_ constants from HjConst.jsh, or simply 0 for
default behavior.  You can use the ICONERROR or other ICON constants to
provide known graphics and system beeps.
Include: Required

Param 2:

Type: String
Description: Enter the text of the message box window.
Include: Required

Param 3:

Type: String
Description: Enter the text for the title of the window.
Include: Required

Param 4:

Type: Int
Description: Enter the time in milliseconds to have the message box stay on
the screen.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
AddHotKeyLinks

Function: AddHotKeyLinks

Description

Adds the standard HotKeyHelp and WindowKeysHelp text and links to the buffer.

Returns

Type: Void
Description: no return description.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
RedirectToUserBuffer

Function: RedirectToUserBuffer

Description

This function formats and sends text to the User Buffer and initiates a
sayAll. %modifiers are processed.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: string to format and send to the User Buffer.
Include: Required

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
RedisplayPrevField

Function: RedisplayPrevField

Description

Scripts can override this function to redisplay a virtual buffer that was
active prior to the display of a help buffer. This function is called if a
user buffer is active and its associated window name (returned by
UserBufferWindowName) is null.  It is called from CloseButton after the
current user buffer has been deactivated and immediately before UpALevel
exits. If it does not wish to redisplay a field it should call the default
version of RedisplayPrevField before returning.

Returns

Type: Void

Parameters

Param 1:

Type: String
Description: The value of UserBufferPrevWindowName() prior to the call to
UserBufferDeactivate().
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 3.00 and later
	2. JAWS 6.10 and later

----------
UserBufferActivateEx

Function: UserBufferActivateEx

Description

The User Virtual buffer may be used as a replacement focus for graphical or
other windows where the real focus is not meaningful. the User Virtual Buffer
maybe populated with text. Each piece of text may have an associated function
assigned to it so that when Enter or the Left Mouse button is presssed in this
text, the function will be called.  This function is like UserBufferActivate
except that it accepts parameters to allow a script to identify the user
buffer.  The passed values are stored for return by UserBufferWindowName,
UserBufferWindowType, UserBufferWindowTypeCode, and UserBufferWindowControlID.
When UserBufferDeactivate is called these values are copied for return by
UserBufferPrevWindowName, etc.

Returns

Type: Int
Description: true if the buffer was activated, false if already active.

Parameters

Param 1:

Type: String
Description: The name that you want to assign the virtual buffer.
Include: Required

Param 2:

Type: String
Description: The window type that you want to assign the virtual buffer.  It
has to be a string.
Include: Required

Param 3:

Type: Int
Description: The type code for the Virtual buffer as an Integer.
Include: Required

Param 4:

Type: Int
Description: The Control Id for the Virtual Buffer as an Integer.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.10 and later

----------
UserBufferActivate

Function: UserBufferActivate

Description

The User Virtual buffer may be used as a replacement focus for graphical or
other windows where the real focus is not meaningful. the User Virtual Buffer
maybe populated with text. Each piece of text may have an associated function
assigned to it so that when Enter or the Left Mouse button is presssed in this
text, the function will be called.

Returns

Type: Int
Description: true if the buffer was activated, false if already active.

Parameters

Param 1:

Type: Int
Description: true to trap (default) false to allow all keys to be passed to
the application.
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferAddText

Function: UserBufferAddText

Description

This function adds the text to the Virtual User Buffer along with the
specified function. The function's display name is used in the links dialog as
a human readable name in place of the code function name.

Returns

Type: Int
Description: true if the text was added, false if not.

Parameters

Param 1:

Type: String
Description: The text to be added to the buffer (if this doesn't end in a
newline character then one will be added)
Include: Required

Param 2:

Type: String
Description: the function name including any parentheses and parameters to be
called when the Enter key or mouse click occurs in the associated text.
Include: Optional

Param 3:

Type: String
Description: the name to be used in the list links dialog when it is invoked
when the User Virtual Buffer is active.
Include: Optional

Param 4:

Type: String
Description: the name of the font used for ins+f when located in this text.
Include: Optional

Param 5:

Type: Int
Description: the point size of the font used for ins+f when located in this
text.
Include: Optional

Param 6:

Type: Int
Description: the attribute flags used for ins+f when located in this text for.
Include: Optional

Param 7:

Type: Int
Description: the text colour.
Include: Optional

Param 8:

Type: Int
Description: the background color.
Include: Optional

Param 9:

Type: Int
Description: add a line break to this string automatically, true by default.
Include: Optional

Param 10:

Type: int
Description: Control Type (see WT_XX constants in HJConst.jsh (JAWS 7.0 and
higher)
Include: Optional

Param 11:

Type: int
Description: Control State, see CTRL_STATE constants in HJConst.jsh (JAWS 7.0
and higher)
Include: Optional

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferClear

Function: UserBufferClear

Description

This function clears the User Virtual Buffer ready to be repopulated with text
and functions.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferDeactivate

Function: UserBufferDeactivate

Description

When this occurs, JAWS will track the normal focus rather than allow
navigation in the User Virtual Buffer.

Returns

Type: Int
Description: true if the buffer was deactivated, false if not active.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferGetFontInfo

Function: UserBufferGetFontInfo

Description

This function  returns the font information set by the user for all text added
to the buffer for which this information is not specified.

Returns

Type: Int
Description: true if get was successful.

Parameters

Param 1:

Type: String
Description: font name.
Include: Required
* Returns data by reference

Param 2:

Type: Int
Description: point size.
Include: Required
* Returns data by reference

Param 3:

Type: Int
Description: attributes of text eg attrib_bold & attrib_italic etc.
Include: Required
* Returns data by reference

Param 4:

Type: Int
Description: color value for text color.
Include: Required
* Returns data by reference

Param 5:

Type: Int
Description: color value for background color.
Include: Required
* Returns data by reference

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferGetLength

Function: UserBufferGetLength

Description

This function returns the number of characters in the User Buffer.

Returns

Type: Int
Description: number of characters (including newlines).

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferGetText

Function: UserBufferGetText

Description

This function returns the text in the user buffer. It is useful when you want
to save and restore the contents.

Returns

Type: String
Description: the text.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferIsActive

Function: UserBufferIsActive

Description

This function determines if the User Virtual Buffer is currently active.

Returns

Type: Int
Description: true or false.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferIsTrappingKeys

Function: UserBufferIsTrappingKeys

Description

This function determines if the User Virtual Buffer is currently trapping
keys.

Returns

Type: Int
Description: true or false.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. JAWS 4.51 and later

----------
UserBufferPrevWindowName

Function: UserBufferPrevWindowName

Description

This function retrieves the window name that was assigned to the previously
active virtual buffer.  It is the value returned by UserBufferWindowName prior
to the last invocation of UserBufferDeactivate.

Returns

Type: String
Description: Returns the window name of the previous virtual buffer.

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.10 and later

----------
userBufferPrevWindowType

Function: userBufferPrevWindowType

Description

This function retrieves the Window type name that was assigned to the previous
virtual buffer.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.10 and later

----------
UserBufferSetFontInfo

Function: UserBufferSetFontInfo

Description

This function  allows user to specify default font name, point size, attribs
and text/background colors, so this info doesn't have to be added for each
segment of text.

Returns

Type: Int
Description: true if set was successful.

Parameters

Param 1:

Type: String
Description: font name.
Include: Required

Param 2:

Type: Int
Description: point size.
Include: Required

Param 3:

Type: Int
Description: attributes of text eg attrib_bold & attrib_italic etc.
Include: Required

Param 4:

Type: Int
Description: color value for text color.
Include: Required

Param 5:

Type: Int
Description: color value for background color.
Include: Required

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 4.51 and later

----------
UserBufferWindowName

Function: UserBufferWindowName

Description

This function retrieves the window name that was specified by the
UserBufferActivateEx function.

Returns

Type: string
Description: the user buffer window name

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.10 and later

----------
userBufferWindowType

Function: userBufferWindowType

Description

This function retrieves the Window type name that was specified by the
UserBufferActivateEx function.

Returns

Type: Void

Parameters

No Parameters

Version

This function is available in the following releases:
	1. PAC Mate 1.10 and later
	2. JAWS 6.10 and later

----------
End of Document
