Click or drag to resize

DbColumnInfo Class

X#
This class describes extended information for a field in a workarea, for fields that come from a SQL backend.
Inheritance Hierarchy
Object
  RddFieldInfo
    DbColumnInfo

Namespace:  XSharp.RDD
Assembly:  XSharp.Core (in XSharp.Core.dll) Version: 2.21
Syntax
 CLASS DbColumnInfo INHERIT RddFieldInfo
Request Example View Source

The DbColumnInfo type exposes the following members.

Constructors
  NameDescription
Public methodDbColumnInfo(RddFieldInfo)
Initializes a new instance of the DbColumnInfo class
Public methodDbColumnInfo(String, String, Long, Long, Long)
Initializes a new instance of the DbColumnInfo class
Top
Properties
  NameDescription
Public propertyCanSort
Can the field be sorted?
(Inherited from RddFieldInfo.)
Public propertyCaption
Dynamic property for the Caption. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyColumnName
Dynamic property for the ColumnName. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyDefaultValue
Dynamic property for the DefaultValue. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyDescription
Dynamic property for the Description. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyDotNetType
DotNet datatype of the column
Public propertyFieldTypeFlags
FieldType as a string
(Inherited from RddFieldInfo.)
Public propertyFieldTypeStr
Field type as 1 character string.
(Inherited from RddFieldInfo.)
Public propertyFormat
Dynamic property for the Format. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyHasProperties
Does the field have properties.
(Inherited from RddFieldInfo.)
Public propertyInputMask
Dynamic property for the InputMask. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyIsAutoIncrement
Is it an autoincrement ?
(Inherited from RddFieldInfo.)
Public propertyIsBinary
Is it binary ?
(Inherited from RddFieldInfo.)
Public propertyIsCompressed
Is it a compressed field (not implemented yet) ?
(Inherited from RddFieldInfo.)
Public propertyIsEncrypted
Is it an encryped field (not implemented yet)?
(Inherited from RddFieldInfo.)
Public propertyIsMemo
Is it a memo ?
(Inherited from RddFieldInfo.)
Public propertyIsNullable
Is it nullable ?
(Inherited from RddFieldInfo.)
Public propertyIsStandard
Is it a standard Dbase 3 field (CDLMN) ?
(Inherited from RddFieldInfo.)
Public propertyIsUnicode
Is it a unicode text ?
(Inherited from RddFieldInfo.)
Public propertyIsUnique
Dynamic property for the IsUnique. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyIsVarLength
Is it a variable length field ?
(Inherited from RddFieldInfo.)
Public propertyIsVfp
Is it a VFP extended field ?
(Inherited from RddFieldInfo.)
Public propertyNumericPrecision
Numeric Precision
Public propertyNumericScale
Numeric Scale
Public propertyPrimaryKey
Dynamic property for the PrimaryKey. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyProperties
Dynamic list of optional properties, such as Caption, Description.
(Inherited from RddFieldInfo.)
Public propertyReadOnly
Numeric Precision
Public propertyRuleExpression
Dynamic property for the RuleExpression. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Public propertyRuleText
Dynamic property for the RuleText. Read from the VFP properties collection.
(Inherited from RddFieldInfo.)
Top
Methods
  NameDescription
Public methodBlankValue
Return the blank (non null) value of the column.
(Inherited from RddFieldInfo.)
Public methodCalculateColumnType
Calculate the column type from the FieldType
Public methodClone
Clone a RddFieldInfo object.
(Inherited from RddFieldInfo.)
Public methodCopyValues
Copy values from one object to another.
(Inherited from RddFieldInfo.)
Public methodSameType
Check if two fields match in type, length and decimals.
(Inherited from RddFieldInfo.)
Public methodToString (Inherited from RddFieldInfo.)
Public methodValidate
Validate combinations of type, length and decimals.
(Inherited from RddFieldInfo.)
Top
Fields
  NameDescription
Public fieldAlias
Alternative name, no length limit. This is the Caption for VFP fields
(Inherited from RddFieldInfo.)
Public fieldDecimals
Decimal positions
(Inherited from RddFieldInfo.)
Public fieldFieldType
Field Type
(Inherited from RddFieldInfo.)
Public fieldFlags
Flags, such as Nullable, AutoIncrement, Binary etc.
(Inherited from RddFieldInfo.)
Public fieldLength
Physical length in the table
(Inherited from RddFieldInfo.)
Public fieldName
Name, normally max 10 characters
(Inherited from RddFieldInfo.)
Public fieldNextValue
Next key for autoincrement columns.
(Inherited from RddFieldInfo.)
Public fieldOffset
Offset in the record buffer for DBF fields.
(Inherited from RddFieldInfo.)
Public fieldOrdinal
1 based Ordinal position in the RDD.
(Inherited from RddFieldInfo.)
Public fieldStepValue
Step value for autoincrement columns.
(Inherited from RddFieldInfo.)
Top
See Also