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
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!-- DBGrids -->
<module name="DBGrids">
<short>
Data-aware grids to display and operate on information in a database
</short>
<descr>
<p>
<var>dbgrids.pas</var> contains classes and types needed to implement a database-aware grid control.
</p>
</descr>
<!-- unresolved type reference visibility: default -->
<element name="Classes"/>
<!-- unresolved type reference visibility: default -->
<element name="SysUtils"/>
<!-- unresolved type reference visibility: default -->
<element name="Math"/>
<!-- unresolved type reference visibility: default -->
<element name="FileUtil"/>
<!-- unresolved type reference visibility: default -->
<element name="DB"/>
<!-- unresolved type reference visibility: default -->
<element name="LazUTF8"/>
<!-- unresolved type reference visibility: default -->
<element name="LCLStrConsts"/>
<!-- unresolved type reference visibility: default -->
<element name="LCLIntf"/>
<!-- unresolved type reference visibility: default -->
<element name="LCLType"/>
<!-- unresolved type reference visibility: default -->
<element name="LMessages"/>
<!-- unresolved type reference visibility: default -->
<element name="LResources"/>
<!-- unresolved type reference visibility: default -->
<element name="Controls"/>
<!-- unresolved type reference visibility: default -->
<element name="StdCtrls"/>
<!-- unresolved type reference visibility: default -->
<element name="Graphics"/>
<!-- unresolved type reference visibility: default -->
<element name="Grids"/>
<!-- unresolved type reference visibility: default -->
<element name="Dialogs"/>
<!-- unresolved type reference visibility: default -->
<element name="Themes"/>
<!-- unresolved type reference visibility: default -->
<element name="Variants"/>
<!-- unresolved type reference visibility: default -->
<element name="Clipbrd"/>
<!-- unresolved type reference visibility: default -->
<element name="ImgList"/>
<!-- unresolved type reference visibility: default -->
<element name="Laz2_XMLCfg"/>
<!-- object visibility: default -->
<element name="EInvalidGridOperation">
<short>
Exception raised for an invalid grid operation
</short>
<descr>
<p>
<var>EInvalidGridOperation</var> is an Exception class raised when an invalid grid operations is performed.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TBookmarkList.CheckActive"/>
</seealso>
</element>
<!-- object visibility: default -->
<element name="TColumn">
<short>
Represents a display column in a database grid
</short>
<descr>
<p>
<var>TColumn</var> is a <var>TGridColumn</var> descendant that represents a display column in a database grid control. TColumn provides properties and methods needed to access and mantain the Dataset, Field, FieldName, and DisplayFormat for the column. TColumn provides overridden functions which implement facilities from the ancestor class.
</p>
<p>
TColumn instances can be created at run-time or design-time; properties are provided to indicate when the instance was created. The display order for columns need not correspond to the order of the Fields in the dataset, nor do all Fields in the dataset need to be represented by a display column.
</p>
<p>
TColumn instances are used as the collection item for the <var>TDBGridColumns</var> collection.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure type visibility: default -->
<element name="TDatasetScrolledEvent">
<short>
Specifies an event handler signalled after scrolling a dataset
</short>
<descr>
<p>
<var>TDatasetScrolledEvent</var> specifies an event handler signalled after scrolling a dataset.TDatasetScrolledEvent can be used to perform actions required when the position in the DataSet has changed.
</p>
<p>
DataSet is the TDataset instance for the event notification.
</p>
<p>
Distance indictates both the number of rows and the direction for the event notification, for example:
</p>
<dl>
<dt><b>Value</b></dt>
<dd><b>Meaning</b></dd>
<dt><var><0</var></dt>
<dd>Scroll toward the beginning of the DataSet</dd>
<dt><var>0</var></dt>
<dd>Current row in the DataSet has been refreshed</dd>
<dt><var>>0</var></dt>
<dd>Scroll toward the end of the DataSet </dd>
</dl>
<p>
TDatasetScrolledEvent is the type used for the OnDataSetScrolled property in TComponentDataLink.
</p>
<p>
See the TCustomDBGrid.OnDataSetScrolled procedure for an example implementation of TDatasetScrolledEvent.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TDatasetScrolledEvent.Dataset">
<short>Dataset for the event</short>
</element>
<!-- argument visibility: default -->
<element name="TDatasetScrolledEvent.Distance">
<short>Number of rows and direction for the event</short>
</element>
<!-- procedure type visibility: default -->
<element name="TFocusControlEvent">
<short>
Event handler signalled to coordinate Field selection and control focus
</short>
<descr>
<p>
<var>TFocusControlEvent</var> specifies an event handler signalled to coordinate Field selection and control focus.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TComponentDataLink.OnFocusControl"/>
<link id="#lcl.DBGrids.TCustomDBGrid.OnFocusControl"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TFocusControlEvent.aField">
<short>Field reference for the focus event</short>
</element>
<!-- procedure type visibility: default -->
<element name="TDBGridClickEvent">
<short>
Specifies an event handler signalled when a grid column in is clicked
</short>
<descr>
<p>
<var>TDBGridClickEvent</var> specifies an event handler signalled when a column in the database grid is clicked
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TDBGridClickEvent.Column">
<short>Column for the event</short>
</element>
<!-- procedure type visibility: default -->
<element name="TMovedEvent">
<short>
Specifies an event handler signalled when the display order of rows or columns is changed
</short>
<descr>
<p>
<var>TMovedEvent</var> specifies an event handler signalled when the display order of rows or columns is changed. TMovedEvent is the type used for the OnColumnMoved and OnRowMoved properties in TDBGrid.
</p>
</descr>
<seealso>
<linlk id="#lcl.DBGrids.TCustomDBGrid.OnColumnMoved"/>
<linlk id="#lcl.DBGrids.TCustomDBGrid.OnRowMoved"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TMovedEvent.Sender">
<short>Grid control for the event</short>
</element>
<!-- argument visibility: default -->
<element name="TMovedEvent.FromIndex">
<short>Previous ordinal position for the event</short>
</element>
<!-- argument visibility: default -->
<element name="TMovedEvent.ToIndex">
<short>New ordinal position for the event</short>
</element>
<!-- procedure type visibility: default -->
<element name="TDrawColumnCellEvent">
<short>
Specifies an event handler for drawing a cell in a grid control
</short>
<descr>
<p>
<var>TDrawColumnCellEvent</var> specifies an event handler used to draw a cell in a column for a grid control. TDrawColumnCellEvent is the type used for the OnDrawColumnCell property in TDBGrid, snd signalled from its DrawCell method.
</p>
</descr>
<seealso>
<link id ="#lcl.DBGrids.TCustomDBGrid.OnDrawColumnCell"/>
<link id ="#lcl.DBGrids.TCustomDBGrid.DrawCell"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TDrawColumnCellEvent.Sender">
<short>Grid control for the event`</short>
</element>
<!-- argument visibility: default -->
<element name="TDrawColumnCellEvent.Rect">
<short>Canvas rectangle where the cell is drawn</short>
</element>
<!-- argument visibility: default -->
<element name="TDrawColumnCellEvent.DataCol">
<short>Position of the Field used to get data for the event</short>
</element>
<!-- argument visibility: default -->
<element name="TDrawColumnCellEvent.Column">
<short>Column definition for the event`</short>
</element>
<!-- argument visibility: default -->
<element name="TDrawColumnCellEvent.State">
<short>Drawing state for the event</short>
</element>
<!-- procedure type visibility: default -->
<element name="TGetDbEditMaskEvent">
<short>
Specifies an event handler used to get the Edit Mask for a cell in a grid
</short>
<descr>
<p>
<var>TGetDbEditMaskEvent</var> specifies an event handler used to get the Edit Mask for a cell in a database grid control. TGetDbEditMaskEvent can be used to provide an edit mask for the specified Field. TGetDbEditMaskEvent is the type used for the OnFieldEditMask property in TDBGrid.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TCustomDBGrid.OnFieldEditMask"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TGetDbEditMaskEvent.Sender">
<short>Grid control for the event</short>
</element>
<!-- argument visibility: default -->
<element name="TGetDbEditMaskEvent.Field">
<short>Field for the event</short>
</element>
<!-- argument visibility: default -->
<element name="TGetDbEditMaskEvent.Value">
<short>Default value for the edit mask</short>
</element>
<!-- enumeration type visibility: default -->
<element name="TDBGridOption">
<short>
Enumerated type containing options available for a database grid
</short>
<descr>
<p>
<var>TDBGridOption</var> is an enumerated type containing options available for a database grid control. Each enumeration value indicates if the associated feature or behavior is enabled in a database grid control.
</p>
<p>
Values from the enumeration are store in the <var>TDBGridOptions</var> set type, and are used in the <var>TDBGrid.Options</var> property.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGridOptions" />
<link id="#lcl.DBGrids.TDBGrid.Options" />
</seealso>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgEditing">
<short>
Indicates cells in the grid can be edited
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgTitles">
<short>
Indicates titles are displayed for columns in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgIndicator">
<short>
Enables drawing of the row indicator for the currently selected row in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgColumnResize">
<short>
Indicates columns in the grid can be resized
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgColumnMove">
<short>
Indicates the order of columns in the grid can be changed
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgColLines">
<short>
Indicates vertical lines are drawn between columns in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgRowLines">
<short>
Indicates horizontal lines are drawn between rows in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgTabs">
<short>
Indicates the Tab key can be used to navigate between cells in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgAlwaysShowEditor">
<short>
Indicates an edit control is always displayed for the current cell in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgRowSelect">
<short>
Indicates the entire row is highlighted when selected
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgAlwaysShowSelection">
<short>
Indicates the current selection is displayed even when the control loses focus
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgConfirmDelete">
<short>
Indicates a confirmation dialog is required when deleting a record in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgCancelOnExit">
<short>
Indicates an active editing operation is cancelled when the control loses focus
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgMultiselect">
<short>
Indicates more than one cell or row can be selected in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgHeaderHotTracking">
<short>
Indicates column headers are highlighted when the column has mouse focus
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgHeaderPushedLook">
<short>
Indicates column headers are drawn with a button down appearance
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgPersistentMultiSelect">
<short>
Indicates multiple selections are retained even when the control loses focus
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgAutoSizeColumns">
<short>
Indicates columns are automatically resized to fit their content
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgAnyButtonCanSelect">
<short>
Indicates that any mouse button can change the selection in the grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgDisableDelete">
<short>
Indicates if deleting records with <var><b>Ctrl + Delete</b></var> is disabled
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgDisableInsert">
<short>
Indicates if inserting (or appending) records is disabled
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgCellHints">
<short>
Indicates if displaying a hint for an individual cell is enabled
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgTruncCellHints">
<short>
Indicates if cell hints are truncated when they are too long
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgCellEllipsis" dgCellEllipsis="dgCellEllipsis">
<short>
Indicates if an Ellipsis character is added to the end of cells longer than the display area for the cell
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgRowHighlight">
<short>
Indicates if the current row in the grid is higlighted instead of the current cell
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgThumbTracking">
<short>
Indicates if the current selection is changed when the mouse thumb wheel is scrolled
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgDblClickAutoSize">
<short>
Indicates if double clicking on borders or headers for a column causes it to be automatically resized to its contents
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDBGridOption.dgDisplayMemoText">
<short>
Indicates if memo content is displayed instead of the '(Memo)' string literal for ftMemo Fields
</short>
</element>
<!-- enumeration type visibility: default -->
<element name="TDbGridExtraOption">
<short>
Enumerated type that specifies extra options available in a database grid
</short>
<descr>
<p>
<var>TDbGridExtraOption</var> is an enumerated type that specifies extra options available in a database grid. Values from TDbGridExtraOption are stored in the <var>TDbGridExtraOptions</var> set type, and used in the <var>TDBGrid.OptionsExtra</var> property.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TCustomDBGrid.OptionsExtra"/>
<link id="#lcl.DBGrids.TDBGrid.OptionsExtra"/>
</seealso>
</element>
<!-- enumeration value visibility: default -->
<element name="TDbGridExtraOption.dgeAutoColumns">
<short>
Indicates if Fields in the dataset are automatically added as columns in the database grid
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDbGridExtraOption.dgeCheckboxColumn">
<short>
Indicates that checkbox controls are used to edit Boolean Fields in the grid dataset
</short>
</element>
<!-- set type visibility: default -->
<element name="TDbGridExtraOptions">
<short>
<var>TDbGridExtraOptions</var> is a set of values from the <var>TDbGridExtraOption</var> enumeration
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- set type visibility: default -->
<element name="TDbGridOptions">
<short>
Stores values from the <var>TDbGridOption</var> enumeration
</short>
<descr>
<var>TDbGridOptions</var> is a set type used to store values from the <var>TDbGridOption</var> enumeration. <var>TDbGridOptions</var> is the trype used for the <var>TDBGrid.Options</var> property.
</descr>
<seealso>
<link id="TCustomDBGrid.Options"/>
<link id="TDBGrid.Options"/>
</seealso>
</element>
<!-- enumeration type visibility: default -->
<element name="TDbGridStatusItem">
<short>
Enumerated type with values for status messages in a database grid
</short>
<descr>
<p>
<var>TDbGridStatusItem</var> is an enumerated type with values for status messages used in a database grid. Values from TDbGridStatusItem are stored in <var>TDbGridStatus</var>, and used in the <var>TDBGrid.GridStatus</var> property.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDbGridStatus" />
<link id="#lcl.DBGrids.TCustomDBGrid.GridStatus" />
<link id="#lcl.DBGrids.TDBGrid.GridStatus" />
</seealso>
</element>
<!-- enumeration value visibility: default -->
<element name="TDbGridStatusItem.gsUpdatingData">
<short>
Indicates the grid is updating after a change in data
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDbGridStatusItem.gsAddingAutoColumns">
<short>
Indicates automatic columns are being added for the grid control
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDbGridStatusItem.gsRemovingAutoColumns">
<short>
Indicates automatic columns are being removed from the grid control
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDbGridStatusItem.gsAutoSized">
<short>
Indicates automatically sized columns are currently in use in the grid control
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDbGridStatusItem.gsStartEditing">
<short>
Indicates the data link for a grid control is updating the value in its Editing property
</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TDbGridStatusItem.gsLoadingGrid">
<short>
Indicates the grid control is loading its settings from a file or stream
</short>
</element>
<!-- set type visibility: default -->
<element name="TDbGridStatus">
<short>
Set type used to store <var>TDbGridStatusItem</var> enumeration values
</short>
<descr>
<p>
<var>TDbGridStatus</var> is a set type used to store <var>TDbGridStatusItem</var> enumeration values. Values added to TDbGridStatus indicate that a feature or behavior has been enabled in a TDBGrid control.
</p>
<p>
TDbGridStatus is used to implement the <var>TDBGrid.GridStatus</var> property.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDbGridStatusItem" />
<link id="#lcl.DBGrids.TCustomDBGrid.GridStatus" />
<link id="#lcl.DBGrids.TDBGrid.GridStatus" />
</seealso>
</element>
<!-- procedure type visibility: default -->
<element name="TDbGridSelEditorEvent">
<short>
Specifies an event handler used to select a cell editor in a database grid
</short>
<descr>
<p>
<var>TDbGridSelEditorEvent</var> specifies an event handler used to
select an editor for a cell in a database grid.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGrid.OnSelectEditor" />
<link id="#lcl.DBGrids.TDBGrid.SelectEditor" />
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TDbGridSelEditorEvent.Sender">
<short>Control signalling the event</short>
</element>
<!-- argument visibility: default -->
<element name="TDbGridSelEditorEvent.Column">
<short>Column for the control</short>
</element>
<!-- argument visibility: default -->
<element name="TDbGridSelEditorEvent.Editor">
<short>Editor for the specified column</short>
</element>
<!-- procedure type visibility: default -->
<element name="TPrepareDbGridCanvasEvent">
<short>
Specifies an event handler which prepares the canvas for drawing a database grid
</short>
<descr>
<p>
<var>TPrepareDbGridCanvasEvent</var> specifies an event handler used to prepare the canvas which draws the content in a database grid. TPrepareDbGridCanvasEvent allows an application to override or enhance the drawing behavior of cells in a database grid.
</p>
<var>TPrepareDbGridCanvasEvent</var> is used to implement the <var>OnPrepareCanvas</var> event handler in <var>TDBGrid</var>.
<p>
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGrid.OnPrepareCanvas" />
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TPrepareDbGridCanvasEvent.Sender">
<short>Control signalling the event</short>
</element>
<!-- argument visibility: default -->
<element name="TPrepareDbGridCanvasEvent.DataCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TPrepareDbGridCanvasEvent.Column">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TPrepareDbGridCanvasEvent.AState">
<short>Drawing state for the selection</short>
</element>
<!-- enumeration type visibility: default -->
<element name="TBookmarkedRecordEnumeratorOptions">
<short>
Enumeration with option values for the bookmarked record enumerator
</short>
<descr>
<p>
<var>TBookmarkedRecordEnumeratorOptions</var> is a set type with option values that control the actions performed in <var>TBookmarkedRecordEnumerator</var>.
TBookmarkedRecordEnumeratorOptions is the type used to implement the <var>TBookmarkedRecordEnumerator.Options</var> property.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TBookmarkedRecordEnumerator"/>
<link id="#lcl.DBGrids.TBookmarkedRecordEnumerator.Options"/>
</seealso>
</element>
<!-- enumeration value visibility: default -->
<element name="TBookmarkedRecordEnumeratorOptions.breDisableDataset">
<short>Disables controls attached to the dataset</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TBookmarkedRecordEnumeratorOptions.breStopOnInvalidBookmark">
<short>Stops enumerating when an invalid bookmark is encountered</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TBookmarkedRecordEnumeratorOptions.breRestoreCurrent">
<short>Restores the current bookmark when exiting the enumerator</short>
</element>
<!-- object visibility: default -->
<element name="TBookmarkedRecordEnumerator">
<short>Defines a bookmarked record enumeration class</short>
<descr>
<p>
<var>TBookmarkedRecordEnumerator</var> is a Class which defines a bookmarked record enumerator for use with <var>TBookmarklist</var>.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TBookmarkList"/>
</seealso>
</element>
<!-- variable visibility: private -->
<element name="TBookmarkedRecordEnumerator.fBookmarkList"/>
<!-- variable visibility: private -->
<element name="TBookmarkedRecordEnumerator.fBookmarkIndex"/>
<!-- variable visibility: private -->
<element name="TBookmarkedRecordEnumerator.fCurrent"/>
<!-- variable visibility: private -->
<element name="TBookmarkedRecordEnumerator.fBook"/>
<!-- variable visibility: private -->
<element name="TBookmarkedRecordEnumerator.fDataset"/>
<!-- variable visibility: private -->
<element name="TBookmarkedRecordEnumerator.fOptions"/>
<!-- constructor visibility: public -->
<element name="TBookmarkedRecordEnumerator.Create">
<short>
Constructor for the class instance
</short>
<descr>
<p>
<var>Create</var> is the constructor for the class instance. Create calls the inherited constructor, and stores the arguments to the method in its BookmarkList, Dataset, and Options properties.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkedRecordEnumerator.Create.bookList">
<short>Bookmark list for the enumerator</short>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkedRecordEnumerator.Create.aGrid">
<short>Grid control for the enumerator</short>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkedRecordEnumerator.Create.anOptions">
<short>Options for the enumerator</short>
</element>
<!-- destructor visibility: public -->
<element name="TBookmarkedRecordEnumerator.Destroy">
<short>
Destructor for the class instance
</short>
<descr>
<p>
<var>Destroy</var> is the destructor for the class instance. Destroy uses values in the Options property to perform actions needed before the class instance is freed, including:
</p>
<ul>
<li>Restore the dataset to its Bookmark position</li>
<li>Re-enable controls attached to the dataset if disabed</li>
</ul>
<p>
Destroy calls the inherited destructor before exit.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: public -->
<element name="TBookmarkedRecordEnumerator.MoveNext">
<short>
Moves to the next bookmark in the list
</short>
<descr>
<p>
<var>MoveNext</var> is a Boolean function used to move the enumerator to the next item in the bookmark list. Move next increments the value in BookmarkIndex, and examines the Options property to see if any actions are required, such as: setting the value of the Current Bookmark before navigation, or disabling controls attached to the dataset.
</p>
<p>
MoveNext updates the current bookmark and checks the dataset to see if the bookmark is still valid. The return value is False if the record for the bookmark no longer exists in the dataset and Options indicates the enumertor should halt for an invalid bookmark. False is also returned when the value in BookmarkIndex exceeds the number of items in the BookmarkList.
</p>
<p>
The return value is True when the action has been performed successfully.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkedRecordEnumerator.MoveNext.Result">
<short>True when the action has been performed successfully</short>
</element>
<!-- function visibility: public -->
<element name="TBookmarkedRecordEnumerator.GetEnumerator">
<short>
Returns the current class instance
</short>
<descr>
<p>
<var>GetEnumerator</var> is a TBookmarkedRecordEnumerator function used to the current class instance.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkedRecordEnumerator.GetEnumerator.Result">
<short>The current class instance</short>
</element>
<!-- property visibiity: public -->
<element name="TBookmarkedRecordEnumerator.Current">
<short>
Current bookmark for the enumerator
</short>
<descr>
<p>
<var>Current</var> is a read-only TBookmark property which returns the current bookmark for the enumerator. The value in Current in updated when the MoveNext method is called.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibiity: public -->
<element name="TBookmarkedRecordEnumerator.Options">
<short>
Controls the actions performed when Bookmarks are visited
</short>
<descr>
<p>
<var>Options</var> is a TBookmarkedRecordEnumeratorOptions property which controls the actions performed when Bookmarks in the enumerator are visited. Values are included in the set type to enable the corresponding feature in the enumerator.
</p>
<p>
See TBookmarkedRecordEnumeratorOptions for more information about option values and their meanings.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TBookmarkedRecordEnumeratorOptions"/>
</seealso>
</element>
<!-- object visibility: default -->
<element name="TBookmarkList">
<short>
<var>TBookmarkList</var> implements a list of Bookmarks in a database grid
</short>
<descr>
<p>
<var>TBookmarkList</var> is a class used to implement a list of Bookmarks in a database grid. <var>TBookmarkList</var> is the type used for the <var>SelectedRows</var> property in <var>TDBGrid</var>.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGrid.SelectedRows" />
</seealso>
</element>
<!-- variable visibility: private -->
<element name="TBookmarkList.FList"/>
<!-- variable visibility: private -->
<element name="TBookmarkList.FGrid"/>
<!-- function visibility: private -->
<element name="TBookmarkList.GetCount">
<short>
Gets the value for the Count property
</short>
<descr>
<var>GetCount</var> is an Integer function that implements the read access specifier for the Count property. Use the Items property to access TBookmark instances stored in the list.
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkList.GetCount.Result">
<short>Number of bookmarks in the list</short>
</element>
<!-- function visibility: private -->
<element name="TBookmarkList.GetCurrentRowSelected">
<short>
Gets the value in the for the CurrentRowSelected property
</short>
<descr>
<p>
<var>GetCurrentRowSelected</var> is a Boolean function that implements the read access specifier for the CurrentRowSelected property. GetCurrentRowSelected calls the CheckActive method to ensure that the Dataset for the list is properly configured. See CheckActive for more information.
</p>
<p>
The return value is True when a TBookmark instance for the current row already exists in the list.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkList.GetCurrentRowSelected.Result">
<short>True when abookmark for the current row already exists in the list</short>
</element>
<!-- function visibility: private -->
<element name="TBookmarkList.GetItem">
<short>
Gets the value for the bookmark stored at the specified position in the list
</short>
<descr>
<p>
<var>GetItem</var> is a TBookmark function that implements the read access specifier for the Items property. GetItems returns the bookmark stored at the specified ordinal position in the list. AIndex is the ordinal position to retrieve in the range <var>0 .. Count - 1</var>. Use the Items property to access the bookmarks stored in the list.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkList.GetItem.Result">
<short>The bookmark at the specified position</short>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkList.GetItem.AIndex">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TBookmarkList.SetCurrentRowSelected">
<short>
Sets the value in the CurrentRowSelected property
</short>
<descr>
<p>
<var>SetCurrentRowSelected</var> is a procedure which provides` write access for the CurrentRowSelected property. SetCurrentRowSelected gets a bookmark for the current row, and calls Find to determine if the bookmark already exists in the list. When AValue contains False, n existing bookmark is freed and removed from the bookmark list. A Bookmark not in the list is created and added when AValue is True.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkList.SetCurrentRowSelected.AValue">
<short>
True to select the current row. False to de-selected the current row
</short>
</element>
<!-- procedure visibility: private -->
<element name="TBookmarkList.CheckActive">
<short>
Ensures that the dataset for the bookmark list is properly configure and active
</short>
<descr>
<p>
CheckActive is a procedure used to ensure that the bookmark list is active and properly configured. CheckActive examines the DataLInk for the Grid to determine if it is active. An EInvalidGridOperation exception is raised if the dataset is not already active.
</p>
<p>
CheckActive compares the datasets in the bookmark list and the associated Grid control. If they are the same Dataset no additional processing is performed in the method. Otherwise the Dataset for the bookmark list is set to the Dataset from the associated Grid control.
</p>
</descr>
<errors>
<dl>
<dt>EInvalidGridOperation</dt>
<dd>
Raised when the DataLink in the Grid control has an inactive Dataset;
exception message is 'Dataset Inactive'.
</dd>
</dl>
</errors>
<seealso></seealso>
</element>
<!-- constructor visibility: public -->
<element name="TBookmarkList.Create">
<short>
<var>Create</var> is the constructor for TBookmarkList
</short>
<descr>
<p>
<var>Create</var> is the constructor for TBookmarkList class instance. Create calls the inherited constructor. Create stores the AGrid argument internally to keep an association to the grid for the Book`marks. Finally Create initializes the internal list used to store Bookmarks added to the class instance.
</p>
</descr>
<seealso>
<link id="#rtl.System.TObject.Create">TObject.Create</link>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkList.Create.AGrid">
<short>Grid control that owns the bookmark list</short>
</element>
<!-- destructor visibility: public -->
<element name="TBookmarkList.Destroy">
<short>
<var>Destroy</var> is the destructor for <var>TBookmarkList</var>
</short>
<descr>
<p>
<var>Destroy</var> is an overridden destructor for the <var>TBookmarkList</var> class instance. Destroy ensures that <var>TBookmark</var> items are removed from the list and freed before the list is freed. Destroy calls the inherited destructor.
</p>
</descr>
<seealso>
<link id="#rtl.System.TObject.Destroy">TObject.Destroy</link>
<link id="#lcl.DBGrids.TBookmark" />
</seealso>
</element>
<!-- procedure visibility: public -->
<element name="TBookmarkList.Clear">
<short>
<var>Clear</var> removes all Items in the bookmark list
</short>
<descr>
<p>
<var>Clear</var> is a procedure used to remove all of the Items stored in the list. Clear calls the TDataset.FreeBookmsark method for each of the TBookmark instances in Items. The length of the Bookmark is set to 0 to decrease the reference count for the memory allocation.
</p>
<p>
Clear uses the Invalidate method in the associated Grid control to force it to be redrawn.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: public -->
<element name="TBookmarkList.Delete">
<short>
Deletes rows in the Dataset represented by bookmarks in the list
</short>
<descr>
<p>
<var>Delete</var> is a procedure used to delete rows in the Dataset represented by bookmarks in the list. Delete processes the Items in the list in reverse order. Each bookmark is located in the Dataset and the TDataset.Delete method is called to remove the data from the dataset. The Dataset.FreeBookmark method is called to remove the Bookmark and it is removed from the Items in the list.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: public -->
<element name="TBookmarkList.Find">
<short>
<var>Find</var> locates the specified Bookmark and its position in the list
</short>
<descr>
<p>
<var>Find</var> is a Boolean function used to locate the specified bookmark in the Items for the bookmark list. AIndex contains the position in the list where the bookmark was located. The return value is True when the specified bookmark is located in the bookmark list.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkList.Find.Result">
<short>True when the bookmark is located in the list</short>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkList.Find.Item">
<short>Bookmark to locate</short>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkList.Find.AIndex">
<short>Position in the list for the bookmark</short>
</element>
<!-- function visibility: public -->
<element name="TBookmarkList.IndexOf">
<short>
<var>IndexOf</var> returns the ordinal position for the specifed Bookmark in the list
</short>
<descr>
<p>
<var>IndexOf</var> is an Integer function used to get the ordinal position in the list for the specifed Bookmark. The return value contains the position in the list where the TBookmark instance was located. IndexOf calls Find to locate the bookmark and to capture the return value for the method. The return value is in the range <var>0..Count-1</var> when the bookmark exists in the list or <var>-1</var> when the bookmark is not found.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkList.IndexOf.Result">
<short>Position in the list for the bookmark</short>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkList.IndexOf.Item">
<short>Bookmark to find in the list</short>
</element>
<!-- function visibility: public -->
<element name="TBookmarkList.Refresh">
<short>
Searches for and removes invalid Bookmarks in the list
</short>
<descr>
<p>
<var>Refresh</var> searches for and removes invalid Bookmarks in the list; returns True if the action was successful.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkList.Refresh.Result">
<short>True when the refresh action was successful</short>
</element>
<!-- property visibility: public -->
<element name="TBookmarkList.Count">
<short>
Indicates the number of Bookmarks in the list
</short>
<descr>
<p>
<var>Count</var> is a read-only Integer property that indicates the number of Bookmarks in the list. GetCount is the read access specifier for the property value.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TBookmarkList.CurrentRowSelected">
<short>
Indicates if the current row in the Dataset is selected
</short>
<descr>
<p>
<var>CurrentRowSelected</var> is a Boolean property that indicates if the current row in the Dataset is selected.
</p>
<p>
GetCurrentRowSelected is the read access specifier for the property value. GetCurrentRowSelected checks to see if the Bookmark for the current row exists in BookmarkList.
</p>
<p>
SetCurrentRowSelected is the write access specifier for the property value. SetCurrentRowSelected tries to locate a Bookmark for the current row in the Dataset, and adds or removes the Bookmark based on the AValue argument. The Grid control is redrawn after changing the selection state for the row.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TBookmarkList.GetCurrentRowSelected"/>
<link id="#lcl.DBGrids.TBookmarkList.SetCurrentRowSelected"/>
</seealso>
</element>
<!-- property visibility: public -->
<element name="TBookmarkList.Items">
<short>
Provides indexed access to Bookmarks in the list
</short>
<descr>
<p>
<var>Items</var> is a read-only TBookmark property that provides indexed access to Bookmarks in the list. Bookmarks can be accessed by their ordinal position in the list (in the range <var>0..Count-1</var>).
</p>
<p>
GetItem is the read access specifier for the Items property, and retrieves the TBookmark stored at the specified position in the list.
</p>
<p>
Items is the default property in TBookmarkList.
</p>
<p>
Use CurrentSelectedRow, Clear, Delete, and Refresh to maintain bookmarks stored in the list.
</p>
</descr>
<seealso>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkList.Items.AIndex">
<short>Ordinal position for the bookmark to retrieve from the list</short>
</element>
<!-- function visibility: public -->
<element name="TBookmarkList.GetEnumerator">
<short>
Gets an enumerator for the bookmark list
</short>
<descr>
<p>
<var>GetEnumerator</var> is a TBookmarkedRecordEnumerator function used to get an enumerator for bookmarked records in the list. GetEnumerator creates an instance of TBookmarkedRecordEnumerator with the specified arguments, and uses the instance as the return value for the method.
</p>
</descr>
<seeslo>
<link id="#lcl.DBGrids.TBookmarkedRecordEnumerator"/>
</seeslo>
</element>
<!-- function result visibility: default -->
<element name="TBookmarkList.GetEnumerator.Result">
<short>The bookmark list enumerator</short>
</element>
<!-- argument visibility: default -->
<element name="TBookmarkList.GetEnumerator.opt">
<short>Options to use in the bookmark list enumerator</short>
</element>
<!-- enumeration type visibility: default -->
<element name="TColumnOrder">
<short>
Enumerated type defining alternate ordering for columns
</short>
<descr>
<p>
<var>TColumnOrder</var> is an enumerated type which defines alternate ordering for columns in a collection. The values specify whether the design-time or run-time index for columns is used when ordering TColumn instances in the TDBGridColumns collection.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn"/>
<link id="#lcl.DBGrids.TDBGridColumns"/>
<link id="#lcl.DBGrids.TDBGrid.Columns"/>
</seealso>
</element>
<!-- enumeration value visibility: default -->
<element name="TColumnOrder.coDesignOrder">
<short>Columns are ordered using the DesignIndex</short>
</element>
<!-- enumeration value visibility: default -->
<element name="TColumnOrder.coFieldIndexOrder">
<short>Columns are order by the Index for the Field</short>
</element>
<!-- TComponentDataLink starts here -->
<!-- object visibility: default -->
<element name="TComponentDataLink" link="#fcl.DB.TDataLink">
<short>
Maintains an association between a component and a dataset
</short>
<descr>
<p>
<var>TComponentDataLink</var> is a TDatalink descendant that maintains an association between a component and its linked dataset. TComponentDataLink coordinates the actions of the component and the dataset, and allows the component to respond to data events. TComponentDataLink defines event handlers which can be used forward dataset events to the component implementation.
</p>
<p>
TComponentDataLink is the type used to implement the <var>TDBGrid.DataLink</var> property.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TCustomDBGrid.DataLink"/>
<link id="#lcl.DBGrids.TDBGrid.DataLink"/>
</seealso>
</element>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FDataset"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FDatasetName"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FModified"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnDatasetChanged"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnDataseClose"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnDataseOpen"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnDataseScrolled"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnFocusControl"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnEditingChanged"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnInvalidDataset"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnInvalidDataSource"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnLayoutChanged"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnNewdataset"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnRecordChanged"/>
<!-- variable visibility: private -->
<element name="TComponentDataLink.FOnUpdateData"/>
<!-- function visibility: private -->
<element name="TComponentDataLink.GetDatasetName">
<short>
Gets the value for the DatasetName property
</short>
<descr>
<p>
<var>GetDatasetName</var> is a String function that provides the value for the DataSetName property. GetDatasetName returns the value in the Name property for the DataSet.
</p>
<p>
Use DatasetName to read or write the value for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TComponentDataLink.GetDatasetName.Result">
<short>Name for the linked dataset</short>
</element>
<!-- function visibility: private -->
<element name="TComponentDataLink.GetFields">
<short>
Gets the Field at the specified position
</short>
<descr>
<p>
<var>GetFields</var> is a TField function that implements read access for the Fields property. GetFields returns the TField instance at the specified position in the Fields for the dataset. The return value is <var><b>Nil</b></var> if Index is not in the range 0..FieldCount-1.
</p>
<p>
Use Fields to read or write values in the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TComponentDataLink.GetFields.Result">
<short>Field stored at the specified position</short>
</element>
<!-- argument visibility: default -->
<element name="TComponentDataLink.GetFields.Index">
<short>Position to get from the Fields in the dataset</short>
</element>
<!-- procedure visibility: private -->
<element name="TComponentDataLink.SetDatasetName">
<short>
Sets the name for the dataset
</short>
<descr>
<p>
<var>SetDatasetName</var> is a procedure used to store the specified value in the DatasetName property. SetDatasetName is the write access specifier for the DatasetName property. The value in AValue is stored in the member variable for the class instance. It does not change the value stored the linked TDataset.
</p>
<p>
Use DatasetName to read or write the value for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TComponentDataLink.SetDatasetName.AValue">
<short>Name to use for the dataset</short>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.RecordChanged">
<short>
Signals the <var>OnRecordChanged</var> event handler when assigned
</short>
<descr>
<p>
<var>RecordChanged</var> is an overridden procedure used to signal the OnRecordChanged event handler when the specified Field is changed. RecordChanged calls the event handler when it has been assigned in the class instance. No action is performed when OnRecordChanged has not been assigned.
</p>
</descr>
<seealso>
<link id="#fcl.db.TDataLink.RecordChanged"/>
<link id="#lcl.DBGrids.TComponentDataLink.OnRecordChanged"/>
<link id="#lcl.DBGrids.TDBGrid.OnRecordChanged"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TComponentDataLink.RecordChanged.Field">
<short>Modified Field for the event notification</short>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.DatasetChanged">
<short>
Signals the <var>OnDatasetChanged</var> event handler when assigned
</short>
<descr>
<p>
<var>DatasetChanged</var> is a procedure used to signal the OnDatasetChanged event handler when the dataset has been changed. DatasetChanged calls the event handler when it has been assigned in the class instance. No action is performed when OnDatasetChanged has not been assigned.
</p>
</descr>
<seealso>
<link id="#fcl.db.TDataLink.DatasetChanged"/>
<link id="#lcl.DBGrids.TComponentDataLink.OnDatasetChanged"/>
<link id="#lcl.DBGrids.TDBGrid.OnDatasetChanged"/>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.ActiveChanged">
<short>
Signals an event handler when the Active property is changed
</short>
<descr>
<p>
<var>ActiveChanged</var> is a procedure used to call event handlers when the value in Active is changed.
</p>
<p>
When Active contains True, the Dataset for the class is read and compared to the value in the DatasetName property. When it diifers from the stored value the change is for a new dataset, and the OnNewDataset event handler is signalled. If DatasetName is the same as the stored value, the OnDataseOpen event handler is signalled.
</p>
<p>
When Active contains False, the Datasource and Dataset are checked to ensure that the contain valid class instances. If Datasource is unassigned, the OnInvalidDataSource event handler is signalled. If Dataset is unassigned, the Dataset is being freed, the OnInvalidDataSet event handler is signalled. If Dataset is assigned, the dataset has been closed and the OnDataSetClose event handler is signalled.
</p>
</descr>
<seealso>
<link id="#fcl.db.TDataLink.ActiveChanged"/>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.LayoutChanged">
<short>
Signals the OnLayoutChanged event hander when assigned
</short>
<descr>
<p>
<var>LayoutChanged</var> is a procedure used to signal the OnLayoutChanged event hander when assigned in the class instance.
</p>
</descr>
<seealso>
<link id="#fcl.db.TDataLink.LayoutChanged"/>
<link id="#lcl.DBGrids.TDBGrid.OnLayoutChanged"/>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.DatasetScrolled">
<short>
Signals the OnDataSetScrolled event handler when assigned
</short>
<descr>
<p>
<var>DatasetScrolled</var> is a procedure used to signal the OnDataSetScrolled event handler when it has been assigned in the class instance.
</p>
</descr>
<seealso>
<link id="#fcl.db.TDataLink.DatasetScrolled"/>
<link id="#lcl.DBGrids.TDBGrid.OnDataSetScrolled"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TComponentDataLink.DatasetScrolled.Distance">
<short>Number of records for the event notification</short>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.FocusControl" link="#fcl.db.TDataLink.FocusControl">
<short>
Signal the OnFocusControl event handler when assigned
</short>
<descr>
<p>
<var>FocusControl</var> is a procedure used to signal the OnFocusControl event handler when assigned in the class instance.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TComponentDataLink.FocusControl.Field">
<short>Field receiving focus in the event notification</short>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.CheckBrowseMode" link="#fcl.db.TDataLink.CheckBrowseMode">
<short>
Calls the inherited method
</short>
<descr>
<p>
<var>CheckBrowseMode</var> is a procedure used to call the inherited method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.EditingChanged">
<short>
Signals the OnEditingChanged event handler when assigned
</short>
<descr>
<p>
<var>EditingChanged</var> is a procedure used to signal the OnEditingChanged event handler when assigned in the class instance.
</p>
</descr>
<seealso>
<link id="#fcl.db.TDataLink.EditingChanged">TDataLink.EditingChanged</link>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TComponentDataLink.UpdateData">
<short>
Signals the OnUpdateData event handler when assigned
</short>
<descr>
<p>
<var>UpdateData</var> is a procedure used to signal the OnUpdateData event handler when assigned in the class instance.
</p>
</descr>
<seealso>
<link id="#fcl.db.TDataLink.UpdateData">TDataLink.UpdateData</link>
</seealso>
</element>
<!-- function visibility: protected -->
<element name="TComponentDataLink.MoveBy" link="#fcl.db.TDataLink.MoveBy">
<short>
Moves the position in the dataset by the specified number of rows
</short>
<descr>
<p>
<var>MoveBy</var> is an Integer function used to move the current position in the dataset by the specified number of rows. MoveBy calls the inherited method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TComponentDataLink.MoveBy.Result">
<short>Actual number of rows moved in the method</short>
</element>
<!-- argument visibility: default -->
<element name="TComponentDataLink.MoveBy.Distance">
<short>Number of rows to move in the dataset</short>
</element>
<!-- procedure visibility: public -->
<element name="TComponentDataLink.Modified">
<short>
Indicates if the component or the linked dataset has been changed
</short>
<descr>
<p>
<var>Modified</var> is a Boolean property that indicates if the component or the linked dataset has been changed.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnRecordChanged">
<short>
<var>OnRecordChanged</var> - event handler for a change in the current record
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnDatasetChanged">
<short>
<var>OnDataseChanged</var> - event handler for a change in the attached Data Set
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnNewdataset">
<short>
<var>OnNewdataset</var> - event handler for formation of a link to a new data
set
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnDatasetOpen">
<short>
<var>OnDataseOpen</var> - event handler when the data set is open
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnInvalidDataset">
<short>
<var>OnInvalidDataset</var> - event handler when the data set is non-valid
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnInvalidDataSource">
<short>
<var>OnInvalidDataSource</var> - event handler when the data source is non-valid
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnFocusContol">
<short>Event handler signalled when the grid control receives focus</short>
<descr>
<p>
<var>OnFocusControl</var> is a TFocusControlEvent property that implements abn event handler signalled when the grid control receives focus.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.`TFocusControlEvent"/>
</seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnLayoutChanged">
<short>
<var>OnLayoutChanged</var> - event handler when the layout of the data set has
changed
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnDatasetClose">
<short>
<var>OnDataseClose</var> - event handler when the data set is closed
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnDatasetScrolled">
<short>
<var>OnDataseScrolled</var> - event handler when the data set is scrolled
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnEditingChanged">
<short>
<var>OnEditingChanged</var> - event handler for a change in the
<var>Editing</var> property
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.OnUpdateData">
<short>
<var>OnUpdateData</var> - event handler for implementing any pending changes to
data
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.DatasetName">
<short>
<var>DatasetName</var> - the (string) name of the attached dataset
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.Fields">
<short>
<var>Fields</var> - an indexed array containing the Fields of the dataset
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TComponentDataLink.Fields.Index">
<short></short>
</element>
<!-- property visibility: public -->
<element name="TComponentDataLink.VisualControl" link="#fcl.db.TDataLink.VisualControl">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- TColumnTitle -->
<!-- object visibility: default -->
<element name="TColumnTitle">
<short>
<var>TColumnTitle</var> is a <var>TGridColumnTitle</var> descendant
</short>
<descr>
<p>
<var>TColumnTitle</var> is a <var>TGridColumnTitle</var> descendant which
ensures the correct caption is used as the title for a column in a
data-aware grid.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: protected -->
<element name="TColumnTitle.GetDefaultCaption">
<short>Gets the default caption used as the title for the grid column</short>
<descr>
<p>
<var>GetDefaultCaption</var> is an overridden String function in
<var>TColumnTitle</var> which provides the default caption used as the title
for a grid column.
</p>
<p>
If a Field has been created for the column, the value of its DisplayName
property are used as the caption. If only the FieldName property is set, it is
used as the caption. Otherwise, the inherited method is called to get the
default caption for the column.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumnTitle.GetDefaultCaption"/>
<link id="#lcl.DBGrids.TColumn"/>
<link id="#fcl.db.TField"/>
</seealso>
</element>
<!-- function result visibility: defult -->
<element name="TColumnTitle.GetDefaultCaption.Result">
<short>Default value used as the title for the column</short>
</element>
<!-- TColumn starts here -->
<!-- object visibility: default -->
<element name="TColumn">
<short>
Implements a display column for the TDBGrid control
</short>
<descr>
<p>
<var>TColumn </var> is a TGridColumn descendant which implements a display column for the TDBGrid grid control. TColumn extends the ancestor class to provide support for using TField for data access, display formatting, alignment, as well as use of checkbox and lookuplist Fields. TColumn also implements support for features in TDBGrid like: automatic rows, and design-time vs run-time column ordering.
</p>
<p>
TColumn is the class type used for items in the TDBGridColumns collection.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGridColumns"/>
<link id="#lcl.DBGrids.TCustomDBGrid.Columns"/>
<link id="#lcl.Grids.TGridColumn"/>
<link id="#fcl.DB.TField"/>
<link id="#fcl.DB.TDataset"/>
</seealso>
</element>
<!-- variable visibility: private -->
<element name="TColumn.FDisplayFormat"/>
<element name="TColumn.FDisplayFormatChanged"/>
<element name="TColumn.FFieldName"/>
<element name="TColumn.FField"/>
<element name="TColumn.FIsAutomaticColumn"/>
<element name="TColumn.FDesignIndex"/>
<!-- procedure visibility: private -->
<element name="TColumn.ApplyDisplayFormat">
<short>
Applies a new display format to the Field which gets data for the column
</short>
<descr>
<p>
<var>ApplyDisplayFormat</var> is a procedure used to apply a new value in DisplayFormat to the Field used to get data for the column. Field must contain a valid TField instance, or no actions are performed in the method.
</p>
<p>
ApplyDisplayFormat ensures that the new value for DisplayFormat is properly applied to Fields using the TNumericField or TDateTimeField class types. ApplyDisplayFormat is used in the implementation of the LinkField method.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.LinkField"/>
</seealso>
</element>
<!-- function visibility: private -->
<element name="TColumn.GetDataset">
<short>Gets the Dataset for the column</short>
<descr>
<p>
<var>GetDataset</var> is a TDataset function used to get the dataset which provides data for the column. GetDataset uses Grid (cast to a TCustomDBGrid instance) to access its DataLink and get the DataSet for the column definition. The return value is <var><b>Nil</b></var> if Grid has not been assigned for the column.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumn.Grid"/>
<link id="#lcl.Grids.TCustomDBGrid"/>
<link id="#fcl.db.TDataset"/>
<link id=""/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDataset.Result">
<short>Dataset for the column definition</short>
</element>
<!-- function visibility: private -->
<element name="TColumn.GetDisplayFormat">
<short>
Get the value for the DisplayFormat property
</short>
<descr>
<p>
<var>GetDisplayFormat</var> is a String function used to get the value for the DisplayFormat property. The value in the member variable is returned when it is different than the stored value for DisplayFormat. Otherwise, the value from GetDefaultDisplayFormat is used as the return value.
</p>
<p>
Use DisplayFormat to read and write the value for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDisplayFormat.Result">
<short>Value for the DisplayFormat property</short>
</element>
<!-- function visibility: private -->
<element name="TColumn.GetField">
<short>
Gets the value for the Field property
</short>
<descr>
<p>
<var>GetField</var> is a TField function used to get the vaue for the Field property. GetField ensures that Field has been assigned, and that FieldName has been set for the class instance. The LinkField method is called to find and store the TField instance used as the return value for the method. The return value is <var><b>Nil</b></var> if a Field with the name in FieldName cannot be found.
</p>
<p>
Use Field to read or write the value in the property.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.Field"/>
<link id="#lcl.DBGrids.TColumn.LinkField"/>
<link id="#fcl.db.TField"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetField.Result">
<short>Field used to access data for the column</short>
</element>
<!-- function visibility: private -->
<element name="TColumn.GetIsDesignColumn">
<short>
Gets the value for the IsDesignColumn property
</short>
<descr>
<p>
<var>GetIsDesignColumn</var> is a Boolean function used to get the value for the IsDesignColumn property. The return value is True when DesignIndex contains a value in the range 0..9999.
</p>
<p>
Use IsDesignColumn to read the value for the property.
</p>
<note>
The upper range for DesignIndex is a result of the value assigned in Create. The value 10000 is used in the property when Grid has not assigned for the collection, or Grid includes csLoading in its ComponentState property.
</note>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGridColumns"/>
<link id="#lcl.DBGrids.TCustomDBGrid.Columns"/>
<link id="#lcl.DBGrids.TColumn.DesignIndex"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetIsDesignColumn.Result">
<short>Value for the IsDesignColumn property</short>
</element>
<!-- function visibility: private -->
<element name="TColumn.IsDisplayFormatStored">
<short>
Determines the storage specifier for the DisplayFormat property
</short>
<descr>
<p>
<var>IsDisplayFormatStored</var> is a Boolean function used as the storage specifier for the DisplayFormat property. The return value is True if the member variable for the DisplayFormat property is different than the one used for the Field.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.IsDisplayFormatStored.Result">
<short>
True when DisplayFormat is different the one used for the Field
</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TColumn.SetDisplayFormat">
<short>
Sets the value in the DisplayFormat property
</short>
<descr>
<p>
<var>SetDisplayFormat</var> is a procedure used to set the value in the DisplayFormat property. SetDisplayFormat compares the value stored in the member variable to the new value for the property. If they are different, the new value is stored and a flag is set to indicate that the display format has changed. SetDisplayFormat calls the ColumnChanged method to indicate that the column definition has been updated.
</p>
<p>
No actions are performed in the method when the DisplayFormat has not been changed.
</p>
<p>
Use DisplayFormat to read or write the value for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TColumn.SetField">
<short>
Sets the value in the Field property
</short>
<descr>
<p>
<var>SetField</var> is a procedure used to set the value in the Field property. SetField compares the new value for the property to the value stored in the member variable. When they are different, the new value is stored in the member variable. If the new value is not Nil, its FieldName is updated as well. SetField calls the ColumnChanged method to indicate that the column definition has been updated.
</p>
<p>
No actions are performed in the method when the new Field value is the same as the value stored in the member variable .
</p>
<p>
Use Field to read or write the value for the property.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.Field"/>
<link id="#lcl.DBGrids.TColumn.FieldName"/>
</seealso>
</element>
<!-- procedure visibility: private -->
<element name="TColumn.SetFieldName">
<short>
Sets the value in the FieldName property
</short>
<descr>
<p>
<var>SetFieldName</var> is a procedure used to set the value in the FieldName property. SetFieldName compares the new value to the value stored in the member variable for the property. No actions are performed in the method when they are the same.
</p>
<p>
SetFieldName stores the new value for the property in its member variable, and calls the LinkField method to find the Field with the specified name. DisplayFormat is updated when a matching Field is located in the dataset for the column.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.LinkField"/>
<link id="#lcl.DBGrids.TColumn.DisplayFormat"/>
</seealso>
</element>
<!-- function visibility: protected -->
<element name="TColumn.CreateTitle" link="#lcl.Grids.TGridColumn.CreateTitle">
<short>
Creates the title used for the grid column
</short>
<descr>
<p>
<var>CreateTitle</var> is an overridden TGridColumnTitle function used to create the title used as a fixed caption for the column.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.CreateTitle.Result">
<short>Title for the column</short>
</element>
<!-- function visibility: protected -->
<element name="TColumn.GetDefaultAlignment">
<short>
Gets the default alignment for the Field in the column definition
</short>
<descr>
<p>
<var>GetDefaultAlignment</var> is an overridden TAlignment function that gets the default alignment for the Field in the column definition. GetDefaultAlignment gets the button style used by the default editor for Field. For checkbox and button-style editors, center alignment is used. Otherwise, the Alignment in Field is used. If Field has not been assigned, left alignment is used.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumn.GetDefaultAlignment"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDefaultAlignment.Result">
<short>Alignment for the Field and/or editor style</short>
</element>
<!-- function visibility: protected -->
<element name="TColumn.GetDefaultDisplayFormat">
<short>
Gets the default display format for the Field in a column
</short>
<descr>
<p>
<var>GetDefaultDisplayFormat</var> is a String function used to get the default display format provided for the Field in a column definition. GetDefaultDisplayFormat uses the Field property to get its DisplayFormat for use as the return value in the method. The return value is a empty string <var>('')</var> when Field has not been assigned for the column definition.
</p>
<p>
GetDefaultDisplayFormat is used in the implementation of the GetDisplayFormat method.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.Field"/>
<link id="#lcl.DBGrids.TColumn.GetDisplayFormat"/>
<link id="#fcl.db.TField.DisplayFormat"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDefaultDisplayFormat.Result">
<short>Default display format for the Field in the column</short>
</element>
<!-- function visibility: protected -->
<element name="TColumn.GetDefaultValueChecked">
<short>
Gets the default value for a Checkbox in the Checked state as a String
</short>
<descr>
<p>
<var>GetDefaultValueChecked</var> is an overridden String function used to get the default value used for a Checkbox column in the Checked state. When Field has been aasigned for the column, and the data type is ftBoolean, the return value is <var>'TRUE'</var>. If Field has not been assigned, the return value is <var>'1'</var>.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumn.GetDefaultValueChecked"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDefaultValueChecked.Result">
<short>'TRUE' or '1'</short>
</element>
<!-- function visibility: protected -->
<element name="TColumn.GetDefaultValueUnchecked">
<short>
Gets the default String value for a Checkbox in the UnChecked state
</short>
<descr>
<p>
<var>GetDefaultValueUnchecked</var> is an overridden String function used to get the default value used for a Checkbox column in the UnChecked state. When Field has been aasigned for the column, and the data type is ftBoolean the return value is <var>'FALSE'</var>. If Field has not been assigned, the return value is <var>'0'</var>.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumn.GetDefaultValueUnchecked"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDefaultValueUnchecked.Result">
<short>'FALSE' or '0'</short>
</element>
<!-- function visibility: protected -->
<element name="TColumn.GetDefaultVisible" link="#lcl.Grids.TGridColumn.GetDefaultVisible">
<short>
Indicates if the Field for the column is Visible
</short>
<descr>
<p>
<var>GetDefaultVisible</var> is an overridden Boolean function that indicates if the Field for the column is Visible. GetDefaultVisible uses Field to get its Visible property for use as the return value in the method. If Field has not been assigned in the column, the return value is True.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDefaultVisible.Result">
<short>Truw when the Field for the column is visible</short>
</element>
<!-- function visibility: protected -->
<element name="TColumn.GetDisplayName">
<short>
Gets the display name for the collection item
</short>
<descr>
<p>
<var>GetDisplayName</var> is an overridden String function used to get the display name for the column. The display name is used at design-time to get the name for the collection item, and at run-time when a dataset has not been assigned or opened for the definition.
</p>
<p>
The value in FieldName is used as the return value for the method, when it has been assigned in the column. Otherwise, the inheriited GetDisplayName method is called to get the return value.
</p>
<p>
Use FieldName to set the name of the Field used for the column.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.FieldName"/>
<link id="#rtl.Classes.TCollectionItem.GetDisplayName"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDisplayName.Result">
<short>Display name for the collection item</short>
</element>
<!-- function visibility: private -->
<element name="TColumn.GetDefaultReadOnly">
<short>
Gets the default value for the ReadOnly property
</short>
<descr>
<p>
<var>GetDefaultReadOnly</var> is an overridden Boolean function which gets the default value for the ReadOnly property. GetDefaultReadOnly combines the ReadOnly values found in both the Grid and the Field for the dataset to derive the value for the method. The return value is True when Grid or Field is not assigned in the column.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumn.GetDefaultReadOnly"/>
<link id="#lcl.Grids.TGrid.ReadOnly"/>
<link id="#rtl.DB.TField.ReadOnly"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDefaultReadOnly.Result">
<short>Effective value for the ReadOnly property</short>
</element>
<!-- function visibility: private -->
<element name="TColumn.GetDefaultWidth">
<short>
Gets the effective width for the column
</short>
<descr>
<p>
<var>GetDefaultWidth</var> is an overridden Integer function used to get the effective width for the column. The return value is calculated using the Grid and its Canvas to find the space needed for the Field in the column. When the Grid has Options that include the value dgTitles, Title.Caption and Title.Font are included in the calculation. GetDefaultWidth calls the CalcColumnFieldWidth function to get the canvas width used as the return value.
</p>
<p>
The return value is -1 if the Grid has not been assigned for the column. The return value contains Grid.DefaultColWidth when Field has not been assigned in the column.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumn.GetDefaultWidth"/>
<link id="#lcl.DBGrids.CalcColumnFieldWidth"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetDefaultWidth.Result">
<short>Effective width for the the column</short>
</element>
<!-- function visibility: private -->
<element name="TColumn.GetPickList">
<short>
Gets the values in the pick list for the column
</short>
<descr>
<p>
<var>GetPickList</var> is an overridden TStrings function which gets the values in the pick list for the column. GetPickList calls the inherited method, and provides support for Lookup Fields in the column definition.
</p>
<p>
When Field is assigned and contains a Lookup Field (fkLookup in its FieldKind property), values from the LookupList or the LookupDataset are included in the return value. When LookupDataset is used, the result includes values from the LookupResultField for each of the rows in the dataset.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumn.GetPickList"/>
<link id="#fcl.DB.TField"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.GetPickList.Result">
<short>Values available for the lookup-style column</short>
</element>
<!-- property visibility: protected -->
<element name="TColumn.IsAutomaticColumn">
<short>
Indicates if the column was automatically added at run-time
</short>
<descr>
<p>
<var>IsAutomaticColumn</var> is a read-only Boolean property that indicates if the column was automatically added to the collection at run-time. The value in IsAutomaticColumn is updated when TDBGrid.AddAutomaticColumns and TDBGridColumns.RemoveAutoColumns add/remove items in the collection.
</p>
<p>
Use IsDesignColumn to determine is the column was added at design-time. Use TDBGridColumns.HasAutomaticColumns to determine if any automatic columns are stored in the collection. Use TDBGrid.OptionsExtra to enable or disable automatically columns in a database grid control.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.IsDesignColumn"/>
<link id="#lcl.DBGrids.TDBGridColumns.HasAutomaticColumns"/>
<link id="#lcl.DBGrids.TCustomDBGrid.OptionsExtra"/>
</seealso>
</element>
<!-- property visibility: protected -->
<element name="TColumn.IsDesignColumn">
<short>
Indicates if the column was added at design-time
</short>
<descr>
<p>
<var>IsDesignColumn</var> is a read-only Boolean property which indicates if the column was added at design-time. GetIsDesignColumn is the read access specifier for the IsDesignColumn property.
</p>
<p>
Use IsAutomaticColumn to determine if the column was added at run-time. Use TDBGridColumns.HasDesignColumns to determine if any design-time columns are stored in the collection.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.IsAutomaticColumn"/>
<link id="#lcl.DBGrids.TDBGridColumns.HasDesignColumns"/>
<link id="#lcl.DBGrids.TCustomDBGrid.OptionsExtra"/>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TColumn.LinkField">
<short>
Establishes a link between the FieldName and the Field in a Dataset
</short>
<descr>
<p>
<var>LinkField</var> is a procedure used to establish a link between the FieldName in the column and the Field in its Dataset. LinkField requires Grid to be assigned in order to access the DataLink and its Dataset. When Grid is unassigned, the value for Field is Nil. The DataLink in Grid must be Active to access the Fields in the dataset. When DataLink in not Active, the value in Field is Nil.
</p>
<p>
LinkField finds the Field in the linked dataset with the name specified in FieldName. The TField instance is stored in the Field property. LinkField calls the ApplyDisplayFormat method to update the DisplayFormat used for the column.
</p>
<note>
LinkField is called when reading the value for the Field property and it has not already been assigned.
</note>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.Field"/>
<link id="#lcl.DBGrids.TColumn.DisplayFormat"/>
<link id="#lcl.DBGrids.TColumn.ApplyDisplayFormat"/>
<link id="#lcl.DBGrids.TCustomDBGrid"/>
<link id="#lcl.DBGrids.TCustomDBGrid.DataLink"/>
</seealso>
</element>
<!-- constructor visibility: public -->
<element name="TColumn.Create">
<short>
Constructor for the <var>TColumn</var> instance
</short>
<descr>
<p>
<var>Create</var> is the constructor for the <var>TColumn</var> instance.
Create calls the inherited <var>Create</var> constructor and sets the
DesignIndex used for the new entry in the
<link id="#rtl.classes.TCollection">TCollection</link>. Create is called by the <link id="#rtl.classes.TCollection.Add">TCollection.Add</link> method and should not be called directly under normal circumstances.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TGridColumn.Create">TGridColumn.Create</link>
<link id="#rtl.classes.TCollection">TCollection</link>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TColumn.Create.ACollection">
<short>Collection that owns the collection item</short>
</element>
<!-- procedure visibility: protected -->
<element name="TColumn.Assign">
<short>
Stores properties from a persistent class in the current class instance
</short>
<descr>
<p>
<var>Assign</var> is an overridden procedure which stores properties from Source in the current class instance. Assign calls the inherited Assign method. When Source is a TColumn class instance, the values for the following are stored in the current class instance:
</p>
<ul>
<li>FieldName</li>
<li>DisplayFormat</li>
<li>ValueChecked</li>
<li>ValueUnchecked</li>
</ul>
</descr>
<seealso>
<link id="#rtl.Classes.TPersistent.Assign">TPersistent.Assign</link>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TColumn.Assign.Source">
<short>Persistent class with values stored in the method</short>
</element>
<!-- function visibility: public -->
<element name="TColumn.IsDefault" link="#lcl.Grids.TGridColumn.IsDefault">
<short>
Indicates if the column uses its default display format
</short>
<descr>
<p>
<var>IsDefault</var> is an overridden Boolean function that indicates if the column uses its default display format. The return value is True when the value in the DisplayFormat property has not been changed. IsDefault calls the inherited method to derive the final value for the method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TColumn.IsDefault.Result">
<short>True when DisplayFormat has been changed</short>
</element>
<!-- property visibility: public -->
<element name="TColumn.Field">
<short>
<var>Field </var> in the <var>Dataset</var> associated with this <var>Column</var>
</short>
<descr>
<p>
<var>Field</var> is a <var>TField</var> property that provides access to the content and other attributes for the dataset Field represented by the column. GetField reads the value for the property. SetField writes the value for the property.
</p>
</descr>
<seealso>
<link id="#rtl.db.TField">TField</link>
<link id="#lcl.DBGrids.TColumn.GetField"/>
<link id="#lcl.DBGrids.TColumn.SetField"/>
<link id="#lcl.DBGrids.TColumn.LinkField"/>
</seealso>
</element>
<!-- property visibility: public -->
<element name="TColumn.DesignIndex">
<short>
Order for the column in its collection at design-time
</short>
<descr>
<p>
<var>DesignIndex</var> is a read-only Integer property that contains the order for the column in its collection at design-time. The value in DesignIndex is used primarily when TDBGridColumns.ResetColumnsOrder compares and sorts the items in its collection.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TColumn.Create"/>
<link id="#lcl.DBGrids.TDBGridColumns.ResetColumnsOrder"/>
<link id="#lcl.DBGrids.CompareDesignIndex"/>
</seealso>
</element>
<!-- property visibility: published -->
<element name="TColumn.DisplayFormat">
<short>The format to be used for display in this column</short>
<descr>
<p>
<var>DisplayFormat</var> is a String property which specifies a format string used for displaying the value of a Field with the name in FieldName. Use of DisplayFormat in TColumn is consistent with its use in TField (and decendants), but can assign a value that overrides the default display format for the Field.
</p>
<p>
<var>GetDisplayFormat</var> is the read access specifier for the property. <var>SetDisplayFormat</var> is the write access specifier for the property. Changing the value in DisplayFormat causes the ColumnChanged method to be called when the column definition has been updated.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TColumn.FieldName">
<short>
Name of the Field with data for the column
</short>
<descr>
<p>
<var>FieldName</var> is a String property which contains the name of the Field used to get data for the column. <var>SetFieldName</var> is the write access specifier for the property. Changing the value in FieldName causes LinkField to be called to find the Field with the specified name. The value in DisplayFormat is also modified when the property was has changed.
</p>
</descr>
<seealso></seealso>
</element>
<!-- TDBGridColumns starts here -->
<!-- object visibility: default -->
<element name="TDbGridColumns">
<short>
Implements a collection for columns in a database grid
</short>
<descr>
<p>
<var>TDBGridColumns</var> is a TGridColumns descendant which implements a collection for columns added to TDBGrid.
</p>
<p>
TDBGridColumns extends the ancestor class to include support for adding and removing automatic columns at run-time. Automatic columns are a feature in TDBGrid that, when enabled, ensures the collection has a column definition for each Field in the linked dataset for its grid control. Methods and Properties are provided to identify columns added at run-time, and to order entries in the collection by their design-time or run-time indices.
</p>
<p>
Items is the default property for the collection. TColumn is the class type used for Items added to the collection.
</p>
<p>
Use the Add method to create a new collection item in the Items property. Use LinkFields to update the association between an item in the collection and the TField used to access its data. Use ResetColumnsOrder to change the order of Items in the collection.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: private -->
<element name="TDBGridColumns.GetColumn">
<short>
Gets the collection item stored at the specified position
</short>
<descr>
<p>
<var>GetColumn</var> is a TColumn function which gets the column at the specified position in the collection. GetColumn is the read access specifier for the Items property.
</p>
<p>
Use Items to read and write values in the collection.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TDBGridColumns.GetColumn.Result">
<short>Collection item at the specified position</short>
</element>
<!-- argument visibility: default -->
<element name="TDBGridColumns.GetColumn.Index">
<short>Position in the collection</short>
</element>
<!-- procedure visibility: private -->
<element name="TDBGridColumns.SetColumn">
<short>
Stores the collection item at the specified position
</short>
<descr>
<p>
<var>SetColumn</var> is a procedure which stores the column in Value at the specified position in the collection. SetColumn is the write access specifer for the Items property. SetColumn uses the Assign method to store the new Value in the collection.
</p>
<p>
Use Items to read and write values in the collection.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TDBGridColumns.SetColumn.Index">
<short>Position where the collection item is stored </short>
</element>
<!-- argument visibility: default -->
<element name="TDBGridColumns.SetColumn.Value">
<short>Collection item to store at the specified position</short>
</element>
<!-- procedure visibility: protected -->
<element name="TDBGridColumns.Update">
<short>
Redraws the Grid control that owns the collection
</short>
<descr>
<p>
<var>Update</var> causes the TDBGrid control which owns the collection to be redrawn. The value in Grid must be assigned, or no actions are performed in the method. In addition, the Grid control will not be updated if component streaming is active (csLoading in its ComponentState). Update calls TDBGrid.LayoutChanged to force the Grid control to be redrawn.
</p>
</descr>
<seealso>
<link id="#rtl.Classes.TCollection.Update">TCollection.Update</link>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TDBGridColumns.Update.Item">
<short>Collection item triggering the update</short>
</element>
<!-- function visibility: protected -->
<element name="TDBGridColumns.ColumnFromField">
<short>
<var>ColumnFromField</var> returns the collection item for the specified Field
</short>
<descr>
<p>
<var>ColumnFromField</var> returns the collection item for the specified Field. The return value is Nil when Field has not been assigned.
</p>
<p>
ColumnFromField iterates over the Items in the collection to locate the specified Field. The return value is Nil when Field cannot be located in the Items for the collection.
</p>
<p>
ColumnFromField is used in the TDBGrid.AddAutomaticColumns method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TDBGridColumns.ColumnFromField.Result">
<short>Collection item for the specified Field</short>
</element>
<!-- argument visibility: default -->
<element name="TDBGridColumns.ColumnFromField.Field">
<short>Field to locate in the collection</short>
</element>
<!-- function visibility: public -->
<element name="TDBGridColumns.Add">
<short>
<var>Add</var> creates and stores a new item in the collection
</short>
<descr>
<p>
<var>Add</var> creates and stores a new TColumn instance in the collection.
</p>
<p>
Add uses the Grid property (and the value in its GridStatus property) to determine whether the column is being explicitly added to the collection or added as a result of the automatic columns option in the grid. If the Grid contains the value gsAddingAutoColumns in its GridStatus property exisiting automatic columns are left in the collection. Otherwise, RemoveAutoColumns is called prior to creating and storing the new TColumn instance.
</p>
<p>
Add calls the inherited Add method to create and store the new TColumn instance.
</p>
</descr>
<seealso>
<link id="#rtl.Classes.TCollection.Add">TCollection.Add</link>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TDBGridColumns.Add.Result">
<short>TColumn added to the collection</short>
</element>
<!-- procedure visibility: public -->
<element name="TDBGridColumns.LinkFields">
<short>
Associates column items with the corresponding Fields in the Dataset
</short>
<descr>
<p>
<var>LinkFields</var> is a procedure which associates column items to the corresponding Fields in the Dataset for the Grid. LinkFields uses Grid to call its BeginLayout and EndLayout methods prior to and immediately after linking the Items in the collection to fields in the Dataset. This forces the Grid control to be updated when the method has completed. LinkFields calls the TColumn.LinkField method for each of the Items in the collection.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGridColumns.Items">
<short>
<var>Items</var> provides indexed access to columns added to the collection
</short>
<descr>
<p>
<var>Items</var> is a TColumn property that provides indexed access to columns
in the collection by their ordinal position (in the range 0..Count-1). Read and write access to columns in the Items property are cast to the TColumn class type used in the collection. Write access calls the Assign method in the TColumn instance stored at the specified position.
</p>
<p>
Items is the default property for the collection.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TDBGridColumns.Items.Index">
<short>Position for the collection item</short>
</element>
<!-- function visibility: protected -->
<element name="TDBGridColumns.HasAutomaticColumns">
<short>
<var>HasAutomaticColumns</var> indicates if any items in the collection are an automatic column
</short>
<descr>
<p>
<var>HasAutomaticColumns</var> is a Boolean function that indicates if any items in the collection are an automatic column added at run-time. Automatic columns are a feature in TDBGrid enabled by adding the approprate value to its OptionsExtra property. HasAutomaticColumns returns True if a TColumn instance in the Items property has its IsAutomaticColumn property set.
</p>
</descr>
<seealso>
<link id="TDBGrid.OptionsExtra" />
<link id="TDBGridColumns.RemoveAutoColumns" />
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TDBGridColumns.HasAutomaticColumns.Result">
<short>True when automatic columns are stored in the collection</short>
</element>
<!-- function visibility: protected -->
<element name="TDBGridColumns.HasDesignColumns">
<short>
<var>HasDesignColumns</var> indicates if the collection contains any items explicitly added at design-time
</short>
<descr>
<p>
<var>HasDesignColumns</var> is a Boolean function that indicates if the collection contains any items explicitly added at design-time. HasDesignColumns returns True if Items contains a TColumn instance with its IsDesignColumn property set.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGridColumns.Items" />
<link id="#lcl.DBGrids.TColumn.IsDesignColumn" />
<link id="#lcl.DBGrids.TColumn.ResetColumnsOrder" />
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TDBGridColumns.HasDesignColumns.Result">
<short>True an item has its IsDesignColumn property set</short>
</element>
<!-- procedure visibility: protected -->
<element name="TDBGridColumns.RemoveAutoColumns">
<short>
<var>RemoveAutoColumns</var> removes automatic columns in the collection
</short>
<descr>
<p>
<var>RemoveAutoColumns</var> is a procedure used to remove any automatic columns in the collection. RemoveAutoColumns uses HasAutomaticColumns to determine if any action is required.
</p>
<p>
When HasAutomaticColumns returns True the Grid updates its GridStatus to include the value gsRemovingAutoColumns. RemoveAutoColumns calls the Delete method for any column having its IsAutomaticColumn property set to True. gsRemovingAutoColumns is removed from the GridStatus property in the Grid prior to exiting from the method.
</p>
<p>
Applications do not normally call the RemoveAutoColumns method. Use TDBGrid.OptionsExtra to disable the automatic columns feature in the grid control.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGrid.RemoveAutomaticColumns" />
<link id="#lcl.DBGrids.TDBGridColumns.Add" />
</seealso>
</element>
<!-- procedure visibility: public -->
<element name="TDBGridColumns.ResetColumnsOrder">
<short>
<var>ResetColumnsOrder</var> arranges columns in the collection to the specified order
</short>
<descr>
<p>
<var>ResetColumnsOrder</var> is a procedure used to arrange columns in the collection to the order specified in the ColumnOrder argument. ColumnOrder can contain the following values:
</p>
<dl>
<dt>coDesignOrder</dt>
<dd>
TColumn.DesignIndex (when available) is used to order collection items.
</dd>
<dt>coFieldIndex</dt>
<dd>
The index for the TColumn.Field (when available) is used to order collection items.
</dd>
</dl>
<p>
Otherwise the index of the collection item is unchanged.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TDBGridColumns.ResetColumnsOrder.ColumnOrder">
<short>Sort order for columns in the collection</short>
</element>
<!-- TCustomDBGrid starts here -->
<!-- object visibility: default -->
<element name="TCustomDBGrid">
<short>
<var>TCustomDBGrid </var> is the base class for <var>TDBGrid</var>
</short>
<descr>
<p>
<var>TCustomDBGrid</var> is a <var>TCustomGrid</var> descendant and the base class for <var>TDBGrid</var>. TCustomDBGrid adds capabilities needed to implement a database-aware grid control. One key feature is the TComponentDataLink used to coordinate access and event handlers between the grid control and its linked dataset. Another key feature is the use of the Options and OptionsExtra properties to enable/disable features or behaviors in the grid control.
</p>
<p>
TCustomDBGrid overrides certain features from the ancestor class to provide consistent use with Fields, Field kinds, and values in TDataset.
</p>
<p>
Applications should use the TDBGrid descendant which sets the scope of properties, methods, and event handlers to public or published.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.HowToUseGrids">HowToUseGrids</link>
<link id="#lcl.DBCtrls.HowToUseDataAwareControls">HowToUseDataAwareControls</link>
</seealso>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetCurrentField">
<short>
Gets the value in the SelectedField property
</short>
<descr>
<p>
<var>GetCurrentField</var> is a TField function used to get the value in the SelectedField property. GetCurrentField is the read access specifier for the SelectedField property. GetCurrentField calls GetFieldFromGridColumn to get the TField instance used as the value for the property.
</p>
<p>
Use SelectedField to read and write value for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetCurrentField.Result">
<short>Value for tehe SelectedField property</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetDataSource">
<short>
Gets the value for the DataSource property
</short>
<descr>
<p>
<var>GetDataSource</var> is a TDataSource function used to get the value for the DataSource property. GetDataSource is the read access specifier for the DataSource property. GetDataSource gets the DataSource property stored in DataLink as the return value for the method.
</p>
<p>
Use DataSource to read or write values in the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetDataSource.Result">
<short>Value for the DataSource property</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetRecordCount">
<short>
Gets the number of records in the linked dataset
</short>
<descr>
<p>
<var>GetRecordCount</var> is an Integer function used to get the number of records in the linked dataset. GetRecordCount uses the DataLink for the grid to get the RecordCount in its DataSet property. The record count is used as the return value for the method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetRecordCount.Result">
<short>Number of records in the linked dataset</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnRecordChanged">
<short>
Default implementation for the event handler in TComponentDataLink
</short>
<descr>
<p>
<var>OnRecordChanged</var> is a procedure which provides a default implementation for the OnRecordChanged event handler in TComponentDataLink. OnRecordChanged ensures that the grid control and the linked dataset are synchronized when refreshing the active record, selecting the current column, and re-enabling the edit control when EditMode is active.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnRecordChanged.Field">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnDatasetChanged">
<short>
Default implementation for the event handler in TComponentDataLink
</short>
<descr>
<p>
<var>OnDatasetChanged</var> is a procedure which provides a default implementation for the OnDatasetChanged event handler in TComponentDataLink.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnDatasetChanged.aDataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnDatasetOpen">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<p>
<var>OnDatasetOpen</var> provides a default implementation for the event handler in TComponentDataLink.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnDatasetOpen.aDataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnDatasetClose">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<var>OnDatasetClose</var> provides a default implementation for the event handler in TComponentDataLink.
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnDatasetClose.aDataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnEditingChanged">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<var>OnEditingChanged</var> provides a default implementation for the event handler in TComponentDataLink.
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnEditingChanged.aDataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnInvalidDataset">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<var>OnInvalidDataSet</var> provides a default implementation for the event handler in TComponentDataLink.
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnInvalidDataset.aDataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnInvalidDataSource">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<var>OnInvalidDataSourcet</var> provides a default implementation for the event handler in TComponentDataLink.
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnInvalidDataSource.ADataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnLayoutChanged">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<var>OnLayoutChanged</var> provides a default implementation for the event handler in TComponentDataLink.
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnLayoutChanged.ADataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnNewDataset">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<var>OnNewDataset</var> provides a default implementation for the event handler in TComponentDataLink.
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnNewdataset.ADataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnDatasetScrolled">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<var>OnDatasetScrolled</var> provides a default implementation for the event handler in TComponentDataLink.
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnDatasetScrolled.ADataset">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnDatasetScrolled.Distance">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.OnUpdateData">
<short>
Implementation for the event handler in TComponentDataLink
</short>
<descr>
<var>OnUpdateData</var> provides a default implementation for the event handler in TComponentDataLink.
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnUpdateData.ADataset">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.ReadColumns">
<short></short>
<descr></descr>
<seealso></seealso>
<remark>
<p>Not used in the current implementation.</p>
</remark>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ReadColumns.Reader">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.SetColumns">
<short></short>
<descr></descr>
<seealso></seealso>
<remark>
<p>Not used in the current implementation.</p>
</remark>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetColumns.AValue">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.SetCurrentField">
<short>
</short>
<descr>
<p>
<var>SetCurrentField</var> is a procedure used to set the value in the SelectedField property. SetCurrentField is the write access specifier for the SelectedField property. SetCurrentField calls GetGridColumnFromField to ensure that the Field in AValue becomes the current column in the control. No actions are performed in the method when AValue contains the same value as the SelectedField property.
</p>
<p>
Use SelectedField to read or write the value for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetCurrentField.AValue">
<short>Field to select in the method</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.SetDataSource">
<short>
Sets the value in the DataSource property
</short>
<descr>
<p>
<var>SetDataSource</var> is a procedure used to set the value in the DataSource property. SetDataSource is the write access specifier for the DataSource property. SetDataSource stores the value in AValue in the DataSource property for DataLink, refreshes the column widths for the control, and calls UpdateActive.
</p>
<p>
Use DataSource to read or write the value in the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetDataSource.AValue">
<short>New data source for the property value</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.SetOptions">
<short>
Sets the values in the Options property
</short>
<descr>
<p>
<var>SetOptions</var> is a procedure used to set the values in the Options property. SetOptions is the write access specifier for the Optoions property. SetOptions causes other aspects of the grid control to be updated to reflect changes in the property value. ChangedOptions is updated to reflect the enumeration values added or removed in the request. Some enumeration values force other features or behaviors to be disabled. For instance: row selection. Enabling row selection forces the options for editing, always displaying the editor, and row highlighting to be removed from the Options property. Finally, removing multi-selection from the Options property forces the SelectedRows and KeyBookmark properties to be cleared.
</p>
<p>
AValue is a TDBGridOptions argument that specifies features or behaviors that will be enabled or disabled in the grid control. Please note that these options are different than the TGridOption values used in the ancestor class.
</p>
<p>
As a result, SetOptions must translate any TDBGridOption values to their TGridOption equivalents and store them in the inherited Options property.
</p>
<p>
Options contains the following default values when the control is created:
</p>
<ul>
<li>dgColumnResize</li>
<li>dgColumnMove</li>
<li>dgTitles</li>
<li>dgIndicator</li>
<li>dgRowLines</li>
<li>dgColLines</li>
<li>dgConfirmDelete</li>
<li>dgCancelOnExit </li>
<li>dgTabs</li>
<li>dgEditing</li>
<li>dgAlwaysShowSelection</li>
</ul>
<p>
See TDBGridOption for more information about values in the enumeration.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetOptions.AValue">
<short>New values for the Options property</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.UpdateBufferCount">
<short>
Sets the number of records buffered for the linked dataset
</short>
<descr>
<p>
<var>UpdateBufferCount</var> is a procedure used to set the number of records buffered for the linked dataset. UpdateBufferCount requires that DataLink be marked as Active to set the buffer count. If DataLink.Active contains False, no actions are performeds in the method.
</p>
<p>
UpdateBufferCount calls GetBufferCount to determine the number of rows that can be displayed in the control with the DefaultRowHeight. When Options includes the value dgTitles, the buffer count is decreased by 1 to account for the fixed title row. UpdateBufferCount stores the new value in the BufferCount property in DataLink.
</p>
<p>
UpdateBufferCount is called from the UpdateGridCounts method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.UpdateData">
<short>
<var>UpdateData</var> is used to perform pending updates for the selected cell.
</short>
<descr>
<p>
<var>UpdateData</var> is a virtual procedure used to perform pending updates for the selected cell to its Field in the grid Dataset. No action is performed if the selected cell has not been modified (or cannot be modified) or the Dataset is not in edit mode.
</p>
<p>
UpdateData ensures that the appropriate method is used to update Field data based on the TField.FieldKind for the modified column. Special handling is provided for lookup Fields to check the cached lookup list or to retrieve the lookup result using its key Fields.
</p>
<p>
UpdateData calls the EditingColumn method to disable the editing flag for the column prior to exit.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetColumnCount">
<short>
Gets the number of visible columns or Fields in the grid
</short>
<descr>
<p>
<var>GetColumnCount</var> is an Integer function used to get the number of visible columns or Fields for the grid control. GetColumnCount uses the Columns collection (when its has been Enabled) to get the value in VisibleCount. When Columns is not Enabled, and OptionsExtra has dgeAutoColumns enabled, the linked dataset is used to determine the number of Fields with their Visible flag set. The Dataset cannot be examined if the DataLink is not marked as Active.
</p>
<p>
GetColumnCount is called from the UpdateGridCounts method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetColumnCount.Result">
<short>Number of visible Fields or columns in the grid</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.DefaultFieldColWidth">
<short>
Gets the default column width for the specified Field
</short>
<descr>
<p>
<var>DefaultFieldColWidth</var> is an Integer function used to get the default column width for the specified Field. When the specified Field contains Nil, the value from DefaultColWidth is used. Otherwise, the DisplayWidth property in the TField instance is used to get the Canvas.TextWidth for the DisplayName in the Field.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.DefaultFieldColWidth.Result">
<short>Default column width for the field</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultFieldColWidth.F">
<short>Field to examine in the method</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetDsFieldFromGridColumn">
<short>
<var>GetDsFieldFromGridColumn</var> returns the identity of the dataset Field corresponding to the nominated grid column
</short>
<descr>
<p>
<var>GetDsFieldFromGridColumn</var> returns the identity of the dataset Field corresponding to the nominated grid column
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetDsFieldFromGridColumn.Result">
<short>Field to use for the specified column</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetDsFieldFromGridColumn.Column">
<short>Column with the field to locate in the method</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetFieldFromGridColumn">
<short>
<var>GetFieldFromGridColumn</var> obtain the Field either from a Db column or directly from dataset Fields
</short>
<descr>
<p>
<var>GetFieldFromGridColumn</var> obtain the Field either from a Db column or directly from dataset Fields.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetFieldFromGridColumn.Result">
<short>Field for the specified column</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetFieldFromGridColumn.Column">
<short>Column to locate in the method</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetGridColumnFromField">
<short>
<var>GetGridColumnFromField</var> - gets the corresponding grid column for the given Field
</short>
<descr>
<p>
<var>GetGridColumnFromField</var> - gets the corresponding grid column for the given Field.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetGridColumnFromField.Result">
<short>Column for the specified field</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetGridColumnFromField.F">
<short>Field to locate in the grid columns</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.FieldIndexFromGridColumn">
<short>
<var>FieldIndexFromGridColumn</var> returns the index for the database Field
corresponding to the stated grid column
</short>
<descr>
<p>
<var>FieldIndexFromGridColumn</var> returns the index for the database Field
corresponding to the stated grid column.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.FieldIndexFromGridColumn.Result">
<short>Position of the field for the specified column</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.FieldIndexFromGridColumn.Column">
<short>Column to locate in the fields for the control</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.UpdateGridColumnSizes">
<short>
Updates sizes for automatically sized columns in the grid
</short>
<descr>
<p>
<var>UpdateGridColumnSizes</var> is a procedure used to update the sizes for automatically sized columns in the grid control. UpdateGridColumnSizes requires DefaultColWidths to be in use for the grid. No actions are performed in the method when DefaultColWidths contains False.
</p>
<p>
UpdateGridColumnSizes also requires the Options property to include the value dgAutoSizeColumns which enables the auto-sized columns feature. No actions are performed if the feature has not been enable for the grid control.
</p>
<p>
UpdateGridColumnSizes calls the UpdateAutoSizeColumns method to calculate the widths for the auto-sized columns.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.UpdateScrollbarRange">
<short>
</short>
<descr>
<p>
<var></var>
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.DoLayoutChanged">
<short>
Update the grid and its scrollbars when its layout has changed
</short>
<descr>
<p>
<var>DoLayoutChanged</var> is a procedure used to update the grid and its scrollbars when the layout for the control has changed. No actions are performed in the method when the control is freed (contains csDestroying in its ComponentState).
</p>
<p>
DoLayoutChanged calls BeginUpdate to signal changes to the control, and UpdateGridCounts to determine the number of rows for the update. When UpdateGridCounts returns 0, the EmptyGrid method is called to clear the grid control. DoLayoutChanged calls EndUpdate to allow pending changes to be applied to the control. DoLayoutChanged calls UpdateScrollbarRange to update scrollbars (when used) for the control.
</p>
<p>
DoLayoutChanged is called from the EndLayout method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.WriteColumns">
<short></short>
<descr></descr>
<seealso></seealso>
<remark>
<p>Not used in the current implementation.</p>
</remark>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.WriteColumns.Writer">
<short></short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.RestoreEditor">
<short>
Re-enables the editor control after scrollbar messages
</short>
<descr>
<p>
<var>RestoreEditor</var> is a procedure used to re-enable the editor control in the grid after processing scrollbar messages. RestoreEditor is used when EditorMode contains True. No actions are performed in the method when EditorMode contains False. RestoreEditor toggles the value in EditorMode to force the editor for the SelectCell to be refreshed and redrawn.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.ISEOF">
<short>
Indicates if the linked dataset is positioned the end-of-file
</short>
<descr>
<p>
<var>ISEOF</var> is a Boolean function used to indicate if the linked dataset is positioned the end-of-file. ISEOF uses the DataLink for the control to access its Active and Dataset properties. DataLink must be Active (contains True) to access its Dataset. The return value is True when the TDataset.EOF method returns True. The return value is False when DataLink is not Active, or TDataset.EOF returns False.
</p>
<p>
ISEOF is used in the KeyDown and MouseDown methods.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.ISEOF.Result">
<short>EOF state for the linked dataset</short>
</element>
<!-- procedure visibility: protected -->
<element
name="TCustomDBGrid.BeforeMoveSelection"
link="#lcl.Grids.TCustomGrid.BeforeMoveSelection">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.BeforeMoveSelection.DCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.BeforeMoveSelection.DRow">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.BeginLayout">
<short>
<var>BeginLayout</var> starts producing layout changes for the grid control
</short>
<descr>
<p>
<var>BeginLayout</var> is a procedure which starts producing layout changes for the grid control. BeginLayout is used along with EndLayout to minimize the number of times layout changed notification events are triggered by the control. Layout changes occur when the control enables certain values in its Options property, when AutoAdjustColumn is called, and when the Columns collection links to Fields in the associated dataset.
</p>
<p>
BeginLayout increments the LayoutChangedCount variable that tracks the number of times the method is called for the control. <var>EndLayout</var> decrements that counter and when it reaches 0 (zero) the DoLayoutChanged method is called.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.CellClick">
<short>
<var>CellClick</var> calls the <var>OnCellClick</var> event handler if it is
assigned for this particular cell
</short>
<descr>
<p>
<var>CellClick</var> calls the <var>OnCellClick</var> event handler if it is
assigned for this particular cell.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.CellClick.aCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.CellClick.aRow">
<short></short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.CheckDisplayMemo">
<short>
Indicates if the field is a Memo that needs to be displayed in the grid
</short>
<descr>
<p>
<var>CheckDisplayMemo</var> is a Boolean function used to determine if the specified field is a Memo field that needs to be displayed in the grid control. The return value is True when the specified field has the value ftMemo in its DataType property, and the Options property has enabled the dgDisplayMemoText feature.
</p>
<p>
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibiity: default -->
<element name="TCustomDBGrid.CheckDisplayMemo.aField">
<short></short>
</element>
<!-- function result visibiity: default -->
<element name="TCustomDBGrid.CheckDisplayMemo.Result">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.ChangeBounds" link="#lcl.Controls.TControl.ChangeBounds">
<short>
</short>
<descr>
<p>
<var></var>
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ChangeBounds.ALeft">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ChangeBounds.ATop">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ChangeBounds.AWidth">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ChangeBounds.AHeight">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.ColRowMoved" link="#lcl.Grids.TCustomGrid.ColRowMoved">
<short>
Signals event handlers when a row or a column is moved in the grid control
</short>
<descr>
<p>
<var>ColRowMoved</var> is an overridden procedure used to signal event handlers when a row or a column is moved in the grid control. When IsColumn contains False, the OnRowMoved event handler is signalled (when assigned). When IsColumn contains True, the OnColumnMoved event handler is signalled (when assigned) if Columns have not been Enabled in the grid control. If Columns have been Enabled, the inherited ColRowMoved method is called.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ColRowMoved.IsColumn">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ColRowMoved.FromIndex">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ColRowMoved.ToIndex">
<short></short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.CreateColumns" link="#lcl.Grids.TCustomGrid.CreateColumns">
<short>
Creates the Columns collection for the grid control
</short>
<descr>
<p>
<var>CreateColumns</var> is an overridden TGridColumns function used to create the Columns collection for the grid control. In TDBGrid, the Columns collection is implemented using the TDBGridColumns class type (a descendant of TGridColumns). CreateColumns creates an instance of TDBGridColumns which is used as the return value for the method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.CreateColumns.Result">
<short>Columns collection for the grid control</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.CreateWnd">
<short>
<var>CreateWnd</var> - creates the window adjusts its layout and adds scrollbars when needed
</short>
<descr></descr>
<seealso>
<link id="#lcl.Controls.TWinControl.CreateWnd">TWinControl.CreateWnd</link>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DefineProperties" link="#rtl.Classes.TComponent.DefineProperties">
<descr></descr>
<seealso></seealso>
<remark>
<p>
Provides an empty implementation that avoids calling the inherited DefineProperties method. TCustomGrid defines ColWidths, RowHeights and Cells properties which do not use facilities available in the data-aware grid control.
</p>
</remark>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefineProperties.Filer">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DefaultDrawCell">
<short>
Default method used to drawing a cell at the specified location
</short>
<descr>
<p>
<var>DefaultDrawCell</var> is a procedure that provides the default method for drawing a cell at the specified location using different cell types. DefaultDrawCell draws the background for the cell with the specified drawing state. For a cell which appears in a fixed row or column, the text for the cell is also drawn.
</p>
<p>
When the DataSet for the grid control has rows, the Field used for the specified column is retrieved and the cell is drawn in the manner needed for its column editor style. For checkbox columns, the DrawCheckBoxBitmaps is called. For columns with a button-style editor, the DrawButtonCell method is used. For Fields with a ftMemo data type, the CheckDisplayMemo method is called to determine whether the content in the memo or the DIsplayText for the column definition is drawn. Finally, the DrawCellText method is called to draw the specified cell using its state and value.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultDrawCell.aCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultDrawCell.aRow">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultDrawCell.aRect">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultDrawCell.aState">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DoExit">
<short>
<var>DoExit</var> closes the editor and the datalink for the control
</short>
<descr>
<p>
<var>DoExit</var> is an overridden procedure in TCustomDBGrid used to close the editor and the datalink for the control. A valid dataset must be assigned in the DataLink property and inserts must be cancellable for the dataset. The Options property must include the dgCancelOnExit enumeration value for the grid. If any of these conditions are not met, no actions are performed in the method on either the dataset or the Field editor.
</p>
<p>
DoExit calls the inherited method to perform any actions implemented in the ancestor class.
</p>
</descr>
<seealso>
<link id="#lcl.Controls.TWinControl.DoExit">TWinControl.DoExit</link>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DoOnChangeBounds">
<short>
<var>DoOnChangeBounds</var> - calls inherited
<var>DoOnChangeBounds</var> adjusts layout if required
</short>
<descr></descr>
<seealso>
<link id="#lcl.Controls.TControl.DoOnChangeBounds">TControl.DoOnChangeBounds</link>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DrawFocusRect" link="#lcl.Grids.TCustomGrid.DrawFocusRect">
<short>
Draws the current selection in the grid in a focused state
</short>
<descr>
<p>
DrawFocusRect is an overridden procedure used to draw the current selection in the grid in a focused state.
</p>
<p>
The grid control must have focus before the current selection can be drawn. In
addition the DataLink for the control must refer to an active dataset.
DrawFocusRect uses the Options property to ensure that dgAlwaysShowSelection
has been included for the control. Finally DefaultDrawing must be enabled to
allow drawing of the focus rectangle using the rubberband style on the Canvas
for the control.
</p>
<p>
If any of the previous conditions are not met, no actions are performed in the method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawFocusRect.aCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawFocusRect.aRow">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawFocusRect.ARect">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DrawRow" link="#lcl.Grids.TCustomGrid.DrawRow">
<short>
</short>
<descr>
<p>
DrawRow is an overridden procedure used to draw the specified row number in the grid control.
</p>
<p>
ARow contains the row number to be drawn and refers to an ordinal position relative to the FixedRows for the control. When ARows contains a value that would be in the FixedRows the state flags that track drawing an active record or multi-selection are reset. DrawRow also requires that DataLink refer to an active dataset. No actions are performed in the method if these conditions are not satisfied.
</p>
<p>
DrawRow sets the active record in DataLink for selected rows in the control and updates the DrawingActiveRecord and DrawingMultiSelRecord flags as needed. The Options property must include the value dgMultiSelect to enable drawing of multiple selections in the control.
</p>
<p>
DrawRow calls the inherited method to perform any actions implemented in the ancestor class.
</p>
</descr>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawCell">
<short>
DrawCell renders the specified grid cell in the supplied drawing state
</short>
<descr>
<p>
DrawCell is used to render a cell at the specified coordinates with the specified drawing state.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawCell.aCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawCell.aRow">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawCell.aRect">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawCell.aState">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.EditingColumn">
<short>
<var>EditingColumn</var> sets or resets the column being edited in the control
</short>
<descr>
<p>
<var>EditingColumn</var> is a procedure used to set or reset the column being edited in the control .
</p>
<p>
aCol indicates the ordinal column number and is stored internally for use in other methods of the control. Ok indicates that editing is active when set and causes the DataLink to set its Modified flag to true. When Ok contains False the internal column number is reset to its default value indicating that no column is currently being edited.
</p>
<p>
EditingColumn is used in the implementation of other methods in the grid control such as UpdateData EditorCancelEditing EditorIsReadOnly and DoExit.
</p>
</descr>
<seealso>
<link id="TCustomDBGrid.UpdateData"/>
<link id="TCustomDBGrid.EditorCancelEditing"/>
<link id="TCustomDBGrid.EditorIsReadOnly"/>
<link id="TCustomDBGrid.DoExit"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.EditingColumn.aCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.EditingColumn.Ok">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.EditorCancelEditing">
<short>
<var>EditorCancelEditing</var> cancels pending changes and disables the editor
</short>
<descr>
<p>
<var>EditorCancelEditing</var> is a procedure used to cancel pending changes
and to halt the editing process.
</p>
<p>
EditorCancelEditing calls the EditingColumn method to disable the editor in
the currently selected cell for the control. The EditorMode property is
cleared when set but is restore if the Options property includes the value
dgAlwaysShowEditor.
</p>
<p>
EditorCancelEditing is used in the implementation of methods like
DoOperation MoveSel and MouseDown.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.EditorDoGetValue">
<short>
<var>EditorDoGetValue</var> gets the value used in the editor for the control
</short>
<descr>
<p>
<var>EditorDoGetValue</var> is an overridden proecedure used to get the value used in the editor for the control. EditorDoGetValue calls the inherited EditorDoGetValue method. UpdateData is called to retrieve the value for the editor from its column in the underlying dataset.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.EditorDoGetValue"/>
</seealso>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.EditorCanAcceptKey">
<short>
<var>EditorCanAcceptKey</var> determines if the specified character can be applied to the Field for the editor
</short>
<descr>
<p>
<var>EditorCanAcceptKey</var> is an overridden Boolean function
which determines if the cell editor can accept the character specified in <var>ch</var>. EditorCanAcceptKey requires that the linked dataset be active to access the SelectedField for the control. The Field cannot be an AutoIncrement, Lookup, Calculated, or Blob Field type. The return value is False if any of these conditions are not satisfied.
</p>
<p>
EditorCanAcceptKey calls the IsValidChar routine to determine if the UTF8-encoded value in ch can be applied to the dataset for the control.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.EditorCanAcceptKey"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.EditorCanAcceptKey.ch">
<short>Key to examine in the method</short>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.EditorCanAcceptKey.Result">
<short>True when the character can be applied to the field</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.EditorIsReadOnly" link="#lcl.Grids.TCustomGrid.EditorIsReadOnly">
<short>
<var>EditorIsReadOnly</var> determines if the editor can be enabled for the selected cell in the control
</short>
<descr>
<p>
<var>EditorIsReadOnly</var> is a Boolean function used to determine if the
editor can be enabled for the selected cell in the control.
</p>
<p>
EditorIsReadOnly calls the inherited method to ensure that requirements from the ancestor class are respected. If the ancestor class returns True no actions are performed in the method.
</p>
<p>
EditorIsReadOnly locates the TField used to store data for the selected cell and calls its CanModify method to determine if the Field can be modified. Additional logic is applied for lookup Fields; the TField.KeyFields for the Field are also examined to determine if any of them are marked as read only.
</p>
<p>
EditorIsReadOnly ensures the dataset in DataLink is in edit mode. The GridStatus property is updated to include gsStartEditing prior to changing the dataset state and removed from GridStatus after the datasdet state has changed.
</p>
<p>
EditorIsReadOnly calls the EditingColumn method synchronize the cell editor state to the value returned by the method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.EditorIsReadOnly.Result">
<short>True when an editor cannot modify the select cell</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.EndLayout">
<short>
<var>EndLayout</var> finishes layout changes for the control
</short>
<descr>
<p>
<var>EndLayout</var> is a procedure used along with BeginLayout to minimize the number of times layout changed notification events are triggered by the control. Layout changes occur when the control enables certain values in its Options property when AutoAdjustColumn is called and when the Columns collection links to Fields in the associated dataset.
</p>
<p>
The grid maintains an internal counter that tracks the number of times BeginLayout has been called to start a layout change for the control. EndLayout decrements that counter and when it reaches 0 (zero) the DoLayoutChanged method is called.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TCustomDBGrid.BeginLayout"/>
<link id="#lcl.DBGrids.TCustomDBGrid.DoLayoutChanged"/>
<link id="#lcl.DBGrids.TCustomDBGrid.LayoutChanged"/>
<link id="#lcl.DBGrids.TCustomDBGrid.Options"/>
<link id="#lcl.DBGrids.TCustomDBGrid.AutoAdjustColumn"/>
<link id="#lcl.DBGrids.TDBGridColumns.LinkFields"/>
<link id="#lcl.DBGrids.TDBGridColumns.Update"/>
</seealso>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetEditMask">
<short>
<var>GetEditMask</var> gets the EditMask for the Field at the specied Row and Column
</short>
<descr>
<p>
<var>GetEditMask</var> is an overridden String function used to get the EditMask for the TField that reads and writes data for specified Row and Column.
</p>
<p>
The linked dataset for the grid control must be active to access the Field definition at the specified column number. GetEditMask calls the GetFieldFromGridColumn method to get the TField instance with the EditMask for the column.
</p>
<p>
The return value can contain an empty string ('') is the dataset is not active, or a Field cannot be located for the specified column, or the EditMask has not been assigned in the Field definition.
</p>
<p>
GetEditMask signals the OnFieldEditMask event handler when it has been assigned for the control. Use OnFieldEditMask to return a user-specified value for the EditMask.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.GetEditMask">TCustomGrid.GetEditMask</link>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetEditMask.Result">
<short>Edit mask for the specified cell</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetEditMask.aCol">
<short>Column in the grid</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetEditMask.aRow">
<short>Row in the grid</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetEditText">
<short>
<var>GetEditText</var> gets the Text value for the specified Field
</short>
<descr>
<p>
<var>GetEditText</var> is an overridden String function used to get the Text value for the Field at the specified Row and Column.
</p>
<p>
GetEditText requires that the linked dataset for the control be active to access its Field definitions. GetEditText calls the GetFieldFromGridColumn method to get the TField instance that provides the textual representation of the value for the Field. GetEditText calls the CheckDisplayMemo method to determine if a Field with the ftMemo data type displays its content or the string literal in its Text property '(Memo)'.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetEditText.Result">
<short>Text value displayed for the specified cell</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetEditText.aCol">
<short>Column in the grid`</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetEditText.aRow">
<short>Row in the grid</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GridCanModify">
<short>
<var>GridCanModify</var> indicates if the DataLink is active and allows editing
</short>
<descr>
<p>
<var>GridCanModify</var> indicates if the DataLink is active, and allows editing.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GridCanModify.Result">
<short>True when the grid can be modified</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.HeaderClick">
<short>
<var>HeaderClick</var> - calls <var>OnHeaderClick</var> if assigned
</short>
<descr>
<p>
<var>HeaderClick</var> - calls <var>OnHeaderClick</var> if assigned.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.HeaderClick">TCustomGrid.HeaderClick</link>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.HeaderClick.IsColumn">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.HeaderClick.Index">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.HeaderSized" link="#lcl.Grids.TCustomGrid.HeaderSized">
<short>
Updates Columns in the control whena a header cell is resized
</short>
<descr>
<p>
<var>HeaderSized</var> is an overridden procedure which updates the Columns for the control when a header cell is resized. If IsColumn contains False the resize operation was for the height of a header row and no action is perfomed in the method. When IsColumn contains True the request applies to the width of the column with the Field at the position specified in Index.
</p>
<p>
HeaderSized calls the ColumnIndexFromGridColumn method to determine the position in the Columns collection for the Field specified in Index. The width in Columns is updated with the corresponding value from ColWidths. HederSized sets the value in DefaulrColWidths to False to indicate that custom column sizing has been applied to the control.
</p>
<p>
HeaderSized signals theOnColumnSized event handler when assigned for the control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.HeaderSized.IsColumn">
<short>Sizing applies to a column and not a row</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.HeaderSized.Index">
<short>Ordinal position for the column</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.KeyDown">
<short>
<var>KeyDown</var> handles special keys and signals the <var>OnKeyDown</var> event handler
</short>
<descr>
<p>
<var>KeyDown</var> ensures that keys which affect navigation and editing operations are handled in the grid control. KeyDown handles the following keys:
</p>
<dl>
<dt><var><b>Tab</b></var></dt>
<dd>
Advances to the next column when dgTabs is included in Options. Otherwise exits the control.
</dd>
<dt><var><b>Shift + Tab</b></var></dt>
<dd>
Moves to the previous column when dgTabs is included in Options. Otherwise exits the control.
</dd>
<dt><var><b>Return</b></var></dt>
<dd>
Enables the editor for the cell when dgEditing is included in Options.
Otherwise advances to the next column.
</dd>
<dt><var><b>Ctrl + Delete</b></var></dt>
<dd>
Deletes the selected row when dgDisableDelete has not been included in Options. A confirmation dialog is displayed when dgConfirmDelete is included in Options.
</dd>
<dt><var><b>Up</b></var></dt>
<dd>
Moves to the previous row in the dataset. The currently selected column remains the same.
</dd>
<dt><var><b>Down</b></var></dt>
<dd>
Moves to the next row in the dataset. The currently selected column remains the same. Appends a new row when positioned at the end of the dataset and dgDiableInsert has not been included in Options.
</dd>
<dt><var><b>Page Up</b></var></dt>
<dd>
Moves towards the beginning of the dataset by the number of rows specified in VisibleRows.
</dd>
<dt><var><b>Page Down</b></var></dt>
<dd>
Moves towards the end of the dataset by the number of rows specified in VisibleRows.
</dd>
<dt><var><b>Escape</b></var></dt>
<dd>
Cancels an active editor for the selected cell. Clears pending modifications to the Field for the column.
</dd>
<dt><var><b>Insert</b></var></dt>
<dd>
Inserts a new row at the current row position when dgDisableInsert has not been included in Options. The actual position for the new row can change if the dataset has sorting or ordering capabilities.
</dd>
<dt><var><b>Home</b></var></dt>
<dd>
Changes the selected cell to first non-fixed column in the control. An active editor is removed.
</dd>
<dt><var><b>Ctrl + Home</b></var></dt>
<dd>
Moves to the first row in the dataset. An active editor is removed.
</dd>
<dt><var><b>End</b></var></dt>
<dd>
Changes the selected cell to the last visible column in the control. An active editor is removed.
</dd>
<dt><var><b>Ctrl + End</b></var></dt>
<dd>
Moves to the last row in the dataset. An active editor is removed.
</dd>
<dt><var><b>Space</b></var></dt>
<dd>
Toggles the value in a column which uses a checkbox editor.
</dd>
<dt><var><b>Ctrl + Multiply (Num Pad *)</b></var></dt>
<dd>
Toggles the selected state for the current row when dgMultiSelect is included in Options.
</dd>
</dl>
<p>
<var>KeyDown</var> reads and writes values in GridFlags as needed while handling cell editors and performing dataset navigation.
</p>
<p>
<var>KeyDown</var> calls the inherited <var>KeyDown</var> method to process keys not explicitly handled by the data-aware control.
</p>
<p>
<var>KeyDown</var> signals the <var>OnKeyDown</var> event handler when it has been assigned for the control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.KeyDown.Key">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.KeyDown.Shift">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.LinkActive">
<short>
<var>LinkActive</var> updates the control after a change to the state of its DataLink
</short>
<descr>
<p>
<var>LinkActive</var> is a procedure which updates the control when the state of its DataLink is changing. Value contains False when the dataset for the DataLink will be closed. The state change causes updates to control properties like SelectedRows and the KeyBookmark which tracks the selected row in the linked dataset. LinkActive calls RemoveAutomaticColumns to remove automatic columns added to the control when the DataLink became active. The LayoutChanged method is called to refresh the control after updates to the Columns property.
</p>
<p>
No actions are performed in the method when Value contains True.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.LinkActive.Value">
<short>True when the dataset is open</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.LayoutChanged">
<short>
<var>LayoutChanged</var> links columns to Fields and inserts any required automatic columns
</short>
<descr>
<p>
<var>LayoutChanged</var> is a virtual procedure used to link Columns to the Fields which read and write the values used in the control. LayoutChanged calls the TDBGridColumns.LinkFields method establish the column-to-fiels association. If Columns have not been explicitly defined the AddAutomaticColumns method is called to add a column for each Field in the linked dataset.
</p>
<p>
LayoutChanged calls the BeginLayout and EndLayout methods to minimize the number of times the OnLayoutChange event is signalled during updates to the control.
</p>
<p>
LayoutChanged performs no actions when ComponentState indicates the control is being destroyed (contains csDestroying).
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.Loaded" link="#rtl.Classes.TComponent.Loaded">
<short>
Performs layout operations after the control is loaded at run-time
</short>
<descr>
<p>
<var>Loaded</var> performs the notication that signals component streaming has been completed at run-time. Loaded calls the LayoutChanged method to update the visual appearance of the control. Loaded calls the inherited Loaded method
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.MoveSelection">
<short>
<var>MoveSelection</var> changes the current selection in the control
</short>
<descr>
<p>
<var>MoveSelection</var> causes the current selection in the control to be changed. MoveSelection calls the inherited MoveSelection method. If the selection change causes a different column to become active, the OnColEnter event handler is signalled (when assigned). MoveSelection calls the UpdateActive method to ensure that the correct row and/or column are drawn in the control.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.MoveSelection"/>
</seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.MouseDown">
<short>
<var>MouseDown</var> handles mouse down messages in the control and signals the <var>OnMouseDown</var> event handler
</short>
<descr>
<p>
<var>MouseDown</var> handles mouse button clicks (when cllowed) in the control. MouseDown ensures that the specified Button and State are correctly applied to the control similar to the processing provided in KeyDown method. MouseDown translates screen coordinates into the row and column numbers used in the control and performs actions needed for focus selection editing or navigation.
</p>
<p>
MouseDown signals the OnMouseDown event handler when assigned in the class instance.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.MouseDown.Button">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.MouseDown.Shift">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.MouseDown.X">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.MouseDown.Y">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.PrepareCanvas" link="#lcl.Grids.TCustomGrid.PrepareCanvas">
<short>
Prepares the Canvas to render the specified cell with the drawing state in aState
</short>
<descr>
<p>
PrepareCanvas prepares the Canvas used to render the cell at the specified position with the drawing state in aState. PrepareCanvas calls the inherited PrepareCanvas method and sets the brush color in the Canvas to the value need for fixed or focus/selected columns.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.PrepareCanvas.aCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.PrepareCanvas.aRow">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.PrepareCanvas.aState">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.SelectEditor" link="#lcl.Grids.TCustomGrid.SelectEditor">
<short>
Gets the editor used for the SelectedField in the control
</short>
<descr>
<p>
<var>SelectEditor</var> is a procedure used to get the editor used for the
SelectedField in the control. SelectEditor requires an active dataset in
DataLink to access properties and methods in SelectedField. SelectEditor uses
SelectedField to get the maximum length of the Field in the dataset and
stores the vaue in the Editor for the control.
</p>
<p>
SelectEditor calls the Inherited SelectEditor method to initialize the class used in the Editor property. SelectEditor signals the OnSelectEditor event handler (when assigned) to get a custom value for the Editor property. Please note that Editor is set to <var><b>Nil</b></var> if the OnSelectEditor event handler is not assigned for the control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.SetEditText" link="#lcl.Grids.TCustomGrid.SetEditText">
<short>
Sets the textual value for the editor in the specified cell
</short>
<descr>
<p>
SetEditText sets the textual value for the editor in the specified cell.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetEditText.ACol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetEditText.ARow">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetEditText.Value">
<short></short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.SelectCell">
<short>
Indicates if the cell at the specified coordinates can be selected in the control
</short>
<descr>
<p>
<var>SelectCell</var> is an overridden Boolean function that indicates if the cell at the specified coordinates can be selected in the control. SelectCell uses ColWidths and RowHeights to determine if the cell can be visually selected. The return value is True when both contain positive non-zero values.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.SelectCell.Result">
<short>True when the cell can be selected</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SelectCell.aCol">
<short>Column for the cell</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SelectCell.aRow">
<short>Row for the cell</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.UpdateActive">
<short>
<var>UpdateActive</var> redraws the control when the active row in the dataset is changed
</short>
<descr>
<p>
<var>UpdateActive</var> forces the control to be redrawn when the active row in the linked dataset is changed. UpdateActive requires an active dataset in DataLink with a selected record. No actions are performed in the method when the dataset is closed or contains no rows. UpdateActive calls InvalidateCell when the selected row in the control has changed. InvaidateRow is called to update the selected row in the control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.UpdateGridCounts">
<short>
Gets the total number of visible columns (or fields) in the grid
</short>
<descr>
<p>
<var>UpdateGridCounts</var> is an Integer function which gets the total number of visible columns (or fields) in the grid control.
</p>
<p>
UpdateGridCounts calls GetColumnCount to get the number of entries in the Columns collection. When Columns have been defined, and DataLink is Active, the RecCount and RowCount variables are updated. The UpdateGridColumnSizes method is used to adjust the sizes for the columns. If the linked dataset is Active, and a Row is Selected, the AdjustEditorBounds method is called.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.UpdateGridCounts.Result">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.WMVScroll" link="#lcl.Grids.TCustomGrid.WMVScroll">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.WMVScroll.Message">
<short></short>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.Columns">
<short>
Columns provides access to columns defined for the database grid control
</short>
<descr>
<p>
Columns is a TDBGridColumns property that provides access to columns defined for the database grid control. Items in the Columns collection are represented as TColumn instances and can be explictly created in the IDE at design-time, or automatically added when the OptionsExtra property includes the value dgeAutoColumns.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDBGridColumns"/>
<link id="#lcl.DBGrids.TColumn"/>
<link id="#lcl.DBGrids.TCustomDBGrid.OptionsExtra"/>
</seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.DataSource">
<short>
Provides access to the dataset displayed in the grid
</short>
<descr>
<p>
<var>DataSource</var> is a TDataSource property which provides access to the DataSet dispayed in the database grid control. Read and write access to the property are redirected to the DataLink property.
</p>
<p>
Reading the value for DataSource returns the value stored in the <var>TComponentDataLink</var> instance.
</p>
<p>
Writing the value for DataSource sets the value in the TComponentDataLink instance (when they are not the same). Write access to DataSource also resets the width of columns in the grid by calling <var>RenewColWidths</var>. <var>UpdateActive</var> is called to redraw the grid control after changes to the DataSource and Columns properties.
</p>
</descr>
<seealso>
</seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.Options" link="#lcl.DBGrids.TDBGridOptions">
<short>
Enables or disables optional features or behaviors in the grid control
</short>
<descr>
<p>
Options is a TDBGridOptions property that specifies features or behaviors that can be enabled or disabled by values stored in the property. Please note that these options are different than the TGridOption values used in the ancestor class. Options can contain zero (0) or more values from the TDBGridOption enumeration.
</p>
<p>
Options contains the following default values when the control is created:
</p>
<ul>
<li>dgColumnResize</li>
<li>dgColumnMove</li>
<li>dgTitles</li>
<li>dgIndicator</li>
<li>dgRowLines</li>
<li>dgColLines</li>
<li>dgConfirmDelete</li>
<li>dgCancelOnExit </li>
<li>dgTabs</li>
<li>dgEditing</li>
<li>dgAlwaysShowSelection</li>
</ul>
<p>
See TDBGridOption for more information about values in the enumeration.
</p>
<p>
Changing value(s) in Options causes other aspects of the grid control to be updated to reflect change(s) to the property. ChangedOptions is updated to reflect the enumeration values added or removed in the request. Some enumeration values force other features or behaviors to be disabled. For instance: row selection. Enabling row selection forces the options for editing, always displaying the editor, and row highlighting to be removed from the Options property. Finally, removing multi-selection from the Options property forces the SelectedRows and KeyBookmark properties to be cleared.
</p>
<p>
The TDBGridOption values stored in Options are different than the TGridOption values used in the ancestor class. As a result, SetOptions (the write access specifier) must translate any TDBGridOption values to their TGridOption equivalents and store them in the inherited Options property. Welcome to the dark world of inheritance in visual controls. It's tedious... just look at the code.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.ReadOnly">
<short>
Indicates if modifications are allowed in the grid control
</short>
<descr>
<p>
ReadOnly is a Boolean property that indicates if modifications are allowed in the grid control. Please note that ReadOnly applies to the visual grid control only. It does not take into account whether Fields in Columns or the DataSet in DataSource allows modifications.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnCellClick">
<short>
Event handler for mouse click in a column for the grid
</short>
<descr>
<p>
<var>OnCellClick</var> is a <var>TDBGridClickEvent</var> property that contains the event handler signalled when a mouse button is clicked in a cell for the grid control. Assign a procedure to the OnCellClick property to respond to mouse click messages in a column for the grid control.
</p>
<p>
OnCellClick is used the implementation of the CellClick method.
</p>
</descr>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnColEnter">
<short>
Event handler signalled when the mouse enters a column
</short>
<descr>
<p>
<var>OnColEnter</var> is a <var>TNotifyEvent</var> property that implements the event handler signalled when the mouse enters a column for the grid control. OnColEnter is also signalled when the grid control gains focus. Assign a procedure to the property to allow responding to the notification event. OnColEnter is triggered from the <var>MoveSelection</var> method.
</p>
</descr>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnColExit">
<short>
Event handler signalled when the mouse exits a column
</short>
<descr>
<p>
<var>OnColExit</var> is a <var>TNotifyEvent</var> property that implements the event handler signalled when the mouse exits a column in the grid control. OnColExit is also signalled when the grid control loses focus. Assign a procedure to the property to allow responding to the notification event. OnColExit is triggered from the <var>BeforeMoveSelection</var> method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnColumnMoved">
<short>
Event handler signalled when the order of a column is changed
</short>
<descr>
<p>
<var>OnColumnMoved</var> is a <var>TMovedEvent</var> property that implements an event handler signalled when the order of a column in the grid control is changed. Assign a procedure to the event handler to respond to the event notification. OnColumnMoved is triggered from the <var>ColRowMoved</var> method after the new column ordering has been applied.
</p>
<p>
Use <var>OnRowMoved</var> to responding to row ordering notification events.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnDrawColumnTitle">
<short>
Event handler signalled when a cell title needs to be drawn
</short>
<descr>
<p>
<var>OnDrawColumnTitle</var> is a <var>TDrawColumnCellEvent</var> property that implements the event handler signalled when a cell title in the control needs to be drawn. Assign a procedure to the event handler to perform drawing needed for the cell title using the arguments to the routine.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDrawColumnCellEvent"/>
</seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnDrawColumnCell">
<short>
Event handler signalled when a cell needs to be drawn
</short>
<descr>
<p>
<var>OnDrawColumnCell</var> is a <var>TDrawColumnCellEvent</var> property that implements the event handler signalled when a cell in the control needs to be drawn. Assign a procedure to the event handler to perform drawing needed for the cell using the arguments to the routine.
</p>
<p>
OnDrawColumnCell is triggered from the <var>DrawCell</var> method after the Canvas is prepared and any fixed cell or DefaultDrawing is performed. Please note that OnDrawColumnCell is not performed at design-time, or for fixed rows in the grid control.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TDrawColumnCellEvent"/>
</seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnFieldEditMask">
<short>
Event handler signalled to get the edit mask for a Field
</short>
<descr>
<p>
<var>OnFieldEditMask</var> is a <var>TGetDbEditMaskEvent</var> property that implements the event handler signalled to get the edit mask used for a Field in the grid control. OnFieldEditMask allows overriding the edit mask assigned to a Field in the Columns property, or assigning an edit mask for Fields that do not already have one. Assign a procedure to the event handler to allow responding to the event notification.
</p>
<p>
OnFieldEditMask is triggered from the <var>GetEditMask</var> method when the DataSet in DataLink is active.
</p>
</descr>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnTitleClick">
<short>
Event handler for mouse clicks on a Title cell
</short>
<descr>
<p>
<var>OnTitleClick</var> is a <var>TDBGridClickEvent</var> property that implements the event handler signalled when a mouse click occurs in the fixed title cell for a column. Use OnTitleClick to perform actions required when the title cell for a column is clicked. Assign a procedure to the event handler to allow responding to the event notification.
</p>
<p>
OnTitleClick is triggered from the <var>DoHeaderClick</var> method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- constructor visibility: public -->
<element name="TCustomDBGrid.Create">
<short>
</short>
<descr>
<p>
<var>Create</var> is the constructor for the <var>TCustomDBGrid</var> instance . Create calls the inherited <var>Create</var> method, and allocates resources for properties in the class instance. Create sets the default event handlers used in DataLink to the corresponding procedures in the class:
</p>
<ul>
<li>OnDataSetChanged</li>
<li>OnDataSetClose</li>
<li>OnDataSetOpen</li>
<li>OnDataSetScrolled</li>
<li>OnEditingChanged</li>
<li>OnFocusControl</li>
<li>OnInvalidDataset</li>
<li>OnInvalidDataSource</li>
<li>OnLayoutChanged</li>
<li>OnRecordChanged</li>
<li>OnUpdateData</li>
</ul>
<p>
Create calls RenewColWidths to set columns to their default widths and to disable column auto-sizing.
</p>
<p>
Create sets the values in the Options property to establish the baseline features and behavior enabled for the grid control, including:
</p>
<ul>
<li>dgColumnResize</li>
<li>dgColumnMove</li>
<li>dgTitles</li>
<li>dgIndicator</li>
<li>dgRowLines</li>
<li>dgColLines</li>
<li>dgConfirmDelete</li>
<li>dgCancelOnExit</li>
<li>dgTabs</li>
<li>dgEditing</li>
<li>dgAlwaysShowSelection</li>
</ul>
<p>
See the Options property and TDBGridOption type for more information on values in the enumeration.
</p>
<p>
Values in the Options property from the ancestor class are also updated. They use the set of enumeration values in TGridOption, and are updated to include values which correspond to the TDBGridOption values used in the database grid control.
</p>
<p>
Create sets the default values in the ExtraOptions property to the following:
</p>
<ul>
<li>dgeAutoColumns</li>
<li>dgeCheckboxColumn</li>
</ul>
<p>
The value of the AutoAdvance property is set to aaRightDown, indicating the cell navigation is from left-to-right and then top-to-bottom in the grid control.
</p>
<p>
Create sets the value in ScrollBars to ssBoth indicating that both horizontal and vertical scroll bars are needed, and sets AllowOutboundEvents to False to prevent forwarding of event notifications to the ancestor class.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.Create">TCustomGrid.Create</link>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.Create.AOwner">
<short>Owner of the component</short>
</element>
<!-- procedure visibility: public -->
<element name="TCustomDBGrid.DefaultDrawColumnCell">
<short>
Default method used for drawing cells in a column
</short>
<descr>
<p>
<var>DefaultDrawColumnCell</var> is the default method used for drawing cells in a column. DefaultDrawColumnCell uses the specified column to get the Field and the editor style needed to render the cell.
</p>
<p>
Checkbox columns are drawn by calling the DrawCheckBoxBitmaps method. Other editor styles use the DisplayText for the TField as the value drawn using the DrawCellText method. Please note that Fields with a data type of ftBlob are always rendered as the string literal <var><b>'(blob)'</b></var>.
</p>
<p>
Use the OnDrawColumnCell event handler to render a cell when DefaultDrawing is not enabed for the grid control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultDrawColumnCell.Rect">
<short>Canvas rectangle for the cell</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultDrawColumnCell.DataCol">
<short>Index of the Field for cell data</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultDrawColumnCell.Column">
<short>Column definition for the cell</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DefaultDrawColumnCell.State">
<short>Grid drawing state for the cell</short>
</element>
<!-- destructor visibility: public -->
<element name="TCustomDBGrid.Destroy">
<short>
<var>Destroy</var> is the destructor for <var>TCustomDbGrid</var>
</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor in <var>TCustomDbGrid</var>. Destroy frees any bookmarks stored in the SelectedRows property. Destroys ensures that event handlers assigned to DataLink are removed prior to freeing resources allocated to the property.
</p>
<p>
Destroy calls the inherited <var>Destroy</var> method.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.Destroy">TCustomGrid.Destroy</link>
<link id="TCustomDBGrid.DataLink"/>
<link id="TCustomDBGrid.SelectedRows"/>
</seealso>
</element>
<!-- property visibility: public -->
<element name="TCustomDBGrid.SelectedField">
<short>
Field that reads and writes data for the currently selected column
</short>
<descr>
<p>
<var>SelectedField</var> is a TField property with the Field used to read and write data for the selected column in the grid control. SelectedField is updated when column navigation occurs in the control.
</p>
<p>
GetCurrentField is the read access specifier for the property, and returns the TField instance derived by GetFieldFromGridColumn for the selected column. SetCurrentField is the write access specifier for the property, and stores the new Field value as the selected column. No action is performed if the new Field value is the same as the current value for the property.
</p>
<p>
SelectedField is used in the implementation of various method in the control, such as KeyDown, SelectEditor, UpdateData, and SwapCheckBox.
</p>
<p>
Use SelectedColumn to get the TColumn instance for the currently selected cell in the grid control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FExtraOptions"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FOnColumnSized"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FOnUserCheckboxBitmap"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FOnSelectEditor"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FDrawingMultiSelRecord"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FDrawingEmptyDataset"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FDefaultColWidths"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FGridStatus"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FOldControlStyle"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FCheckedBitmap"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FUnCheckedBitmap"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FGrayedBitmap"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FSelectedRows"/>
<!-- variable visibility: private -->
<element name="TCustomDBGrid.FOnPrepareCanvas"/>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.EmptyGrid">
<short>
Clears the data display area for the grid control
</short>
<descr>
<p>
<var>EmptyGrid</var> is a procedure used to clear the data content for the grid control. EmptyGrid calls the <var>Clear</var> method to remove the visual display for data in the grid control. Please note that stored data is not removed; only the visual display for the control is affected. EmptyGrid ensures that fixed display columns are retained. EmptyGrid also resets the width of the row indicator to its default value when <var>dgIndicator</var> is included in the <var>Options</var> for the control.
</p>
<p>
EmptyGrid is used in the implementation of the <var>DoLayoutChanged</var> method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetCurrentColumn">
<short>
Read access specifier for the SelectedColumn property
</short>
<descr>
<p>
<var>GetCurrentColumn</var> is a <var>TColumn</var> function used as the read access specifier for the SelectedColumn property. GetCurrentColumn checks the <var>Columns</var> property to ensure that it is enabled for the control. The return value is the TColumn instance stored at SelectedIndex in Columns when Enabled. The return value is <var>Nil</var> if Columns has not been enabled for the control.
</p>
<p>
Use SelectedColumn to get the currently selected column in the grid control. Use SelectedField to the TField which reads and writes data for the currently selected column in the grid control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetCurrentColumn.Result">
<short></short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.GetSelectedIndex">
<short>
Read access specifier for the SelectedIndex property
</short>
<descr>
<p>
<var>GetSelectedIndex</var> is an Integer function used as the read access specifier for the <var>SelectedIndex</var> property. GetSelectedIndex returns the ordinal position of the currently selected column in the Columns property. If Columns has not been Enabled for the control, the ordinal position of the Field for the currently selected column is returned.
</p>
<p>
Use SelectedIndex to read or write values for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetSelectedIndex.Result">
<short>Ordinal position of the currently selected column</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.SetExtraOptions">
<short>
Write access specifier for the ExtraOptions property
</short>
<descr>
<p>
<var>SetExtraOptions</var> is a procedure used as the write access specifier for the <var>ExtraOptions</var> property. SetExtraOptions ensures that new <var>TDBGridExtraOption</var> values in AValue are properly applied to the grid control. This includes repainting the control when Checkbox columns are enabled or disabled, and when adding or removing the automatic columns option. SetExtraOptions calls <var>UpdateActive</var> when automatic columns have been added or removed.
</p>
<p>
Use ExtraOptions to read or write values in the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetExtraOptions.AValue">
<short>New value for the ExtraOptions property</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.SetSelectedIndex">
<short>
Write access specifier for the SelectedIndex property
</short>
<descr>
<p>
<var>SetSelectedIndex</var> is a procedure used as the write access specifier for the <var>SelectedIndex</var> property. SetSelectedIndex updates the ordinal position of the currently selected column to the specified value.
</p>
<p>
Use SelectedIndex to read or write values for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SetSelectedIndex.AValue">
<short>New value for the SelectedIndex property</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.ValidDataset">
<short>
Indicates the DataLink contains a valid and active Dataset
</short>
<descr>
<p>
ValidDataSet is a Boolean function used to indicate if the DataLink for the control contains a valid and active Dataset. The return value is True when DataLink has a Dataset assigned to the property, and it has been marked as Active.
</p>
<p>
ValidDataSet is used in the implementation of various methods including KeyDown, MouseDown, and DoExit.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.ValidDataset.Result">
<short>True when the control points to a valid dataset</short>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.InsertCancelable">
<short>
Indicates if the dataset can cancel an active insert
</short>
<descr>
<p>
InsertCancelable is a Boolean function that indicates if the dataset for the control can cancel an active insert operation. InsertCancelable uses the DataSet in DataLink to ensure that the State contains dsInsert. The return value is False if DataSet state has any value other than dsInsert. InsertCancelable also examines both DataSet and DataLink to see if either of their Modified properties has been set. The return value is False when either has been modified.
</p>
<p>
InsertCancelable is used in the implementation of methods like KeyDown, MouseDown, and DoExit.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.InsertCancelable.Result">
<short>True when the insert can be cancelled</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.StartUpdating">
<short>
Prepares the grid control for updates to its display area
</short>
<descr>
<p>
StartUpdating is a procedure used to prepare the grid control for updates to its display area. StartUpdating checks the value from UpdatingData to see if the procedure has already been called. No actions are performed in the method when UpdatingData returns True.
</p>
<p>
StartUpdating updates the GridStatus property to include the value gsUpdatingData. The value in the ControlStyle property is also updated to include the value csActionClient. FInally, the LockEditor method is called to prevent changes in the editor control while the update is in progress.
</p>
<p>
StartUpdating and EndUpdating are used in the implementation of the UpdateData method to prevent multiple calls to UpdateData.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.EndUpdating">
<short>
Restores the status of the control after updating its display area
</short>
<descr>
<p>
EndUpdating is a procedure used to restore the status of the control after an update to its display area. EndUpdating ensures that the value gsUpdatingData is removed from the GridStatus property, and restores the value in ControlStyle to its value prior to starting the update; the value csActionClient is removed from the property. The UnLockEditor method is called to re-enable an editor control in the grid.
</p>
<p>
StartUpdating and EndUpdating are used in the implementation of the UpdateData method to prevent multiple calls to UpdateData.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: private -->
<element name="TCustomDBGrid.UpdatingData">
<short>
Indicates if UpdateData has already been called for the control
</short>
<descr>
<p>
UpdatingData is a Boolean function that indicates if the UpdateData method has already been called for the grid control. UpdatingData returns True if the GridStatus property contains the value gsUpdatingData. This GridStatus value is added in the StartUpdating method. UpdatingData prevents multiple calls to UpdateData.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.UpdatingData.Result">
<short>True when UpdateData has been called for the control</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.SwapCheckBox">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.ToggleSelectedRow">
<short>
Toggles the bookmark in SelectedRows for the current grid row
</short>
<descr>
<p>
<var>ToggleSelectedRow</var> is a procedure used add or remove the bookmark for the current row in the <var>SelectedRows</var> property. ToggleSelectedRow calls the <var>SelectRecord</var> method to toggle the value in SelectRows using its <var>CurrentRowSelected</var> property. ToggleSelectedRow is used in the <var>KeyDown</var> or <var>MouseDown</var> methods when <var><b>Ctrl + Multiply</b> (Num Pad *)</var> or <var><b>Ctrl + MBLeft</b></var> are pressed.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.SelectRecord">
<short>
Changes the selection in the SelectedRows property
</short>
<descr>
<p>
SelectRecord is a procedure used to change the SelectedRows.CurrentRowSelected property to the specified value. SelectRecord checks the Options property to see if the value dgMultiSelect is included, and updates SelectedRows.CurrentRowSelected. No action is performed in the method if Options does not include the value dgMultiSelect.
</p>
<p>
SelectRecord is used in the implementation of various methods such as KeyDown, MouseDown, ToggleSelectedRow, and ClearSelection.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.SelectRecord.AValue">
<short>True when the current record should be selected</short>
</element>
<!-- procedure visibility: private -->
<element name="TCustomDBGrid.GetScrollbarParams">
<short>
Adjusts scrollbars using the record count and the visible rows for the control
</short>
<descr>
<p>
GetScrollbarParams is a procedure used to adjust scrollbars using the record count for the dataset and the number of visible rows for the control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetScrollbarParams.aRange">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetScrollbarParams.aPage">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetScrollbarParams.aPos">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.AddAutomaticColumns">
<short>
Adds a column for each Field in the dataset
</short>
<descr>
<p>
<var>AddAutomaticColumns</var> is a procedure used to add a column for each Field in the dataset.
</p>
<p>
Please note that AddAutomaticColumns can be performed at run-time only; no actions are performed in the method at design-time.
</p>
<p>
AddAutomaticColumns requires an active dataset to access the Fields that must be added to the grid control. No actions are performed if the datasset in DataLink has not been assigned or marked as Active.
</p>
<p>
AddAutomaticColumns cannot be performed when GridStatus contains either gsRemovingAutoColumns or gsLoadingGrid. No actions are performed in the method when these values are included in the GridStatus property.
</p>
<p>
AddAutomaticColumns is enabled by including the value dgeAutoColumns in the OptionsExtra property. No actions are performed in the method when the feature has not been included in the OptionsExtra property.
</p>
<p>
AddAutomaticColumns uses DataLink to get the Fields for the dataset, and checks the Columns collection to see if a column already exists for each Field. If the Field is already in the collection, it is skipped to avoid duplicate Fields. Missing Fields are added to Columns using its Add method, and sets the IsAutomaticColumn and Visible properties to True for each. When missing Fields have been added, the ResetColumnsOrder method in Columns is called using the coFieldIndexOrder column ordering option.
</p>
<p>
AddAutomaticColumns updates the GridStatus property prior to adding columns to include the value gsAddingAutoColumns. The value is removed from GridStatus when adding columns has completed. This prevents the TDBGridColumns.Add method from removing automatic columns while the add operation is still active.
</p>
<p>
See RemoveAutomaticColumns for information about removing automatic columns in the Columns collection.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.InvalidateSizes">
<short>
<var>InvalidateSizes</var> renders the Sizes non-valid
</short>
<descr>
<p>
<var>InvalidateSizes</var> is a procedure used to force the grid to recalculate column sizes and to repaint its display area. InvalidateSizes updates the GridFlags for the control to include the value gfVisualChange.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.ColumnEditorStyle">
<short>
<var>ColumnEditorStyle</var> gets the button style for the column being edited
</short>
<descr>
<p>
<var>ColumnEditorStyle</var> is a TColumnButtonStyle function used to get the button style for the specified column number or Field in the grid control. ColumnEditorStyle assumes the default button style is cbsAuto unless overridden by settings in the Columns collection or by the Field definition in the dataset.
</p>
<p>
ColumnEditorStyle calls ColumnFromGridColumn to get the TColumn instance for the specified column number. Its ButtonStyle property is used as the return value if Columns has been Enabled. Otherwise, DefaultEditorStyle is called for the specified TField to get the return value for the method. DefaultEditorStyle will use cbsCheckBoxColumn as the button style when dgeCheckboxColumn has been included in the OptionsExyta property.
</p>
<p>
ColumnEditorStyle is used in the implementation of various methods including: CellClick, DefaultDrawCell, DefaultDrawColumnCell, EditorByStyle, KeyDown and MouseDown.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.ColumnEditorStyle.Result">
<short>Button style for the column or Field</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ColumnEditorStyle.aCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.ColumnEditorStyle.F">
<short></short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.DoMouseWheelDown">
<short>
Handle mouse wheel down events in the grid control
</short>
<descr>
<p>
<var>DoMouseWheelDown</var> is an overridden Boolean function used to handle mouse wheel down events in the grid control. The return value is True when the mouse wheel event has been handled in the method. DoMouseWheelDown signals the OnMouseWheelDown event handler when it has been assigned to handle the mouse event. If OnMouseWheelDown cannot handle the mouse event, and the DataLink is marked as Active, DataLink calls its MoveBy method.
</p>
</descr>
<seealso>
<link id="#lcl.Controls.TControl.DoMouseWheelDown"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.DoMouseWheelDown.Result">
<short>True when the mouse event is handled in the method</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DoMouseWheelDown.Shift">
<short>Shift state for the mouse wheel event</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DoMouseWheelDown.MousePos">
<short>Location of the mouse wheel event</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.DoMouseWheelUp">
<short>
Handle mouse wheelup events in the grid control
</short>
<descr>
<p>
<var>DoMouseWheelUp</var> is an overridden Boolean function used to handle mouse wheel up events in the grid control. The return value is True when the mouse wheel event has been handled in the method. DoMouseWheelUp signals the OnMouseWheelUp event handler when it has been assigned to handle the mouse event. If OnMouseWheelUp cannot handle the mouse event, and the DataLink is marked as Active, DataLink calls its MoveBy method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.DoMouseWheelUp.Result">
<short>True when the mouse event is handled in the method</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DoMouseWheelUp.Shift">
<short>Shift state for the mouse wheel event</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DoMouseWheelUp.MousePos">
<short>Location of the mouse wheel event</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DoPrepareCanvas">
<short>
Prepares the canvas and signals OnPrepareCanvas
</short>
<descr>
<p>
<var>DoPrepareCanvas</var> is an overridden procedure used to prepare the Canvas to draw a cell in the grid control. DoPrepareCanvas applies to data cells and performs no actions in the method when aRow refers to a fixed row in the control. In addition, DoPrepareCanvas applies only when DefaultDrawing contains False. No actions are performed in the method when DefaultDrawing is enabled.
</p>
<p>
DoPrepareCanvas calls GetSelectedState to determine if the Canvas is updated with brush and font colors used to draw in a selected state. DoPrepareCanvas signals the OnPrepareCanvas event handler when it has been assigned for the control using the specified column number and drawing state.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.DoPrepareCanvas"/>
</seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DoPrepareCanvas.aCol">
<short>Column number for the operation</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DoPrepareCanvas.aRow">
<short>Row number for the operation</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DoPrepareCanvas.aState">
<short>Drawing state for the operation</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DrawAllRows" link="#lcl.Grids.TCustomGrid.DrawAllRows">
<short>
Draws all data rows in grid control
</short>
<descr>
<p>
DrawAllRows is an overridden procedure used to draw all data rows for the control. DrawAllRows checks the DataLink property to determine if a DataSet is available for the operation. When DataLink is marked as Active, its ActiveRecord is used to reposition the DataSet when the drawing operation is completed. DrawAllRows calls the inherited method and restores the position of the DataSet prior to exiting from the method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DrawCheckboxBitmaps">
<short>
Draws a Checkbox bitmap for the specified Boolean column
</short>
<descr>
<p>
<var>DrawCheckboxBitmaps</var> is a procedure used to draw the Checkbox bitmap for the specified column. DrawCheckboxBitmaps draws the checkbox bitmap only when the editor for the column is not visible; otherwise, no actions are performed in the method.
</p>
<p>
DrawCheckboxBitmaps examines the specified Field argument to ensure that it uses a Boolean data type. If the Field IsNull, the value cbGrayed is assigned to the aState argument. Otherwise, the TField.AsBoolean method is used to determine if aState is set to cbChecked or cbUnChecked. For Fields that do not use ftBoolean in the data type, the TField.AsString method is used to determine if the Field matches the value in TColumn.ValueChecked or TColumn.ValueUnChecked.
</p>
<p>
DrawCheckboxBitmaps signals the DrawCheckboxBitmaps event handler when it has been assigned in the control.
</p>
<p>
DrawCheckboxBitmaps calls the DrawGridCheckboxBitmaps method to render the Checkbox bitmap with the necessary drawing state.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawCheckboxBitmaps.aCol">
<short>Column number to draw</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawCheckboxBitmaps.aRect">
<short>Canvas rectangle for the operation</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawCheckboxBitmaps.F">
<short>Field with data for the column</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.DrawFixedText">
<short>
Draws the fixed text at the specified row and column numbers
</short>
<descr>
<p>
DrawFixedText is a procedure used to draw a cell with fixed text at the specified row and column numbers. DrawFixedText calls the DrawIndicator method for the active record when aCol contains 0 (zero) and Options incudes the value dgIndicator. Otherwise, the DrawColumnText method is called using the aguments passed to the method.
</p>
<p>
DrawFixedText is used in the implementation for the DefaultDrawCell method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawFixedText.aCol">
<short>Column number to draw</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawFixedText.aRow">
<short>Row number to draw</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawFixedText.aRect">
<short>Canvas rectangle for the drawing operation</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.DrawFixedText.aState">
<short>Drawing state for the operation</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetBufferCount">
<short>
Gets the number of rows to buffer in the grid control
</short>
<descr>
<p>
<var>GetBufferCount</var> is a virtual Integer function used to get the number of rows to buffer for display in the grid control. The return value contains the number of rows that can be displayed using the DefaultRowHeight for the control. The return value is decreased by 1 when column titles are enabled in the Options property with the dgTitles enumeration value.
</p>
<p>
GetBufferCount is called from the UpdateBufferCount method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetBufferCount.Result">
<short>Number of data rows visible in the grid control</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetDefaultColumnAlignment">
<short>
Gets the default alignment for the column
</short>
<descr>
<p>
<var>GetDefaultColumnAlignment</var> is an overridden TAlignment function used to get the default alignment for data at the specified column number. GetDefaultColumnAlignment gets the TField for the specified column when assigned, and uses its Alignment property as the return value for the method. The value taLeftJustify is used when a TField cannot be found for the specified column number.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetDefaultColumnAlignment.Result">
<short>Default alignment for the column</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetDefaultColumnAlignment.Column">
<short>Column number to use from the dataset</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetDefaultColumnWidth">
<short>
Gets the default width for the specified column
</short>
<descr>
<p>
<var>GetDefaultColumnWidth</var> is an overridden Integer function used to get the default width for the specified column number. GetDefaultColumnWidth calls the DefaultFieldColWidth method for the specified column. The return value is the width of the column calculate using either the display name or the display width for the TField in the column.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetDefaultColumnWidth.Result">
<short>Default width of the column</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetDefaultColumnWidth.Column">
<short>Column number to use for the calculation</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetDefaultColumnReadOnly">
<short>
Gets the default ReadOnlyvalue for the specifed column
</short>
<descr>
<p>
<var>GetDefaultColumnReadOnly</var> is an overridden Boolean function used to get the ReadOnly value for the grid control. GetDefaultColumnReadOnly determines the effective read only status for the control using the ReadOnly property as well as the DataLink property and the TField used for the specified column.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetDefaultColumnReadOnly.Result">
<short>True when the column cannot be modified</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetDefaultColumnReadOnly.Column">
<short>Column number to examine</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetDefaultColumnTitle">
<short>
Gets the default title displayed for the specified column
</short>
<descr>
<p>
<var>GetDefaultColumnTitle</var> is an overridden String function used to get the default title displayed for the specified column number. GetDefaultColumnTitle gets the TField used for the column (when available) and uses its DisplayName as the return value for the method. The return value is an empty String ('') when a TField instance is not available for the specified column.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetDefaultColumnTitle.Result">
<short>Default title for the column</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetDefaultColumnTitle.Column">
<short>Column number to locate in the Fields for the grid control</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetDefaultRowHeight">
<short>
Get the default row height for records displayed in the grid
</short>
<descr>
<p>
<var>GetDefaultRowHeight</var> is an overriden Integer function used to get the default row height for records displayed in the grid control. GetDefaultRowHeight calls the inherited GetDefaultRowHeight method to get the return vaue for the method. The calculated row height is decreased by 2 pixels to allow space for borders on the editors overlaid onto the grid control.
</p>
</descr>
<seealso>
<link id="#lcl.Grids.TCustomGrid.GetDefaultRowHeight"/>
</seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetDefaultRowHeight.Result">
<short>Default height for records displayed in the control</short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetImageForCheckBox">
<short>
Gets the bitmap displayed for a Checkbox at the specified location
</short>
<descr>
<p>
GetImageForCheckBox is an overridden TBitmap function used to get the bitmap displayed for a Checkbox at the specified location in the grid control. GetImageForCheckBox calls the inherited GetImageForCheckBox method using the passed arguments to get the return value. GetImageForCheckBox signals the OnUserCheckboxBitmap event handler when it has been assigned in the control to allow overriding the TBitmap used for the desired TCheckboxState.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetImageForCheckBox.Result">
<short>Bitmap to display for the Checkbox column</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetImageForCheckBox.aCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetImageForCheckBox.aRow">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetImageForCheckBox.CheckBoxView">
<short>Checkbox state for the column</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetImageForCheckBox.ImageList">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetImageForCheckBox.ImageIndex">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetImageForCheckBox.Bitmap">
<short></short>
</element>
<!-- function visibility: protected -->
<element name="TCustomDBGrid.GetIsCellSelected" link="#lcl.Grids.TCustomGrid.GetIsCellSelected">
<short>
Determines if the cell at the specifed location is currently selected
</short>
<descr>
<p>
<var>GetIsCellSelected</var> is an overridden Boolean function used to determine if the cell at the specifed location is currently selected. GetIsCellSelected calls the inherited method to get the return value, and also examines the value in DrawingMultiSelRecord. The return value is True when the cell is either selected or multi-selected.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.GetIsCellSelected.Result">
<short>True when the specified cell is selected or muilti-selected</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetIsCellSelected.aCol">
<short>Column number to examine</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetIsCellSelected.aRow">
<short>Row number to examine</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.GetSBVisibility" link="#lcl.Grids.TCustomGrid.GetSBVisibility">
<short>
Determines the visibility of horizontal and vertical scroll bars for the control
</short>
<descr>
<p>
GetSBVisibility is an overridden procedure used to determine the visibility of horizontal and vertical scroll bars for the control. GetSBVisibility calls the inherited method to use the logic implemented in the ancestor class. GetSBVisibility overrides the value used for the vertical scroll bar; it is set to True when ScrollBars contains ssVertical or ssBoth. ScrollBarAutomatic is called when the vertical scroll bar is not visible, and the GetScrollbarParams method is used to update the vertical scrollbar settings.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetSBVisibility.HsbVisible">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetSBVisibility.VsbVisible">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.GetSBRanges" link="#lcl.Grids.TCustomGrid.GetSBRanges">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetSBRanges.HsbVisible">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetSBRanges.VsbVisible">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetSBRanges.HsbRange">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetSBRanges.VsbRange">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetSBRanges.HsbPage">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.GetSBRanges.VsbPage">
<short></short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.RemoveAutomaticColumns">
<short>
Removes automatic columns added to the grid control
</short>
<descr>
<p>
<var>RemoveAutomaticColumns</var> is a procedure used to remove automatic columns added to the grid control in the AddAutomaticColumns method. Automatic columns are generated at run-time when the value dgeAutoColumns is included in the OptionsExtra property. The feature cannot be enabled at design-time. No actions are performed in the method at design-time.
</p>
<p>
RemoveAutomaticColumns uses the Columns property to execute its RemoveAutoColumns method which removes the automatic columns in the collection.
</p>
<p>
RemoveAutomaticColumns is used in the implementation of the LinkActive and the SetExtraOptions methods.
</p>
<p>
Use the OptionsExtra property to control adding and removing automatic columns at run-time.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.WndProc" link="#lcl.Controls.TControl.WndProc">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.WndProc.TheMessage">
<short></short>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.GridStatus">
<short>
Stores status information about operations active for the grid control
</short>
<descr>
<p>
<var>GridStatus</var> is a TDBGridStatus property which stores status information for the grid control. GridStatus is a set type that can contain 0 (zero) or more values from the TDbGridStatusItem enumeration, and indicate operations occuring in the control at run-time. Values in GridStatus are added and removed in several methods for the grid control to prevent duplicate calls the method while the operation is active.
</p>
<p>
See TDbGridStatusItem for more information about the values in the enumeration and their meaning.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OptionsExtra">
<short>
Contains the extra options enabled for the grid control
</short>
<descr>
<p>
<var>OptionsExtra</var> is a TDBGridExtraOptions property used to store extra options enabled for the grid control. OptionsExtra is a set data type which can contain 0 (zero) or more values from the TDBGridExtraOption enumeration. The default values in the property include dgeAutoColumns and dgeCheckboxColumn; these values enable the use of automatic columns for the linked dataset and displaying checkboxes for Boolean columns.
</p>
<p>
SetExtraOptions is the write access specifier for the property, and ensures that the grid control is updated to reflect values added to or removed from the set.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.SelectedRows">
<short>
<var>SelectedRows</var> - recorded as a bookmark list
</short>
<descr>
<p>
<var>SelectedRows</var> is a read-only TBookmarkList property used to store TBookmark instance for one or more rows selected in the grid control. SelectedRows will normally contain a single TBookmark entry in its Items property for a selected row. However, multiples entry can exist when multi-selection is enabled by including the value dgMultiSelect in the Options property.
</p>
<p>
SelectedRows is updated when methods which perform record navigation call the DrawRow, SelectRecord or ToggleSelectedRow methods.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnColumnSized">
<short>
Event handler signalled when a grid column has been resized
</short>
<descr>
<p>
<var>OnColumnSized</var> is a TNotifyEvent propety that implements the event handler signalled when a column has been resized. OnColumnSized allows the application to perform actions required after the column has been resized. Assign a procedure to the event handler to respond to the event notification.
</p>
<p>
OnColumnSized is triggered from the HeaderSized method when a change to a column width was requested.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnPrepareCanvas">
<short>
Event handler signalled to prepare the grid canvas for drawing a cell
</short>
<descr>
<p>
<var>OnPrepareCanvas</var> is a TPrepareDbGridCanvasEvent property that implements the event handler signalled to prepare the Canvas for drawing a cell in the grid. OnPrepareCanvas allows the application to provide custom settings in the Canvas for the Grid control. The <var>Sender</var> argument is the grid control, and can be used to access the Canvas or other properties in the component. Assign a procedure to the event handler to respond to the event notification.
</p>
<p>
OnPrepareCanvas is signalled from the DoPrepareCanvas method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnPrepareCanvas.sender">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnPrepareCanvas.DataCol">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnPrepareCanvas.Column">
<short></short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.OnPrepareCanvas.AState">
<short></short>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnSelectEditor">
<short>
Event handler signalled when the editor is selected for a Field in the grid
</short>
<descr>
<p>
<var>OnSelectEditor</var> is a TDbGridSelEditorEvent property that implements the event handler signalled when an editor control is selected for the current Field in the grid. OnSelectEditor is used to modify or override the editor control for SelectedField in the grid control.
</p>
<p>
OnSelectEditor is signalled in the SelectEditor method after the default editor control has be chosen and its maximum length has been set. Assign a procedure to the event hander which modifies or assigns the control in the Editor argument.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: protected -->
<element name="TCustomDBGrid.OnUserCheckboxBitmap">
<short>
Event handler signalled to get the image used for a checkbox entry on the grid
</short>
<descr>
<p>
<var>OnUserCheckboxBitmap</var> is a property that implements the <var>TDBGridCheckboxBitmapEvent</var> event handler signalled to get the image used for a checkbox entry on the grid. OnUserCheckboxBitmap allows the application to override the TBitmap provided by the GetImageForCheckBox method. Assign a procedure to the event handler that implements the TDBGridCheckboxBitmapEvent interface to enable the event handler.
</p>
<p>
The user is encouraged to provide bitmaps to represent the three states for
database grid checkboxes: <var>gcbpUnChecked</var>, <var>gcbpChecked</var> and
<var>gcbpGrayed</var>.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: public -->
<element name="TCustomDBGrid.InitiateAction">
<short>
Initiates the action associated with the grid control
</short>
<descr>
<p>
<var>InitiateAction</var> is an overridden procedure used to initiate the action associated with the grid control. InitiateAction calls the inherited InitiateAction method. The EndUpdating method is called when GridStatus includes the value gsUpdatingData.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function visibility: public -->
<element name="TCustomDBGrid.EditorByStyle" link="#lcl.Grids.TCustomGrid.EditorByStyle">
<short>
Gets an editor control with the specified button style
</short>
<descr>
<p>
<var>EditorByStyle</var> is an overridden TWinControl function used to a get an editor control with the specified button style. EditorByStyle calls the ColumnEditorStyle method to get the button style for the current column and SelectedField. This allows the grid to override the cbsAuto button style when the SelectedField contains a Boolean data type. EditorByStyle calls the inherited method using the TColumnButtonStyle derived in the method as an argument. The editor control in the return value is supplied by the inherited EditorByStyle method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- function result visibility: default -->
<element name="TCustomDBGrid.EditorByStyle.Result">
<short>Editor control for the specified button style</short>
</element>
<!-- argument visibility: default -->
<element name="TCustomDBGrid.EditorByStyle.Style">
<short>Button style to use in the editor control</short>
</element>
<!-- procedure visibility: public -->
<element name="TCustomDBGrid.ResetColWidths">
<short>
Restores column widths to their default values
</short>
<descr>
<p>
<var>ResetColWidths</var> is a procedure used to restore column widths in he grid to their default values. ResetColWidths uses the value in DefaultColWidths to determine if default column widths are already in use. When DefaultColWidths contains True, no actions are performed in the method.
</p>
<p>
ResetColWidths calls the RenewColWidths method to restore the column widths. The LayoutChanged method is called to refresh the grid control after the column layouts are altered.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TCustomDBGrid.SelectedIndex">
<short>
Ordinal position of the selected column in the grid control
</short>
<descr>
<p>
<var>SelectedIndex</var> is an Integer property that represents the ordinal position of the selected column in the grid control. The property value contains the result from ColumnIndexFromGridColumn when the Columns collection is enabled in the control. Otherwise, the value from FieldIndexFromGridColumn is used as the property value.
</p>
<p>
GetSelectedIndex is the read access specifier for the property value. SetSelectedIndex is the write access specifier for the property.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TCustomDBGrid.SelectedColumn">
<short>
Represents the currently selected column in the grid control
</short>
<descr>
<p>
<var>SelectedColumn</var> is a read-only TColumn property that represents the currently selected column in the grid control. SelectedColumn contains a value only when the Columns collection has been enabled (or contains visible columns) for the control. Otherwise, SelectedColumn returns the value <var><b>Nil</b></var>.
</p>
<p>
GetCurrentColumn is the read access specifier for the property value, and returns the TColumn instance in Columns at the position specified in SelectedIndex.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibiity: private -->
<element name="TCustomDBGrid.OnFocusControl">
<short>Implements an event handler signalled when a control gets focus</short>
<descr>
<p>
<var>OnFocusControl</var> is a procedure which implements the event handler signalled when a control getsx focus in the database grid. It cannot be overridden. Use the OnFocusControl property in DataLink to override the event handler.
</p>
<p>
OnFocusControl ensures that SelectedField is updated with the specified Field and calls the SetFocus method. No actions are performed if CanFocus indicaters the control cannot be focused, or a column is not found for the specified Field.
</p>
</descr>
<seealso>
<link id="#lcl.DBGrids.TFocusControlEvent"/>
<link id="#lcl.DBGrids.TComponentDataLink"/>
</seealso>
</element>
<!-- argument visibiity: default -->
<element name="TCustomDBGrid.OnFocusControl.aField">
<short>Field reference for the event</short>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.MouseMove" link="#lcl.Controls.TControl.MouseMove">
<short>
Signals the OnMouseMove event handler for the grid control
</short>
<descr>
<p>
MouseMove is an overridden procedure used to signal the OnMouseMove event handler for the grid control. MouseMove signals the OnMouseMove event handler when GridState contains the value gsSelecting, and the Dragging flag has not been set. Otherwise, the inherited MouseMove method is called in the method.
</p>
</descr>
<seealso></seealso>
</element>
<!-- procedure visibility: protected -->
<element name="TCustomDBGrid.IsValidChar">
<short>
<var>IsValidChar</var> indicates if the specified Field contains the specified UTF-8 character
</short>
<descr>
<p>
<var>IsValidChar</var> is a Boolean function that indicates if the Field specified in <var>AField</var> contains the UTF-8 encoded character in <var>AChar</var>. No action is required (or performed) when <var>AChar</var> contains a single byte character.
</p>
<remark>
<p>
Please note that TField does not contain a method which verifies a Unicode character. This routine converts a multibyte Unicode character using UTF8ToSys and calls the TField.IsValidChar method to validate.
</p>
</remark>
<p>
IsValidChar returns True when TField.IsValidChar returns the same or when AChar contains the <var>BackSace (Decimal 8)</var> character.
</p>
</descr>
</element>
<!-- TDBGrid starts here -->
<!-- object visibility: default -->
<element name="TDBGrid">
<short>
Data-aware grid control for display and editing rows and columns in a dataset
</short>
<descr>
<p>
<var>TDBGrid</var> is a data-aware version of <var>TStringGrid</var> used to
display and edit a Rows and Columns in a dataset.
</p>
<p>
TDBGrid inherits many of its properties from
<link id="#lcl.Grids.TCustomGrid">TCustomGrid</link> and its immediate ancestor <link id="TCustomDBGrid">TCustomDBGrid</link>.
</p>
</descr>
<seealso>
<link id="#lcl.DBCtrls.HowToUseDataAwareControls">HowToUseDataAwareControls</link>
<link id="#lcl.Grids.HowToUseGrids">HowToUseGrids</link>
</seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.Canvas" link="#lcl.Controls.TCustomControl.Canvas">
<short>
Area on the screen where various components are drawn
</short>
<descr>
<p>
Canvas is a TCanvas that represents the area of screen on which the various components are drawn.
</p>
</descr>
<seealso>
<link id="#lcl.Controls.TCustomControl.Canvas" />
</seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Align" link="#lcl.Controls.TControl.Align">
<short>
Indicates how the control is drawn relative to its parent
</short>
<descr>
<p>
<var>Align</var> is a TAlignment property that indicates how the control is drawn relative to its parent . Align can be used to read or write the alignment instructions for the control. The control may have no alignment custom or client alignment or can be aligned to top bottom left or right of its parent control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Anchors" link="#lcl.Controls.TControl.Anchors">
<descr>
<p>
Determines how the control is to be anchored to its client or parent conrol
</p>
<p>
Either reads a flag containing the set of anchors to be used, or writes a set of anchors. If they have been written this is indicated in <var>IsAnchorsStored</var>.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.AutoAdvance" link="#lcl.Grids.TCustomGrid.AutoAdvance">
<short>
Sets the auto advance option for the grid control
</short>
<descr>
AutoAdvance is a publised property in TDBGrid which sets the option used in the grid control. The default value for the property is aaRightDown.
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.AutoFillColumns" link="#lcl.Grids.TCustomGrid.AutoFillColumns">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.BorderStyle" link="#lcl.Controls.TWinControl.BorderStyle">
<short></short>
<descr>
<remarks>
A restricted set of options are available for the grid control: bsNone or bsSingle.
</remarks>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Color" link="#lcl.Controls.TControl.Color">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Columns" link="#lcl.Grids.TCustomGrid.Columns">
<descr>
<p>
Refers to the physical columns of the grid displaying the contents of the relevant <var>Fields</var>.
</p>
<p>
The <var>Columns</var> property is configurable from the Object Inspector selecting the ellipsis (...) next to the property name in which case a pop-up memo box appears to allow editing. It deals with things like the size shape and format of the display and contains a link to the appropriate Field.
</p>
<p>
Do no confuse Grid columns (in the display) with the SQL usage of COLUMNS (Fields in our environment). The Fields consist of a series of cells arranged in Records which contain the actual data which are to be displayed and operated upon.
</p>
<p>
It is entirely possible that Fields in the dataset are not displayed and the result is that Field order in a dataset may not correspond directly to the column order in a database grid; in fact the <var>Columns</var> property allows the user to configure which data Field is to be displayed in each column.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Constraints" link="#lcl.Controls.TControl.Constraints">
<short>
Sizing constraints for the control
</short>
<descr>
<p>
<var>Constraints</var> is used to read or write values that determine the
min and max values for the height and width of the control; reads the size constraints or stores new ones.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.DataSource" link="#lcl.DBGrids.TCustomDBGrid.DataSource">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.DefaultDrawing" link="#lcl.Grids.TCustomGrid.DefaultDrawing">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.DefaultRowHeight" link="#lcl.Grids.TCustomGrid.DefaultRowHeight">
<short>
Default height for rows drawn in the grid control
</short>
<descr>
<p>
DefaultRowHeight is an Integer property that contains the default height used for rows drawn in the grid control. If new rows of the grid are created by changing the <var>RowCount</var> property, the height of these new rows will be set to the value of the <var>DefaultRowHeight</var> property.
</p>
<p>
When the <link id="TCustomGrid.DefaultRowHeight.Options">Options</link> property includes the appropriate value, the row height may be changed by at run-time.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibiity: published -->
<element name="TDBGrid.DoubleBuffered" link="#lcl.Controls.TWinControl.DoubleBuffered">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibiity: published -->
<element name="TDBGrid.ParentDoubleBuffered" link="#lcl.Controls.TWinControl.ParentDoubleBuffered">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Enabled" link="#lcl.Controls.TControl.Enabled">
<short>
Determines if the grid control is enabled for navigation and editing
</short>
<descr>
<p>
<var>Enabled</var> is a published property in TDBGrid that determines if the control is available for editing and navigation. When <var>Enabled</var> contains <var>False</var>, the control usually appears 'greyed-out' or unavailable.
</p>
<p>
Use the <var>Visible</var> property to determine whether the control is displayed or hidden.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.FixedColor" link="#lcl.Grids.TCustomGrid.FixedColor">
<short>
</short>
<descr>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Flat" link="#lcl.Grids.TCustomGrid.Flat">
<short>
</short>
<descr>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Font" link="#lcl.Controls.TControl.Font">
<short>
</short>
<descr>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Options" link="#lcl.DBGrids.TCustomDBGrid.Options">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.ParentColor" link="#lcl.Controls.TControl.ParentColor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.ParentFont" link="#lcl.Controls.TControl.ParentFont">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.PopupMenu" link="#lcl.Controls.TControl.PopupMenu">
<short></short>
<descr>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.ReadOnly" link="#lcl.DBGrids.TCustomDBGrid.ReadOnly">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.ShowHint" link="#lcl.Controls.TControl.ShowHint">
<short>
Controls whether the <var>Hint</var> is displayed for the control
</short>
<descr>
<p>
Controls whether the value in the <var>Hint</var> property is shown when the mouse hovers over the control. If a value is stored for the property a storage flag is set.
</p>
<p>
Display of the actual hint is performed by the <var>OnShowHint</var> event handler.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.TabOrder" link="#lcl.Controls.TWinControl.TabOrder">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.TabStop" link="#lcl.Controls.TWinControl.TabStop">
<descr>
<p>
Reads or writes boolean flag; default is False.
</p>
<p>
Use TabStop to allow or disallow access to the control using the Tab key.
</p>
<p>
If <var>TabStop</var> is True the control is in the tab order. If <var>TabStop</var> is False the control is not in the tab order and the user can't use the Tab key to move to the control.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.TitleFont" link="#lcl.Grids.TCustomGrid.TitleFont">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Visible" link="#lcl.Controls.TControl.Visible">
<short>
<var>Visible</var> controls whether the grid control is visible
</short>
<descr>
<p>
The Visible property controls the ability to see a visual control. If Visible is True the control is shown otherwise it is hidden. Calling Show sets among other properties Visible to True. Setting Visible to False is equivalent to calling Hide method.
</p>
<remark>
The Visible property does not depend on control's parent visibility. Use
IsVisible method to consider this and get real visibility.
</remark>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnCellClick" link="#lcl.DBGrids.TCustomDBGrid.OnCellClick">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnColEnter" link="#lcl.DBGrids.TCustomDBGrid.OnColEnter">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnColExit" link="#lcl.DBGrids.TCustomDBGrid.OnColExit">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnColumnMoved" link="#lcl.DBGrids.TCustomDBGrid.OnColumnMoved">
<short>
</short>
<descr>
</descr>
<seealso></seealso>
</element>
<!-- property visibiity: published -->
<element name="TDBGrid.OnDrawColumnTitle" link="#lcl.DBGrids.TCustomDBGrid.OnDrawColumnTitle">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnDrawColumnCell" link="#lcl.DBGrids.TCustomDBGrid.OnDrawColumnCell">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnDblClick" link="#lcl.Controls.TControl.OnDblClick">
<descr>
<p>
Double-clicking is much more common in a Windows environment than in Unix or
Linux where single-clicking is the default method for selecting an object.
However in all environments there could be valid use for a double-click and
a method should be supplied if appropriate.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnEditButtonClick" link="#lcl.Grids.TCustomGrid.OnEditButtonClick">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnEnter" link="#lcl.Controls.TWinControl.OnEnter">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnExit" link="#lcl.Controls.TWinControl.OnExit">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnKeyDown" link="#lcl.Controls.TWinControl.OnKeyDown">
<short>
Event handler signalled when a key is down while the control has focus
</short>
<descr>
<p>
<var>OnKeyDown</var> is a TKeyEvent event handler signalled when a key is down
while the control has focus. OnKeyDown is called from the KeyDown method when
processing keys specific to the data-aware grid.
</p>
<p>
<var>OnKeyDown</var> differs from
<link id="#lcl.Controls.TWinControl.OnKeyPress">OnKeyPress</link>. With
<var>OnKeyDown</var> the key may have already been down when the control
receives focus. With <var>OnKeyPress</var> the key needs to become pressed
while the control has focus.
</p>
</descr>
<seealso>
<link id="TDBGrid.OnKeyPress"/>
<link id="TDBGrid.OnKeyUp"/>
<link id="#lcl.Controls.TKeyEvent"/>
</seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnKeyPress" link="#lcl.Controls.TWinControl.OnKeyPress">
<descr>
<p>
<var>OnKeyPress</var> is an event controller for a key being pressed while the control has focus.
</p>
<p>
<var>OnKeyPress</var> differs from
<link id="#lcl.Controls.TWinControl.OnKeyDown">OnKeyDown</link> in that the key needs to become pressed while the control has focus; with <var>OnKeyDown</var> the key may have already been down when the control received focus.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnKeyUp" link="#lcl.Controls.TWinControl.OnKeyUp">
<descr>
<p>
<var>OnKeyUp</var> is an event handler for instance when a key is up (not pressed) while the control has focus
</p>
<p>
The key may already have been up when the control received focus or a pressed key may become released during the time the control has focus.
</p>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnMouseDown" link="#lcl.Controls.TControl.OnMouseDown">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnMouseMove" link="#lcl.Controls.TControl.OnMouseMove">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnMouseUp" link="#lcl.Controls.TControl.OnMouseUp">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnPrepareCanvas" link="#lcl.DBGrids.TCustomDBGrid.OnPrepareCanvas">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnTitleClick" link="#lcl.DBGrids.TCustomDBGrid.OnTitleClick">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.BorderColor" link="#lcl.Grids.TCustomGrid.BorderColor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.DefaultTextStyle" link="#lcl.Grids.TCustomGrid.DefaultTextStyle">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.EditorBorderStyle" link="#lcl.Grids.TCustomGrid.EditorBorderStyle">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.EditorMode" link="#lcl.Grids.TCustomGrid.EditorMode">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.ExtendedColSizing" link="#lcl.Grids.TCustomGrid.ExtendedColSizing">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.FastEditing" link="#lcl.Grids.TCustomGrid.FastEditing">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.FocusColor" link="#lcl.Grids.TCustomGrid.FocusColor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.FocusRectVisible" link="#lcl.Grids.TCustomGrid.FocusRectVisible">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.GridLineColor" link="#lcl.Grids.TCustomGrid.GridLineColor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.GridLineStyle" link="#lcl.Grids.TCustomGrid.GridLineStyle">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.SelectedColor" link="#lcl.Grids.TCustomGrid.SelectedColor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: public -->
<element name="TDBGrid.SelectedRows" link="#lcl.DBGrids.TCustomDBGrid.SelectedRows">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.AlternateColor" link="#lcl.Grids.TCustomGrid.AlternateColor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.DragCursor" link="#lcl.Controls.TControl.DragCursor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.DragMode" link="#lcl.Controls.TControl.DragMode">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.FixedHotColor" link="#lcl.Grids.TCustomGrid.FixedHotColor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.HeaderHotZones" link="#lcl.Grids.TCustomGrid.HeaderHotZones">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.HeaderPushZones" link="#lcl.Grids.TCustomGrid.HeaderPushZones">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OptionsExtra" link="#lcl.DBGrids.TCustomDBGrid.OptionsExtra">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.Scrollbars" link="#lcl.Grids.TCustomGrid.ScrollBars">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.TitleStyle" link="#lcl.Grids.TCustomGrid.TitleStyle">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnColumnSized" link="#lcl.DBGrids.TCustomDBGrid.OnColumnSized">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnDragDrop" link="#lcl.Controls.TControl.OnDragDrop">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnDragOver" link="#lcl.Controls.TControl.OnDragOver">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnEndDrag" link="#lcl.Controls.TControl.OnEndDrag">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnFieldEditMask" link="#lcl.DBGrids.TCustomDBGrid.OnFieldEditMask">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnSelectEditor" link="#lcl.DBGrids.TCustomDBGrid.OnSelectEditor">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnStartDrag" link="#lcl.Controls.TControl.OnStartDrag">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnUserCheckboxBitmap" link="#lcl.Grids.TCustomGrid.OnUserCheckboxBitmap">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.AutoEdit" link="#lcl.Grids.TCustomGrid.AutoEdit">
<short></short>
<descr>
</descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.BorderSpacing" link="#lcl.Controls.TControl.BorderSpacing">
<short>
</short>
<descr>
</descr>
<seealso/>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.UseXORFeatures" link="#lcl.Grids.TCustomGrid.UseXORFeatures">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property visibility: published -->
<element name="TDBGrid.OnUTF8KeyPress" link="#lcl.Controls.TWinControl.OnUTF8KeyPress">
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<!-- procedure visibility: default -->
<element name="Register"/>
</module>
<!-- DBGrids -->
</package>
</fpdoc-descriptions>
|