LocalizedStringProvider Class

Provides custom localized strings.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.1.1
C#
public class LocalizedStringProvider
Inheritance
Object    LocalizedStringProvider

Remarks

Inherit from this class and override its members to provide customized or localized strings. You can specify the implementation to use using StringProvider.

  Note

For error messages, this only lets you customize error messages for the CommandLineArgumentException class. Other exceptions thrown by this library, such as for invalid argument definitions, constitute bugs and should not occur in a correct program, and should therefore not be shown to the user.

Constructors

LocalizedStringProviderInitializes a new instance of the LocalizedStringProvider class

Methods

ApplicationCopyright Gets the copyright information for the application, used by the automatic version argument and command.
ApplicationNameAndVersion Gets the name and version of the application, used by the automatic version argument and command.
ApplyValueError Gets the error message for ApplyValueError.
ArgumentValueConversionError Gets the error message for ArgumentValueConversion.
AutomaticHelpDescription Gets the description of the help argument created if the AutoHelpArgument property is .
AutomaticHelpName Gets the name of the help argument created if the AutoHelpArgument or AutoHelpArgument property is .
AutomaticHelpShortName Gets the short name of the help argument created if the AutoHelpArgument property is , typically '?'.
AutomaticVersionCommandDescription Gets the description of the version command created if the AutoVersionCommand property is .
AutomaticVersionCommandName Gets the name of the version command created if the AutoVersionCommand property is .
AutomaticVersionDescription Gets the description of the version argument created if the AutoVersionArgument property is .
AutomaticVersionName Gets the name of the version argument created if the AutoVersionArgument property is .
ClassValidationFailed Gets a generic error message for the base implementation of GetErrorMessage(CommandLineParser).
CombinedShortNameNonSwitch Gets the error message for CombinedShortNameNonSwitch.
CreateArgumentsTypeError Gets the error message for CreateArgumentsTypeError.
DuplicateArgument Gets the error message for DuplicateArgument.
DuplicateArgumentWarning Gets the warning message used if the DuplicateArguments or DuplicateArguments property is Warning.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
InvalidDictionaryValue Gets the error message for InvalidDictionaryValue.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
MissingKeyValuePairSeparator Gets the error message used if the KeyValuePairConverterTKey, TValue is unable to find the key/value pair separator in the argument value.
MissingNamedArgumentValue Gets the error message for MissingNamedArgumentValue.
MissingRequiredArgument Gets the error message for MissingRequiredArgument.
NullArgumentValue Gets the error message for NullArgumentValue.
ProhibitsUsageHelp Gets the usage help for the ProhibitsAttribute class.
RequiresAnyUsageHelp Gets an error message used if the RequiresAnyAttribute fails validation.
RequiresUsageHelp Gets the usage help for the RequiresAttribute class.
TooManyArguments Gets the error message for TooManyArguments.
ToStringReturns a string that represents the current object.
(Inherited from Object)
UnknownArgument Gets the error message for UnknownArgument.
UnspecifiedError Gets the error message for Unspecified.
ValidateCountFailed Gets an error message used if the ValidateCountAttribute fails validation.
ValidateCountUsageHelp Gets the usage help for the ValidateCountAttribute class.
ValidateEnumValueFailed Gets an error message used if the ValidateEnumValueAttribute fails validation.
ValidateEnumValueUsageHelp Gets the usage help for the ValidateEnumValueAttribute class.
ValidateNotEmptyFailed Gets an error message used if the ValidateNotEmptyAttribute fails validation because the string was empty.
ValidateNotEmptyUsageHelp Gets the usage help for the ValidateNotEmptyAttribute class.
ValidateNotWhiteSpaceFailed Gets an error message used if the ValidateNotWhiteSpaceAttribute fails validation because the string was empty.
ValidateNotWhiteSpaceUsageHelp Gets the usage help for the ValidateNotWhiteSpaceAttribute class.
ValidateProhibitsFailed Gets an error message used if the ProhibitsAttribute fails validation.
ValidateRangeFailed Gets an error message used if the ValidateRangeAttribute fails validation.
ValidateRangeUsageHelp Gets the usage help for the ValidateRangeAttribute class.
ValidateRequiresAnyFailed Gets an error message used if the RequiresAnyAttribute fails validation.
ValidateRequiresFailed Gets an error message used if the RequiresAttribute fails validation.
ValidateStringLengthFailed Gets an error message used if the ValidateStringLengthAttribute fails validation.
ValidateStringLengthUsageHelp Gets the usage help for the ValidateStringLengthAttribute class.
ValidationFailed Gets a generic error message for the base implementation of GetErrorMessage(CommandLineArgument, Object).
ValidatorDescriptions Gets a formatted list of validator help messages.

See Also