Click or drag to resize

Field Class

Represents a database field.
Inheritance Hierarchy
SystemObject
  GSF.DataField

Namespace: GSF.Data
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8
Syntax
[SerializableAttribute]
public class Field : IComparable
View Source

The Field type exposes the following members.

Constructors
 NameDescription
Public methodField Creates a new Field.
Top
Properties
 NameDescription
Public propertyAllowsNulls Get or set Allow Null flag
Public propertyAutoIncrement Get or set Auto increment flag
Public propertyAutoIncrementSeed Get or set Auto increment seed
Public propertyAutoIncrementStep Get or set Auto increment step
Public propertyDateTimePrecision Get or set date time precision
Public propertyDefaultValue Get or set default value
Public propertyDescription Get or set description
Public propertyForeignKeys Get or set list of ForeignKeyFields
Public propertyHasDefault Get or set has default value flag
Public propertyIsForeignKey Get or set foreign key flag. if Field is ReferencedBy then true else false
Public propertyIsPrimaryKey Get or set flag to check Field is primary key or not
Public propertyMaxLength Get or set maximum length of field
Public propertyName Get Field Name
Public propertyNonNullNativeValue Gets the native value for the field (SQL Encoded).
Public propertyNumericPrecision Get or set numeric precision
Public propertyNumericScale Get or set Numeric scale
Public propertyOrdinal Get or set file ordinal
Public propertyParent Get or set Fields parent
Public propertyPrimaryKeyName Get or set primary key name
Public propertyPrimaryKeyOrdinal Get or set ordinal for Primary key field
Public propertyReadOnly Get or set read-only flag
Public propertyReferencedBy Get or set - check Field is reference by
Public propertySQLEncodedValue Change Field value to encoded string. It will check Type and Parent value before convert to OleDbType compatible value
Public propertySQLEscapedName Get SQL escaped name of Table
Public propertyTable Get or set Field's parent Table
Public propertyType Get OleDbType Type
Public propertyUnique Get or set for unique
Public propertyValue Get or set value of Field
Top
Methods
 NameDescription
Public methodCompareTo Compare obj ordinal to current field Ordinal
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also