Macro Item

Last updated
Save as PDF

MacroItem is implemented as the MacroItem class. A MacroItem object provides the information to define labels and fields within a macro template for messaging. The attributes of MacroItem are:

Attribute	Description
column	An integer value indicating the starting column in the macro (character number) for this item.
dictName	A string of maximum length 25 containing the unique name of the dictionary entry for this item.
dictTag	A string of maximum length 25 containing the unique XML tag name of the dictionary entry for this item.
groupName	A string of maximum length 25 containing the unique name of the group the dictionary entry belongs to.
groupNum	An integer value indicating the sequence of the specified group.
groupTag	A string of maximum length 25 containing the unique XML tag name of the group the dictionary entry belongs to.
length	An integer value indicating the length of the specified item.
required	In the case of input capable items, a boolean value that indicates whether the field is required to be populated before a user or driver may send a message based on this macro.
row	An integer value stating the row of the specified item.
type	A string of maximum length 5 indicating the type of item. This string may have the following values: "label" indicating that the item is a macro label. A label is literal text in the macro template that is usually used as a prompt. The value field will contain the literal text. Any other value indicates that the item defines an input capable field.\(i) Future versions of this structure may include the mobile data type code in this field. Mobile data type codes are numeric values. They will be represented as strings in this field.
value	A string of maximum length 38 indicating the value of the item. For items of type "label": this field contains the label itself. For input capable field items: this field may be empty or, for certain field types, may contain a string that indicates the values that may be entered into the input capable field. These may be a range of numbers or an item list. This string appears as prompting information on the macro template. It usually follows the input capable field.