PercentFormatter Class

Definition

Namespace:

Windows.Globalization.NumberFormatting

Formats and parses percentages.

public ref class PercentFormatter sealed : INumberFormatter, INumberFormatter2, INumberFormatterOptions, INumberParser, INumberRounderOption, ISignedZeroOption, ISignificantDigitsOption

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
/// [Windows.Foundation.Metadata.Activatable(Windows.Globalization.NumberFormatting.IPercentFormatterFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class PercentFormatter final : INumberFormatter, INumberFormatter2, INumberFormatterOptions, INumberParser, INumberRounderOption, ISignedZeroOption, ISignificantDigitsOption

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Globalization.NumberFormatting.IPercentFormatterFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class PercentFormatter : INumberFormatter, INumberFormatter2, INumberFormatterOptions, INumberParser, INumberRounderOption, ISignedZeroOption, ISignificantDigitsOption

function PercentFormatter(languages, geographicRegion)

Public NotInheritable Class PercentFormatter
Implements INumberFormatter, INumberFormatter2, INumberFormatterOptions, INumberParser, INumberRounderOption, ISignedZeroOption, ISignificantDigitsOption

Inheritance

Object Platform::Object IInspectable PercentFormatter

Attributes

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

INumberFormatter INumberFormatter2 INumberFormatterOptions INumberParser INumberRounderOption ISignedZeroOption ISignificantDigitsOption

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

// This scenario uses the Windows.Globalization.NumberFormatting.PercentFormatter and
// the Windows.Globalization.NumberFormatting.PermilleFormatter classes to format numbers
// as a percent or a permille.

//using System.Text;
//using Windows.Globalization.NumberFormatting;

StringBuilder sb = new StringBuilder();

// Create numbers to format.
double randomNumber = new Random().NextDouble();
ulong fixedNumber = 500;

// Create percent formatters.
PercentFormatter defaultPercentFormatter = new PercentFormatter();
PercentFormatter languagePercentFormatter = new PercentFormatter(new[] { "fr-FR" }, "ZZ");

// Create permille formatters.
PermilleFormatter defaultPermilleFormatter = new PermilleFormatter();
PermilleFormatter languagePermilleFormatter = new PermilleFormatter(new[] { "ar" }, "ZZ");

// Format random numbers as percent or permille.
sb.AppendLine("Random number: " + randomNumber);
sb.AppendLine("Percent formatted: " + defaultPercentFormatter.Format(randomNumber));
sb.AppendLine("Permille formatted: " + defaultPermilleFormatter.Format(randomNumber));
sb.AppendLine();
sb.AppendLine("Language-specific percent formatted: " + languagePercentFormatter.Format(randomNumber));
sb.AppendLine("Language-specific permille formatted: " + languagePermilleFormatter.Format(randomNumber));
sb.AppendLine();
sb.AppendLine("Fixed number: " + fixedNumber);

// Format fixed number with grouping.
defaultPercentFormatter.IsGrouped = true;
sb.AppendLine("Percent formatted (grouped): " + defaultPercentFormatter.Format(fixedNumber));

//Format with grouping using French language.
languagePercentFormatter.IsGrouped = true;
sb.AppendLine("Percent formatted (grouped as fr-FR): " + defaultPercentFormatter.Format(fixedNumber));

// Format with no fraction digits.
defaultPercentFormatter.FractionDigits = 0;
sb.AppendLine("Percent formatted (no fractional digits): " + defaultPercentFormatter.Format(fixedNumber));

// Format always with a decimal point.
defaultPercentFormatter.IsDecimalPointAlwaysDisplayed = true;
sb.AppendLine("Percent formatted (always with a decimal point): " + defaultPercentFormatter.Format(fixedNumber));

Remarks

Note

If your app passes language tags used in this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

Constructors

PercentFormatter()	Creates a PercentFormatter object and initializes it to default values.
PercentFormatter(IIterable<String>, String)	Creates a PercentFormatter object initialized by a language list and a geographic region.

Properties

FractionDigits	Gets or sets the minimum number of digits to display for the fraction part of the percentage.
GeographicRegion	Gets the region that is used when formatting and parsing percentages.
IntegerDigits	Gets or sets the minimum number of digits to display for the integer part of the percentage.
IsDecimalPointAlwaysDisplayed	Gets or sets whether the decimal point of the percentage should always be displayed.
IsGrouped	Gets or sets whether the integer part of the percentage should be grouped.
IsZeroSigned	Gets or sets whether -0 is formatted as "-0" or "0".
Languages	Gets the priority list of language identifiers that is used when formatting and parsing percentages.
NumberRounder	Gets or sets the current rounding strategy to be used when formatting percents.
NumeralSystem	Gets or sets the numbering system that is used to format and parse percentages.
ResolvedGeographicRegion	Gets the geographic region that was most recently used to format or parse percent values.
ResolvedLanguage	Gets the language that was most recently used to format or parse percent values.
SignificantDigits	Gets or sets the current padding to significant digits when a percent is formatted.

Methods

Format(Double)	Returns a string representation of a Double percentage.
Format(Int64)	Returns a string representation of an Int64 percentage.
Format(UInt64)	Returns a string representation of a UInt64 percentage.
FormatDouble(Double)	Returns a string representation of a Double percentage.
FormatInt(Int64)	Returns a string representation of an Int64 percentage.
FormatUInt(UInt64)	Returns a string representation of a UInt64 percentage.
ParseDouble(String)	Attempts to parse a string representation of a Double percentage.
ParseInt(String)	Attempts to parse a string representation of an integer percentage.
ParseUInt(String)	Attempts to parse a string representation of an unsigned integer percentage.

See also

• INumberFormatterOptions
• INumberFormatter
• INumberFormatter2
• INumberParser
• ISignificantDigitsOption
• INumberRounderOption
• Number formatting and parsing sample
• Number formatting and parsing sample (Windows 10)