[r9444]: docs / trunk / oodialog / en-US / propertySheetDialogs.xml  Maximize  Restore  History

Download this file

7660 lines (7137 with data), 318.9 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
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
<?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="chpPropertySheetControlDialogs"><title>Property Sheet and Control Dialogs</title>
<indexterm><primary>Property Sheet dialogs</primary></indexterm>
<indexterm><primary>Control dialogs</primary></indexterm>
<para>
ooDialog supports two approaches to embedding content in a <xref linkend="clsTab"/> control. Although the appearance of a
dialog using either approach can appear almost exactly the same, there are distinct differences in the two approaches.
These approaches are discussed in this chapter.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Property Sheet:</emphasis></term>
<listitem>
<para>
A Windows <emphasis role="italic">property sheet</emphasis> is a main window containing one or more overlapping
windows. Each of the overlapping windows is called a <emphasis role="italic">page</emphasis>. The main window is
called a property sheet, signifying a property sheet is used to set <emphasis role="italic">properties</emphasis>. In
practice programmers use property sheets for a number of different reasons other than setting properties.
</para>
<para>
ooDialog implements property sheets through the <xref linkend="clsPropertySheetDialog"/> and
the <xref linkend="clsPropertySheetPage"/> classes.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Control Dialogs:</emphasis></term>
<listitem>
<para>
Windows also has a style for dialogs that allows the dialog to work well as a dialog within a top-level dialog. The
ooDialog framework has support for this type of dialog and calls them <emphasis role="italic">control</emphasis>
dialogs because they function like a dialog control within the top-level dialog. These dialogs work well as the
content for tab control pages. The implementation for control dialogs is primarily through the <xref
linkend="clsControlDialog"/> mixin class and the subclasses that inherit the
<computeroutput>ControlDialog</computeroutput> class.
</para>
</listitem></varlistentry>
</variablelist>
<section id="sctControlDialogs" xreflabel="Control"><title>Control Dialogs</title>
<indexterm><primary>Control Dialogs</primary></indexterm>
<para>
Windows supports a style for dialogs that allow the dialog to work well as a dialog within a top-level dialog. In
essence a dialog with this style functions as a dialog control within the top-level dialog. Much of the behaviour and
appearance and of these dialogs is controlled automatically by the operating system. The Windows programmer does not
need to do much other than assign the proper style to the dialog. The ooDialog framework assigns the correct style to
the control dialog and does not allow the Rexx programmer to change that.
</para>
<para>
The <computeroutput>ControlDialog</computeroutput> class is a mixin class that signals to the ooDialog framework that
the <xref linkend="ovvUnderlying"/> Windows dialog is to have the control dialog style. To use a
control dialog in an ooDialog program, the programmer simply subclasses one of the 3 provided dialog classes that
inherit the <computeroutput>ControlDialog</computeroutput> mixin class. These are the
<xref linkend="clsRcControlDialog"/>, the <xref linkend="clsResControlDialog"/>
and the <xref linkend="clsUserControlDialog"/>. The 3 classes allow the programmer to base the
dialog subclass on any one of the 3 basic ooDialog dialogs, a dialog based on a resource
<xref linkend="defResourceScript"/> file, dialog based on a binary compiled resource file, or a dialog where the
programmer manually defines the dialog template in the program code. Because of this a control dialog is programmed in
the same basic way as any other ooDialog dialog.
</para>
<section id="clsControlDialog" xreflabel="ControlDialog"><title>ControlDialog Class</title>
<indexterm><primary>Control Dialogs</primary><secondary>ControlDialog class</secondary></indexterm>
<indexterm><primary>ControlDialog Class</primary></indexterm>
<para>
The <computeroutput>ControlDialog</computeroutput> class is the mixin class that allows dialogs in ooDialog to be used
as a dialog control. It is inherited by the <computeroutput>RcControlDialog</computeroutput>,
<computeroutput>ResControlDialog</computeroutput>, and the <computeroutput>UserControlDialog</computeroutput> classes.
To use a dialog as a control in a Rexx program, the programmer should pick one of the three basic types of control
dialogs and write a subclass of that dialog:
</para>
<para>
<itemizedlist>
<listitem>
<para>
Subclass the <xref linkend="clsRcControlDialog"/> when the dialog template will be defined in
a resource <xref linkend="defResourceScript"/> file.
</para>
</listitem>
<listitem>
<para>
Subclass the <xref linkend="clsResControlDialog"/> when the dialog <xref linkend="ovvDialogTemplate"/> will be loaded
from a compiled binary resource file.
</para>
</listitem>
<listitem>
<para>
Subclass the <xref linkend="clsUserControlDialog"/> when the dialog template will be defined
using the <xref linkend="sctCreateMethods"/> methods.
</para>
</listitem>
</itemizedlist>
</para>
<section id="mthEndExecution" xreflabel="endExecution"><title>endExecution</title>
<indexterm><primary>endExecution</primary></indexterm>
<indexterm><primary>ControlDialog class</primary><secondary>endExecution</secondary></indexterm>
<programlisting>
<![CDATA[
>>--endExecution(--+-------------+--)------------><
+--endLikeOk--+
]]>
</programlisting>
<para>
The <emphasis role="italic">endExecution</emphasis> method must be used to finish the execution of all
<computeroutput>ControlDialog</computeroutput> objects. Do not use any other mechanism to end the execution of any
<computeroutput>ControlDialog</computeroutput> objects.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>endLikeOk [optional]</term>
<listitem>
<para>
This argument specifies if the dialog is ending as though the user pressed the <emphasis
role="italic">Ok</emphasis> button or the <emphasis role="italic">Cancel</emphasis> button. By default <emphasis
role="italic">endLikeOk</emphasis> is false and the dialog is ended as though the user canceled the dialog. If
<emphasis role="italic">endLikOk</emphasis> is true, the dialog is ended as though the user pressed the
<emphasis role="italic">Ok</emphasis> button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the <link linkend="tblConstantsDlgObject">IDOK</link> constant if the dialog was
<xref linkend="atrWasActivatedClsControlDialog"/> and is closed as though the user pressed the <emphasis
role="italic">Ok</emphasis> button. Otherwise, the IDCANCEL constant is returned.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When a dialog is used as a control in another dialog there are some operating system differences in how the
<xref linkend="ovvUnderlying"/> dialog behaves. The ooDialog framework ensures that the Rexx dialog object
used as a dialog control behaves consistently with other dialogs in ooDialog. Closing a control dialog through some
other mechanism than the <emphasis role="italic">endExecution</emphasis> method will bypass the internal processing
used by the framework. This makes it likely that at some point the control dialog will not behave consistently with
other dialogs.
</para>
<para>
Control dialogs are most useful as the pages in a <xref linkend="clsTab"/> control. In Windows applications
it is common practice to not create the underlying dialog for a tab page unless the user actually visits that page.
If the Rexx control dialog, never has its underlying dialog created, then <emphasis
role="italic">endExecution</emphasis> always returns the IDCANCEL constant and the Rexx dialog object is always
ended as though the user had canceled the dialog.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows the <emphasis role="italic">ok</emphasis> method of a main dialog that uses control dialogs as
the pages of a tab control. If the user closes the main dialog with <emphasis role="italic">ok</emphasis> then all
the control dialogs used as pages are ended using <emphasis role="italic">endExecution</emphasis> with an argument
of true:
<programlisting>
<![CDATA[
::method ok
expose pages
do page over pages
if page \== .nil then page~endExecution(.true)
end
return self~ok:super
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ControlDialog::endExecution() -->
<section id="mthExecuteClsControlDialog" xreflabel="execute"><title>execute</title>
<indexterm><primary>execute</primary><secondary>ControlDialog class</secondary></indexterm>
<indexterm><primary>ControlDialog class</primary><secondary>execute</secondary></indexterm>
<programlisting>
<![CDATA[
>>--execute--------------------------------------><
]]>
</programlisting>
<para>
All <computeroutput>ControlDialog</computeroutput> objects must be started through the <emphasis
role="italic">execute</emphasis> method. This method causes the <xref linkend="ovvUnderlying"/> dialog to be created. Do
not use any other method to start control dialogs.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no argument to this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Execute does not return any value.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
In order to ensure that dialogs used as controls in main dialogs behave consistently, the programmer is required to
start execution of all controld dialogs using the <emphasis role="italic">execute</emphasis> method and to end the
dialog using the <xref linkend="mthEndExecution"/> method. Failure to do so is not guarenteed to
work.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example has a control dialog of the <computeroutput>.HistoryDlg</computeroutput> subclass used as a page in a
tab control. The dialog object is not instantiated until the user actually visits the page in the tab control. At
that time, the dialog object is instantiated and then started executing throught the <emphasis
role="italic">execute</emphasis> method:
<programlisting>
<![CDATA[
::method activateHistory private unguarded
expose historyDlg dlgRect pages
reply
historyDlg = .HistoryDlg~new(dlgRect, self)
historyDlg~execute
pages[4] = historyDlg
self~postOnSelChange(10)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ControlDialog::execute() -->
<section id="mthInitUpdateListView" xreflabel="initUpdateListView"><title>initUpdateListView</title>
<indexterm><primary>initUpdateListView</primary></indexterm>
<indexterm><primary>ControlDialog class</primary><secondary>initUpdateListView</secondary></indexterm>
<programlisting>
<![CDATA[
>>--initUpdateListView(--listViewID--+-----------+--)-----------><
+--seconds--+
]]>
</programlisting>
<para>
Causes the ooDialog framework to use an internal work around for a known Windows problem when a
<xref linkend="clsListView"/> control is used in the page of a <xref linkend="clsTab"/> control.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>listViewID [required]</term>
<listitem>
<para>
The resource ID of the list-view control in a page of a tab control, may be numeric or
<xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>seconds [optional]</term>
<listitem>
<para>
The positive number of seconds to pause before the list-view is redrawn. This should be a very small period
expressed in decimal notation. Whole numbers are acceptable, but the pause will be too long to be of good use.
The default value if this argument is omitted is .005.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method does not return a value.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
There is a known problem in Windows when a list-view in used in the page of a tab control. If an item in the
list-view is selected and the user selects another tab, then goes back to the first tab, the list-view sometimes
does not redraw properly.
</para>
<para>
There is a work around for this problem and the ooDialog framework implements the work around internally so the Rexx
programmer does not need to remember, or know, the details of the work around. If an application exhibits this
problem, then use this method to fix it. The <xref linkend="mthInitDialog"/> is the best place to
invoke the method.
</para>
<para>
The solution to the problem is to have the list-view control redraw itself after the tab has been selected. The
<emphasis role="italic">seconds</emphasis> argument can be used by the programmer to control the pause between the
tab being selected and the list-view being redrawn. If the pause is too short, the list-view still may not redraw
correctly. If the pause is too long, the user will notice the list-view being drawn twice. The <emphasis
role="italic">seconds</emphasis> argument is only needed if the programmer is not satisfied with the appearance in a
specific application.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example activates the internal work around for a list-view with the symbolic ID of IDC_LV_MAIN:
<programlisting>
<![CDATA[
::method initDialog
-- Initialize the internal fix for the list-view redrawing problem when a
-- list-view is used in a tab control.
self~initUpdateListView(IDC_LV_MAIN)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ControlDialog::initUpdateListView() -->
<section id="atrWasActivatedClsControlDialog" xreflabel="wasActivated"><title>wasActivated (Attribute)</title>
<indexterm><primary>wasActivated</primary></indexterm>
<indexterm><primary>ControlDialog class</primary><secondary>wasActivated</secondary></indexterm>
<programlisting>
<![CDATA[
>>--wasActivated---------------------------------><
>>--wasActivated-=-trueFalse---------------------><
]]>
</programlisting>
<para>
Reflects whether the <xref linkend="ovvUnderlying"/> dialog for this control dialog was ever created.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">wasActivated get:</emphasis></term>
<listitem>
<para>
The value of this attribute is true if the underlying dialog was created, otherwise it is false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">wasActivated set:</emphasis></term>
<listitem>
<para>
The programmer can not set the value of this attribute, it is set internally by the ooDialog framework.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Dialogs used as controls in other dialogs are most commonly used as a page in a tab control. In Windows it is a
common practice to defer the creation of the dialog for the page until the tab page is actually visited by the user.
This attribute allows the Rexx programmer to determine whether or not the underlying dialog has been created yet or
not.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ControlDialog::wasActivated() [attribute] -->
</section>
<section id="clsRcControlDialog" xreflabel="RcControlDialog"><title>RcControlDialog Class</title>
<indexterm><primary>Control Dialogs</primary><secondary>RcControlDialog class</secondary></indexterm>
<indexterm><primary>RcControlDialog Class</primary></indexterm>
<para>
The <computeroutput>RcControlDialog</computeroutput> should be subclassed when the programmer wants to use a resource
<xref linkend="defResourceScript"/> to create the dialog <xref linkend="ovvDialogTemplate"/>
for his control dialog.
</para>
<section id="sctMethodsRcControlDialog"><title>Method Table</title>
<para>
The following table provides links to the documentation for the few methods and attributes used in working
with <computeroutput>RcControlDialog</computeroutput> objects that differ from working with regular dialogs:
</para>
<table id="tblRcControlDialogMethods" frame="all">
<title>Important RcControlDialog Methods</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="4*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="mthNewClsUserControlDialog"/></entry>
<entry>Instantiates a new user control dialog.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attributes</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="atrOwnerDialog"/></entry>
<entry>Reflects the dialog that owns this control dialog.</entry>
</row>
<row>
<entry><xref linkend="atrWasActivatedClsControlDialog"/></entry>
<entry>Reflects whether the <xref linkend="ovvUnderlying"/> dialog for this control dialog was ever created.</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="mthEndExecution"/></entry>
<entry>Must be used to finish the execution of all <computeroutput>RcControlDialog</computeroutput> objects.</entry>
</row>
<row>
<entry><xref linkend="mthExecuteClsControlDialog"/></entry>
<entry>All <computeroutput>RcControlDialog</computeroutput> objects must be started through the <emphasis role="italic">execute</emphasis> method.</entry>
</row>
<row>
<entry><xref linkend="mthInitUpdateListView"/></entry>
<entry>Initializes an internal work around for a problem with list-views that are used in a page of a tab control.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="mthNewClsRcControlDialog" xreflabel="new"><title>new (Class method)</title>
<indexterm><primary>new</primary><secondary>RcControlDialog class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--init(-scrpt-,-id-+---------+-+-----+-+--------+-+---------+-+---------+-)--><
+-,-data.-+ +-,-h-+ +-,-opts-+ +-,-xpect-+ +-,-oData-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>RcControlDialog</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments when creating a new dialog instance of this class are:
<variablelist>
<varlistentry><term>scrpt [required]</term>
<listitem>
<para>
The file name of the resource script containing the dialog template.
</para>
</listitem></varlistentry>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the dialog template. This may be numeric or <xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>data. [optional]</term>
<listitem>
<para>
A <xref linkend="termDialogDataStem"/> variable (don't forget the trailing period) that
contains data used to initialize the underlying dialog's controls.
</para>
</listitem></varlistentry>
<varlistentry><term>h [optional]</term>
<listitem>
<para>
The name of a <xref linkend="defHeaderFile"/>) containing symbolic ID defines for resource IDs.
</para>
</listitem></varlistentry>
<varlistentry><term>opts [optional]</term>
<listitem>
<para>
Zero or more of the following keywords, separated by blanks:
<variablelist>
<varlistentry><term>CENTER</term>
<listitem>
<para>
The dialog is to be positioned in the center of the screen.
</para>
</listitem></varlistentry>
<varlistentry><term>CONNECTBUTTONS</term>
<listitem>
<para>
Each push <xref linkend="clsButton"/> in the underlying dialog has the CLICKED
<xref linkend="ovvEvents"/> notification connected automatically to a method in the Rexx dialog object.
This is the same as using the <xref linkend="mthConnectButtonEvent"/>() method for the
CLICKED notification. The name for the method is generated automatically by the ooDialog framework. The method
name is the button label with all spaces, ampersands, colons, and trailing <emphasis
role="italic">...</emphasis> characters removed.
</para>
</listitem></varlistentry>
<varlistentry><term>CONNECTRADIOS</term>
<listitem>
<para>
Similar to CONNECTBUTTONS, this option connects the CLICKED event notification from each
<xref linkend="clsRadioButton"/> button to a method in the Rexx dialog object. Again, this is the same as
using the <emphasis role="italic">connectButtonEvent</emphasis> method. For radio buttons, the generated
</para>
</listitem></varlistentry>
<varlistentry><term>CONNECTCHECKS</term>
<listitem>
<para>
Exactly the same as CONNECTRADIOS, for check <xref linkend="clsCheckBox"/> controls. The object
method name is generated in the same way as it is for radio buttons. That is, the method name is the button
label, with all spaces, ampersands, colons, and trailing <emphasis role="italic">...</emphasis> characters
removed. Which is then <emphasis role="bold"> prepended</emphasis> with the text
<computeroutput>ID</computeroutput>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>xpect [optional]</term>
<listitem>
<para>
This is the maximum number of dialog controls expected in the dialog template. It serves the same purpose as the
<emphasis role="italic">expected</emphasis> argument in the <xref linkend="mthCreate"/>() method of
the <computeroutput>UserDialog</computeroutput>. The default value for this argument is 200.
</para>
</listitem></varlistentry>
<varlistentry><term>oData [optional]</term>
<listitem>
<para>
Used to specifiy the <emphasis role="italic">owner</emphasis> dialog of this
<xref linkend="clsControlDialog"/>. All control dialogs <emphasis role="italic">must</emphasis>
have the <xref linkend="atrOwnerDialog"/> attribute set to the Rexx dialog that owns the
control dialog, before the <xref linkend="ovvUnderlying"/> control dialog is created. In
addition, the underlying owner dialog must be created before the underlying control dialog can be created.
</para>
<para>
The <emphasis role="italic">oData</emphasis> argument can be used to set the <emphasis
role="italic">ownerDialog</emphasis> attribute when this control dialog object is instantiated. The Rexx owner
dialog's underlying dialog does not have to be created when the attribute is set. The programmer just needs to
ensure that the underlying dialog <emphasis role="italic">has</emphasis> been created when the
<xref linkend="mthExecuteClsControlDialog"/> method is invoked.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Normally a programmer does not instantiate a <computeroutput>RcControlDialog</computeroutput> directly, but rather
creates a subclass of a <computeroutput>RcControlDialog</computeroutput> and instantiates the subclass. Recall that
in ooRexx, when a new object is instantiated, the <emphasis role="italic">new</emphasis> method invokes the
<emphasis role="italic">init</emphasis> method of the object using the arguments passed to the <emphasis
role="italic">new</emphasis> method. So, the arguments of the <emphasis role="italic">new</emphasis> method are
also the arguments of the <emphasis role="italic">init</emphasis> method.
</para>
<para>
If the programmer over-rides the <emphasis role="italic">init</emphasis> method in the subclass of the
<computeroutput>RcControlDialog</computeroutput>, care must be taken to invoke the superclass <emphasis
role="italic">init</emphasis> method with the correct arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows the instantiation of a <computeroutput>RcControlDialog</computeroutput> subclass, (which is
really no different than instantiating a <xref linkend="clsRcDialog"/> subclass.) Note that the
<emphasis role="italic">ownerDialog</emphasis> attribute is set after the invocation of the <emphasis
role="italic">new</emphasis> method. This is sometimes easier than using a lot of omitted arguments for a
<computeroutput>RcControlDialog</computeroutput>.
<programlisting>
<![CDATA[
...
dlg3 = .ProgressBarDlg~new("rc\PropertySheetDemo.rc", IDD_PROGRESSBAR_DLG)
-- Create the main dialog.
dlg = .NewControlsDialog~new('rc\PropertySheetDemo.dll', IDD_NEWCONTROLS_DLG)
dlg3~ownerDialog = dlg
::requires "ooDialog.cls"
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section><!-- End RcControlDialog::new() -->
</section>
<section id="clsResControlDialog" xreflabel="ResControlDialog"><title>ResControlDialog Class</title>
<indexterm><primary>Control Dialogs</primary><secondary>ResControlDialog class</secondary></indexterm>
<indexterm><primary>ResControlDialog Class</primary></indexterm>
<para>
Subclass the <computeroutput>ResControlDialog</computeroutput> to use a control dialog in an application where the
dialog <xref linkend="ovvDialogTemplate"/> comes from a compiled binary resource file.
</para>
<section id="sctMethodsResControlDialog"><title>Method Table</title>
<para>
The following table provides links to the documentation for the few methods and attributes used in working
with <computeroutput>ResControlDialog</computeroutput> objects that differ from working with regular dialogs:
</para>
<table id="tblResControlDialogMethods" frame="all">
<title>Important ResControlDialog Methods</title>
<tgroup cols="2">
<colspec colwidth="1*" /><colspec colwidth="4*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="mthNewClsUserControlDialog"/></entry>
<entry>Instantiates a new user control dialog.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attributes</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="atrOwnerDialog"/></entry>
<entry>Reflects the dialog that owns this control dialog.</entry>
</row>
<row>
<entry><xref linkend="atrWasActivatedClsControlDialog"/></entry>
<entry>Reflects whether the <xref linkend="ovvUnderlying"/> dialog for this control dialog was ever created..</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="mthEndExecution"/></entry>
<entry>Must be used to finish the execution of all <computeroutput>ResControlDialog</computeroutput> objects.</entry>
</row>
<row>
<entry><xref linkend="mthExecuteClsControlDialog"/></entry>
<entry>All <computeroutput>ResControlDialog</computeroutput> objects must be started through the <emphasis role="italic">execute</emphasis> method.</entry>
</row>
<row>
<entry><xref linkend="mthInitUpdateListView"/></entry>
<entry>Initializes an internal work around for a problem with list-views that are used in a page of a tab control.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="mthNewClsResControlDialog" xreflabel="new"><title>new (Class method)</title>
<indexterm><primary>new</primary><secondary>ResControlDialog class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(--module--,--id--+-------------+--+----------+--+-------------+--)-----><
+-,--dlgData.-+ +-,--hFile-+ +-,-ownerData-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>ResControlDialog</computeroutput> object. The dialog template for the object is
taken from the specified module, which is usually a resource only DLL.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments when creating a new dialog instance of this class are:
<variablelist>
<varlistentry><term>module [required]</term>
<listitem>
<para>
The file name of the executable module (a DLL or EXE) in which the resource (the compiled dialog template) is
located.
</para>
</listitem></varlistentry>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the dialog template. This may be numeric or <xref linkend="defSymbolicId"/>.
The resource ID is assigned to the dialog template when it was compiled.
</para>
</listitem></varlistentry>
<varlistentry><term>dlgData. [optional]</term>
<listitem>
<para>
A <xref linkend="termDialogDataStem"/> variable (don't forget the trailing period) that
contains data used to initialize the underlying dialog's controls.
</para>
</listitem></varlistentry>
<varlistentry><term>hFile [optional]</term>
<listitem>
<para>
The name of a <xref linkend="defHeaderFile"/>) containing symbolic ID defines for resource IDs.
</para>
</listitem></varlistentry>
<varlistentry><term>ownerData [optional]</term>
<listitem>
<para>
Used to specifiy the <emphasis role="italic">owner</emphasis> dialog of this
<xref linkend="clsControlDialog"/>. All control dialogs <emphasis role="italic">must</emphasis>
have the <xref linkend="atrOwnerDialog"/> attribute set to the Rexx dialog that owns the
control dialog, before the <xref linkend="ovvUnderlying"/> control dialog is created. In
addition, the underlying owner dialog must be created before the underlying control dialog can be created.
</para>
<para>
The <emphasis role="italic">ownerData</emphasis> argument can be used to set the <emphasis
role="italic">ownerDialog</emphasis> attribute when this control dialog object is instantiated. The Rexx owner
dialog's underlying dialog does not have to be created when the attribute is set. The programmer just needs to
ensure that the underlying dialog <emphasis role="italic">has</emphasis> been created when the
<xref linkend="mthExecuteClsControlDialog"/> method is invoked.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Normally a programmer does not instantiate a <computeroutput>ResControlDialog</computeroutput> directly, but rather
creates a subclass of a <computeroutput>ResControlDialog</computeroutput> and instantiates the subclass. Recall that
in ooRexx, when a new object is instantiated, the <emphasis role="italic">new</emphasis> method invokes the
<emphasis role="italic">init</emphasis>() method of the object, using the method arguments of the <emphasis
role="italic">new</emphasis>() method. So, the arguments of the <emphasis role="italic">new</emphasis> method are
also the arguments of the <emphasis role="italic">init</emphasis> method.
</para>
<para>
Therefore, if the programmer over-rides the <emphasis role="italic">init</emphasis> method in the subclass of the
<computeroutput>ResControlDialog</computeroutput>, care must be taken to invoke the superclass <emphasis
role="italic">init</emphasis> method with the correct arguments.
</para>
<para>
When a <computeroutput>ResControlDialog</computeroutput>, or subclass, is instantiated, and the file specified in
the <emphasis role="italic">module</emphasis> argument can not be found, or can not be loaded as an executable
module, a message box will pop up informing the user of the problem.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows the instantiation of a <computeroutput>ResControlDialog</computeroutput> subclass, (which is
really no different than instantiating a <xref linkend="clsResDialog"/> subclass.) Note that the
<emphasis role="italic">ownerDialog</emphasis> attribute is set after the invocation of the <emphasis
role="italic">new</emphasis> method. This is sometimes easier than using a lot of omitted arguments for a
<computeroutput>ResControlDialog</computeroutput>.
<programlisting>
<![CDATA[
...
dlg4 = .TrackBarDlg~new("rc\PropertySheetDemo.dll", IDD_TRACKBAR_DLG)
-- Create the main dialog.
dlg = .NewControlsDialog~new('rc\PropertySheetDemo.dll', IDD_NEWCONTROLS_DLG)
dlg4~ownerDialog = dlg
::requires "ooDialog.cls"
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section><!-- End ResControlDialog::new() -->
</section><!-- End ResControlDialog Class -->
<section id="clsUserControlDialog" xreflabel="UserControlDialog"><title>UserControlDialog Class</title>
<indexterm><primary>Control Dialogs</primary><secondary>UserControlDialog class</secondary></indexterm>
<indexterm><primary>UserControlDialog Class</primary></indexterm>
<para>
The <computeroutput>UserControlDialog</computeroutput> should be used when the programmer wants to define the dialog
<xref linkend="ovvDialogTemplate"/> for the control dialog by using the
<xref linkend="sctCreateMethods"/> methods.
</para>
<section id="sctMethodsUserControlDialog"><title>Method Table</title>
<para>
The following table provides links to the documentation for the few methods and attributes used in working
with <computeroutput>UserControlDialog</computeroutput> objects that differ from working with regular dialogs:
</para>
<table id="tblUserControlDialogMethods" frame="all">
<title>Important UserControlDialog Methods</title>
<tgroup cols="2">
<colspec colwidth="1*" /><colspec colwidth="4*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="mthNewClsUserControlDialog"/></entry>
<entry>Instantiates a new user control dialog.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attributes</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="atrOwnerDialog"/></entry>
<entry>Reflects the dialog that owns this control dialog.</entry>
</row>
<row>
<entry><xref linkend="atrWasActivatedClsControlDialog"/></entry>
<entry>Reflects whether the <xref linkend="ovvUnderlying"/> dialog for this control dialog was ever created..</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="mthEndExecution"/></entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="mthExecuteClsControlDialog"/></entry>
<entry></entry>
</row>
<row>
<entry><xref linkend="mthInitUpdateListView"/></entry>
<entry>Initializes an internal work around for a problem with list-views that are used in a page of a tab control.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="mthNewClsUserControlDialog" xreflabel="new"><title>new (Class method)</title>
<indexterm><primary>new</primary><secondary>UserControlDialog class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(--+----------+--+---------------+--+-------------+--)---><
+-dlgData.-+ +-,--headerFile-+ +-,-ownerData-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>UserControlDialog</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>dlgData. [optional]</term>
<listitem>
<para>
A <xref linkend="termDialogDataStem"/> variable (don't forget the trailing period) that
contains data used to initialize the underlying dialog's controls.
</para>
</listitem></varlistentry>
<varlistentry><term>hFile [optional]</term>
<listitem>
<para>
The name of a <xref linkend="defHeaderFile"/>) containing symbolic ID defines for resource IDs.
</para>
</listitem></varlistentry>
<varlistentry><term>ownerData [optional]</term>
<listitem>
<para>
Used to specifiy the <emphasis role="italic">owner</emphasis> dialog of this
<xref linkend="clsControlDialog"/>. All control dialogs <emphasis role="italic">must</emphasis>
have the <xref linkend="atrOwnerDialog"/> attribute set to the Rexx dialog that owns the
control dialog, before the <xref linkend="ovvUnderlying"/> control dialog is created. In
addition, the underlying owner dialog must be created before the underlying control dialog can be created.
</para>
<para>
The <emphasis role="italic">ownerData</emphasis> argument can be used to set the <emphasis
role="italic">ownerDialog</emphasis> attribute when this control dialog object is instantiated. The Rexx owner
dialog's underlying dialog does not have to be created when the attribute is set. The programmer just needs to
ensure that the underlying dialog <emphasis role="italic">has</emphasis> been created when the
<xref linkend="mthExecuteClsControlDialog"/> method is invoked.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Normally a programmer does not instantiate a <computeroutput>UserDialog</computeroutput> directly, but rather
creates a subclass of a <computeroutput>UserDialog</computeroutput> and instantiates the subclass. Recall that in
ooRexx, when a new object is instantiated, the <emphasis role="italic">new</emphasis> method invokes the <emphasis
role="italic">init</emphasis>() method of the object, using the arguments of the <emphasis
role="italic">new</emphasis>() method. Therefore, the arguments of the <emphasis role="italic">new</emphasis> method
are also the arguments of the <emphasis role="italic">init</emphasis> method.
</para>
<para>
If the programmer over-rides the <emphasis role="italic">init</emphasis> method in the subclass of the
<computeroutput>UserDialog</computeroutput>, care must be taken to invoke the superclass <emphasis
role="italic">init</emphasis> method with the correct arguments.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This sample shows a method in the main dialog that instantiates a subclass of a
<computeroutput>UserControlDialog</computeroutput> and shows the init() method of that subclass. Note the proper way
that the <computeroutput>PatientDlg</computeroutput> object initializes its superclass.
<programlisting>
<![CDATA[
::method activatePatient private unguarded
expose patientDlg dlgRect pages
patientDlg = .PatientDlg~new(dlgRect, self)
patientDlg~execute
pages[1] = patientdlg
...
::class 'PatientDlg' subclass UserControlDialog
::method init
use arg r, parent
self~init:super( , , parent)
self~create(r~left, r~top, r~right, r~bottom)
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section><!-- End UserControlDialog::new() -->
</section>
</section><!-- End Control Dialogs -->
<section id="clsPropertySheetDialog" xreflabel="PropertySheetDialog"><title>PropertySheetDialog Class</title>
<indexterm><primary>Property sheet dialogs</primary><secondary>PropertySheetDialog class</secondary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary></indexterm>
<para>
The Windows <emphasis role="italic">property sheet</emphasis> is a dialog that contains one or more overlapping child
windows called <emphasis role="italic">pages</emphasis>. Each page normally contains a group of related dialog
controls. Each page has a tab that the user can select to bring the page to the foreground of the property sheet. The
main dialog itself is the property sheet. The name <emphasis role="italic">property sheet</emphasis> indicates that
Microsoft's original purpose for the property sheet was to set properties. However, property sheet dialogs are useful
in any situation where the programmer needs to place a number of dialog controls without using a huge dialog. In
practice, programmers have not restricted the use of property sheet dialogs to strictly setting properties.
</para>
<para>
There is a special type of property sheet called a <emphasis role="italic">wizard</emphasis>. Wizards are designed to
show the pages one at a time in a sequence that is controlled by the application. Instead of selecting from a group of
pages by clicking a tab, users navigate forward and backward through the sequence, one page at a time, by clicking
Next or Back buttons located at the bottom of the wizard.
</para>
<para>
The ooDialog framework provides the <computeroutput>PropertySheetDialog</computeroutput> and
<xref linkend="clsPropertySheetPage"/> classes that allow the programmer to create property sheet and
wizard dialogs. Unlike most other ooDialog dialogs, the operating system manages much of the property sheet dialog
itself. For instance, the operating system executes and shows the page dialogs itself. The ooDialog programmer does
not invoke the <xref linkend="mthExecute"/> method for the page dialogs.
</para>
<section id="sctMethodsPropertySheetDialog"><title>Method Table</title>
<para>
The following table provides links to the documentation for the primary methods and attributes used in working
with <computeroutput>PropertySheetDialog</computeroutput> objects.
</para>
<table id="tblPropertySheetDialogMethods" frame="all">
<title>PropertySheetDialog Methods</title>
<tgroup cols="2">
<colspec colwidth="6*" />
<colspec colwidth="15*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Constant Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry>ID_PSREBOOTSYSTEM</entry>
<entry>Possible return value from the <xref linkend="mthExecuteClsPSD"/> or <xref linkend="mthGetResultClsPSD"/> methods. Indicates a page sent the reboot system message to the property sheet. The computer must be restarted for the user's changes to take effect. The application is responsible for rebooting the computer.</entry>
</row>
<row>
<entry>ID_PSRESTARTWINDOWS</entry>
<entry>Possible return value from the <xref linkend="mthExecuteClsPSD"/> or <xref linkend="mthGetResultClsPSD"/> methods. Indicates a page sent the restart Window message to the property sheet. Microsoft Windwos must be restarted for the user's changes to take effect. The application is responsible for restarting Windows.</entry>
</row>
<row>
<entry>MAXPROPPAGES</entry>
<entry>The maximun number of pages a property sheet dialog can have. This is an operating system restriction.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="mthNewClsPropertySheetDialog"/></entry>
<entry>Instantiates a new <computeroutput>PropertySheetDialog</computeroutput> object.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attributes</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="atrAppIcon"/></entry>
<entry>Reflects the value of the <xref linkend="defDialogIcon"/> for the property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="atrCaption"/></entry>
<entry>Reflects the caption, or title, of the property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="atrHeader"/></entry>
<entry>Specifies the bitmap that will be placed at the right side of an interior page's header area in a Wizard dialog. The attribute is only used for the Wizard style property sheet dialogs.</entry>
</row>
<row>
<entry><xref linkend="atrImageList"/></entry>
<entry>Used to assign icons for the tabs of the tab control in a property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="atrPages"/></entry>
<entry>Reflects the dialog objects used as the pages of this property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="atrResourcesClsPSD"/></entry>
<entry>Can be set to a <xref linkend="clsResourceImage"/> object to supply some or all of the resources used by the property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="atrStartPage"/></entry>
<entry>Reflects the index of the page that will be selected and visible when the property sheet dialog is first shown on the screen.</entry>
</row>
<row>
<entry><xref linkend="atrWatermark"/></entry>
<entry>Reflects the watermark bitmap image that will be used with a Wizard97 property sheet dialog.</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="mthAddPage"/></entry>
<entry>Adds a page to the property sheet at the end of the current pages.</entry>
</row>
<row>
<entry><xref linkend="mthApplyClsPSD"/></entry>
<entry>Simulates the selection of the Apply button, indicating that one or more pages have changed and the changes need to be validated and recorded.</entry>
</row>
<row>
<entry><xref linkend="mthCancelToClose"/></entry>
<entry>Used when changes made since the most recent APPLY notification cannot be canceled.</entry>
</row>
<row>
<entry><xref linkend="mthChanged"/></entry>
<entry>Informs the underlying property sheet dialog that information in a page has changed.</entry>
</row>
<row>
<entry><xref linkend="mthEnableWizButtons"/></entry>
<entry>Enables or disables buttons in an Aero wizard.</entry>
</row>
<row>
<entry><xref linkend="mthExecuteClsPSD"/></entry>
<entry>Starts the execution of the underlying, <xref linkend="defModalModeless"/>, property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="mthGetCurrentPageHwnd"/></entry>
<entry>Retrieves the window <xref linkend="defHandle"/> of the <xref linkend="ovvUnderlying"/> dialog of the current page in this property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="mthGetPage"/></entry>
<entry>Gets the Rexx dialog object for the page specified by <emphasis role="italic">index</emphasis>.</entry>
</row>
<row>
<entry><xref linkend="mthGetResultClsPSD"/></entry>
<entry>Returns a keyword indicating the result of executing the <computeroutput>PropertySheetDialog</computeroutput>.</entry>
</row>
<row>
<entry><xref linkend="mthGetTabControl"/></entry>
<entry>Retrieves the Rexx tab control object for the tab control of the property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="mthHwndToIndex"/></entry>
<entry>Returns the one-based index of the property sheet page specified by its window handle.</entry>
</row>
<row>
<entry><xref linkend="mthIdToIndex"/></entry>
<entry>Takes a property sheet page ID and returns its one-based page index.</entry>
</row>
<row>
<entry><xref linkend="mthIndexToHwnd"/></entry>
<entry>Given the one-based index to a page, returns the window handle of the underlying page dialog.</entry>
</row>
<row>
<entry><xref linkend="mthIndexToID"/></entry>
<entry>Given the index of a page, returns its ID.</entry>
</row>
<row>
<entry><xref linkend="mthIndexToPage"/></entry>
<entry>Returns the PROPSHEETPAGE <xref linkend="defHandle"/> for the specified page index.</entry>
</row>
<row>
<entry><xref linkend="mthInitDialogClsPSD"/></entry>
<entry>Invoked by the ooDialog framework when the underlying property sheet dialog has first been created.</entry>
</row>
<row>
<entry><xref linkend="mthInsertPage"/></entry>
<entry>Inserts a new page into the property sheet dialog at the specified index.</entry>
</row>
<row>
<entry><xref linkend="mthPageToIndex"/></entry>
<entry>Takes the handle of a <xref linkend="mthIndexToPage"/> and returns the one-based index of the page.</entry>
</row>
<row>
<entry><xref linkend="mthPopupClsPSD"/></entry>
<entry>Begins the execution of a <link linkend="defModalModeless">modeless</link> property sheet dialog and returns immediately.</entry>
</row>
<row>
<entry><xref linkend="mthPopupAsChildClsPSD"/></entry>
<entry>Sarts a <emphasis role="italic">modeless</emphasis> propertry sheet dialog executing and returns immediately. The property sheet dialog is closed automatically when its parent is closed</entry>
</row>
<row>
<entry><xref linkend="mthPressButton"/></entry>
<entry>Pushes the specified property sheet button programmatically.</entry>
</row>
<row>
<entry><xref linkend="mthQuerySiblings"/></entry>
<entry>Causes the underlying property sheet dialog to send the <xref linkend="mthQueryFromSibling"/> notification, with the specified arguments to each page of the of the property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="mthRebootSystem"/></entry>
<entry>Invoked to notify the property sheet dialog that the system needs to be rebooted for changes to take effect.</entry>
</row>
<row>
<entry><xref linkend="mthRecalcPageSizes"/></entry>
<entry>Recalculates the page size of a standard or wizard property sheet after pages have been added or removed.</entry>
</row>
<row>
<entry><xref linkend="mthRestartWindows"/></entry>
<entry>Invoked to notify the property sheet dialog that Microsoft Windows needs to be restarted for changes to take effect.</entry>
</row>
<row>
<entry><xref linkend="mthRemovePage"/></entry>
<entry>Removes a page from this property sheet.</entry>
</row>
<row>
<entry><xref linkend="mthSetButtonText"/></entry>
<entry>Sets the text of the specified button in an Aero wizard.</entry>
</row>
<row>
<entry><xref linkend="mthSetCurSel"/></entry>
<entry>Activates the specified page in a property sheet.</entry>
</row>
<row>
<entry><xref linkend="mthSetCurSelByID"/></entry>
<entry>Activates the page specified by <emphasis role="italic">id</emphasis> in this property sheet.</entry>
</row>
<row>
<entry><xref linkend="mthSetFinishText"/></entry>
<entry>Sets the text of the Finish button in a wizard, shows and enables the button, and hides the Next and Back buttons.</entry>
</row>
<row>
<entry><xref linkend="mthSetHeaderSubTitle"/></entry>
<entry>Sets or resets the text for the header subtitle in a wizard property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="mthSetHeaderTitle"/></entry>
<entry>Sets or resets the text for the header in a wizard property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="mthSetNextText"/></entry>
<entry>Sets the text of the Next button in an Aero wizard.</entry>
</row>
<row>
<entry><xref linkend="mthSetTitleClsPSD"/></entry>
<entry>Sets the title for a property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="mthSetWizButtons"/></entry>
<entry>Enables or disables the Back, Next, and Finish buttons in a wizard.</entry>
</row>
<row>
<entry><xref linkend="mthShowWizButtons"/></entry>
<entry>Shows or hides buttons in an Aero wizard.</entry>
</row>
<row>
<entry><xref linkend="mthUnchanged"/></entry>
<entry>Informs this property sheet that information in a page has reverted to the previously saved state.</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="mthNewClsPropertySheetDialog" xreflabel="new"><title>new (Class method)</title>
<indexterm><primary>new</primary><secondary>ResDialog class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(--pages--+--------+--+---------+--+---------+--)-----------------------><
+-,-opts-+ +-,-title-+ +-,-hFile-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>PropertySheetDialog</computeroutput> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments when creating a new dialog instance of this class are:
<variablelist>
<varlistentry><term>pages [required]</term>
<listitem>
<para>
An array of <xref linkend="clsPropertySheetPage"/> dialogs to be used as the pages of the
property sheet. The number of the property sheet page dialogs and the order of the dialogs determines the number
and order of the pages in the property sheet.
</para>
</listitem></varlistentry>
<varlistentry><term>opts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>AEROWIZARD </member>
<member>HASHELP </member>
<member>NOAPPLYNOW </member>
<member>NOCONTEXTHELP </member>
<member>NOMARGIN </member>
<member>PROPTITLE </member>
<member>RESIZABLE </member>
<member>RTLREADING </member>
<member>USEPAGELANG </member>
<member>WIZARD97 </member>
<member>WIZARDCONTEXTHELP</member>
<member>WIZARDHASFINISH </member>
<member>WIZARDLITE </member>
</simplelist>
<variablelist>
<varlistentry><term>AEROWIZARD</term>
<listitem>
<para>
Creates a wizard property sheet that uses the newer Aero style. This keyword is not valid if the operating
system is not Vista or later. A syntax condition is raised if this keyword is used on Windows XP or earlier.
</para>
</listitem></varlistentry>
<varlistentry><term>HASHELP</term>
<listitem>
<para>
Permits property sheet pages, subclasses of the <xref linkend="clsPropertySheetPage"/> class, to display a
<emphasis role="italic">Help</emphasis> button. The HASHELP keyword must also be used in the page's <emphasis
role="italic">opts</emphasis> argument when the page is instantiated. If any of the initial property sheet pages
enable a Help button, the operating system will automatically enables this feature in the property sheet dialog.
If none of the initial pages enable a Help button, the HASHELP keyword must be explicitly set in order to have
Help buttons on any pages that might be added later. This keyword is not supported if the AEROWIZARD style is
used.
</para>
</listitem></varlistentry>
<varlistentry><term>NOAPPLYNOW</term>
<listitem>
<para>
Removes the Apply button. This keyword is not supported with the AEROWIZARD style.
</para>
</listitem></varlistentry>
<varlistentry><term>NOCONTEXTHELP</term>
<listitem>
<para>
Removes the context-sensitive Help button ("?"), which is usually present on the caption bar of property
sheets. This flag is not valid for wizards.
</para>
</listitem></varlistentry>
<varlistentry><term>NOMARGIN</term>
<listitem>
<para>
Specifies that no margin is inserted between the page and the frame. Must be used in combination with
AEROWIZARD.
</para>
</listitem></varlistentry>
<varlistentry><term>PROPTITLE</term>
<listitem>
<para>
Adjusts the title in the title bar of the property sheet. The title takes the appropriate form for the
Microsoft Windows version. In more recent versions of Windows, the title is the string specified by the
<xref linkend="atrCaption"/> attribute followed by the string <emphasis
role="italic">Properties</emphasis>. In older versions of Windows, the title is the string <emphasis
role="italic">Properties for</emphasis>, followed by the string specified by the <emphasis
role="italic">caption</emphasis> attribute This keyword is not supported with the AEROWIZARD style.
</para>
</listitem></varlistentry>
<varlistentry><term>RESIZABLE</term>
<listitem>
<para>
Allows the wizard to be resized by the user. Maximize and minimize buttons appear in the wizard's frame and
the frame is sizable. To use this keyword, the AEROWIZARD keyword must also be set.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Reverses the direction in which the tile of the property dialog is displayed. Normal windows display all
text, including the title, left-to-right (LTR). For languages such as Hebrew or Arabic that read
right-to-left (RTL), a window can be mirrored and all text will be displayed RTL. If RTLREADING is set, the
title will instead read RTL in a normal parent window and LTR in a mirrored parent window.
</para>
</listitem></varlistentry>
<varlistentry><term>USEPAGELANG</term>
<listitem>
<para>
Specifies that the language for the property sheet dialog will be taken from the first page's resource. That
page must be specified by resource identifier. This keyword is included for completeness, it will have no
effect in the current ooDialog implementation. It is possible that a future enhancement to ooDialog will
make this keyword relevant
</para>
</listitem></varlistentry>
<varlistentry><term>WIZARD97</term>
<listitem>
<para>
Creates a Wizard97-style property sheet that allows a header and/or watermark bitmap to be displayed in the
background. This keyword is not supported with the AEROWIZARD style.
</para>
</listitem></varlistentry>
<varlistentry><term>WIZARDCONTEXTHELP</term>
<listitem>
<para>
Adds a context-sensitive Help button ("?"), which is usually absent from the caption bar of a wizard. This
keyword is not supported with the AEROWIZARD style.
</para>
</listitem></varlistentry>
<varlistentry><term>WIZARDHASFINISH</term>
<listitem>
<para>
Always displays the Finish button on the wizard. One of the other WIZARDxx keywords must also be used.
</para>
</listitem></varlistentry>
<varlistentry><term>WIZARDLITE</term>
<listitem>
<para>
Uses the Wizard-lite style. This style is similar in appearance to WIZARD97. There are few restrictions on
how the pages are formatted. For instance, there are no enforced borders, and the WIZARDLITE style does not
paint the watermark and header bitmaps the way WIZARD97 does. This keyword is not supported with the
AEROWIZARD style.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>title [optional]</term>
<listitem>
<para>
Sets the <xref linkend="atrCaption"/> attribute to the text specified.
</para>
</listitem></varlistentry>
<varlistentry><term>hFile [optional]</term>
<listitem>
<para>
A file, (often called a header <xref linkend="defHeaderFile"/>,) defining
<xref linkend="defSymbolicId"/> IDs for resources. The symbolic IDs defined within the file will be
added to the <xref linkend="atrConstDir"/> directory.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
<computeroutput>PropertySheetDialog</computeroutput> dialogs are a little different than most ooDialog dialogs in
that their life-cycle is controlled by the operating system rather than the ooDialog framework. In general the
programmer customizes these dialogs by using the proper keywords in the <emphasis role="italic">opts</emphasis>
argument and by setting the attributes of the dialog object, then starting the dialog through <xref
linkend="mthExecuteClsPSD"/> or <xref linkend="mthPopupClsPSD"/>. Most of the programming work for a property sheet
dialog is in the dialogs that are used as the pages for the property sheet.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example sets up the 5 dialogs to be used as the pages of the property sheet dialog and then instantiates that
dialog:
<programlisting>
<![CDATA[
-- Create the 5 dialog pages.
p1 = .ListViewDlg~new("rc\PropertySheetDemo.rc", IDD_LISTVIEW_DLG)
p2 = .TreeViewDlg~new("rc\PropertySheetDemo.rc", IDD_TREEVIEW_DLG)
p3 = .ProgressBarDlg~new("rc\PropertySheetDemo.rc", IDD_PROGRESSBAR_DLG)
p4 = .TrackBarDlg~new("rc\PropertySheetDemo.rc", IDD_TRACKBAR_DLG)
p5 = .TabDlg~new("rc\PropertySheetDemo.rc", IDD_TAB_DLG)
-- Create the PropertySheetDialog using an array of the 5 dialog pages. The
-- order of the pages in the array will be the order of the pages in the tab
-- control of the property sheet.
pages = .array~of(p1, p2, p3, p4, p5)
propDlg = .PropertySheetDemoDlg~new(pages, "NOAPPLYNOW", "ooRexx Property Sheet with Controls")
-- Do any customization of the property sheet dialog by setting the values of
-- the appropriate attributes.
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section>
<section id="atrAppIcon" xreflabel="appIcon"><title>appIcon (Attribute)</title>
<indexterm><primary>appIcon</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>appIcon</secondary></indexterm>
<programlisting>
<![CDATA[
>>--appIcon--------------------------------------><
>>--appIcon=icon---------------------------------><
]]>
</programlisting>
<para>
Reflects the value of the <xref linkend="defDialogIcon"/> for the property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">appIcon get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">appIcon</emphasis> attribute will be the
<computeroutput>.nil</computeroutput> object if the programmer has not specified a dialog icon. Otherwise the value
is that specified.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">appIcon set:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">appIcon</emphasis> can be set either using an <xref linkend="clsImage"/>
object, or a resource ID, numeric or <xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When the <emphasis role="italic">appIcon</emphasis> is specified as an <computeroutput>Image</computeroutput>
object, then the image must actually be an icon. It can not be a bitmap, or cursor, etc..
</para>
<para>
When the <emphasis role="italic">appIcon</emphasis> attribute is specified as a resource ID, then the image must be
a resource in the resource <xref linkend="clsResourceImage"/> specified by the
<xref linkend="atrResourcesClsPSD"/> attribute. When the property sheet dialog is shown, if an icon can not
be loaded from the resource image, the the property sheet dialog will not have a dialog icon.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage in setting the attribute is detected. If the <emphasis
role="italic">appIcon</emphasis> attribute is set to a numeric value, the ooDialog framework can not detect whether
the number is correct or not. If the number, (or if the number a symbolic ID resolves to,) is not a resource ID of a
resource in the <emphasis role="italic">resources</emphasis> resource image, the the property sheet dialog will not
have a dialog icon when it is shown.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example sets the dialog icon for a property sheet dialog:
<programlisting>
<![CDATA[
-- For the appliation icon of the dialog we will use the ooRexx icon which is
-- available for general use from oodialog.dll.
propDlg~resources = .ResourceImage~new("oodialog.dll", propDlg)
propDlg~appIcon = "IDI_DLG_OOREXX"
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::appIcon() [attribute] -->
<section id="atrCaption" xreflabel="caption"><title>caption (Attribute)</title>
<indexterm><primary>caption</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>caption</secondary></indexterm>
<programlisting>
<![CDATA[
>>--caption--------------------------------------><
>>--caption=varName------------------------------><
]]>
</programlisting>
<para>
Reflects the caption, or title, of the property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">caption get:</emphasis></term>
<listitem>
<para>
Returns the string to be used for the property sheet dialog, or the <computeroutput>.nil</computeroutput> object if
no caption has been set.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">caption set:</emphasis></term>
<listitem>
<para>
Sets the value the property sheet dialog will use for its title bar when the
<xref linkend="ovvUnderlying"/> dialog is created.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This is not a <emphasis role="italic">dynamic</emphasis> attribute. I.e., if the underlying property sheet has its
title bar caption changed, say through the <xref linkend="mthSetTitleClsWindowBase"/> method, the value of the
<emphasis role="italic">caption</emphasis> attribute will not change. Likewise, if the programmer were to change the
value of this attribute after the underlying dialog was created, it would not change the title bar of the dialog. At
the time the underlying dialog is created, this attribute is used to set the dialog's title bar. Other than that,
the attribute does nothing.
</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 PropertySheetDialog::caption() [attribute] -->
<section id="atrHeader" xreflabel="header"><title>header (Attribute)</title>
<indexterm><primary>header</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>header</secondary></indexterm>
<programlisting>
<![CDATA[
>>--header---------------------------------------><
>>--header=varName-------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">header</emphasis> attribute specifies the bitmap that will be placed at the right side of
an interior page's header area in a Wizard dialog. The <emphasis role="italic">header</emphasis> attribute is only
used for the Wizard style property sheet dialogs.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">header get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">header</emphasis> attribute is the <computeroutput>.nil</computeroutput>
object until it has been set by the programmer. Unless the dialog is a Wizard property sheet dialog, it will always
be the <computeroutput>.nil</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">header set:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">header</emphasis> attribute should be set either to an
<xref linkend="clsImage"/> object of the bitmap to display in the header area of a Wizard dialog, or to the
resource ID of the bitmap to be used. Do not set the <emphasis role="italic">header</emphasis> attribute if the
dialog is not a Wizard.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The bitmap for the header area can either be a stand alone bitmap loaded as an
<computeroutput>Image</computeroutput> object, or it can be a compiled binary image located in the resource section
of an executable file. If the bitmap is within the resource section of an executable module, then the
<xref linkend="atrResourcesClsPSD"/> attribute of this dialog object is set to the executable and the
<emphasis role="italic">header</emphasis> attribute is set to the resource ID of the bitmap.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows the header attribute of a Wizard dialog being set to an <computeroutput>Image</computeroutput>
object containing the desired bitmap to be used in the header area of the Wizard:
<programlisting>
<![CDATA[
-- Create the property sheet using the dialog pages and set its attributes.
wizDlg = .TicketWizard97~new(pages, "Wizard97", "Let's Go To The Movies")
wizDlg~header = .Image~getImage("rc\ticketWizardTheater.bmp")
wizDlg~watermark = .Image~getImage("rc\ticketWizardRexxLA.bmp")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::header() [attribute] -->
<section id="atrImageList" xreflabel="imageList"><title>imageList (Attribute)</title>
<indexterm><primary>imageList</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>imageList</secondary></indexterm>
<programlisting>
<![CDATA[
>>--imageList------------------------------------><
>>--imageList=varName----------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">imagelist</emphasis> attribute is used to assign icons for the tabs of the tab control in
a property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">imageList get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">imageList</emphasis> attribute is an
<xref linkend="clsImageList"/> object if one has been assigned, otherwise it is the
<computeroutput>.nil</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">imageList set:</emphasis></term>
<listitem>
<para>
When an <xref linkend="clsImageList"/> object is assigned to the <emphasis
role="italic">imageList</emphasis> attribute, the icons in the imagelist are used as the icons in the tabs of the
pages in the property sheet. The icons are assigned in order to the pages, the first icon in the imagelist is
assigned to the first page, the second icon to the second page, etc..
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
An icon for the tab of a page can also be assigned through the <xref linkend="atrTabIcon"/> attribute
of the <xref linkend="clsPropertySheetPage"/> dialog object for each page in a property sheet
dialog. However, assigning an image list to the <emphasis role="italic">imageList</emphasis> attribute takes
precedence over the <emphasis role="italic">tabIcon</emphasis> attribute of a property sheet page dialog. If an
image list is asigned to the <emphasis role="italic">imageList</emphasis> attribute of the property sheet dialog,
the <emphasis role="italic">tabIcon</emphasis> attribute of the property sheet page dialog is not checked.
</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 PropertySheetDialog::imageList() [attribute] -->
<section id="atrPages" xreflabel="pages"><title>pages (Attribute)</title>
<indexterm><primary>pages</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>pages</secondary></indexterm>
<programlisting>
<![CDATA[
>>--pages----------------------------------------><
>>--pages=varName--------------------------------><
]]>
</programlisting>
<para>
Reflects the dialog objects used as the pages of this property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">pages get:</emphasis></term>
<listitem>
<para>
Returns an array of the dialog objects used for the pages of the property sheet dialog. The dialog object at index 1
is the dialog for the first page in the property sheet. The dialog object at index 2 is the the dialog for the
second page, etc..
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">pages set:</emphasis></term>
<listitem>
<para>
The programmer can not set this attribute, it is set by the ooDialog framework.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The programmer can not manipulate the pages in the property sheet dialog by manipulating the array that is the value
of this attrbiute. I.e., if the programmer removes an index of the array, it does not remove that page in the
property sheet, if the programmer adds an index to the array, it does not add a page to the property sheet dialog.
Page manipulation must be done through the instance methods of the property sheet dialog, for instance, the
<xref linkend="mthInsertPage"/> or <xref linkend="mthRemovePage"/> methods.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::pages() [attribute] -->
<section id="atrResourcesClsPSD" xreflabel="resources"><title>resources (Attribute)</title>
<indexterm><primary>resources</primary><secondary>PropertySheetDialog class</secondary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>resources</secondary></indexterm>
<programlisting>
<![CDATA[
>>--resources------------------------------------><
>>--resources-=-image----------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">resources</emphasis> attribute can be set to a
<xref linkend="clsResourceImage"/> object to supply some or all of the resources used by the
<computeroutput>PropertySheetDialog</computeroutput>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">resources get:</emphasis></term>
<listitem>
<para>
Returns the <computeroutput>ResourceImage</computeroutput> object if this attribute has been set by the programmer
or the <computeroutput>.nil</computeroutput> object if the attrbute has not been set.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">resources set:</emphasis></term>
<listitem>
<para>
This attribute can only be set to a <xref linkend="clsResourceImage"/> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Many of the resources used by a property sheet dialog can be located within the resource section of an executable
module. (Recall that in Windows both an executable file and a DLL are executable modules.) Resources such as the
<xref linkend="atrAppIcon"/>, <xref linkend="atrHeader"/>,
<xref linkend="atrImageList"/>, etc.. can all be located in the
<computeroutput>ResourceImage</computeroutput> that is the value of the <emphasis role="italic">resources</emphasis>
attribute.
</para>
<para>
These resources are then all specified by their resource ID in the resource image. Since the <emphasis
role="italic">resources</emphasis> attribute can only have one value, this implies that all resources specified by
resource ID must reside within the same resource image.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows the assignment of a <computeroutput>ResourceImage</computeroutput> object to the <emphasis
role="italic">resources</emphasis> attribute and specifing the resource ID to use for the appIcon of the property
sheet dialog:
<programlisting>
<![CDATA[
-- For the appliation icon of the dialog we will use the ooRexx icon which is
-- available for general use from oodialog.dll.
propDlg~resources = .ResourceImage~new("oodialog.dll", propDlg)
propDlg~appIcon = IDI_DLG_OOREXX
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::resources() [attribute] -->
<section id="atrStartPage" xreflabel="startPage"><title>startPage (Attribute)</title>
<indexterm><primary>startPage</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>startPage</secondary></indexterm>
<programlisting>
<![CDATA[
>>--startPage------------------------------------><
>>--startPage=varName----------------------------><
]]>
</programlisting>
<para>
Reflects the index of the page that will be selected and visible when the property sheet dialog is first shown on the
screen.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">startPage get:</emphasis></term>
<listitem>
<para>
Returns the one-based index of the page that will be visible when the property sheet dialog is started.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">startPage set:</emphasis></term>
<listitem>
<para>
By default the <emphasis role="italic">startPage</emphasis> attribute is set to 1 so that the first page in the
property sheet is shown first. The first page to be shown can be changed by setting this attribute to the index of
some other page.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">startPage</emphasis> attribute must be set within the range of 1 to
<link linkend="tblPropertySheetDialogMethods">MAXPROPPAGES</link> or a syntax condition will be raised. If <emphasis
role="italic">startPage</emphasis> is set to an index larger than the number of pages, then the first page will be
shown.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example changes the first page to be shown from the default to page 3:
<programlisting>
<![CDATA[
propDlg~startPage = 3
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::startPage() [attribute] -->
<section id="atrWatermark" xreflabel="watermark"><title>watermark (Attribute)</title>
<indexterm><primary>watermark</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>watermark</secondary></indexterm>
<programlisting>
<![CDATA[
>>--watermark------------------------------------><
>>--watermark=varName----------------------------><
]]>
</programlisting>
<para>
Reflects the watermark bitmap image that will be used with a Wizard97 property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">watermark get:</emphasis></term>
<listitem>
<para>
Returns the bitmap image, or resource ID of the bitmap image, that will be used for the watermark. The value of this
attribute is the <computeroutput>.ni</computeroutput> object if the attrbute has not been set or the property sheet
dialog is not a Wizard97 property sheet dialog.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">watermark set:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">watermark</emphasis> attribute should be set either to an
<xref linkend="clsImage"/> object of the bitmap to display as the warermark of a Wizard dialog, or to the
resource ID of the bitmap to be used. Do not set the <emphasis role="italic">watermakr</emphasis> attribute if the
dialog is not a Wizard97 property sheet dialog.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The bitmap for the watermark can either be a stand alone bitmap loaded as an <computeroutput>Image</computeroutput>
object, or it can be a compiled binary image located in the resource section
of an executable file. If the bitmap is within the resource section of an executable module, then the
<xref linkend="atrResourcesClsPSD"/> attribute of this dialog object is set to the executable and the
<emphasis role="italic">watermark</emphasis> attribute is set to the resource ID of the bitmap.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect arguments are detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example creates a Wizard97 property sheet dialog and sets the watermark bitmap to an
<computeroutput>Image</computeroutput> object. The bitmap will be loaded from the
<computeroutput>tickerWizardRexxLA.bmp</computeroutput> bitmap file:
<programlisting>
<![CDATA[
wizDlg = .TicketWizard97~new(pages, "Wizard97", "Let's Go To The Movies")
wizDlg~header = .Image~getImage("rc\ticketWizardTheater.bmp")
wizDlg~watermark = .Image~getImage("rc\ticketWizardRexxLA.bmp")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::watermark() [attribute] -->
<section id="mthAddPage" xreflabel="addPage"><title>addPage</title>
<indexterm><primary>addPage</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>addPage</secondary></indexterm>
<programlisting>
<![CDATA[
>>--addPage(--pageDlg--+---------------+--)------><
+-,-isExterior--+
]]>
</programlisting>
<para>
Adds a page to the property sheet at the end of the current pages.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>pageDlg [required]</term>
<listitem>
<para>
The Rexx dialog object to use as the page being added.
</para>
</listitem></varlistentry>
<varlistentry><term>isExterior [optional]</term>
<listitem>
<para>
Specifies if the added page is an exterior page of a wizard property sheet dialog. If the property sheet dialog
is not a wizard, this argument is ignored.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Syntax conditions are raised if the <emphasis role="italic">page</emphasis> argument is not correct. The argument
must be a <xref linkend="clsPropertySheetPage"/> dialog object.
</para>
<para>
This method must not be invoked from within the event handling methods, <xref linkend="mthApplyClsPSP"/>,
<xref linkend="mthKillActive"/>, <xref linkend="mthReset"/>, or
<xref linkend="mthSetActive"/> of the <xref linkend="clsPropertySheetPage"/>
class. However, you can add or remove pages during the <xref linkend="mthWizBack"/> or
<xref linkend="mthWizNext"/> event handling methods, provided the correct index to specify the new page is
returned from those event handlers.
</para>
<para>
The dialog object must not have already been <emphasis role="italic">used</emphasis> as a property sheet page. In
addition to adding or inserting pages in a property sheet, pages can be removed from a property sheet. When the
page is removed, the operating system destroys the underlying Windows dialog. Although the Rexx dialog object is
still active, that object can not be reinserted into a property sheet as a page.
</para>
<para>
It is possible that the user never <emphasis role="italic">visited</emphasis> a page before it was removed. In this
case the Rexx dialog object could be used to add or insert a new page at some later point, because the underlying
Windows dialog would never have been created. The <xref linkend="atrWasActivatedClsPSP"/>
attribute can be used to test for this condition. However, it
is probably simplier to always instantiate a new Rexx dialog object for each page added to a property sheet.
</para>
<para>
The Windows operating system restricts the maximum number of pages that a property sheet can hold. The MAXPROPPAGES
constant of the <xref linkend="clsPropertySheetDialog"/> reflects this number. If the
programer tries to insert or add a page past this number, a condition is raised.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::addPage() -->
<section id="mthApplyClsPSD" xreflabel="apply"><title>apply</title>
<indexterm><primary>apply</primary><secondary>PropertySheetDialog class</secondary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>apply</secondary></indexterm>
<programlisting>
<![CDATA[
>>--apply----------------------------------------><
]]>
</programlisting>
<para>
Simulates the selection of the Apply button, indicating that one or more pages have changed and the changes need to
be validated and recorded.
</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>
Returns 0, always.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::apply() -->
<section id="mthCancelToClose" xreflabel="cancelToClose"><title>cancelToClose</title>
<indexterm><primary>cancelToClose</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>cancelToClose</secondary></indexterm>
<programlisting>
<![CDATA[
>>--cancelToClose--------------------------------><
]]>
</programlisting>
<para>
Used when changes made since the most recent APPLY notification cannot be canceled.
</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>
Returns 0, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
<emphasis role="italic">cancelToClose</emphasis> disables the <emphasis role="italic">Cancel</emphasis> button and
changes the text of the OK button to <emphasis role="italic">Close</emphasis>.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::cancelToClose() -->
<section id="mthChanged" xreflabel="changed"><title>changed</title>
<indexterm><primary>changed</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>changed</secondary></indexterm>
<programlisting>
<![CDATA[
>>--changed(--pageDlg--)-------------------------><
]]>
</programlisting>
<para>
Informs the underlying property sheet dialog that information in a page has changed.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>pageDlg</term>
<listitem>
<para>
The Rexx dialog object that is the page that is changed.
</para>
</listitem></varlistentry>
</variablelist>
</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>
The underlying property sheet enables the <emphasis role="italic">Apply</emphasis> button.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::changed() -->
<section id="mthEnableWizButtons" xreflabel="enableWizButtons"><title>enableWizButtons</title>
<indexterm><primary>enableWizButtons</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>enableWizButtons</secondary></indexterm>
<programlisting>
<![CDATA[
>>--enableWizButtons(--+--------+--+----------------+--)--------><
+--opts--+ +-,-optsButtons--+
]]>
</programlisting>
<para>
Enables or disables buttons in an Aero wizard. <emphasis role="italic">Vista</emphasis> or later only. This method
does nothing if this property sheet is not an Aero wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>opts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant. These specify which
property sheet buttons are to be enabled. If a button value is included in both this argument and <emphasis
role="italic">optsButton</emphasis> then it is enabled.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BACK </member>
<member>CANCEL</member>
<member>FINISH</member>
<member>NEXT </member>
</simplelist>
<variablelist>
<varlistentry><term>BACK</term>
<listitem>
<para>
The Back button.
</para>
</listitem></varlistentry>
<varlistentry><term>CANCEL</term>
<listitem>
<para>
The Cancel button.
</para>
</listitem></varlistentry>
<varlistentry><term>FINISH</term>
<listitem>
<para>
The Finish button.
</para>
</listitem></varlistentry>
<varlistentry><term>NEXT</term>
<listitem>
<para>
The Next button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>opts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant. These specify which
property sheet buttons are affected by this method invocation. If a button value appears in this parameter but
not in <emphasis role="italic">opts</emphasis>, the button is disabled.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BACK </member>
<member>CANCEL</member>
<member>FINISH</member>
<member>NEXT </member>
</simplelist>
<variablelist>
<varlistentry><term>BACK</term>
<listitem>
<para>
The Back button.
</para>
</listitem></varlistentry>
<varlistentry><term>CANCEL</term>
<listitem>
<para>
The Cancel button.
</para>
</listitem></varlistentry>
<varlistentry><term>FINISH</term>
<listitem>
<para>
The Finish button.
</para>
</listitem></varlistentry>
<varlistentry><term>NEXT</term>
<listitem>
<para>
The Next button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true if this is an Aero Wizard property sheet on Vista on later, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method only works for Aero Wizards. This method requires Vista or later, a condition is raised if the OS is
not Vista or later. This method has no effect if the property sheet is not an Aero wizard.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::enableWizButtons() -->
<section id="mthExecuteClsPSD" xreflabel="execute"><title>execute</title>
<indexterm><primary>execute</primary><secondary>PropertySheetDialog class</secondary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>execute</secondary></indexterm>
<programlisting>
<![CDATA[
>>--execute(--+---------+--)---------------------><
+--owner--+
]]>
</programlisting>
<para>
Starts the execution of the underlying, <link linkend="defModalModeless">modal</link>, property sheet dialog. This method
does not return until the user has closed the property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>owner [optional]</term>
<listitem>
<para>
The Rexx dialog object whose underlying dialog is the owner dialog of this property sheet dialog. Typically
modal dialogs have an owner dialog. If this argument is omitted, then no owner dialog is set.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns a positive number if successful and -1 on error. It is possible that the return will be either one of the
<link linkend="tblPropertySheetDialogMethods">constants</link> ID_PSRESTARTWINDOWS or ID_PSREBOOTSYSTEM.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
<para>
Sets the <xref linkend="dotSystemErrorCode"/>.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::execute() -->
<section id="mthGetCurrentPageHwnd" xreflabel="getCurrentPageHwnd"><title>getCurrentPageHwnd</title>
<indexterm><primary>getCurrentPageHwnd</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>getCurrentPageHwnd</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getCurrentPageHwnd---------------------------><
]]>
</programlisting>
<para>
Retrieves the window <xref linkend="defHandle"/> of the <xref linkend="ovvUnderlying"/>
dialog of the current page in this property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments to this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the current pages window handel.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::getCurrentPageHwnd() -->
<section id="mthGetPage" xreflabel="getPage"><title>getPage</title>
<indexterm><primary>getPage</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>getPage</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getPage(--index--)---------------------------><
]]>
</programlisting>
<para>
Gets the Rexx dialog object for the page specified by <emphasis role="italic">index</emphasis>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the page in the property sheet whose Rexx dialog object should be retrieved.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx dialog object for the page specified
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::getPage() -->
<section id="mthGetResultClsPSD" xreflabel="getResult"><title>getResult</title>
<indexterm><primary>getResult</primary><secondary>PropertySheetDialog class</secondary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>getResult</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getResult------------------------------------><
]]>
</programlisting>
<para>
Returns a keyword indicating the result of executing the <computeroutput>PropertySheetDialog</computeroutput>.
</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>
Returns one of the following keywords to indicate the result of executing the property sheet dialog:
<variablelist>
<varlistentry><term>NotFinished</term>
<listitem>
<para>
The property sheet dialog has not been closed yet.
</para>
</listitem></varlistentry>
<varlistentry><term>ExecutionErr</term>
<listitem>
<para>
The property sheet dialog did not execute because of an error.
</para>
</listitem></varlistentry>
<varlistentry><term>RebootSystem</term>
<listitem>
<para>
A page sent the reboot system message to the property sheet. The computer must be restarted for the user's
changes to take effect.
</para>
</listitem></varlistentry>
<varlistentry><term>RestartWindows</term>
<listitem>
<para>
A page sent restart Windows message to the property sheet. Microsoft Windows must be restarted for the user's
changes to take effect.
</para>
</listitem></varlistentry>
<varlistentry><term>ClosedCancel</term>
<listitem>
<para>
The user canceled the dialog
</para>
</listitem></varlistentry>
<varlistentry><term>ClosedOk</term>
<listitem>
<para>
The user closed the dialog with ok.
</para>
</listitem></varlistentry>
<varlistentry><term>Unknown</term>
<listitem>
<para>
This return should never happen. It would indicate the internal state of the ooDialog framework is inconsistent.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::getResult() -->
<section id="mthGetTabControl" xreflabel="getTabControl"><title>getTabControl</title>
<indexterm><primary>getTabControl</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>getTabControl</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getTabControl--------------------------------><
]]>
</programlisting>
<para>
Retrieves the Rexx tab control object for the tab control of the property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no argument for this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the Rexx <xref linkend="clsTab"/> control for the underlying Windows tab control in the property
sheet dialog
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::getTabControl() -->
<section id="mthHwndToIndex" xreflabel="hwndToIndex"><title>hwndToIndex</title>
<indexterm><primary>hwndToIndex</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>hwndToIndex</secondary></indexterm>
<programlisting>
<![CDATA[
>>--hwndToIndex(--hwnd--)------------------------><
]]>
</programlisting>
<para>
Returns the one-based index of the property sheet page specified by <emphasis role="italic">hwnd</emphasis>, its
window handle.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>hwnd [required]</term>
<listitem>
<para>
The <xref linkend="atrHwnd"/><xref linkend="defHandle"/> whose page index is needed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the one-based index of the page on success, otherwise zero.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::hwndToIndex() -->
<section id="mthIdToIndex" xreflabel="idToIndex"><title>idToIndex</title>
<indexterm><primary>idToIndex</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>idToIndex</secondary></indexterm>
<programlisting>
<![CDATA[
>>--idToIndex(--id--)----------------------------><
]]>
</programlisting>
<para>
Takes a property sheet page ID and returns its one-based page index.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>ID [required]</term>
<listitem>
<para>
The property sheet page <xref linkend="mthIndexToID"/>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The one-based index of the page on success, or 0 on error.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::idToIndex() -->
<section id="mthIndexToHwnd" xreflabel="indexToHwnd"><title>indexToHwnd</title>
<indexterm><primary>indexToHwnd</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>indexToHwnd</secondary></indexterm>
<programlisting>
<![CDATA[
>>--indexToHwnd(--index--)-----------------------><
]]>
</programlisting>
<para>
Given the one-based index to a page, returns the window handle of the underlying page dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based page index.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The window handle for the page.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::indexToHwnd() -->
<section id="mthIndexToID" xreflabel="indexToID"><title>indexToID</title>
<indexterm><primary>indexToID</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>indexToID</secondary></indexterm>
<programlisting>
<![CDATA[
>>--indexToID(--index--)-------------------------><
]]>
</programlisting>
<para>
Given the index of a page, returns its ID.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is :
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the page. The special values 0 and -1 are also acceptable.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The proper page ID for the index.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Page IDs are different depending on the type of the dialog page, <xref linkend="clsUserPSPDialog"/>,
<xref linkend="clsResPSPDialog"/>, etc.. In order to get the correct ID, the Rexx programmer
must use this method.
</para>
<para>
There are also two special case values for <emphasis role="italic">index</emphasis>. The page ID would most
commonly be used in the <xref linkend="mthSetActive"/>, <xref linkend="mthWizBack"/>, or
<xref linkend="mthWizNext"/> event notification methods that signal a page is being changed. To accept
the page change, the event handler returns 0, and to cancel the page change the event handler returns -1. So, 0 and
-1 are acceptable here and return the proper value for those methods.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::indexToID() -->
<section id="mthIndexToPage" xreflabel="indexToPage"><title>indexToPage</title>
<indexterm><primary>indexToPage</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>indexToPage</secondary></indexterm>
<programlisting>
<![CDATA[
>>--indexToPage(--index--)-----------------------><
]]>
</programlisting>
<para>
Returns the PROPSHEETPAGE <xref linkend="defHandle"/> for the specified page index.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based page index.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The PROPSHEETPAGE handle for the specified page.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The PROPSHEETPAGE handle is not the same as the window handle of the page. This method is added for completeness. In
the current implementation of ooDialog, the returned handle will not be of much use to the programmer. However,
future version of ooDialog may have enhancements that require a PROPSHEETPAGE handle.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::indexToPage() -->
<section id="mthInitDialogClsPSD" xreflabel="initDialog"><title>initDialog</title>
<indexterm><primary>initDialog</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>initDialog</secondary></indexterm>
<programlisting>
<![CDATA[
>>--initDialog-----------------------------------><
]]>
</programlisting>
<para>
Invoked by the ooDialog framework when the underlying property sheet dialog has first been created. This is the same
point in the life-cycle of the property sheet dialog as the <xref linkend="mthInitDialog"/> method is
invoked for the normal <xref linkend="chpDialogObject"/> object.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments to this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Any return from this method is ignored.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method is available for the programmer to over-ride for any purpose the programmer deems useful. However, since
the operating system manages the property sheet dialog, this method will not be as useful as it is in the typical
ooDialog dialog.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::initDialog() -->
<section id="mthInsertPage" xreflabel="insertPage"><title>insertPage</title>
<indexterm><primary>insertPage</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>insertPage</secondary></indexterm>
<programlisting>
<![CDATA[
>>--insertPage(--pageDlg--,--index--+---------------+--)--------><
+-,-isExterior--+
]]>
</programlisting>
<para>
Inserts a new page into the property sheet dialog at the specified index.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>pageDlg [required]</term>
<listitem>
<para>
The Rexx dialog object to use as the page being inserted.
</para>
</listitem></varlistentry>
<varlistentry><term>index</term>
<listitem>
<para>
The one-based index where the page is to be inserted.
</para>
</listitem></varlistentry>
<varlistentry><term>isExterior [optional]</term>
<listitem>
<para>
Specifies if the inserted page is an exterior page of a wizard property sheet dialog. If the property sheet
dialog is not a wizard, this argument is ignored.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Syntax conditions are raised if the <emphasis role="italic">page</emphasis> argument is not correct. The argument
must be a <xref linkend="clsPropertySheetPage"/> dialog object.
</para>
<para>
The pages after the insertion point are shifted to the right to accommodate the new page.
</para>
<para>
This method must not be invoked from within the event handling methods, <xref linkend="mthApplyClsPSP"/>,
<xref linkend="mthKillActive"/>, <xref linkend="mthReset"/>, or
<xref linkend="mthSetActive"/> of the <xref linkend="clsPropertySheetPage"/>
class. However, you can add or remove pages during the <xref linkend="mthWizBack"/> or
<xref linkend="mthWizNext"/> event handling methods, provided the correct index to specify the new page is
returned from those event handlers.
</para>
<para>
The dialog object must not have already been <emphasis role="italic">used</emphasis> as a property sheet page. In
addition to adding or inserting pages in a property sheet, pages can be removed from a property sheet. When the
page is removed, the operating system destroys the underlying Windows dialog. Although the Rexx dialog object is
still active, that object can not be reinserted into a property sheet as a page.
</para>
<para>
It is possible that the user never <emphasis role="italic">visited</emphasis> a page before it was removed. In this
case the Rexx dialog object could be used to add or insert a new page at some later point, because the underlying
Windows dialog would never have been created. The <xref linkend="atrWasActivatedClsPSP"/>
attribute can be used to test for this condition. However, it
is probably simplier to always instantiate a new Rexx dialog object for each page added to a property sheet.
</para>
<para>
The Windows operating system restricts the maximum number of pages that a property sheet can hold. The MAXPROPPAGES
constant of the <xref linkend="clsPropertySheetDialog"/> reflects this number. If the
programer tries to insert or add a page past this number, a condition is raised.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::insertPage() -->
<section id="mthPageToIndex" xreflabel="pageToIndex"><title>pageToIndex</title>
<indexterm><primary>pageToIndex</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>pageToIndex</secondary></indexterm>
<programlisting>
<![CDATA[
>>--pageToIndex(--hPage--)-----------------------><
]]>
</programlisting>
<para>
Takes the handle of a <xref linkend="mthIndexToPage"/> and returns the one-based index of the page.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>hPage</term>
<listitem>
<para>
The handle to the PROPSHEETPAGE whose index is needed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The one-based index of the page specified by <emphasis role="italic">hPage</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The PROPSHEETPAGE handle is not the same as the window handle of the page. This method is added for completeness. In
the current implementation of ooDialog, the PROPESHEET handle is not of much use to the programmer. However, future
version of ooDialog may have enhancements that require a PROPSHEETPAGE handle.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::pageToIndex() -->
<section id="mthPopupClsPSD" xreflabel="popup"><title>popup</title>
<indexterm><primary>popup</primary><secondary>rPropertySheetDialog class</secondary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>popup</secondary></indexterm>
<programlisting>
<![CDATA[
>>--popup----------------------------------------><
]]>
</programlisting>
<para>
Begins the execution of a modeless property sheet dialog and returns immediately.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
There are no arguments to this method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
All <computeroutput>PropertySheetDialog</computeroutput> objects must be executed through either the <emphasis
role="italic">popup</emphasis> or <xref linkend="mthExecuteClsPSD"/> methods. However, a property sheet
with the Aero Wizard style can not be executed as a modeless dialog. Do not use the <emphasis
role="italic">popup</emphasis> method with an Aero Wizard.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::popup() -->
<section id="mthPopupAsChildClsPSD" xreflabel="popupAsChild"><title>popupAsChild</title>
<indexterm><primary>popupAsChild</primary><secondary>PropertySheetDialog class</secondary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>popupAsChild</secondary></indexterm>
<programlisting>
<![CDATA[
>>--popupAsChild(--parent--)---------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">popupAsChild</emphasis> method starts a <link linkend="defModalModeless">modeless</link>
propertry sheet dialog executing and returns immediately. It is very similar to the <xref linkend="mthPopupClsPSD"/>
method, but has the additional functionality that it is closed automatically when the <emphasis
role="italic">parent</emphasis> dialog is closed.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
</para>
<variablelist>
<varlistentry><term>parent [required]</term>
<listitem>
<para>
Some other Rexx dialog object. A relationship is established with the <emphasis role="italic">parent</emphasis>
dialog such that when the <emphasis role="italic">parent</emphasis> dialog is closed, this dialog is
automatically closed also.
</para>
</listitem></varlistentry>
</variablelist>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The return is a Rexx <computeroutput>Message</computeroutput> object, (see the Open Object Rexx reference manual to
learn more about the <computeroutput>Message</computeroutput> class.) The message object can be used, for instance,
to check if the dialog has been closed by the user, to obtain the result value from the execution of the dialog,
etc..
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Note that the relationship between the dialog started with <emphasis role="italic">popupAsChild</emphasis> and the
<emphasis role="italic">parent</emphasis> dialog is one-way. When the <emphasis role="italic">parent</emphasis>
dialog is closed, the dialog started with the <emphasis role="italic">popupAsChild</emphasis> method is closed. But,
when the dialog started with <emphasis role="italic">popupAsChild</emphasis> is closed, the <emphasis
role="italic">parent</emphasis> dialog continues to execute as normal. It is not effected by the closing of the
<emphasis role="italic">child</emphasis> dialog.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows a property sheet dialog that is popped up from the parent dialog when a button is clicked:
<programlisting>
<![CDATA[
::method onPopup unguarded
-- Create the 5 dialog pages.
p1 = .ListViewDlg~new("rc\PropertySheetDemo.rc", IDD_LISTVIEW_DLG)
p2 = .TreeViewDlg~new("rc\PropertySheetDemo.rc", IDD_TREEVIEW_DLG)
p3 = .ProgressBarDlg~new("rc\PropertySheetDemo.rc", IDD_PROGRESSBAR_DLG)
p4 = .TrackBarDlg~new("rc\PropertySheetDemo.rc", IDD_TRACKBAR_DLG)
p5 = .TabDlg~new("rc\PropertySheetDemo.rc", IDD_TAB_DLG)
-- Create the PropertySheetDialog using an array of the 5 dialog pages.
pages = .array~of(p1, p2, p3, p4, p5)
title = "ooRexx Property Sheet with Controls"
propDlg = .PropertySheetDemoDlg~new(pages, "NOAPPLYNOW", title)
-- Show the property sheet.
propDlg~popupAsChild(self)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::popupAsChild() -->
<section id="mthPressButton" xreflabel="pressButton"><title>pressButton</title>
<indexterm><primary>pressButton</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>pressButton</secondary></indexterm>
<programlisting>
<![CDATA[
>>--pressButton(--button--)----------------------><
]]>
</programlisting>
<para>
Pushes the specified property sheet button programmatically.
</para>
<variablelist>
<varlistentry><term>button [required]</term>
<listitem>
<para>
Exactly one of the following keywords, case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>APPLYNOW</member>
<member>BACK </member>
<member>CANCEL </member>
<member>FINISH </member>
<member>HELP </member>
<member>NEXT </member>
<member>OK </member>
</simplelist>
<variablelist>
<varlistentry><term>APPLYNOW</term>
<listitem>
<para>
The ApplyNow button is pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>BACK</term>
<listitem>
<para>
The Back button is pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>Cancel</term>
<listitem>
<para>
The Cancel button is pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>Finish</term>
<listitem>
<para>
The Finish button is pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>Help</term>
<listitem>
<para>
The Help button is pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>Next</term>
<listitem>
<para>
The Next button is pushed.
</para>
</listitem></varlistentry>
<varlistentry><term>OK</term>
<listitem>
<para>
The Ok button is pushed.
</para>
</listitem></varlistentry>
</variablelist>
</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">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::pressButton() -->
<section id="mthQuerySiblings" xreflabel="querySiblings"><title>querySiblings</title>
<indexterm><primary>querySiblings</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>querySiblings</secondary></indexterm>
<programlisting>
<![CDATA[
>>--querySiblings(--arg1--,--arg2--)-------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">querySiblings</emphasis> method causes the underlying property sheet dialog to send the
<xref linkend="mthQueryFromSibling"/> notification, with the specified arguments to each page of
the of the property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The two arguments are sent in the QUERYFROMSIBLING notification exactly as specified. These arguments can be any
Rexx object desired.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns the nonzero value from a page in the property sheet, or zero if no page returns a nonzero value.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
If a page returns a nonzero value, the property sheet does not send the message to subsequent pages.
</para>
<para>
The <emphasis role="italic">querySiblings</emphasis> method provides a way for the different page dialogs in a
property sheet dialog to communicate with one another. The uses for this ability are certainly unlimited.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
In this example, when one of the pages in a wizard becomes active it sends an empty table to each of the other pages
in the property sheet combined with the command SELECTED. Each page then adds information to the table passed in
with the command. The information is specific to the application:
<programlisting>
<![CDATA[
::method setActive unguarded
expose filmArray movieTheaters selectedMovies movieCombo
use arg propSheet
propSheet~setWizButtons("BACK NEXT")
selected = .table~new
selectedMovies~empty
propSheet~querySiblings(selected, "SELECTED")
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::querySiblings() -->
<section id="mthRebootSystem" xreflabel="rebootSystem"><title>rebootSystem</title>
<indexterm><primary>rebootSystem</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>rebootSystem</secondary></indexterm>
<programlisting>
<![CDATA[
>>--rebootSystem---------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">rebootSystem</emphasis> method is invoked to notify the property sheet dialog that the
system needs to be rebooted for changes to take effect.
</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>
Returns 0 always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
An application should invoke the <emphasis role="italic">rebootSystem</emphasis> method only in response to the
APPLY or KILLACTIVE notifications. Invoking the method causes the <xref linkend="mthExecuteClsPSD"/>
method to return the ID_PSREBOOTSYSTEM value, or for the <xref linkend="mthGetResultClsPSD"/> method to
return <emphasis role="italic">RebootSystem</emphasis>. But only if the user clicks the OK button to close the
property sheet. It is the application's responsibility to reboot the system.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::rebootSystem() -->
<section id="mthRecalcPageSizes" xreflabel="recalcPageSizes"><title>recalcPageSizes</title>
<indexterm><primary>recalcPageSizes</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>recalcPageSizes</secondary></indexterm>
<programlisting>
<![CDATA[
>>--recalcPageSizes------------------------------><
]]>
</programlisting>
<para>
Causes a standard or wizard property sheet to recalculate the page size of all its pages. The <emphasis
role="italic">recalcPageSizes</emphasis> method would normally be invoked after pages have been added or removed.
</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>
Returns true if successful, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
When a property sheet is created, it is sized to fit its initial collection of pages. To maintain compatibility with
previous versions of the common controls, property sheets and wizards do not automatically resize themselves when
pages are subsequently added or removed. Applications would use the <emphasis
role="italic">recalcPageSizes</emphasis> method after adding or removing pages to ensure that the property sheet is
properly sized for its current collection of pages. <emphasis role="bold">Note</emphasis> however that the ooDialog
framework automatically invokes this method during the <xref linkend="mthAddPage"/>,
<xref linkend="mthInsertPage"/>, and <xref linkend="mthRemovePage"/> methods. Therefore
the programmer will normally not need to explicitly invoke this method.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::recalcPageSizes() -->
<section id="mthRestartWindows" xreflabel="restartWindows"><title>restartWindows</title>
<indexterm><primary>restartWindows</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>restartWindows</secondary></indexterm>
<programlisting>
<![CDATA[
>>--restartWindows-------------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">restartWindows</emphasis> method is invoked to notify the property sheet dialog that
Microsoft Windows needs to be restarted for changes to take effect.
</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>
An application should invoke the <emphasis role="italic">restartWindows</emphasis> method only in response to the
APPLY or KILLACTIVE notifications. Invoking the method causes the <xref linkend="mthExecuteClsPSD"/>
method to return the ID_PSRESTARTWINDOWS value, or for the <xref linkend="mthGetResultClsPSD"/> method to
return <emphasis role="italic">RestartWindows</emphasis>. But only if the user clicks the OK button to close the
property sheet. It is the application's responsibility to restart Windows.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::restartWindows() -->
<section id="mthRemovePage" xreflabel="removePage"><title>removePage</title>
<indexterm><primary>removePage</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>removePage</secondary></indexterm>
<programlisting>
<![CDATA[
>>--removePage(--+---------+--)------------------><
+--index--+
]]>
</programlisting>
<para>
Removes a page from this property sheet.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>index [optional]</term>
<listitem>
<para>
The one-based index of the page to remove. If this argument is omitted then the last page is removed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Always returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method must not be invoked from within the event handling methods, <xref linkend="mthApplyClsPSP"/>,
<xref linkend="mthKillActive"/>, <xref linkend="mthReset"/>, or
<xref linkend="mthSetActive"/> of the <xref linkend="clsPropertySheetPage"/>
class. However, you can add or remove pages during the <xref linkend="mthWizBack"/> or
<xref linkend="mthWizNext"/> event handling methods, provided the correct index to specify the new page is
returned from those event handlers.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::removePage() -->
<section id="mthSetButtonText" xreflabel="setButtonText"><title>setButtonText</title>
<indexterm><primary>setButtonText</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setButtonText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setButtonText(--button--,--text--)-----------><
]]>
</programlisting>
<para>
Sets the text of the specified button in an Aero wizard. <emphasis role="italic">Vista</emphasis> or later only. This method does
nothing if this property sheet is not an Aero wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>button [required]</term>
<listitem>
<para>
Exactly one of the following keyword, case is not significant. This specifies which property sheet button's text
will be set.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BACK </member>
<member>CANCEL</member>
<member>FINISH</member>
<member>NEXT </member>
</simplelist>
<variablelist>
<varlistentry><term>BACK</term>
<listitem>
<para>
The Back button.
</para>
</listitem></varlistentry>
<varlistentry><term>CANCEL</term>
<listitem>
<para>
The Cancel button.
</para>
</listitem></varlistentry>
<varlistentry><term>FINISH</term>
<listitem>
<para>
The Finish button.
</para>
</listitem></varlistentry>
<varlistentry><term>NEXT</term>
<listitem>
<para>
The Next button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text, the label, for the specified button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
True if the property sheet is an Aero wizard and the label for the button was allocated, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setButtonText() -->
<section id="mthSetCurSel" xreflabel="setCurSel"><title>setCurSel</title>
<indexterm><primary>setCurSel</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setCurSel</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setCurSel(--+----------+--+------------------+--)-----------><
+-,-index--+ +--hPropSheetPage--+
]]>
</programlisting>
<para>
Activates the specified page in a property sheet.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>index [optional]</term>
<listitem>
<para>
The one-based index of the page to be removed. If this argument is omitted, then the <emphasis
role="italic">hPropSheetPage</emphasis> argument can not be omitted.
</para>
</listitem></varlistentry>
<varlistentry><term>hPropSheetPage [optional]</term>
<listitem>
<para>
A <xref linkend="mthIndexToPage"/> <xref linkend="defHandle"/> for the page to be
removed. If this argument is omitted, then the <emphasis role="italic">index</emphasis> argument can not be
omitted.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, othewise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The property sheet page to activate can be specified by either the page index, or the property sheet page handle,
or both. If both are specified, the page index takes precedence.
</para>
<para>
Although both arguments are optional, they are optional individually. At least one of the arguments must be
specified or a condition is raised. In addition, if the index argument is used to specify the page is not a valid
index, a condition is raised.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setCurSel() -->
<section id="mthSetCurSelByID" xreflabel="setCurSelByID"><title>setCurSelByID</title>
<indexterm><primary>setCurSelByID</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setCurSelByID</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setCurSelByID(--id--)------------------------><
]]>
</programlisting>
<para>
Activates the page specified by <emphasis role="italic">id</emphasis> in this property sheet.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>id</term>
<listitem>
<para>
The page ID of the page to activate.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true on success, false on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The property sheet page ID can be obtained using the <xref linkend="mthIndexToID"/> method. Do not
confuse a page ID with a page handle, they are 2 separate things. The only way for the Rexx programmer to obtain
the page ID is through <emphasis role="italic">indexToID</emphasis>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setCurSelByID() -->
<section id="mthSetFinishText" xreflabel="setFinishText"><title>setFinishText</title>
<indexterm><primary>setFinishText</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setFinishText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setFinishText(--text--)----------------------><
]]>
</programlisting>
<para>
Sets the text of the Finish button in a wizard, shows and enables the button, and hides the Next and Back buttons.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text to display on the Finish button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns 0 always.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setFinishText() -->
<section id="mthSetHeaderSubTitle" xreflabel="setHeaderSubTitle"><title>setHeaderSubTitle</title>
<indexterm><primary>setHeaderSubTitle</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setHeaderSubTitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setHeaderSubTitle(--index--,--text--)--------><
]]>
</programlisting>
<para>
Sets or resets the text for the header subtitle in a wizard property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the page whose header subtitle is to be set.
</para>
</listitem></varlistentry>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text for the header subtitle.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Always returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method is not available for Aero-style wizards. If the page specified is the current page, it will immediately
be repainted to display the new subtitle.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setHeaderSubTitle() -->
<section id="mthSetHeaderTitle" xreflabel="setHeaderTitle"><title>setHeaderTitle</title>
<indexterm><primary>setHeaderTitle</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setHeaderTitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setHeaderTitle(--index--,--text--)-----------><
]]>
</programlisting>
<para>
Sets or resets the text for the header in a wizard property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>index [required]</term>
<listitem>
<para>
The one-based index of the page whose header text is to be set.
</para>
</listitem></varlistentry>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text for the header.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Always returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This method does not work for Aero-style wizards. If the page specified is the current page, it will immediately be
repainted to display the new header.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setHeaderTitle() -->
<section id="mthSetNextText" xreflabel="setNextText"><title>setNextText</title>
<indexterm><primary>setNextText</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setNextText</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setNextText(--text--)------------------------><
]]>
</programlisting>
<para>
Sets the text of the Next button in an Aero wizard. <emphasis role="italic">Vista</emphasis> or later only. This
method does nothing if this property sheet is not an Aero wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>text [required]</term>
<listitem>
<para>
The text to display on the Next button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
This method always returns 0.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setNextText() -->
<section id="mthSetTitleClsPSD" xreflabel="setTitle"><title>setTitle</title>
<indexterm><primary>setTitle</primary><secondary>PropertySheetDialog class</secondary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setTitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setTitle(--text--+---------------------+--)-----------------><
+-,-addPropertiesFor--+
]]>
</programlisting>
<para>
Sets the title for a property sheet dialog. Testing has shown that this method does nothing for any property sheet
that is a wizard.
</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 for the property sheet title.
</para>
</listitem></varlistentry>
<varlistentry><term>addPropertiesFor [optional]</term>
<listitem>
<para>
If true, the operating system includes the prefix <emphasis role="italic">Properties for</emphasis> with the
specified title text. Otherwise, the prefix is not used. The default is false.
</para>
</listitem></varlistentry>
</variablelist>
</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>
The MSDN documentation seems to indicate that this is valid for wizards, but experimentation shows it does not work
for any wizard.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setTitle() -->
<section id="mthSetWizButtons" xreflabel="setWizButtons"><title>setWizButtons</title>
<indexterm><primary>setWizButtons</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>setWizButtons</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setWizButtons(--+--------+--)----------------><
+--opts--+
]]>
</programlisting>
<para>
Enables or disables the Back, Next, and Finish buttons in a wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is.
<variablelist>
<varlistentry><term>opts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BACK </member>
<member>DISABLEFINISH</member>
<member>FINISH </member>
<member>NEXT </member>
</simplelist>
<variablelist>
<varlistentry><term>BACK</term>
<listitem>
<para>
Enables the Back button. If this keyword is missing, the Back button is displayed as disabled.
</para>
</listitem></varlistentry>
<varlistentry><term>DISABLEFINISH</term>
<listitem>
<para>
Displays a disabled Finish button
</para>
</listitem></varlistentry>
<varlistentry><term>FINISH</term>
<listitem>
<para>
Displays an enabled Finish button.
</para>
</listitem></varlistentry>
<varlistentry><term>NEXT</term>
<listitem>
<para>
Enables the Next button. If this keyword is missing, the Next button is displayed as disabled.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true if the property sheet dialog is a wizard, otherwise returns false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Wizards display either three or four buttons below each page. This method is used to specify which buttons are
enabled. Wizards normally display Back, Cancel, and either a Next or Finish button.
</para>
<para>
Typically, the application enables only the Next button for the welcome page, enables the Next and Back buttons for
the interior pages, and enables the Back and Finish buttons for the completion page. The Cancel button is always
enabled. Normally, setting FINISH or DISABLEDFINISH replaces the Next button with a Finish button. To changes this
to display both Next and Finish buttons simultaneously, set the WIZARDHASFINISH keyword in the options when the
<xref linkend="mthNewClsPropertySheetDialog"/> is instantiated. With that option, every
page will then display all four buttons.
</para>
<para>
If this property sheet is not a Wizard, this method has no effect.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows the <xref linkend="mthSetActive"/> event handler in one of the interior page
dialogs for a wizard property sheet dialog:
<programlisting>
<![CDATA[
::method setActive unguarded
use arg propSheet
propSheet~setWizButtons("BACK NEXT")
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::setWizButtons() -->
<section id="mthShowWizButtons" xreflabel="showWizButtons"><title>showWizButtons</title>
<indexterm><primary>showWizButtons</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>showWizButtons</secondary></indexterm>
<programlisting>
<![CDATA[
>>--showWizButtons(--+--------+--+----------------+--)----------><
+--opts--+ +-,-optsButtons--+
]]>
</programlisting>
<para>
Shows or hides buttons in an Aero wizard. <emphasis role="italic">Vista</emphasis> or later only. This method does
nothing if this property sheet is not an Aero wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>opts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant. These specify which
property sheet buttons are to be shown. If a button value is included in both this argument and <emphasis
role="italic">optsButton</emphasis> then it is shown.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BACK </member>
<member>CANCEL</member>
<member>FINISH</member>
<member>NEXT </member>
</simplelist>
<variablelist>
<varlistentry><term>BACK</term>
<listitem>
<para>
The Back button.
</para>
</listitem></varlistentry>
<varlistentry><term>CANCEL</term>
<listitem>
<para>
The Cancel button.
</para>
</listitem></varlistentry>
<varlistentry><term>FINISH</term>
<listitem>
<para>
The Finish button.
</para>
</listitem></varlistentry>
<varlistentry><term>NEXT</term>
<listitem>
<para>
The Next button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>opts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following keywords separated by spaces, case is not significant. these specify which
property sheet buttons are to be shown or hidden. If a button value appears in this parameter but not in dwFlag,
it indicates that the button should be hidden.
</para>
<para>
<simplelist type='vert' columns='3'>
<member>BACK </member>
<member>CANCEL</member>
<member>FINISH</member>
<member>NEXT </member>
</simplelist>
<variablelist>
<varlistentry><term>BACK</term>
<listitem>
<para>
The Back button.
</para>
</listitem></varlistentry>
<varlistentry><term>CANCEL</term>
<listitem>
<para>
The Cancel button.
</para>
</listitem></varlistentry>
<varlistentry><term>FINISH</term>
<listitem>
<para>
The Finish button.
</para>
</listitem></varlistentry>
<varlistentry><term>NEXT</term>
<listitem>
<para>
The Next button.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns true if this is an Aero Wizard property sheet on Vista on later, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The order of <emphasis role="italic">showWizButtons</emphasis> and
<xref linkend="mthSetWizButtons"/> is important. This works:
<programlisting>
<![CDATA[
propSheet~setWizButtons("NEXT")
propSheet~showWizButtons("NEXT", "BACK NEXT")
]]>
</programlisting>
This does not work:
<programlisting>
<![CDATA[
propSheet~showWizButtons("NEXT", "BACK NEXT")
propSheet~setWizButtons("NEXT")
]]>
</programlisting>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows the <xref linkend="mthSetActive"/> event handler for the first page in an Aero
wizard. It removes the Back button from the page, (since it is impossible to go back from the first page.)
<programlisting>
<![CDATA[
::method setActive
use arg propSheet
propSheet~setWizButtons("NEXT")
propSheet~showWizButtons("NEXT", "BACK NEXT")
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::showWizButtons() -->
<section id="mthUnchanged" xreflabel="unchanged"><title>unchanged</title>
<indexterm><primary>unchanged</primary></indexterm>
<indexterm><primary>PropertySheetDialog class</primary><secondary>unchanged</secondary></indexterm>
<programlisting>
<![CDATA[
>>--unchanged(--pspDlg--)------------------------><
]]>
</programlisting>
<para>
Informs this property sheet that information in a page has reverted to the previously saved state.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>pspDlg</term>
<listitem>
<para>
The Rexx property sheet page object whose data has been reverted.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Returns zero, always.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The property sheet disables the Apply Now button if no other pages have registered changes with the property sheet.
The MSDN documentation specifically states that this message does not apply to Aero wizards, it probably does
nothing in all wizards.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetDialog::unchanged() -->
</section>
<section id="sctPropertySheetPages"><title>Property Sheet Pages</title>
<indexterm><primary>Property Sheet Pages</primary></indexterm>
<para>
Each property sheet <xref linkend="clsPropertySheetDialog"/> must contain one or more property sheet
<emphasis role="italic">pages</emphasis>. To instantiate a <computeroutput>PropertySheetDialog</computeroutput> the
programmer passes in an array of one or more <computeroutput>PropertySheetPage</computeroutput> objects. In ooDialog
each property sheet page is represented by one of the concrete property sheet page dialogs that inherit from the
<computeroutput>PropertySheetPage</computeroutput> mixin class.
</para>
<para>
To create a page for a <computeroutput>PropertySheetDialog</computeroutput> the programmer defines a dialog subclass
using one of these three property sheet page dialogs:
<itemizedlist>
<listitem>
<para>
Subclass the <xref linkend="clsRcPSPDialog"/> when the page dialog template will be defined in
a resource <xref linkend="defResourceScript"/> file.
</para>
</listitem>
<listitem>
<para>
Subclass the <xref linkend="clsResPSPDialog"/> when the dialog <xref linkend="ovvDialogTemplate"/> will be loaded from a
compiled binary resource file.
</para>
</listitem>
<listitem>
<para>
Subclass the <xref linkend="clsUserPSPDialog"/> when the dialog template will be defined
using the <xref linkend="sctCreateMethods"/> methods.
</para>
</listitem>
</itemizedlist>
</para>
<para>
All property sheet page dialogs are managed more by the operating system than is typical for an ooDialog dialog. The
programmer does not <xref linkend="mthExecute"/> the page dialog to create the
<xref linkend="ovvUnderlying"/> Windows dialog, or stop the dialog. The operating system creates and
destroys the underlying page dialogs.
</para>
<para>
Each page has a corresponding icon and label. The underlying property sheet, that is the operating system, creates a
tab for each page and displays the icon and label in the tab. Note that this does not apply to wizards. The minimum
size for a property sheet page is 212 dialog units horizontally and 114 dialog units vertically. If a page dialog is
smaller than this, the operating system will enlarge the page until it meets the minimum size.
</para>
<para>
Microsoft has three recommended sizes for pages and notes that using these recommended sizes will help ensure visual
consistency between your application and other Microsoft Windows applications. The three sizes are basically <emphasis
role="italic">small</emphasis>, <emphasis role="italic">medium</emphasis>, and <emphasis
role="italic">large</emphasis>. The <emphasis role="italic">pageOpts</emphasis> argument to the <emphasis
role="italic">new</emphasis> method of each of the three types of property sheet page dialogs provides the SMALL,
MEDIUM, and LARGE keywords to automatically set the size of the property sheet page to one of the recommended sizes.
The <computeroutput>PropertySheetPage</computeroutput> class provides
<link linkend="tblPropertySheetPageMethods">constant</link>) values for the width and height of the three recommended sizes
for property sheet page dialogs.
</para>
<section id="clsPropertySheetPage" xreflabel="PropertySheetPage"><title>PropertySheetPage Class</title>
<indexterm><primary>Property Sheet Pages</primary><secondary>PropertySheetPage class</secondary></indexterm>
<indexterm><primary>PropertySheetPage class</primary></indexterm>
<para>
The <computeroutput>PropertySheetPage</computeroutput> class is a mixin class that contains the methods of a property
sheet page dialog object. Other than the individual <emphasis role="italic">new</emphasis> methods for each of the
three types of property sheet page dialogs, (Rc <xref linkend="mthNewClsRcPSPDialog"/>, Res <xref
linkend="mthNewClsResPSPDialog"/>, and User <xref linkend="mthNewClsUserPSPDialog"/>,) all page methods
come from the <computeroutput>PropertySheetPage</computeroutput> class. Of course, each property sheet page dialog has
all the methods of the <xref linkend="chpDialogObject"/> object and the methods of its parent class,
respectively the <xref linkend="clsRcDialog"/>, <xref linkend="clsResDialog"/>, or
<xref linkend="clsUserDialog"/>.
</para>
<section id="sctMethodsPropertySheetPage"><title>Method Table</title>
<para>
The following table provides links to the documentation for the primary methods and attributes used in working
with <computeroutput>PropertySheetPage</computeroutput> objects.
</para>
<table id="tblPropertySheetPageMethods" frame="all">
<title>PropertySheetPage Methods</title>
<tgroup cols="2">
<colspec colwidth="1*" />
<colspec colwidth="2*" />
<thead>
<row>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center"><emphasis role="bold">Constant Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry>PROP_SM_CXDLG</entry>
<entry>Width, in dialog units, of a small property sheet page. (Currently 212 dialog units.)</entry>
</row>
<row>
<entry>PROP_SM_CYDLG</entry>
<entry>Height, in dialog units, of a small property sheet page. (Currently 188 dialog units.)</entry>
</row>
<row>
<entry>PROP_MED_CXDLG</entry>
<entry>Width, in dialog units, of a medium property sheet page. (Currently 227 dialog units.)</entry>
</row>
<row>
<entry>PROP_MED_CYDLG</entry>
<entry>Height, in dialog units, of a medium property sheet page. (Currently 215 dialog units.)</entry>
</row>
<row>
<entry>PROP_LG_CXDLG</entry>
<entry>Width, in dialog units, of a large property sheet page. (Currently 252 dialog units.)</entry>
</row>
<row>
<entry>PROP_LG_CYDLG</entry>
<entry>Height, in dialog units, of a large property sheet page. (Currently 218 dialog units.)</entry>
</row>
<row>
<entry>PSNRET_NOERROR</entry>
<entry>A constant value that can be returned from a property sheet page event handler. The individual event handlers document the meaning of the PSNRET_xxx values for that handler.</entry>
</row>
<row>
<entry>PSNRET_INVALID</entry>
<entry>A constant value that can be returned from a property sheet page event handler. The individual event handlers document the meaning of the PSNRET_xxx values for that handler.</entry>
</row>
<row>
<entry>PSNRET_INVALID_NOCHANGEPAGE</entry>
<entry>A constant value that can be returned from a property sheet page event handler. The individual event handlers document the meaning of the PSNRET_xxx values for that handler.</entry>
</row>
<row>
<entry>PSNRET_MESSAGEHANDLED</entry>
<entry>A constant value that can be returned from a property sheet page event handler. The individual event handlers document the meaning of the PSNRET_xxx values for that handler.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Class Methods</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="clsRcPSPDialog"/> (RcPSPDialog)</entry>
<entry>Instantiates a new property sheet page whose dialog template is created from a resource <xref linkend="defResourceScript"/>.</entry>
</row>
<row>
<entry><xref linkend="clsResPSPDialog"/> (ResPSPDialog)</entry>
<entry>Instantiates a new property sheet page whose dialog <xref linkend="ovvDialogTemplate"/> comes from a compiled binary resource file.</entry>
</row>
<row>
<entry><xref linkend="clsUserPSPDialog"/> (UserPSPDialog)</entry>
<entry>Instantiates a new property sheet page whose dialog template is created using the <xref linkend="sctCreateMethods"/> methods of the <computeroutput>UserDialog</computeroutput> class.</entry>
</row>
<row>
<entry align="center"><emphasis role="bold">Attributes</emphasis></entry>
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
<entry><xref linkend="atrCX"/></entry>
<entry>Reflects the initial width of the property page dialog in dialog units.</entry>
</row>
<row>
<entry><xref linkend="atrCY"/></entry>
<entry>Reflects the initial height of the property page dialog in dialog units.</entry>
</row>
<row>
<entry><xref linkend="atrHeaderSubtitle"/></entry>
<entry>Reflects the text for the subtitle of a non-Aero wizard.</entry>
</row>
<row>
<entry><xref linkend="atrHeaderTitle"/></entry>
<entry>Reflects the text that will be displayed as the title in the header area of the page in a wizard.</entry>
</row>
<row>
<entry><xref linkend="atrPageID"/></entry>
<entry>Reflects the value of the page ID, which identifies the page to the <xref linkend="ovvUnderlying"/> property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="atrPageNumber"/></entry>
<entry>Reflects the page number, or index, of this property sheet page.</entry>
</row>
<row>
<entry><xref linkend="atrPageTitle"/></entry>
<entry>Reflects the title to use for this property sheet page.</entry>
</row>
<row>
<entry><xref linkend="atrPropSheet"/></entry>
<entry>Reflects the Rexx <xref linkend="clsPropertySheetDialog"/> object that this page belongs to.</entry>
</row>
<row>
<entry><xref linkend="atrResourcesClsPSP"/></entry>
<entry>The <emphasis role="italic">resources</emphasis> attribute is set to a <xref linkend="clsResourceImage"/> object containing resources used by this property sheet page.</entry>
</row>
<row>
<entry><xref linkend="atrTabIcon"/></entry>
<entry>Reflects the icon to use as the icon in the tab of this property sheet page.</entry>
</row>
<row>
<entry><xref linkend="atrWasActivatedClsPSP"/></entry>
<entry>Reflects whether the <xref linkend="ovvUnderlying"/> property sheet page was created.</entry>
</row>
<row>
<entry><xref linkend="atrWantAccelerators"/></entry>
<entry>The value of this attribute determines if this page should receive the TRANSLATEACCELERATOR event notification.</entry>
</row>
<row>
<entry><xref linkend="atrWantGetObject"/></entry>
<entry>The value of this attribute determines if this page should receive the GETOBJECT event notification message.</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="mthApplyClsPSP"/></entry>
<entry>Notifies every page in the property sheet that the user has clicked the OK, Close, or Apply button and wants all changes to take effect.</entry>
</row>
<row>
<entry><xref linkend="mthGetObject"/></entry>
<entry>Sent by a property sheet dialog to request a drop target object when the cursor passes over one of the tab control's buttons.</entry>
</row>
<row>
<entry><xref linkend="mthHelpClsPSP"/></entry>
<entry>Notifies a page that the user has clicked the Help button.</entry>
</row>
<row>
<entry><xref linkend="mthKillActive"/></entry>
<entry>Notifies a page that it is about to lose activation either because another page is being activated or the user has clicked the OK button.</entry>
</row>
<row>
<entry><xref linkend="mthPageCreate"/></entry>
<entry>Notifies the Rexx page dialog that the <xref linkend="ovvUnderlying"/> page dialog is about to be created.</entry>
</row>
<row>
<entry><xref linkend="mthQueryCancel"/></entry>
<entry>Notifies a property sheet page that the user has canceled the property sheet dialog.</entry>
</row>
<row>
<entry><xref linkend="mthQueryFromSibling"/></entry>
<entry>Notifies the page of a <xref linkend="mthQuerySiblings"/>messge.</entry>
</row>
<row>
<entry><xref linkend="mthQueryInitialFocus"/></entry>
<entry>Provides a property sheet page an opportunity to specify which dialog box control should receive the initial focus.</entry>
</row>
<row>
<entry><xref linkend="mthReset"/></entry>
<entry>Notifies a page that the property sheet is about to be destroyed.</entry>
</row>
<row>
<entry><xref linkend="mthSetActive"/></entry>
<entry>Notifies a page that it is about to be activated.</entry>
</row>
<row>
<entry><xref linkend="mthSetSizeClsPSP"/></entry>
<entry>Used to set both the <xref linkend="atrCX"/> and <xref linkend="atrCY"/> attributes at one time.</entry>
</row>
<row>
<entry><xref linkend="mthTranslateAccelerator"/></entry>
<entry>Notifies a property sheet page that a keyboard message has been received. It provides the page an opportunity to do private keyboard accelerator translation.</entry>
</row>
<row>
<entry><xref linkend="mthWizBack"/></entry>
<entry>Notifies a page that the user has clicked the Back button in a wizard.</entry>
</row>
<row>
<entry><xref linkend="mthWizFinish"/></entry>
<entry>Notifies a page that the user has clicked the Finish button in a wizard.</entry>
</row>
<row>
<entry><xref linkend="mthWizNext"/></entry>
<entry>Notifies a page that the user has clicked the Next button in a wizard.</entry>
</row>
<row>
<entry><xref linkend="mthValidateClsPSP"/></entry>
<entry>Provides a place to validate the data entered by the user in a page during the <emphasis role="italic">apply</emphasis> notification.</entry>
</row>
<row>
<entry><xref linkend="mthValidatePage"/></entry>
<entry>Provides a place to validate the data entered by the user in a page during the <emphasis role="italic">killActive</emphasis> notification</entry>
</row>
</tbody></tgroup>
</table>
</section>
<section id="sctPageEventHandlers"><title>Page Event Handlers</title>
<indexterm><primary>event notification</primary><secondary>property sheet page event handlers</secondary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>event handlers</secondary></indexterm>
<para>
The process for connecting <xref linkend="ovvEvents"/> handlers for the property sheet page
dialogs takes a slightly different approach than that of other dialog classes in the ooDialog framework. The property
sheet page class provides a default event handler for all property sheet page specifc events.
</para>
<para>
Rather than connecting a property sheet page event to a specified method in the Rexx dialog, the programmer over-rides
the default handler in the dialog. This is similiar to how the <xref linkend="mthOk"/> and
<xref linkend="mthCancel"/> events are handled in the <xref linkend="chpDialogObject"/> object.
</para>
<para>
In the property sheet page dialogs, most of the methods are actually default event handlers. To act on an event in a
manner different from the default, the programmer over-rides the default handler and provides an implementation that
handles the event as needed by the application. For example, to remove the back button from the first page of an
Aero wizard, the programmer would over-ride the <xref linkend="mthSetActive"/> method in the page
dialog for the first page of the property sheet dialog. In the new implementation code for <emphasis
role="italic">setActive</emphasis>, the programmer would invoke the
<xref linkend="mthShowWizButtons"/> method of the property sheet dialog and specify that the Back button
was hidden. This same general technique is used for all property sheet page events.
</para>
</section> <!-- End Page Event Handlers -->
<section id="atrCX" xreflabel="cx"><title>cx (Attribute)</title>
<indexterm><primary>cx</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>cx</secondary></indexterm>
<programlisting>
<![CDATA[
>>--cx-------------------------------------------><
>>--cx-=-width-----------------------------------><
]]>
</programlisting>
<para>
Reflects the initial width of the property page dialog in dialog units.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">cx get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">cx</emphasis> attribute is the width, in dialog
<xref linkend="defDialogUnit"/>s, of the page dialog.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">cx set:</emphasis></term>
<listitem>
<para>
When the page dialog is first instantiated, <emphasis role="italic">cx</emphasis> is set to one of the 3 recommended
page widths though the use of the SMALL, MEDIUM, or LARGE keywords of the <emphasis
role="italic">pageOpts</emphasis> argument to the <emphasis role="italic">new</emphasis> method of the page dialog.
Since the MEDIUM keyword is the default if the SMALL or LARGE keywords are not used, <emphasis
role="italic">cx</emphasis> is always set to a value. The programmer can reset the <emphasis
role="italic">cx</emphasis> value if desired.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Setting <emphasis role="italic">cx</emphasis> is really only of use for a
<xref linkend="clsUserPSPDialog"/>. And, indeed, for a <computeroutput>UserPSPDialog</computeroutput>
the programmer must set this attribute to obtain a dialog with a different width than one of the 3 recommended
widths. With a <xref linkend="clsRcPSPDialog"/>, <emphasis role="italic">cx</emphasis> is
over-written with the value in the resource script, and for a <xref linkend="clsResPSPDialog"/>,
the width is determined when the resource is compiled and can not changed.
</para>
<para>
With a <computeroutput>UserPSPDialog</computeroutput>, the underlying page dialog is created with the width
specified by the <emphasis role="italic">cx</emphasis> attribute. So, to have a different width than one of the
recommended widths, the programmer must set this attribute before the dialog template is created. Note that the
<xref linkend="mthSetSizeClsPSP"/> method can be used to set both the <emphasis
role="italic">cx</emphasis> and <xref linkend="atrCY"/> attributes at one time.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows an <computeroutput>UserPSPDialog</computeroutput> being instantiated for use as one of the pages
of a <xref linkend="clsPropertySheetDialog"/> sheet dialog. The size of the page dialog is set using
the <emphasis role="italic">cx</emphasis> and <emphasis role="italic">cy</emphasis> attributes;
<programlisting>
<![CDATA[
p3 = .DaysDlg~new( , , "", "Days" )
p3~cx = 267
p3~cy = 143
p3~headerTitle = "Choose a day to watch the movie(s)."
p3~headerSubtitle = "Use the drop down list to switch movies. Pick the day most suitable for the movie."
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::cx() [attribute] -->
<section id="atrCY" xreflabel="cy"><title>cy (Attribute)</title>
<indexterm><primary>cy</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>cy</secondary></indexterm>
<programlisting>
<![CDATA[
>>--cy-------------------------------------------><
>>--cy-=-height----------------------------------><
]]>
</programlisting>
<para>
Reflects the initial height of the property page dialog in dialog units.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">cy get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">cy</emphasis> attribute is the height, in dialog
<xref linkend="defDialogUnit"/>s, of the page dialog.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">cy set:</emphasis></term>
<listitem>
<para>
When the page dialog is first instantiated, <emphasis role="italic">cy</emphasis> is set to one of the 3 recommended
page heights though the use of the SMALL, MEDIUM, or LARGE keywords of the <emphasis
role="italic">pageOpts</emphasis> argument to the <emphasis role="italic">new</emphasis> method of the page dialog.
Since the MEDIUM keyword is the default if the SMALL or LARGE keywords are not used, <emphasis
role="italic">cy</emphasis> is always set to a value. The programmer can reset the <emphasis
role="italic">cy</emphasis> value if desired.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Setting <emphasis role="italic">cy</emphasis> is really only of use for a
<xref linkend="clsUserPSPDialog"/>. And, indeed, for a <computeroutput>UserPSPDialog</computeroutput>
the programmer must set this attribute to obtain a dialog with a different height than one of the 3 recommended
heights. With a <xref linkend="clsRcPSPDialog"/>, <emphasis role="italic">cy</emphasis> is
over-written with the value in the resource script, and for a <xref linkend="clsResPSPDialog"/>,
the height is determined when the resource is compiled and can not changed.
</para>
<para>
With a <computeroutput>UserPSPDialog</computeroutput>, the underlying page dialog is created with the height
specified by the <emphasis role="italic">cy</emphasis> attribute. So, to have a different height than one of the
recommended heights, the programmer must set this attribute before the dialog template is created. Note that the
<xref linkend="mthSetSizeClsPSP"/> method can be used to set both the <emphasis
role="italic">cy</emphasis> and <xref linkend="atrCX"/> attributes at one time.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows an <computeroutput>UserPSPDialog</computeroutput> being instantiated for use as one of the pages
of a <xref linkend="clsPropertySheetDialog"/> sheet dialog. The size of the page dialog is set using
the <emphasis role="italic">cx</emphasis> and <emphasis role="italic">cy</emphasis> attributes;
<programlisting>
<![CDATA[
p3 = .DaysDlg~new( , , "", "Days" )
p3~cx = 267
p3~cy = 143
p3~headerTitle = "Choose a day to watch the movie(s)."
p3~headerSubtitle = "Use the drop down list to switch movies. Pick the day most suitable for the movie."
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::cy() [attribute] -->
<section id="atrHeaderSubtitle" xreflabel="headerSubtitle"><title>headerSubtitle (Attribute)</title>
<indexterm><primary>headerSubtitle</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>headerSubtitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--headerSubtitle-------------------------------><
>>--headerSubtitle-=-text------------------------><
]]>
</programlisting>
<para>
Reflects the text for the subtitle of a non-Aero wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">headerSubtitle get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">headerSubtitle</emphasis> attribute is the text a wizard property sheet
page will use for the subtitle text in the header area of a wizard. If the programmer has not assigned a value to
this attribute, its value is the <computeroutput>.nil</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">headerSubtitle set:</emphasis></term>
<listitem>
<para>
To display text for the subtitle in a wizard dialog page, the programmer can set the <emphasis
role="italic">headerSubtitle</emphasis> attribute to the text to be displayed. This text is used when the underlying
page is first created. Setting the attribute after the page has been created has no effect. Likewise, setting this
attribute to any text has no effect if the page is not in a wizard dialog. Aero-style wizards do not use subtitle
text.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
For non-aero wizards, the subtitle text can also be set dynamically by using the
<xref linkend="mthSetHeaderSubTitle"/> method of the
<xref linkend="clsPropertySheetDialog"/>. For instance, setting the subtitle text could be done
in the <xref linkend="mthSetActive"/> event handler when the page is about to become active but
before it is actually shown on the screen.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::headerSubtitle() [attribute] -->
<section id="atrHeaderTitle" xreflabel="headerTitle"><title>headerTitle (Attribute)</title>
<indexterm><primary>headerTitle</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>headerTitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--headerTitle----------------------------------><
>>--headerTitle-=-text---------------------------><
]]>
</programlisting>
<para>
Reflects the text that will be displayed as the title in the header area of the page in a wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">headerTitle get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">headerTitle</emphasis> attribute is the text a wizard property sheet page
will use for the title text in the header area of a wizard. If the programmer has not assigned a value to this
attribute, its value is the <computeroutput>.nil</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">headerTitle set:</emphasis></term>
<listitem>
<para>
To display text for the header title in a wizard dialog page, the programmer can set the <emphasis
role="italic">headerTitle</emphasis> attribute to the text to be displayed. This text is used when the underlying
page is first created. Setting the attribute after the page has been created has no effect. Likewise, setting this
attribute to any text has no effect if the the page is a page in a non-wizard dialog.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
For non-aero wizards, the header title text can also be set dynamically by using the
<xref linkend="mthSetHeaderTitle"/> method of the
<xref linkend="clsPropertySheetDialog"/>. For instance, setting the title text could be done in
the <xref linkend="mthSetActive"/> event handler when the page is about to become active but before
it is actually shown on the screen.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::headerTitle() [attribute] -->
<section id="atrPageID" xreflabel="pageID"><title>pageID (Attribute)</title>
<indexterm><primary>pageID</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>pageID</secondary></indexterm>
<programlisting>
<![CDATA[
>>--pageID---------------------------------------><
>>--pageID-=-val---------------------------------><
]]>
</programlisting>
<para>
Reflects the value of the page ID, which identifies the page to the <xref linkend="ovvUnderlying"/>
property sheet dialog. The ID is essentially an opaque value to the Rexx programmer.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">pageID get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">pageID</emphasis> attribute is a value that uniquely identifies this page
to the underlying property sheet dialog that this page belongs to. In Rexx, the value is a
<computeroutput>Pointer</computeroutput> object. The value of the <computeroutput>Pointer</computeroutput> has no
meaning to the programmer.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">pageID set:</emphasis></term>
<listitem>
<para>
The Rexx programmer can not set this value it is set internally by the ooDialog framework.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Note that the page <emphasis role="italic">ID</emphasis> is different than the page <emphasis
role="italic">index</emphasis>. The <emphasis role="italic">index</emphasis> is the page number of the page, page 1,
page 2, etc.. A page ID can be returned from several of the page event handlers, such as
<xref linkend="mthSetActive"/>, <xref linkend="mthWizBack"/>, and
<xref linkend="mthWizNext"/> to direct the property sheet dialog to display the page with that ID. The
<xref linkend="mthIndexToID"/> method of the
<xref linkend="clsPropertySheetDialog"/> class can be used to translate the page number to that
page's ID.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::pageID() [attribute] -->
<section id="atrPageNumber" xreflabel="pageNumber"><title>pageNumber (Attribute)</title>
<indexterm><primary>pageNumber</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>pageNumber</secondary></indexterm>
<programlisting>
<![CDATA[
>>--pageNumber-----------------------------------><
>>--pageNumber-=-val-----------------------------><
]]>
</programlisting>
<para>
Reflects the page number, or index, of this property sheet page.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">pageNumber get:</emphasis></term>
<listitem>
<para>
The property sheet page numbers are one-based and the <emphasis role="italic">pageNumber</emphasis> attribute is the
current page number in the property sheet dialog for this property sheet page.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">pageNumber set:</emphasis></term>
<listitem>
<para>
The programmer can not set the <emphasis role="italic">pageNumber</emphasis> attribute, it is set correctly by the
ooDialog framework.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::pageNumber() [attribute] -->
<section id="atrPageTitle" xreflabel="pageTitle"><title>pageTitle (Attribute)</title>
<indexterm><primary>pageTitle</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>pageTitle</secondary></indexterm>
<programlisting>
<![CDATA[
>>--pageTitle------------------------------------><
>>--pageTitle-=-text-----------------------------><
]]>
</programlisting>
<para>
Reflects the title to use for this property sheet page.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">pageTitle get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">pageTitle</emphasis> attribute is the text used for the label of the tab
for this property sheet page. If the programmer has not assigned a value to this attribute, its value is the
<computeroutput>.nil</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">pageTitle set:</emphasis></term>
<listitem>
<para>
The programmer can set the <emphasis role="italic">pageTitle</emphasis> attribute to the text to be used for the
label of the tab in a property sheet dialog for this page. This text is used when the underlying page is first
created. Setting the attribute after the page has been created has no effect.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Normally, the property sheet dialog sets the title of a property sheet page to the caption in the dialog template
for the page. The title of a property sheet page is used as the label of the tab for that page. If the dialog
template does not have a caption for the dialog, or if the programmer wants a label different from the caption in
the dialog template, then the <emphasis role="italic">pageTitle</emphasis> attribute should be set to the desired
label for the tab.
</para>
<para>
In addition to setting the <emphasis role="italic">pageTtle</emphasis> attribute, the USETITLE keyword needs to be
included in the <emphasis role="italic">pageOpts</emphasis> argument to the <emphasis role="italic">new</emphasis>
method of the page. However, in general, the ooDialog framework will set the keyword correctly if / when the
<emphasis role="italic">pageTitle</emphasis> attrbiute is set, and the Rexx programmer does not need to worry about
it. There is one <emphasis role="italic">exception</emphasis> to this. For the
<xref linkend="clsRcPSPDialog"/> page object, the title for the page will be overwritten when the
resource script is parsed. To prevent this, for <computeroutput>RcPSPDialog</computeroutput> pages, the USETITLE
keyword must be used in the <link linkend="argPageOptsClsRcPSPDialog">pageOpts</link> argument.
</para>
<para>
In a <xref linkend="clsUserPSPDialog"/>, the <emphasis role="italic">pageTitle</emphasis>
attribute can also be set by using the <link linkend="argTitleClsUserPSPDialog">title</link> argument in the <emphasis
role="italic">new</emphasis> method of the class.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example uses the dialog caption as set in the resource script file for the labels of the tabs, except for page
5. For page 5 the label is changed to <emphasis role="italic">ooRexx Tab Control</emphasis> by setting the <emphasis
role="italic">pageTitle</emphasis> attribute. Notice the use of the USETITLE keyword in the <emphasis
role="italic">pageOpts</emphasis> argument to the <emphasis role="italic">new</emphasis> method for page 5:
<programlisting>
<![CDATA[
-- Create the 5 dialog pages.
p1 = .ListViewDlg~new("rc\PropertySheetDemo.rc", IDD_LISTVIEW_DLG)
p2 = .TreeViewDlg~new("rc\PropertySheetDemo.rc", IDD_TREEVIEW_DLG)
p3 = .ProgressBarDlg~new("rc\PropertySheetDemo.rc", IDD_PROGRESSBAR_DLG)
p4 = .TrackBarDlg~new("rc\PropertySheetDemo.rc", IDD_TRACKBAR_DLG)
p5 = .TabDlg~new("rc\PropertySheetDemo.rc", IDD_TAB_DLG, , , "USETITLE")
p5~pageTitle = "ooRexx Tab Control"
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::pageTitle() [attribute] -->
<section id="atrPropSheet" xreflabel="propSheet"><title>propSheet (Attribute)</title>
<indexterm><primary>propSheet</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>propSheet</secondary></indexterm>
<programlisting>
<![CDATA[
>>--propSheet------------------------------------><
>>--propSheet-=-propSheetObj---------------------><
]]>
</programlisting>
<para>
Reflects the Rexx <xref linkend="clsPropertySheetDialog"/> object that this page belongs to.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">propSheet get:</emphasis></term>
<listitem>
<para>
Returns the Rexx property sheet dialog that owns this property sheet page.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">propSheet set:</emphasis></term>
<listitem>
<para>
The Rexx programmer can not set the value of this attribute. It is set internally by the ooDialog framework.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
One of the arguments sent to the event handler methods of a property sheet page is the Rexx property sheet dialog
object. That object sent as an argument and the <emphasis role="italic">propSheet</emphasis> attribute are the same
Rexx object. Within an event handler the programmer can use either object to access the property sheet dialog,
whichever seems more convenient.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example uses the <emphasis role="italic">propSheet</emphasis> attribute to invoke the
<xref linkend="mthQuerySiblings"/> method of the property sheet dialog that owns the page:
<programlisting>
<![CDATA[
::method initDialog
expose filmArray movieTheaters selectedMovies movieCombo
filmArray = .array~new(20)
self~propSheet~querySiblings(filmArray, "FILMS")
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::propSheet() [attribute] -->
<section id="atrResourcesClsPSP" xreflabel="resources"><title>resources (Attribute)</title>
<indexterm><primary>resources</primary><secondary>PropertySheetPage class</secondary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>resources</secondary></indexterm>
<programlisting>
<![CDATA[
>>--resources------------------------------------><
>>--resources-=-image----------------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">resources</emphasis> attribute is set to a
<xref linkend="clsResourceImage"/> object containing resources used by this property sheet page.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">resources get:</emphasis></term>
<listitem>
<para>
Returns the <computeroutput>ResourceImage</computeroutput> object if this attribute has been set by the programmer
or the <computeroutput>.nil</computeroutput> object if the attrbute has not been set.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">resources set:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">resources</emphasis> attribute is set to the source of some resources used by the
property sheet page dialog. The object assigned to the <emphasis role="italic">resources</emphasis> attribute must
be a <xref linkend="clsResourceImage"/> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Resources used by a page dialog can be taken from a compiled binary executable module. In Windows, executable
modules are <computeroutput>*.exe</computeroutput> and <computeroutput>*.dll</computeroutput> files. In the ooDialog
framework, access to a compiled binary module is provided by the
<xref linkend="clsResourceImage"/> class.
</para>
<para>
Typically, the resources used by the property sheet page would include the tab icon and the strings used for the
header title, header subtile, page title, etc.. However, the current implementation does not yet support retrieving
string resources from a <computeroutput>ResourceImage</computeroutput>. Therefore, at this point, it is really only
the tab icon for this page that would be contained in the <emphasis role="italic">resources</emphasis> attribute.
Future versions of ooDialog will likely be enhanced to work with string resources in a resource image.
</para>
<para>
To supply the tab icon for this page from a resource image, the programmer would set the <emphasis
role="italic">resources</emphasis> attribute to a resource image containing the icon and set the
<xref linkend="atrTabIcon"/> attribute to the resource ID of the icon in the resource image.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example creates a resource image from the <computeroutput>ooDialog.dll</computeroutput> file which has 4 icon
images within the DLL. It assigns the resource image to the <emphasis role="italic">resources</emphasis> attribute
so that it can use the icon images as the icons for the tabs of the pages:
<programlisting>
<![CDATA[
p1 = .ListViewDlg~new("rc\PropertySheetDemo.rc", IDD_LISTVIEW_DLG)
p2 = .TreeViewDlg~new("rc\PropertySheetDemo.rc", IDD_TREEVIEW_DLG)
p3 = .ProgressBarDlg~new("rc\PropertySheetDemo.rc", IDD_PROGRESSBAR_DLG)
p4 = .TrackBarDlg~new("rc\PropertySheetDemo.rc", IDD_TRACKBAR_DLG)
resourceImage = .ResourceImage~new("oodialog.dll", p1)
p1~resources = resourceImage
p1~tabIcon = IDI_DLG_OODIALOG
p2~resources = resourceImage
p2~tabIcon = IDI_DLG_APPICON
p3~resources = resourceImage
p3~tabIcon = IDI_DLG_APPICON2
p4~resources = resourceImage
p4~tabIcon = IDI_DLG_OOREXX
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::resources() [attribute] -->
<section id="atrTabIcon" xreflabel="tabIcon"><title>tabIcon (Attribute)</title>
<indexterm><primary>tabIcon</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>tabIcon</secondary></indexterm>
<programlisting>
<![CDATA[
>>--tabIcon--------------------------------------><
>>--tabIcon-=-icon-------------------------------><
]]>
</programlisting>
<para>
Reflects the icon to use as the icon in the tab of this property sheet page.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">tabIcon get:</emphasis></term>
<listitem>
<para>
The value of the <emphasis role="italic">tabIcon</emphasis> attribute if the programmer has set that value.
Otherwise, the value is the <computeroutput>.nil</computeroutput> object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">tabIcon set:</emphasis></term>
<listitem>
<para>
This attribute can either be set to a stand alone icon <xref linkend="clsImage"/> object or to the
resource ID of the icon if the icon image is contained in a compiled resource file. If the attribute is set to a
resource ID, then the <xref linkend="atrResourcesClsPSP"/> attribute must be set to a
<xref linkend="clsResourceImage"/> object that contains the icon image. If the attribute is set to an
<computeroutput>Image</computeroutput> object, the the image has to be an actual icon image. It can not be a bitmap
or cursor.
</para>
<para>
When a resource ID is used it may be numeric or <xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The tab icons for all pages in a <xref linkend="clsPropertySheetDialog"/> sheet dialog can also be set
through the <xref linkend="atrImageList"/> attribute. If both the <emphasis
role="italic">imageList</emphasis> attribute and the <emphasis role="italic">tabIcon</emphasis> attribute are set,
the icon for the tab is taken from the <emphasis role="italic">imageList</emphasis> attribute.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example creates a resource image from the ooDialog.dll file which has 4 icon images within the resource section
of the DLL. It then assigns an icon from the resource image to the <emphasis role="italic">tabIcon</emphasis>
attribute of each page dialog:
<programlisting>
<![CDATA[
p1 = .ListViewDlg~new("rc\PropertySheetDemo.rc", IDD_LISTVIEW_DLG)
p2 = .TreeViewDlg~new("rc\PropertySheetDemo.rc", IDD_TREEVIEW_DLG)
p3 = .ProgressBarDlg~new("rc\PropertySheetDemo.rc", IDD_PROGRESSBAR_DLG)
p4 = .TrackBarDlg~new("rc\PropertySheetDemo.rc", IDD_TRACKBAR_DLG)
resourceImage = .ResourceImage~new("oodialog.dll", p1)
p1~resources = resourceImage
p1~tabIcon = IDI_DLG_OODIALOG
p2~resources = resourceImage
p2~tabIcon = IDI_DLG_APPICON
p3~resources = resourceImage
p3~tabIcon = IDI_DLG_APPICON2
p4~resources = resourceImage
p4~tabIcon = IDI_DLG_OOREXX
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::tabIcon() [attribute] -->
<section id="atrWasActivatedClsPSP" xreflabel="wasActivated"><title>wasActivated (Attribute)</title>
<indexterm><primary>wasActivated</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>wasActivated</secondary></indexterm>
<programlisting>
<![CDATA[
>>--wasActivated---------------------------------><
>>--wasActivated-=-trueFalse---------------------><
]]>
</programlisting>
<para>
Reflects whether the <xref linkend="ovvUnderlying"/> property sheet page was created.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">wasActivated get:</emphasis></term>
<listitem>
<para>
The value of this attribute is true if the underlying page was created, otherwise it is false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">wasActivated set:</emphasis></term>
<listitem>
<para>
The programmer can not set the value of this attribute, it is set internally by the ooDialog framework.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The property <xref linkend="clsPropertySheetDialog"/> dialog creates the property sheet page dialogs as
they are needed, usually not until the page is visited. This attribute allows the Rexx programmer to determine
whether or not the underlying dialog was ever created.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::wasActivated() [attribute] -->
<section id="atrWantAccelerators" xreflabel="wantAccelerators"><title>wantAccelerators (Attribute)</title>
<indexterm><primary>wantAccelerators</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>wantAccelerators</secondary></indexterm>
<programlisting>
<![CDATA[
>>--wantAccelerators-----------------------------><
>>--wantAccelerators-=-trueFalse-----------------><
]]>
</programlisting>
<para>
The value of this attribute determines if this page should receive the TRANSLATEACCELERATOR event notification. The
notification is passed on to the page dialog by invoking its
<xref linkend="mthTranslateAccelerator"/> method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">wantAccelerators get:</emphasis></term>
<listitem>
<para>
If the <emphasis role="italic">wantAccelerators</emphasis> attrbiute is true, the
<xref linkend="mthTranslateAccelerator"/> method will be invoked for each TRANSLATEACCELERATOR
event notification. By default this attribute is false and TRANSLATEACCELERATOR notifications are ignored.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">wantAccelerators set:</emphasis></term>
<listitem>
<para>
By default, the ooDialog framework sets the <emphasis role="italic">wantAccelerators</emphasis> attribute to false.
If the programmer wants to process the TRANSLATEACCELERATOR notification then this attribute value can be set to
true.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Setting the <emphasis role="italic">wantAccelerators</emphasis> attribute to true won't by itself give the
programmer notification of the translate accelerator event because the default
<xref linkend="mthTranslateAccelerator"/> event handler just returns 0. The programmer must also
over-ride the <emphasis role="italic">translateAcclerator</emphasis> method in her subclass and process the
notification in the over-ride.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::wantAccelerators() [attribute] -->
<section id="atrWantGetObject" xreflabel="wantGetObject"><title>wantGetObject (Attribute)</title>
<indexterm><primary>wantGetObject</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>wantGetObject</secondary></indexterm>
<programlisting>
<![CDATA[
>>--wantGetObject--------------------------------><
>>--wantGetObject=trueFalse----------------------><
]]>
</programlisting>
<para>
The value of this attribute determines if this page should receive the GETOBJECT event notification message.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">wantGetObject get:</emphasis></term>
<listitem>
<para>
Returns the value of the <emphasis role="italic">wantGetObject</emphasis> attribute. By default the value is false.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">wantGetObject set:</emphasis></term>
<listitem>
<para>
Set the value of <emphasis role="italic">wantGetObject</emphasis> to true to have the GETOBJECT event notification
passed on to this page.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This attribute and the <xref linkend="mthGetObject"/> event handler are provided for completeness.
The ooDialog framework does not currently have a way to allow the programmer to handle the get object event. The
<emphasis role="italic">wantGetObject</emphasis> attribute is set to false by default. Changing it to true will not
be of any use int the current ooDialog implementation.. Future versions of ooDialog may be enhanced to take
advantage of this attribute.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::wantGetObject() [attribute] -->
<section id="mthApplyClsPSP" xreflabel="apply"><title>apply</title>
<indexterm><primary>apply</primary><secondary>PropertySheetPage class</secondary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>apply</secondary></indexterm>
<programlisting>
<![CDATA[
>>--apply(--isOkBtn-,-pageNum-,-rexxPage-,-propSheet--)---------><
]]>
</programlisting>
<para>
Notifies every page in the property sheet that the user has clicked the OK, Close, or Apply button and wants all
changes to take effect.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>isOkBtn</term>
<listitem>
<para>
This argument is true if the user clicked the OK button. It is also set to true if the
<xref linkend="mthCancelToClose"/> method had inovked on the propertery sheet and the user clicked
the Close button. It is set to false if the user clicked the Apply button.
</para>
</listitem></varlistentry>
<varlistentry><term>pageNum</term>
<listitem>
<para>
This argument is set to the page number of the page that had the focus when the user clicked the button.
</para>
</listitem></varlistentry>
<varlistentry><term>rexxPage</term>
<listitem>
<para>
This argument is set to the Rexx property sheet page object that had the focuse when the user clicked the
button.
</para>
</listitem></varlistentry>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
One of the following values must be returned:
<variablelist>
<varlistentry><term>PSNRET_NOERROR</term>
<listitem>
<para>
Return the PSNRET_NOERROR <link linkend="tblPropertySheetPageMethods">constant</link>) to indicate that the
changes made to this page are valid and have been applied. If all pages return PSNRET_NOERROR, the property sheet
dialog can be destroyed.
</para>
</listitem></varlistentry>
<varlistentry><term>PSNRET_INVALID</term>
<listitem>
<para>
Return the PSNRET_INVALID <link linkend="tblPropertySheetPageMethods">constant</link>) to prevent the property
sheet dialog from being destroyed. The focus will be returned to this page.
</para>
</listitem></varlistentry>
<varlistentry><term>PSNRET_INVALID_NOCHANGEPAGE</term>
<listitem>
<para>
Return the PSNRET_INVALID_NOCHANGEPAGE <link linkend="tblPropertySheetPageMethods">constant</link>) to prevent the
property sheet dialog from being destroyed. The focus will be returned to the page that had the focus when the
button was pressed.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The default <emphasis role="italic">apply</emphasis> implementation returns PSNRET_NOERROR. When over-riding this
method the programmer must return one of the three listed return values.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Over-riding apply():</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">apply</emphasis> event handler can be over-ridden by the Rexx programmer, but there are
a few additional details the programmer needs to be aware of. First, the default implementation simply calls the
<xref linkend="mthValidateClsPSP"/> method and returns the value that <emphasis
role="italic">validate</emphasis> returns. Because of that, an appropriate strategy would be to over-ride <emphasis
role="italic">validate</emphasis> and leave the default implementation of <emphasis role="italic">apply</emphasis>
as is.
</para>
<para>
Second, when the return from <emphasis role="italic">apply</emphasis> is to be PSNRET_NOERROR, the programmer should
always invoke the private <xref linkend="mthApplyNoError"/> method as the last step. Failure to
invoke <emphasis role="italic">applyNoError</emphasis> will likely introduce inconsistencies in the behaviour of the
page dialog as compared to the behaviour of other ooDialog dialogs.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::apply() -->
<section id="mthApplyNoError" xreflabel="applyNoError"><title>applyNoError</title>
<programlisting>
<![CDATA[
>>--applyNoError(--propSheet--)------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">applyNoError</emphasis> method is a <emphasis role="bold">private</emphasis> method that
is used by the ooDialog framework to keep the property sheet page dialogs behaviour consistent with the behaviour of
other ooDialog dialogs. It is intended to be <emphasis role="italic">invoked</emphasis> by the Rexx programmer, but
<emphasis role="bold">not</emphasis> over-ridden by the programmer.
</para>
<para>
The <emphasis role="italic">applyNoError</emphasis> should only be invoked from the
<xref linkend="mthApplyClsPSP"/> method as the last step when PSN_NOERROR is going to be returned from <emphasis
role="italic">apply</emphasis>. If the <emphasis role="italic">apply</emphasis> event handler is over-ridden by the
programmer, the <emphasis role="italic">applyNoError</emphasis> methods should <emphasis
role="italic">always</emphasis> be invoked as the final step when the return from <emphasis
role="italic">apply</emphasis> will be PSN_NOERROR and it should <emphasis role="italic">never</emphasis> be invoked
when the return is to be PSNRET_INVALID or PSNRET_PSNRET_INVALID_NOCHANGEPAGE.
</para>
<para>
The first and only argument to <emphasis role="italic">applyNoError</emphasis> should be the same <emphasis
role="italic">propSheet</emphasis> argument that is passed to <xref linkend="mthApplyClsPSP"/>. The return
from <emphasis role="italic">applyNoError</emphasis> is always PSNRET_NOERROR. The typical over-ride of the <emphasis
role="italic">apply</emphasis> method would always look similar to this:
<programlisting>
<![CDATA[
::method apply unguarded
use arg isOkBtn, pageNum, rexxPage, propSheet
...
-- Do all validation
...
-- okay, everything is correct, return PSNRET_NOERROR
return self~applyNoError(propSheet)
]]>
</programlisting>
</para>
</section> <!-- End PropertySheetPage::applyNoError() -->
<section id="mthGetObject" xreflabel="getObject"><title>getObject</title>
<indexterm><primary>getObject</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>getObject</secondary></indexterm>
<programlisting>
<![CDATA[
>>--getObject(--propSheet--)---------------------><
]]>
</programlisting>
<para>
Sent by a property sheet dialog to request a drop target object when the cursor passes over one of the tab control's
buttons. This event handler is provided for completeness. The method is currently a no-op. The ooDialog framework
currently has no way for the programmer to respond to this notification. Future versions of ooDialog may be enhanced
to allow an application to respond to this notification.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Any return from <emphasis role="italic">getObject</emphasis> is ignored. The default implementation returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
By default, the GETOBJECT notification is completely ignored. This is controlled by the
<xref linkend="atrWantGetObject"/> attribute. If that attribute is set to true, the <emphasis
role="italic">getObject</emphasis> event handler will be invoked.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::getObject() -->
<section id="mthHelpClsPSP" xreflabel="help"><title>help</title>
<indexterm><primary>help</primary><secondary>PropertySheetPage class</secondary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>help</secondary></indexterm>
<programlisting>
<![CDATA[
>>--help(--propSheet--)--------------------------><
]]>
</programlisting>
<para>
Notifies a page that the user has clicked the Help button.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The default implementation of the <emphasis role="italic">help</emphasis> event handler returns 0. When the
programmer over-rides this method, the method must return a value, but the value itself is ignored.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
If the application provides a help button, then the application should display help if this notification is
received.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::help() -->
<section id="mthKillActive" xreflabel="killActive"><title>killActive</title>
<indexterm><primary>killActive</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>killActive</secondary></indexterm>
<programlisting>
<![CDATA[
>>--killActive(--propSheet--)--------------------><
]]>
</programlisting>
<para>
Notifies a page that it is about to lose activation either because another page is being activated or the user has
clicked the OK button.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer must return <computeroutput>.true</computeroutput> to allow the page to lose activation and
<computeroutput>.false</computeroutput> to prevent the page from losing the activation. The default implementation
of this event handler returns <xref linkend="mthValidatePage"/>. The default implementation of
<xref linkend="mthValidatePage"/> returns <computeroutput>.true</computeroutput>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
An application handles this notification to validate the information the user has entered. If the programmer returns
<computeroutput>.false</computeroutput> to prevent the page from losing activation, it should display a message box
to explain the problem to the user.
</para>
<para>
The default implementation invokes the <xref linkend="mthValidatePage"/> method. Since the default
implementation of <emphasis role="italic">validatePage</emphasis> returns <computeroutput>.true</computeroutput>,
the default <emphasis role="italic">killActive</emphasis> returns <computeroutput>.true</computeroutput>. Rather
than over-ride <emphasis role="italic">killActive</emphasis>, the programmer could over-ride the <emphasis
role="italic">validatePage</emphasis> method and do page validation in the over-ride. Returning
<computeroutput>.false</computeroutput> from the over-ride will cause the default <emphasis
role="italic">killActive</emphasis> to return <computeroutput>.false</computeroutput>.
</para>
<para>
A common strategy might be to over-ride <emphasis role="italic">validatePage</emphasis>, do all page validation in
<emphasis role="italic">validatePage</emphasis>, return <computeroutput>.true</computeroutput> or
<computeroutput>.false</computeroutput> from <emphasis role="italic">validatePage</emphasis> depending on the
outcome of the validation, and leave the default implementation of <emphasis role="italic">killActive</emphasis>
alone.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example checks that the user has entered a last name in the form before leaving a page. If the last name field
was left blank, the user is not allowed to leave the page:
<programlisting>
<![CDATA[
::method killActive unguarded
expose editLName
use arg propSheet
if editLName~getText~strip~length == 0 then do
msg = "The last name field must be filled in."
title = "Acme Employment Application"
ret = MessageDialog(msg, self~hwnd, title, "OK", "WARNING")
editLName~assignFocus
return .false
end
return .true
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::killActive() -->
<section id="mthPageCreate" xreflabel="pageCreate"><title>pageCreate</title>
<indexterm><primary>pageCreate</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>pageCreate</secondary></indexterm>
<programlisting>
<![CDATA[
>>--pageCreate(--propSheet--)--------------------><
]]>
</programlisting>
<para>
Notifies the Rexx page dialog that the <xref linkend="ovvUnderlying"/> page dialog is about to be
created. This notification is sent before the underlying page exists.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Return <computeroutput>.true</computeroutput> to allow the page to be created. Return
<computeroutput>.false</computeroutput> to <emphasis role="italic">prevent</emphasis> the underlying dialog page
from being created. The default implmentation returns <computeroutput>.true</computeroutput>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This event handler is provided for completeness. It is not readily apparent how useful handling the event would be.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from some code that experiments with property sheet dialogs. It over-rides the default
implementation of <emphasis role="italic">pageCreate</emphasis> to print a message when the <emphasis
role="italic">pageCreate</emphasis> is invoked. It returns <computeroutput>.false</computeroutput> to prevent the
page from being created. The experimentation showed that if the current tab selection is not set to another page,
the appearance of the dialog was a little raggedy:
<programlisting>
<![CDATA[
::method pageCreate unguarded
use arg propSheet
say 'In pageCreate(), propSheet:' propSheet
reply .false
propSheet~setCurSel(3)
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::pageCreate() -->
<section id="mthQueryCancel" xreflabel="queryCancel"><title>queryCancel</title>
<indexterm><primary>queryCancel</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>queryCancel</secondary></indexterm>
<programlisting>
<![CDATA[
>>--queryCancel(--propSheet--)-------------------><
]]>
</programlisting>
<para>
Notifies a property sheet page that the user has canceled the property sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer must return <computeroutput>.false</computeroutput> to disallow the dialog from closing and
<computeroutput>.true</computeroutput> to allow the dialog to close. The default implementation returns
<computeroutput>.true</computeroutput>.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This event notification is typically sent when a user clicks the Cancel button. It is also sent when a user clicks
the X button in the property sheet's upper right hand corner or presses the ESCAPE key. A property sheet page could
handle this notification, for example, to ask the user to verify the cancel operation.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::queryCancel() -->
<section id="mthQueryFromSibling" xreflabel="queryFromSibling"><title>queryFromSibling</title>
<indexterm><primary>queryFromSibling</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>queryFromSibling</secondary></indexterm>
<programlisting>
<![CDATA[
>>--queryFromSibling(--arg1--,--arg2--,--propSheet--)-----------><
]]>
</programlisting>
<para>
Notifies the page of a <xref linkend="mthQuerySiblings"/> messge.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>arg1</term>
<listitem>
<para>
The first application defined value. This can be any Rexx object.
</para>
</listitem></varlistentry>
<varlistentry><term>arg2</term>
<listitem>
<para>
The second application defined value. This can be any Rexx object.
</para>
</listitem></varlistentry>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
Return a whole number. If the returned number is 0, the property sheet
<xref linkend="clsPropertySheetDialog"/> sends the QUERYSIBLINGS message on to the next page in the property
sheet. If the number is not 0, then the property sheet dialog does not send the message on the the next page and
returns its value from the <xref linkend="mthQuerySiblings"/> method. The default implementation
returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">querySiblings</emphasis> method provides a way for the pages of a property sheet to
communicate with each other. The <emphasis role="italic">querySiblings</emphasis> method is invoked with two
values. The property sheet dialog then notifies each page, in order, through the <emphasis
role="italic">queryFromSibling</emphasis> event handler. The two values passed into the <emphasis
role="italic">querySiblings</emphasis> method are passed on unchanged to each page. If a page returns non-zero, then
the property sheet does not notify any of the subsequent pages and returns from the <emphasis
role="italic">querySiblings</emphasis> method. If all pages return 0, then the property sheet dialog returns 0 from
the <emphasis role="italic">querySiblings</emphasis> method.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example comes from a movie ticket purchasing wizard. On the last page the application needs to know what movies
the user is buying tickets for. In the last page, he application invokes <emphasis
role="italic">querySiblings</emphasis> and all the other pages fill in the details of the tickets being purchased:
<programlisting>
<![CDATA[
-- snippet code from the last page in a property sheet dialog
info = .table~new
movieCombo~deleteAll
ret = propSheet~querySiblings(info, "DATA")
do movie over info
movieCombo~add(movie)
end
-- snippet of code from the first page in the property sheet dialog
when arg2 == "DATA" then do
-- arg1 is a table whose indexes are the films. Each item is a directory,
-- and the indexes are theater, date, and time. The other pages fill in the
-- directory. We just make sure only the selected movies are in the
-- table.
arg1~empty
currentSelectedMovies = self~getSelectedMovies
do movie over currentSelectedMovies
d = .directory~new
arg1[movie] = d
end
end
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::queryFromSibling() -->
<section id="mthQueryInitialFocus" xreflabel="queryInitialFocus"><title>queryInitialFocus</title>
<indexterm><primary>queryInitialFocus</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>queryInitialFocus</secondary></indexterm>
<programlisting>
<![CDATA[
>>--queryInitialFocus(--idDefault--,--propSheet--)--------------><
]]>
</programlisting>
<para>
Provides a property sheet page an opportunity to specify which dialog box control should receive the initial focus.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>idDefault</term>
<listitem>
<para>
The resource ID of the dialog control that will receive the focus by default
</para>
</listitem></varlistentry>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer returns 0 to set the focus to the default control and returns the dialog control resource ID to
set that focus to that control. The ID can be numeric or symbolic. The default implmentation returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The application must not invoke any ooDialog framework methods to set the focus while handling this notification.
Instead, return the resource ID of the control that should receive focus, and the property sheet manager will handle
the focus change.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
In this example the <emphasis role="italic">queryInitialFocus</emphasis> event handler is used to change the initial
focus from the top check box to the third check box, using the symbolic ID of the third check box:
<programlisting>
<![CDATA[
::method queryInitialFocus
use arg id, propSheet
return IDC_CK_NO_ADMIN
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::queryInitialFocus() -->
<section id="mthReset" xreflabel="reset"><title>reset</title>
<indexterm><primary>reset</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>reset</secondary></indexterm>
<programlisting>
<![CDATA[
>>--reset(--isCancelButton--,--propSheet--)------><
]]>
</programlisting>
<para>
Notifies a page that the property sheet is about to be destroyed.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>isCancelButton</term>
<listitem>
<para>
This argument is <computeroutput>.true</computeroutput> if the user clicked the Cancel button . It will be
<computeroutput>.false</computeroutput> if the user clicked the X button in the upper-right corner of the
property sheet.
</para>
</listitem></varlistentry>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer must return a value from this event handler, but the value of the return has no meaning. The
default implementation returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
This notification is only sent to the page that has the current focus. It gives the page the opportunity to do some
final clean up.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::reset() -->
<section id="mthSetActive" xreflabel="setActive"><title>setActive</title>
<indexterm><primary>setActive</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>setActive</secondary></indexterm>
<programlisting>
<![CDATA[
>>--setActive(--propSheet--)---------------------><
]]>
</programlisting>
<para>
Notifies a page that it is about to be activated.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer returns 0 to allow the page to become active, -1 to prevent a page change, and the page
<xref linkend="atrPageNumber"/> or page <xref linkend="atrPageID"/>, to go to that specific page. The
default implementation returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows the <emphasis role="italic">setActive</emphasis> method from the first page in an Aero wizard. It
uses the notification to enable the Next button and to remove the Back and Finish buttons. (The user can not go
<emphasis role="italic">back</emphasis> from the first page and <emphasis role="italic">finishing</emphasis> is not
possible at that point.)
<programlisting>
<![CDATA[
::method setActive
use arg propSheet
propSheet~setWizButtons("NEXT")
propSheet~showWizButtons("NEXT", "BACK FINISH NEXT")
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::setActive() -->
<section id="mthSetSizeClsPSP" xreflabel="setSize"><title>setSize</title>
<indexterm><primary>setSize</primary><secondary>PropertySheetPage class</secondary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>setSize</secondary></indexterm>
<programlisting>
<![CDATA[
Form 1:
>>--setSize(--sizeObj--)-------------------------><
Form 2:
>>--setSize(--width--,--height--)----------------><
Generic form:
>>--setSize(--sizeSpecifier--)-------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">setSize</emphasis> method can be used to set both the <xref linkend="atrCX"/> and
<xref linkend="atrCY"/> attributes at one time.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are the width and height values, in dialog units, for the dialog template of this page. As noted in
the syntax diagram, the width and height can either be supplied through a single <xref linkend="clsSize"/>
object, or by specifying the width and height separately.
</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>
This is a convenience method to set both the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes at one time. The documentation on the two attrribtes is relevant here. This
is one of the few <computeroutput>PropertySheetPage</computeroutput> methods that is not an event handler.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This snippet of code shows how the <emphasis role="italic">setSize</emphasis> method can be used to set all the
pages of a wizard dialog to the proper size:
<programlisting>
<![CDATA[
-- First we create the dialogs for each page, and set any of the attributes
-- we need to. We want each dialog to be the same size.
outPageSize = .Size~new(267, 193)
inPageSize = .Size~new(267, 143)
intro = .IntroDlg~new( , , "", "ooRexx Movie Ticket Selectitron")
intro~setSize(outPageSize)
p1 = .MoviesDlg~new( , , "", "Movies")
p1~setSize(inPageSize)
...
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::setSize() -->
<section id="mthTranslateAccelerator" xreflabel="translateAccelerator"><title>translateAccelerator</title>
<indexterm><primary>translateAccelerator</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>translateAccelerator</secondary></indexterm>
<programlisting>
<![CDATA[
>>--translateAccelerator(--wmMsg--,--keyCode--,--status--,--propSheet--)-------><
]]>
</programlisting>
<para>
Notifies a property sheet page that a keyboard message has been received. It provides the page an opportunity to do
private keyboard accelerator translation.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>wmMsg</term>
<listitem>
<para>
One of the following keywords that indicates the type of keyboard message
</para>
<para>
<simplelist type='vert' columns='3'>
<member>KEYUP </member>
<member>KEYDOWN </member>
<member>CHAR </member>
<member>DEADCHAR </member>
<member>SYSKEYUP </member>
<member>SYSKEYDOWN </member>
<member>SYSCHAR </member>
<member>SYSDEADCHAR</member>
</simplelist>
<variablelist>
<varlistentry><term>KEYUP</term>
<listitem>
<para>
This message is posted to the window with the keyboard focus when a nonsystem key is released. A nonsystem
key is a key that is pressed when the ALT key is not pressed, or a keyboard key that is pressed when a
window has the keyboard focus. The <emphasis role="italic">keyCode</emphasis> argument is the virtual-key
code of the nonsystem key.
</para>
</listitem></varlistentry>
<varlistentry><term>KEYDOWN</term>
<listitem>
<para>
This message is posted to the window with the keyboard focus when a nonsystem key is pressed. A nonsystem
key is a key that is pressed when the ALT key is not pressed. The <emphasis role="italic">keyCode</emphasis>
argument is the virtual-key code of the nonsystem key.
</para>
</listitem></varlistentry>
<varlistentry><term>CHAR</term>
<listitem>
<para>
This message is posted to the window with the keyboard focus when a WM_KEYDOWN message is translated by the
operating system. The <emphasis role="italic">keyCode</emphasis> argument is the character code of the key.
</para>
</listitem></varlistentry>
<varlistentry><term>DEADCHAR</term>
<listitem>
<para>
This message is posted to the window with the keyboard focus when a KEYUP message is translated by the
operating system. DEADCHAR specifies a character code generated by a dead key. A dead key is a key that
generates a character, such as the umlaut (double-dot), that is combined with another character to form a
composite character. For example, the umlaut-O character is generated by typing the dead key for the
umlaut character, and then typing the O key. The <emphasis role="italic">keyCode</emphasis> argument is the
character code generated by the dead key.
</para>
</listitem></varlistentry>
<varlistentry><term>SYSCHAR</term>
<listitem>
<para>
This message is posted to the window with the keyboard focus when a SYSKEYDOWN message is translated by the
operating system. The <emphasis role="italic">keyCode</emphasis> argument specifies the character code of a
system character key, that is, a character key that is pressed while the ALT key is down.
</para>
</listitem></varlistentry>
<varlistentry><term>SYSDEADCHAR</term>
<listitem>
<para>
This message is sent to the window with the keyboard focus when a SYSKEYDOWN message is translated by the
oeprating system. The <emphasis role="italic">keyCode</emphasis> argument specifies the character code of a
system dead key, that is, a dead key that is pressed while holding down the ALT key.
</para>
</listitem></varlistentry>
<varlistentry><term>SYSKEYDOWN</term>
<listitem>
<para>
Thise message is posted to the window with the keyboard focus when the user presses the F10 key (which
activates the menu bar) or holds down the ALT key and then presses another key. It also occurs when no
window currently has the keyboard focus, in this case, the message is sent to the active window. The
<emphasis role="italic">keyCode</emphasis> argument is the virtual-key code of the key being pressed.
</para>
</listitem></varlistentry>
<varlistentry><term>SYSKEYUP</term>
<listitem>
<para>
This message is posted to the window with the keyboard focus when the user releases a key that was pressed
while the ALT key was held down. The <emphasis role="italic">keyCode</emphasis> argument is the virtual-key
code of the key being released.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>keyCode</term>
<listitem>
<para>
A key code that is dependent on the <emphasis role="italic">wmMsg</emphasis> argument.
</para>
</listitem></varlistentry>
<varlistentry><term>status</term>
<listitem>
<para>
A <computeroutput>Directory</computeroutput> that further clarifies the status of the keyboard message. The
<computeroutput>Dirctory</computeroutput> object will contain the following indexes where the value of each
index will be either <computeroutput>.true</computeroutput> or <computeroutput>.false</computeroutput>:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>RELEASED </member>
<member>WASDOWN </member>
<member>ISEXTENDED </member>
<member>ALTHELD </member>
<member>SHIFTHELD </member>
<member>CONTROLHELD</member>
</simplelist>
<variablelist>
<varlistentry><term>RELEASED</term>
<listitem>
<para>
True if the key was released, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term>WASDOWN</term>
<listitem>
<para>
True if the key was down prior to this keyboard message, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term>ISEXTENDED</term>
<listitem>
<para>
True if the key specified by this keyboard message is an extended key, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term>ALTHELD</term>
<listitem>
<para>
True if the Alt key was held down at the time of this message, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term>SHIFTHELD</term>
<listitem>
<para>
True if the Shift key was held down at the time of this message, otherwise false.
</para>
</listitem></varlistentry>
<varlistentry><term>CONTROLHELD</term>
<listitem>
<para>
True if the Control key was held down at the time of this message, otherwise false.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer returns one of the <link linkend="tblPropertySheetPageMethods">constants</link> PSNRET_NOERROR or
PSNRET_MESSAGEHANDLED. Return PSNRET_MESSAGEHANDLED to indicate to the OS that no further processing is necessary or
return PSNRET_NOERROR to request normal processing from the OS. The default implementation returns PSNRET_NOERROR.
</para> </listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
The Microsoft documentation does not specify exactly which keyboard messages are passed on through the
TRANSLATEACCELERATOR notification, it simply says <emphasis role="italic">keyboard messages</emphasis>. The
documentation above for the <emphasis role="italic">wmMsg</emphasis> argument lists possible keyboard messages, but
it may not be the case that all of the listed messages are in fact passed on to the event handler.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows an over-ride of the translateAccelerator() event handle that prints out the arguments and some
sample output:
<programlisting>
<![CDATA[
::method translateAccelerator
use arg msg, keyCode, d, propSheet
say msg keyCode
say 'Released:' d~released 'was down:' d~wasDown 'is extended:' d~isExtended
say 'Alt held:' d~altHeld 'shift held:' d~shiftHeld 'control held:' d~controlHeld
say
return self~PSNRET_NOERROR
/* Output for a shift-M keystroke, i.e. typing capital M. Note the repeated messages
for the shift key bein held down:
KEYDOWN 16
Released: 0 was down: 0 is extended: 0
Alt held: 0 shift held: 1 control held: 0
KEYDOWN 16
Released: 0 was down: 1 is extended: 0
Alt held: 0 shift held: 1 control held: 0
KEYDOWN 16
Released: 0 was down: 1 is extended: 0
Alt held: 0 shift held: 1 control held: 0
KEYDOWN 77
Released: 0 was down: 0 is extended: 0
Alt held: 0 shift held: 1 control held: 0
CHAR 77
Released: 0 was down: 0 is extended: 0
Alt held: 0 shift held: 1 control held: 0
KEYUP 77
Released: 1 was down: 1 is extended: 0
Alt held: 0 shift held: 1 control held: 0
KEYUP 16
Released: 1 was down: 1 is extended: 0
Alt held: 0 shift held: 0 control held: 0
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::translateAccelerator() -->
<section id="mthWizBack" xreflabel="wizBack"><title>wizBack</title>
<indexterm><primary>wizBack</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>wizBack</secondary></indexterm>
<programlisting>
<![CDATA[
>>--wizBack(--propSheet--)-----------------------><
]]>
</programlisting>
<para>
Notifies a page that the user has clicked the Back button in a wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer returns 0 to allow the page to be changed to the previous page, -1 to prevent the page from
changing, and the page <xref linkend="atrPageNumber"/> or page <xref linkend="atrPageID"/>, to
go to that specific page instead of the previous page. The default implementation returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example is from some exploratory code. When the user clicks the back button on page four of the wizard, instead
of going to page three, the dialog goes back to page one. I.e., the user starts over. There are some say statements
to print out information on the screen. The <xref linkend="mthIndexToID"/> method is used to test
that it works. It would have been just as good to simply return the page number (1.)
<programlisting>
<![CDATA[
::method wizBack unguarded
use arg propSheet
say 'In wizBack page four'
ret = propSheet~indexToID(1)
say 'Got return from indexToID() ret:' ret
return ret
/* Output might be:
In wizBack page four
Got return from indexToID() ret: 0x00000000004EAF60
*/
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::wizBack() -->
<section id="mthWizFinish" xreflabel="wizFinish"><title>wizFinish</title>
<indexterm><primary>wizFinish</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>wizFinish</secondary></indexterm>
<programlisting>
<![CDATA[
>>--wizFinish(--propSheet--)---------------------><
]]>
</programlisting>
<para>
Notifies a page that the user has clicked the Finish button in a wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer returns 0 to allow the wizard to finish. To prevent the wizard from finishing, the programmer
should return -1 or the resource ID of a dialog control on the page. The default implementation returns 0.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Typically, when the programmer wants to prevent the wizard from finishing it is because of some error in the data
the user entered on one of the wizard pages. In this case it is nice to set the focus to the first dialog control on
the page that needs correcting. If the <emphasis role="italic">wizFinish</emphasis> method returns -1, then the
programmer has no control over which dialog control will have the focus. It is recommended to always return the
resource ID of a dialog control when preventing the wizard from finishing.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example shows part of a wizFinish() over-ride. The method does some checking and determines that the credit
card number entered (or not entered at all) is not valid. A message box will inform the user of the problem and then
returns the resource ID of the edit control where the user enters the credit card number. This prevents the wizard
from finishing and places the focus on the edit control so that the user can correct the number:
<programlisting>
<![CDATA[
::method wizFinish unguarded
use arg propSheet
...
chkCreditCard = self~newCheckBox(IDC_CK_CREDIT)
editCCNumber = self~newEdit(IDC_EDIT_CC_NUMBER)
...
if chkCreditCard~checked then do
...
ccNumber = editCCNumber~getText~strip
if ccNumber~length <> 12 then do
-- put up message box informing user
return IDC_EDIT_CC_NUMBER
end
end
...
return 0
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::wizFinish() -->
<section id="mthWizNext" xreflabel="wizNext"><title>wizNext</title>
<indexterm><primary>wizNext</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>wizNext</secondary></indexterm>
<programlisting>
<![CDATA[
>>--wizNext(--propSheet--)-----------------------><
]]>
</programlisting>
<para>
Notifies a page that the user has clicked the Next button in a wizard.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer returns 0 to allow the page to be changed to the next page, -1 to prevent the page from
changing, and the page <xref linkend="atrPageNumber"/> or page <xref linkend="atrPageID"/>, to
go to that specific page instead of the next page. The default implementation returns 0.
</para> </listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::wizNext() -->
<section id="mthValidateClsPSP" xreflabel="validate"><title>validate</title>
<indexterm><primary>validate</primary><secondary>PropertySheetPage class</secondary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>validate</secondary></indexterm>
<programlisting>
<![CDATA[
>>--validate(--isOkButton--,--propSheet--)-------><
]]>
</programlisting>
<para>
The <emphasis role="italic">validate</emphasis> method is invoked automatically by the ooDialog framework from the
default implementation of the <xref linkend="mthApplyClsPSP"/> event handler. It is meant to be over-ridden
by the Rexx progammer and provides a place to validate the data entered by the user in a page. It is similar in
purpose to the <xref linkend="chpDialogObject"/> object's <xref linkend="mthValidate"/>
method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments are:
<variablelist>
<varlistentry><term>isOkButton</term>
<listitem>
<para>
The <emphasis role="italic">validate</emphasis> method is meant to be invoked from the
<xref linkend="mthApplyClsPSP"/> event handler. The <emphasis role="italic">isOkButton</emphasis> argument
is the <emphasis role="italic">isOkBtn</emphasis> argument passed to the <emphasis
role="italic">apply</emphasis> event handler.
</para>
<para>
The argument is true if the user clicked the OK button. It is also set to true if the
<xref linkend="mthCancelToClose"/> method had inovked on the propertery sheet and the user clicked
the Close button. It is set to false if the user clicked the Apply button.
</para>
</listitem></varlistentry>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The <emphasis role="italic">validate</emphasis> method should return one of the 3
<link linkend="tblPropertySheetPageMethods">constant</link>) values: PSNRET_NOERROR, PSNRET_INVALID, or
PSNRET_INVALID_NOCHANGEPAGE. See the remarks section.
</para> </listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Recall that the <xref linkend="mthApplyClsPSP"/> method handles the notification sent to every page in
the property sheet that the user has clicked the OK, Close, or Apply button and wants all changes to take effect.
The purpose of that notification, and therefore the <emphasis role="italic">validate</emphasis> method, is to give
the application a chance to check that any data entered by the user is of the right form and prevent the dialog from
closing if the user needs to correct any data. The default <emphasis role="italic">apply</emphasis> implementation
returns the value returned from this <emphasis role="italic">validate</emphasis> method. The default implementation
returns PSNRET_NOERROR.
</para>
<para>
Therefore, a better stategy than over-riding the <emphasis role="italic">apply</emphasis> method, might be to
over-ride the <emphasis role="italic">validate</emphasis> method. In the over-ride, return PSNRET_INVALID or
PSNRET_INVALID_NOCHANGEPAGE to prevent the dialog from closing and return PSNRET_NOERROR to allow the dialog to
close. The advantage to this is that the <xref linkend="mthApplyClsPSP"/> method also handles some
internal house keeping when the return is PNSRET_NOERROR. By over-riding <emphasis role="italic">validate</emphasis>
instead of <emphasis role="italic">apply</emphasis>, the Rexx programmer has fewer details to take care of.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example over-rides the <emphasis role="italic">validate</emphasis> method for the page and checks that the user
has filled in the last name field. If not, PSNRET_INVALID is returned to prevent the dialog from proceeding and to
have the focus returned to the page. If the user did fill in the last name and the other checks pass, PSNRET_NOERROR
is returned:
<programlisting>
<![CDATA[
::method validate private unguarded
use arg isOkButton, propSheet
if self~newEdit(IDC_EDIT_LNAME)~getText~strip == "" then do
msg = "The last name field must be filled in"
title = "Job Application Error"
ret = MessageDialog(msg, self~hwnd, title, "OK", "WARNING")
return self~PSNRET_INVALID
end
...
return self~PSNRET_NOERROR
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::validate() -->
<section id="mthValidatePage" xreflabel="validatePage"><title>validatePage</title>
<indexterm><primary>validatePage</primary></indexterm>
<indexterm><primary>PropertySheetPage class</primary><secondary>validatePage</secondary></indexterm>
<programlisting>
<![CDATA[
>>--validatePage(--propSheet--)------------------><
]]>
</programlisting>
<para>
The <emphasis role="italic">validatePage</emphasis> method is invoked automatically by the ooDialog framework from the
default implementation of the <xref linkend="mthKillActive"/> event handler. It is meant to be
over-ridden by the Rexx progammer and provides a place to validate the data entered by the user in a page. It is
similar in purpose to the <xref linkend="chpDialogObject"/> object's
<xref linkend="mthValidate"/> method.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The single argument is:
<variablelist>
<varlistentry><term>propSheet</term>
<listitem>
<para>
This argument is set to the Rexx property sheet dialog object that owns this property sheet page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
The Rexx programmer should return <computeroutput>.true</computeroutput> to signal that the data entered for the
page is valid and <computeroutput>.false</computeroutput> to signal that the data on the page is not valid. The
default implementation of <xref linkend="mthKillActive"/> directly returns <emphasis
role="italic">validatePage</emphasis>. Therefore, if <emphasis role="italic">killActive</emphasis> is not
over-ridden, the progammer must return <computeroutput>.true</computeroutput> to allow the page to lose activation
and <computeroutput>.false</computeroutput> to prevent the page from losing the activation.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
A common strategy might be to over-ride <emphasis role="italic">validatePage</emphasis> and do all page validation
there. When using this strategy, the default implementation of <xref linkend="mthKillActive"/> would
be left alone. The programmer would be careful to return either <computeroutput>.true</computeroutput> or
<computeroutput>.false</computeroutput> from <emphasis role="italic">validatePage</emphasis>.
</para>
<para>
On the other hand, if the programmer were to over-ride <emphasis role="italic">killActive</emphasis>, the
implementation of <emphasis role="italic">killActive</emphasis> would be free to interpret the return from <emphasis
role="italic">validatePage</emphasis> as desired, or not invoke <emphasis role="italic">validatePage</emphasis> at
all.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Details</emphasis></term>
<listitem>
<para>
Raises syntax errors when incorrect usage is detected.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example over-rides the implementation of <emphasis role="italic">validatePage</emphasis> and returns
<computeroutput>.true</computeroutput> or <computeroutput>.false</computeroutput> to indicate if the page is valid
or invalid. The default implementation of <xref linkend="mthKillActive"/> is left alone:
<programlisting>
<![CDATA[
::method validatePage private unguarded
expose editLName
use arg propSheet
if editLName~getText~strip~length == 0 then do
msg = "The last name field must be filled in."
title = "Acme Employment Application"
ret = MessageDialog(msg, self~hwnd, title, "OK", "WARNING")
editLName~assignFocus
return .false
end
return .true
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End PropertySheetPage::validatePage() -->
</section> <!-- End PropertySheetPage Class Section -->
<section id="clsRcPSPDialog" xreflabel="RcPSPDialog"><title>RcPSPDialog Class</title>
<indexterm><primary>Property Sheet Pages</primary><secondary>RcPSPDialog class</secondary></indexterm>
<indexterm><primary>RcPSPDialog class</primary></indexterm>
<para>
The <computeroutput>RcPSPDialog</computeroutput> class provides the basis for a page dialog where the dialog
<xref linkend="ovvDialogTemplate"/> is defined within a resource
<xref linkend="defResourceScript"/> file. It is a subclass of the <xref linkend="clsRcDialog"/>.
</para>
<section id="mthNewClsRcPSPDialog" xreflabel="new"><title>new (Class method)</title>
<indexterm><primary>new</primary><secondary>RcPSPDialog class</secondary></indexterm>
<programlisting>
<![CDATA[
>>-init(--rc--,--id-+---------+-+---------+-+---------+-+---------+-+---------+-)--><
+-,-data.-+ +-,-hFile-+ +-,-pOpts-+ +-,-cOpts-+ +-,-exptd-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>RcPSPDialog</computeroutput> object. A <computeroutput>RcPSPDialog</computeroutput>
object can be used as a page in a <xref linkend="clsPropertySheetDialog"/> sheet dialog.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments when creating a new dialog instance of this class are:
<variablelist>
<varlistentry><term>rc [required]</term>
<listitem>
<para>
The file name of the resource script containing the dialog template.
</para>
</listitem></varlistentry>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the dialog template. This may be numeric or <xref linkend="defSymbolicId"/>.
</para>
</listitem></varlistentry>
<varlistentry><term>data. [optional]</term>
<listitem>
<para>
A <xref linkend="termDialogDataStem"/> variable (don't forget the trailing period) that
contains data used to initialize the underlying dialog's controls.
</para>
</listitem></varlistentry>
<varlistentry><term>hFile [optional]</term>
<listitem>
<para>
The name of a <xref linkend="defHeaderFile"/>) containing symbolic ID defines for resource IDs.
</para>
</listitem></varlistentry>
<varlistentry id="argPageOptsClsRcPSPDialog"><term>pOpts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following page option keywords separated by spaces, case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>AEROPAGE </member>
<member>HASHELP </member>
<member>HIDEHEADER </member>
<member>LARGE </member>
<member>MEDIUM </member>
<member>PREMATURE </member>
<member>RTLREADING </member>
<member>SMALL </member>
<member>USEFUSIONCONTEXT </member>
<member>USEHEADERSUBTITLE</member>
<member>USEHEADERTITLE </member>
<member>USEREFPARENT </member>
<member>USETITLE </member>
</simplelist>
<variablelist>
<varlistentry><term>AEROPAGE</term>
<listitem>
<para>
Specifies that this page is for use in an Aero wizard. All property sheet pages that are used in Aero wizard
dialogs need to specify this keyword to ensure that the page is initialized correctly.
</para>
</listitem></varlistentry>
<varlistentry><term>HASHELP</term>
<listitem>
<para>
Enables the property sheet Help button when the page is active. This keyword is not supported when using the
Aero-style wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>HIDEHEADER</term>
<listitem>
<para>
Causes the wizard property sheet to hide the header area when the page is selected. If a watermark has been
provided, it will be painted on the left side of the page. This flag should be set for welcome and
completion pages, and omitted for interior pages. This keyword is not supported when using the Aero-style
wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>LARGE</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a large property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_LG_CXDLG and PROP_LG_CYDLG respectively.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>MEDIUM</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a medium property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_MED_CXDLG and PROP_MED_CYDLG respectively. This is the default if the SMALL or LARGE keywords are not
used.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>PREMATURE</term>
<listitem>
<para>
Causes the page to be created when the property sheet is created. If this flag is not specified, the page
will not be created until it is selected the first time. This keywork is not supported when using the
Aero-style wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Reverses the direction in which the page title is displayed. Normal windows display all text, including the
page title, left-to-right (LTR). For languages such as Hebrew or Arabic that read right-to-left (RTL), a
window can be mirrored and all text will be displayed RTL. If RTLREADING is set, the page title will instead
read RTL in a normal parent window, and LTR in a mirrored parent window.
</para>
</listitem></varlistentry>
<varlistentry><term>SMALL</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a small property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_SM_CXDLG and PROP_SM_CYDLG respectively.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>USEFUSIONCONTEXT</term>
<listitem>
<para>
Use an activation context. This keyword is provided for completeness. In the current implementation of
ooDialog there is no way for the programmer to provide the activation context. Future versions of ooDialog
may be enhanced in a way that would give meaning to this keyword.
</para>
</listitem></varlistentry>
<varlistentry><term>USEHEADERSUBTITLE</term>
<listitem>
<para>
Displays the string value of the <xref linkend="atrHeaderSubtitle"/> attribute as the
subtitle in the header of a Wizard97 interior page. This keyword is ignored when the HIDEHEADER
keyword is used.
</para>
</listitem></varlistentry>
<varlistentry><term>USEHEADERTITLE</term>
<listitem>
<para>
Displays the string value of the <xref linkend="atrHeaderTitle"/> attribute as the title in
the header of a Wizard97 interior page. This keyword is ignored when the HIDEHEADER keyword is used.
</para>
</listitem></varlistentry>
<varlistentry><term>USEREFPARENT</term>
<listitem>
<para>
Maintains a reference count for the lifetime of the property sheet page. This keyword is present for
completeness. It will serve no purpose in the current implementation of ooDialog. Future versions of
ooDialog may be enhanced in a way where this keyword would have meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>USETITLE</term>
<listitem>
<para>
Specifies that the <xref linkend="atrPageTitle"/> attribute will be used as the title of the
page, rather than the title stored in the dialog template for the page. This keyword is not supported when
using the Aero-style wizard.
</para>
<para>
In general, the ooDialog framework will set this flag correctly and the Rexx programmer does not need to
worry about it. <emphasis role="italic">Except</emphasis>, for the
<xref linkend="clsRcPSPDialog"/> page object. In this case, the title for the page will be the
dialog title as specfied in the resource script, even if the <emphasis role="italic">pageTitle</emphasis>
attribute is set by the programmer. For <computeroutput>RcPSPDialog</computeroutput> pages, specify the
USETITLE keyword to use the <emphasis role="italic">pageTitle</emphasis> attribute as the title for the
page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>cOpts [optional]</term>
<listitem>
<para>
Zero or more of the following connect option keywords, separated by blanks:
<variablelist>
<varlistentry><term>CONNECTBUTTONS</term>
<listitem>
<para>
Each push <xref linkend="clsButton"/> in the underlying dialog has the CLICKED
<xref linkend="ovvEvents"/> notification connected automatically to a method in the Rexx dialog object.
This is the same as using the <xref linkend="mthConnectButtonEvent"/>() method for the
CLICKED notification. The name for the method is generated automatically by the ooDialog framework. The method
name is the button label with all spaces, ampersands, colons, and trailing <emphasis
role="italic">...</emphasis> characters removed.
</para>
</listitem></varlistentry>
<varlistentry><term>CONNECTRADIOS</term>
<listitem>
<para>
Similar to CONNECTBUTTONS, this option connects the CLICKED event notification from each
<xref linkend="clsRadioButton"/> button to a method in the Rexx dialog object. Again, this is the same as
using the <emphasis role="italic">connectButtonEvent</emphasis> method. For radio buttons, the generated
method name is the button label with all spaces, ampersands, colons, and trailing <emphasis
role="italic">...</emphasis> characters removed. The resulting text is then <emphasis
role="bold">prepened</emphasis> with the text <computeroutput>ID</computeroutput>.
</para>
</listitem></varlistentry>
<varlistentry><term>CONNECTCHECKS</term>
<listitem>
<para>
Exactly the same as CONNECTRADIOS, for check <xref linkend="clsCheckBox"/> controls. The object
method name is generated in the same way as it is for radio buttons. That is, the method name is the button
label, with all spaces, ampersands, colons, and trailing <emphasis role="italic">...</emphasis> characters
removed. Which is then <emphasis role="bold"> prepended</emphasis> with the text
<computeroutput>ID</computeroutput>.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term>exptd [optional]</term>
<listitem>
<para>
This is the maximum number of dialog controls expected in the dialog template. It serves the same purpose as the
<emphasis role="italic">expected</emphasis> argument in the <xref linkend="mthCreate"/>() method of
the <computeroutput>UserDialog</computeroutput>. The default value for this argument is 200.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This example creates 5 <computeroutput>RcPSPDialog</computeroutput> objects and then uses them as the 5 pages of a
<xref linkend="clsPropertySheetDialog"/>:
<programlisting>
<![CDATA[
-- Create the 5 dialog pages.
p1 = .ListViewDlg~new("rc\PropertySheetDemo.rc", IDD_LISTVIEW_DLG)
p2 = .TreeViewDlg~new("rc\PropertySheetDemo.rc", IDD_TREEVIEW_DLG)
p3 = .ProgressBarDlg~new("rc\PropertySheetDemo.rc", IDD_PROGRESSBAR_DLG)
p4 = .TrackBarDlg~new("rc\PropertySheetDemo.rc", IDD_TRACKBAR_DLG)
p5 = .TabDlg~new("rc\PropertySheetDemo.rc", IDD_TAB_DLG)
pages = .array~of(p1, p2, p3, p4, p5)
propDlg = .PropertySheetDemoDlg~new(pages, "NOAPPLYNOW", "ooRexx Property Sheet with Controls")
...
::requires "ooDialog.cls"
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End RcPSPDialog::new() -->
</section> <!-- End RcPSPDialog Class -->
<section id="clsResPSPDialog" xreflabel="ResPSPDialog"><title>ResPSPDialog Class</title>
<indexterm><primary>Property Sheet Pages</primary><secondary>ResPSPDialog class</secondary></indexterm>
<indexterm><primary>ResPSPDialog class</primary></indexterm>
<para>
The <computeroutput>ResPSPDialog</computeroutput> class provides the basis for a page dialog where the dialog
<xref linkend="ovvDialogTemplate"/> is loaded from a binary resource file. It is a subclass of the
<xref linkend="clsResDialog"/>.
</para>
<section id="mthNewClsResPSPDialog" xreflabel="new"><title>new (Class method)</title>
<indexterm><primary>new</primary><secondary>ResPSPDialog class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(--module--,--id--+-------------+--+----------+--+------------+--)------><
+-,--dlgData.-+ +-,--hFile-+ +-,-pageOpts-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>ResPSPDialog</computeroutput> object. A
<computeroutput>ResPSPDialog</computeroutput> can be used as a page in a
<xref linkend="clsPropertySheetDialog"/>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments when creating a new dialog instance of this class are:
<variablelist>
<varlistentry><term>module [required]</term>
<listitem>
<para>
The file name of the executable module (a DLL or EXE) in which the resource (the compiled dialog template) is
located.
</para>
</listitem></varlistentry>
<varlistentry><term>id [required]</term>
<listitem>
<para>
The resource ID of the dialog template. This may be numeric or <xref linkend="defSymbolicId"/>.
The resource ID is assigned to the dialog template when it was compiled.
</para>
</listitem></varlistentry>
<varlistentry><term>dlgData. [optional]</term>
<listitem>
<para>
A <xref linkend="termDialogDataStem"/> variable (don't forget the trailing period) that
contains data used to initialize the underlying dialog's controls.
</para>
</listitem></varlistentry>
<varlistentry><term>hFile [optional]</term>
<listitem>
<para>
The name of a <xref linkend="defHeaderFile"/>) containing symbolic ID defines for resource IDs.
</para>
</listitem></varlistentry>
<varlistentry><term>pageOpts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following page option keywords separated by spaces, case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>AEROPAGE </member>
<member>HASHELP </member>
<member>HIDEHEADER </member>
<member>LARGE </member>
<member>MEDIUM </member>
<member>PREMATURE </member>
<member>RTLREADING </member>
<member>SMALL </member>
<member>USEFUSIONCONTEXT </member>
<member>USEHEADERSUBTITLE</member>
<member>USEHEADERTITLE </member>
<member>USEREFPARENT </member>
<member>USETITLE </member>
</simplelist>
<variablelist>
<varlistentry><term>AEROPAGE</term>
<listitem>
<para>
Specifies that this page is for use in an Aero wizard. All property sheet pages that are used in Aero wizard
dialogs need to specify this keyword to ensure that the page is initialized correctly.
</para>
</listitem></varlistentry>
<varlistentry><term>HASHELP</term>
<listitem>
<para>
Enables the property sheet Help button when the page is active. This keyword is not supported when using the
Aero-style wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>HIDEHEADER</term>
<listitem>
<para>
Causes the wizard property sheet to hide the header area when the page is selected. If a watermark has been
provided, it will be painted on the left side of the page. This flag should be set for welcome and
completion pages, and omitted for interior pages. This keyword is not supported when using the Aero-style
wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>LARGE</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a large property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_LG_CXDLG and PROP_LG_CYDLG respectively.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>MEDIUM</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a medium property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_MED_CXDLG and PROP_MED_CYDLG respectively. This is the default if the SMALL or LARGE keywords are not
used.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>PREMATURE</term>
<listitem>
<para>
Causes the page to be created when the property sheet is created. If this flag is not specified, the page
will not be created until it is selected the first time. This keywork is not supported when using the
Aero-style wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Reverses the direction in which the page title is displayed. Normal windows display all text, including the
page title, left-to-right (LTR). For languages such as Hebrew or Arabic that read right-to-left (RTL), a
window can be mirrored and all text will be displayed RTL. If RTLREADING is set, the page title will instead
read RTL in a normal parent window, and LTR in a mirrored parent window.
</para>
</listitem></varlistentry>
<varlistentry><term>SMALL</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a small property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_SM_CXDLG and PROP_SM_CYDLG respectively.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>USEFUSIONCONTEXT</term>
<listitem>
<para>
Use an activation context. This keyword is provided for completeness. In the current implementation of
ooDialog there is no way for the programmer to provide the activation context. Future versions of ooDialog
may be enhanced in a way that would give meaning to this keyword.
</para>
</listitem></varlistentry>
<varlistentry><term>USEHEADERSUBTITLE</term>
<listitem>
<para>
Displays the string value of the <xref linkend="atrHeaderSubtitle"/> attribute as the
subtitle in the header of a Wizard97 interior page. This keyword is ignored when the HIDEHEADER
keyword is used.
</para>
</listitem></varlistentry>
<varlistentry><term>USEHEADERTITLE</term>
<listitem>
<para>
Displays the string value of the <xref linkend="atrHeaderTitle"/> attribute as the title in
the header of a Wizard97 interior page. This keyword is ignored when the HIDEHEADER keyword is used.
</para>
</listitem></varlistentry>
<varlistentry><term>USEREFPARENT</term>
<listitem>
<para>
Maintains a reference count for the lifetime of the property sheet page. This keyword is present for
completeness. It will serve no purpose in the current implementation of ooDialog. Future versions of
ooDialog may be enhanced in a way where this keyword would have meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>USETITLE</term>
<listitem>
<para>
Specifies that the <xref linkend="atrPageTitle"/> attribute will be used as the title of the
page, rather than the title stored in the dialog template for the page. This keyword is not supported when
using the Aero-style wizard.
</para>
<para>
In general, the ooDialog framework will set this flag correctly and the Rexx programmer does not need to
worry about it. <emphasis role="italic">Except</emphasis>, for the
<xref linkend="clsRcPSPDialog"/> page object. In this case, the title for the page will be the
dialog title as specfied in the resource script, even if the <emphasis role="italic">pageTitle</emphasis>
attribute is set by the programmer. For <computeroutput>RcPSPDialog</computeroutput> pages, specify the
USETITLE keyword to use the <emphasis role="italic">pageTitle</emphasis> attribute as the title for the
page.
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
</variablelist>
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Example:</emphasis></term>
<listitem>
<para>
This sample code snippet shows the instantiation of 5 <computeroutput>ResPSPDialog</computeroutput> objects. These
dialogs are then suitable to be used as the pages of a <computeroutput>PropertySheetDialog</computeroutput> object:
<programlisting>
<![CDATA[
t1 = .ListViewDlg~new("rc\PropertySheetDemo.dll", IDD_LISTVIEW_DLG)
t2 = .TreeViewDlg~new("rc\PropertySheetDemo.dll", IDD_TREEVIEW_DLG)
t3 = .ProgressBarDlg~new("rc\PropertySheetDemo.rc", IDD_PROGRESSBAR_DLG)
t4 = .TrackBarDlg~new("rc\PropertySheetDemo.dll", IDD_TRACKBAR_DLG)
t5 = .TabDlg~new("rc\PropertySheetDemo.dll", IDD_TAB_DLG)
pages = .array~of(t1, t2, t3, t4, t5)
...
::requires "ooDialog.cls"
]]>
</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
</section> <!-- End ResPSPDialog::new() -->
</section> <!-- End ResPSPDialog Class -->
<section id="clsUserPSPDialog" xreflabel="UserPSPDialog"><title>UserPSPDialog Class</title>
<indexterm><primary>Property Sheet Pages</primary><secondary>UserPSPDialog class</secondary></indexterm>
<indexterm><primary>UserPSPDialog class</primary></indexterm>
<para>
The <computeroutput>UserPSPDialog</computeroutput> class provides the basis for a page dialog where the dialog
<xref linkend="ovvDialogTemplate"/> is built dynamically in the program using the
<xref linkend="sctCreateMethods"/> methods of the <xref linkend="clsUserDialog"/>. It is a
subclass of the <computeroutput>UserDialog</computeroutput>.
</para>
<section id="mthNewClsUserPSPDialog" xreflabel="new"><title>new (Class method)</title>
<indexterm><primary>new</primary><secondary>UserPSPDialog class</secondary></indexterm>
<programlisting>
<![CDATA[
>>--new(--+----------+--+---------------+--+------------+--+---------+--------->
+-dlgData.-+ +-,--headerFile-+ +-,-pageOpts-+ +-,-title-+
>----+------------+--+------------+--+------------+--)-------------------------><
+-,-fontName-+ +-,-fontSize-+ +-,-expected-+
]]>
</programlisting>
<para>
Instantiates a new <computeroutput>UserPSPDialog</computeroutput> object. This dialog can then be used as a page in a
<xref linkend="clsPropertySheetDialog"/>.
</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
<listitem>
<para>
The arguments when creating a new dialog instance of this class are:
<variablelist>
<varlistentry><term>dlgData. [optional]</term>
<listitem>
<para>
A <xref linkend="termDialogDataStem"/> variable (don't forget the trailing period) that
contains data used to initialize the underlying dialog's controls.
</para>
</listitem></varlistentry>
<varlistentry><term>hFile [optional]</term>
<listitem>
<para>
The name of a <xref linkend="defHeaderFile"/>) containing symbolic ID defines for resource IDs.
</para>
</listitem></varlistentry>
<varlistentry><term>pageOpts [optional]</term>
<listitem>
<para>
A list of 0 or more of the following page option keywords separated by spaces, case is not significant:
</para>
<para>
<simplelist type='vert' columns='3'>
<member>AEROPAGE </member>
<member>HASHELP </member>
<member>HIDEHEADER </member>
<member>LARGE </member>
<member>MEDIUM </member>
<member>PREMATURE </member>
<member>RTLREADING </member>
<member>SMALL </member>
<member>USEFUSIONCONTEXT </member>
<member>USEHEADERSUBTITLE</member>
<member>USEHEADERTITLE </member>
<member>USEREFPARENT </member>
<member>USETITLE </member>
</simplelist>
<variablelist>
<varlistentry><term>AEROPAGE</term>
<listitem>
<para>
Specifies that this page is for use in an Aero wizard. All property sheet pages that are used in Aero wizard
dialogs need to specify this keyword to ensure that the page is initialized correctly.
</para>
</listitem></varlistentry>
<varlistentry><term>HASHELP</term>
<listitem>
<para>
Enables the property sheet Help button when the page is active. This keyword is not supported when using the
Aero-style wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>HIDEHEADER</term>
<listitem>
<para>
Causes the wizard property sheet to hide the header area when the page is selected. If a watermark has been
provided, it will be painted on the left side of the page. This flag should be set for welcome and
completion pages, and omitted for interior pages. This keyword is not supported when using the Aero-style
wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>LARGE</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a large property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_LG_CXDLG and PROP_LG_CYDLG respectively.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>MEDIUM</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a medium property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_MED_CXDLG and PROP_MED_CYDLG respectively. This is the default if the SMALL or LARGE keywords are not
used.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>SMALL</term>
<listitem>
<para>
Specifies that the initial size of the page dialog is the Microsoft recommended size for a small property
sheet page. This sets the <xref linkend="atrCX"/> and <emphasis role="italic">cy</emphasis>
attributes of the page to the <link linkend="tblPropertySheetPageMethods">constant</link>) values
PROP_SM_CXDLG and PROP_SM_CYDLG respectively.
</para>
<para>
Note that this keyword is really only relevant in a <computeroutput>UserPSPDialog</computeroutput>. In a
<computeroutput>RcPSPDialog</computeroutput> the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes are over-written with the width and height specified in the resource
script file. In a <computeroutput>ResPSPDialog</computeroutput> the size of the dialog template is set when
the resource is compiled and can not be changed so the <emphasis role="italic">cx</emphasis> and <emphasis
role="italic">cy</emphasis> attributes have no meaning.
</para>
</listitem></varlistentry>
<varlistentry><term>PREMATURE</term>
<listitem>
<para>
Causes the page to be created when the property sheet is created. If this flag is not specified, the page
will not be created until it is selected the first time. This keywork is not supported when using the
Aero-style wizard.
</para>
</listitem></varlistentry>
<varlistentry><term>RTLREADING</term>
<listitem>
<para>
Reverses the direction in which the page title is displayed. Normal windows display all text, including the
page title, left-to-right (LTR). For languages such as Hebrew or Arabic that read right-to-left (RTL), a
window can be mirrored and all text will be displayed RTL. If RTLREADING is set, the page title will instead
read RTL in a normal parent window, and LTR in a mirrored parent window.
</para>
</listitem></varlistentry>
<varlistentry><term>USEFUSIONCONTEXT</term>