CommandLine.Text.MultilineTextAttribute Class Reference

Provides base properties for creating an attribute, used to define multiple lines of text. More...

Inheritance diagram for CommandLine.Text.MultilineTextAttribute:

Protected Member Functions
	MultilineTextAttribute (string line1)
	Initializes a new instance of the MultilineTextAttribute class. Used in derived type using one line of text.
	MultilineTextAttribute (string line1, string line2)
	Initializes a new instance of the MultilineTextAttribute class. Used in type using two lines of text.
	MultilineTextAttribute (string line1, string line2, string line3)
	Initializes a new instance of the MultilineTextAttribute class. Used in type using three lines of text.
	MultilineTextAttribute (string line1, string line2, string line3, string line4)
	Initializes a new instance of the MultilineTextAttribute class. Used in type using four lines of text.
	MultilineTextAttribute (string line1, string line2, string line3, string line4, string line5)
	Initializes a new instance of the MultilineTextAttribute class. Used in type using five lines of text.
virtual int	GetLastLineWithText (string[] value)
	Returns the last line with text. Preserves blank lines if user intended by skipping a line.

Package Functions
HelpText	AddToHelpText (HelpText helpText, Func< string, HelpText > func)
HelpText	AddToHelpText (HelpText helpText, bool before)

Properties
virtual string	Value [get]
	Gets the all non-blank lines as string.
string	Line1 [get]
	Gets the first line of text.
string	Line2 [get]
	Gets the second line of text.
string	Line3 [get]
	Gets third line of text.
string	Line4 [get]
	Gets the fourth line of text.
string	Line5 [get]
	Gets the fifth line of text.

Detailed Description

Provides base properties for creating an attribute, used to define multiple lines of text.

Definition at line 12 of file MultiLineTextAttribute.cs.

Constructor & Destructor Documentation

MultilineTextAttribute() [1/5]

CommandLine.Text.MultilineTextAttribute.MultilineTextAttribute ( string  line1 )

protected

Initializes a new instance of the MultilineTextAttribute class. Used in derived type using one line of text.

Parameters

line1

The first line of text.

Definition at line 19 of file MultiLineTextAttribute.cs.

            : this(line1, string.Empty, string.Empty, string.Empty, string.Empty) { }

MultilineTextAttribute() [2/5]

CommandLine.Text.MultilineTextAttribute.MultilineTextAttribute ( string  line1, string  line2  )

protected

Initializes a new instance of the MultilineTextAttribute class. Used in type using two lines of text.

Parameters

line1	The first line of text.
line2	The second line of text.

Definition at line 28 of file MultiLineTextAttribute.cs.

            : this(line1, line2, string.Empty, string.Empty, string.Empty) { }

MultilineTextAttribute() [3/5]

CommandLine.Text.MultilineTextAttribute.MultilineTextAttribute ( string  line1, string  line2, string  line3  )

protected

Initializes a new instance of the MultilineTextAttribute class. Used in type using three lines of text.

Parameters

line1	The first line of text.
line2	The second line of text.
line3	The third line of text.

Definition at line 38 of file MultiLineTextAttribute.cs.

            : this(line1, line2, line3, string.Empty, string.Empty) { }

MultilineTextAttribute() [4/5]

CommandLine.Text.MultilineTextAttribute.MultilineTextAttribute ( string  line1, string  line2, string  line3, string  line4  )

protected

Initializes a new instance of the MultilineTextAttribute class. Used in type using four lines of text.

Parameters

line1	The first line of text.
line2	The second line of text.
line3	The third line of text.
line4	The fourth line of text.

Definition at line 49 of file MultiLineTextAttribute.cs.

            : this(line1, line2, line3, line4, string.Empty) { }

MultilineTextAttribute() [5/5]

CommandLine.Text.MultilineTextAttribute.MultilineTextAttribute ( string  line1, string  line2, string  line3, string  line4, string  line5  )

protected

Initializes a new instance of the MultilineTextAttribute class. Used in type using five lines of text.

Parameters

line1	The first line of text.
line2	The second line of text.
line3	The third line of text.
line4	The fourth line of text.
line5	The fifth line of text.

Definition at line 61 of file MultiLineTextAttribute.cs.

        {
            if (line1 == null)
            {
                throw new ArgumentException("line1");
            }
 
            if (line2 == null)
            {
                throw new ArgumentException("line2");
            }
 
            if (line3 == null)
            {
                throw new ArgumentException("line3");
            }
 
            if (line4 == null)
            {
                throw new ArgumentException("line4");
            }
 
            if (line5 == null)
            {
                throw new ArgumentException("line5");
            }
 
            Line1 = line1;
            Line2 = line2;
            Line3 = line3;
            Line4 = line4;
            Line5 = line5;
        }

Member Function Documentation

AddToHelpText() [1/2]

HelpText CommandLine.Text.MultilineTextAttribute.AddToHelpText ( HelpText  helpText, bool  before  )

package

Definition at line 148 of file MultiLineTextAttribute.cs.

        {
            // before flag only distinguishes which action is called, 
            // so refactor common code and call with appropriate func
            return before
                       ? AddToHelpText(helpText, helpText.AddPreOptionsLine)
                       : AddToHelpText(helpText, helpText.AddPostOptionsLine);
        }

AddToHelpText() [2/2]

HelpText CommandLine.Text.MultilineTextAttribute.AddToHelpText ( HelpText  helpText, Func< string, HelpText >  func  )

package

Definition at line 140 of file MultiLineTextAttribute.cs.

        {
            string[] strArray = { Line1, Line2, Line3, Line4, Line5 };
 
            return strArray.Take(GetLastLineWithText(strArray))
                           .Aggregate(helpText, (current, line) => func(line));
        }

GetLastLineWithText()

virtual int CommandLine.Text.MultilineTextAttribute.GetLastLineWithText ( string[]  value )

protectedvirtual

Returns the last line with text. Preserves blank lines if user intended by skipping a line.

Returns

The last index of line of the non-blank line.

Parameters

value

The string array to process.

Definition at line 164 of file MultiLineTextAttribute.cs.

        {
            int index = Array.FindLastIndex(value, str => !string.IsNullOrEmpty(str));
 
            // remember FindLastIndex returns zero-based index
            return index + 1;
        }

Property Documentation

Line1

string CommandLine.Text.MultilineTextAttribute.Line1

get

Gets the first line of text.

Definition at line 118 of file MultiLineTextAttribute.cs.

{ get; }

Line2

string CommandLine.Text.MultilineTextAttribute.Line2

get

Gets the second line of text.

Definition at line 123 of file MultiLineTextAttribute.cs.

{ get; }

Line3

string CommandLine.Text.MultilineTextAttribute.Line3

get

Gets third line of text.

Definition at line 128 of file MultiLineTextAttribute.cs.

{ get; }

Line4

string CommandLine.Text.MultilineTextAttribute.Line4

get

Gets the fourth line of text.

Definition at line 133 of file MultiLineTextAttribute.cs.

{ get; }

Line5

string CommandLine.Text.MultilineTextAttribute.Line5

get

Gets the fifth line of text.

Definition at line 138 of file MultiLineTextAttribute.cs.

{ get; }

Value

virtual string CommandLine.Text.MultilineTextAttribute.Value

get

Gets the all non-blank lines as string.

A string of all non-blank lines.

Definition at line 99 of file MultiLineTextAttribute.cs.

        {
            get
            {
                StringBuilder value = new StringBuilder(string.Empty);
                string[] strArray = { Line1, Line2, Line3, Line4, Line5 };
 
                for (int i = 0; i < GetLastLineWithText(strArray); i++)
                {
                    value.AppendLine(strArray[i]);
                }
 
                return value.ToString();
            }
        }

---

The documentation for this class was generated from the following file:

• deps/commandlineparser/src/CommandLine/Text/MultiLineTextAttribute.cs