ReadText.LocalizedDemo.LocalizableSentenceBuilder Class Reference

Inheritance diagram for ReadText.LocalizedDemo.LocalizableSentenceBuilder:

Properties
override Func< string >	RequiredWord [get]
override Func< string >	ErrorsHeadingText [get]
override Func< string >	UsageHeadingText [get]
override Func< bool, string >	HelpCommandText [get]
override Func< bool, string >	VersionCommandText [get]
override Func< Error, string >	FormatError [get]
override Func< IEnumerable< MutuallyExclusiveSetError >, string >	FormatMutuallyExclusiveSetErrors [get]
Properties inherited from CommandLine.Text.SentenceBuilder
static Func< SentenceBuilder >	Factory = () => new DefaultSentenceBuilder() [get, set]
	Factory to allow custom SentenceBuilder injection.
Func< string >	RequiredWord [get]
	Gets a delegate that returns the word 'required'.
Func< string >	OptionGroupWord [get]
	Gets a delegate that returns the word 'group'.
Func< string >	ErrorsHeadingText [get]
	Gets a delegate that returns that errors block heading text.
Func< string >	UsageHeadingText [get]
	Gets a delegate that returns usage text block heading text.
Func< bool, string >	HelpCommandText [get]
	Get a delegate that returns the help text of help command. The delegates must accept a boolean that is equal truefor options; otherwise falsefor verbs.
Func< bool, string >	VersionCommandText [get]
	Get a delegate that returns the help text of vesion command. The delegates must accept a boolean that is equal truefor options; otherwise falsefor verbs.
Func< Error, string >	FormatError [get]
	Gets a delegate that handles singular error formatting. The delegates must accept an Error and returns a string.
Func< IEnumerable< MutuallyExclusiveSetError >, string >	FormatMutuallyExclusiveSetErrors [get]
	Gets a delegate that handles mutually exclusive set errors formatting. The delegates must accept a sequence of MutuallyExclusiveSetError and returns a string.

Additional Inherited Members
Static Public Member Functions inherited from CommandLine.Text.SentenceBuilder
static SentenceBuilder	Create ()
	Create instance of CommandLine.Text.SentenceBuilder,.

Detailed Description

Definition at line 10 of file LocalizableSentenceBuilder.cs.

Property Documentation

ErrorsHeadingText

override Func<string> ReadText.LocalizedDemo.LocalizableSentenceBuilder.ErrorsHeadingText

get

Definition at line 17 of file LocalizableSentenceBuilder.cs.

        {
            // Cannot be pluralized
            get { return () => Properties.Resources.SentenceErrorsHeadingText; }
        }

FormatError

override Func<Error, string> ReadText.LocalizedDemo.LocalizableSentenceBuilder.FormatError

get

Definition at line 43 of file LocalizableSentenceBuilder.cs.

        {
            get
            {
                return error =>
                {
                    switch (error.Tag)
                    {
                        case ErrorType.BadFormatTokenError:
                            return String.Format(Properties.Resources.SentenceBadFormatTokenError, ((BadFormatTokenError)error).Token);
                        case ErrorType.MissingValueOptionError:
                            return String.Format(Properties.Resources.SentenceMissingValueOptionError, ((MissingValueOptionError)error).NameInfo.NameText);
                        case ErrorType.UnknownOptionError:
                            return String.Format(Properties.Resources.SentenceUnknownOptionError, ((UnknownOptionError)error).Token);
                        case ErrorType.MissingRequiredOptionError:
                            var errMisssing = ((MissingRequiredOptionError)error);
                            return errMisssing.NameInfo.Equals(NameInfo.EmptyName)
                                       ? Properties.Resources.SentenceMissingRequiredOptionError
                                       : String.Format(Properties.Resources.SentenceMissingRequiredOptionError, errMisssing.NameInfo.NameText);
                        case ErrorType.BadFormatConversionError:
                            var badFormat = ((BadFormatConversionError)error);
                            return badFormat.NameInfo.Equals(NameInfo.EmptyName)
                                       ? Properties.Resources.SentenceBadFormatConversionErrorValue
                                       : String.Format(Properties.Resources.SentenceBadFormatConversionErrorOption, badFormat.NameInfo.NameText);
                        case ErrorType.SequenceOutOfRangeError:
                            var seqOutRange = ((SequenceOutOfRangeError)error);
                            return seqOutRange.NameInfo.Equals(NameInfo.EmptyName)
                                       ? Properties.Resources.SentenceSequenceOutOfRangeErrorValue
                                       : String.Format(Properties.Resources.SentenceSequenceOutOfRangeErrorOption, 
                                            seqOutRange.NameInfo.NameText);
                        case ErrorType.BadVerbSelectedError:
                            return String.Format(Properties.Resources.SentenceBadVerbSelectedError, ((BadVerbSelectedError)error).Token);
                        case ErrorType.NoVerbSelectedError:
                            return Properties.Resources.SentenceNoVerbSelectedError;
                        case ErrorType.RepeatedOptionError:
                            return String.Format(Properties.Resources.SentenceRepeatedOptionError, ((RepeatedOptionError)error).NameInfo.NameText);
                        case ErrorType.SetValueExceptionError:
                            var setValueError = (SetValueExceptionError)error;
                            return String.Format(Properties.Resources.SentenceSetValueExceptionError, setValueError.NameInfo.NameText, setValueError.Exception.Message);
                    }
                    throw new InvalidOperationException();
                };
            }
        }

FormatMutuallyExclusiveSetErrors

override Func<IEnumerable<MutuallyExclusiveSetError>, string> ReadText.LocalizedDemo.LocalizableSentenceBuilder.FormatMutuallyExclusiveSetErrors

get

Definition at line 88 of file LocalizableSentenceBuilder.cs.

        {
            get
            {
                return errors =>
                {
                    var bySet = from e in errors
                                group e by e.SetName into g
                                select new { SetName = g.Key, Errors = g.ToList() };
 
                    var msgs = bySet.Select(
                        set =>
                        {
                            var names = String.Join(
                                String.Empty,
                                (from e in set.Errors select String.Format("'{0}', ", e.NameInfo.NameText)).ToArray());
                            var namesCount = set.Errors.Count();
 
                            var incompat = String.Join(
                                String.Empty,
                                (from x in
                                     (from s in bySet where !s.SetName.Equals(set.SetName) from e in s.Errors select e)
                                    .Distinct()
                                 select String.Format("'{0}', ", x.NameInfo.NameText)).ToArray());
                            //TODO: Pluralize by namesCount
                            return
                                String.Format(Properties.Resources.SentenceMutuallyExclusiveSetErrors,
                                    names.Substring(0, names.Length - 2), incompat.Substring(0, incompat.Length - 2));
                        }).ToArray();
                    return string.Join(Environment.NewLine, msgs);
                };
            }
        }

HelpCommandText

override Func<bool, string> ReadText.LocalizedDemo.LocalizableSentenceBuilder.HelpCommandText

get

Definition at line 28 of file LocalizableSentenceBuilder.cs.

        {
            get
            {
                return isOption => isOption
                    ? Properties.Resources.SentenceHelpCommandTextOption
                    : Properties.Resources.SentenceHelpCommandTextVerb;
            }
        }

RequiredWord

override Func<string> ReadText.LocalizedDemo.LocalizableSentenceBuilder.RequiredWord

get

Definition at line 12 of file LocalizableSentenceBuilder.cs.

        {
            get { return () => Properties.Resources.SentenceRequiredWord; }
        }

UsageHeadingText

override Func<string> ReadText.LocalizedDemo.LocalizableSentenceBuilder.UsageHeadingText

get

Definition at line 23 of file LocalizableSentenceBuilder.cs.

        {
            get { return () => Properties.Resources.SentenceUsageHeadingText; }
        }

VersionCommandText

override Func<bool, string> ReadText.LocalizedDemo.LocalizableSentenceBuilder.VersionCommandText

get

Definition at line 38 of file LocalizableSentenceBuilder.cs.

        {
            get { return _ => Properties.Resources.SentenceVersionCommandText; }
        }

---

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

• deps/commandlineparser/demo/ReadText.LocalizedDemo/LocalizableSentenceBuilder.cs