Method: PrintSize - Syntax 1

Returns actual size of a rotated barcode symbol in millimeters. The barcode symbol is specified in the properties of this barcode component.

Syntax:

function PrintSize(var TotalWidth, TotalHeight, SymbolWidth, SymbolHeight: Double; Module: Double; BarcodeWidth: Double = 0; BarcodeHeight: Double = 0; Angle: Integer = -1; HDPI: Integer = 0; VDPI: Integer = 0): Integer; overload; virtual;

Description:

The method returns the actual size of the rotated barcode symbol that is specified by properties of this barcode component, in millimeters.

Note, if the DisplayText property isn't set to dtNone, pelase use the method between Printer.BeginDoc and Printer.EndDoc methods, and the printer must be connected to your computer.

Parameters:

• TotalWidth: Double; Returns the horizontal width of the rotated barcode symbol in millimeters.

  Before rotation, if the human readable text is represented, both the width of human readable text and the height of the human readable text (including its vertical spacing) will be consulted. Otherwise, they will not be consulted. Note, if the human readable text is represented and it exceeds the barcode symbol in horizontal or vertical direction, the excess is included.

  For TBarcode1D_UPCA, TBarcode1D_UPCE, TBarcode1D_UPCE0, TBarcode1D_UPCE1, TBarcode1D_EAN2, TBarcode1D_EAN5, TBarcode1D_EAN8, and TBarcode1D_EAN13 barcode components, if the human readable text is represented, and the TextAlignment property is set to taCustom, the width of quiet zone marks and their horizontal spacing (LeftQuietZoneSpacing and RightQuietZoneSpacing) are included too.

  For TBarcode1D_ITF6, TBarcode1D_ITF14, and TBarcode1D_ITF16 barcode components, the width of left and right bearer bars (BearerWidth), the height of top and bottom bearer bars (BearerWidth), the left spacing, and the right spacing are included too.

• TotalHeight: Double; Returns the vertical height of the rotated barcode symbol in millimeters.

  Before rotation, if the human readable text is represented, both the width of human readable text and the height of the human readable text (including its vertical spacing) will be consulted. Otherwise, they will not be consulted. Note, if the human readable text is represented and it exceeds the barcode symbol in horizontal or vertical direction, the excess is included.

  For TBarcode1D_UPCA, TBarcode1D_UPCE, TBarcode1D_UPCE0, TBarcode1D_UPCE1, TBarcode1D_EAN2, TBarcode1D_EAN5, TBarcode1D_EAN8, and TBarcode1D_EAN13 barcode components, if the human readable text is represented, and the TextAlignment property is set to taCustom, the width of quiet zone marks and their horizontal spacing (LeftQuietZoneSpacing and RightQuietZoneSpacing) are included too.

  For TBarcode1D_ITF6, TBarcode1D_ITF14, and TBarcode1D_ITF16 barcode components, the width of left and right bearer bars (BearerWidth), the height of top and bottom bearer bars (BearerWidth), the left spacing, and the right spacing are included too.

• SymbolWidth: Double; Returns the distance between the leading and trailing of the rotated barcode symbol in millimeters.

  Before rotation, if the human readable text is represented, the width of human readable text will be consulted. Otherwise, it will not be consulted. Note, if the human readable text is represented, and it exceeds the barcode symbol in horizontal direction, the excess is included.

  For TBarcode1D_UPCA, TBarcode1D_UPCE, TBarcode1D_UPCE0, TBarcode1D_UPCE1, TBarcode1D_EAN2, TBarcode1D_EAN5, TBarcode1D_EAN8, and TBarcode1D_EAN13 barcode components, if the human readable text is represented, and the TextAlignment property is set to taCustom, the width of quiet zone marks and their horizontal spacing (LeftQuietZoneSpacing and RightQuietZoneSpacing) are included too.

  For TBarcode1D_ITF6, TBarcode1D_ITF14, and TBarcode1D_ITF16 barcode components, the width of left and right bearer bars (BearerWidth), the left spacing, and the right spacing are included too.

• SymbolHeight: Double; Returns the distance between the top and bottom of the rotated barcode symbol in millimeters.

  Before rotation, if the human readable text is represented, the height of the human readable text and its vertical spacing (TextVSpacing) are included. If it exceeds the barcode symbol in vertical direction, the excess is included too.

  For TBarcode1D_ITF6, TBarcode1D_ITF14, and TBarcode1D_ITF16 barcode components, the height of top and bottom bearer bars (BearerWidth) are included too.

  See also the "Height" property.

• Module: Double; Specifies the module width in millimeters, it is the width of the smallest bar (or space) in the barcode symbol.

  If the BarcodeWidth parameter is greater than zero, the value in the Module will be ignored, the module value will be calculated based on the BarcodeWidth parameter. If both Module and BarcodeWidth parameters are less than or equal to zero, the BarcodeHeight parameter must be set to greater than zero, the module value will be calculated based on the BarcodeHeight parameter and the Height property.

  See also the "Module" property.

• BarcodeWidth: Double, Specifies the barcode symbol width before rotation, in millimeters. If the human readable text is displayed and it exceeds the barcode symbol in horizontal direction, the excess isn't included in the width value.

  For TBarcode1D_UPCA, TBarcode1D_UPCE, TBarcode1D_UPCE0, TBarcode1D_UPCE1, TBarcode1D_EAN2, TBarcode1D_EAN5, TBarcode1D_EAN8, and TBarcode1D_EAN13 barcode components, if the human readable text is displayed, and the TextAlignment property is set to taCustom, the width of quiet zone marks and their horizontal spacing (LeftQuietZoneSpacing and RightQuietZoneSpacing) are included.

  For TBarcode1D_ITF6, TBarcode1D_ITF14, and TBarcode1D_ITF16 barcode components, width of left and right bearer bars (BearerWidth), left spacing, and right spacing are included too.

  If the parameter is provided and isn't zero; the value in Module parameter will be ignored, the module width will be calculated based on the BarcodeWidth value. If the parameter isn't provided or it's set to zero, the Module parameter will be used.

  See also the "BarcodeWidth" property.

• BarcodeHeight: Integer; Specifies the distance between the top and bottom of the barcode symbol before rotation, in millimeters or modules. If the human readable text is displayed, the height of the human readable text and its vertical spacing (TextVSpacing) are included. If it exceeds the barcode symbol in vertical direction, the excess isn't included.

  For TBarcode1D_ITF6, TBarcode1D_ITF14, and TBarcode1D_ITF16 barcode components, the height of top and bottom bearer bars are included too.

  If the parameter isn't provided or it's set to zero, it will be calculated based on the values of Module parameter and the Height property.

  If the parameter is provided and it is not set to zero, the value of Height property will be ignored. If it's greater than zero, it specifies the height in millimeters. If it's less than zero, the absolute value of the parameter specifies the height in modules.

• Angle: Integer; Specifies an angle in degrees to rotate the barcode symbol. It defaults to -1 if the Angle is not provided, and the barcode symbol will be rotated base on the value of the Orientation property:

  • boLeftRight: 0 degrees
  • boRightLeft: 180 degrees
  • boTopBottom: 270 degrees
  • boBottomTop: 90 degrees

  If you want to use the -1 degrees, the 359 degrees can be used instead.

• HDPI: Integer, Specifies the physical horizontal resolution of printer in DPI (dots per inch).

  It defaults to 0 if the HDPI is not provided. If it is set to less than or equal to zero, the horizontal resolution will be obtained from your printer.

• VDPI: Integer, Specifies the physical vertical resolution of printer in DPI (dots per inch).

  It defaults to 0 if the VDPI is not provided. If it is set to less than or equal to zero, the vertical resolution will be obtained from your printer.

Return:

• If the method succeeds, the return value is zero.
• If the length of the barcode text that is specified by Barcode or Data (only for Delphi/C++ Builder 2009 or later) property is invalid, the return value is -1. Corresponding to the OnInvalidLength or OnInvalidDataLength (only for Delphi/C++ Builder 2009 or later) event will occur.
• If all of the Module, BarcodeWidth, and BarcodeHeight parameters are less than or equal to zero, the return value is -2.
• If there is any invalid character in the the barcode text that is specified by Barcode or Data (only for Delphi/C++ Builder 2009 or later) property, the return value is the position index of first invalid character, the index 1 denotes that the first character is invalid character. Corresponding to the OnInvalidChar or OnInvalidDataChar (only for Delphi/C++ Builder 2009 or later) event will occur. For the TBarcode1D_OneCode component, if the invalid character in the Tracking property, the index is from 1 to 20 including 1 and 20; if it is in the Routing property, the value starts with 21 (First character of the Routing property).

See diagram:

Note:

For Delphi 3, the method overload and default value of parameter aren't supported, so the method name is changed to PrintSize1, and the parameters Module, BarcodeWidth, BarcodeHeight, Angle, HDPI, and VDPI are required.

Contents