TDADatasetRelationshipCollection

 

Creates a new instance.

constructor Create(aOwner: TComponent)

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 master-detail relation.

function Add: TDADatasetRelationship

---

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 the list of master-detail relationships for the given dataset.

procedure GetDetails(const aMasterDatasetName: string; aList: TDADatasetRelationshipList)

Parameters:

• aMasterDatasetName: name for the master dataset
• aList: destination

---

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

---

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 a relationship by name, if it exists.

function RelationShipByName(const aName: string): TDADatasetRelationship

Parameters:

• aName: the specified name.

---

Checks for the existence of a relationship with the given parameters.

function RelationshipExists(const aMasterDatasetName: string; const aDetailDatasetName: string; const aMasterFields: string; const aDetailFields: string): Boolean

Parameters:

• aMasterDatasetName: name for the master dataset
• aDetailDatasetName: name for the detail dataset
• aMasterFields: one or more fields in a master table
• aDetailFields: one or more fields in a detail table

---

Returns the list of objects that represents the master-detail relationship between datasets.

property Relationships[Index: Integer]: TDADatasetRelationship read

---

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

 

Returns the list of objects that represents the master-detail relationship between datasets.

property Relationships[Index: Integer]: TDADatasetRelationship read

 

Creates a new instance.

constructor Create(aOwner: TComponent)

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 master-detail relation.

function Add: TDADatasetRelationship

---

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 the list of master-detail relationships for the given dataset.

procedure GetDetails(const aMasterDatasetName: string; aList: TDADatasetRelationshipList)

Parameters:

• aMasterDatasetName: name for the master dataset
• aList: destination

---

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 a relationship by name, if it exists.

function RelationShipByName(const aName: string): TDADatasetRelationship

Parameters:

• aName: the specified name.

---

Checks for the existence of a relationship with the given parameters.

function RelationshipExists(const aMasterDatasetName: string; const aDetailDatasetName: string; const aMasterFields: string; const aDetailFields: string): Boolean

Parameters:

• aMasterDatasetName: name for the master dataset
• aDetailDatasetName: name for the detail dataset
• aMasterFields: one or more fields in a master table
• aDetailFields: one or more fields in a detail table

---

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)