TDADataDictionary

Overview

The TDADataDictionary component is used to store a number of predefined field configurations (so called data dictionary entries, or data dictionary fields).

These entries exhibit most of the properties of normal fields; however, they are not used to represent actual data fields, but are templates for the configuration of actual fields in the data tables of your schema.

For example, a schema might define several tables that contain a "phone number" string field; common configuration for this field type (edit masks, display formats, field captions) might be defined in a common data dictionary entry, which is then referenced from the individual "phone number" fields using their DataDictionary property. The fields will then inherit their configuration from the commonly shared dictionary entry, rather than having to duplicate the settings. Changes to the dictionary entry will automatically reflect in all the actual fields.

While you can edit the content of a data dictionary from code or in Object Inspector using the Fields collection property, you will usually edit the dictionary by double-clicking a TDASchema component that references it, to launch the Schema Modeler.

Location

Implements

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

Clear  virtual    (declared in TDAStreamableComponent)

Clears all properties.

procedure Clear

Fields

Maintains the list of TDADataDictionaryField defined in the dictionary.

property Fields: TDADataDictionaryFieldCollection read write

LoadFromFile    (declared in TDAStreamableComponent)

Restores the component data from file via LoadFromStream.

procedure LoadFromFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:


LoadFromStream  virtual    (declared in TDAStreamableComponent)

Restores the component data stored in the given stream.

procedure LoadFromStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:


LoadFromXml (ROUTF8String)  overload    (declared in TDAStreamableComponent)

Uses aXML as storage to load from.

procedure LoadFromXml(aXML: ROUTF8String)

Parameters:

  • aXML: Xml text

RestoreNonStreamableProperties  protected override

Restores specific information not accessible as usual properties.

procedure RestoreNonStreamableProperties(const TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

SaveNonStreamableProperties  protected override

Stores specific information not accessible as usual properties.

procedure SaveNonStreamableProperties(var TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

SaveToFile    (declared in TDAStreamableComponent)

Stores the component data into file via SaveToStream.

procedure SaveToFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:


SaveToStream  virtual    (declared in TDAStreamableComponent)

Stores the component data into the given stream.

procedure SaveToStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

 

Fields

Maintains the list of TDADataDictionaryField defined in the dictionary.

property Fields: TDADataDictionaryFieldCollection read write

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

Clear  virtual    (declared in TDAStreamableComponent)

Clears all properties.

procedure Clear

LoadFromFile    (declared in TDAStreamableComponent)

Restores the component data from file via LoadFromStream.

procedure LoadFromFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:


LoadFromStream  virtual    (declared in TDAStreamableComponent)

Restores the component data stored in the given stream.

procedure LoadFromStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:


LoadFromXml (ROUTF8String)  overload    (declared in TDAStreamableComponent)

Uses aXML as storage to load from.

procedure LoadFromXml(aXML: ROUTF8String)

Parameters:

  • aXML: Xml text

RestoreNonStreamableProperties  protected override

Restores specific information not accessible as usual properties.

procedure RestoreNonStreamableProperties(const TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

SaveNonStreamableProperties  protected override

Stores specific information not accessible as usual properties.

procedure SaveNonStreamableProperties(var TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

SaveToFile    (declared in TDAStreamableComponent)

Stores the component data into file via SaveToStream.

procedure SaveToFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:


SaveToStream  virtual    (declared in TDAStreamableComponent)

Stores the component data into the given stream.

procedure SaveToStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

See Also