Core properties and methods

Public Property Get CanCoerceNullToEmptyString() As Boolean

Is the column a string type, non nullable but empty string allowed

Public Property Get ColumnDescription() As String

Column description

Public Property Get ColumnLength() As Long

The column length is this number of characters (if string type)

Public Property Get ColumnName() As String

Column name

Public Property Get ColumnNameBracketed() As String

Column name contained in square brackets

Public Property Get ColumnNameBracketedEquals() As String

Column name contained in square brackets with a trailing '='

Public Property Get ColumnOrderIndex() As Integer

The column order in the table

Public Property Get DecimalPlaces() As Long

The column number of decimal places (if applicable)

Public Property Get DefaultExpression() As String

The column default value or expression

Public Property Get DependencyExclusionList() As String

Don't test for a FK dependency in these tables when deleting a record
- a cascade delete is at work

Public Property Get EmptyOrNullNotAllowed() As Boolean

Is a Null or an empty string value disallowed in the column ?

Public Property Get EmptyStringNotAllowed() As Boolean

Is an empty string value disallowed in the column ?

Public Property Get FKColumnRef() As String

The FK column reference (in the FK table) for the column, if any

Public Property Get FKTableRef() As String

The FK table reference for the column, if any

Public Function FormatColValueSimple( ColumnVal As Variant , Optional CheckForQuotedStrings As Boolean = False , Optional OverrideSQLColumnFormat As xf_SQLColumnFormatEnum = xf_SQLColumnFormat_Unsupported ) As String

Format the column value based on this column's schema, but just do type checking , not null and length checking etc.
Assumes that strings are not quoted prior to passing in.


Public Function FormatSqlColumn( ColumnVal As Variant , InsertNewRec As Boolean , SQLNullList As String, SQLTruncList As String, SQLTypeMismatchList As String , Optional CheckForQuotedStrings As Boolean = False , Optional InDatasheetMode As Boolean = False , Optional DatasheetControl As Control = Empty , Optional OverrideSQLColumnFormat As xf_SQLColumnFormatEnum = xf_SQLColumnFormat_Unsupported , Optional NameMatchArray As Variant = Null ) As String

Formats the passed variant for inclusion in an SQL UPDATE/INSERT command, eg. Date, null, numeric etc.
Assumes that strings are not quoted prior to passing in.
Strings are quoted as part of the formatting operation, unless CheckForQuotedStrings=true and they are already quoted.


Public Property Get HasDefault() As Boolean

Does the column have a default value specified ?

Public Property Get IsComputed() As Boolean

Is the column computed (MSSQL) ?

Public Property Get IsIdentity() As Boolean

Is the column an autonumber/identity ?

Public Property Get IsNullable() As Boolean

Is the column nullable ?

Public Property Get IsPKCol() As Boolean

Is this column part fo the primary key ?

Public Property Get IsStringType() As Boolean

Is the column a string type

Public Property Get IsTextPtrCol() As String

Is the column a pointer to a global text storage table

Public Property Get NativeColumnType() As Variant

The column native (MSSQL or MS Access) type

Public Property Get Parent() As xf_DbSchema_Table

The table schema to which this column belongs

Public Sub SetColumnData( TableObject As xf_DbSchema_Table, TableName As String, ColumnName As String, ColumnDescription As String, SQLColumnFormat As xf_SQLColumnFormatEnum, NativeColumnType As Variant, ColumnOrderIndex As Integer, TrimToLength As Long, ColumnLength As Long, DecimalPlaces As Integer, IsComputed As Boolean, IsIdentity As Boolean, IsNullable As Boolean, EmptyStringNotAllowed As Boolean, EmptyOrNullNotAllowed As Boolean, FKTableRef As String, FKColumnRef As String, TestUniqueDomain As Integer, UnhideTrigger As Boolean, DependencyExclusionList As String, HasDefault As Boolean, DefaultExpression As String)

Initialises the column schema with values

Public Property Get SQLColumnFormat() As xf_SQLColumnFormatEnum

Internal functional column type

Public Property Get TestUniqueDomain() As Integer

Test for the column being unique over a specific domain

Public Property Get TrimToLength() As Long

Trim the column to this number of characters (if string type)

Public Property Get UnhideTrigger() As Boolean

If the user tries to enter a new value that matches an existing hidden value, trigger the hidden value to be shown