Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext Class Referencefinal

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark code. More...

Inherits Aspose::BarCode::ComplexBarcode::IComplexCodetext.

Public Member Functions

System::String get_UPUCountryID () const
 Identifies the UPU Country ID.Max length: 4 characters. More...
 
void set_UPUCountryID (System::String value)
 Identifies the UPU Country ID.Max length: 4 characters. More...
 
System::String get_InformationTypeID () const
 Identifies the Royal Mail Mailmark barcode payload for each product type. More...
 
void set_InformationTypeID (System::String value)
 Identifies the Royal Mail Mailmark barcode payload for each product type. More...
 
System::String get_VersionID () const
 Identifies the barcode version as relevant to each Information Type ID. More...
 
void set_VersionID (System::String value)
 Identifies the barcode version as relevant to each Information Type ID. More...
 
System::String get_Class () const
 Identifies the class of the item. More...
 
void set_Class (System::String value)
 Identifies the class of the item. More...
 
int32_t get_SupplyChainID () const
 Identifies the unique group of customers involved in the mailing. Max value: 9999999. More...
 
void set_SupplyChainID (int32_t value)
 Identifies the unique group of customers involved in the mailing. Max value: 9999999. More...
 
int32_t get_ItemID () const
 Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999. More...
 
void set_ItemID (int32_t value)
 Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999. More...
 
System::String get_DestinationPostCodeAndDPS () const
 Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format. More...
 
void set_DestinationPostCodeAndDPS (System::String value)
 Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format. More...
 
System::String get_RTSFlag () const
 Flag which indicates what level of Return to Sender service is being requested. More...
 
void set_RTSFlag (System::String value)
 Flag which indicates what level of Return to Sender service is being requested. More...
 
System::String get_ReturnToSenderPostCode () const
 Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format. More...
 
void set_ReturnToSenderPostCode (System::String value)
 Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format. More...
 
System::String get_CustomerContent () const
 Optional space for use by customer. More...
 
void set_CustomerContent (System::String value)
 Optional space for use by customer. More...
 
Aspose::BarCode::Generation::DataMatrixEncodeMode get_CustomerContentEncodeMode () const
 Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40. More...
 
void set_CustomerContentEncodeMode (Aspose::BarCode::Generation::DataMatrixEncodeMode value)
 Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40. More...
 
Mailmark2DType get_DataMatrixType () const
 2D Mailmark Type defines size of Data Matrix barcode. More...
 
void set_DataMatrixType (Mailmark2DType value)
 2D Mailmark Type defines size of Data Matrix barcode. More...
 
 Mailmark2DCodetext ()
 Constructor. Create default instance of Mailmark2DCodetext class. More...
 
System::String GetConstructedCodetext () override
 Construct codetext from Mailmark data. More...
 
void InitFromString (System::String constructedCodetext) override
 Initializes Mailmark data from constructed codetext. More...
 
System::SharedPtr< Aspose::BarCode::Generation::BaseEncodeTypeGetBarcodeType () override
 Gets barcode type. 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)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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...
 

Detailed Description

Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark code.

Constructor & Destructor Documentation

◆ Mailmark2DCodetext()

Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::Mailmark2DCodetext ( )

Constructor. Create default instance of Mailmark2DCodetext class.

Member Function Documentation

◆ get_Class()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_Class ( ) const

Identifies the class of the item.

Valid Values:

“1” - 1C (Retail)

“2” - 2C (Retail)

“3” - Economy (Retail)

“5” - Deffered (Retail)

“8” - Premium (Network Access)

“9” - Standard (Network Access)

◆ get_CustomerContent()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_CustomerContent ( ) const

Optional space for use by customer.

Max length by Type:

Type 7: 6 characters

Type 9: 45 characters

Type 29: 25 characters

◆ get_CustomerContentEncodeMode()

Aspose::BarCode::Generation::DataMatrixEncodeMode Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_CustomerContentEncodeMode ( ) const

Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40.

◆ get_DataMatrixType()

Mailmark2DType Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_DataMatrixType ( ) const

2D Mailmark Type defines size of Data Matrix barcode.

◆ get_DestinationPostCodeAndDPS()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_DestinationPostCodeAndDPS ( ) const

Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format.

◆ get_InformationTypeID()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_InformationTypeID ( ) const

Identifies the Royal Mail Mailmark barcode payload for each product type.

Valid Values:

“0” - Domestic Sorted & Unsorted

“A” - Online Postage

“B” - Franking

“C” - Consolidation

◆ get_ItemID()

int32_t Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_ItemID ( ) const

Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.

◆ get_ReturnToSenderPostCode()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_ReturnToSenderPostCode ( ) const

Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.

◆ get_RTSFlag()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_RTSFlag ( ) const

Flag which indicates what level of Return to Sender service is being requested.

◆ get_SupplyChainID()

int32_t Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_SupplyChainID ( ) const

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

◆ get_UPUCountryID()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_UPUCountryID ( ) const

Identifies the UPU Country ID.Max length: 4 characters.

◆ get_VersionID()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::get_VersionID ( ) const

Identifies the barcode version as relevant to each Information Type ID.

Valid Values:

Currently “1”.

“0” & “2” to “9” and “A” to “Z” spare reserved for potential future use.

◆ GetBarcodeType()

System::SharedPtr<Aspose::BarCode::Generation::BaseEncodeType> Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::GetBarcodeType ( )
overridevirtual

Gets barcode type.

Returns
Barcode type.

Implements Aspose::BarCode::ComplexBarcode::IComplexCodetext.

◆ GetConstructedCodetext()

System::String Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::GetConstructedCodetext ( )
overridevirtual

Construct codetext from Mailmark data.

Returns
Constructed codetext

Implements Aspose::BarCode::ComplexBarcode::IComplexCodetext.

◆ InitFromString()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::InitFromString ( System::String  constructedCodetext)
overridevirtual

Initializes Mailmark data from constructed codetext.

Parameters
constructedCodetextConstructed codetext.

Implements Aspose::BarCode::ComplexBarcode::IComplexCodetext.

◆ set_Class()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_Class ( System::String  value)

Identifies the class of the item.

Valid Values:

“1” - 1C (Retail)

“2” - 2C (Retail)

“3” - Economy (Retail)

“5” - Deffered (Retail)

“8” - Premium (Network Access)

“9” - Standard (Network Access)

◆ set_CustomerContent()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_CustomerContent ( System::String  value)

Optional space for use by customer.

Max length by Type:

Type 7: 6 characters

Type 9: 45 characters

Type 29: 25 characters

◆ set_CustomerContentEncodeMode()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_CustomerContentEncodeMode ( Aspose::BarCode::Generation::DataMatrixEncodeMode  value)

Encode mode of Datamatrix barcode. Default value: DataMatrixEncodeMode.C40.

◆ set_DataMatrixType()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_DataMatrixType ( Mailmark2DType  value)

2D Mailmark Type defines size of Data Matrix barcode.

◆ set_DestinationPostCodeAndDPS()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_DestinationPostCodeAndDPS ( System::String  value)

Contains the Postcode of the Delivery Address with DPS If inland the Postcode/DP contains the following number of characters. Area (1 or 2 characters) District(1 or 2 characters) Sector(1 character) Unit(2 characters) DPS (2 characters). The Postcode and DPS must comply with a valid PAF® format.

◆ set_InformationTypeID()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_InformationTypeID ( System::String  value)

Identifies the Royal Mail Mailmark barcode payload for each product type.

Valid Values:

“0” - Domestic Sorted & Unsorted

“A” - Online Postage

“B” - Franking

“C” - Consolidation

◆ set_ItemID()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_ItemID ( int32_t  value)

Identifies the unique item within the Supply Chain ID. Every Mailmark barcode is required to carry an ID so it can be uniquely identified for at least 90 days. Max value: 99999999.

◆ set_ReturnToSenderPostCode()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_ReturnToSenderPostCode ( System::String  value)

Contains the Return to Sender Post Code but no DPS. The PC(without DPS) must comply with a PAF® format.

◆ set_RTSFlag()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_RTSFlag ( System::String  value)

Flag which indicates what level of Return to Sender service is being requested.

◆ set_SupplyChainID()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_SupplyChainID ( int32_t  value)

Identifies the unique group of customers involved in the mailing. Max value: 9999999.

◆ set_UPUCountryID()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_UPUCountryID ( System::String  value)

Identifies the UPU Country ID.Max length: 4 characters.

◆ set_VersionID()

void Aspose::BarCode::ComplexBarcode::Mailmark2DCodetext::set_VersionID ( System::String  value)

Identifies the barcode version as relevant to each Information Type ID.

Valid Values:

Currently “1”.

“0” & “2” to “9” and “A” to “Z” spare reserved for potential future use.