FieldType object describes the attributes of a Field object. More...
#import <kfxKLOFieldType.h>
Instance Methods | |
| (id) | - init |
| Initializer. More... | |
Properties | |
| NSString * | name |
| Field Type Name. More... | |
| NSString * | displayName |
| Field Type Display Name. More... | |
| NSString * | label |
| Field Type Label. More... | |
| bool | required |
| Field object Value Required. More... | |
| KLOdataTypes | dataType |
| Field Data Type. More... | |
| bool | hidden |
| Field Hidden. More... | |
| bool | readOnly |
| ReadOnly. More... | |
| NSMutableArray * | options |
| Options Array. More... | |
| bool | forceMatch |
| Field must match options list choices. More... | |
| NSString * | min |
| Minimum index field value. More... | |
| NSString * | max |
| Maximum index field value. More... | |
| NSString * | defaultValue |
| Default field value. More... | |
| NSString * | customTag |
| Application field. More... | |
Detailed Description
FieldType object describes the attributes of a Field object.
The data contained in an instance of this object describes the attributes of a given Field object. The FieldType object is used as input to instantiation of the Field object.
Serialization**
This class adopts the NSCoding protocol so that this object may be archived and unarchived using the iOS standard [NSKeyedArchiver archiveRootObject:<object> toFile: archiveFileName]; approach. Using keyed archive files, you can save this object for later use. The library supports backward compatibility, such that as a new version of an app that uses the API in this SDK, includes a newer versions of the SDK libraries that have data model changes, the older archive can still be read by the newer version. However, it is not a design goal to archive and dearchive with forward compatibility, such as decoding an archive on a newer version of the class, using an older library.
Refer to the kfxKEDImage class description, by expanding the class description, that describes how to archive and unarchive objects in this framework that adopt the NSCoding protocol.
You can create keyed archives using NSKeyedArchiver objects and decoded by NSKeyedUnarchiver objects. The framework design uses keyed archives, which differ from sequential archives, in that every value encoded in a keyed archive is given a Kofax unique key name. When you decode an archive, the underlying implementation can use values by name, allowing the unarchive delegate to request values in any order or not at all.
Please refer to the Apple documentation for more information: https://developer.apple.com/library/ios/documentation/cocoa/reference/foundation/Classes/NSCoder_Class/Reference/NSCoder.html
Keyed Archiving** https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSKeyedArchiver_Class/Reference/Reference.html#//apple_ref/occ/cl/NSKeyedArchiver
Keyed Unarchiving** https://developer.apple.com/library/mac/documentation/Cocoa/Reference/Foundation/Classes/NSKeyedUnarchiver_Class/Reference/Reference.html#//apple_ref/occ/instm/NSKeyedUnarchiver
Method Documentation
| - (id) init |
Initializer.
This is the default initializer. All properties are set to defaults, as indicated for each property.
Property Documentation
|
readwriteatomicretain |
Application field.
This string value is provided for an application-specific field. Initially, this field value is nil.
|
readwriteatomicassign |
Field Data Type.
This variable identifies the type of data to be contained in the created Field object. By default, the default value is set to KLO_TYPE_STRING. The value must be one of the values identified in the KLOdataTypes enum.
|
readwriteatomicretain |
Default field value.
This string value indicates the default value for the index field.
|
readwriteatomicretain |
Field Type Display Name.
This string member variable contains a human-readable Field Type name suitable for display in User Interface controls. The default value is nil.
|
readwriteatomicassign |
Field must match options list choices.
This boolean variable determines if the user is limited to the choices in the options array, or if other values are valid. The default of this variable is true (limited to the choice in the options array).
|
readwriteatomicassign |
Field Hidden.
This boolean variable defines whether the field should be visible to the user. The default value of this variable is false (not hidden).
|
readwriteatomicretain |
Field Type Label.
This string member variable contains a displayable label for this field type. The default label value is nil.
|
readwriteatomicretain |
Maximum index field value.
This string value indicates the maximum value for the index field. For strings, this specifies the maximum length. For integer and float values, this specifies the maximum allowed value. The value can be negative. For dates, this specifies the newest allowed date. The default value of this variable is nil.
|
readwriteatomicretain |
Minimum index field value.
This string value indicates the minimum value for the index field. For strings, this specifies the minimum length. For integer and float values, this specifies the minimum allowed value. This value can be negative. For dates, this specifies the oldest allowed date. The default value of this variable is nil.
|
readwriteatomicretain |
Field Type Name.
This string member variable contains a name for this Field Type. The default name value is nil.
|
readwriteatomicretain |
Options Array.
This array of strings contains the values associated with a choice list for this field. This array is implemented as a NSMutableArray. Thus, its contents can't be manipulated using standard getter and setter functions. For example, to add a NSString object to the array, the method might be:
|
readwriteatomicassign |
ReadOnly.
This boolean variable defines whether the field should be updatable by the user. The default value of this variable is false.
|
readwriteatomicassign |
Field object Value Required.
This boolean variable indicates whether a value must be entered for the associated Field object. The default value is false.
The documentation for this class was generated from the following file: