LayoutField Class |
Inheritance HierarchyNamespace: OBCOM.NetClient
Assembly: OBCOM.NetClient (in OBCOM.NetClient.dll) Version: 40.82.5945.17884 (40.82.5945.17884)
SyntaxThe LayoutField type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Default |
Returns the default value of the field.
|
| DefinedDefault |
Returns the defined default value of the field.
|
| Length |
Returns the length of the field.
|
| Name |
Returns the name of the field.
|
| Occurs |
Returns the number of occurrences of the field.
|
| Parent |
Returns the list field that contains the LayoutField.
|
| Scale |
Returns the numeric scale of the field.
|
| Type |
Returns the type of the field.
|
Methods| Name | Description | |
|---|---|---|
 | 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.) |
| GetChar |
Returns the first character of the value of the index
occurence of field in message.
|
| GetData |
Returns the string value of the index occurence of
field in message.
|
| GetDate |
Returns the date value of the index occurence of
field in message.
|
| GetDouble |
Returns the double value of the index occurence of
field in message.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInteger |
Returns the integer value of the index occurence of
field in message.
|
| GetNumber |
Returns the decimal value of the index occurence of
field in message.
|
| GetOffset |
Returns the offset position of the index occurence of
the field in the message or parent list.
|
| GetString |
Returns the string value of the index occurence of
field in message.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsNull |
Returns true is the data of the index
occurence of the field in message is NULL.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetChar |
Updates the character value of the index occurence of
field in message.
|
| SetData |
Updates the internal character sequence of the index
occurence of this field in message.
|
| SetDate |
Updates the date value of the index occurence of
field in message.
|
| SetDefault |
Updates the index occurence of the field in message to its default value.
|
| SetDouble |
Updates the double value of the index occurence of
field in message.
|
| SetInteger |
Updates the integer value of the index occurence of
field in message.
|
| SetNull |
Updates the data of the index occurence of this field
stored in message with the NULL (NO-DATA)
value.
|
| SetNumber |
Updates the decimal value the index occurence of
field in message.
|
| SetString |
Updates the string value of the index occurence of
field in message.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
RemarksA 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