Barcode#
Class representing a barcode object.
Method / Attribute |
Short Description |
|---|---|
Add metadata to the barcode |
|
Add a listing of metadata to the barcode |
|
Adds result points to the barcode |
|
Gets the text value or number of bytes as a string from the barcode |
|
The text value for the barcode |
|
The barcode’s raw bytes |
|
The barcode’s points |
|
The barcode’s format |
|
The barcode’s metadata |
|
The barcode’s timestamp |
|
The barcode’s number of bits |
Note
See Working with Barcodes for usage examples.
Class API
- class Barcode#
- Barcode(string text, byte[] rawBytes, int numBits, BarcodePoint[] resultPoints, BarcodeFormat format, long timestamp)#
Creates a Barcode object.
- Parameters:
text (string) – String value for barcode.
rawBytes (byte[]) – Raw bytes value for barcode.
numBits (int) – Number of bits for barcode.
resultPoints (BarcodePoint[]) – Result pointsfor barcode.
format (BarcodeFormat) – BarcodeFormat for barcode.
timestamp (long) – Timestamp for barcode.
- putMetadata(BarcodeMetadataType type, object value)#
Adds metadata to the barcode
- Parameters:
type (BarcodeMetadataType) – Type of barcode.
value (object) – A key/value object for the meatadata.
- putAllMetadata(IDictionary<BarcodeMetadataType, object> metadata)#
Adds metadata from a dictionary listing to the barcode.
- Parameters:
metadata (IDictionary) – Dictionary of metadata.
- addResultPoints(BarcodePoint[] newPoints)#
Adds result points to a barcode.
- Parameters:
newPoints (BarcodePoint[]) – An array of barcode points.
- ToString()#
Returns the atring value of the barcode text, or if
nullthen the bytes length.- Return type:
string- Returns:
the string value of the text or the bytes length as a string.
- Text#
The text value for the barcode. Get only.
- Type:
bool
- RawBytes#
The barcode’s raw bytes. Get only.
- Type:
byte[]
- ResultPoints#
The barcode’s points. Get only.
- Type:
BarcodePoint[]
- BarcodeFormat#
The barcode’s format. Get only.
- Type:
- BarcodeMetadata#
The barcode’s metadata. Get only.
- Type:
IDictionary
- Timestamp#
The barcode’s timestamp. Get only.
- Type:
long
- NumBits#
The barcode’s number of bits. Get only.
- Type:
int
BarcodeFormat#
Barcode formats are available from the BarcodeFormat enumeration:
Barcode type |
|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|