FieldDescriptionData Class |
This class is used to describe format variable fields.
Inheritance HierarchyNamespace: Zebra.Sdk.Printer
Assembly: SdkApi_Core (in SdkApi_Core.dll) Version: 2.14.1989
SyntaxThe FieldDescriptionData type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FieldDescriptionData |
Create a descriptor for a field
|
Properties| Name | Description | |
|---|---|---|
 | FieldName |
In CPCL, this field is always null. In ZPL, this field will correspond to the optional name parameter of the ^FN command, or null if the parameter is not present |
| FieldNumber |
In CPCL, this number will be the number of the variable field in the format. The fields are numbered starting at 1. In ZPL, this number will correspond to the ^FN number. |
Methods| Name | Description | |
|---|---|---|
| CompareTo | Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
For example, in CPCL, the following format will contain 2 FieldDescriptionData.
In ZPL, the following ^FN command will contain 2 FieldDescriptionData.
Note: If a label format contains multiple Field Numbers, only 1 will be returned since the data will be shared by all variables with the number. The FieldName portion of the variable will be the last one in the format, unless it is not present.For example, in the format above, there are 3 ^FN15's. The first 2 have a "prompt" parameter, the third does not. The second one, "Address", overwrites the first one, "Name". The third one is not present, so the previous one, "Address", is preserved.
! DF SHELF.FMT
! 0 200 200 210 1
CENTER
TEXT 4 3 0 15 \\
TEXT 4 0 0 95 \\
FORM
PRINT
The first FieldDescriptionData will contain a fieldNumber of 1, and a fieldName of
null. The second FieldDescriptionData will contain a fieldNumber of 2, and a fieldName of null.
In ZPL, the following ^FN command will contain 2 FieldDescriptionData.
^XA
^DFR:SHELF.ZPL^FS
^FO25,25^A0N,50,50^FN15"Name"^FS
^FO25,75^A0N,50,50^FN15"Address"^FS
^FO25,125^A0N,50,50^FN18^FS
^FO25,175^A0N,50,50^FN15
^XZ
The first FieldDescriptionData will contain a fieldNumber of 15, and a fieldName of
"Address". The second FieldDescriptionData will contain a fieldNumber of 18, and a fieldName of null.Note: If a label format contains multiple Field Numbers, only 1 will be returned since the data will be shared by all variables with the number. The FieldName portion of the variable will be the last one in the format, unless it is not present.For example, in the format above, there are 3 ^FN15's. The first 2 have a "prompt" parameter, the third does not. The second one, "Address", overwrites the first one, "Name". The third one is not present, so the previous one, "Address", is preserved.
See Also