Class
CellValueFormatResult

Contains the formatted output of a cell value, including text segments, color, culture, and conditional formatting information.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Formatting.FormatStrings

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class CellValueFormatResult

Inheritance: objectCellValueFormatResult

Constructors

CellValueFormatResult(IEnumerable<CellValueFormatResultItem>)

Initializes a new instance of the CellValueFormatResult class.

Declaration

cs-api-definition
public CellValueFormatResult(IEnumerable<CellValueFormatResultItem> infos)

Parameters

infos

IEnumerable<CellValueFormatResultItem>

The infos.

CellValueFormatResult(IEnumerable<CellValueFormatResultItem>, Color?, Predicate<double>, CultureInfo)

Initializes a new instance of the CellValueFormatResult class.

Declaration

cs-api-definition
public CellValueFormatResult(IEnumerable<CellValueFormatResultItem> infos, Color? foreground, Predicate<double> condition, CultureInfo culture)

Parameters

infos

IEnumerable<CellValueFormatResultItem>

The infos.

foreground

Color?

The foreground.

condition

Predicate<double>

The condition.

culture

CultureInfo

The culture.

Properties

Condition

Conditional predicate that determines whether this format applies to a numeric value.

Declaration

cs-api-definition
public Predicate<double> Condition { get; }

Property Value

Predicate<double>

The condition.

Culture

Culture used to format the cell value.

Declaration

cs-api-definition
public CultureInfo Culture { get; }

Property Value

CultureInfo

The culture.

Foreground

Foreground color applied to the formatted value, if specified by the format string.

Declaration

cs-api-definition
public Color? Foreground { get; }

Property Value

Color?

The foreground.

Infos

Collection of formatted text segments, each with its own formatting attributes.

Declaration

cs-api-definition
public ReadOnlyCollection<CellValueFormatResultItem> Infos { get; }

Property Value

ReadOnlyCollection<CellValueFormatResultItem>

The infos.

InfosText

Concatenated text from all format result items, including transparent segments.

Declaration

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

Property Value

string

The infos text.

VisibleInfosText

Concatenated text from all visible (non-transparent) format result items.

Declaration

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

Property Value

string

The visible infos text.