Class BarcodeGenerator

Definition

Namespace:
Tizen.Multimedia.Vision
Assembly:
Tizen.Multimedia.Vision.dll

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

public static class BarcodeGenerator
Inheritance
object
BarcodeGenerator

Methods

View Source

GenerateImage(string, BarcodeType, BarcodeImageConfiguration, BarcodeGenerationConfiguration)

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

Declaration
public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config)
Parameters
Type Name Description
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.
System.UnauthorizedAccessException

No permission to write a file.
System.NotSupportedException

The feature is not supported.
System.ObjectDisposedException

config already has been disposed of.
See Also
View Source

GenerateImage(string, BarcodeType, BarcodeImageConfiguration)

Generates a barcode image file with the specified message.

Declaration
public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig)
Parameters
Type Name Description
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.
System.UnauthorizedAccessException

No permission to write a file.
System.NotSupportedException

The feature is not supported.
See Also
View Source

GenerateImage(string, QrConfiguration, BarcodeImageConfiguration, BarcodeGenerationConfiguration)

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

Declaration
public static void GenerateImage(string message, QrConfiguration qrConfig, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config)
Parameters
Type Name Description
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.
System.UnauthorizedAccessException

No permission to write a file.
System.NotSupportedException

The feature is not supported.
-or-
TextVisibility is the Visible.
System.ObjectDisposedException

config already has been disposed of.
See Also
View Source

GenerateImage(string, QrConfiguration, BarcodeImageConfiguration)

Generates a QR image file with the specified message.

Declaration
public static void GenerateImage(string message, QrConfiguration qrConfig, BarcodeImageConfiguration imageConfig)
Parameters
Type Name Description
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.
System.UnauthorizedAccessException

No permission to write a file.
System.NotSupportedException

The feature is not supported.
See Also
View Source

GenerateSource(string, BarcodeType, BarcodeGenerationConfiguration)

Generates a barcode image with the specified message and BarcodeGenerationConfiguration.

Declaration
public static MediaVisionSource GenerateSource(string message, BarcodeType type, BarcodeGenerationConfiguration config)
Parameters
Type Name Description
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.
System.ObjectDisposedException

config already has been disposed of.
See Also
View Source

GenerateSource(string, BarcodeType)

Generates a barcode image with the specified message.

Declaration
public static MediaVisionSource GenerateSource(string message, BarcodeType type)
Parameters
Type Name Description
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.
See Also
View Source

GenerateSource(string, QrConfiguration, BarcodeGenerationConfiguration)

Generates a QR image with the specified message with BarcodeGenerationConfiguration.

Declaration
public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig, BarcodeGenerationConfiguration config)
Parameters
Type Name Description
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.
System.ObjectDisposedException

config already has been disposed of.
See Also
View Source

GenerateSource(string, QrConfiguration)

Generates a QR image with the specified message.

Declaration
public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig)
Parameters
Type Name Description
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.
See Also

See Also