New to Telerik UI for WinForms? Start a free 30-day trial

CellValueFormat

Class

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:

public class CellValueFormat

Inheritance: objectCellValueFormat

Constructors

CellValueFormat(string)

Initializes a new CellValueFormat with the specified format pattern string.

public CellValueFormat(string formatString)

Parameters:formatStringstring

The format string.

Fields

GeneralFormat

CellValueFormat

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

public static readonly CellValueFormat GeneralFormat

Properties

FormatString

string

Format pattern string that controls how cell values are displayed.

public string FormatString { get; }

Property Value:

The format string.

FormatStringInfo

Metadata about the format string including its category and type.

public FormatStringInfo FormatStringInfo { get; }

Property Value:

The format string information.

Methods

Equals(object)

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

public override bool Equals(object obj)

Parameters:objobject

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.

public CellValueFormatResult GetFormatResult(ICellValue cellValue)

Parameters:cellValueICellValue

The cell value.

Returns:

CellValueFormatResult

The format result.

GetHashCode()

Serves as a hash function for a particular type.

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.

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

Parameters:firstCellValueFormat

The first value.

secondCellValueFormat

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.

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

Parameters:firstCellValueFormat

The first value.

secondCellValueFormat

The second value.

Returns:

bool

The result of the operator.