Class EbicsIniLetter

Namespace: Subsembly.EBICS

Assembly: Subsembly.EBICS.Core.dll

Helper class for creating an EBICS Ini-Letter.

public class EbicsIniLetter

Inheritance: object

EbicsIniLetter

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EbicsIniLetter(EbicsContact)

public EbicsIniLetter(EbicsContact aContact)

Parameters

aContact EbicsContact: The EbicsContact for which an Ini-Letter shall be created. This contact must contain values for UserSignaturePubKey, UserAuthenticationPubKey, and UserEncryptionPubKey.

Exceptions

ArgumentNullException: The parameter aContact was null.
InvalidOperationException: At least one of the public keys is missing in the EbicsContact.

Properties

AddressLines

Optional address text that is included at the top of the first page.

public string AddressLines { get; set; }

Property Value

string

Remarks

This should be the address of the bank that shall receive this Ini-Letter. The address lines must be separated by CRLF or just LF characters. If this is not set, then the Ini-Letter will be created without an address field.

DateTimeHIA

The date that will be shown at the top of the HIA section in the generated Ini-Letter.

public DateTime DateTimeHIA { get; set; }

Property Value

DateTime

Remarks

Setting the date will automatically convert it to the CET/CEST timezone, based on its DateTimeKind. The default value of this property is DateTime.MinValue.

If the property value is DateTime.MinValue, then the TimeStamp of the public authentication key will be used as the key submission date at the top of the generated Ini-Letter. If that time stamp is DateTime.MinValue, then the current CET/CEST time will be used instead.

DateTimeINI

The date that will be shown at the top of the INI section in the generated Ini-Letter.

public DateTime DateTimeINI { get; set; }

Property Value

DateTime

Remarks

Setting the date will automatically convert it to the CET/CEST timezone, based on its DateTimeKind. The default value of this property is DateTime.MinValue.

If the property value is DateTime.MinValue, then the TimeStamp of the public signature key will be used as the key submission date at the top of the generated Ini-Letter. If that time stamp is DateTime.MinValue, then the current CET/CEST time will be used instead.

FooterText

Optional footer text that is added at the bottom of each page.

public string FooterText { get; set; }

Property Value

string

Remarks

The footer text may consist of up to three tab separated sub-strings. The first sub-string will be left aligned, the second sub-string is centered, and the third sub-string is right aligned.

Within the footer text the special escape sequences, may be used to insert the date or time of printing:

&d	short date (digits only)
&D	long date (textual)
&t	short time
&T	long time (with seconds)

LanguageInfo

A CultureInfo that provides the language that shall be used when generating the Ini-Letter.

public CultureInfo LanguageInfo { get; set; }

Property Value

CultureInfo

Remarks

Currently the Subsembly EBICS API contains text resources for the following languages and cultures: "de-DE", "de-CH", "fr", "en". If no language is specified, then the default "de-DE" culture will be used.

Methods

CreatePDF()

Creates an in-memory PDF data blob for this Ini-Letter.

public byte[] CreatePDF()

Returns

byte[]

See Also: WritePDF(string)

WritePDF(string)

Writes a PDF file for this Ini-Letter.

public bool WritePDF(string sFilePath)

Parameters

sFilePath string: Complete path to file that shall be written with the Ini-Letter PDF.

Returns

bool: If the file was successfully created or overwritten, then true is returned. If the Ini-Letter content could not be created, then false is returned.

Exceptions

ArgumentNullException: The parameter sFilePath was null.
ArgumentException: The parameter sFilePath was an empty string.

See Also: CreatePDF()