Click or drag to resize
XCField Class
Class XCField persents CField.

 

Code of field: C

Type of field: multi-state unordered discrete data.

Storage: one integer with value 0 to 3 for each subfield.

Applicable to:

Discrete data, multiple states (ex: colors, type of vegetation, climate...)

Inheritance Hierarchy

Namespace:  Biolomics.BioCallback
Assembly:  Biolomics.BioCallback (in Biolomics.BioCallback.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public class XCField : XField

The XCField type exposes the following members.

Constructors
  NameDescription
Public methodXCField(XCField)
Copy ctor
Public methodXCField(TCField, XRecord)
Initializes a new instance of the XCField class.
Public methodXCField(XCField, XRecord)
Copy ctor but into a new XRecord
Top
Properties
  NameDescription
Public propertyFieldValue
Gets or sets the field TCField.
(Overrides XFieldFieldValue.)
Public propertyIsModified
Gets or sets a value indicating whether this instance is modified.
(Inherited from XField.)
Public propertySubfield
Gets or sets the subfield value.
Top
Methods
  NameDescription
Public methodCanRead
Determines whether current connection can read from Field.
(Inherited from XField.)
Public methodCanWrite
Determines whether current connection can write from Field.
(Inherited from XField.)
Public methodClear
Clears this instance.
(Inherited from XField.)
Public methodClone
Clones this instance.
Public methodCloneAsXField
Create new XCField based on current XCField
(Overrides XFieldCloneAsXField(XRecord).)
Public methodCount
Counts Subfields in this XCField.
Public methodDataToView
Converts field value to readable string.
(Inherited from XField.)
Public methodDataToView(Int32)
Mandatory otherwise DataToView(5) returns letter 5 of string given by DataToView(), instead of the subfield value
(Inherited from XField.)
Public methodEquals
Determines whether the specified Object is equal to this instance.
(Inherited from XField.)
Protected methodField
Gets the CField object as TField
(Overrides XFieldField.)
Public methodFieldDef
Gets the Field definition.
(Inherited from XField.)
Public methodFieldType
The Field type.
(Inherited from XField.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodKey
Gets Field Key.
(Inherited from XField.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodParentRecord
Gets the parent record.
(Inherited from XField.)
Public methodRead
Reads the Content from source object.
(Inherited from XField.)
Public methodReset
Resets this instance.
(Inherited from XField.)
Public methodSetDefaultValues
Sets the default values.
(Inherited from XField.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWrite
Writes data into a TQuery and Format it depending to field type
(Inherited from XField.)
Top
Examples
This is an example of use of XCField to change XCField subfield value
Example VB.Net
Imports System
Imports BioloMICS.BioCallback
Imports BioloMICS.SharedClasses

Public Class Program

    <STAThread()>
    Shared Sub Main()

        Dim program As New Program
        program.ChangeField()
    End Sub

    '    Write sub functions here
    Public Sub ChangeField()
        '    get the current connection
        Dim SqlCo As XConnection = Run.GetCurrentConnection()
        If SqlCo Is Nothing Then
            Return
        End If

        '    get a table from its User name
        Dim TableDef As XTableDef = SqlCo.GetTableDefByUserNameEng("Your_Table_Name")
        If TableDef Is Nothing Then   '    may happen if that table doesn't exist
            Return
        End If
        '    load a C-Field from that table
        Dim FieldDefMap As New XFieldDefMap
        Dim FieldDef As XFieldDef = SqlCo.GetFieldByUserNameEng("Your_C_Field_name", TableDef.Key)
        If FieldDef Is Nothing Then   '    that field doesn't exist
            Return
        End If
        FieldDefMap.Add(FieldDef)

        '    load all records
        Dim Where As XWhere = XWhere.All

        Dim RecordMap As XRecordMap = Run.LoadRecords(TableDef.Key, FieldDefMap, Where)
        If RecordMap.Count() = 0 Then
            Return   '    no record loaded: nothing else to do
        End If
        For Each Record As XRecord In RecordMap
            '    get the Field from the loaded record
            Dim Field As XCField = TryCast(Record.Fields(FieldDef.Key), XCField)
            If Field Is Nothing Then   '    this field doesn't exist or is not a C-Field
                Continue For
            End If
            '    *****    C Field    meaning *****
            '    Display          Value            Meaning
            '    ?                0            Unknown
            '    variable        1            Character is variable
            '    yes            2            Character is present
            '    no                3            Character is absent

            '    change the field value: replace '?' by 'variable' for the first subfield
            If Field.Subfield(0) = 0 Then    '    ?
                Field.Subfield(0) = 1         '    = variable
            End If

            Record.Save(False)
        Next
    End Sub
End Class
See Also