Class
CellValueFormat

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

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class CellValueFormat

Inheritance: objectCellValueFormat

Constructors

CellValueFormat(string)

Initializes a new CellValueFormat with the specified format pattern string.

Declaration

cs-api-definition
public CellValueFormat(string formatString)

Parameters

formatString

string

The format string.

Fields

GeneralFormat

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

Declaration

cs-api-definition
public static readonly CellValueFormat GeneralFormat

Field Value

CellValueFormat

Properties

FormatString

Format pattern string that controls how cell values are displayed.

Declaration

cs-api-definition
public string FormatString { get; }

Property Value

string

The format string.

FormatStringInfo

Metadata about the format string including its category and type.

Declaration

cs-api-definition
public FormatStringInfo FormatStringInfo { get; }

Property Value

FormatStringInfo

The format string information.

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

The object to compare with the current object.

Returns

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides object.Equals(object)

GetFormatResult(ICellValue)

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

Declaration

cs-api-definition
public CellValueFormatResult GetFormatResult(ICellValue cellValue)

Parameters

cellValue

ICellValue

The cell value.

Returns

CellValueFormatResult

The format result.

GetHashCode()

Serves as a hash function for a particular type.

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()

Operators

operator !=(CellValueFormat, CellValueFormat)

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

Declaration

cs-api-definition
public static bool operator !=(CellValueFormat first, CellValueFormat second)

Parameters

first

CellValueFormat

The first value.

second

CellValueFormat

The second value.

Returns

bool

The result of the operator.

operator ==(CellValueFormat, CellValueFormat)

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

Declaration

cs-api-definition
public static bool operator ==(CellValueFormat first, CellValueFormat second)

Parameters

first

CellValueFormat

The first value.

second

CellValueFormat

The second value.

Returns

bool

The result of the operator.