Click or drag to resize

ByteSizeFormatter Class

Formats a numeric value to a human readable size.

For example: The reformatted value of the number 2048 is 2KB

Inheritance Hierarchy

Namespace:  Cauldron.Formatters
Assembly:  Cauldron (in Cauldron.dll) Version: 3.2.0.2
Syntax
public sealed class ByteSizeFormatter : FormatterBase

The ByteSizeFormatter type exposes the following members.

Constructors
  NameDescription
Public methodByteSizeFormatter
Initializes a new instance of ByteSizeFormatter
Public methodByteSizeFormatter(CultureInfo)
Initializes a new instance of ByteSizeFormatter
Top
Methods
  NameDescription
Public methodFormat
Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information.
(Inherited from FormatterBase.)
Public methodGetFormat
Returns an object that provides formatting services for the specified type.
(Inherited from FormatterBase.)
Protected methodOnFormat
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).)
Top
Extension Methods
  NameDescription
Public Extension MethodCode exampleAs(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.)
Public Extension MethodCode exampleAs(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.)
Public Extension MethodCode exampleAsTOverloaded.
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.)
Public Extension MethodCode exampleCreateTypeT
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.)
Public Extension MethodGetPropertyNonPublicValueT
Searches for the specified property, using the specified binding constraints and returns its value.

Default BindingFlags are Instance and NonPublic

(Defined by ExtensionsReflection.)
Public Extension MethodGetPropertyValue(String, BindingFlags)Overloaded.
Searches for the specified property, using the specified binding constraints and returns its value.
(Defined by ExtensionsReflection.)
Public Extension MethodGetPropertyValueT(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.)
Public Extension MethodGetPropertyValueT(String, BindingFlags)Overloaded.
Searches for the specified property, using the specified binding constraints and returns its value.
(Defined by ExtensionsReflection.)
Public Extension MethodMapToT
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.)
Public Extension MethodToLong
Tries to convert a Object to an Int64. Returns MinValue if target cannot be parsed.
(Defined by ExtensionsConvertions.)
Public Extension MethodToStringEx(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.)
Public Extension MethodToStringEx(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.)
Public Extension MethodTryDispose
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.)
Top
Examples
var result = string.Format(new ByteSizeFormatter(), "The size is {0:byte}", value);
var result = string.Format(new ByteSizeFormatter(), "The size is {0:byte 0.###}", value);
See Also