Rosi Components

Class Hierarchy

Classes, Interfaces, Objects and Records

Functions and Procedures

Class TrDBCheckListBox

Fields

Unit

Declaration

type TrDBCheckListBox = class(TCheckListBox)

Description

DB version of TCheckListBox for n:m relationship

Hierarchy

TCheckListBox
TrDBCheckListBox

Overview

Methods

	`procedure UpdateChecklistState; virtual;`
	`procedure DoLoadItemList; virtual;`
	`procedure DoLoadItemValues; virtual;`
	`procedure DoSaveItemValues; virtual;`
	`procedure DoCancelItemValues; virtual;`
	`function CheckedCount: integer;`
	`procedure FilterItemsList; virtual;`
	`procedure SelectItemsList; virtual;`
	`procedure SetItemState(AItemIndex: integer; AChecked: boolean);`
	`procedure SetAllItemsState(AChecked: boolean);`
	`procedure StoreItemsForDuplication;`
	`procedure RestoreDuplicatedItems;`
	`function GetCheckedItemsList(Separator: string; UseItemObjectAsInt: boolean = false): string;`

Properties

	`property Field: TField read GetField;`
	`property DataField: string read GetDataField write SetDataField;`
	`property DataSource: TDataSource read GetDataSource write SetDataSource;`
	`property ReadOnly: boolean read FReadOnly write SetReadOnly default false;`
	`property DefaultPrefix: string read FDefaultPrefix write SetDefaultPrefix;`
	`property ReadOnlyColor: TColor read FReadOnlyColor write FReadOnlyColor default clBtnFace;`
	`property DBEditLabel: TDBBoundLabel read FDBEditLabel;`
	`property BoundLabel: rDBComponents.TBoundLabel read FBoundLabel;`
	`property FindEdit: TBoundButtonedEdit read FFindEdit;`
	`property FindEditSpace: integer read FFindEditSpace write SetFindEditSpace default 4;`
	`property FindItemsStyle: TFindItemsStyle read FFindItemsStyle write SetFindItemsStyle default fisNone;`
	`property CheckItemsStyle: TCheckItemsStyle read FCheckItemsStyle write SetCheckItemsStyle default chsAllItems;`
	`property OnLoadItemList: TLoadSaveItemList read FOnLoadItemList write FOnLoadItemList;`
	`property OnLoadItemValues: TLoadSaveItemList read FOnLoadItemValues write FOnLoadItemValues;`
	`property OnSaveItemValues: TLoadSaveItemList read FOnSaveItemValues write FOnSaveItemValues;`
	`property PostponedSaving: boolean read FPostponedSaving;`
	`property PostponeSaveNewRecord: boolean read FPostponeSaveNewRecord write FPostponeSaveNewRecord default false;`
	`property CheckboxUpdateMode: TCheckboxUpdateMode read FCheckboxUpdateMode write FCheckboxUpdateMode default chmCheckboxClick;`

Description

Methods

	`procedure UpdateChecklistState; virtual;`
update state of all items according dataset state

	`procedure DoLoadItemList; virtual;`
load list of available items to FAllItemsList

	`procedure DoLoadItemValues; virtual;`
load and set state (check/uncheck) of all items

	`procedure DoSaveItemValues; virtual;`
store state (check/uncheck) of all items

	`procedure DoCancelItemValues; virtual;`
cancel all changes and load previous state

	`function CheckedCount: integer;`
indicates count of checked items

	`procedure FilterItemsList; virtual;`
show list of items in CheckListBox according filter state

	`procedure SelectItemsList; virtual;`
select item in the list of items in CheckListBox according filter text

	`procedure SetItemState(AItemIndex: integer; AChecked: boolean);`
programmatically set state of one item

	`procedure SetAllItemsState(AChecked: boolean);`
programmatically set state of all items

	`procedure StoreItemsForDuplication;`
store state (check/uncheck) of all items for duplication to another record

	`procedure RestoreDuplicatedItems;`
restore state (check/uncheck) of all items from state stored by StoreItemsForDuplication

	`function GetCheckedItemsList(Separator: string; UseItemObjectAsInt: boolean = false): string;`
get list of checked items

Properties

	`property Field: TField read GetField;`
returns linked `Field`

	`property DataField: string read GetDataField write SetDataField;`

	`property DataSource: TDataSource read GetDataSource write SetDataSource;`

	`property ReadOnly: boolean read FReadOnly write SetReadOnly default false;`

	`property DefaultPrefix: string read FDefaultPrefix write SetDefaultPrefix;`
define prefix for auto-named function (name of component is set according datafield)

	`property ReadOnlyColor: TColor read FReadOnlyColor write FReadOnlyColor default clBtnFace;`
define color for not edit state

	`property DBEditLabel: TDBBoundLabel read FDBEditLabel;`
define properties of bound label

	`property BoundLabel: rDBComponents.TBoundLabel read FBoundLabel;`
define properties of bounded label

	`property FindEdit: TBoundButtonedEdit read FFindEdit;`
define properties of bound find editor

	`property FindEditSpace: integer read FFindEditSpace write SetFindEditSpace default 4;`
define horizontal space between checkbox and find edit

	`property FindItemsStyle: TFindItemsStyle read FFindItemsStyle write SetFindItemsStyle default fisNone;`
define using of Find edit box below listbox

	`property CheckItemsStyle: TCheckItemsStyle read FCheckItemsStyle write SetCheckItemsStyle default chsAllItems;`
define order of items in listbox

	`property OnLoadItemList: TLoadSaveItemList read FOnLoadItemList write FOnLoadItemList;`
event for loading of item list

	`property OnLoadItemValues: TLoadSaveItemList read FOnLoadItemValues write FOnLoadItemValues;`
event for loading of item values

	`property OnSaveItemValues: TLoadSaveItemList read FOnSaveItemValues write FOnSaveItemValues;`
event for saving of item values

	`property PostponedSaving: boolean read FPostponedSaving;`
indicate that values should be saved after saving of record (used for new record without ID value before post)

	`property PostponeSaveNewRecord: boolean read FPostponeSaveNewRecord write FPostponeSaveNewRecord default false;`
define whether postponed saving should be used for new record (to avoid database error in relationship

	`property CheckboxUpdateMode: TCheckboxUpdateMode read FCheckboxUpdateMode write FCheckboxUpdateMode default chmCheckboxClick;`
define mode for checkbox update

Generated by PasDoc 0.15.0.