FieldDescriptionData Class Reference

A class used to describe format variable fields. More...

#import <FieldDescriptionData.h>

Inheritance diagram for FieldDescriptionData:

Instance Methods
(id)	- initWithFieldNumber:andWithFieldName:
	Initializes a new instance of the FieldDescriptionData class.

Properties
NSNumber *	fieldNumber
	In CPCL, this number will be the sequential number of the variable field in the format.
NSString *	fieldName
	In CPCL, this field is always nil.

Detailed Description

A class used to describe format variable fields.

In CPCL, the description of the following format will contain 2 <code>FieldDescriptionData</code> objects.
@code 

! 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 nil. The second FieldDescriptionData will contain a fieldNumber of 2, and a fieldName of nil.

In ZPL, the description of the following ^FN command will contain 2 FieldDescriptionData objects.

^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 nil.

Note: If a ZPL label format contains multiple field numbers that use the same identifier, 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.

Method Documentation

- (id) initWithFieldNumber:		(NSNumber *)	aFieldNumber
andWithFieldName:		(NSString *)	aFieldName

Initializes a new instance of the FieldDescriptionData class.

Parameters

aFieldNumber	The number of the field.
aFieldName	The name of the field, or nil if not present.

Property Documentation

- (NSString *) fieldName

readatomicassign

In CPCL, this field is always nil.

In ZPL, this field will correspond to the optional name parameter of the ^FN command, or nil if the parameter is not present.

- (NSNumber *) fieldNumber

readatomicassign

In CPCL, this number will be the sequential number of the variable field in the format.

In ZPL, this number will correspond to the ^FN number.

---

The documentation for this class was generated from the following file:

• FieldDescriptionData.h