[r8770]: ooDialog / branches / 4.2.1 / doc / oodialog / en-US / dialogControlObject.xml Maximize Restore History

Download this file

dialogControlObject.xml    2981 lines (2737 with data), 112.2 kB

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "oodialog.ent">
%BOOK_ENTITIES;
]>
<!--#########################################################################
#
# Description: Open Object Rexx: ooDialog Reference XML file.
#
# Copyright (c) 2005-2013 Rexx Language Association. All rights reserved.
# Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
# distribution. A copy is also available at the following address:
# http://www.oorexx.org/license.html
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the distribution.
#
# Neither the name of Rexx Language Association nor the names
# of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#########################################################################
-->
<chapter id="chpDialogControlObject" xreflabel="control"><title>The Dialog Control Object</title>
<indexterm><primary>dialog control object</primary></indexterm>
<indexterm><primary>dialog control object</primary></indexterm>
<para>
This chapter discussses the <emphasis role="italic">dialog control object</emphasis> in a fashion similar to the <xref
linkend="chpDialogObject"/> object. It lists the methods that are common to all dialog controls. In the
graphical user interface (GUI) for the Windows operating system both dialogs and dialog controls are windows.
Therefore, many of the methods of a dialog control object are the same as the methods of the dialog object. These are
the methods that are common to all windows, whether they are dialog windows or dialog control windows.
</para>
<para id="paraDialogControlStyles">
In the Windows GUI all windows are created with a set of <emphasis role="italic">window styles</emphasis>. Dialog
control windows are created using styles that are common to all windows, (for example the visible style,) and styles
specific to the dialog control itself, (for example the multi-line style of the <xref linkend="clsEdit"/>
control class.) In general the styles of a control fall into three categories: Styles that can only be set when the
control is created and then can not be changed afterwards. Styles that can be changed after control creation by
sending messages to the control. And, styles that can be changed after the control is created by accessing the control
window directly.
</para>
<para>
The ooDialog programmer chooses the window styles for dialog controls when he defines the dialog, either by using a
resource editor for dialogs defined with resource scripts or binary compiled resources, or by using the one of the
<xref linkend="sctCreateMethods"/> methods for a user dialog. After the dialog control has been
created, the individual dialog control classes provide methods to change those styles that can be changed, either by
sending the proper message to the control or by accessing the control window directly.
</para>
<section id="sctMethodsDlgContorlObject"><title>Method Table</title>
<para>
The following table lists the class methods, attributes, and instance methods that all dialog controls have in
common:
<table id="tblDialogControlObject" frame="all">
<title>Dialog Control Object Method Reference</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="3*" />
<thead>
<row>
<entry>Dialog Control Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Attributes</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="wbdcoFactorX"/></entry>
<entry>The horizontal size of one dialog unit in pixels. (Inaccurate.)</entry>
</row>
<row>
<entry><xref linkend="wbdcoFactorY"/></entry>
<entry>The vertical size of one dialog unit in pixels. (Inaccurate.)</entry>
</row>
<row>
<entry><xref linkend="atrHDlg"/></entry>
<entry>Reflects the window handle of the underlying Windows dialog that the dialog control belongs to.</entry>
</row>
<row>
<entry><xref linkend="wbdcoHwnd"/></entry>
<entry>The window handle of the dialog control.</entry>
</row>
<row>
<entry><xref linkend="atrID"/></entry>
<entry>Reflects the numeric resource ID for the dialog control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoInitCode"/></entry>
<entry>Meaningless for a dialog control, it is always 0.</entry>
</row>
<row>
<entry><xref linkend="atrODlg"/></entry>
<entry>Reflects the Rexx dialog object that the dialog control belongs to.</entry>
</row>
<row>
<entry><xref linkend="wbdcoSizeX"/></entry>
<entry>The width of the dialog control in dialog units. (Inaccurate.)</entry>
</row>
<row>
<entry><xref linkend="wbdcoSizeY"/></entry>
<entry>The height of the dialog control in dialog units. (Inaccurate.)</entry>
</row>
<row>
<entry><xref linkend="wbdcoPixelCX"/></entry>
<entry>The width of the dialog control in pixels.</entry>
</row>
<row>
<entry><xref linkend="wbdcoPixelCY"/></entry>
<entry>The height of the dialog control in pixels.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="mthAssignFocus"/></entry>
<entry>Sets the input focus to this dialog control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoChildWindowFromPoint"/></entry>
<entry>Determines which, if any, of the child windows belonging to this dialog control contains the specified point.</entry>
</row>
<row>
<entry><xref linkend="wbdcoClear"/></entry>
<entry>Clears the client area of the control by painting it with the background brush.</entry>
</row>
<row>
<entry><xref linkend="mthClearRectClsDialogControl"/></entry>
<entry>Clears the specified rectangular within the client area of this control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoClient2screen"/></entry>
<entry>Converts a point or points in client-area coordinates of the control to its screen coordinates.</entry>
</row>
<row>
<entry><xref linkend="wbdcoClientRect"/></entry>
<entry>Returns a <computeroutput>Rect</computeroutput> object containng the dimensions of the control's client area in pixels.</entry>
</row>
<row>
<entry><xref linkend="wbdcoClientToScreen"/></entry>
<entry>Converts client-area coordinates of the control to its screen coordinates.</entry>
</row>
<row>
<entry><xref linkend="mthConnectCharEvent"/></entry>
<entry>Connects a character event notification sent to the control to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectFKeyPressDialogControlObject"/></entry>
<entry>Connects all F Key key press events to a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="mthConnectKeyPressDialogControlObject"/></entry>
<entry>Connects a key press event notification with a method in the Rexx dialog.</entry>
</row>
<row>
<entry><xref linkend="wedcoCreateBrush"/></entry>
<entry>Creates a logical brush that has the specified style, color, and pattern.</entry>
</row>
<row>
<entry><xref linkend="wedcoCreateFont"/></entry>
<entry>Returns a handle to a logical font, the implementation is <emphasis role="bold">incorrect</emphasis>.</entry>
</row>
<row>
<entry><xref linkend="wedcoCreateFontEx"/></entry>
<entry>Retrieves a handle to a logical font from the system font manager</entry>
</row>
<row>
<entry><xref linkend="wedcoCreatePen"/></entry>
<entry>Creates a logical pen that has the specified style, width, and color.</entry>
</row>
<row>
<entry><xref linkend="mthData"/></entry>
<entry>Retrievs the <emphasis role="italic">data</emphasis> (the value) of the underlying control's state.</entry>
</row>
<row>
<entry><xref linkend="mthDataEquals"/></entry>
<entry>Sets the state of the underlying dialog control to the <emphasis role="italic">data</emphasis> (the value) specified.</entry>
</row>
<row>
<entry><xref linkend="wedcoDeleteFont"/></entry>
<entry>Deletes a font returned from <emphasis role="italic">createFontEx</emphasis> or <emphasis role="italic">createFont</emphasis>.</entry>
</row>
<row>
<entry><xref linkend="wedcoDeleteObject"/></entry>
<entry>Deletes a graphic object,</entry>
</row>
<row>
<entry><xref linkend="wbdcoDisable"/></entry>
<entry>Disables the control</entry>
</row>
<row>
<entry><xref linkend="mthDisconnectKeyPressDialogControlObject"/></entry>
<entry>Disconnects a method in the Rexx dialog from a previously connected key press event.</entry>
</row>
<row>
<entry><xref linkend="wbdcoDisplay"/></entry>
<entry>Shows or hides the control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoDraw"/></entry>
<entry>Redraws the entire client area of the control immediately.</entry>
</row>
<row>
<entry><xref linkend="wedcoDrawAngleArc"/></entry>
<entry>Draws a partial circle (arc) and a line connecting the start drawing point with the start of the arc.</entry>
</row>
<row>
<entry><xref linkend="wedcoDrawArc"/></entry>
<entry>Draws a circle or ellipse withi the given device context using the active pen.</entry>
</row>
<row>
<entry><xref linkend="wedcoDrawLine"/></entry>
<entry>Draws a line within the device context using the active pen.</entry>
</row>
<row>
<entry><xref linkend="wedcoDrawPie"/></entry>
<entry>Draws and fills a pie of a circle or ellipse within the given device context using the active brush and pen.</entry>
</row>
<row>
<entry><xref linkend="wedcoDrawPixel"/></entry>
<entry>Draws a pixel within the device context.</entry>
</row>
<row>
<entry><xref linkend="wbdcoEnable"/></entry>
<entry>Enables the control</entry>
</row>
<row>
<entry><xref linkend="wedcoFillDrawing"/></entry>
<entry>Fills in an outline figure within the device context using the active brush.</entry>
</row>
<row>
<entry><xref linkend="wedcoFontColor"/></entry>
<entry>Sets the font color for a device context.</entry>
</row>
<row>
<entry><xref linkend="wedcoFontToDC"/></entry>
<entry>Loads a font into a device context and returns the handle of the previous font.</entry>
</row>
<row>
<entry><xref linkend="wbdcoForegroundWindow"/></entry>
<entry>Returns the handle of the window in the foreground.</entry>
</row>
<row>
<entry><xref linkend="wedcoFreeDC"/></entry>
<entry>Releases a device context.</entry>
</row>
<row>
<entry><xref linkend="wedcoGetArcDirection"/></entry>
<entry>Returns the current drawing direction.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetClientRect"/></entry>
<entry>Returns the dimensions of the control's client area.</entry>
</row>
<row>
<entry><xref linkend="wedcoGetDC"/></entry>
<entry>Returns the handle to the display device context of a dialog control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetExStyleRaw"/></entry>
<entry>Retrieves the numeric value of the control's extended style flags.</entry>
</row>
<row>
<entry><xref linkend="wedcoGetFont"/></entry>
<entry>Returns the font used by the dialog control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetID"/></entry>
<entry>Retrieves the identification number of the control.</entry>
</row>
<row>
<entry><xref linkend="wedcoGetPixel"/></entry>
<entry>Returns the color number of a pixel within the device context.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetPos"/></entry>
<entry>Returns the position of the control in dialog units <emphasis role="bold">(not accurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="wbdcoGetRealPos"/></entry>
<entry>Returns the position of the control in pixels as a <computeroutput>Point</computeroutput> object.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetRealSize"/></entry>
<entry>Returns the size of the control in pixels as a <computeroutput>Size</computeroutput> object.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetRect"/></entry>
<entry>Returns the dimesions of the control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetSize"/></entry>
<entry>Returns the size of the control in dialog units <emphasis role="bold">(not accurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="wbdcoGetStyleRaw"/></entry>
<entry>Retrieves the numeric value of the control's style flags.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetText"/></entry>
<entry>Gets the text of the control.</entry>
</row>
<row>
<entry><xref linkend="mthGetTextSizeDlgClsDialogControl"/></entry>
<entry>Calculates the size, (width and height,) in dialog units for a given string.</entry>
</row>
<row>
<entry><xref linkend="wbdcoGetTextSizePx"/></entry>
<entry>Calculates the size needed for a string in pixels <emphasis role="bold">(preferred method.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="wbdcoGetTextSizeScreen"/></entry>
<entry>Calculates the size needed for a string in pixels.</entry>
</row>
<row>
<entry><xref linkend="mthGroup"/></entry>
<entry>Adds or removes the <xref linkend="wsgroup"/> style for the control.</entry>
</row>
<row>
<entry><xref linkend="mthHasKeyPressConnectionDialogControlObject"/></entry>
<entry>Queries if a specific method, or any method, in the Rexx dialog has a connection to a key press event.</entry>
</row>
<row>
<entry><xref linkend="wbdcoHide"/></entry>
<entry>Makes the control invisible and repaints it.</entry>
</row>
<row>
<entry><xref linkend="wbdcoHideFast"/></entry>
<entry>Marks the control as invisible</entry>
</row>
<row>
<entry><xref linkend="wedcoHScrollPos"/></entry>
<entry>Returns the position of the horizontal scroll bar in the dialog control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoIsVisible"/></entry>
<entry>Tests if the control is visible.</entry>
</row>
<row>
<entry><xref linkend="wbdcoIsEnabled"/></entry>
<entry>Tests if the control is enabled.</entry>
</row>
<row>
<entry><xref linkend="wedcoLoadBitmap"/></entry>
<entry>Loads a bitmap from a file into memory and returns the handle to the bitmap.</entry>
</row>
<row>
<entry><xref linkend="wbdcoMove"/></entry>
<entry>Moves the control to the position specified in dialog units <emphasis role="bold">(not accurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="wbdcoMoveTo"/></entry>
<entry>Moves the control to the position specified in pixels.</entry>
</row>
<row>
<entry><xref linkend="wbdcoMoveWindow"/></entry>
<entry>Changes the position, visibility, and Z order of the dialog.</entry>
</row>
<row>
<entry><xref linkend="wedcoObjectToDC"/></entry>
<entry>Loads a graphic object into a device context.</entry>
</row>
<row>
<entry><xref linkend="wedcoOpaqueText"/></entry>
<entry>Sets the text drawing mode in a device context to opaque, (background is redrawn with the current brush.)</entry>
</row>
<row>
<entry><xref linkend="wedcoRectangle"/></entry>
<entry>Draws a rectangle within the given device context.</entry>
</row>
<row>
<entry><xref linkend="wbdcoRedraw"/></entry>
<entry>Redraws the entire control window and all its child windows immediately.</entry>
</row>
<row>
<entry><xref linkend="wbdcoRedrawClient"/></entry>
<entry>Redraws the entire client area of the control immediately.</entry>
</row>
<row>
<entry><xref linkend="mthRedrawRectClsDialogControl"/></entry>
<entry>Immediately redraws the rectangle of the client area of the associated dialog.</entry>
</row>
<row>
<entry><xref linkend="wedcoRemoveBitmap"/></entry>
<entry>Frees an in-memory bitmap that was loaded through the <emphasis role="italic">loadBitmap</emphasis> method.</entry>
</row>
<row>
<entry><xref linkend="wbdcoResize"/></entry>
<entry>Resizes the control to the size specified in dialog units <emphasis role="bold">(not accurate.)</emphasis></entry>
</row>
<row>
<entry><xref linkend="wbdcoResizeTo"/></entry>
<entry>Resizes the control to the size specified in pixels.</entry>
</row>
<row>
<entry><xref linkend="wedcoRestoreCursorShape"/></entry>
<entry>Restores the shape of the mouse cursor.</entry>
</row>
<row>
<entry><xref linkend="wbdcoScreen2client"/></entry>
<entry>Converts a point or points in screen coordinates to the client-area coordinates of the control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoScreenToClient"/></entry>
<entry>Converts screen coordinates to the client-area coordinates of the control.</entry>
</row>
<row>
<entry><xref linkend="wedcoScrollClsWE"/></entry>
<entry>Scrolls the contents of the dialog control's client area by the amount specified.</entry>
</row>
<row>
<entry><xref linkend="wbdcoSendMessage"/></entry>
<entry>Sends a Windows message to the underlying control and returns its response as a whole number.</entry>
</row>
<row>
<entry><xref linkend="wbdcoSendMessageHandle"/></entry>
<entry>Sends a Windows message to the underlying control and returns its response as a handle.</entry>
</row>
<row>
<entry><xref linkend="wedcoSetArcDirection"/></entry>
<entry>Sets the current drawing direction.</entry>
</row>
<row>
<entry><xref linkend="mthSetColor"/></entry>
<entry>Sets the background color, and optionally the text color, for this dialog control.</entry>
</row>
<row>
<entry><xref linkend="wedcoSetFont"/></entry>
<entry>Sets a new font to be used by the dialog control.</entry>
</row>
<row>
<entry><xref linkend="wedcoSetHScrollPos"/></entry>
<entry>Sets the thumb position of the horizontal scroll bar contained in the dialog control.</entry>
</row>
<row>
<entry><xref linkend="wedcoSetVScrollPos"/></entry>
<entry>Sets the thumb position of the vertical scroll bar contained in the dialog control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoSetRect"/></entry>
<entry>Moves and / or resizes the control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoSetText"/></entry>
<entry>Sets the text of the control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoSetTitle"/></entry>
<entry>Sets the text of the control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoSetWindowPos"/></entry>
<entry>Changes the size, position, visibility, and Z order of the dialog.</entry>
</row>
<row>
<entry><xref linkend="wbdcoShow"/></entry>
<entry>Makes the control visible if it was hidden and repaints it.</entry>
</row>
<row>
<entry><xref linkend="wbdcoShowFast"/></entry>
<entry>Marks the control as visible.</entry>
</row>
<row>
<entry><xref linkend="wbdcoSizeWindow"/></entry>
<entry>Changes the size, visibility, and Z order of the dialog.</entry>
</row>
<row>
<entry><xref linkend="mthSetSysColor"/></entry>
<entry>Sets the background color, and optionally the text color, for this dialog control using the system colors.</entry>
</row>
<row>
<entry><xref linkend="mthTabStop"/></entry>
<entry>Add or remove the tab stop style for the control.</entry>
</row>
<row>
<entry><xref linkend="mthTextSize"/></entry>
<entry>Computes the width and height in pixels of the specified string of text when displayed by this control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoTitle"/></entry>
<entry>Gets the text of the control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoTitleEquals"/></entry>
<entry>Sets the text of the control.</entry>
</row>
<row>
<entry><xref linkend="wedcoTransparentText"/></entry>
<entry>Sets the text drawing mode in a device context to transparent, (background is not changed.)</entry>
</row>
<row>
<entry><xref linkend="wbdcoUpdate"/></entry>
<entry>Invalidates the entire client area of the control.</entry>
</row>
<row>
<entry><xref linkend="mthUseUnicode"/></entry>
<entry>Sets the format flag telling the control to use, or not use, Unicode.</entry>
</row>
<row>
<entry><xref linkend="mthUseVersion"/></entry>
<entry>Informs the control that the programmer is expecting a behavior associated with a particular common control library version.</entry>
</row>
<row>
<entry><xref linkend="mthUsingUnicode"/></entry>
<entry>Determines if the control is using Unicode or not.</entry>
</row>
<row>
<entry><xref linkend="mthUsingVersion"/></entry>
<entry>Returns the version number for the control that was set by the most recent <emphasis role="italic">useVersion</emphasis>method call.</entry>
</row>
<row>
<entry><xref linkend="wedcoVScrollPos"/></entry>
<entry>Returns the position of the vertical scroll bar in the dialog control.</entry>
</row>
<row>
<entry><xref linkend="wbdcoWindowRect"/></entry>
<entry>Returns a <computeroutput>Rect</computeroutput> object containng the dimensions of the control in pixels.</entry>
</row>
<row>
<entry><xref linkend="wedcoWrite"/></entry>
<entry>Writes text in a dialog control using the given font, style, and color at the position specified.</entry>
</row>
<row>
<entry><xref linkend="wedcoWriteDirect"/></entry>
<entry>Writes text in a dialog control at the position specified using a device context.</entry>
</row>
</tbody></tgroup>
</table>
</para>
</section>
<section id="sctDialogControlAttributes"><title>Attribute Methods</title>
<indexterm><primary>dialog control object</primary><secondary>attributes</secondary></indexterm>
<para>
This section describes the attributes of the dialog control object.
</para>
<section id="wbdcoFactorX"><title>factorX (Attribute)</title>
<programlisting>
WindowBase::<xref linkend="atrFactorX"/>
<![CDATA[
>>--factorX--------------------------------------><
>>--factorX = ratio------------------------------><
]]>
</programlisting>
</section>
<section id="wbdcoFactorY"><title>factorY (Attribute)</title>
<programlisting>
WindowBase::<xref linkend="atrFactorY"/>
<![CDATA[
>>--factorY--------------------------------------><
>>--factorY = ratio------------------------------><
]]>
</programlisting>
</section>
<section id="atrHDlg" xreflabel="hDlg"><title>hDlg (Attribute)</title>
<indexterm><primary>hDlg</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>hDlg</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>hDlg</secondary></indexterm>
<programlisting>
<![CDATA[
>>--hDlg-----------------------------------------><
>>--hDlg = varName-------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">hDlg</emphasis> attribute reflects the window <xref linkend="defHandle"/> of
the <xref linkend="ovvUnderlying"/> Windows dialog that this dialog control belongs to.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">hDlg get:</emphasis></term>
<listitem>
<para>
Returns the window handle of the underlying dialog that this dialog control belongs to.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">hDlg set:</emphasis></term>
<listitem>
<para>
The programmer can not set the <emphasis role="italic">hDlg</emphasis> attribute. It is set correctly by the
ooDialog framework and can not be changed.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::hDlg() [attribute] -->
<section id="wbdcoHwnd"><title>hwnd</title>
<programlisting>
WindowBase::<xref linkend="atrHwnd"/>
<![CDATA[
>>--hwnd-----------------------------------------><
]]>
</programlisting>
</section>
<section id="atrID" xreflabel="id"><title>id (Attribute)</title>
<indexterm><primary>id</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>id</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>id</secondary></indexterm>
<programlisting>
<![CDATA[
>>--id-------------------------------------------><
>>--id = varName---------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">id</emphasis> attribute reflects the numeric resource ID for this dialog control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">id get:</emphasis></term>
<listitem>
<para>
Returns the resource ID of the dialog control. This is always the whole number resource ID, not the <xref
linkend="defSymbolicId" />) ID, even if symbolic IDs are used for the control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">id set:</emphasis></term>
<listitem>
<para>
The programmer can not set the value of this attribute. Its value is the value of the <xref linkend="ovvUnderlying"/>
dialog control's ID, which is set when the dialog control is created by the operating system and can not be changed.
</para> </listitem></varlistentry>
</variablelist> </section> <!-- End DialogControl::id() [attribute] -->
<section id="wbdcoInitCode"><title>initCode (Attribute)</title>
<programlisting>
WindowBase::<xref linkend="atrInitCode"/>
<![CDATA[
>>--initCode-------------------------------------><
>>--initCode = code------------------------------><
]]>
</programlisting>
</section>
<section id="atrODlg" xreflabel="oDlg"><title>oDlg (Attribute)</title>
<indexterm><primary>oDlg</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>oDlg</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>oDlg</secondary></indexterm>
<programlisting>
<![CDATA[
>>--oDlg-----------------------------------------><
>>--oDlg = varName-------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">oDlg</emphasis> attribute reflects the Rexx dialog object that this dialog control belongs
to.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">oDlg get:</emphasis></term>
<listitem>
<para>
Returns the Rexx dialog object to which this dialog control belongs.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">oDlg set:</emphasis></term>
<listitem>
<para>
The programmer can not set the <emphasis role="italic">oDlg</emphasis> attribute. It is set correctly by the
ooDialog framework and can not be changed.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::oDlg() [attribute] -->
<section id="wbdcoSizeX"><title>sizeX (Attribute)</title>
<programlisting>
WindowBase::<xref linkend="atrSizeX"/>
<![CDATA[
>>--sizeX----------------------------------------><
>>--sizeX = dialogUnits--------------------------><
]]>
</programlisting>
</section>
<section id="wbdcoSizeY"><title>sizeY (Attribute)</title>
<programlisting>
WindowBase::<xref linkend="atrSizeY"/>
<![CDATA[
>>--sizeY----------------------------------------><
>>--sizeY = dialogUnits--------------------------><
]]>
</programlisting>
</section>
<section id="wbdcoPixelCX"><title>pixelCX (Attribute)</title>
<programlisting>
WindowBase::<xref linkend="atrPixelCX"/>
<![CDATA[
>>--pixelCX--------------------------------------><
]]>
</programlisting>
</section>
<section id="wbdcoPixelCY"><title>pixelCY (Attribute)</title>
<programlisting>
WindowBase::<xref linkend="atrPixelCY"/>
<![CDATA[
>>--pixelCY--------------------------------------><
]]>
</programlisting>
</section>
</section> <!-- End Attributes Section -->
<!-- <section id="sctWindowBaseDCO"><title>Basic Window Methods</title> START -->
<xi:include href="windowBaseDCO.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- <section id="sctWindowBaseDCO"><title>Basic Window Methods</title> END -->
<!-- <section id="sctWindowExtensionsDCO"><title>Extended Window Methods</title> START -->
<xi:include href="windowExtensionsDCO.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- <section id="sctWindowExtensionsDCO"><title>Extended Window Methods</title> END -->
<section id="mthAssignFocus" xreflabel="assignFocus"><title>assignFocus</title>
<indexterm><primary>assignFocus</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>assignFocus</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>assignFocus</secondary></indexterm>
<programlisting>
<![CDATA[
>>--assignFocus----------------------------------><
]]>
</programlisting>
<para>
Assigns the input focus to this dialog control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method has no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When a dialog control is assigned the focus, the operating system does more than just set the input focus to the
window. The Windows dialog manager also updates the default push button border, sets the default control identifier,
and automatically selects the text of an edit control (if the target window is an edit control).
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::assignFocus() -->
<section id="mthClearRectClsDialogControl" xreflabel="clearRect"><title>clearRect</title>
<indexterm><primary>clearRect</primary><secondary>dialog control object</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>clearRect</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>clearRect</secondary></indexterm>
<programlisting>
<![CDATA[
Form 1:
>>--clearRect(--rectangle--)---------------------><
Form 2:
>>--clearRect(--pt1--,--pt2--)-------------------><
Form 3:
>>--clearRect(--x-,--y-,--cx-,--cy--)------------><
Generic form:
>>--clearRect(--rectCoordinates--)---------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">clearRect</emphasis> method clears the specified rectangular within the client area of
this control. The rectangle is <emphasis role="italic">cleared</emphasis> by redrawing it with the background brush
set to the typical background color for dialog boxes and three dimensional elements.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>rectCoordinates [required]</term>
<listitem>
<para>
The coordinates of the rectangle to be cleared. The coordinates specify the upper left and lower right corners
of the rectangle. The corners can be specified using either a <xref linkend="clsRect"/> object, two
<xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner.
</para>
<para>
The coordinates are specified as <xref linkend="defClientArea"/> coordinates, in pixels.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
0 on success, 1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The rectangle is not really cleared, but rather is redrawn using the normal background color for a dialog box.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog control object::clearRect() -->
<section id="mthConnectCharEvent" xreflabel="connectCharEvent"><title>connectCharEvent</title>
<indexterm><primary>connectCharEvent</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>connectCharEvent</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>connectCharEvent</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectCharEvent(--+--------------+--)-------><
+--methodName--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectCharEvent</emphasis> method connects a keyboard <emphasis role="italic">character</emphasis> event notification to
this dialog control with a method in the Rexx dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The name of the Rexx method to be connected to the character event. If this argument is omitted, the ooDialog
framework uses a method name of: <emphasis role="italic">onChar</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns <computeroutput>.true</computeroutput> on success and <computeroutput>.false</computeroutput> on error.
</para>
</listitem></varlistentry>
<varlistentry id="rmkConnectCharEvent"><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The operating system translates the numeric <xref linkend="clsVK"/> key code produced by a key down /
key up combination into a numeric <emphasis role="italic">character</emphasis> code. The character code is sent to
the window with the keyboard focus in a character event notification. For enhanced 101-key and 102-key keyboards, the
<link linkend="evtDialogControlCHAR">CHAR</link> <xref linkend="evtDialogControlCHAR"/> event handler will also
receive extended key notifications. The extended keys are the INS, DEL, HOME, END, PAGE UP, PAGE DOWN and the arrow keys
in the clusters to the left of the numeric keypad.
</para>
<para>
There is not a one to one correspondence between the numeric value of a virtual key code and the numeric character
code for the same key. For example the character key code for the dash <emphasis role="italic">-</emphasis> is 45,
but 45 is the virtual key code for INSERT. I.e., <computeroutput>45 == .VK~INSERT</computeroutput> and
<computeroutput>45~d2c == -</computeroutput>.
</para>
<para>
The character codes expected to reach the <xref linkend="evtDialogControlCHAR"/> event handler are in the following
table. The explanation for the character event handler describes how to determine which character is received.
<table id="tblCharacterCode" frame="all"> <title>Numeric Character Code for the Character Event</title>
<tgroup cols="2">
<thead>
<row>
<entry>ASCII Characters</entry><entry>Numeric Codes</entry>
</row>
</thead>
<tbody>
<row>
<entry>Ctrl-A through Ctrl-Z</entry><entry>1 through 26</entry>
</row>
<row>
<entry>Ctrl-[</entry><entry>27</entry>
</row>
<row>
<entry>Ctrl-]</entry><entry>29</entry>
</row>
<row>
<entry>Normal alphabetic characters</entry><entry>use <computeroutput>d2c</computeroutput></entry>
</row>
<row>
<entry>Punctuation characters</entry><entry>use <computeroutput>d2c</computeroutput></entry>
</row>
<row>
<entry>Numeric characters</entry><entry>use <computeroutput>d2c</computeroutput></entry>
</row>
<row>
<entry>Extended keys use the <xref linkend="clsVK"/> class</entry>
</row>
</tbody></tgroup>
</table>
</para>
<para>
<emphasis role="bold">Note</emphasis> that the Microsoft documentation states that character notifications are only
generated for keys that are mapped to ASCII characters by the keyboard driver. This implies that different keyboards
may produce different character codes than those listed above. The list was produced through experimentation by the
author, using an extended keyboard, and is in general correct. Some specific details may be different for other
keyboards.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
This method requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later. If necessary
use the <xref linkend="mthComCtl32Version"/> method to determine the current version of the
library.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This is a complete working example. It can be used to experiment with the <emphasis
role="italic">connectCharEvent</emphasis> method. As the user types in the edit box, information from the character
event are printed to the console. This allows the user to see what key presses reach the application as characters:
<programlisting>
<![CDATA[
/* Print characters received */
.application~setDefaults('O', , .false)
.constDir[IDC_EDIT] = 200
dlg = .TestDialog~new
dlg~execute("SHOWTOP", IDI_DLG_OOREXX)
::requires "ooDialog.cls"
::class 'TestDialog' subclass UserDialog
::method init
forward class (super) continue
self~create(30, 30, 250, 200, "CHAR Tester", "CENTER")
::method defineDialog
self~createEdit(IDC_EDIT, 10, 10, 230, 155, "MULTILINE")
self~createPushButton(IDOK, 135, 175, 50, 14, "DEFAULT", "Ok")
self~createPushButton(IDCANCEL, 190, 175, 50, 14, , "Cancel")
::method initDialog
self~newEdit(IDC_EDIT)~connectCharEvent(onChar)
::method onChar unguarded
use arg char, isShift, isCtrl, isAlt, misc, control
if misc~pos('extended') <> 0 then c = .VK~key2name(char)
else c = char~d2c
say 'Char:' char c 'isShift' isShift 'isCtrl' isCtrl 'isAlt' isAlt 'misc' misc
return .true
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
<section id="evtDialogControlCHAR"><title>Char Event Handler</title>
<indexterm><primary>dialog control object Event</primary><secondary>CHAR</secondary></indexterm>
<para>
The <xref linkend="ovvEvents"/> handler for the char event is invoked when the dialog control has the
keyboard focus and the user types a key or a keyboard combination that the operating system translates to a
<link linkend="rmkConnectCharEvent">character</link>.
</para>
<para>
The programmer must return a value from the event handler and the interpreter waits for this return. Generic information on
how to <link linkend="sctCodingEventHandlers">code</link> event handlers is included in the documentation for the <xref
linkend="clsEventNotification"/> class.
</para>
<programlisting>
<![CDATA[
::method onChar unguarded
use arg char, isShift, isCtrl, isAlt, misc, controlObj
return response
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">Event Handler Method Arguments:</emphasis></term>
<listitem>
<para>
The event handling method receives 6 arguments:
</para>
<variablelist>
<varlistentry><term>char</term>
<listitem>
<para>
The numeric character code of the key pressed, or on extended keyboards, the virtual key code of an extended key.
</para>
<para>
For enhanced 101-key and 102-key keyboards, the extended keys are the INS, DEL, HOME, END, PAGE UP, PAGE DOWN and
the arrow keys in the clusters to the left of the numeric keypad.
</para>
<para>
To determine the character received use <computeroutput>char~d2c</computeroutput> when <emphasis
role="italic">isCtrl</emphasis> is false and <emphasis role="italic">misc</emphasis> does <emphasis
role="italic">not</emphasis> contain the word <emphasis role="italic">extended</emphasis>. Use the <xref
linkend="clsVK" />) class when <emphasis role="italic">isCtrl</emphasis> is false and <emphasis
role="italic">misc</emphasis> contains the word <emphasis role="italic">extended</emphasis>.
</para>
<para>
In addition, the characters Ctrl-A through Ctrl-Z, plus Ctrl-[ and Ctrl-] are received. For this group of
characters, the <emphasis role="italic">isCtrl</emphasis> argument will be true and the numeric value of
<emphasis role="italic">char</emphasis> will be 1 through 26 for Ctrl-A through Ctrl-Z, 27 for Ctrl-[, and 29 for
Ctrl-]
</para>
</listitem></varlistentry>
<varlistentry><term>isShift</term>
<listitem>
<para>
A boolean (true or false) that denotes whether a shift key was down or up at the time of the key press. It will
be true if a shift key was down and false if the shift key was not down.
</para>
</listitem></varlistentry>
<varlistentry><term>isCtrl</term>
<listitem>
<para>
True if a control key was down at the time of the key press, false if it was not.
</para>
</listitem></varlistentry>
<varlistentry><term>isAlt</term>
<listitem>
<para>
True if an alt key was down at the time of the key press, false if it was not.
</para>
</listitem></varlistentry>
<varlistentry><term>extraInfo</term>
<listitem>
<para>
This argument is a string containing keywords. It supplies extra information about the keyboard state at the
time of a key press event. The string will contain some combination of these keywords
<variablelist>
<varlistentry><term>extended</term>
<listitem>
<para>
The character event is for one of the extended keys previously mentioned, INS, DEL, HOME, END, PAGE UP, PAGE
DOWN, or one of the arrow keys.
</para>
</listitem></varlistentry>
<varlistentry><term>numOn</term>
<listitem>
<para>
Num Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>numOff</term>
<listitem>
<para>
Num Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>capsOn</term>
<listitem>
<para>
Caps Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>capsOff</term>
<listitem>
<para>
Caps Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>scrollOn</term>
<listitem>
<para>
Scroll Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>scrollOff</term>
<listitem>
<para>
Scroll Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>lShift</term>
<listitem>
<para>
The left shift key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rShift</term>
<listitem>
<para>
The right shift key was down.
</para>
</listitem></varlistentry>
<varlistentry><term>lControl</term>
<listitem>
<para>
The left control key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rControl</term>
<listitem>
<para>
The right control key was down.
</para>
</listitem></varlistentry>
<varlistentry><term>lAlt</term>
<listitem>
<para>
The left alt key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rAlt</term>
<listitem>
<para>
The right alt key was down.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>controlObj</term>
<listitem>
<para>
The dialog control object representing the underlying control that recieved the keyboard character event notification.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return:</emphasis></term>
<listitem>
<para>
The event handler must return <computeroutput>.true</computeroutput>, <computeroutput>.false</computeroutput>, or a
numeric character code. Returning <computeroutput>.true</computeroutput> passes the event notification on to the control
unchanged. Returning <computeroutput>.false</computeroutput> prevents the character from being sent on to the control.
This has the effect of <emphasis role="italic">swallowing</emphasis> the character. The control will not be aware of the
character. Passing a numeric character back has the effect of replacing what the character was, with the character passed
back.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example</emphasis></term>
<listitem>
<para>
This example comes from some code my nephew wrote. I wrote a typing tutorial for my neice and nephews, they each had
their own copy. Each week their typing scores were expected to get better. If their score was worse, they were
assigned extra chores for the next week. My nephew injected the following code into his brother's typing tutorial.
He thought it was hilarious, his brother was not amused:
<programlisting>
<![CDATA[
self~newEdit(IDC_EDIT_TYPING_WINDOW)~connectCharEvent(onChar)
::method onChar unguarded
use arg char, isShift, isCtrl, isAlt, misc, control
if misc~pos('extended') <> 0 then do
if char == .VK~END then char = .VK~HOME
else if char == .VK~HOME then char = .VK~END
else if char == .VK~LEFT then char = .VK~RIGHT
end
else do
if char~d2c == 'a' then char = 'z'~c2d
else if char~d2c == 'i' then char = 'k'~c2d
end
return char
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End char Event Handler -->
</section> <!-- End DialogControl::connectCharEvent() -->
<section id="mthConnectFKeyPressDialogControlObject" xreflabel="connectFKeyPress"><title>connectFKeyPress</title>
<indexterm><primary>connectFKeyPress</primary><secondary>dialog control object</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>connectFKeyPress</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>connectFKeyPress</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectFKeyPress(--methodName--)-------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">connectFKeyPress</emphasis> method connects all F Key key press events to a method in the
Rexx dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single arguments is:
<variablelist>
<varlistentry><term>methodName [required]</term>
<listitem>
<para>
The name of the method that is to be invoked when a F Key key press event happens. The method name can not be
the empty string. The method is defined by the programmer in the dialog class that is the parent to the dialog
control.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
Success.
</para>
</listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem>
<para>
The underlying mechanism in the Windows API that is used to capture key events failed.
</para>
</listitem></varlistentry>
<varlistentry><term>-6</term>
<listitem>
<para>
The maximum number of connections has been reached.
</para>
</listitem></varlistentry>
<varlistentry><term>-7</term>
<listitem>
<para>
The <emphasis role="italic">methodName</emphasis> method is already connected to a key down event for this
dialog.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">connectFKeyPress</emphasis> method is a convenience method for the <xref
linkend="mthConnectKeyPressDialogControlObject"/> method. It is equivalent to using the
<emphasis role="italic">connectKeyPress</emphasis> method and supplying the FKEYS keyword for the <emphasis
role="italic">keys</emphasis> argument and omitting the <emphasis role="italic">filter</emphasis> argument. The
<emphasis role="italic">connectKeyPress</emphasis> method documentation goes into deeper detail in explaining how
the <emphasis role="italic">connectKeyPress</emphasis> method, and by extension the <emphasis
role="italic">connectFKeyPress</emphasis> method, works.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method requires CommonControl<xref linkend="ovvComctl32"/> version 6.0 or later. If necessary
use the <xref linkend="mthComCtl32Version"/> method to determine the current version of the
library.
</para>
<para>
Raises syntax errors when some incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example connects the F key down events for an edit control. The application determines which F key
was pressed and takes appropriate action. For this application, the F3 key is the search key.
<programlisting>
<![CDATA[
::method initDialog
expose editControl lastSearchToken
editControl = self~newEdit(IDC_EDIT)
editControl~connectFKeyPress(onFKey)
...
lastSearchToken = ""
...
::method onFKey
expose editControl lastSearchToken
use arg key
select
when key == .VK~F2 then do
...
end
when key == .VK~F3 then do
description = "What word would you like to search for?"
lastSearchToken = inputBox(description, "Search", lastSearchToken)
if lastSearchToken <> "" then
self~findAndHighlight(lastSearchToken, editControl)
end
when key == .VK~F4 then do
...
end
...
end
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog control object::connectFKeyPress() -->
<section id="mthConnectKeyPressDialogControlObject" xreflabel="connectKeyPress"><title>connectKeyPress</title>
<indexterm><primary>connectKeyPress</primary><secondary>dialog control object</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>connectKeyPress</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>connectKeyPress</secondary></indexterm>
<programlisting>
<![CDATA[
>>--connectKeyPress(--methodName--,--keys--+-----------+--)-----><
+-,-filter--+
]]>
</programlisting>
<para>
The <emphasis role="italic">connectKeyPress</emphasis> method connects a key press <xref linkend="ovvEvents"/>
notification with a method in the Rexx dialog. A single key or multiple keys can be
connected to the same method. Multiple methods can be connected for key press events, but only 1 method can be
connected to any single key.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>methodName [required]</term>
<listitem>
<para>
The name of the method that is to be invoked when the key press event happens. The method name can not be the
empty string. The method is defined by the programmer in the dialog class that is the parent to the dialog
control.
</para>
</listitem></varlistentry>
<varlistentry><term>keys [required]</term>
<listitem>
<para>
The key (or keys) for which the key press event is to be connected. A single key or multiple keys can be
specified. A range of keys can be used. Each single key or range of keys is separated by a comma. A range of
keys is denoted by using the dash character &quot;-&quot;. White space within the <emphasis
role="italic">keys</emphasis> argument is ignored. This argument can not be the empty string.
</para>
<para>
The keys are specified by the numeric value defined by Microsoft for its virtual key set. These numeric values
are 0 through 255. There are some integer values between 0 and 255 that do not have a vitural key assigned to
them. For example, 0, 7, 10, 11, and 255 are not used. The <xref linkend="clsVK"/> class contains
constants for all of the defined virtual keys.
</para>
<para>
In addition, there are a few keywords that can be used to specify some common key ranges. These keywords are:
<variablelist>
<varlistentry><term>ALL</term>
<listitem>
<para>
All keys.
</para>
</listitem></varlistentry>
<varlistentry><term>FKEYS</term>
<listitem>
<para>
All Function keys, other than F1. (In Windows the F1 key is the help key and the <xref
linkend="mthConnectHelp"/> method should be used for F1.)
</para>
</listitem></varlistentry>
<varlistentry><term>ALPHA</term>
<listitem>
<para>
The keys A though Z.
</para>
</listitem></varlistentry>
<varlistentry><term>NUMERIC</term>
<listitem>
<para>
The keys 0 through 9. Note that these are the normal number keys, not the keypad numbers on an enhanced
keyboard.
</para>
</listitem></varlistentry>
<varlistentry><term>ALPHANUMERIC</term>
<listitem>
<para>
The keys A through Z and 0 through 9.
</para>
</listitem></varlistentry>
</variablelist>
</para>
<para>
<emphasis role="bold">Note</emphasis> that case is insignificant for these keywords as is the order of the
keywords. A keyword not in the list will result in a return of -9. However, if the argument contains other valid
key tokens, those keys will be connected to the method. If there are no other valid key tokens, then no
connection is made.
</para>
</listitem></varlistentry>
<varlistentry><term>filter [optional]</term>
<listitem>
<para>
A (simplistic) filter that is applied to the key press event for the key(s) specified. The filter is a string of
keywords separated by blanks. (Case is not significant, neither is the order of the words. Any words other than
the specified keywords are ignored.) The possible keywords are: <computeroutput>SHIFT, CONTROL, ALT, AND, NONE,
VIRTUAL.</computeroutput>
</para>
<para>
The VIRTUAL keyword can be abbreviated to VIRT if desired. The VIRTUAL keyword effects how the test for the
shift, control, and alt key is performed. By default the physical state of the keyboard is checked to see if the
control, alt, or shift key is depressed. However, it is common in Windows to use keystroke programs that inject
keystrokes into other application windows. Testing the physical state of the keyboard will not detect
combination keystrokes like Ctrl-S, Alt-L, etc., that are inserted by keystroke programs because the physical
state of the modifier keys control and alt will not be depressed. If the VIRTUAL keyword is used, the test for
the modifier keys being down will be altered in a way that will detect if the virtual state of the key is down.
This test will detect key events inserted into the Rexx application by third party keystroke programs.
</para>
<para>
Shift, control, and alt specify that the corresponding key must be down at the time of the key press event. These
keywords are combined in a boolean expression. The default is an OR expression. If the AND keyword is present
then the boolean expression is an AND expression. If the NONE keyword is used, it means that none of the shift,
control, or alt keys can be down at the time of the key press event. (When NONE is used, all other words,
except VIRTUAL, in the string are ignored.)
</para>
<para>
Some examples may make this more clear:
<programlisting>
<![CDATA[
::method initDialog
editControl = self~newEdit(IDC_EDIT1)
-- Using the below, the onAltCD method would be invoked when the user types
-- Alt-Shift-C or Alt-Shift-D when the edit control has the focus. But the
-- method would not be invoked for Alt-C or Shift-D (or any other key press
-- event.)
keys = .VK~C "," .VK~D
editControl~connectKeyPress(onAltCD, keys, "ALT AND SHIFT")
-- The below would invoke the onAltCD method any time a C or a D was typed,
-- when the edit control has the focus, with either the Alt or the Control key
-- also being down. This would include Alt-C, Alt-Shift-C, Ctrl-Alt-Shift-C,
-- etc..
editControl~connectKeyPress(onAltCD, keys, "ALT CONTROL")
-- The below would invoke the onAltCD method only when Alt-C or Alt-D was
-- typed.
editControl~connectKeyPress(onAltCD, keys, "ALT AND")
-- The below would invoke the onF4 method when the edit control has the focus,
-- only when the F4 key was pressed by itself. Alt-F4, Ctrl-F4, etc., would
-- not invoke the method.
editControl~connectKeyPress(onF4, .VK~F4, "NONE")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
Success.
</para>
</listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem>
<para>
The underlying mechanism in the Windows API that is used to capture key events failed.
</para>
</listitem></varlistentry>
<varlistentry><term>-6</term>
<listitem>
<para>
The maximum number of connections has been reached.
</para>
</listitem></varlistentry>
<varlistentry><term>-7</term>
<listitem>
<para>
The <emphasis role="italic">methodName</emphasis> method is already connected to a key down event for this
dialog.
</para>
</listitem></varlistentry>
<varlistentry><term>-8</term>
<listitem>
<para>
The <emphasis role="italic">filter</emphasis> argument is not correct.
</para>
</listitem></varlistentry>
<varlistentry><term>-9</term>
<listitem>
<para>
An incorrect format for the <emphasis role="italic">keys</emphasis> argument. Note that it is possible to get a
return of -9 but still have some keys connected. For instance in the following example the C and D keys would be
connected and the filter applied. The &quot;"dog&quot;" token would result in -9 being returned:
<programlisting>
<![CDATA[
editControl = self~newEdit(IDC_EDIT_ENTRY)
keys = .VK~C ", dog," .VK~D
ret = editControl~connectKeyPress('onAltCD', keys, "ALT AND SHIFT")
say 'Got a return of:' ret
say "Have connection to onAltCD?" self~hasKeyPressConnection('onAltCD')
-- The output would be:
Got a return of: -9
Have connection to onAltCD? 1
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
There is a maximum limit of 63 methods, per dialog, that can be connected to key press events. Connections can be
removed using the <xref linkend="mthDisconnectKeyPressDialogControlObject"/> method if there
is no longer a need for a notification of a key press.
</para>
<para>
The dialog object also has a <xref linkend="mthConnectKeyPressDialogObject"/> method. It is
important to note this distinction between the two methods. The method of the dialog control object (this method)
will capture any key press event when the specific dialog control has the focus. The method of the dialg object will
capture all key press events when the dialog is the active window.
</para>
<para>
This includes key presses when a dialog control in the dialog has the focus. This implies that if you connect the
same key press event to both the dialog and to a specific dialog control, if the key press event ocurrs when the
dialog control has the focus, you will receive two event notifications.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
This method requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later. If necessary
use the <xref linkend="mthComCtl32Version"/> method to determine the current version of the
library.
</para>
<para>
Raises syntax errors when some incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Event Handler Method Arguments:</emphasis></term>
<listitem>
<para>
The ooDialog method connected to the key press event will receive the following five arguments in the order listed:
<variablelist>
<varlistentry><term>keyCode</term>
<listitem>
<para>
The numeric code of the key pressed.
</para>
</listitem></varlistentry>
<varlistentry><term>shift</term>
<listitem>
<para>
A boolean (true or false) that denotes whether a shift key was down or up at the time of the key press. It will
be true if a shift key was down and false if the shift key was not down.
</para>
</listitem></varlistentry>
<varlistentry><term>control</term>
<listitem>
<para>
True if a control key was down at the time of the key press, false if it was not.
</para>
</listitem></varlistentry>
<varlistentry><term>alt</term>
<listitem>
<para>
True if an alt key was down at the time of the key press, false if it was not.
</para>
</listitem></varlistentry>
<varlistentry><term>extraInfo</term>
<listitem>
<para>
This argument is a string containing keywords. It supplies extra information about the keyboard state at the
time of a key press event. The string will contain some combination of these keywords
<variablelist>
<varlistentry><term>numOn</term>
<listitem>
<para>
Num Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>numOff</term>
<listitem>
<para>
Num Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>capsOn</term>
<listitem>
<para>
Caps Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>capsOff</term>
<listitem>
<para>
Caps Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>scrollOn</term>
<listitem>
<para>
Scroll Lock was on at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>scrollOff</term>
<listitem>
<para>
Scroll Lock was off.
</para>
</listitem></varlistentry>
<varlistentry><term>lShift</term>
<listitem>
<para>
The left shift key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rShift</term>
<listitem>
<para>
The right shift key was down.
</para>
</listitem></varlistentry>
<varlistentry><term>lControl</term>
<listitem>
<para>
The left control key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rControl</term>
<listitem>
<para>
The right control key was down.
</para>
</listitem></varlistentry>
<varlistentry><term>lAlt</term>
<listitem>
<para>
The left alt key was down at the time of the key press event.
</para>
</listitem></varlistentry>
<varlistentry><term>rAlt</term>
<listitem>
<para>
The right alt key was down.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example could be from an application that supplies extended editing abilities for a multi-line edit
control. When the edit control has the focus the user can use Alt-D to delete the current word, Ctrl-D to delete
the current line, and Shift-Alt-D delete the current paragraph:
<programlisting>
<![CDATA[
::method initDialog
expose editControl
editControl = self~newEdit(IDC_EDTIT)
...
-- Capture the D key press when either the Alt or Control keys are
-- also pressed.
editControl~connectKeyPress(onDPress, .VK~D, "ALT CONTROL")
...
::method onDPress
expose editControl
use arg key, shift, control, alt, info
-- Determine which of the key press combinations this is and take
-- appropriate action if it is a combination we are interested in.
isAltD = \ shift & \ control & alt
isCtrlD = \ shift & control & \ alt
isShiftAltD = shift & \ control & alt
if isAltD then self~deleteWord(editControl)
if isCtrlD the self~deleteLine(editControl)
if isShiftAltD then self~deleteParagraph(editControl)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog control object::connectKeyPress() -->
<section id="mthData" xreflabel="data"><title>data</title>
<indexterm><primary>data method</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>data method</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>data method</secondary></indexterm>
<programlisting>
<![CDATA[
>>--data-----------------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">data</emphasis> method retrieves the current
<link linkend="sctUnderstandingDataAttributes">data</link> of the dialog control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method does not take any arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The current <emphasis role="italic">data</emphasis> of the dialog control. Exactly what the format of the <emphasis
role="italic">data</emphasis> takes is dependent on the type of the control. The Data Attribute Methods
<link linkend="sctDataAttributes">xection</link> of this reference has a detailed discussion on data attributes and the
meaning of the <emphasis role="italic">data</emphasis> of a dialog control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method was really intended to be used on controls that have previously been connected to a data attribute.
But, since the dialog control object, itself, knows which type of control it is, the method works whether the
control is connected or not. However, the abstraction of viewing a dialog control's state as data, represented by a
single string, is restrictive and somewhat out of date. It is more flexible, and often easier, to use the methods of
the specific dialog control object to determine the control's state.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example determines if the restart check box is checked, and if so sets a flag that tells the
application to restart the computer:
<programlisting>
<![CDATA[
::method leaving
expose restartChk fancyFont logoBmp appCleanUpParams
if restartChk~data == 1 then do
self~deleteFont(fancyFont)
logoBmp~release
appCleanUpParams['NoErrs'] = .true
appCleanUpParams['UserOK'] = .true
appCleanUpParams['Restart'] = .true
end
else do
...
appCleanUpParams['Restart'] = .false
end
]]>
</programlisting>
The same thing can be accomplished in this manner:
<programlisting>
<![CDATA[
::method leaving
expose restartChk fancyFont logoBmp appCleanUpParams
if restartChk~checked then do
self~deleteFont(fancyFont)
logoBmp~release
appCleanUpParams['NoErrs'] = .true
appCleanUpParams['UserOK'] = .true
appCleanUpParams['Restart'] = .true
end
else do
...
appCleanUpParams['Restart'] = .false
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog control object::data() -->
<section id="mthDataEquals"><title>data=</title>
<indexterm><primary>data=</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>data=</secondary></indexterm>
<indexterm><primary>DialogCcontrol class</primary><secondary>data=</secondary></indexterm>
<programlisting>
<![CDATA[
>>--data = newData-------------------------------><
]]>
</programlisting>
<para>
Sets the <link linkend="sctUnderstandingDataAttributes">data</link> of the dialog control to the new value specified.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<variablelist>
<varlistentry><term>newData [required]</term>
<listitem>
<para>
The value used to set the <emphasis role="italic">data</emphasis> of the dialog control. The exact format of this
value is dependent on the type of the control. The Data Attribute Methods <link
linkend="sctDataAttributes">section</link> of this reference has a detailed discussion on data attributes and the
meaning of the <emphasis role="italic">data</emphasis> of a dialog control.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method was really intended to be used on controls that have previously been connected to a data attribute.
But, since the dialog control object, itself, knows which type of control it is, the method works whether the
control is connected or not. However, the abstraction of viewing a dialog control's state as data is restrictive and
somewhat out of date. It is more flexible, and often easier, to use the methods of the specific dialog control
object to set the control's state.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example checks the restart check box and unchecks the verify check box:
<programlisting>
<![CDATA[
::method setRestart private
expose restartChk verifyChk
restartChk~data = 1
verifyChk~data = 0
]]>
</programlisting>
The same thing can be accomplished in this manner:
<programlisting>
<![CDATA[
::method setRestart private
expose restartChk verifyChk
restartChk~check
verifyChk~uncheck
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog control object::data= -->
<section id="mthDisconnectKeyPressDialogControlObject" xreflabel="disconnectKeyPress"><title>disconnectKeyPress</title>
<indexterm><primary>disconnectKeyPress</primary><secondary>dialog control object</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>disconnectKeyPress</secondary></indexterm>
<indexterm><primary>DialogControl object</primary><secondary>disconnectKeyPress</secondary></indexterm>
<programlisting>
<![CDATA[
>>--disconnectKeyPress(--+--------------+--)-----><
+--methodName--+
]]>
</programlisting>
<para>
Disconnects a method in the Rexx dialog from a previously connected key press <xref linkend="ovvEvents"/>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
The method to be disconnected. If omitted then all key press events are disconnected.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The possible return values are:
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>
Success.
</para>
</listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem>
<para>
While trying to disconnect the method, the underlying mechanism in the Windows API that is used to capture key
events had an error. This is unlikely to happen.
</para>
</listitem></varlistentry>
<varlistentry><term>-7</term>
<listitem>
<para>
Either the <emphasis role="italic">methodName</emphasis> method is already disconnected, or there are no methods
connected at all.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The dialog object also has a <xref linkend="mthDisconnectKeyPressDialogObject"/> method.
The method of the dialog control object (this method) can only disconnect key press events that were set with the
dialog control object's versions of <xref linkend="mthConnectKeyPressDialogControlObject"/> and
<xref linkend="mthConnectFKeyPressDialogControlObject"/> methods. This method can not
disconnect key press events that were set with the dialog object's versions of <xref
linkend="mthConnectKeyPressDialogObject"/> and <xref linkend="mthConnectFKeyPressDialogObject"/> methods.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
This method requires Common Control <xref linkend="ovvComctl32"/> version 6.0 or later. If necessary
use the <xref linkend="mthComCtl32Version"/> method to determine the current version of the
library.
</para>
<para>
Raises syntax errors when some incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example could come from a dialog where the user can enable or disable the use of hot keys when she is
working within an edit control. When the user presses the disable hot keys button, the dialog disables
the hot keys for the edit control by removing the key press connections.
<programlisting>
<![CDATA[
::method defineDialog
...
self~createPushButton(IDC_PB_DISABLE, 60, 135, 65, 15, , "Disable Hot Keys", onDisable)
...
method onDisable
editControl = self~newEdit(IDC_EDIT)
editControl~disconnectKeyPress
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog control object::disconnectKeyPress() -->
<section id="mthGetTextSizeDlgClsDialogControl" xreflabel="getTextSizeDlg"><title>getTextSizeDlg</title>
<indexterm><primary>getTextSizeDlg</primary><secondary>dialog control object</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>getTextSizeDlg</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>getTextSizeDlg</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getTextSizeDlg(--text--+-------------+--+-------------+--+---------+--)----><
+-,-fontname--+ +-,-fontSize--+ +-,-hwnd--+
]]>
</programlisting>
<para>
Calculates the size, (width and height,) in <xref linkend="defDialogUnit"/> for a given string.
</para>
<para>
<emphasis role="bold">Note:</emphasis> The convoluted arguments to this method are needed to retain backwards
compatibility with older versions of ooDialog. The recommendation is that the ooDialog programmer not use this method
of the dialog control object.
</para>
<para>
In general, dialog units are only of value in laying out the dialog controls before the underlying dialog is
created. Once the underlying dialog is created, it makes more sense to work with pixels. In addition, dialog units
are tied directly to the actual font used by a specific dialog. Therefore, the optional arguments do not make much
sense. Since the dialog object directly knows which font it is using, and the dialog control does not, it does not
make much sense for this method to be a method of a dialog control in the first place.
</para>
<para>
The ooDialog programmer is therefore <emphasis role="bold">strongly</emphasis> encouraged to use the <xref
linkend="mthGetTextSizeDu"/> method of the <xref linkend="chpDialogObject"/> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The string whose size is desired. If none of the optional arguments are specified then the font of the dialog
that owns the control is used to calculate the size.
</para>
<para>
However, there are some exceptions to this if the method is invoked <emphasis role="italic">after</emphasis> the
underlying dialog is created.
<orderedlist>
<listitem>
<para>
If this method is invoked through a dialog control object, then the size is calculated using the dialog
control font. This usage is deprecated and the ooDialog programmer is <emphasis
role="bold">strongly</emphasis> encouraged to not use this method in this manner.
</para>
</listitem>
<listitem>
<para>
If the fourth, optional, hwnd argument is used, then the font of that window is used to calculate the size.
Again, the ooDialog programmer is <emphasis role="bold">strongly</emphasis> encouraged to not use this
method in this manner.
</para>
</listitem>
</orderedlist>
</para>
</listitem></varlistentry>
<varlistentry><term>fontName [optional]</term>
<listitem>
<para>
The name of the font to use to calculate the size needed for the string. Use this argument when the string will
be displayed in a font <emphasis role="bold">different</emphasis> than the dialog font.
</para>
</listitem></varlistentry>
<varlistentry><term>fontSize [optional]</term>
<listitem>
<para>
The size of the font named by the fontName argument. If this argument is omitted then the default font size is
used. (Currently the default size is 8.) This argument is ignored completely when the fontName argument is
omitted.
</para>
</listitem></varlistentry>
<varlistentry><term>hwnd [optional]</term>
<listitem>
<para>
Optional. A valid window handle. The font of this window is used to calculate the text size. This argument is
always ignored when the fontName argument is specified. As per the notes above the ooDialog programmer is
encouraged not to use this argument.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The size needed for the string is returned in a <xref linkend="clsSize"/> object. The size is specified
in dialog units.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::getTextSizeDlg() -->
<section id="mthGroup" xreflabel="group"><title>group</title>
<indexterm><primary>group</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>group</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>group</secondary></indexterm>
<programlisting>
<![CDATA[
>>--group(--+-----------+--)---------------------><
+-wantStyle-+
]]>
</programlisting>
<para>
Adds or removes the <xref linkend="wsgroup"/> style for this control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The only argument is
<variablelist>
<varlistentry><term>wantStyle [optional]</term>
<listitem>
<para>
A boolean (.true or .false) to indicate whether the control should have or not have the group style. True (the
default) indicates the control should have the group style and false indicates the control should not have the
style.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Negative values indicate the function failed, positive values indicate success.
<variablelist>
<varlistentry><term>Less than 0</term>
<listitem>
<para>
The value is the negated operating system error code.
</para>
</listitem></varlistentry>
<varlistentry><term>Greater than 0</term>
<listitem>
<para>
The window style of the dialog control prior to adding or removing the group style.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The group style controls how the user can navigate through the dialog using the keyboard. For most dialogs this
does not change while the dialog is executing. However, in some dialogs the programmer may want to change the
navigation depending on the options the user selects.
</para>
<para>
The negative return value from this method is a hold over from a period prior to the introduction of the <xref
linkend="dotSystemErrorCode"/>. This method now sets the
<computeroutput>.systemErrorCode</computeroutput>, making it easier to use the negative return as a failure
indication and use the <computeroutput>.systemErrorCode</computeroutput> value to look up the actual error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::group() -->
<section id="mthHasKeyPressConnectionDialogControlObject" xreflabel="hasKeyPressConnection"><title>hasKeyPressConnection</title>
<indexterm><primary>hasKeyPressConnection</primary><secondary>dialog control object</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>hasKeyPressConnection</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>hasKeyPressConnection</secondary></indexterm>
<programlisting>
<![CDATA[
>>--hasKeyPressConnection(--+--------------+--)--><
+--methodName--+
]]>
</programlisting>
<para>
Queries if a specific method in the Rexx dialog has a connection to a key down event, or if any methods are connected
to a key down event.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>methodName [optional]</term>
<listitem>
<para>
If <emphasis role="italic">methodName</emphasis> is specified, then this method checks if there is a key press
event connected to that method. When the argument is omitted, then the check is if any methods are connected to
key press events.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns <computeroutput>.true</computeroutput> if a key press event connection exists, otherwise
<computeroutput>.false</computeroutput>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The dialog object also has a <xref linkend="mthHasKeyPressConnectionDialogObject"/>
method. The method of the dialog control object (this method) can only check for connections that were set with the
dialog control object's versions of <xref linkend="mthConnectKeyPressDialogControlObject"/> and
<xref linkend="mthConnectFKeyPressDialogControlObject"/> methods. This method can not check
for connections that were set with the dialog object's versions of <xref linkend="mthConnectKeyPressDialogObject"/> and
<xref linkend="mthConnectFKeyPressDialogObject"/> methods.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
The following example is from an application where the user can enable the use of hot keys when an edit control has
the focus, or not. The reset push button is used in the application to reset the state of the dialog. One of the
things done when the state is reset to check or uncheck a check box that shows whether hot keys are currently
enabled or not.
<programlisting>
<![CDATA[
::method defineDialog
...
self~createCheckBox(IDC_CHECK_FKEYSENABlED, 30, 60, , , , "Hot Keys Enabled")
...
self~createPushButton(IDC_PB_RESET, 60, 135, 45, 15, , "Reset", onReset)
...
::method onReset
...
editControl = self~newEdit(IDC_EDIT)
if editControl~hasKeyPressConnection then
self~newCheckBox(IDC_CHECK_FKEYSENABlED)~check
else
self~newCheckBox(IDC_CHECK_FKEYSENABlED)~uncheck
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End dialog control object::hasKeyPressConnection() -->
<section id="mthRedrawRectClsDialogControl" xreflabel="redrawRect"><title>redrawRect</title>
<indexterm><primary>redrawRect</primary><secondary>dialog control object</secondary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>redrawRect</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>redrawRect</secondary></indexterm>
<programlisting>
<![CDATA[
Form 1:
>>--redrawRect(--rectangle--+---------+--)----------------------><
+-,-erase-+
Form 2:
>>--redrawRect(--pt1--,--pt2--+---------+--)--------------------><
+-,-erase-+
Form 3:
>>--redrawRect(--x-,--y-,--x1-,--y1--+---------+--)-------------><
+-,-erase-+
Generic form:
>>--redrawRect(--rectCoordinates--+---------+--)----------------><
+-,-erase-+
]]>
</programlisting>
<para>
The <emphasis role="italic">redrawRect</emphasis> method redraws the specified
<link linkend="ovvRectangleCoordinates">bounding</link> rectangle within the client area of this dialog control. Optionally
the background of the rectangle can be erased first.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>rectCoordinates [required]</term>
<listitem>
<para>
The coordinates of the rectangle to be redrawn. The coordinates specify the upper left and lower right corners
of the rectangle. The corners can be specified using either a <xref linkend="clsRect"/> object, two
<xref linkend="clsPoint"/> objects, or the individual x and y coordinates of each corner.
</para>
<para>
The coordinates are specified as <xref linkend="defClientArea"/> coordinates, in pixels.
</para>
</listitem></varlistentry>
<varlistentry><term>erase [optional]</term>
<listitem>
<para>
A boolean (<computeroutput>.true</computeroutput> or <computeroutput>.false</computeroutput>) that specifies
whether the background of the rectangle should be redrawn (<computeroutput>.true</computeroutput>) or not
<computeroutput>.false</computeroutput>.) The default is <computeroutput>.false</computeroutput>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
0 on success, 1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
For the <emphasis role="italic">erase</emphasis> argument, the background is not really erased, but rather the
background is specified to be redrawn also. By default the operating system does not redraw the background.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::redrawRect() -->
<section id="mthSetColor" xreflabel="setColor"><title>setColor</title>
<indexterm><primary>setColor</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>setColor</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>setColor</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setColor(--+------+--+-------+--+---------+--)--------------><
+-,-bk-+ +-,-fg--+ +-,-isClr-+
]]>
</programlisting>
<para>
Sets the background color or foreground color, or both, for this dialog control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>bk [optionaal]</term>
<listitem>
<para>
Specifies the the background color for this dialog control. This may either be a palette <xref linkend="defColor"/>,
or a <xref linkend="defColorRef"/> number. To use a COLORREF, the <emphasis role="italic">isClr</emphasis> argument
must be true.
</para>
</listitem></varlistentry>
<varlistentry><term>fg [optional]</term>
<listitem>
<para>
Specifies the the foreground color for this dialog control. This may either be a palette <xref linkend="defColor"/>,
or a <xref linkend="defColorRef"/> number. To use a COLORREF, the <emphasis role="italic">isClr</emphasis> argument
must be true. The foreground color is the color that text is written in.
</para>
</listitem></varlistentry>
<varlistentry><term>isClr [optional]</term>
<listitem>
<para>
Specifies if the <emphasis role="italic">bg</emphasis> and <emphasis role="italic">fg</emphasis> arguments are to be
interpreted as palette indexes or COLORREF numbers. The default if omitted is false.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0 on success or 1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">bk</emphasis> and <emphasis role="italic">fg</emphasis> arguments must be specified in the
same way. They must both be either palette indexes or both be COLORREF numbers. If the <emphasis
role="italic">bk</emphasis> argument is omitted, the ooDialog framework ensures that the operating system paints the
background using the same color as the dialog background.
</para>
<para>
Earlier versions of ooDialog had a restriction on the number of different dialog controls that could have their
control changed from their default color. In ooDialog version 4.2.0 that restriction was lifted and there is no
limit to the number of controls having their color set.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example changes the text color of a static control in the dialog to a bright red using a COLORREF number:
<programlisting>
<![CDATA[
::method changeColor
expose staticText
staticText~setColor( , .Image~colorRef(161, 6, 17), .true)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::setColor() -->
<section id="mthSetSysColor" xreflabel="setSysColor"><title>setSysColor</title>
<indexterm><primary>setSysColor</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>setSysColor</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>setSysColor</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setSysColor(--+------+--+-------+--)---------><
+-,-bk-+ +-,-fg--+
]]>
</programlisting>
<para>
Sets the background color or foreground color, or both, for this dialog control using the system <link
linkend="defSysColor">colors</link>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>bk [optional]</term>
<listitem>
<para>
The system color ID for the background color of the dialog control. This can be either the whole number ID or
the keyword ID. IDs can be looked up in the System Color Elements <link linkend="tblSysColors">table</link>
</para>
</listitem></varlistentry>
<varlistentry><term>fg [optional]</term>
<listitem>
<para>
The system color for the foreground color of the dialog control. The foreground color is the color that text is
written in. This can be either the whole number ID or the keyword ID. IDs can be looked up in the System Color
Elements <link linkend="tblSysColors">table</link>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0 on success or 1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
If the <emphasis role="italic">bk</emphasis> is omitted, the ooDialog framework ensures that the operating system paints
the background of the control the same color as the background of the dialog. The <emphasis role="italic">bk</emphasis> and <emphasis role="italic">fg</emphasis> arguments must be specified in the
same way. They must both be either palette indexes or both be COLORREF numbers.
</para>
<para>
Earlier versions of ooDialog had a restriction on the number of different dialog controls that could have their
control changed from their default color. In ooDialog version 4.2.0 that restriction was lifted and there is no
limit to the number of controls having their color set.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example changes the background color of a static text lable in the dialog to the system background color for a
menu:
<programlisting>
<![CDATA[
::method changeColor
expose label
label~setSysColor('MENU')
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::setSysColor() -->
<section id="mthTabStop" xreflabel="tabStop"><title>tabStop</title>
<indexterm><primary>tabStop</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>tabStop</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>tabStop</secondary></indexterm>
<programlisting>
<![CDATA[
>>--tabStop(--+-----------+--)-------------------><
+-wantStyle-+
]]>
</programlisting>
<para>
Add or remove the <xref linkend="wstabstop"/> style for this control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem><para>The only argument is:
<variablelist>
<varlistentry><term>wantStyle [optional]</term>
<listitem>
<para>
A boolean (.true or .false) to indicate whether the control should have or not have the tabstop style. True (the
default) indicates the control should have the tabstop style and false indicates the control should not have the
style.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Negative values indicate the function failed, non-negative values indicate success.
<variablelist>
<varlistentry><term>-4 or less</term>
<listitem><para>
The value is the negated Operating System Error code. The absolute value of the return can be used to look up the
error reason in the Windows documentation.
</para>
</listitem></varlistentry>
<varlistentry><term>-3</term>
<listitem>
<para>
The second argument to the method is not a boolean.
</para>
</listitem></varlistentry>
<varlistentry><term>-2</term>
<listitem>
<para>
There is an (internal) problem with the dialog or the dialog handle.
</para>
</listitem></varlistentry>
<varlistentry><term>-1</term>
<listitem>
<para>
There is an (internal) problem with the resource ID of the control.
</para>
</listitem></varlistentry>
<varlistentry><term>0 or greater</term>
<listitem>
<para>
The window style of the dialog control prior to adding or removing the tabstop style.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When a control has the tabstop style, the user can set the focus to the control by using the tab key. When a
control does not have this style, the tab key will skip over the control. Adding or removing this style during the
execution of a dialog allows the programmer to alter how the user navigates through the dialog controls.
</para>
<para>
The negative return value from this method is a hold over from a period prior to the introduction of the <xref
linkend="dotSystemErrorCode"/>. This method now sets the
<computeroutput>.systemErrorCode</computeroutput>, making it easier to use the negative return as a failure
indication and use the <computeroutput>.systemErrorCode</computeroutput> value to look up the actual error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details:</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::tabStop() -->
<section id="mthTextSize" xreflabel="textSize"><title>textSize</title>
<indexterm><primary>textSize</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>textSize</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>textSize</secondary></indexterm>
<programlisting>
<![CDATA[
>>--textSize(--text--,--size--)------------------><
]]>
</programlisting>
<para>
Computes the width and height in pixels of the specified string of text when displayed by this control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text whose size is needed.
</para>
</listitem></varlistentry>
<varlistentry><term>size [required] [in / out]</term>
<listitem>
<para>
A Size <xref linkend="clsSize"/>) object. The computed size is returned in this argument.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, otherwise false. It is unlikely this method will fail.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example ...
<programlisting>
<![CDATA[
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::textSize() -->
<section id="mthUseUnicode" xreflabel="useUnicode"><title>useUnicode</title>
<indexterm><primary>useUnicode</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>useUnicode</secondary></indexterm>
<indexterm><primary>Dialog Control class</primary><secondary>useUnicode</secondary></indexterm>
<programlisting>
<![CDATA[
>>--useUnicode(--use--)--------------------------><
]]>
</programlisting>
<para>
Sets the Unicode character format flag that tells the dialog control to use, or not use, Unicode.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>use [required]</term>
<listitem>
<para>
If this argument is <computeroutput>.true</computeroutput> the format flag is set to tell the control to use
Unicode. If it is <computeroutput>.false</computeroutput> the format flag is set to not use Unicode.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the previous format flag for the control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Currently, the ooDialog framework is compiled in ANSI only mode. Therefore this method will have no effect. It is
possible that future version of ooDialog may be compiled in a manner that will allow Unicode to be used.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End Dialog Control::useUnicode() -->
<section id="mthUseVersion" xreflabel="useVersion"><title>useVersion</title>
<indexterm><primary>useVersion</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>useVersion</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>useVersion</secondary></indexterm>
<programlisting>
<![CDATA[
>>--useVersion(--versionNumber--)----------------><
]]>
</programlisting>
<para>
This method is used to inform the control that the programmer is expecting a behavior associated with a particular
version common control library.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>versionNumber [required]</term>
<listitem>
<para>
The common control version whose behavior this control is requested to use.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the version specified by the previous invocation of the <emphasis role="italic">useVersion</emphasis>
method. If <emphasis role="italic">versionNumber</emphasis> is set to a value greater than the current version,
returns -1.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
In some cases, a control may behave in a different manner, depending on the version of the common control library.
This mostly happens when bugst were fixed in later versions. The <emphasis role="italic">useVersion</emphasis>
method allows the programmer to inform the control which behavior is expected. Which version behavior the control
has been requested to use can be determined through the <link linkend="mthUsingVersion">usingVersion</link> method.
</para>
<para>
<emphasis role="bold">Note:</emphasis> If common control version 6 is in use, regardless of what value is set using
<emphasis role="italic">versionNumber</emphasis>, <emphasis role="italic">useVersion</emphasis> returns version 6.
Testing seems to indicate that if common control version 6 is in use, the <emphasis
role="italic">useVersion</emphasis> method has no effect. The method is provided becasue the Microsoft documentation
in many places suggests to use it with Custom Draw.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::useVersion() -->
<section id="mthUsingUnicode" xreflabel="usingUnicode"><title>usingUnicode</title>
<indexterm><primary>usingUnicode</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>usingUnicode</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>usingUnicode</secondary></indexterm>
<programlisting>
<![CDATA[
>>--usingUnicode---------------------------------><
]]>
</programlisting>
<para>
Determines if the dialog control is using Unicode characters.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments for this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return is true if the dialog control is using Unicode characters and false if the control is not using Unicode
characters.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Currently, the ooDialog framework is compiled in ANSI only mode. Therefore this method will always return false. It
is possible that future version of ooDialog may be compiled in a manner that will allow Unicode to be used.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::usingUnicode() -->
<section id="mthUsingVersion" xreflabel="usingVersion"><title>usingVersion</title>
<indexterm><primary>usingVersion</primary></indexterm>
<indexterm><primary>dialog control object</primary><secondary>usingVersion</secondary></indexterm>
<indexterm><primary>DialogControl class</primary><secondary>usingVersion</secondary></indexterm>
<programlisting>
<![CDATA[
>>--usingVersion---------------------------------><
]]>
</programlisting>
<para>
Returns the common control version number the control is using, if the <link linkend="mthUseVersion">useVersion</link>
method has been invoked by the programmer to set a specific version.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
This method had no arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the version set by the most recent invocation of the <link linkend="mthUseVersion">useVersion</link> method
for the control. Returns 0 if the method has never been invoked for the control.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The Microsoft documentation says, if no specific version has been set using the <emphasis
role="italic">useVersion</emphasis> method, the control will return 0. However testing seems to indicate that
documentation is incorrect or out of date. The documentation, in the remarks section, for the <link
linkend="mthUseVersion">useVersion</link> expands on this a little.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End DialogControl::useVersion() -->
</chapter>