Field Class

Represents a database field.

Inheritance Hierarchy

SystemObject
GSF.DataField

Namespace: GSF.Data
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.257-beta+00aa2366fbb9ec75f636ebc7cfa610e3826a727c

Syntax

[SerializableAttribute]
public class Field : IComparable

<SerializableAttribute>
Public Class Field
	Implements IComparable

[SerializableAttribute]
public ref class Field : IComparable

[<SerializableAttribute>]
type Field = 
    class
        interface IComparable
    end

GSF.Data.Field = function();

Type.createClass(
	'GSF.Data.Field',
	null,
	IComparable);

The Field type exposes the following members.

Constructors

	Name	Description
	Field	Creates a new Field.

Properties

	Name	Description
	AllowsNulls	Get or set Allow Null flag
	AutoIncrement	Get or set Auto increment flag
	AutoIncrementSeed	Get or set Auto increment seed
	AutoIncrementStep	Get or set Auto increment step
	DateTimePrecision	Get or set date time precision
	DefaultValue	Get or set default value
	Description	Get or set description
	ForeignKeys	Get or set list of ForeignKeyFields
	HasDefault	Get or set has default value flag
	IsForeignKey	Get or set foreign key flag. if Field is ReferencedBy then true else false
	IsPrimaryKey	Get or set flag to check Field is primary key or not
	MaxLength	Get or set maximum length of field
	Name	Get Field Name
	NonNullNativeValue	Gets the native value for the field (SQL Encoded).
	NumericPrecision	Get or set numeric precision
	NumericScale	Get or set Numeric scale
	Ordinal	Get or set file ordinal
	Parent	Get or set Fields parent
	PrimaryKeyName	Get or set primary key name
	PrimaryKeyOrdinal	Get or set ordinal for Primary key field
	ReadOnly	Get or set read-only flag
	ReferencedBy	Get or set - check Field is reference by
	SQLEncodedValue	Change Field value to encoded string. It will check Type and Parent value before convert to OleDbType compatible value
	SQLEscapedName	Get SQL escaped name of Table
	Table	Get or set Field's parent Table
	Type	Get OleDbType Type
	Unique	Get or set for unique
	Value	Get or set value of Field

Methods

	Name	Description
	CompareTo	Compare obj ordinal to current field Ordinal
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (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)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)