Class # Barcode
forsearch
Hardware --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description Uses the device's camera to read any bar code types supported by the device. You must call `StartScan` to display the scanning interface and begin scanning for a barcode. Scanning continues until `StopScan` is called in code or the user closes the scanning dialog. Once `StartScan` is called, displaying the scanning interface does not block execution of code on the main thread. Use the `ScanCompleted`, `ScanCancelled`, and `ScanFailed` events to respond to the result of the scan. ## Properties
table-centered_columns_3_and_4
| Name | Type | Read-Only | Shared | |----------------------------------|------------------------------------|-----------|--------| | `FullScreen` | `Boolean` | | | ## Methods
table-centered_column_4
| Name | Parameters | Returns | Shared | |--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|--------| | `FromImage` | image As `Picture` | `String()` | ✓ | | `Image` | value As `String`, width As `Integer`, height As `Integer`, type As `Barcode.Types` = `Barcode.Types.QR` | `Picture` | ✓ | | `StartScan` | | | | | `StopScan` | | | | ## Events
table-centered_column_4
| Name | Parameters | Returns | |----------------------------------------|-------------------------------------------|---------| | `ScanCancelled` | | | | `ScanCompleted` | value As `String` | | | `ScanFailed` | | | ## Enumerations
forsearch
Barcode.Types ### Types > The types of barcodes that can be read. > > | Name | > |--------| > | QR | > | Bar128 | ## Property descriptions
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
Barcode.FullScreen **FullScreen** As `Boolean` > If `True` the barcode scanner will appear full screen. > > This can be changed even while the barcode scanner is already displayed. > >
> >
> > Important > >
> > This property is only supported for iOS. > >
> >
> >
> > Important > >
> > For Web, please use the `WebBarcode` control. > >
## Method descriptions
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
Barcode.FromImage **FromImage**(image As `Picture`) As `String()` > Returns an array of the unique identifiers from all detected barcodes in the *image* provided. > > This method is `shared`.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
Barcode.Image **Image**(value As `String`, width As `Integer`, height As `Integer`, type As `Barcode.Types` = `Barcode.Types.QR`) As `Picture` > Returns an image with the value encoded as the specified type of barcode. > > This method is `shared`.
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
Barcode.StartScan **StartScan** > Opens the scanning user interface provided by the device and begins scanning for a barcode. The device will auto-detect the type of barcode. Scanning continues until `StopScan` is called in code or the user closes the scanning dialog. > > Displaying the scanning interface does not block execution of code on the main thread. Use the `ScanCompleted`, `ScanCancelled`, and `ScanFailed` events to respond to the result of the scan. > >
> >
> > Important > >
> > For macOS, this method requires macOS 10.15 or later. > >
> >
> >
> > Important > >
> > For Web, please use the `WebBarcode` control. > >
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
Barcode.StopScan **StopScan** > Stops the process of scanning barcodes and closes the scanning user interface on the device. > >
> >
> > Important > >
> > This method is not currently supported for Android. > >
> >
> >
> > Important > >
> > For Web, please use the `WebBarcode` control. > >
## Event descriptions
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
Barcode.ScanCancelled **ScanCancelled** > The user canceled the scan. > >
> >
> > Important > >
> > For Web, please use the `WebBarcode` control. > >
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
Barcode.ScanCompleted **ScanCompleted**(value As `String`) > A barcode was successfully scanned. The *value* is the unique identifier scanned. > >
> >
> > Important > >
> > For Web, please use the `WebBarcode` control. > >
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
forsearch
Barcode.ScanFailed **ScanFailed** > The scan was not able to complete. > >
> >
> > Important > >
> > For Web, please use the `WebBarcode` control. > >
## Notes For Android Play Store installs, the Play Store will download and install the barcode library if it was not already installed on the device. For non Play Store-installs, the OS will download the library after it is first used (if it is not already installed). Attempting to scan before the library is installed (which could take several minutes depending on how the OS prioritizes it) will result in the `ScanFailed` event will be called until it completes. On Linux, X11 is required. This class is not supported for Wayland. ### Supported barcode types The following types of barcodes are supported: | Type | Description | |-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Aztec | Two-dimensional Barcodes and has a characteristic square pattern in the middle. This Code is widely used by railway companies in their ticketing systems. | | Code39 | Widely used in a variety of industries and is part of of many governmental specifications. It encodes a set of alphanumeric symbols. | | Code93 | Encodes numerical input, as well as capital letters and some special characters. It used by Canada Post for additional delivery information. | | Code128 | Universal barcode with excellent data density. It is used, for example, in shipping and packaging. | | Data Matrix | Two-dimensional Code that may contain text, numbers or binary data. It is widely used for labeling small electronic components or in food production, but also on mail labels. | | EAN8 | Derived from the longer European Article Number (EAN-13) code. It was introduced for use on small packages where an EAN-13 barcode would be too large. | | EAN13 | Codes are widely used in retail across Europe. There are several versions of EAN encoding 2, 5, 7 or 12 digits. | | Interleaved2of5 | Developed on the basis of Industrial Code 2 of 5 and only encodes an even number of digits. It is used in warehousing and industrial applications. | | ITF14 | Also called SCC-14 is used to mark shipping containers. It is also placed on cartons and pallets and signifies the type of products transported. | | PDF417 | Suitable for storing large amounts of data due to its two-dimensional structure. It is widely used for labeling electronic equipment or hazardous materials, but also on personal IDs. | | QR | Applications include product tracking, item identification, time tracking, document management, and general marketing. | | UPC-E | Only has 8 digits and is used instead of UPC-A on smaller products. It is similarly used in retail and warehousing, especially in the USA and Canada. | ## Compatibility | | | |-----------------------|-----| | **Project Types** | All | | **Operating Systems** | All |
`Object` parent class; `WebBarcode` class