Active
Osztály: TCustomClientDataSet
property Active: Boolean;
A property-ből megtudható, illetve ezen keresztül beállítható, hogy az adatkészlet meg van-e nyitva, vagy sem. Ha a property értéke hamis, akkor az adatkészlet nincs megnyitva, így semmiféle műveletet nem tudunk végezni az adatokkal.
Amikor a property-nek igaz értéket adunk, akkor a következő események történnek:
- feltölti az adatkészletet az adatokkal. Ha a FileName property meg van adva, akkor a megadott fájlból, ellenkező esetben a CommandText propert-ben megadott lekérdezés eredményével;
- generál egy BeforeOpen eseményt;
- a State property értékét dsBrowse-ra állítja;
- megnyit egy kurzort az adatbázisban;
- generál az AfterOpen eseményt.
Ha a megnyitás közben hiba történt, akkor a State property értéke dsInactive lesz, és a kurzort bezárja.
Ha hamis értéket adunk a property-nek, akkor a következő események történnek:
- generál egy BeforeClose eseményt;
- a State property értékét dsInactive-ra állítja;
- lezárja a kurzort és elmenti az adatokat a fájlba (ha a FileName property-ben megadtunk egy fájlnevet), illetve elmenti az adatokat a cache-be, ahonnan azok újra kiolvashatók az újbóli megnyitáskor;
- generál egy AfterClose eseményt.
ActiveAggs
Osztály: TCustomClientDataSet
property ActiveAggs[Index: Integer] :;
Egy tömb property, amelyből megtudható, hogy mely összesítéseket (Aggregates) támogatja az aktuális index. A tömb indexe a csoportosítás szintjét jelöli (lásd. GroupingLevel). A property egy TList objektumot ad vissza, amelynek elemei az Aggregates property-ben felsorolt összesítések valamelyikére mutatnak. A visszaadott lista természetesen csak az adott index által támogatott, és a megadott csoportosítási szinten elérhető összesítéseket tartalmazza. Ha nincs ilyen, akkor a lista üres, vagy a visszatérési érték nil.
Aggregates
Osztály: TCustomClientDataSet
property Aggregates: TAggregates;
A property egy listát tartalmaz, melynek elemei az adatkészlethez tartozó összesítések (TAggregate). Ennek segítségével különböző összesítéseket, számításokat végeztethetünk el a komponenssel, teljesen automatikusan. Minden összesítés akkor használható csak, amikor a hozzá rendelt index az aktív.
Az TAggregate osztály a következő property-kkel rendelkezik (csak a legfontosabbak):
- Active: az összesítés aktív állapotú, ebben az esetben folyamatosan frissíti az összesített értéket;
- AggregateName: az összesítés neve;
- Expression: az a kifejezés, ami ez összesített értéket számolja. Különböző függvényeket is felhasználhatunk, ezeket viszont nem ágyazhatjuk egymásba. A Sum függvénnyel a mezők adatait összesíthetjük, az Avg átlagot számol, a Min és Max függvények a minimum és maximum értékek meghatározására használhatók, valamint a Count függvény az előfordulások számát adja meg.
- GroupingLevel: meghatározza, hogy az összesítést mely csoport szinten kell elvégezni. Az alapértelmezett a 0, ami minden rekordra vonatkozik.
- IndexName: annak az indexnek a neve, amely az alcsoportokat meghatározza (ha a GroupLevel property értéke nagyobb, mint 0). Ezt mindig meg kell adni, ha a Groupinglevel porperty értéke nem 0, vagyis az összesítés nem az összes rekordra vonatkozik.
- InUse: a property logikai értéke megmondja, hogy az összesített érték elérhető-e. Ha az értéke hamis, akkor a Value függvény NULL értéket ad vissza, ellenkező esetben pedig az összesítés eredményét.
Az összesítés eredményét a Value függvénnyel kérdezhetjük le. Ha a GroupingLevel property értéke nem 0, vagyis az összesítés a rekordok egy csoportjára vonatkozik (lásd. GroupingLevel property), akkor annak a csoportnak az összesített eredményét adja meg, amelyikbe az aktuális rekord tartozik.
AggregatesActive
Osztály: TCustomClientDataSet
property AggregatesActive: Boolean;
Engedélyezi, vagy éppen letiltja az automatikus összesítéseket. Ha a property értéke hamis (ez az alapértelmezett), akkor az Aggregate property-ben felsorolt összesítések nem fognak működni, tehát az eredményük sem kérdezhető le. Ha a property értéke igaz, akkor mindegyik összesített érték kiszámítódik, amelyek az aktuális indexhez tartoznak. Ha csak egy-egy összesítést szeretnénk letiltani, akkor használjuk az összesítések TAggregate osztályának Active property-jét.
AppServer
Osztály: TCustomClientDataSet
property AppServer: IAppServer;
Az alkalmazás kiszolgáló interfészét érhetjük el ezen a property-n keresztül. Ha a komponens egy olyan provider-t használ, ami ugyanazon alkalmazáson belül található, akkor az AppServer belsőleg van létrehozva, hogy az IAppServer metódusai elérhetők legyenek a provider számára. Ha a provider egy másik, kiszolgáló alkalmazásban található, akkor az AppServer property megegyezik a kapcsolódásért felelős komponens azonos property-jével.
Az alkalmazásoknak nem kell közvetlenül használniuk az IAppServer interfészt, mivel a komponensek megoldják ezt a feladatot.
CanModify
Osztály: TCustomClientDataSet
property CanModify: Boolean;
A property értékéből megtudható, hogy az adatkészlet szerkeszthető, módosítható-e. Ha a property értéke igaz, akkor a rekordok felvétele, törlése és módosítása lehetséges, ellenkező esetben az adatok csak olvashatóak. Ha a ReadOnly property értéke hamis, akkor a CanModify property értéke igaz.
ChangeCount
Osztály: TCustomClientDataSet
property ChangeCount: Integer;
A property értéke azt adja meg, hogy hány módosítás történt az adatokon a legutóbbi változtatások tárolása óta. Az adatok véglegesítésekor a property értéke 0-ra változik.
CloneSource
Osztály: TCustomClientDataSet
property CloneSource: TCustomClientDataSet;
A CloneCursor által megadott adatkészlethez biztosít hozzáférést. Ha nem hívtuk meg a CloneCursor eljárást, akkor a property értéke nil.
CommandText
Osztály: TCustomClientDataSet
property CommandText: string;
Az adatbázis szerveren futtatandó SQL parancsot adhatjuk meg ebben a property-ben. Ez a property tulajdonképpen azt mondja meg, hogy milyen adatkészletet kell a provider-nek szolgáltatnia. Ez lehet egy SQL lekérdezés, vagy egy tárolt eljárás vagy tábla neve. Hogy pontosan mit tartalmaz, azt a CommandType property-ben lehet megadni (ez a TCustomClientDataSet osztályban nem, csak a származtatott osztályokban található meg).
Ha a kliens adatkészlet egy belső providert használ, akkor ez a property elengedhetetlen (pl. TSQLClientDataSet).
Ha a property értéke nem egy üres sztring, akkor az adatkészlet megnyitásakor elküldi a provider-nek, ami az ennek megfelelő adatkészletet (lekérdezés, tábla vagy tárolt eljárás) adja vissza, és nem a provider-ben beállított adatkészletet.
ConnectionBroker
Osztály: TCustomClientDataSet
property ConnectionBroker: TConnectionBroker;
A ConnectionBroker komponens egy új felületet szúr be a kliens adatkészlet és a kapcsolatot megvalósító (connection) komponens közé. Ezt akkor használhatjuk ki, ha az alkalmazás szerver több adatkészlet elérését teszi lehetővé ugyanazon connection komponens segítségével. Ha egy másik kiszolgálót akarunk megadni, akkor nem kell az összes kliens adatkészletnél újra beállítani a használni kívánt connection komponenst, hanem elég csak a ConnectionBroker komponensben, amit hozzárendelünk a kliens adatkészletekhez.
Data
Osztály: TCustomClientDataSet
property Data: OleVariant;
Ennek a property-nek az értéke az adatkészlet tartalma bináris formában. Mérete a DataSize property-ből olvasható ki. Ha XML formátumban szeretnénk megkapni az adatkészletet, akkor használjuk az XMLData property-t.
DataSetField
Osztály: TCustomClientDataSet
property DataSetField: TDataSetField;
Annak a komponensnek az objektuma (TDataSetField) amely ezt a kliens adatkészletet reprezentálja master-detail kapcsolatban.
Ha a property-nek értéket adunk, akkor a ProviderName, RemoteServer, és FileName property-k értékei törlődnek.
A master adatkészlet természetesen nem lehet ugyanaz, mint a kliens adatkészlet, mivel egy adatkészlet nem ágyazható egybe saját magával.
DataSize
Osztály: TCustomClientDataSet
property DataSize: Integer;
A Data property-ben bináris formában van tárolva az adatkészlet. Ebből a property-ből tudhatjuk meg ennek méretét, bájtban.
DataSource
Osztály: TCustomClientDataSet
property DataSource: TDataSource;
A property egy TCustomClientDataSet objektumra mutat (ha van ilyen), amellyel ez az adatkészlet megosztja az adatait. A property értékét a CloneCursor metódus állítja be. Ha a kliens adatkészlet nem hívta meg ezt a metódust, akkor a property értéke nil.
Delta
Osztály: TCustomClientDataSet
property Delta: OleVariant;
Ezen a property-n keresztül érhető el az az adatcsomag, ami az adatbázison végzett módosításokat tartalmazza. Ez a property szolgáltatja az adatokat az ApplyUpdates és Reconcile metódusokhoz. Ha a módosítások véglegesítésre kerülnek, akkor a property tartalma törlődik. Ha a véglegesítés során hiba lépett fel, akkor a property értéke a következőképpen alakulhat:
- az összes módosítás vissza lesz görgetve (roll back), vagyis törölve lesz, ami a property-ben volt tárolva;
- csak azok a módosítások lesznek törölve, amelyek még nem lettek véglegesítve.
DisableStringTrim
Osztály: TCustomClientDataSet
property DisableStringTrim: Boolean;
Ha a property értéke hamis, akkor sztring típusú adatok tárolásakor a felesleges szóközök törölve lesznek a sztring elejéről és végéről. Ha az értéke igaz, akkor a sztring pontosan abban a formában lesz eltárolva a rekordba, ahogyan meg lett adva.
FetchOnDemand
Osztály: TCustomClientDataSet
property FetchOnDemand: Boolean;
A property értéke meghatározza, hogy az adatok fogadása a szolgáltatótól „szükség szerint” történik-e. Az alapértelmezett értéke igaz, ami azt jelenti, hogy a szolgáltató az összes szükséges adatot elküldi az adatcsomagokban. Ha a szolgáltató nem küldi el automatikusan a BLOB mezők, illetve a detail adatkészlet adatait, akkor állítsuk a property értékét igazra.
Csak abban az esetben állítsuk a property értékét hamisra, ha az alkalmazásunk tartalmaz olyan kódot, ami megoldja az adatcsomagok fogadását a getNextpacker metódus használatával. Ha a property értéke hamis, és a szolgáltató a BLOB mezők adatait nem küldi el automatikusan (az Options property-ben a poFetchBlobsOnDemand opció nincs beállítva), akkor ezeknek az adatoknak a letöltésére a FetchBlobs metódust kell használni. Ha ugyanez a helyzet fennáll a detail adatkészletek esetében is (az Options property-ben a poFetchDetailsOnDemand opció nincs megadva), akkor ezek fogadásához a FetchDetails metódust kell használni.
FileName
Osztály: TCustomClientDataSet
property FileName: string;
Ha az adatok beolvasása és írása egy fájlban történik, akkor a fájl nevét ebben a property-ben kell megadni. Ha a property egy valós fájl nevet tartalmaz, akkor az adatok kiírása automatikusan megtörténik az adatkészlet bezárásakor. Ha a fájl már létezik, akkor az adatkészlet megnyitásakor az adatokat automatikusan beolvassa.
Amikor a komponens elmenti az adatokat a fájlba, akkor ezzel felülírja a fájlban eltárolt adatokat.
Ha az adatokat más-más fájlba szeretnénk menteni, akkor használjuk a SaveToFile metódust, illetve betöltéshez a LoadFromFile metódust az Active property értékének megváltozásakor.
Filter
Osztály: TCustomClientDataSet
property Filter: string;
A property-ben megadhatunk egy szűrő feltételt, ami a megjelenítendő rekordokra vonatkozik. Amelyik rekord megfelel a feltételnek az „látható” lesz az adatkészletben, a többi pedig nem. A szűrőt a Filtered property-vel kapcsolhatjuk be, illetve ki. Ha a Filtered property értéke hamis, akkor a szűrő feltétel figyelmen kívül marad.
A Filter-t az adatbázis szerver által támogatott SQL formátumban kell megadni. Ez egyben meghatározza a szűrési lehetőségeket is.