Class SwiftTextLines

Helper class for working with a block of text lines, such as the multi-line payment purpose field on a German remittance.

Inheritance

object

SwiftTextLines

Implements

IEnumerable<string>

IEnumerable

IComparable

IComparable<SwiftTextLines>

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Subsembly.Swift

Assembly: Subsembly.Sepa.dll

Syntax

public class SwiftTextLines : IEnumerable<string>, IEnumerable, IComparable, IComparable<SwiftTextLines>

Remarks

This class manages a multi-line text field as an conceptual array of strings. It ensures that leading and trailing whitespace is trimmed from all the lines that it contains. Also, it ensures that it never contains empty lines or even null string references.

Constructors

SwiftTextLines()

Constructs an all empty instance.

Declaration

public SwiftTextLines()

SwiftTextLines(string)

Constructs a new instance containing a single line of text.

Declaration

public SwiftTextLines(string sLine)

Parameters

Type	Name	Description
string	sLine

SwiftTextLines(string, bool)

Declaration

public SwiftTextLines(string sText, bool fNewLine)

Parameters

Type	Name	Description
string	sText
bool	fNewLine

SwiftTextLines(string, int, bool, bool)

Constructs a new instance by splitting up a single text string.

Declaration

public SwiftTextLines(string sText, int nMaxChars, bool fNewLine, bool fWordWrap)

Parameters

Type	Name	Description
string	sText	The text that makes up the new text block. If this is null, then the new text block will be empty.
int	nMaxChars	The max number of characters that may be placed on a single line. If the given line exceeds this limit, then it will be broken up into multiple lines.
bool	fNewLine	If true, then the text will be splt at new line sequences.
bool	fWordWrap	If true, then long lines will be broken up at a blank character, if possible. If false, then lines will be broken up into exactly nMaxChars portions.

Exceptions

Type	Condition
ArgumentOutOfRangeException	The parameter nMaxChars was zero or negative.

SwiftTextLines(string[])

Constructs a new instance from an array of strings.

Declaration

public SwiftTextLines(string[] vsLines)

Parameters

Type	Name	Description
string[]	vsLines	Array of strings that provides the initial content of this text block. If this parameter is null, then the new text block will be empty. Otherwise all non-empty and non-null strings contained in the array are trimmed and become the content of the new text block.

Properties

Count

The actual count of lines.

Declaration

public int Count { get; }

Property Value

Type	Description
int

this[int]

Direct access to the individual lines in this text block.

Declaration

public string this[int nIndex] { get; set; }

Parameters

Type	Name	Description
int	nIndex	The index of the line to retrieve. If this is greater than the number of lines available, then null is returned.

Property Value

Type	Description
string

Exceptions

Type	Condition
ArgumentOutOfRangeException	The given index was less than zero.

MaxChars

Provides the number of characters in the longest line contained in this text lines instance.

Declaration

public int MaxChars { get; }

Property Value

Type	Description
int

Methods

AddEmptyLine()

Declaration

public void AddEmptyLine()

AddLine(string)

Add a single line at the end of this text block.

Declaration

public void AddLine(string sLine)

Parameters

Type	Name	Description
string	sLine	The line to be added. If this is null or an empty string, then nothing will be added.

AddLine(string, bool)

Add a single line at the end of this text block.

Declaration

public void AddLine(string sLine, bool fAddEmptyLines)

Parameters

Type	Name	Description
string	sLine	The line to be added.
bool	fAddEmptyLines	If this is true, then an empty string or null will add an empty line. If this is false, then an empty string or null will be ignored.

AddLine(string, int, WrapOption)

Adds a single text line at the end of this text block.

Declaration

public void AddLine(string sLine, int nMaxChars, SwiftTextLines.WrapOption nWrapOption)

Parameters

Type	Name	Description
string	sLine	The line to be added. If this is null or an empty string, then nothing will be added.
int	nMaxChars	The max number of characters that may be placed on a single line. If the given line exceeds this limit, then it will be broken up into multiple lines.
SwiftTextLines.WrapOption	nWrapOption	Selects how to break a line that is longer than nMaxChars characters.

Exceptions

Type	Condition
ArgumentOutOfRangeException	The parameter nMaxChars was zero or negative.

AddLine(string, int, bool)

Adds a single text line at the end of this text block.

Declaration

public void AddLine(string sLine, int nMaxChars, bool fWordWrap)

Parameters

Type	Name	Description
string	sLine	The line to be added. If this is null or an empty string, then nothing will be added.
int	nMaxChars	The max number of characters that may be placed on a single line. If the given line exceeds this limit, then it will be broken up into multiple lines.
bool	fWordWrap	If true, then any leading or trailing whitespace will be trimmed and long lines will be broken up at a blank character, if possible. If false, then lines will be broken up into exactly nMaxChars portions.

Exceptions

Type	Condition
ArgumentOutOfRangeException	The parameter nMaxChars was zero or negative.

AddLines(string[])

Declaration

public void AddLines(string[] vsLines)

Parameters

Type	Name	Description
string[]	vsLines	Array of strings that provides the text lines to be added. If this parameter is null, then nothing will be added. Otherwise all non-empty and non-null strings contained in the array are trimmed and added to this text block.

AddText(string)

Declaration

public void AddText(string sText)

Parameters

Type	Name	Description
string	sText

AddText(string, int, bool, bool)

Add the given text wrapping it over mutliple lines if necessary.

Declaration

public void AddText(string sText, int nMaxChars, bool fNewLine, bool fWordWrap)

Parameters

Type	Name	Description
string	sText	The text to be added.
int	nMaxChars	The max number of characters that may be placed on a single line. If a line exceeds this limit, then it will be broken up into multiple lines.
bool	fNewLine	If true, then the text will be split at new line sequences.
bool	fWordWrap	If true, then long lines will be broken up at a blank character, if possible. If false, then lines will be broken up into exactly nMaxChars portions.

Exceptions

Type	Condition
ArgumentOutOfRangeException	The parameter nMaxChars was zero or negative.

BreakLines(int, int)

Breaks all lines that are longer than the requested max line length into multiple adjacent lines.

Declaration

public void BreakLines(int nMaxChars, int nMaxLines = 0)

Parameters

Type	Name	Description
int	nMaxChars	The maximum allowed line length. Lines longer than this length will be broken into multiple adjacent lines.
int	nMaxLines	The max number of resulting lines after breaking them. Any excess lines are discarded in order to match this limit. If this is zero, then no max line limit will be applied.

Remarks

The lines will be broken hard at the nMaxChars position. No trimming of leading or trailing whitespace will be done. Thus all whitespace is preserved exactly.

Clear()

Clear this text block.

Declaration

public void Clear()

Clone()

Declaration

public SwiftTextLines Clone()

Returns

Type	Description
SwiftTextLines

CompareTo(SwiftTextLines)

Declaration

public int CompareTo(SwiftTextLines that)

Parameters

Type	Name	Description
SwiftTextLines	that

Returns

Type	Description
int

CompareTo(object)

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
int

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetEnumerator()

Declaration

public IEnumerator GetEnumerator()

Returns

Type	Description
IEnumerator

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

IsEmpty()

Declaration

public bool IsEmpty()

Returns

Type	Description
bool

Join(string)

Declaration

public string Join(string sNewLine = "")

Parameters

Type	Name	Description
string	sNewLine

Returns

Type	Description
string

Pack()

Packs all lines onto a single text line, replacing any new line sequences with a single blank character.

Declaration

public string Pack()

Returns

Type	Description
string

Pack(int)

Packs all lines onto a single text line without any new line sequence.

Declaration

public string Pack(int nMaxChars)

Parameters

Type	Name	Description
int	nMaxChars	Maximum number of characters of a packed line.

Returns

Type	Description
string

Remarks

All lines are joined using the blank character between each line. If a line fills the entire MaxChars, then no blank is appended and it is directly concatenated with the subsequent line.

PackLines(int, int)

Nicely wraps lines to match the requested max line length.

Declaration

public bool PackLines(int nMaxChars, int nMaxLines)

Parameters

Type	Name	Description
int	nMaxChars
int	nMaxLines

Returns

Type	Description
bool

RemoveAt(int)

Declaration

public void RemoveAt(int nIndex)

Parameters

Type	Name	Description
int	nIndex

Exceptions

Type	Condition
ArgumentOutOfRangeException	A line with the given index does not exist in this instance.

SetLineCount(int)

Declaration

public void SetLineCount(int nLineCount)

Parameters

Type	Name	Description
int	nLineCount

SetLines(string[])

Set the content of this text block from an array of strings.

Declaration

public void SetLines(string[] vsLines)

Parameters

Type	Name	Description
string[]	vsLines	Array of strings that provides the new content of this text block. If this parameter is null, then this text block is effectively cleared. Otherwise all non-empty and non-null strings contained in the array are trimmed and become the new text block.

SetText(string)

Set text with new lines but without word wrapping.

Declaration

public void SetText(string sText)

Parameters

Type	Name	Description
string	sText

SetText(string, int, bool, bool)

Set this text block to the given text, wrapping it over mutliple lines if necessary.

Declaration

public void SetText(string sText, int nMaxChars, bool fNewLine, bool fWordWrap)

Parameters

Type	Name	Description
string	sText	The text to be set.
int	nMaxChars	The max number of characters that may be placed on a single line. If a line exceeds this limit, then it will be broken up into multiple lines.
bool	fNewLine	If true, then the text will be splt at new line sequences.
bool	fWordWrap	If true, then long lines will be broken up at a blank character, if possible. If false, then lines will be broken up into exactly nMaxChars portions.

Exceptions

Type	Condition
ArgumentException	The parameter sNewLine was an empty string. Use null if you do not want to split at newline sequences.
ArgumentOutOfRangeException	The parameter nMaxChars was zero or negative.

ToArray()

Declaration

public string[] ToArray()

Returns

Type	Description
string[]

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

TrimLines()

Declaration

public void TrimLines()

TrimTrailingEmptyLines()

Declaration

public void TrimTrailingEmptyLines()

Operators

operator ==(SwiftTextLines, SwiftTextLines)

Declaration

public static bool operator ==(SwiftTextLines lhs, SwiftTextLines rhs)

Parameters

Type	Name	Description
SwiftTextLines	lhs
SwiftTextLines	rhs

Returns

Type	Description
bool

operator !=(SwiftTextLines, SwiftTextLines)

Declaration

public static bool operator !=(SwiftTextLines lhs, SwiftTextLines rhs)

Parameters

Type	Name	Description
SwiftTextLines	lhs
SwiftTextLines	rhs

Returns

Type	Description
bool

Implements

IEnumerable<T>

IEnumerable

IComparable

IComparable<T>