Class BarcodeGenerator

Definition

Namespace:: Tizen.Multimedia.Vision

Assembly:: Tizen.Multimedia.Vision.dll

API Level:: 4

Provides the ability to generate barcodes and QR codes. Different encoding types QrMode, error correction codes ErrorCorrectionLevel, and code versions are supported for QRCodes.


                C#
                
                    Copy
                    
                
            
public static class BarcodeGenerator

Inheritance: System.Object

BarcodeGenerator

Methods

View Source

GenerateImage(String, BarcodeType, BarcodeImageConfiguration)

Generates a barcode image file with the specified message.

Declaration


                C#
                
                    Copy
                    
                
            
public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig)

Parameters

Type	Name	Description
System.String	message	The message to be encoded in the barcode.
BarcodeType	type	Type of the barcode to be generated.
BarcodeImageConfiguration	imageConfig	The BarcodeImageConfiguration that contains information about the file to be generated.

Exceptions

Type	Condition
System.ArgumentNullException	`message` is null. -or- `imageConfig` is null.
System.ArgumentException	`message` is too long. -or- `type` is QR. -or- `type` is invalid. -or- `message` contains illegal characters.
UnauthorizedAccessException	No permission to access a file.
System.NotSupportedException	The feature is not supported.

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

View Source

GenerateImage(String, BarcodeType, BarcodeImageConfiguration, BarcodeGenerationConfiguration)

Generates a barcode image file with the specified message and BarcodeGenerationConfiguration.

Declaration


                C#
                
                    Copy
                    
                
            
public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config)

Parameters

Type	Name	Description
System.String	message	The message to be encoded in the barcode.
BarcodeType	type	Type of the barcode to be generated.
BarcodeImageConfiguration	imageConfig	The BarcodeImageConfiguration that contains information about the file to be generated.
BarcodeGenerationConfiguration	config	The configuration of the barcode generator. This value can be null.

Exceptions

Type	Condition
System.ArgumentNullException	`message` is null. -or- `imageConfig` is null.
System.ArgumentException	`message` is too long. -or- `type` is QR. -or- `type` is invalid. -or- `message` contains illegal characters.
UnauthorizedAccessException	No permission to access a file.
System.NotSupportedException	The feature is not supported.
ObjectDisposedException	`config` already has been disposed of.

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

View Source

GenerateImage(String, QrConfiguration, BarcodeImageConfiguration)

Generates a QR image file with the specified message.

Declaration


                C#
                
                    Copy
                    
                
            
public static void GenerateImage(string message, QrConfiguration qrConfig, BarcodeImageConfiguration imageConfig)

Parameters

Type	Name	Description
System.String	message	The message to be encoded in the barcode.
QrConfiguration	qrConfig	The QrConfiguration instance.
BarcodeImageConfiguration	imageConfig	The BarcodeImageConfiguration that contains information about the file to be generated.

Remarks

TextVisibility must be Invisible, because the text visibility is not supported in the QR code.

Exceptions

Type	Condition
System.ArgumentNullException	`message` is null. -or- `qrConfig` is null. -or- `imageConfig` is null.
System.ArgumentException	`message` is too long. -or- `message` contains characters which are illegal by the QrMode.
UnauthorizedAccessException	No permission to access a file.
System.NotSupportedException	The feature is not supported.

GenerateImage(String, QrConfiguration, BarcodeImageConfiguration, BarcodeGenerationConfiguration)

Generates a QR image file with the specified message and BarcodeGenerationConfiguration.

Declaration


                C#
                
                    Copy
                    
                
            
public static void GenerateImage(string message, QrConfiguration qrConfig, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config)

Parameters

Type	Name	Description
System.String	message	The message to be encoded in the barcode.
QrConfiguration	qrConfig	The QrConfiguration instance.
BarcodeImageConfiguration	imageConfig	The BarcodeImageConfiguration that contains information about the file to be generated.
BarcodeGenerationConfiguration	config	The configuration of the barcode generator. This value can be null.

Remarks

TextVisibility must be Invisible, because the text visibility is not supported in the QR code.

Exceptions

Type	Condition
System.ArgumentNullException	`message` is null. -or- `qrConfig` is null. -or- `imageConfig` is null.
System.ArgumentException	`message` is too long. -or- `message` contains characters which are illegal by the QrMode.
UnauthorizedAccessException	No permission to access a file.
System.NotSupportedException	The feature is not supported. -or- TextVisibility is the Visible.
ObjectDisposedException	`config` already has been disposed of.

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

View Source

GenerateSource(String, BarcodeType)

Generates a barcode image with the specified message.

Declaration


                C#
                
                    Copy
                    
                
            
public static MediaVisionSource GenerateSource(string message, BarcodeType type)

Parameters

Type	Name	Description
System.String	message	The message to be encoded in the barcode.
BarcodeType	type	Type of the barcode to be generated.

Returns

Type	Description
MediaVisionSource	MediaVisionSource containing the generated barcode image.

Exceptions

Type	Condition
System.ArgumentNullException	`message` is null.
System.ArgumentException	`message` is too long. -or- `type` is QR. -or- `type` is invalid. -or- `message` contains illegal characters.
System.NotSupportedException	The feature is not supported.

API Level: 4

View Source

GenerateSource(String, BarcodeType, BarcodeGenerationConfiguration)

Generates a barcode image with the specified message and BarcodeGenerationConfiguration.

Declaration


                C#
                
                    Copy
                    
                
            
public static MediaVisionSource GenerateSource(string message, BarcodeType type, BarcodeGenerationConfiguration config)

Parameters

Type	Name	Description
System.String	message	The message to be encoded in the barcode.
BarcodeType	type	Type of the barcode to be generated.
BarcodeGenerationConfiguration	config	The configuration of the barcode generator. This value can be null.

Returns

Type	Description
MediaVisionSource	MediaVisionSource containing the generated barcode image.

Exceptions

Type	Condition
System.ArgumentNullException	`message` is null.
System.ArgumentException	`message` is too long. -or- `type` is QR. -or- `type` is invalid. -or- `message` contains illegal characters.
System.NotSupportedException	The feature is not supported.
ObjectDisposedException	`config` already has been disposed of.

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

View Source

GenerateSource(String, QrConfiguration)

Generates a QR image with the specified message.

Declaration


                C#
                
                    Copy
                    
                
            
public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig)

Parameters

Type	Name	Description
System.String	message	The message to be encoded in the barcode.
QrConfiguration	qrConfig	The QrConfiguration instance.

Returns

Type	Description
MediaVisionSource	MediaVisionSource containing the generated QR image.

Exceptions

Type	Condition
System.ArgumentNullException	`qrConfig` is null. -or- `message` is null.
System.ArgumentException	`message` is too long. -or- `message` contains characters which are illegal by the QrMode.
System.NotSupportedException	The feature is not supported.

GenerateSource(String, QrConfiguration, BarcodeGenerationConfiguration)

Generates a QR image with the specified message with BarcodeGenerationConfiguration.

Declaration


                C#
                
                    Copy
                    
                
            
public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig, BarcodeGenerationConfiguration config)

Parameters

Type	Name	Description
System.String	message	The message to be encoded in the barcode.
QrConfiguration	qrConfig	The QrConfiguration instance.
BarcodeGenerationConfiguration	config	The configuration of the barcode generator. This value can be null.

Returns

Type	Description
MediaVisionSource	MediaVisionSource containing the generated QR image.

Remarks

TextVisibility must be Invisible, because the text visibility is not supported in the QR code.

Exceptions

Type	Condition
System.ArgumentNullException	`qrConfig` is null. -or- `message` is null.
System.ArgumentException	`message` is too long. -or- `message` contains characters which are illegal by the QrMode.
System.NotSupportedException	The feature is not supported. -or- TextVisibility is the Visible.
ObjectDisposedException	`config` already has been disposed of.

Class BarcodeGenerator

Definition

Methods

GenerateImage(String, BarcodeType, BarcodeImageConfiguration)

Declaration

Parameters

Exceptions

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

GenerateImage(String, BarcodeType, BarcodeImageConfiguration, BarcodeGenerationConfiguration)

Declaration

Parameters

Exceptions

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

GenerateImage(String, QrConfiguration, BarcodeImageConfiguration)

Declaration

Parameters

Remarks

Exceptions

See Also

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

GenerateImage(String, QrConfiguration, BarcodeImageConfiguration, BarcodeGenerationConfiguration)

Declaration

Parameters

Remarks

Exceptions

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

GenerateSource(String, BarcodeType)

Declaration

Parameters

Returns

Exceptions

API Level: 4

GenerateSource(String, BarcodeType, BarcodeGenerationConfiguration)

Declaration

Parameters

Returns

Exceptions

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

GenerateSource(String, QrConfiguration)

Declaration

Parameters

Returns

Exceptions

See Also

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

GenerateSource(String, QrConfiguration, BarcodeGenerationConfiguration)

Declaration

Parameters

Returns

Remarks

Exceptions

See Also

API Level: 4

Feature: http://tizen.org/feature/vision.barcode_generation

See Also