Aspose::BarCode::Generation::BarcodeGenerator Class Referencefinal

BarcodeGenerator for backend barcode images generation. More...

Inherits System::IDisposable.

Public Member Functions

System::SharedPtr< BaseGenerationParametersget_Parameters ()
 Generation parameters. More...
 
System::SharedPtr< BaseEncodeTypeget_BarcodeType ()
 Barcode symbology type. More...
 
void set_BarcodeType (System::SharedPtr< BaseEncodeType > value)
 Barcode symbology type. More...
 
System::String get_CodeText ()
 Text to be encoded. More...
 
void set_CodeText (System::String value)
 Text to be encoded. More...
 
 BarcodeGenerator (System::SharedPtr< BaseEncodeType > type)
 Creates an instance of BarcodeGenerator. More...
 
 BarcodeGenerator (System::SharedPtr< BaseEncodeType > type, System::String codeText)
 Creates an instance of BarcodeGenerator. More...
 
System::SharedPtr< System::Drawing::BitmapGenerateBarCodeImage ()
 Generate the barcode image under current settings. More...
 
void Save (System::SharedPtr< System::IO::Stream > stream, BarCodeImageFormat format)
 Save barcode image to stream in specific format. More...
 
void Save (System::String filename, BarCodeImageFormat format)
 Save barcode image to specific file in specific format. More...
 
void Save (System::String filename)
 Save barcode image to specific file. More...
 
bool ExportToXml (System::String xmlFile)
 Exports BarCode properties to the xml-file specified More...
 
bool ExportToXml (System::SharedPtr< System::IO::Stream > xml)
 Exports BarCode properties to the xml-stream specified More...
 
void Dispose () override
 Clean up any resources being used. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Static Public Member Functions

static System::SharedPtr< BarcodeGeneratorImportFromXml (System::String xmlFile)
 Imports BarCode properties from the xml-file specified and creates BarcodeGenerator instance. More...
 
static System::SharedPtr< BarcodeGeneratorImportFromXml (System::SharedPtr< System::IO::Stream > xml)
 Imports BarCode properties from the xml-stream specified and creates BarcodeGenerator instance. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

BarcodeGenerator for backend barcode images generation.

supported symbologies: 1D: Codabar, Code11, Code128, Code39Standard, Code39Extended Code93Standard, Code93Extended, EAN13, EAN8, Interleaved2of5, MSI, Standard2of5, UPCA, UPCE, ISBN, GS1Code128, Postnet, Planet EAN14, SCC14, SSCC18, ITF14, SingaporePost ... 2D: Aztec, DataMatrix, PDf417, QR code ...

This sample shows how to create and save a barcode image.

[C#]
using(var generator = new BarcodeGenerator(EncodeTypes.Code128))
{
generator.CodeText = "123ABC";
generator.Save("code128.png");
}

Constructor & Destructor Documentation

◆ BarcodeGenerator() [1/2]

Aspose::BarCode::Generation::BarcodeGenerator::BarcodeGenerator ( System::SharedPtr< BaseEncodeType type)

Creates an instance of BarcodeGenerator.

Parameters
typeBarcode symbology type. Use EncodeTypes class to setup a symbology.

◆ BarcodeGenerator() [2/2]

Aspose::BarCode::Generation::BarcodeGenerator::BarcodeGenerator ( System::SharedPtr< BaseEncodeType type,
System::String  codeText 
)

Creates an instance of BarcodeGenerator.

Parameters
typeBarcode symbology type. Use EncodeTypes class to setup a symbology.
codeTextText to be encoded.

Member Function Documentation

◆ Dispose()

void Aspose::BarCode::Generation::BarcodeGenerator::Dispose ( )
overridevirtual

Clean up any resources being used.

Reimplemented from System::IDisposable.

◆ ExportToXml() [1/2]

bool Aspose::BarCode::Generation::BarcodeGenerator::ExportToXml ( System::String  xmlFile)

Exports BarCode properties to the xml-file specified

Parameters
xmlFileThe name for the file
Returns

Whether or not export completed successfully.

Returns True in case of success; False Otherwise

◆ ExportToXml() [2/2]

bool Aspose::BarCode::Generation::BarcodeGenerator::ExportToXml ( System::SharedPtr< System::IO::Stream xml)

Exports BarCode properties to the xml-stream specified

Parameters
xmlThe xml-stream
Returns

Whether or not export completed successfully.

Returns True in case of success; False Otherwise

◆ GenerateBarCodeImage()

System::SharedPtr<System::Drawing::Bitmap> Aspose::BarCode::Generation::BarcodeGenerator::GenerateBarCodeImage ( )

Generate the barcode image under current settings.

Returns
Barcode image. See Bitmap.

This sample shows how to create and save a barcode image.

[C#]
using(var generator = new BarcodeGenerator(EncodeTypes.Code128))
{
Bitmap barcode = generator.GenerateBarCodeImage();
barcode.Save("test.png");
}

◆ get_BarcodeType()

System::SharedPtr<BaseEncodeType> Aspose::BarCode::Generation::BarcodeGenerator::get_BarcodeType ( )

Barcode symbology type.

◆ get_CodeText()

System::String Aspose::BarCode::Generation::BarcodeGenerator::get_CodeText ( )

Text to be encoded.

◆ get_Parameters()

System::SharedPtr<BaseGenerationParameters> Aspose::BarCode::Generation::BarcodeGenerator::get_Parameters ( )

Generation parameters.

◆ ImportFromXml() [1/2]

static System::SharedPtr<BarcodeGenerator> Aspose::BarCode::Generation::BarcodeGenerator::ImportFromXml ( System::String  xmlFile)
static

Imports BarCode properties from the xml-file specified and creates BarcodeGenerator instance.

Parameters
xmlFileThe name for the file
Returns
BarcodeGenerator instance

◆ ImportFromXml() [2/2]

static System::SharedPtr<BarcodeGenerator> Aspose::BarCode::Generation::BarcodeGenerator::ImportFromXml ( System::SharedPtr< System::IO::Stream xml)
static

Imports BarCode properties from the xml-stream specified and creates BarcodeGenerator instance.

Parameters
xmlThe xml-stream
Returns
BarcodeGenerator instance

◆ Save() [1/3]

void Aspose::BarCode::Generation::BarcodeGenerator::Save ( System::SharedPtr< System::IO::Stream stream,
BarCodeImageFormat  format 
)

Save barcode image to stream in specific format.

Parameters
streamOutput System.IO.Stream.
formatSpecifies the file format of the output image.

◆ Save() [2/3]

void Aspose::BarCode::Generation::BarcodeGenerator::Save ( System::String  filename,
BarCodeImageFormat  format 
)

Save barcode image to specific file in specific format.

Parameters
filenamePath to save to.
formatSpecifies the file format of the output image.

◆ Save() [3/3]

void Aspose::BarCode::Generation::BarcodeGenerator::Save ( System::String  filename)

Save barcode image to specific file.

Parameters
filenamePath to save to.

◆ set_BarcodeType()

void Aspose::BarCode::Generation::BarcodeGenerator::set_BarcodeType ( System::SharedPtr< BaseEncodeType value)

Barcode symbology type.

◆ set_CodeText()

void Aspose::BarCode::Generation::BarcodeGenerator::set_CodeText ( System::String  value)

Text to be encoded.