BarcodeDataMatrixGetSize Method (GdPictureImaging)

In This Topic

Returns the size, in pixels, required to render a DataMatrix barcode on a Bitmap.

Syntax

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

'Declaration
 
Public Function BarcodeDataMatrixGetSize( _
   ByVal Data As String, _
   ByVal EncodingMode As BarcodeDataMatrixEncodingMode, _
   ByRef Version As BarcodeDataMatrixVersion, _
   ByVal QuietZone As Integer, _
   ByVal ModuleSize As Integer, _
   ByRef Width As Integer, _
   ByRef Height As Integer _
) As GdPictureStatus

public GdPictureStatus BarcodeDataMatrixGetSize( 
   string Data,
   BarcodeDataMatrixEncodingMode EncodingMode,
   ref BarcodeDataMatrixVersion Version,
   int QuietZone,
   int ModuleSize,
   out int Width,
   out int Height
)

public function BarcodeDataMatrixGetSize( 
    Data: String;
    EncodingMode: BarcodeDataMatrixEncodingMode;
   var  Version: BarcodeDataMatrixVersion;
    QuietZone: Integer;
    ModuleSize: Integer;
   Out  Width: Integer;
   Out  Height: Integer
): GdPictureStatus;

public function BarcodeDataMatrixGetSize( 
   Data : String,
   EncodingMode : BarcodeDataMatrixEncodingMode,
   Version : BarcodeDataMatrixVersion,
   QuietZone : int,
   ModuleSize : int,
   Width : int,
   Height : int
) : GdPictureStatus;

public: GdPictureStatus BarcodeDataMatrixGetSize( 
   string* Data,
   BarcodeDataMatrixEncodingMode EncodingMode,
   ref BarcodeDataMatrixVersion Version,
   int QuietZone,
   int ModuleSize,
   [PARAMFLAG::Out] int Width,
   [PARAMFLAG::Out] int Height
)

public:
GdPictureStatus BarcodeDataMatrixGetSize( 
   String^ Data,
   BarcodeDataMatrixEncodingMode EncodingMode,
   BarcodeDataMatrixVersion% Version,
   int QuietZone,
   int ModuleSize,
   [Out] int Width,
   [Out] int Height
)

Parameters

Data: The data of the barcode to encode.
EncodingMode: A member of the BarcodeDataMatrixEncodingMode enumeration. The encoding mode.
Version: A member of the BarcodeDataMatrixVersion enumeration. The version of the DataMatrix barcode. Use BarcodeDataMatrixVersionAuto to let the engine decide the minimum version required to encode all data.
QuietZone: The number of modules composing the quiet zone. The quiet zone defines the margin around the barcode. A value superior or equal to 4 is highly suggested.
ModuleSize: The size of each module, in pixels. A value superior or equal to 4 is recommended.
Width: Output parameter. The width, in pixels, required to render the DataMatrix barcode.
Height: Output parameter. The height, in pixels, required to render the DataMatrix barcode.

Return Value

A member of the GdPictureStatus enumeration.

Example

Rendering a DataMatrix barcode into a new image and saving the result into a png file.

using (GdPictureImaging gdpictureImaging = new GdPictureImaging())
{
    // String with numbers, which have to be encoded into a barcode.
    string data = "123456";
 
    BarcodeDataMatrixEncodingMode encodingMode = BarcodeDataMatrixEncodingMode.BarcodeDataMatrixEncodingModeUndefined;
    BarcodeDataMatrixVersion dmVersion = BarcodeDataMatrixVersion.BarcodeDataMatrixVersionAuto;
    int moduleSize = 8;
    int fillColor = gdpictureImaging.ARGBI(255, 0, 0, 0);
    int backColor = gdpictureImaging.ARGBI(0, 255, 255, 255);
 
    // Compute size (in pixels), required to render the DataMatrix barcode.
    gdpictureImaging.BarcodeDataMatrixGetSize(data, encodingMode, ref dmVersion, 4, moduleSize, out int width, out int height);
 
    int imageID = gdpictureImaging.CreateNewGdPictureImage(width, height, 32, Color.White);
    gdpictureImaging.BarcodeDataMatrixWrite(imageID, data, encodingMode, ref dmVersion, 4, moduleSize, 0, 0, 0, fillColor, backColor);
    gdpictureImaging.SaveAsPNG(imageID, "output.png");
 
    // Release used resources.
    gdpictureImaging.ReleaseGdPictureImage(imageID);
}

Reference

GdPictureImaging Class
GdPictureImaging Members
BarcodeDataMatrixWrite(Int32,String,BarcodeDataMatrixEncodingMode,BarcodeDataMatrixVersion,Int32,Int32,Int32,Int32,Single,Color,Color) Method