TDAJoinSourceTableCollection

 

Creates a new instance.

constructor Create(aOwner: TPersistent)

Parameters:

• aOwner: Specified owner of the current collection.

---

Initializes the collection with the supplied parameters.

constructor Create(AOwner: TPersistent; ItemClass: TCollectionItemClass)

Parameters:

• AOwner: owner
• ItemClass: item class

---

Adds a new JOIN source table item (TDAJoinSourceTable object) to the current collection and returns the created item.

function Add: TDAJoinSourceTable

---

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 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

---

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

---

Gets the item (TDAJoinSourceTable object) with the specified name from the current collection and returns it. If no item with that name is found, an exception will be raised.

function JoinSourceTableByName(const aName: string): TDAJoinSourceTable

Parameters:

• aName: Specified name of the item in the current collection.

---

Represents the single source table (TDAJoinSourceTable object) with the specified index in the current collection.

property JoinSourceTables[Index: Integer]: TDAJoinSourceTable read write

---

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)

---

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

 

Represents the single source table (TDAJoinSourceTable object) with the specified index in the current collection.

property JoinSourceTables[Index: Integer]: TDAJoinSourceTable read write

 

Creates a new instance.

constructor Create(aOwner: TPersistent)

Parameters:

• aOwner: Specified owner of the current collection.

---

Initializes the collection with the supplied parameters.

constructor Create(AOwner: TPersistent; ItemClass: TCollectionItemClass)

Parameters:

• AOwner: owner
• ItemClass: item class

---

Adds a new JOIN source table item (TDAJoinSourceTable object) to the current collection and returns the created item.

function Add: TDAJoinSourceTable

---

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 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

---

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

---

Gets the item (TDAJoinSourceTable object) with the specified name from the current collection and returns it. If no item with that name is found, an exception will be raised.

function JoinSourceTableByName(const aName: string): TDAJoinSourceTable

Parameters:

• aName: Specified name of the item in the current collection.

---

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

---

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

 

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)