Class BillTextFormatter

Formats text on a QR bill.

The resulting text often contains multiple lines, e.g. for addresses.These line breaks a represented by a line feed character(U+000A). Long lines might require additional line breaks to fit into the given text boxes.These additional line breaks are not included in the resulting text.

Inheritance
System.Object
BillTextFormatter
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Codecrete.SwissQRBill.Generator
Assembly: Codecrete.SwissQRBill.Core.dll
Syntax
public class BillTextFormatter

Constructors

| Improve this Doc View Source

BillTextFormatter(Bill)

Creates a new instance for the specified bill.

Declaration
public BillTextFormatter(Bill bill)
Parameters
Type Name Description
Bill bill

QR bill data
Exceptions
Type Condition
QRBillValidationException

thrown if the bill cannot be validated without errors

Properties

| Improve this Doc View Source

Account

Gets the formatted account number.

Declaration
public string Account { get; }
Property Value
Type Description
System.String

account number
| Improve this Doc View Source

AdditionalInformation

Returns the additional information.

It consists of the unstructured message, the bill information, both or none, depending on what has been specified. If neither has been specified, null is returned.

Declaration
public string AdditionalInformation { get; }
Property Value
Type Description
System.String

additional information
| Improve this Doc View Source

Amount

Gets the formatted amount.

Returns null if no amount has been set.

Declaration
public string Amount { get; }
Property Value
Type Description
System.String

formatted amount
| Improve this Doc View Source

CreditorAddress

Gets the formatted creditor address.

Declaration
public string CreditorAddress { get; }
Property Value
Type Description
System.String

creditor address
| Improve this Doc View Source

CreditorAddressReduced

Gets the reduced formatted creditor address.

If space is very tight, a reduced address without street and house number can be used.

Declaration
public string CreditorAddressReduced { get; }
Property Value
Type Description
System.String

formatted address
| Improve this Doc View Source

PayableBy

Gets the "payable by" text (debtor address).

Returns null if no debtor has been set.

Declaration
public string PayableBy { get; }
Property Value
Type Description
System.String

formatted address
| Improve this Doc View Source

PayableByReduced

Gets the "payable by" text with a reduced address.

If space is very tight, a reduced address without street and house number can be used.

Returns null if no debtor has been set.

Declaration
public string PayableByReduced { get; }
Property Value
Type Description
System.String

formatted address
| Improve this Doc View Source

PayableTo

Gets the "payable to" text (account number and creditor address).

Declaration
public string PayableTo { get; }
Property Value
Type Description
System.String

"payable to" text
| Improve this Doc View Source

PayableToReduced

Gets the "payable to" text (account number and creditor address) with a reduced address.

If space is very tight, an address without street and house number can be used.

"payable to" text
Declaration
public string PayableToReduced { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Reference

Gets the formatted reference number.

Declaration
public string Reference { get; }
Property Value
Type Description
System.String

reference number