LocalizedStringProvider Class

Provides custom localized strings.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086
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 with the ParseOptionsStringProvider property.

  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 CommandLineArgumentErrorCategoryApplyValueError.
ArgumentValueConversionError Gets the error message for CommandLineArgumentErrorCategoryArgumentValueConversion.
AutomaticHelpDescription Gets the description of the help argument created if the ParseOptionsAutoHelpArgument property is .
AutomaticHelpName Gets the name of the help argument created if the ParseOptionsAutoHelpArgument or ParseOptionsAttributeAutoHelpArgument property is .
AutomaticHelpShortName Gets the short name of the help argument created if the ParseOptionsAutoHelpArgument property is , typically '?'.
AutomaticVersionCommandDescription Gets the description of the version command created if the CommandOptionsAutoVersionCommand property is .
AutomaticVersionCommandName Gets the name of the version command created if the CommandOptionsAutoVersionCommand property is .
AutomaticVersionDescription Gets the description of the version argument created if the ParseOptionsAutoVersionArgument property is .
AutomaticVersionName Gets the name of the version argument created if the ParseOptionsAutoVersionArgument property is .
ClassValidationFailed Gets a generic error message for the base implementation of ClassValidationAttributeGetErrorMessage(CommandLineParser).
CombinedShortNameNonSwitch Gets the error message for CommandLineArgumentErrorCategoryCombinedShortNameNonSwitch.
CreateArgumentsTypeError Gets the error message for CommandLineArgumentErrorCategoryCreateArgumentsTypeError.
DuplicateArgument Gets the error message for CommandLineArgumentErrorCategoryDuplicateArgument.
DuplicateArgumentWarning Gets the warning message used if the ParseOptionsAttributeDuplicateArguments or ParseOptionsDuplicateArguments property is ErrorModeWarning.
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 CommandLineArgumentErrorCategoryInvalidDictionaryValue.
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 CommandLineArgumentErrorCategoryMissingNamedArgumentValue.
MissingRequiredArgument Gets the error message for CommandLineArgumentErrorCategoryMissingRequiredArgument.
NullArgumentValue Gets the error message for CommandLineArgumentErrorCategoryNullArgumentValue.
ProhibitsUsageHelp Gets the usage help for the ProhibitsAttribute attribute.
RequiresAnyUsageHelp Gets the usage help for the RequiresAnyAttribute attribute.
RequiresUsageHelp Gets the usage help for the RequiresAttribute attribute.
TooManyArguments Gets the error message for CommandLineArgumentErrorCategoryTooManyArguments.
ToStringReturns a string that represents the current object.
(Inherited from Object)
UnknownArgument Gets the error message for CommandLineArgumentErrorCategoryUnknownArgument.
UnspecifiedError Gets the error message for CommandLineArgumentErrorCategoryUnspecified.
ValidateCountFailed Gets an error message used if the ValidateCountAttribute attribute fails validation.
ValidateCountUsageHelp Gets the usage help for the ValidateCountAttribute attribute.
ValidateEnumValueFailed Gets an error message used if the ValidateEnumValueAttribute attribute fails validation.
ValidateEnumValueUsageHelp Gets the usage help for the ValidateEnumValueAttribute attribute.
ValidateNotEmptyFailed Gets an error message used if the ValidateNotEmptyAttribute attribute fails validation because the string was empty.
ValidateNotEmptyUsageHelp Gets the usage help for the ValidateNotEmptyAttribute attribute.
ValidateNotWhiteSpaceFailed Gets an error message used if the ValidateNotWhiteSpaceAttribute fails validation because the string was empty or white-space.
ValidateNotWhiteSpaceUsageHelp Gets the usage help for the ValidateNotWhiteSpaceAttribute attribute.
ValidateProhibitsFailed Gets an error message used if the ProhibitsAttribute attribute fails validation.
ValidateRangeFailed Gets an error message used if the ValidateRangeAttribute attribute fails validation.
ValidateRangeUsageHelp Gets the usage help for the ValidateRangeAttribute attribute.
ValidateRequiresAnyFailed Gets an error message used if the RequiresAnyAttribute attribute fails validation.
ValidateRequiresFailed Gets an error message used if the RequiresAttribute attribute fails validation.
ValidateStringLengthFailed Gets an error message used if the ValidateStringLengthAttribute attribute fails validation.
ValidateStringLengthUsageHelp Gets the usage help for the ValidateStringLengthAttribute attribute.
ValidationFailed Gets a generic error message for the base implementation of ArgumentValidationAttributeGetErrorMessage(CommandLineArgument, Object).
ValidatorDescriptions Gets a formatted list of validator help messages.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also