Class EbicsIniLetter

Helper class for creating an EBICS Ini-Letter.

Inheritance

System.Object

EbicsIniLetter

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: Subsembly.EBICS

Assembly: Subsembly.EBICS.Core.dll

Syntax

public class EbicsIniLetter

Constructors

EbicsIniLetter(EbicsContact)

Declaration

public EbicsIniLetter(EbicsContact aContact)

Parameters

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

Exceptions

Type	Condition
System.ArgumentNullException	The parameter aContact was null.
System.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.

Declaration

public string AddressLines { get; set; }

Property Value

Type	Description
System.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.

FooterText

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

Declaration

public string FooterText { get; set; }

Property Value

Type	Description
System.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.

Declaration

public CultureInfo LanguageInfo { get; set; }

Property Value

Type	Description
System.Globalization.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.

Declaration

public byte[] CreatePDF()

Returns

Type	Description
System.Byte[]

See Also

WritePDF(String)

WritePDF(String)

Writes a PDF file for this Ini-Letter.

Declaration

public bool WritePDF(string sFilePath)

Parameters

Type	Name	Description
System.String	sFilePath	Complete path to file that shall be written with the Ini-Letter PDF.

Returns

Type	Description
System.Boolean	If the file was successfully created or overwritten, then true is returned. If the file could not be written, then false is returned.

Exceptions

Type	Condition
System.ArgumentNullException	The parameter sFilePath was null.
System.ArgumentException	The parameter sFilePath was an empty string.

See Also

CreatePDF()