Open Object Rexx™

Windows OODialog Reference

Version 4.0.0 Edition


August 14, 2009

W. David Ashley
Rony G. Flatscher
Mark Hessling
Rick McGuire
Mark Miesfeld
Lee Peedin
Rainer Tammer
Jon Wolfers

Table of Contents
1. About This Book
Who Should Use This Book
How This Book is Structured
Related Information
How to Read the Syntax Diagrams
Getting Help
The Rexx Language Association Mailing List
The Open Object Rexx SourceForge Site
comp.lang.rexx Newsgroup
2. Brief Overview
Gettting Started
OODialog Class Reference
Definition of Terms
ooDialog 4.0.0 and the future
3. PlainBaseDialog, PlainUserDialog, Base Mixin Classes
PlainUserDialog Class
Attributes
Methods
WindowBase Mixin Class
WindowExtensions Mixin Class
4. Standard Dialogs, and Public Routines
Standard Dialog Classes
TimedMessage Class
InputBox Class
PasswordBox Class
IntegerBox Class
MultiInputBox Class
ListChoice Class
MultiListChoice Class
CheckList Class
SingleSelection Class
Public Routines
Play Routine
InfoDialog Routine
ErrorDialog Routine
AskDialog Routine
FileNameDialog Routine
FindWindow Routine
ScreenSize Routine
SystemMetrics Routine (deprecated)
MSSleep Routine
TimedMessage Routine
InputBox Routine
PasswordBox Routine
IntegerBox Routine
MultiInputBox Routine
ListChoice Routine
MultiListChoice Routine
CheckList Routine
SingleSelection Routine
External Functions (deprecated)
InfoMessage (deprecated)
ErrorMessage (deprecated)
YesNoMessage (deprecated)
GetScreenSize (deprecated)
getSysMetrics (deprecated)
PlaySoundFile (deprecated)
PlaySoundFileInLoop (deprecated)
StopSoundFile (deprecated)
GetFileNameWindow (deprecated)
SleepMS (deprecated)
WinTimer (deprecated)
5. BaseDialog Class
Class Methods
setDefaultFont (Class method)
getFontName (Class method)
getFontSize (Class method)
Attributes
fontName (Attribute)
fontSize (Attribute)
Preparing and Running the Dialog
Init
InitAutoDetection
NoAutoDetection
AutoDetection
InitDialog
Run
Execute
ExecuteAsync
EndAsyncExecution
Popup
PopupAsChild
IsDialogActive
StopIt
HandleMessages
AsyncMessageHandling
PeekDialogMessage
ClearMessages
SendMessageToItem
Connect Event Methods
ConnectResize
ConnectMove
ConnectPosChanged
ConnectMouseCapture
ConnectHelp
ConnectKeyPress
ConnectFKeyPress
DisconnectKeyPress
HasKeyPressConnection
ConnectButton
ConnectBitmapButton
ConnectControl
ConnectDraw
ConnectList
ConnectListLeftDoubleClick
ConnectScrollBar
ConnectAllSBEvents
addUserMsg
Connect Attribute Methods
ConnectEntryLine
connectComboBox
ConnectCheckBox
ConnectRadioButton
ConnectListBox
ConnectMultiListBox
AddAttribute
Get and Set Methods
GetData
SetData
ItemTitle
SetStaticText
GetEntryLine
SetEntryLine
GetListLine
SetListLine
GetMultiList
SetMultiList
GetComboLine
SetComboLine
GetRadioButton
SetRadioButton
GetCheckBox
SetCheckBox
GetValue
SetValue
GetAttrib
SetAttrib
SetDataStem
GetDataStem
Standard Event Methods
OK
Cancel
Help
Validate
Leaving
DeInstall
Combo Box Methods
AddComboEntry
InsertComboEntry
DeleteComboEntry
FindComboEntry
GetComboEntry
GetComboItems
GetCurrentComboIndex
SetCurrentComboIndex
ChangeComboEntry
ComboAddDirectory
ComboDrop
List Box Methods
GetListWidth
SetListWidth
SetListColumnWidth
AddListEntry
InsertListEntry
DeleteListEntry
FindListEntry
GetListEntry
GetListItems
GetListItemHeight
SetListItemHeight
GetCurrentListIndex
SetCurrentListIndex
ChangeListEntry
SetListTabulators
ListAddDirectory
ListDrop
Scroll Bar Methods
GetSBRange
SetSBRange
GetSBPos
SetSBPos
CombineELwithSB
DetermineSBPosition
Methods to Query Operating System Values
GetSelf
Get
GetItem
GetControlID
getPos
GetButtonRect
GetWindowRect
getSystemMetrics (deprecated)
Appearance and Behavior Methods
getTextSizeDlg
BackgroundColor
Show
ToTheTop
EnsureVisible
Minimize
Maximize
Restore
IsMinimized
IsMaximized
FocusItem
TabToNext
TabToPrevious
SetGroup
SetTabStop
EnableItem
DisableItem
HideItem
HideItemFast
ShowItem
ShowItemFast
HideWindow
HideWindowFast
ShowWindow
ShowWindowFast
SetWindowRect
RedrawWindow
ResizeItem
MoveItem
Center
assignWindow (deprecated)
SetWindowTitle
FileViewer Example Program
Window Draw Methods
DrawButton
RedrawRect
RedrawButton
RedrawWindowRect
ClearRect
ClearButtonRect
ClearWindowRect
Bitmap Methods
ChangeBitmapButton
GetBitmapSizeX
GetBitmapSizeY
DrawBitmap
ScrollBitmapFromTo
TiledBackgroundBitmap
BackgroundBitmap
DisplaceBitmap
GetBmpDisplacement
Device Context Methods
GetWindowDC
GetButtonDC
FreeWindowDC
FreeButtonDC
Text Methods
Write
ScrollText
ScrollInButton
ScrollButton
SetItemFont
GetTextSize (deprecated)
Animated Buttons
AddAutoStartMethod
ConnectAnimatedButton
Menu Methods
ConnectMenuItem
EnableMenuItem
DisableMenuItem
CheckMenuItem
UncheckMenuItem
GrayMenuItem
SetMenuItemRadio
GetMenuItemState
Debugging Method
Dump
6. DialogControl Class
Appearance and Behavior Methods
Show
Hide
HideFast
ShowFast
Display
isVisible
Enable
Disable
isEnabled
Group
TabStop
Resize
Move
SetForegroundWindow
ForegroundWindow
GetID
getStyleRaw
getExStyleRaw
GetRect
SetRect
GetClientRect
GetSize
AssignFocus
GetFocus
SetFocus
SetFocusToWindow
SetColor
Update
Title
Title=
SetTitle
Miscellaneous Dialog Control Methods
ProcessMessage
Value
Value=
Connect Event Methods
ConnectKeyPress
ConnectFKeyPress
DisconnectKeyPress
HasKeyPressConnection
Draw Methods
Draw
Clear
ClearRect
Redraw
RedrawRect
RedrawClient
Conversion Methods
LogRect2AbsRect
AbsRect2LogRect
ScreenToClient
ClientToScreen
Scroll Methods
Scroll
HScrollPos
VScrollPos
SetHScrollPos
SetVScrollPos
Mouse and Cursor Methods
CursorPos
SetCursorPos
RestoreCursorShape
Cursor_Arrow
Cursor_AppStarting
Cursor_Cross
Cursor_No
Cursor_Wait
GetMouseCapture
CaptureMouse
ReleaseMouseCapture
IsMouseButtonDown
Bitmap Methods
LoadBitmap
RemoveBitmap
Device Context Methods
GetDC
FreeDC
Text Methods
Write
WriteDirect
TransparentText
OpaqueText
WriteToWindow
WriteToButton
getTextSizeScreen
setFont
getFont
createFont
createFontEx
deleteFont
FontToDC
FontColor
Graphic Methods
CreateBrush
CreatePen
ObjectToDC
DeleteObject
Graphic Drawing Methods
Rectangle
DrawLine
DrawPixel
GetPixel
DrawArc
GetArcDirection
SetArcDirection
DrawPie
FillDrawing
DrawAngleArc
7. UserDialog Class
Init
InitAutoDetection
Create
CreateCenter
DefineDialog
Load
LoadFrame
LoadItems
Add... Methods
Add Button Controls
Add Static Controls
addIcon
addEntryLine
addPasswordLine
addListBox
addComboBox
addInput
addInputGroup
addComboInput
addInputStem
addScrollBar
Dialog Control Methods
StartIt
StopIt
Menu Methods
CreateMenu
AddPopupMenu
AddMenuItem
AddMenuSeparator
SetMenu
LoadMenu
8. Resource File Dialogs
ResDialog Class
new (Class method)
StartIt
SetMenu
RcDialog Class
Init
9. CategoryDialog Class
Setting Up the Dialog
Init
InitCategories
DefineDialog
CategoryPage
CreateCategoryDialog
InitDialog
GetSelectedPage
CurrentCategory
NextPage
PreviousPage
ChangePage
PageHasChanged
StartIt
Connect... Methods
Methods for Dialog Items
Get and Set Methods
SetCategoryStaticText
GetCategoryEntryLine
SetCategoryEntryLine
GetCategoryListLine
SetCategoryListLine
GetCategoryListWidth
SetCategoryListWidth
GetCategoryMultiList
SetCategoryMultiList
GetCategoryComboLine
SetCategoryComboLine
GetCategoryRadioButton
SetCategoryRadioButton
GetCategoryCheckBox
SetCategoryCheckBox
GetCategoryValue
SetCategoryValue
GetCategoryAttrib
SetCategoryAttrib
Combo Box Methods
AddCategoryComboEntry
InsertCategoryComboEntry
DeleteCategoryComboEntry
FindCategoryComboEntry
GetCategoryComboEntry
GetCategoryComboItems
GetCurrentCategoryComboIndex
SetCurrentCategoryComboIndex
ChangeCategoryComboEntry
CategoryComboAddDirectory
CategoryComboDrop
List Box Methods
AddCategoryListEntry
InsertCategoryListEntry
DeleteCategoryListEntry
FindCategoryListEntry
GetCategoryListEntry
GetCategoryListItems
GetCurrentCategoryListIndex
SetCurrentCategoryListIndex
ChangeCategoryListEntry
SetCategoryListTabulators
CategoryListAddDirectory
CategoryListDrop
Appearance Modification Methods
EnableCategoryItem
DisableCategoryItem
ShowCategoryItem
HideCategoryItem
SetCategoryItemFont
FocusCategoryItem
ResizeCategoryItem
MoveCategoryItem
SendMessageToCategoryItem
10. Utility Classes and Objects
.SystemErrorCode
DlgUtil Class
version (Class Method)
comCtl32Version (Class Method)
loWord (Class Method)
hiWord (Class Method)
or (Class Method)
and (Class Method)
getSystemMetrics (Class Method)
Rect Class
new (Class Method)
left
left=
top
top=
right
right=
bottom
bottom=
Point Class
new (Class Method)
x
x=
y
y=
Size Class
new (Class Method)
width
width=
height
height=
DlgArea Class
Init
B
Bottom
CX
CY
H
HR
L
Left
Margin
R
Right
T
Top
W
WR
X
Y
DlgArea Example
DlgAreaU Class
Init
CorrectionFactor
LastError
NoMove
NoResize
Creating Resizeable Dialogs
Possible Problems
Sample Code
VirtualKeyCodes Class
Methods of the VirtualKeyCodes Class
Symbolic Names for Virtual Keys
11. MessageExtensions Class
ConnectCommonNotify
ConnectTreeNotify
DefTreeDragHandler
ConnectListNotify
DefListDragHandler
ConnectListViewNotify
connectButtonNotify
connectStaticNotify
ConnectEditNotify
ConnectListBoxNotify
ConnectComboBoxNotify
ConnectScrollBarNotify
ConnectTabNotify
ConnectSliderNotify
12. AdvancedControls Class
GetStaticControl
GetEditControl
GetButtonControl
GetRadioControl
GetCheckControl
getGroupBox
GetListBox
GetComboBox
GetScrollBar
GetTreeControl
GetListControl
getProgressBar
GetSliderControl
GetTabControl
ConnectTreeControl
ConnectListControl
ConnectSliderControl
ConnectTabControl
AddTreeControl
AddListControl
addProgressBar
AddSliderControl
AddTabControl
13. StaticControl Class
new (Class method)
setText
getText
setIcon
getIcon
setImage
getImage
14. Button Controls
ButtonControl Class
push
click
state
state=
style=
getIdealSize
getTextMargin
setTextMargin
getImageList
setImageList
getImage
setImage
ChangeBitmap
DisplaceBitmap
GetBmpDisplacement
Scroll
ScrollText
GetBitmapSizeX
GetBitmapSizeY
DrawBitmap
DimBitmap
ScrollBitmapFromTo
RadioButton Class
checkInGroup (Class)
checked
getCheckState
check
uncheck
isChecked (deprecated)
indeterminate (deprecated)
CheckBox Class
isIndeterminate
getCheckState
setIndeterminate
GroupBox Class
Style=
AnimatedButton Class
15. EditControl Class
Selected
Select
ScrollCommand
LineScroll
EnsureCaretVisibility
FirstVisibleLine
IsModified
SetModified
Lines
LineIndex
LineFromIndex
LineLength
GetLine
GetText
SetText
ReplaceSelText
SetLimit
PasswordChar=
PasswordChar
SetReadOnly
SetMargins
Margins
SetCue
ShowBalloon
HideBalloon
AddStyle
RemoveStyle
ReplaceStyle
GetStyle
16. ComboBox Class
Add
Insert
Delete
DeleteAll
Find
SelectedIndex
Selected
SelectIndex
Select
Items
GetText
Modify
AddDirectory
OpenDropDown
CloseDropDown
IsDropDownOpen
EditSelection
17. ListBox Class
Add
Insert
Delete
DeleteAll
Find
SelectedIndex
Selected
SelectIndex
DeSelectIndex
Select
SelectRange
DeselectRange
Items
SelectedItems
SelectedIndexes
MakeFirstVisible
GetFirstVisible
GetText
Modify
SetTabulators
AddDirectory
SetWidth
Width
ItemHeight
ItemHeight=
ColumnWidth=
18. ScrollBar Class
setRange
Range
setPos
Position
DeterminePosition
19. ListControl Class
View Styles
Methods of the ListControl Class
ReplaceStyle
AddStyle
RemoveStyle
AddExtendedStyle
RemoveExtendedStyle
ReplaceExtendedStyle
GetExtendedStyle
GetExtendedStyleRaw
GetHoverTime
SetHoverTime
Check
Uncheck
CheckAll
UncheckAll
GetCheck
IsChecked
InsertColumn
DeleteColumn
ModifyColumn
ColumnInfo
ColumnWidth
SetColumnWidth
getColumnCount
getColumnOrder
setColumnOrder
StringWidth
insert
modify
setItemText
SetItemState
add
addRow
Delete
DeleteAll
Items
Last
Prepare4nItems
SelectedItems
ItemInfo
ItemText
ItemState
Select
Deselect
Selected
LastSelected
Focused
Focus
DropHighlighted
FirstVisible
NextSelected
PreviousSelected
Next
Previous
NextLeft
NextRight
SmallSpacing
Spacing
RedrawItems
UpdateItem
Update
EnsureVisible
setImageList
getImageList
setSmallImages (deprecated)
setImages (deprecated)
removeSmallImages (deprecated)
removeImages (deprecated)
Find
FindPartial
FindNearestXY
Arrange
SnapToGrid
AlignLeft
AlignTop
ItemPos
SetItemPos
Edit
EndEdit
SubclassEdit
RestoreEditClass
ItemsPerPage
Scroll
BkColor
BkColor=
TextColor
TextColor=
TextBkColor
TextBkColor=
Notification Messages
20. TreeControl Class
Methods of the TreeControl Class
Insert
Add
Modify
ItemInfo
Items
VisibleItems
Root
Parent
Child
Selected
DropHighlighted
FirstVisible
Next
NextVisible
Previous
PreviousVisible
Delete
DeleteAll
Collapse
CollapseAndReset
Expand
Toggle
EnsureVisible
Indent
Indent=
Edit
EndEdit
SubclassEdit
RestoreEditClass
Select
MakeFirstVisible
DropHighlight
SortChildren
setImageList
getImageList
setImages (deprecated)
removeImages (deprecated)
HitTest
MoveItem
IsAncestor
Notification Messages
21. SliderControl Class
Pos=
setPos
Pos
InitRange
SetMin
SetMax
Range
ClearTicks
CountTicks
GetTick
SetTickAt
SetTickFrequency
GetLineStep
GetPageStep
SetLineStep
SetPageStep
InitSelRange
SetSelStart
SetSelEnd
ClearSelRange
SelRange
22. ProgressBar Class
step
setPos
getPos
setStep
setRange
getRange
setMarquee
barColor
backgroundColor
23. TabControl Class
Insert
Modify
AddSequence
AddFullSeq
Items
Rows
ItemInfo
Delete
DeleteAll
Last
Selected
SelectedIndex
Select
SelectIndex
Focus
Focused
setImageList
getImageList
setImages (deprecated)
removeImages (deprecated)
SetPadding
SetSize
PosRectangle
AdjustToRectangle
RequiredWindowSize
24. PropertySheet Class
Init
25. Resources
Image Class
new (Class method)
toID (Class method)
getImage (Class method)
fromFiles (Class method)
fromIDs (Class method)
colorRef (Class Method)
getRValue (Class Method)
getGValue (Class Method)
getBValue (Class Method)
handle
release
isNull
systemErrorCode
ImageList Class
new (Class method)
create (Class method)
add
addMasked
addIcon
addImages
getCount
getImageSize
duplicate
remove
removeAll
release
handle
isNull
ResourceImage Class
new (Class method)
getImage
getImages
release
handle
isNull
systemErrorCode
A. Notices
Trademarks
Source Code For This Document
B. Common Public License Version 1.0
Definitions
Grant of Rights
Requirements
Commercial Distribution
No Warranty
Disclaimer of Liability
General
Index
List of Tables
2-1. Symbolic IDs Used by ooDialog
2-2. ooDialog Supplied Icons
3-1. PlainUserDialog Class Methods
4-1. Standard Dialogs, and Routines
5-1. BaseDialog Reference
6-1. DialogControl Instance Methods
7-1. UserDialog Instance Methods
10-1. ooDialog Utilitiy Classes and Objects
10-2. Methods of the DlgUtil class
10-3. Rect Instance Methods
10-4. Point Class and Instance Methods
10-5. Size Class and Instance Methods
10-6. DlgAreaU Automatic Resize Elements
10-7. DlgAreaU Non-Automatic Resize Elements
10-8. Symbolic Names for Virtual Keys
11-1. MessageExtensions Instance Methods
12-1. AdvancedControls Instance Methods
13-1. StaticControl Instance Methods
14-1. ooDialog Button Control Classes
14-2. ButtonControl Instance Methods
14-3. RadioButton Class and Instance Methods
14-4. CheckBox Instance Methods
14-5. GroupBox Instance Methods
15-1. EditControl Instance Methods
16-1. ComboBox Instance Methods
17-1. ListBox Instance Methods
18-1. ScrollBar Instance Methods
19-1. ListControl Instance Methods
20-1. TreeControl Instance Methods
21-1. SliderControl Instance Methods
22-1. ProgressBar Instance Methods
23-1. TabControl Instance Methods
25-1. ooDialog Resource Classes
25-2. Methods of the .Image Class
25-3. Image Instance Methods
25-4. Name Instance Methods
List of Figures
2-1. The Hierarchy of OODialog Classes
7-1. Sample Radio Button Group
7-2. Sample Check Box Group
7-3. Frames and Rectangles
7-4. Sample Input Field
10-1. DlgArea Measurements
10-2. DlgArea Plan
10-3. Sample DlgArea