Class BarcodeResult
Result from reading a barcode using IronBarCode
Inheritance
Namespace: IronBarCode
Assembly: IronBarCode.dll
Syntax
public class BarcodeResult : ObjectConstructors
BarcodeResult()
Initializes a new instance of the BarcodeResults class.
Declaration
public BarcodeResult()BarcodeResult(PointF[], String)
Initializes a new instance of the BarcodeResults class.
Declaration
public BarcodeResult(PointF[] points, string value)Parameters
| Type | Name | Description |
|---|---|---|
| IronSoftware.Drawing.PointF[] | points | |
| System.String | value |
Properties
BarcodeImage
An image of the scanned barcode image as a IronSoftware.Drawing.AnyBitmap.
This IronSoftware.Drawing.AnyBitmap will be disposed when the BarcodeResult finalizes. If you wish to keep a permanent copy of the BarcodeImage use the (Bitmap)BarcodeResult.BarcodeImage.Clone() method.
Declaration
public AnyBitmap BarcodeImage { get; }Property Value
| Type | Description |
|---|---|
| IronSoftware.Drawing.AnyBitmap | An image of the barcode which was read. |
BarcodeType
The BarcodeEncoding (barcode type) which was detected
Declaration
public BarcodeEncoding BarcodeType { get; }Property Value
| Type | Description |
|---|---|
| BarcodeEncoding |
BinaryValue
The binary value of the barcode as a byte array.
Declaration
public byte[] BinaryValue { get; }Property Value
| Type | Description |
|---|---|
| System.Byte[] |
Height
A Barcode Height
Declaration
public Nullable<int> Height { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
PageNumber
The page number of the PDF or Image in which the barcode was discovered.
Declaration
public int PageNumber { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
PageOrientation
A Page orientation of input image.
Declaration
public PageOrientation PageOrientation { get; }Property Value
| Type | Description |
|---|---|
| PageOrientation |
Points
Points defining the corners of the detected barcode code.
Declaration
public PointF[] Points { get; }Property Value
| Type | Description |
|---|---|
| IronSoftware.Drawing.PointF[] |
Rotation
Clockwise rotation of the barcode from a horizontal position. Setting AutoRotate to true in BarcodeReaderOptions gives the angle in multiples of 15, while setting it to false gives it in multiples of 90. Null signifies the orientation was not found.
Declaration
public Nullable<int> Rotation { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Text
The value of the barcode as a string. Synonym for BarcodeResult.Value
Declaration
public string Text { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Url
Gets the URI if the Value is a valid URI.
Declaration
public Uri Url { get; }Property Value
| Type | Description |
|---|---|
| System.Uri |
Value
The value of the barcode as a string.
Declaration
public string Value { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Width
A Barcode Width
Declaration
public Nullable<int> Width { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Methods
ToString()
Returns a System.String that represents the value of the barcode as a string;
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | A System.String that represents this instance. |