Click or drag to resize

LayoutField Class

Represents a data item whose value can be stored in a Message.
Inheritance Hierarchy
SystemObject
  OBCOM.NetClientLayoutField

Namespace:  OBCOM.NetClient
Assembly:  OBCOM.NetClient (in OBCOM.NetClient.dll) Version: 40.82.5945.17884 (40.82.5945.17884)
Syntax
[SerializableAttribute]
public abstract class LayoutField

The LayoutField type exposes the following members.

Properties
  NameDescription
Public propertyDefault
Returns the default value of the field.
Public propertyDefinedDefault
Returns the defined default value of the field.
Public propertyLength
Returns the length of the field.
Public propertyName
Returns the name of the field.
Public propertyOccurs
Returns the number of occurrences of the field.
Public propertyParent
Returns the list field that contains the LayoutField.
Public propertyScale
Returns the numeric scale of the field.
Public propertyType
Returns the type of the field.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodGetChar
Returns the first character of the value of the index occurence of field in message.
Public methodGetData
Returns the string value of the index occurence of field in message.
Public methodGetDate
Returns the date value of the index occurence of field in message.
Public methodGetDouble
Returns the double value of the index occurence of field in message.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetInteger
Returns the integer value of the index occurence of field in message.
Public methodGetNumber
Returns the decimal value of the index occurence of field in message.
Public methodGetOffset
Returns the offset position of the index occurence of the field in the message or parent list.
Public methodGetString
Returns the string value of the index occurence of field in message.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsNull
Returns true is the data of the index occurence of the field in message is NULL.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetChar
Updates the character value of the index occurence of field in message.
Public methodSetData
Updates the internal character sequence of the index occurence of this field in message.
Public methodSetDate
Updates the date value of the index occurence of field in message.
Public methodSetDefault
Updates the index occurence of the field in message to its default value.
Public methodSetDouble
Updates the double value of the index occurence of field in message.
Public methodSetInteger
Updates the integer value of the index occurence of field in message.
Public methodSetNull
Updates the data of the index occurence of this field stored in message with the NULL (NO-DATA) value.
Public methodSetNumber
Updates the decimal value the index occurence of field in message.
Public methodSetString
Updates the string value of the index occurence of field in message.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

A LayoutField has a type, a name, a length, a numeric scale and a default value. The values of these properties have restrictions depending on the type of the field. For example, if the type of a field is TEXT then its scale value must be defined as 0 (zero). The following table shows the defined LayoutField types and their property restrictions

A LayoutField of type LIST represents a list of fields with multiple occurrences (an array). The number of occurrences of the fields contained in the list is given by the length of the LIST. Each field in this list is accessed using it's Name and an Index number where (0 <= Index < Occurrences). The LISTEND type is used to complete (or terminate) the definition of a LayoutField of type LIST; it does not represent an actual field.

See Also