3rdpartylibs/fastreports/Fast-Report/FastReport.Base/Format/PercentFormat.cs

using System;
using System.Collections.Generic;
using System.Text;
using System.ComponentModel;
using FastReport.Utils;
using System.Globalization;

namespace FastReport.Format
{
    /// <summary>
    /// Defines how percent values are formatted and displayed.
    /// </summary>
    public class PercentFormat : FormatBase
    {
        #region Fields
        private bool useLocale;
        private int decimalDigits;
        private string decimalSeparator;
        private string groupSeparator;
        private string percentSymbol;
        private int positivePattern;
        private int negativePattern;
        #endregion

        #region Properties
        /// <summary>
        /// Gets or sets a value that determines whether to use system locale settings to format a value.
        /// </summary>
        [DefaultValue(true)]
        public bool UseLocale
        {
            get { return useLocale; }
            set { useLocale = value; }
        }

        /// <summary>
        /// Gets or sets the number of decimal places to use in percent values. 
        /// </summary>
        [DefaultValue(2)]
        public int DecimalDigits
        {
            get { return decimalDigits; }
            set { decimalDigits = value; }
        }

        /// <summary>
        /// Gets or sets the string to use as the decimal separator in percent values.
        /// </summary>
        public string DecimalSeparator
        {
            get { return decimalSeparator; }
            set { decimalSeparator = value; }
        }

        /// <summary>
        /// Gets or sets the string that separates groups of digits to the left of the decimal in percent values. 
        /// </summary>
        public string GroupSeparator
        {
            get { return groupSeparator; }
            set { groupSeparator = value; }
        }

        /// <summary>
        /// Gets or sets the string to use as the percent symbol.
        /// </summary>
        public string PercentSymbol
        {
            get { return percentSymbol; }
            set { percentSymbol = value; }
        }

        /// <summary>
        /// Gets or sets the format pattern for positive percent values.
        /// </summary>
        /// <remarks>This property can have one of the values in the following table. 
        /// The symbol "%" is the <b>PercentSymbol</b> and <i>n</i> is a number.
        /// <list type="table">
        ///   <listheader><term>Value</term><description>Associated Pattern</description></listheader>
        ///   <item><term>0</term><description>n %</description></item>
        ///   <item><term>1</term><description>n%</description></item>
        ///   <item><term>2</term><description>%n</description></item>
        ///   <item><term>3</term><description>% n</description></item>
        /// </list>
        /// </remarks>
        [DefaultValue(0)]
        public int PositivePattern
        {
            get { return positivePattern; }
            set { positivePattern = value; }
        }

        /// <summary>
        /// Gets or sets the format pattern for negative percent values.
        /// </summary>
        /// <remarks>This property can have one of the values in the following table. 
        /// The symbol "%" is the <b>PercentSymbol</b> and <i>n</i> is a number.
        /// <list type="table">
        ///   <listheader><term>Value</term><description>Associated Pattern</description></listheader>
        ///   <item><term>0</term> <description>-n %</description></item>
        ///   <item><term>1</term> <description>-n%</description></item>
        ///   <item><term>2</term> <description>-%n</description></item>
        ///   <item><term>3</term> <description>%-n</description></item>
        ///   <item><term>4</term> <description>%n-</description></item>
        ///   <item><term>5</term> <description>n-%</description></item>
        ///   <item><term>6</term> <description>n%-</description></item>
        ///   <item><term>7</term> <description>-%n</description></item>
        ///   <item><term>8</term> <description>n %-</description></item>
        ///   <item><term>9</term> <description>% n-</description></item>
        ///   <item><term>10</term><description>% -n</description></item>
        ///   <item><term>11</term><description>n- %</description></item>
        /// </list>
        /// </remarks>
        [DefaultValue(0)]
        public int NegativePattern
        {
            get { return negativePattern; }
            set { negativePattern = value; }
        }
        #endregion

        #region Public Methods
        /// <inheritdoc/>
        public override FormatBase Clone()
        {
            PercentFormat result = new PercentFormat();
            result.UseLocale = UseLocale;
            result.DecimalDigits = DecimalDigits;
            result.DecimalSeparator = DecimalSeparator;
            result.GroupSeparator = GroupSeparator;
            result.PercentSymbol = PercentSymbol;
            result.PositivePattern = PositivePattern;
            result.NegativePattern = NegativePattern;
            return result;
        }

        /// <inheritdoc/>
        public override bool Equals(object obj)
        {
            PercentFormat f = obj as PercentFormat;
            return f != null &&
              UseLocale == f.UseLocale &&
              DecimalDigits == f.DecimalDigits &&
              DecimalSeparator == f.DecimalSeparator &&
              GroupSeparator == f.GroupSeparator &&
              PercentSymbol == f.PercentSymbol &&
              PositivePattern == f.PositivePattern &&
              NegativePattern == f.NegativePattern;
        }

        /// <inheritdoc/>
        public override int GetHashCode()
        {
            return base.GetHashCode();
        }

        /// <inheritdoc/>
        public override string FormatValue(object value)
        {
            if (value is Variant)
                value = ((Variant)value).Value;

            return String.Format(GetNumberFormatInfo(), "{0:p}", new object[] { value });
        }

        internal NumberFormatInfo GetNumberFormatInfo()
        {
            NumberFormatInfo info = new NumberFormatInfo();
            if (UseLocale)
            {
                NumberFormatInfo cultureFormat = CultureInfo.CurrentCulture.NumberFormat;
                info.PercentDecimalDigits = DecimalDigits;
                info.PercentDecimalSeparator = cultureFormat.PercentDecimalSeparator;
                info.PercentGroupSizes = cultureFormat.PercentGroupSizes;
                info.PercentGroupSeparator = cultureFormat.PercentGroupSeparator;
                info.PercentSymbol = cultureFormat.PercentSymbol;
                info.PercentPositivePattern = cultureFormat.PercentPositivePattern;
                info.PercentNegativePattern = cultureFormat.PercentNegativePattern;
            }
            else
            {
                info.PercentDecimalDigits = DecimalDigits;
                info.PercentDecimalSeparator = DecimalSeparator;
                info.PercentGroupSizes = new int[] { 3 };
                info.PercentGroupSeparator = GroupSeparator;
                info.PercentSymbol = PercentSymbol;
                info.PercentPositivePattern = PositivePattern;
                info.PercentNegativePattern = NegativePattern;
            }
            return info;
        }

        internal override string GetSampleValue()
        {
            return FormatValue(1.23f);
        }

        internal override void Serialize(FRWriter writer, string prefix, FormatBase format)
        {
            base.Serialize(writer, prefix, format);
            PercentFormat c = format as PercentFormat;

            if (c == null || UseLocale != c.UseLocale)
                writer.WriteBool(prefix + "UseLocale", UseLocale);
            if (c == null || DecimalDigits != c.DecimalDigits)
                writer.WriteInt(prefix + "DecimalDigits", DecimalDigits);

            if (!UseLocale)
            {
                if (c == null || DecimalSeparator != c.DecimalSeparator)
                    writer.WriteStr(prefix + "DecimalSeparator", DecimalSeparator);
                if (c == null || GroupSeparator != c.GroupSeparator)
                    writer.WriteStr(prefix + "GroupSeparator", GroupSeparator);
                if (c == null || PercentSymbol != c.PercentSymbol)
                    writer.WriteStr(prefix + "PercentSymbol", PercentSymbol);
                if (c == null || PositivePattern != c.PositivePattern)
                    writer.WriteInt(prefix + "PositivePattern", PositivePattern);
                if (c == null || NegativePattern != c.NegativePattern)
                    writer.WriteInt(prefix + "NegativePattern", NegativePattern);
            }
        }
        #endregion

        /// <summary>
        /// Initializes a new instance of the <b>PercentFormat</b> class with default settings. 
        /// </summary>
        public PercentFormat()
        {
            UseLocale = true;
            DecimalDigits = 2;
            DecimalSeparator = ".";
            GroupSeparator = ",";
            PercentSymbol = "%";
        }
    }
}