DataDictionaryField Class

[This is preliminary documentation and is subject to change.]

Summary description for DataDictionaryField.

Inheritance Hierarchy

SystemObject
CSC.SC.TOPICA4.DynamicDataDataDictionaryField

Namespace: CSC.SC.TOPICA4.DynamicData
Assembly: CSC.SC.TOPICA4.DynamicData (in CSC.SC.TOPICA4.DynamicData.dll) Version: 4.30.6239.27195

Syntax

Copy

public class DataDictionaryField : IEquatable<DataDictionaryField>

The DataDictionaryField type exposes the following members.

Constructors

	Name	Description
	DataDictionaryField(Database, DataRow)	Construct field, reading from DataRow
	DataDictionaryField(String, String, String, String, DataType, Boolean)	Constructor
	DataDictionaryField(String, String, String, String, DataType, Int32, Boolean)	Construct field
	DataDictionaryField(String, String, String, String, Boolean, DataType, Boolean)	Constructor
	DataDictionaryField(String, String, String, String, DataType, Int32, Boolean, Boolean, Boolean)	Construct field
	DataDictionaryField(String, String, String, String, DataType, Int32, Boolean, Boolean, Boolean, Boolean)	Construct field
	DataDictionaryField(String, String, String, String, DataType, Int32, Boolean, Boolean, Boolean, Boolean, Boolean)	Construct field
	DataDictionaryField(String, String, String, String, Boolean, DataType, Int32, Boolean, Boolean, Boolean, Boolean, Boolean)	Construct field

Top

Methods

	Name	Description
	AddEnum	Add enum-value to field
	AsString	Return string representation
	DatabaseTypeToDataType	Compute DataType from type stored in metadata. NB: currently SQL Server only!
	DataDictionaryFieldFromMetaData	Create a DataDictionaryField from metadata in the database
	DBDelete	Deletes field from database
	DBInsert	Insert into database
	DBRead	Read on object from DataRow
	DBUpdate	Updates field in supplied database
	DBUpdateEnums
	DebugPrint	Prints field without margin
	DebugPrint(String)	prints field with specified margin
	EnumToString	returns enumeration as string
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Equals(DataDictionaryField)	Check if two DataDictionaryFields are equal
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindEnum	Finds enumeration
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SQLCreate	Returns SQL-statement to create table
	SQLCreate(DataDictionary, Boolean)	Generate SQL for create table
	TablesContainingField	Return collection of tables, that contain this field
	ToString	Returns field as string (Overrides ObjectToString.)

Top

Properties

	Name	Description
	Caption	The text displayed in the input form.
	ComputedColumnSQL	Get/Set ComputedColumnSQL
	DataColumnType	SystemType of DataColumn
	DataType	Type of data stored in database.
	Description	Internal description of field
	Dimension	True => field is used as base for a dimension in a cube (DataWarehouse).
	EnumCollection	Enum values for this field.
	FieldName	Field name defined by DataName in form template. Used as field name in database.
	FieldSize	Width of text fields. Nonzero => generate VARCHAR(nnn), 0 => TEXT (arbitrary length).
	HasEnums	Has this field enumeration values?
	HistoryCaption	The text displayed in the history view
	HistoryOnly	Get HistoryOnly - false: normal field, true: only in history table
	IsComputed	Is field computed.
	IsDateStart	Field is used as DateStart
	IsDateStop	Field is used as DateStop
	IsIdentity	Field is IDENTITY in database (autoincrement).
	IsIndex	Generate index on this field.
	IsInternal	Field is auto generated internal field
	IsPersisted	Get/Set IsPersisted
	IsStatus	Field is auto-generated and used for misc. status information.
	Link	Link (e.g. URL) to external description of field
	LookupViewName	Return the name of the lookup view for this enum field (if the field is not enum an empty string is returned")
	MapToExternalField	Get/Set MapToExternalField: Reference to fiel in external system
	Measure	True => field is used as base for a measure in a cube (DataWarehouse).
	NonBlankCaption	Get a non-blank caption : first nonblank value in this sequeunce: Caption, HistoryCaption, FieldName
	NonBlankHistoryCaption	Get a non-blank historycaption : first nonblank value in this sequeunce: HistoryCaption, Caption, FieldName
	ReferencesField	Get/set ReferencesField : Reference to field in table specifed by ReferencesTable
	ReferencesTable	Get/set ReferencesTable: Reference to table in current database
	SetValueOnCopy	Get/Set SetValueOnCopy: An expression used to compute value in newly created record in copy operation.
	ViewName	Field name in auto-generated views etc.

Top

Reference

CSC.SC.TOPICA4.DynamicData Namespace