IBarcode InterfaceByteScout Barcode SDK
Base interface for all barcode classes.

Namespace:  Bytescout.BarCode
Assembly:  Bytescout.BarCode (in Bytescout.BarCode.dll) Version: 7.3.1.1185-master
Syntax

public interface IBarcode

The IBarcode type exposes the following members.

Properties

  NameDescription
Public propertyAddChecksum
Gets or sets a value indicating whether checksum should be added to barcode.
Public propertyAddChecksumToCaption
Gets or sets a value indicating whether checksum should be added to barcode caption.
Public propertyAdditionalCaption
Gets or sets the additional barcode caption text to draw.
Public propertyAdditionalCaptionAlignment
Gets or sets text alignment of the additional barcode caption.
Public propertyAdditionalCaptionFont
Gets or sets the font of the additional barcode caption.
Public propertyAdditionalCaptionPosition
Gets or sets the position of the additional caption.
Public propertyAngle
Gets or sets the barcode rotation angle in degrees.
Public propertyBackColor
Gets or sets the color used to draw the barcode background.
Public propertyBarHeight
Gets or sets the height of the barcode bars in pixels.
Public propertyCaption
Gets or sets the barcode caption (by default this is encoded value).
Public propertyCaptionAlignment
Gets or sets the alignment of barcode caption text.
Public propertyCaptionFont
Gets or sets the font of the barcode caption.
Public propertyCaptionPosition
Gets or sets the position of the barcode caption.
Public propertyCutUnusedSpace
Gets or sets a value indicating whether unused space should be cut when drawing or saving barcode images. Unused space is usually a result of calling one of FitInto methods with size greater then needed to draw barcode.
Public propertyDrawCaption
Gets or sets a value indicating whether to draw the barcode encoded value.
Public propertyDrawCaptionFor2DBarcodes
Gets or sets a value indicating whether to draw the barcode encoded value for 2D barcodes.
Public propertyDrawQuietZones
Gets or sets a value indicating whether to draw quite zones when barcode type supposes such zones.
Public propertyForeColor
Gets or sets the color used to draw the barcode bars and caption(s).
Public propertyLicenseInfo
Gets license information.
Public propertyMargins
Gets or sets the barcode margins in pixels.
Public propertyNarrowBarWidth
Gets or sets the width of the narrow bar in pixels.
Public propertyOptions
Gets or sets the barcode symbology specific options.
Public propertyPreserveMinReadableSize
Gets or sets a value indicating whether to check output size so it's not less than barcode size. Use FitInto() method to fit barcode into a given physical size.
Public propertyProduceMonochromeImages
Gets or sets a value indicating whether the component should produce monochrome (1-bit, black and white) images.
Public propertyProfiles
Comma-separated list of profiles to apply to the Barcode. Profiles are sets of properties and methods represented as JSON string. Check the source code examples installed with the SDK.
Public propertyRegistrationKey
Gets or sets the key number part of registration information.
Public propertyRegistrationName
Gets or sets the name part of the registration information.
Public propertyRenderingHint
Gets or sets the text rendering quality.
Public propertyResolutionX
Gets or sets the horizontal resolution of barcode.
Public propertyResolutionY
Gets or sets the vertical resolution of barcode.
Public propertyRoundDots
Sets whether to generate barcodes with round dots. Works only for QR Code, DataMatrix, and Aztec barcode types.
Public propertySmoothingMode
Gets or sets the barcode rendering quality.
Public propertySupplementValue
Gets or sets the supplementary barcode value to encode (used with EAN-13, ISBN and UPC-A barcodes).
Public propertySymbology
Gets or sets the barcode symbology type.
Public propertyValue
Gets or sets the barcode value to encode.
Public propertyVersion
Gets the component version number.
Public propertyWideToNarrowRatio
Gets or sets the width of the wide bar relative to the narrow bar.
Top
Methods

  NameDescription
Public methodAddDecorationImage(Image, Int32)
Add decorative image to draw in the center of the barcode. (!) Supported with QR Code only.
Public methodAddDecorationImage(String, Int32)
Add decorative image to draw in the center of the barcode. (!) Supported with QR Code only.
Public methodCreateProfile(String)
Creates JSON profile will all Barcode properties with current values.
Public methodCreateProfile(String, String)
Creates JSON profile will all Barcode properties with current values.
Public methodDraw(Graphics, Point)
Draws the barcode on Graphics canvas object.
Public methodDraw(Graphics, Single, Single, UnitOfMeasure)
Draws the barcode.
Public methodDrawHDC(IntPtr, Int32, Int32)
Draws the barcode on HDC canvas object.
Public methodDrawHDC(IntPtr, Single, Single, UnitOfMeasure)
Draws the barcode on HDC graphics context.
Public methodDrawImagesToPDF(Stream, Stream, DrawImagesToPDFCallback)
Utility method allowing to draw any image on specified page of PDF document.
Public methodDrawImagesToPDF(String, String, DrawImagesToPDFCallback)
Utility method allowing to draw any image on specified page of PDF document.
Public methodDrawImagesToPDF(Stream, Int32, Image, Point, Stream)
Utility method allowing to draw any image on specified page of PDF document.
Public methodDrawImagesToPDF(String, Int32, Image, Point, String)
Utility method allowing to draw any image on specified page of PDF document.
Public methodDrawImagesToPDF(Stream, Int32, Image, Point, Stream, String)
Utility method allowing to draw any image on specified page of PDF document.
Public methodDrawImagesToPDF(String, Int32, Image, Point, String, String)
Utility method allowing to draw any image on specified page of PDF document.
Public methodDrawToImage(Stream, Int32, Int32, Int32, Stream)
Draws barcode to image at specified coordinates.
Public methodDrawToImage(String, Int32, Int32, Int32, String)
Draws barcode to image at specified coordinates.
Public methodDrawToNewPDF(String)
Creates new PDF document and draws barcode on it.
Public methodDrawToNewPDF(String, Int32, Int32, Int32, Int32)
Creates new PDF document and draws barcode on it.
Public methodDrawToPDF(Stream, Int32, Int32, Int32, Stream)
Draws barcode on specified page of PDF document.
Public methodDrawToPDF(String, Int32, Int32, Int32, String)
Draws barcode on specified page of PDF document.
Public methodFitInto(Size)
IMPORTANT: Call this method AFTER setting the barcode value. Fits the barcode into the area of size specified in pixels. Calling this method will change output size of the barcode. Barcode size will be increased in order to occupy all of the area.
Public methodFitInto(SizeF, UnitOfMeasure)
IMPORTANT: Call this method AFTER setting the barcode value. Fits the barcode into the area of size specified in units. Calling this method will change output size of the barcode. Barcode size will be increased in order to occupy all of the area.
Public methodFitInto(Int32, Int32)
IMPORTANT: Call this method AFTER setting the barcode value. Fits the barcode into the area of size specified in pixels. Calling this method will change output size of the barcode. Barcode size will be increased in order to occupy all of the area.
Public methodFitInto(Single, Single, UnitOfMeasure)
IMPORTANT: Call this method AFTER setting the barcode value. Fits the barcode into the area of size specified in units. Calling this method will change output size of the barcode. Barcode size will be increased in order to occupy all of the area.
Public methodGetBarHeight
Returns the height of the barcode bars in specified units.
Public methodGetImage
Gets the Image object with the barcode.
Public methodGetImageBytes
Returns the barcode image as byte array.
Public methodGetImageBytesEMF
Returns the barcode image in EMF format as byte array.
Public methodGetImageBytesGIF
Returns the barcode image in GIF format as byte array.
Public methodGetImageBytesJPG
Returns the barcode image in JPEG format as byte array.
Public methodGetImageBytesPNG
Returns the barcode image in PNG format as byte array.
Public methodGetImageBytesTIFF
Returns the barcode image in TIFF format as byte array.
Public methodGetImageBytesWMF
Returns the barcode image in WMF format as byte array.
Public methodGetMarginBottom
Retrieves the bottom barcode margin value in specified units.
Public methodGetMarginLeft
Returns the left barcode margin value in specified units.
Public methodGetMarginRight
Returns the right barcode margin value in specified units.
Public methodGetMargins
Returns the barcode margins in specified units.
Public methodGetMarginTop
Returns the top barcode margin value in specified units.
Public methodGetMinimalHeight
Returns the height in specified units of the smallest rectangle that can accommodate the barcode.
Public methodGetMinimalSize
Gets or sets the size of the smallest rectangle in pixels that can accommodate the barcode.
Public methodGetMinimalSize(UnitOfMeasure)
Returns the size in specified units of the smallest rectangle that can accommodate the barcode.
Public methodGetMinimalWidth
Returns the width in specified units of the smallest rectangle that can accommodate the barcode.
Public methodGetNarrowBarWidth
Retrieves the width of the narrow bar in specified units.
Public methodGetPDFDimensions(Stream)
Returns size of PDF document pages in document units.
Public methodGetPDFDimensions(String)
Returns size of PDF document pages in document units.
Public methodGetPdfPageCount(Stream)
Returns count of pages in PDF document.
Public methodGetPdfPageCount(String)
Returns count of pages in PDF document.
Public methodGetSupplementaryValueRestrictions
Gets the supplementary value restrictions.
Public methodGetValueRestrictions
Gets the value restrictions for the specified symbology.
Public methodLoadAndApplyProfiles
Loads profiles from JSON string and automatically applies them. Note that profiles containing detection keywords will be deferred until the extraction.
Public methodLoadProfiles
Loads profiles from file.
Public methodLoadProfilesFromString
Loads profiles from JSON string.
Public methodProcessMacros
Replaces macro codes with corresponding ASCII control characters.
Public methodRevertToNormalSize
Reverts any changes to barcode size caused by a call to any of FitInto methods.
Public methodSaveImage(Stream)
Saves the barcode image to specified stream.
Public methodSaveImage(String)
Saves the barcode image to file.
Public methodSaveImage(Stream, ImageFormat)
Saves the barcode image to specified stream.
Public methodSaveImage(String, ImageFormat)
Saves the barcode image to file.
Public methodSaveImage(Stream, ImageFormat, Size, Int32, Int32)
Saves the image with barcode into given stream.
Public methodSaveImage(String, ImageFormat, Size, Int32, Int32)
Saves the barcode image to file.
Public methodSetAdditionalCaptionFont(String, Int32)
Sets the font of the additional barcode caption.
Public methodSetAdditionalCaptionFont(String, Int32, Boolean, Boolean, Boolean, Boolean, Byte)
Sets the font of the barcode additional caption.
Public methodSetBackColorRGB
Sets the background color in RGB format.
Public methodSetBarHeight
Sets the height of the barcode bars in specified units.
Public methodSetCaptionFont(String, Int32)
Sets the font of the barcode caption.
Public methodSetCaptionFont(String, Int32, Boolean, Boolean, Boolean, Boolean, Byte)
Sets the font of the barcode caption font.
Public methodSetCustomCaptionGap
Sets the gap size between the barcode and caption. To reset the gap to default (1/10 of caption font height) set gap to float.NaN.
Public methodSetForeColorRGB
Sets the fore color in RGB format.
Public methodSetMargins
Sets the barcode margins in specified units.
Public methodSetNarrowBarWidth
Sets the width of the narrow bars in specified units.
Public methodSetSmoothingMode
Sets the barcode rendering quality.
Public methodValueIsValid(String)
Validates the value using current symbology rules.
Public methodValueIsValid(String, Boolean)
Validates the value using current symbology rules.
Public methodValueIsValidGS1
Validates the GS1 value using GS1 rules.
Top
See Also

Reference