 | MetricUnitFormatter Class |
Formats a numeric value to a human readable metric number.
For example: The reformatted value of the number 2400 is 2.4k
Inheritance HierarchyNamespace: Cauldron.Formatters
Assembly: Cauldron (in Cauldron.dll) Version: 3.2.0.2
Syntaxpublic sealed class MetricUnitFormatter : FormatterBase
The MetricUnitFormatter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MetricUnitFormatter |
Initializes a new instance of MetricUnitFormatter |
| MetricUnitFormatter(CultureInfo) |
Initializes a new instance of MetricUnitFormatter |
Methods| Name | Description | |
|---|---|---|
| Format |
Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.
(Inherited from FormatterBase.) |
| GetFormat |
Returns an object that provides formatting services for the specified type.
(Inherited from FormatterBase.) |
 | OnFormat |
Converts the value of a specified object to an equivalent string representation using
specified format and culture-specific formatting information.
(Overrides FormatterBaseOnFormat(String, Object, IFormatProvider).) |
Extension Methods| Name | Description | |
|---|---|---|
  | As(Type) | Overloaded.
Converts a type using the implicit or explicit operators. If both fails it will try to
convert the value with ChangeType(Object, Type).
(Defined by ExtensionsConvertions.) |
| As(Type, Type) | Overloaded.
Converts a type using the implicit or explicit operators. If both fails it will try to
convert the value with ChangeType(Object, Type).
(Defined by ExtensionsConvertions.) |
| AsT | Overloaded.
Performs a cast between compatible reference types. If a convertion is not possible then
null is returned. As a last resort it will use ChangeType(Object, Type).
Tries to use the implicit and explicit operators if exists when convertion with 'as'
returns null.
(Defined by ExtensionsConvertions.) |
| CreateTypeT |
Creates a new Type that implements the properties of an interface defined by T
and copies all value of anon to the new object.
(Defined by ExtensionsInterception.) |
| GetPropertyNonPublicValueT |
Searches for the specified property, using the specified binding constraints and returns
its value.
Default BindingFlags are Instance and NonPublic (Defined by ExtensionsReflection.) |
| GetPropertyValue(String, BindingFlags) | Overloaded.
Searches for the specified property, using the specified binding constraints and returns
its value.
(Defined by ExtensionsReflection.) |
| GetPropertyValueT(String) | Overloaded.
Searches for the specified property, using the specified binding constraints and returns
its value.
Default BindingFlags are Instance and Public (Defined by ExtensionsReflection.) |
| GetPropertyValueT(String, BindingFlags) | Overloaded.
Searches for the specified property, using the specified binding constraints and returns
its value.
(Defined by ExtensionsReflection.) |
| MapToT |
Maps all properties and fields of an instance to another instance. The Clone() method is used to copy an instance if exist.
Mapping fails on jagged and multidimensional array. Classes without parameterless constructor will stay null.
(Defined by ExtensionsCloning.) |
| ToLong | (Defined by ExtensionsConvertions.) |
| ToStringEx(String) | Overloaded.
Converts the value of this instance to its equivalent string representation, using the
specified format.
The following custom formatter are already added: ByteSizeFormatter, MetricUnitFormatter (Defined by Extensions.) |
| ToStringEx(String, CultureInfo) | Overloaded.
Converts the value of this instance to its equivalent string representation, using the
specified format.
The following custom formatter are already added: ByteSizeFormatter, MetricUnitFormatter (Defined by Extensions.) |
| TryDispose |
Tries to performs application-defined tasks associated with freeing, releasing, or
resetting unmanaged resources.
This will dispose an object if it implements the IDisposable interface.
(Defined by Extensions.) |
Examplesvar result = string.Format(new MetricUnitFormatter(), "The size is {0:metric}", value); var result = string.Format(new MetricUnitFormatter(), "The size is {0:metric #0.00}", value);
See Also