TDACustomFieldCollection

 

Creates a new instance.

constructor Create(aOwner: TPersistent; aFieldClass: TDAFieldClass)

Parameters:

• aOwner: owner
• aFieldClass: field class

---

Initializes the collection with the supplied parameters.

constructor Create(AOwner: TPersistent; ItemClass: TCollectionItemClass)

Parameters:

• AOwner: owner
• ItemClass: item class

---

Creates new TDAField and add it to collection

function Add: TDAField

---

Creates new TDAField, fills with specified properties and adds it to collection

function Add(const aName: string; aType: TDADataType; aSize: Integer): TDACustomField

Parameters:

• aName: field name
• aType: field type
• aSize: field size

---

Calls AssignFieldCollection if source is TDACustomFieldCollection

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Copies the contents of another collection to the object where the method is executed.

procedure AssignFieldCollection(Source: TDACustomFieldCollection)

Parameters:

• Source: Instance whose properties will be copied

---

Binds child fields with aDataset

procedure Bind(aDataset: TDataset)

Parameters:

• aDataset: dataset

---

Binds child fields with aNativeObject

procedure Bind(aNativeObject: IDASQLCommandNativeObject)

Parameters:

• aNativeObject: native object

---

Inserts a copy of an item and names it "Copy nn of " of the cloned item name.

function CloneItem(iIndex: Integer): Integer

Parameters:

• iIndex: position.

---

Gets/sets the DataDictionary property.

property DataDictionary: IDADataDictionary read write

---

Finds a field based on its name. If the specified field does not exist, FieldByName raises an exception.

function FieldByName(const aName: string): TDACustomField

Parameters:

• aName: name of the searched field

---

Allows to process events in child items.

property FieldEventsDisabled: Boolean read write

---

Provides access to specific field.

property Fields[Index: Integer]: TDACustomField read write

---

Returns an item with the specified name.

function FindField(const aName: string): TDACustomField

Parameters:

• aName: name of the searched field

---

Finds the first occurrence of the item with the supplied name. Search is case-insensitive.

function FindItem(const aName: string): TCollectionItem

Parameters:

• aName: the supplied name

---

Returns the supplied name if the item with that name is absent in the collection or adds a number to it and sequentially increments it until the result is unique.

function FindUniqueName(const iBaseName: string): string

Parameters:

• iBaseName: the supplied name

---

Does the same as FindUniqueName, but uses a template with a numeric parameter as second argument, it should be compatible with the Delphi Format function.

function FindUniqueNameEx(const iBaseName: string; const iNumberedName: string): string

Parameters:

• iBaseName: the supplied name
• iNumberedName: numeric parameter

---

Does nothing, should be implemented in the descendant.

function GetCount: Integer

---

Looks for the first occurrence of the item that has a boolean property with the name "Default" and the value true. Raises an exception if no such item can be found.

function GetDefaultItem: TCollectionItem

---

Returns default item's name

function GetItemDefault(anItem: TCollectionItem): Boolean

Parameters:

• anItem: given item

---

Gets the name of the specified item.

function GetItemName(anItem: TCollectionItem): string

Parameters:

• anItem: the specified item.

---

Specifies DA4 compatible mode.

property IsCompatibleV4: Boolean read write

---

Returns an item with the specified name.

function ItemByName(const aName: string): TCollectionItem

Parameters:

• aName: fClientFields

---

Returns the string "item".

function ItemName: string

---

Returns False.

function MergeDataDictionaries: Boolean

---

Moves the item from one position to another. Checks boundaries.

procedure MoveItem(iFromIndex: Integer; iToIndex: Integer)

Parameters:

• iFromIndex: old index
• iToIndex: new index

---

Notifies about the adding or removal of an item if the event handler is assigned. If an item with an empty name is added and items without name are not allowed, it sets the name to "Item" plus number.

procedure Notify(Item: TCollectionItem; Action: TCollectionNotification)

Parameters:

• Item: given item
• Action: action

---

This event is fired if field was updated

property OnFieldAfterUpdate: TDAFieldNotifyEvent read write
delegate:  procedure OnFieldAfterUpdate(Sender: TDACustomField)

---

This event is fired before field was updated

property OnFieldBeforeUpdate: TDAFieldNotifyEvent read write
delegate:  procedure OnFieldBeforeUpdate(Sender: TDACustomField)

---

Event handler for removing an item.

property OnItemRemoved: TDAItemRemovedEvent read write
delegate:  procedure OnItemRemoved(aSender: TObject; const aName: string)

---

Event handler for renaming an item.

property OnItemRenamed: TDAItemRenamedEvent read write
delegate:  procedure OnItemRenamed(aSender: TObject; const aOldName: string; const aNewName: string)

---

Calculates number of fields that have InPrimaryKey = True;

property PrimaryKeyFieldCount: Integer read

---

Returns a reference to a specified interface if the object supports that interface. This is one of the methods introduced by the IUnknown interface.

function QueryInterface(const IID: TGUID; out Obj: ): HResult

Parameters:

• IID: Identifier of the interface to return
• Obj: Variable to store the returned interface reference to

---

Sets a new name for the specified item.

function SetItemName(anItem: TCollectionItem; const aName: string): string

Parameters:

• anItem: item
• aName: name

---

Calls the event handler if it was assigned.

procedure TriggerOnItemRemoved(const iName: string)

Parameters:

• iName: item name

---

Calls the event handler if it was assigned.

procedure TriggerOnItemRenamed(const iOldName: string; const iNewName: string)

Parameters:

• iOldName: old name
• iNewName: new name

---

Unbinds early binded collections

procedure Unbind

 

Gets/sets the DataDictionary property.

property DataDictionary: IDADataDictionary read write

---

Allows to process events in child items.

property FieldEventsDisabled: Boolean read write

---

Provides access to specific field.

property Fields[Index: Integer]: TDACustomField read write

---

Specifies DA4 compatible mode.

property IsCompatibleV4: Boolean read write

---

Calculates number of fields that have InPrimaryKey = True;

property PrimaryKeyFieldCount: Integer read

 

Creates a new instance.

constructor Create(aOwner: TPersistent; aFieldClass: TDAFieldClass)

Parameters:

• aOwner: owner
• aFieldClass: field class

---

Initializes the collection with the supplied parameters.

constructor Create(AOwner: TPersistent; ItemClass: TCollectionItemClass)

Parameters:

• AOwner: owner
• ItemClass: item class

---

Creates new TDAField and add it to collection

function Add: TDAField

---

Creates new TDAField, fills with specified properties and adds it to collection

function Add(const aName: string; aType: TDADataType; aSize: Integer): TDACustomField

Parameters:

• aName: field name
• aType: field type
• aSize: field size

---

Calls AssignFieldCollection if source is TDACustomFieldCollection

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Copies the contents of another collection to the object where the method is executed.

procedure AssignFieldCollection(Source: TDACustomFieldCollection)

Parameters:

• Source: Instance whose properties will be copied

---

Binds child fields with aDataset

procedure Bind(aDataset: TDataset)

Parameters:

• aDataset: dataset

---

Binds child fields with aNativeObject

procedure Bind(aNativeObject: IDASQLCommandNativeObject)

Parameters:

• aNativeObject: native object

---

Inserts a copy of an item and names it "Copy nn of " of the cloned item name.

function CloneItem(iIndex: Integer): Integer

Parameters:

• iIndex: position.

---

Finds a field based on its name. If the specified field does not exist, FieldByName raises an exception.

function FieldByName(const aName: string): TDACustomField

Parameters:

• aName: name of the searched field

---

Returns an item with the specified name.

function FindField(const aName: string): TDACustomField

Parameters:

• aName: name of the searched field

---

Finds the first occurrence of the item with the supplied name. Search is case-insensitive.

function FindItem(const aName: string): TCollectionItem

Parameters:

• aName: the supplied name

---

Returns the supplied name if the item with that name is absent in the collection or adds a number to it and sequentially increments it until the result is unique.

function FindUniqueName(const iBaseName: string): string

Parameters:

• iBaseName: the supplied name

---

Does the same as FindUniqueName, but uses a template with a numeric parameter as second argument, it should be compatible with the Delphi Format function.

function FindUniqueNameEx(const iBaseName: string; const iNumberedName: string): string

Parameters:

• iBaseName: the supplied name
• iNumberedName: numeric parameter

---

Does nothing, should be implemented in the descendant.

function GetCount: Integer

---

Looks for the first occurrence of the item that has a boolean property with the name "Default" and the value true. Raises an exception if no such item can be found.

function GetDefaultItem: TCollectionItem

---

Returns default item's name

function GetItemDefault(anItem: TCollectionItem): Boolean

Parameters:

• anItem: given item

---

Gets the name of the specified item.

function GetItemName(anItem: TCollectionItem): string

Parameters:

• anItem: the specified item.

---

Returns an item with the specified name.

function ItemByName(const aName: string): TCollectionItem

Parameters:

• aName: fClientFields

---

Returns the string "item".

function ItemName: string

---

Returns False.

function MergeDataDictionaries: Boolean

---

Moves the item from one position to another. Checks boundaries.

procedure MoveItem(iFromIndex: Integer; iToIndex: Integer)

Parameters:

• iFromIndex: old index
• iToIndex: new index

---

Notifies about the adding or removal of an item if the event handler is assigned. If an item with an empty name is added and items without name are not allowed, it sets the name to "Item" plus number.

procedure Notify(Item: TCollectionItem; Action: TCollectionNotification)

Parameters:

• Item: given item
• Action: action

---

Returns a reference to a specified interface if the object supports that interface. This is one of the methods introduced by the IUnknown interface.

function QueryInterface(const IID: TGUID; out Obj: ): HResult

Parameters:

• IID: Identifier of the interface to return
• Obj: Variable to store the returned interface reference to

---

Sets a new name for the specified item.

function SetItemName(anItem: TCollectionItem; const aName: string): string

Parameters:

• anItem: item
• aName: name

---

Calls the event handler if it was assigned.

procedure TriggerOnItemRemoved(const iName: string)

Parameters:

• iName: item name

---

Calls the event handler if it was assigned.

procedure TriggerOnItemRenamed(const iOldName: string; const iNewName: string)

Parameters:

• iOldName: old name
• iNewName: new name

---

Unbinds early binded collections

procedure Unbind

 

This event is fired if field was updated

property OnFieldAfterUpdate: TDAFieldNotifyEvent read write
delegate:  procedure OnFieldAfterUpdate(Sender: TDACustomField)

---

This event is fired before field was updated

property OnFieldBeforeUpdate: TDAFieldNotifyEvent read write
delegate:  procedure OnFieldBeforeUpdate(Sender: TDACustomField)

---

Event handler for removing an item.

property OnItemRemoved: TDAItemRemovedEvent read write
delegate:  procedure OnItemRemoved(aSender: TObject; const aName: string)

---

Event handler for renaming an item.

property OnItemRenamed: TDAItemRenamedEvent read write
delegate:  procedure OnItemRenamed(aSender: TObject; const aOldName: string; const aNewName: string)