Namespace WizardWrx.FormatStringEngine

Classes

FormatItem

This is an infrastructure class; instances represent a FormatItem found in the FormatString associated with the FormatStringParser that owns it.

The static methods of this class are public, and are very handy for creating compact summary reports.

Use them to construct composite format items that have their characteristics, especially their widths, established at runtime. Setting the width dynamically permits summary totals and their labels, all of which may have widely varying widths that are unknown in advance to be set in such a way that a set of numeric values and their labels can be printed with labels on the left, and a minimum amount of white space between the longest label and the numbers.

FormatItemsCollection

This generic List derivative holds the collection of FormatItems found in a FormatString.

While the class, itself, is marked Public, everything else about it is marked as Internal, so that only instances of classes defined in this assembly can create a collection or add items to it, while instances of the FormatStringParser class expose it as a read only property.

FormatStringError

The FormatStringParser exposes a List of these objects if errors exist in its current format string.

FormatStringParser

Use this class to parse format control strings that you intend to use with string.Format or one of the Write or WriteLine methods of a stream object, such as a Console or TextWriter. Properties and methods report on its attributes, including its FormaItems, and errors flagged by the parser.

Enums

FormatItem.Alignment

If specified, the Width property supports two alignments, Left and Right.