TDAParam

 

Creates a new instance.

constructor Create(Collection: TCollection)

Parameters:

• Collection: collection which the field belongs to

---

Gets or sets the value of the field as 8-bit ANSI string value.

property AsAnsiString: string read write

---

Gets or sets the value of the field as Blob value.

property AsBlob: TBlobData read write

---

Gets or sets the value of the field as Boolean value.

property AsBoolean: Boolean read write

---

Gets or sets the value of the field as Byte value.

property AsByte: Byte read write

---

Gets or sets the value of the field as Bytes value.

property AsBytes: TBytes read write

---

Gets or sets the value of the field as Cardinal value.

property AsCardinal: Cardinal read write

---

Gets or sets the value of the field as 64-bit fixed point Currency value.

property AsCurrency: Currency read write

---

Gets or sets the value of the field as TDateTime value.

property AsDateTime: TDateTime read write

---

Gets or sets the value of the field as binary coded decimal value.

property AsDecimal: TBcd read write

---

Gets or sets the value of the field as Float/Double value.

property AsFloat: Double read write

---

Gets or sets the value of the field as TGUID value.

property AsGuid: TGUID read write

---

Gets or sets the value of the field as 32-bit integer value.

property AsInteger: Integer read write

---

Gets or sets the value of the field as 64-bit integer value.

property AsLargeInt: Int64 read write

---

Gets or sets the value of the field as 64-bit unsigned integer value.

property AsLargeUInt: UInt64 read write

---

Gets or sets the value of the field as ShortInt value.

property AsShortInt: ShortInt read write

---

Assigns the Source field.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Assigns the Source field

procedure AssignField(Source: TDABaseField)

Parameters:

• Source: TDABaseField instance that current TDABaseField should be assigned to

---

Assigns the ParamType and other properties.

procedure AssignParam(Source: TDAParam)

Parameters:

• Source: Instance whose properties will be copied

---

Gets or sets the value of the field as Single value.

property AsSingle: Single read write

---

Gets or sets the value of the field as SmallInt value.

property AsSmallInt: SmallInt read write

---

Gets or sets the value of the field as string value.

property AsString: string read write

---

Gets or sets the value of the field as variant.

property AsVariant: Variant read write

---

Gets or sets the value of the field as 16-bit Unicode WideString value.

property AsWideString: UnicodeString read write

---

Gets or sets the value of the field as Word value.

property AsWord: Word read write

---

Gets or sets the value of the field as XML node.

property AsXml: IXMLNode read write

---

Indicates the number of bytes of data contained in the blob field on the current record.

property BlobSize: Integer read

---

Manages additional Blob options, if the DataType of the field is set to datBlob.

property BlobType: TDABlobType read write

---

Clears the value of the field by setting it to Null.

procedure Clear

---

Specifies the type of data contained within the field, from a collection of supported TDADataTypes. Depending on the data type, the Size and BlobType properties are also used to further define the data type in more detail. For datString and datWideString, Size will define the maximum length of string permitted for the field; for blobs and memos, BlobType provides special options.

property DataType: TDADataType read write

---

Specifies decimal precision for a binary coded decimal value (if the DataType of the field is set to datDecimal).

property DecimalPrecision: Integer read write

---

Specifies decimal scale for a binary coded decimal value (if the DataType of the field is set to datDecimal).

property DecimalScale: Integer read write

---

Provides a human-readable description of the field. This property will not be used by the Data Abstract library, but can be filled with description text for documentation purposes when defining the field or parameter in Schema Modeler.

property Description: string read write

---

Name of the data dictionary for the field

property DictionaryEntry: string read write

---

For fields of type datAutoInc, this property specifies the name of the generator in the back-end database that will be used to generate new primary key values. This applies only to database types that do not natively support AutoInc fields (such as Oracle or Interbase). Please refer to the AutoIncs and Generators help topic for more detail.

property GeneratorName: string read write

---

Returns Name of the field

function GetDisplayName: string

---

Returns whether the field currently contains a value (false) or is Null (true).

function GetIsNull: Boolean

---

Returns the name of the object as it appears in the Object Inspector

function GetNamePath: string

---

Indicates if the field has appropriate data dictionary entry

function HasValidDictionaryField: Boolean

---

Indicates if the field is compatible with DA v.4 . Returns False

function IsCompatibleV4: Boolean

---

Returns whether the field currently contains a value (false) or is Null (true).

property IsNull: Boolean read

---

Reads Value from file.

procedure LoadFromFile(const aFileName: string)

Parameters:

• aFileName: given file name.

---

Reads Value from stream.

procedure LoadFromStream(const aStream: IROStream)

Parameters:

• aStream: given stream.

---

One of the conditions for indicating if the field's property should be saved on the form or when TDASchema is saved. For internal using.

function MergeDatadictionaries: Boolean

---

Defines the name of the field or parameter. This name usually matches the name of the underlying field in the physical database, or it's mapped to a different field using the data tables column mapping.

property Name: string read write

---

Specifies the direction of the parameter. Command parameters can either be incoming (passed into the command), outgoing/result (returned from the command) or Incoming and Outgoing (both passed in and returned). Data table parameters can only be incoming.

property ParamType: TDAParamType 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

---

Writes Value to file.

procedure SaveToFile(const aFileName: string)

Parameters:

• aFileName: given file name.

---

Writes Value to stream.

procedure SaveToStream(const aStream: IROStream)

Parameters:

• aStream: given stream.

---

Sets the name of the field as it appears in the collection editor.

procedure SetDisplayName(const Value: string)

Parameters:

• Value: value for the Name property

---

Sets the maximum length of string permitted for the field, DataType is set to datString or datWideString.

property Size: Integer read write

---

Indicates if original field's BlobType property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now

function StoreBlobType: Boolean

---

Indicates if field's DataType property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now.

function StoreDataType: Boolean

---

Indicates if field's DecimalPrecision property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema.

function StoreDecimalPrecision: Boolean

---

Indicates if field's DecimalScale property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema.

function StoreDecimalScale: Boolean

---

Indicates if field's DecimalPrecision property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now

function StoreDescription: Boolean

---

Indicates if field's DecimalPrecision property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now

function StoreGeneratorName: Boolean

---

Indicates if field's DecimalPrecision property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now

function StoreSize: Boolean

---

Tag has no predefined meaning. The Tag property can store any additional integer value for the convenience of developers

property Tag: Integer read write

---

Gets or sets the value of the field as variant.

property Value: Variant read write

 

Gets or sets the value of the field as 8-bit ANSI string value.

property AsAnsiString: string read write

---

Gets or sets the value of the field as Blob value.

property AsBlob: TBlobData read write

---

Gets or sets the value of the field as Boolean value.

property AsBoolean: Boolean read write

---

Gets or sets the value of the field as Byte value.

property AsByte: Byte read write

---

Gets or sets the value of the field as Bytes value.

property AsBytes: TBytes read write

---

Gets or sets the value of the field as Cardinal value.

property AsCardinal: Cardinal read write

---

Gets or sets the value of the field as 64-bit fixed point Currency value.

property AsCurrency: Currency read write

---

Gets or sets the value of the field as TDateTime value.

property AsDateTime: TDateTime read write

---

Gets or sets the value of the field as binary coded decimal value.

property AsDecimal: TBcd read write

---

Gets or sets the value of the field as Float/Double value.

property AsFloat: Double read write

---

Gets or sets the value of the field as TGUID value.

property AsGuid: TGUID read write

---

Gets or sets the value of the field as 32-bit integer value.

property AsInteger: Integer read write

---

Gets or sets the value of the field as 64-bit integer value.

property AsLargeInt: Int64 read write

---

Gets or sets the value of the field as 64-bit unsigned integer value.

property AsLargeUInt: UInt64 read write

---

Gets or sets the value of the field as ShortInt value.

property AsShortInt: ShortInt read write

---

Gets or sets the value of the field as Single value.

property AsSingle: Single read write

---

Gets or sets the value of the field as SmallInt value.

property AsSmallInt: SmallInt read write

---

Gets or sets the value of the field as string value.

property AsString: string read write

---

Gets or sets the value of the field as variant.

property AsVariant: Variant read write

---

Gets or sets the value of the field as 16-bit Unicode WideString value.

property AsWideString: UnicodeString read write

---

Gets or sets the value of the field as Word value.

property AsWord: Word read write

---

Gets or sets the value of the field as XML node.

property AsXml: IXMLNode read write

---

Indicates the number of bytes of data contained in the blob field on the current record.

property BlobSize: Integer read

---

Manages additional Blob options, if the DataType of the field is set to datBlob.

property BlobType: TDABlobType read write

---

Specifies the type of data contained within the field, from a collection of supported TDADataTypes. Depending on the data type, the Size and BlobType properties are also used to further define the data type in more detail. For datString and datWideString, Size will define the maximum length of string permitted for the field; for blobs and memos, BlobType provides special options.

property DataType: TDADataType read write

---

Specifies decimal precision for a binary coded decimal value (if the DataType of the field is set to datDecimal).

property DecimalPrecision: Integer read write

---

Specifies decimal scale for a binary coded decimal value (if the DataType of the field is set to datDecimal).

property DecimalScale: Integer read write

---

Provides a human-readable description of the field. This property will not be used by the Data Abstract library, but can be filled with description text for documentation purposes when defining the field or parameter in Schema Modeler.

property Description: string read write

---

Name of the data dictionary for the field

property DictionaryEntry: string read write

---

For fields of type datAutoInc, this property specifies the name of the generator in the back-end database that will be used to generate new primary key values. This applies only to database types that do not natively support AutoInc fields (such as Oracle or Interbase). Please refer to the AutoIncs and Generators help topic for more detail.

property GeneratorName: string read write

---

Returns whether the field currently contains a value (false) or is Null (true).

property IsNull: Boolean read

---

Defines the name of the field or parameter. This name usually matches the name of the underlying field in the physical database, or it's mapped to a different field using the data tables column mapping.

property Name: string read write

---

Specifies the direction of the parameter. Command parameters can either be incoming (passed into the command), outgoing/result (returned from the command) or Incoming and Outgoing (both passed in and returned). Data table parameters can only be incoming.

property ParamType: TDAParamType read write

---

Sets the maximum length of string permitted for the field, DataType is set to datString or datWideString.

property Size: Integer read write

---

Tag has no predefined meaning. The Tag property can store any additional integer value for the convenience of developers

property Tag: Integer read write

---

Gets or sets the value of the field as variant.

property Value: Variant read write

 

Creates a new instance.

constructor Create(Collection: TCollection)

Parameters:

• Collection: collection which the field belongs to

---

Assigns the Source field.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Assigns the Source field

procedure AssignField(Source: TDABaseField)

Parameters:

• Source: TDABaseField instance that current TDABaseField should be assigned to

---

Assigns the ParamType and other properties.

procedure AssignParam(Source: TDAParam)

Parameters:

• Source: Instance whose properties will be copied

---

Clears the value of the field by setting it to Null.

procedure Clear

---

Returns Name of the field

function GetDisplayName: string

---

Returns whether the field currently contains a value (false) or is Null (true).

function GetIsNull: Boolean

---

Returns the name of the object as it appears in the Object Inspector

function GetNamePath: string

---

Indicates if the field has appropriate data dictionary entry

function HasValidDictionaryField: Boolean

---

Indicates if the field is compatible with DA v.4 . Returns False

function IsCompatibleV4: Boolean

---

Reads Value from file.

procedure LoadFromFile(const aFileName: string)

Parameters:

• aFileName: given file name.

---

Reads Value from stream.

procedure LoadFromStream(const aStream: IROStream)

Parameters:

• aStream: given stream.

---

One of the conditions for indicating if the field's property should be saved on the form or when TDASchema is saved. For internal using.

function MergeDatadictionaries: Boolean

---

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

---

Writes Value to file.

procedure SaveToFile(const aFileName: string)

Parameters:

• aFileName: given file name.

---

Writes Value to stream.

procedure SaveToStream(const aStream: IROStream)

Parameters:

• aStream: given stream.

---

Sets the name of the field as it appears in the collection editor.

procedure SetDisplayName(const Value: string)

Parameters:

• Value: value for the Name property

---

Indicates if original field's BlobType property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now

function StoreBlobType: Boolean

---

Indicates if field's DataType property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now.

function StoreDataType: Boolean

---

Indicates if field's DecimalPrecision property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema.

function StoreDecimalPrecision: Boolean

---

Indicates if field's DecimalScale property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema.

function StoreDecimalScale: Boolean

---

Indicates if field's DecimalPrecision property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now

function StoreDescription: Boolean

---

Indicates if field's DecimalPrecision property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now

function StoreGeneratorName: Boolean

---

Indicates if field's DecimalPrecision property (not appropriate data dictionary property) should be saved in the form file or when saving TDASchema. Not used for now

function StoreSize: Boolean