Class PercentFormat

Defines how percent values are formatted and displayed.

Inheritance
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
FormatBase
PercentFormat
Inherited Members
Namespace: FastReport.Olap.Format
Assembly: FastReport.Olap.dll
Syntax
public class PercentFormat : FormatBase, IComponent, IDisposable

Constructors

PercentFormat()

Initializes a new instance of the PercentFormat class with default settings.

Declaration
public PercentFormat()

Properties

DecimalDigits

Gets or sets the number of decimal places to use in percent values.

Declaration
public int DecimalDigits { get; set; }
Property Value
Type Description
System.Int32

DecimalSeparator

Gets or sets the string to use as the decimal separator in percent values.

Declaration
public string DecimalSeparator { get; set; }
Property Value
Type Description
System.String

GroupSeparator

Gets or sets the string that separates groups of digits to the left of the decimal in percent values.

Declaration
public string GroupSeparator { get; set; }
Property Value
Type Description
System.String

NegativePattern

Gets or sets the format pattern for negative percent values.

Declaration
public int NegativePattern { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property can have one of the values in the following table. The symbol "%" is the PercentSymbol and n is a number.

ValueAssociated Pattern
0-n %
1-n%
2-%n
3%-n
4%n-
5n-%
6n%-
7-%n
8n %-
9% n-
10% -n
11n- %

PercentSymbol

Gets or sets the string to use as the percent symbol.

Declaration
public string PercentSymbol { get; set; }
Property Value
Type Description
System.String

PositivePattern

Gets or sets the format pattern for positive percent values.

Declaration
public int PositivePattern { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property can have one of the values in the following table. The symbol "%" is the PercentSymbol and n is a number.

ValueAssociated Pattern
0n %
1n%
2%n
3% n

UseLocale

Gets or sets a value that determines whether to use system locale settings to format a value.

Declaration
public bool UseLocale { get; set; }
Property Value
Type Description
System.Boolean

Methods

Clone()

Creates exact copy of this format.

Declaration
public override FormatBase Clone()
Returns
Type Description
FormatBase

The copy of this format.
Overrides

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

FormatValue(Object)

Formats the specified value.

Declaration
public override string FormatValue(object value)
Parameters
Type Name Description
System.Object value

The value to format.
Returns
Type Description
System.String

The string that represents the formatted value.
Overrides

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

Load(XmlItem)

Declaration
public override void Load(XmlItem item)
Parameters
Type Name Description
XmlItem item
Overrides

Save(XmlItem)

Declaration
public override void Save(XmlItem item)
Parameters
Type Name Description
XmlItem item
Overrides