WriteBarcode Method

C#
Visual Basic
WinRT C#
Java
Objective-C
WinRT JavaScript
C++

public void WriteBarcode( 
   RasterImage image,
   BarcodeData data,
   BarcodeWriteOptions options
)

'Declaration

Public Sub WriteBarcode( _
   ByVal image As RasterImage, _
   ByVal data As BarcodeData, _
   ByVal options As BarcodeWriteOptions _
)

'Usage

Dim instance As BarcodeWriter
Dim image As RasterImage
Dim data As BarcodeData
Dim options As BarcodeWriteOptions
 
instance.WriteBarcode(image, data, options)

public void WriteBarcode( 
   RasterImage image,
   BarcodeData data,
   BarcodeWriteOptions options
)

- (BOOL)writeBarcode:(LTRasterImage *)image 
                data:(LTBarcodeData *)data 
             options:(nullable LTBarcodeWriteOptions *)options 
               error:(NSError **)error

public void writeBarcode(
  RasterImage image, 
  BarcodeData data, 
  BarcodeWriteOptions options
)

 function Leadtools.Barcode.BarcodeWriter.WriteBarcode( 
   image ,
   data ,
   options 
)

public:
void WriteBarcode( 
   RasterImage^ image,
   BarcodeData^ data,
   BarcodeWriteOptions^ options
)

Parameters

image: The RasterImage that specifies the image to write the barcode to. Must not be null (Nothing in Visual Basic).
data: The barcode data. Must not be null (Nothing in Visual Basic).
options: Write options. Could be null (Nothing in Visual Basic).

Writes a barcode to an image. The data object must contain the data for the barcode (or one of its derived classes). The following members are used by this method:

BarcodeData.Symbology: Specifies the symbology (or type) of the barcode to write. Must not be set to BarcodeSymbology.Unknown.
The raw data stored in BarcodeData.GetData: Must contain the raw data for the symbology in a format and size supported by the barcode standard.
BarcodeData.Bounds: Must contain barcode location (and optionally, its size). Refer to Writing Barcodes - Bounds and XModule for more information.

If options is null (Nothing in Visual Basic), then this method will use the default write options associated with the symbology by calling GetDefaultOptions(data.Symbology). If options is not null (Nothing in Visual Basic), then this method will use these write options instead of the default ones. The default will use options stored in this BarcodeWriter and will not be overridden by this method at any time.

Note that this method will not check if the options passed in options are associated with symbology stored in BarcodeData.Symbology. If these two do not match, then the default options are used instead.

For an example, refer to BarcodeWriter.

Target Platforms

Reference