https://github.com/andersnm/excelnumberformat

Parse and render Excel number format strings
https://github.com/andersnm/excelnumberformat

Last synced: about 23 hours ago
JSON representation

Parse and render Excel number format strings

• Host: GitHub
• URL: https://github.com/andersnm/excelnumberformat
• Owner: andersnm
• License: mit
• Created: 2017-07-09T12:12:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-07-26T12:05:13.000Z (4 months ago)
• Last Synced: 2024-07-30T14:18:59.236Z (4 months ago)
• Language: C#
• Homepage:
• Size: 108 KB
• Stars: 79
• Watchers: 6
• Forks: 26
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
ExcelNumberFormat

=================

.NET library to parse ECMA-376 number format strings and format values like Excel and other spreadsheet softwares.

[![Build status](https://ci.appveyor.com/api/projects/status/pg23vtba9wjr138f?svg=true)](https://ci.appveyor.com/project/andersnm/excelnumberformat)

## Install via NuGet

If you want to include ExcelNumberFormat in your project, you can [install it directly from NuGet](https://www.nuget.org/packages/ExcelNumberFormat)

To install ExcelNumberFormat, run the following command in the Package Manager Console

```

PM> Install-Package ExcelNumberFormat

```

## Usage

```C#

var format = new NumberFormat("#.##");

Console.WriteLine(format.Format(1234.56, CultureInfo.InvariantCulture));

```

## Features

- Parses and formats most custom number formats as expected: decimal, percent, thousands, exponential, fraction, currency, date/time, duration, text.

- Supports multiple sections with conditions.

- Formats values with relevant constants from CultureInfo.

- Supports DateTime, TimeSpan and numeric values for date and duration formats.

- Supports both 1900- and 1904-based numeric datetimes (Excel on Mac uses 1904-based dates).

- Targets net20 and netstandard1.0 for max compatibility.

## Formatting .NET types

The `Format()` method takes a value of type `object` as parameter. Internally, the value is cast or converted to a specific .NET type depending on the kind of number format:

Format Kind | Example | .NET type|Conversion strategy

-|-|-|-

Number   | 0.00      |double|Convert.ToDouble()

Fraction | 0/0       |double|Convert.ToDouble()

Exponent | \#0.0E+0  |double|Convert.ToDouble()

Date/Time| hh\:mm    |DateTime|ExcelDateTime.TryConvert()

Duration | \[hh\]\:mm|TimeSpan|Cast or TimeSpan.FromDays()

General  | General   |(any)|CompatibleConvert.ToString()

Text     | ;;;"Text: "@|string|Convert.ToString()

In case of errors, `Format()` returns the value from `CompatibleConvert.ToString()`.

`CompatibleConvert.ToString()` formats floats and doubles with explicit precision, or falls back to `Convert.ToString()` for any other types.

`ExcelDateTime.TryConvert()` uses DateTimes as is, or converts numeric values to a DateTime with adjustments for legacy Excel behaviors.

## TODO/notes

- 'General' is formatted with `.ToString()` instead of Excel conventions.

- No errors: Invalid format strings and incompatible input values are formatted with `.ToString()`.

- No color information.

- Variable width space is returned as regular space.

- Repeat-to-fill characters are printed once, not repeated.

- No alignment hinting.

- No date conditions.