TDAParamCollection

 

Creates a new instance.

constructor Create(aOwner: TPersistent)

Parameters:

• aOwner: owner

---

Initializes the collection with the supplied parameters.

constructor Create(AOwner: TPersistent; ItemClass: TCollectionItemClass)

Parameters:

• AOwner: owner
• ItemClass: item class

---

Adds a new parameter.

function Add: TDAParam

---

Adds a new parameter with given name, value and type.

function Add(aName: string; aValue: Variant; aDataType: TDADataType): TDAParam

Parameters:

• aName: parameter name.
• aValue: parameter value.
• aDataType: parameter type.

---

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

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 AssignParamCollection(Source: TDAParamCollection)

Parameters:

• Source: Instance whose properties will be copied

---

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 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 an item with the specified name.

function FindParam(const aParamName: string): TDAParam

Parameters:

• aParamName: the specified 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 true if the ParamType of one of the parameters is daptUnknown, daptInput or daptInputOutput.

property HasInputParams: Boolean read

---

Returns an item with the specified name.

function ItemByName(const aName: string): TCollectionItem

Parameters:

• aName: fClientFields

---

Returns the string "item".

function ItemName: string

---

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

---

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)

---

Returns the item with the specified name. If no matching parameter is defined, an exception will be raised.

function ParamByName(const aName: string): TDAParam

Parameters:

• aName: name of the parameter

---

This indexer property gives access to the individual parameters contained in the collection. If no matching parameter is defined, an exception will be raised.

property Params[Index: Integer]: TDAParam read write

---

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

---

Copies the TParams collection to the existing collection.

procedure ReadValues(InputParams: TParams)

Parameters:

• InputParams: the existing collection.

---

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

---

Copies the existing collection to the TParams collection.

procedure WriteValues(OutputParams: TParams)

Parameters:

• OutputParams: the existing collection.

 

Returns true if the ParamType of one of the parameters is daptUnknown, daptInput or daptInputOutput.

property HasInputParams: Boolean read

---

This indexer property gives access to the individual parameters contained in the collection. If no matching parameter is defined, an exception will be raised.

property Params[Index: Integer]: TDAParam read write

 

Creates a new instance.

constructor Create(aOwner: TPersistent)

Parameters:

• aOwner: owner

---

Initializes the collection with the supplied parameters.

constructor Create(AOwner: TPersistent; ItemClass: TCollectionItemClass)

Parameters:

• AOwner: owner
• ItemClass: item class

---

Adds a new parameter.

function Add: TDAParam

---

Adds a new parameter with given name, value and type.

function Add(aName: string; aValue: Variant; aDataType: TDADataType): TDAParam

Parameters:

• aName: parameter name.
• aValue: parameter value.
• aDataType: parameter type.

---

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

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 AssignParamCollection(Source: TDAParamCollection)

Parameters:

• Source: Instance whose properties will be copied

---

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 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 an item with the specified name.

function FindParam(const aParamName: string): TDAParam

Parameters:

• aParamName: the specified 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

---

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 the item with the specified name. If no matching parameter is defined, an exception will be raised.

function ParamByName(const aName: string): TDAParam

Parameters:

• aName: name of the parameter

---

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

---

Copies the TParams collection to the existing collection.

procedure ReadValues(InputParams: TParams)

Parameters:

• InputParams: the existing collection.

---

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

---

Copies the existing collection to the TParams collection.

procedure WriteValues(OutputParams: TParams)

Parameters:

• OutputParams: the existing collection.

 

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)