DrawBarcodePDF417(String,BarcodePDF417EncodingMode,BarcodePDF417ErrorCorrectionLevel,Int32,Int32,Int32,Int32,Int32,Single,Single,Color,Color) Method

In This Topic

Draws a required PDF417 barcode onto the currently selected page of the loaded PDF document according to your preference.

This method uses the RGB color space internally when manipulating with the barcode symbol's fill and background colors you have specified.

The coordinates and the dimensions of the PDF417 barcode symbol need to be set in the current units with respect to the currently located origin defined in the PDF document, related to the actual page, where the symbol is to be drawn. You can use the GetMeasurementUnit method to determine the currently defined units and you can use the SetMeasurementUnit method to reset the units according to your preference.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function DrawBarcodePDF417( _
   ByVal Data As String, _
   ByVal EncodingMode As BarcodePDF417EncodingMode, _
   ByVal ErrorCorrectionLevel As BarcodePDF417ErrorCorrectionLevel, _
   ByVal Rows As Integer, _
   ByVal Cols As Integer, _
   ByVal QuietZone As Integer, _
   ByVal ModuleWidth As Integer, _
   ByVal RowHeight As Integer, _
   ByVal DstX As Single, _
   ByVal DstY As Single, _
   ByVal FillColor As Color, _
   ByVal BackColor As Color _
) As GdPictureStatus

public GdPictureStatus DrawBarcodePDF417( 
   string Data,
   BarcodePDF417EncodingMode EncodingMode,
   BarcodePDF417ErrorCorrectionLevel ErrorCorrectionLevel,
   int Rows,
   int Cols,
   int QuietZone,
   int ModuleWidth,
   int RowHeight,
   float DstX,
   float DstY,
   Color FillColor,
   Color BackColor
)

public function DrawBarcodePDF417( 
    Data: String;
    EncodingMode: BarcodePDF417EncodingMode;
    ErrorCorrectionLevel: BarcodePDF417ErrorCorrectionLevel;
    Rows: Integer;
    Cols: Integer;
    QuietZone: Integer;
    ModuleWidth: Integer;
    RowHeight: Integer;
    DstX: Single;
    DstY: Single;
    FillColor: Color;
    BackColor: Color
): GdPictureStatus;

public function DrawBarcodePDF417( 
   Data : String,
   EncodingMode : BarcodePDF417EncodingMode,
   ErrorCorrectionLevel : BarcodePDF417ErrorCorrectionLevel,
   Rows : int,
   Cols : int,
   QuietZone : int,
   ModuleWidth : int,
   RowHeight : int,
   DstX : float,
   DstY : float,
   FillColor : Color,
   BackColor : Color
) : GdPictureStatus;

public: GdPictureStatus DrawBarcodePDF417( 
   string* Data,
   BarcodePDF417EncodingMode EncodingMode,
   BarcodePDF417ErrorCorrectionLevel ErrorCorrectionLevel,
   int Rows,
   int Cols,
   int QuietZone,
   int ModuleWidth,
   int RowHeight,
   float DstX,
   float DstY,
   Color FillColor,
   Color BackColor
)

public:
GdPictureStatus DrawBarcodePDF417( 
   String^ Data,
   BarcodePDF417EncodingMode EncodingMode,
   BarcodePDF417ErrorCorrectionLevel ErrorCorrectionLevel,
   int Rows,
   int Cols,
   int QuietZone,
   int ModuleWidth,
   int RowHeight,
   float DstX,
   float DstY,
   Color FillColor,
   Color BackColor
)

Parameters

Data: The data to encode using the required barcode symbol.
EncodingMode: A member of the BarcodePDF417EncodingMode enumeration. The barcode encoding mode.
You can use the BarcodePDF417EncodingMode.BarcodePDF417EncodingModeUndefined to let the engine analyze the input and to select the most appropriate encoding mode.
ErrorCorrectionLevel: A member of the BarcodePDF417ErrorCorrectionLevel enumeration. The error correction level.
You can use the BarcodePDF417ErrorCorrectionLevel.BarcodePDF417ErrorCorrectionLevelAuto to let the engine automatically determine the required level.
Rows: Specifies the number of rows constituting the barcode symbol.
A PDF417 symbol must have at least 3 rows and no more than 90. It is recommended to use 0 for automatic computation.
Cols: Specifies the number of columns constituting the barcode symbol.
A column refers to the set of codewords vertically. A PDF41 symbol may have 1 to 30 columns. It is recommended to use 0 for automatic computation.
QuietZone: The number of modules composing the quiet zone. The quiet zone defines the margin around the barcode, specifically for the PDF417 barcode it is a mandated minimum amount of white space before the barcode begins and ends.
ModuleWidth: The width of a module, in points.
Module is the smallest unit of a PDF417 symbol. The width of a module (width of the narrowest bar) is commonly referred as X dimension of the symbol, for more details on this please read the Remarks section below.
RowHeight: The height of each row, in points.
For better decodability, height should be no less than 2, for more details on this please read the Remarks section below.
DstX: The horizontal (X) coordinate of the destination point, expressed in the current units specified by the SetMeasurementUnit method with respect to the defined origin, related to the currently selected page.
DstY: The vertical (Y) coordinate of the destination point, expressed in the current units specified by the SetMeasurementUnit method with respect to the defined origin, related to the currently selected page.
FillColor: A color object that defines the color to be used for drawing a required barcode symbol.
BackColor: A color object that defines the color to be used for drawing a background behind the barcode symbol.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

This method is only allowed for use with non-encrypted documents.

Just to remind you that the PDF417 barcode is usually printed at an X to Y ratio of 1:2 to 1:5, with 1:3 being the most popular. By lowering the ratio, a significant amount of space can be saved; however, some scanners cannot read X to Y ratios of less than 1:3.

Likewise, just to remind you that 1 point is equivalent to 1/72 of an inch.

This method requires the Barcode Reading & Writing component to run.

Example

How to draw various PDF417 barcodes on the newly created page of the new PDF document.

VB.NET
C#

Dim caption As String = "Example: DrawBarcodePDF417"
Dim gdpicturePDF As New GdPicturePDF()
Dim status As GdPictureStatus = gdpicturePDF.NewPDF()
If status = GdPictureStatus.OK Then
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter)
    status = gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeLetter)
    If status = GdPictureStatus.OK Then
        If (gdpicturePDF.DrawBarcodePDF417("0123456789", BarcodePDF417EncodingMode.BarcodePDF417EncodingModeText, BarcodePDF417ErrorCorrectionLevel.BarcodePDF417ErrorCorrectionLevel2,
                                            16, 5, 2, 2, 4, 2, 2, Color.Chocolate, Color.Yellow) = GdPictureStatus.OK) AndAlso
           (gdpicturePDF.DrawBarcodePDF417("9876543210", BarcodePDF417EncodingMode.BarcodePDF417EncodingModeText, BarcodePDF417ErrorCorrectionLevel.BarcodePDF417ErrorCorrectionLevel2,
                                            32, 5, 2, 4, 6, 2, 10, Color.Chocolate, Color.Yellow) = GdPictureStatus.OK) Then
            status = gdpicturePDF.SaveToFile("test_DrawBarcodePDF417.pdf")
            If status = GdPictureStatus.OK Then
                MessageBox.Show("The example has been followed successfully and the file has been saved.", caption)
            Else
                MessageBox.Show("The example has been followed successfully, but the file can't be saved. Status: " + status.ToString(), caption)
            End If
        Else
            MessageBox.Show("The one of the DrawBarcodePDF417() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption)
        End If
    Else
        MessageBox.Show("The NewPage() method has failed with the status: " + status.ToString(), caption)
    End If
Else
    MessageBox.Show("The NewPDF() method has failed with the status: " + status.ToString(), caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: DrawBarcodePDF417";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
GdPictureStatus status = gdpicturePDF.NewPDF();
if (status == GdPictureStatus.OK)
{
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    gdpicturePDF.SetMeasurementUnit(PdfMeasurementUnit.PdfMeasurementUnitCentimeter);
    status = gdpicturePDF.NewPage(PdfPageSizes.PdfPageSizeLetter);
    if (status == GdPictureStatus.OK)
    {
            if ((gdpicturePDF.DrawBarcodePDF417("0123456789", BarcodePDF417EncodingMode.BarcodePDF417EncodingModeText, BarcodePDF417ErrorCorrectionLevel.BarcodePDF417ErrorCorrectionLevel2,
                                                 16, 5, 2, 2, 4, 2, 2, Color.Chocolate, Color.Yellow) == GdPictureStatus.OK) &&
                (gdpicturePDF.DrawBarcodePDF417("9876543210", BarcodePDF417EncodingMode.BarcodePDF417EncodingModeText, BarcodePDF417ErrorCorrectionLevel.BarcodePDF417ErrorCorrectionLevel2,
                                                 32, 5, 2, 4, 6, 2, 10, Color.Chocolate, Color.Yellow) == GdPictureStatus.OK))
        {
            status = gdpicturePDF.SaveToFile("test_DrawBarcodePDF417.pdf");
            if (status == GdPictureStatus.OK)
                MessageBox.Show("The example has been followed successfully and the file has been saved.", caption);
            
            else
                MessageBox.Show("The example has been followed successfully, but the file can't be saved. Status: " + status.ToString(), caption);
        }
        else
            MessageBox.Show("The one of the DrawBarcodePDF417() method has failed with the status: " + gdpicturePDF.GetStat().ToString(), caption);
    }
    else
        MessageBox.Show("The NewPage() method has failed with the status: " + status.ToString(), caption);
}
else
    MessageBox.Show("The NewPDF() method has failed with the status: " + status.ToString(), caption);
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
SetMeasurementUnit Method
SetOrigin Method
GetMeasurementUnit Method
GetOrigin Method
DrawBarcode1D(Barcode1DWriterType,String,Single,Single,Single,Single,Byte,Byte,Byte) Method
DrawBarcodeAztec(String,BarcodeAztecCodeVersion,Int32,Int32,Int32,Single,Single,Byte,Byte,Byte) Method
DrawBarcodeDataMatrix(String,BarcodeDataMatrixEncodingMode,BarcodeDataMatrixVersion,Int32,Single,Single,Byte,Byte,Byte) Method
DrawBarcodeQrCode(String,BarcodeQREncodingMode,BarcodeQRErrorCorrectionLevel,Int32,Int32,Single,Single,Color) Method
DrawBarcodeMicroMicroQrCode(String,BarcodeQREncodingMode,BarcodeMicroQRErrorCorrectionLevel,Int32,Int32,Single,Single,Color) Method