TDAParamCollection

Overview

The TDAParamCollection is a container for TDAParam objects. It is used to represent parameters for a command or data table.

Location

 

constructor Create (TPersistent)

Creates a new instance.

constructor Create(aOwner: TPersistent)

Parameters:

  • aOwner: owner

constructor Create (TPersistent, TCollectionItemClass)    (declared in TSearcheableCollectionCached)

Initializes the collection with the supplied parameters.

constructor Create(AOwner: TPersistent; ItemClass: TCollectionItemClass)

Parameters:

  • AOwner: owner
  • ItemClass: item class

Add  reintroduce overload

Adds a new parameter.

function Add: TDAParam

Add (string, Variant, TDADataType): TDAParam  overload

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.

Assign  override

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

AssignParamCollection

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

CloneItem    (declared in TSearcheableCollection)

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.

FindItem  override    (declared in TSearcheableCollectionCached)

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

FindParam

Returns an item with the specified name.

function FindParam(const aParamName: string): TDAParam

Parameters:

  • aParamName: the specified name.

FindUniqueName    (declared in TSearcheableCollection)

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

FindUniqueNameEx    (declared in TSearcheableCollection)

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

GetCount  protected    (declared in TSearcheableInterfacedCollection)

Does nothing, should be implemented in the descendant.

function GetCount: integer

GetDefaultItem    (declared in TSearcheableCollection)

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

GetItemDefault  protected dynamic    (declared in TSearcheableCollection)

Returns default item's name

function GetItemDefault(anItem: TCollectionItem): boolean

Parameters:

  • anItem: given item

GetItemName  protected override

Gets the name of the specified item.

function GetItemName(anItem: TCollectionItem): string

Parameters:

  • anItem: the specified item.

HasInputParams

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

property HasInputParams: boolean read write

ItemByName    (declared in TSearcheableCollection)

Returns an item with the specified name.

function ItemByName(const aName: string): TCollectionItem

Parameters:

  • aName: fClientFields

ItemName  protected virtual    (declared in TSearcheableCollection)

Returns the string "item".

function ItemName: string

MoveItem    (declared in TSearcheableCollection)

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

procedure MoveItem(iFromIndex: integer; iToIndex: integer)

Parameters:

  • iFromIndex: old index
  • iToIndex: new index

Notify  protected override    (declared in TSearcheableCollectionCached)

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

OnItemRemoved    (declared in TSearcheableCollection)

Event handler for removing an item.

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

OnItemRenamed    (declared in TSearcheableCollection)

Event handler for renaming an item.

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

ParamByName

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

Params

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

QueryInterface  protected stdcall    (declared in TSearcheableInterfacedCollection)

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

ReadValues

Copies the TParams collection to the existing collection.

procedure ReadValues(InputParams: TParams)

Parameters:

  • InputParams: the existing collection.

SetItemName  protected override

Sets a new name for the specified item.

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

Parameters:

  • anItem: item
  • aName: name

TriggerOnItemRemoved  override    (declared in TSearcheableCollectionCached)

Calls the event handler if it was assigned.

procedure TriggerOnItemRemoved(const iName: string)

Parameters:

  • iName: item name

TriggerOnItemRenamed  override    (declared in TSearcheableCollectionCached)

Calls the event handler if it was assigned.

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

Parameters:

  • iOldName: old name
  • iNewName: new name

WriteValues

Copies the existing collection to the TParams collection.

procedure WriteValues(OutputParams: TParams)

Parameters:

  • OutputParams: the existing collection.

 

HasInputParams

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

property HasInputParams: boolean read write

Params

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

 

constructor Create (TPersistent)

Creates a new instance.

constructor Create(aOwner: TPersistent)

Parameters:

  • aOwner: owner

constructor Create (TPersistent, TCollectionItemClass)    (declared in TSearcheableCollectionCached)

Initializes the collection with the supplied parameters.

constructor Create(AOwner: TPersistent; ItemClass: TCollectionItemClass)

Parameters:

  • AOwner: owner
  • ItemClass: item class

Add  reintroduce overload

Adds a new parameter.

function Add: TDAParam

Add (string, Variant, TDADataType): TDAParam  overload

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.

Assign  override

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

AssignParamCollection

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

CloneItem    (declared in TSearcheableCollection)

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.

FindItem  override    (declared in TSearcheableCollectionCached)

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

FindParam

Returns an item with the specified name.

function FindParam(const aParamName: string): TDAParam

Parameters:

  • aParamName: the specified name.

FindUniqueName    (declared in TSearcheableCollection)

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

FindUniqueNameEx    (declared in TSearcheableCollection)

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

GetCount  protected    (declared in TSearcheableInterfacedCollection)

Does nothing, should be implemented in the descendant.

function GetCount: integer

GetDefaultItem    (declared in TSearcheableCollection)

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

GetItemDefault  protected dynamic    (declared in TSearcheableCollection)

Returns default item's name

function GetItemDefault(anItem: TCollectionItem): boolean

Parameters:

  • anItem: given item

GetItemName  protected override

Gets the name of the specified item.

function GetItemName(anItem: TCollectionItem): string

Parameters:

  • anItem: the specified item.

ItemByName    (declared in TSearcheableCollection)

Returns an item with the specified name.

function ItemByName(const aName: string): TCollectionItem

Parameters:

  • aName: fClientFields

ItemName  protected virtual    (declared in TSearcheableCollection)

Returns the string "item".

function ItemName: string

MoveItem    (declared in TSearcheableCollection)

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

procedure MoveItem(iFromIndex: integer; iToIndex: integer)

Parameters:

  • iFromIndex: old index
  • iToIndex: new index

Notify  protected override    (declared in TSearcheableCollectionCached)

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

ParamByName

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

QueryInterface  protected stdcall    (declared in TSearcheableInterfacedCollection)

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

ReadValues

Copies the TParams collection to the existing collection.

procedure ReadValues(InputParams: TParams)

Parameters:

  • InputParams: the existing collection.

SetItemName  protected override

Sets a new name for the specified item.

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

Parameters:

  • anItem: item
  • aName: name

TriggerOnItemRemoved  override    (declared in TSearcheableCollectionCached)

Calls the event handler if it was assigned.

procedure TriggerOnItemRemoved(const iName: string)

Parameters:

  • iName: item name

TriggerOnItemRenamed  override    (declared in TSearcheableCollectionCached)

Calls the event handler if it was assigned.

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

Parameters:

  • iOldName: old name
  • iNewName: new name

WriteValues

Copies the existing collection to the TParams collection.

procedure WriteValues(OutputParams: TParams)

Parameters:

  • OutputParams: the existing collection.

 

OnItemRemoved    (declared in TSearcheableCollection)

Event handler for removing an item.

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

OnItemRenamed    (declared in TSearcheableCollection)

Event handler for renaming an item.

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