 | LayoutMessage Class |
Text message formatted according to a Layout specification.
Inheritance HierarchyNamespace: OBCOM.NetSwitchLib.Layouts
Assembly: OBCOM.NetSwitchLib (in OBCOM.NetSwitchLib.dll) Version: 1.48.7760.35650 (1.48.7760.35650)
SyntaxThe LayoutMessage type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LayoutMessage |
Creates a new LayoutMessage instance.
|
| LayoutMessage(String) |
Creates a new LayoutMessage with the supplied text.
|
| LayoutMessage(String, Layout) |
Creates a new LayoutMessage with the supplied arguments.
|
Properties| Name | Description | |
|---|---|---|
  | DefaultSignANSI |
Gets or sets whether, by default, numeric fields are stored in
Messages using the ANSI or the TANDEM format.
|
| DefaultStrict |
Gets or sets whether, by default, message editing is strict.
|
| Layout |
Gets or sets the Layout of this LayoutMessage.
|
| SignANSI |
Gets or sets whether numeric fields are stored in this LayoutMessage using
the ANSI or the TANDEM format.
|
| Strict |
Gets or sets wheter the LayoutMessage is strict.
|
| Text |
Gets or sets the text of this LayoutMessage |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Exists |
Returns true if the field identified by name exists in the Layout of this LayoutMessage.
|
| GetChar(String) |
Returns the first character of the value of the field identified by
name.
|
| GetChar(String, Int32) |
Returns the first character of the value of the field identified by
name and index.
|
| GetDate(String) |
Returns the date value of the field identified by name.
|
| GetDate(String, Int32) |
Returns the date value of the field identified by name and index.
|
| GetDouble(String) |
Returns the double value of the field identified by name.
|
| GetDouble(String, Int32) |
Returns the double value of the field identified by name and index.
|
| GetField |
Returns the field identified by specified name.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInteger(String) |
Returns the integer value of the field identified by name.
|
| GetInteger(String, Int32) |
Returns the integer value of the field identified by name and index.
|
| GetLong(String) |
Returns the long value of the field identified by name.
|
| GetLong(String, Int32) |
Returns the long value of the field identified by name and index.
|
| GetNumber(String) |
Returns the decimal value of the field identified by name.
|
| GetNumber(String, Int32) |
Returns the decimal value of the field identified by name and index.
|
| GetOccurs |
Returns the number of occurrences of the field identified by
name.
|
| GetSequence(String) |
Returns the unformatted character sequence of the field identified
by name.
|
| GetSequence(String, Int32) |
Returns the unformatted character sequence of the field identified
by name and index.
|
| GetString(String) |
Returns the string value of the field identified by name.
|
| GetString(String, Int32) |
Returns the string value of the field identified by name and index.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitFields |
Sets the value of each field of this LayoutMessage to its
default value.
|
| InitFields(LayoutMessage) |
Sets the value of each field of the LayoutMessage to the
value of its corresponding field in source.
|
| IsNull(String) |
Returns true if the value of the field identified by
name is NULL.
|
| IsNull(Int32, Int32) |
Returns true if the substring that begins at the specified start
and extends to the character at index end-1 is null. A substring
is NULL if it's first character is the NO-DATA (0x1a).
|
| IsNull(String, Int32) |
Returns true if the value of the field identified by
name and index is NULL.
|
| Replace |
Replaces the characters in a substring of the message data with
characters in the specified string. The substring begins at the
specified start and extends to the character at
index end-1. If needed, the capacity of the data
is extended so the entire substring can be stored. If the string is
null the substring is filled with NO-DATA (0x1a). If the
string is shorter than the substring, the rest is filled with
spaces.
|
| SetChar(String, NullableChar) |
Changes the character value of the field identified by name to the supplied value.
|
| SetChar(String, Int32, NullableChar) |
Changes the character value of the field identified by name and index to the supplied value.
|
| SetDate(String, NullableDateTime) |
Changes the date value of the field identified by name to the supplied value.
|
| SetDate(String, Int32, NullableDateTime) |
Changes the date value of the field identified by name and index to the supplied value.
|
| SetDouble(String, NullableDouble) |
Changes the double value of the field identified by name to the supplied value.
|
| SetDouble(String, Int32, NullableDouble) |
Changes the double value of the field identified by name and index to the supplied value.
|
| SetInteger(String, NullableInt32) |
Changes the integer value of the field identified by name to the supplied value.
|
| SetInteger(String, Int32, NullableInt32) |
Changes the integer value of the field identified by name and index to the supplied value.
|
| SetLong(String, NullableInt64) |
Changes the long value of the field identified by name to the supplied value.
|
| SetLong(String, Int32, NullableInt64) |
Changes the long value of the field identified by name and index to the supplied value.
|
| SetNull(String) |
Changes the the value of the field identified by name to NULL.
|
| SetNull(String, Int32) |
Changes the the value of the field identified by name and index to NULL.
|
| SetNumber(String, NullableDecimal) |
Changes the decimal value of the field identified by name to the supplied value.
|
| SetNumber(String, Int32, NullableDecimal) |
Changes the decimal value of the field identified by name and index to the supplied value.
|
| SetSequence(String, String) |
Changes the string value of the field identified by name to the supplied value.
|
| SetSequence(String, Int32, String) |
Changes the string value of the field identified by name and index to the supplied value.
|
| SetString(String, String) |
Changes the string value of the field identified by name to the supplied value.
|
| SetString(String, Int32, String) |
Changes the string value of the field identified by name and index to the supplied value.
|
| Substring |
Returns a new string that is a substring of this Message. The
substring begins at the specified start and
extends to the character at index end-1. Thus the
length of the substring is end-start. If the first character of the
substring is NO-DATA (0x1a) it returns null. The
trailing space characters of the the substring are removed (right
trimmed).
|
| TextTrim |
Returns the text of this LayoutMessage with trailing space
characters removed.
|
| ToMessage |
Returns a Message with the text and layout name of this message.
|
| ToString |
Returns a string representation of this LayoutMessage.
(Overrides ObjectToString.) |
| ToXml |
Returns the XML string representation of this LayoutMessage.
|
| VerifyLayout |
Returns true if the name of the Layout of this
LayoutMessage equals to supplied layoutName.
|
See Also