Class CellValueFormat

Number format pattern for displaying cell values; applies format strings to control how numbers, dates, times, and text appear in cells.

Inheritance
System.Object
CellValueFormat
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class CellValueFormat

Constructors

CellValueFormat(String)

Initializes a new CellValueFormat with the specified format pattern string.

Declaration
public CellValueFormat(string formatString)
Parameters
System.String formatString

The format string.

Fields

GeneralFormat

Default general format that displays values without any special formatting rules.

Declaration
public static readonly CellValueFormat GeneralFormat
Field Value
CellValueFormat

Properties

FormatString

Format pattern string that controls how cell values are displayed.

Declaration
public string FormatString { get; }
Property Value
System.String

The format string.

FormatStringInfo

Metadata about the format string including its category and type.

Declaration
public FormatStringInfo FormatStringInfo { get; }
Property Value
FormatStringInfo

The format string information.

Methods

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetFormatResult(ICellValue)

Applies this format to a cell value and returns the formatted result with color, culture, and condition information.

Declaration
public CellValueFormatResult GetFormatResult(ICellValue cellValue)
Parameters
ICellValue cellValue

The cell value.
Returns
CellValueFormatResult

The format result.

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

Operators

Equality(CellValueFormat, CellValueFormat)

Determines whether two cell value formats are equal by comparing their format strings.

Declaration
public static bool operator ==(CellValueFormat first, CellValueFormat second)
Parameters
CellValueFormat first

The first value.
CellValueFormat second

The second value.
Returns
System.Boolean

The result of the operator.

Inequality(CellValueFormat, CellValueFormat)

Determines whether two cell value formats are not equal by comparing their format strings.

Declaration
public static bool operator !=(CellValueFormat first, CellValueFormat second)
Parameters
CellValueFormat first

The first value.
CellValueFormat second

The second value.
Returns
System.Boolean

The result of the operator.