[]
        
(Showing Draft Content)

GrapeCity.Spreadsheet.IFormatter.Format

Format Method

Format(DateTime, FormatOptions)

Formats the specified date to display text.

Declaration
FormatResult Format(DateTime date, FormatOptions options = FormatOptions.None)
Function Format([date] As Date, Optional options As FormatOptions = FormatOptions.None) As FormatResult
Parameters
Type Name Description
DateTime date

A DateTime value indicates the date to format.

FormatOptions options

A value that specifies additional format options.

Returns
Type Description
FormatResult

A FormatResult value represents the formatting result.

Format(TimeSpan, FormatOptions)

Formats the specified number to display text.

Declaration
FormatResult Format(TimeSpan timeSpan, FormatOptions options = FormatOptions.None)
Function Format(timeSpan As TimeSpan, Optional options As FormatOptions = FormatOptions.None) As FormatResult
Parameters
Type Name Description
TimeSpan timeSpan

A TimeSpan value indicates the time interval.

FormatOptions options

A value that specifies additional format options.

Returns
Type Description
FormatResult

A FormatResult value represents the formatting result.

Format(double, FormatOptions)

Formats the specified number to display text.

Declaration
FormatResult Format(double number, FormatOptions options = FormatOptions.None)
Function Format(number As Double, Optional options As FormatOptions = FormatOptions.None) As FormatResult
Parameters
Type Name Description
double number

A double value indicates the number to format.

FormatOptions options

A value that specifies additional format options.

Returns
Type Description
FormatResult

A FormatResult value represents the formatting result.

Format(string, FormatOptions)

Formats the specified text to display text.

Declaration
FormatResult Format(string text, FormatOptions options = FormatOptions.None)
Function Format(text As String, Optional options As FormatOptions = FormatOptions.None) As FormatResult
Parameters
Type Name Description
string text

A string value indicates the text to format.

FormatOptions options

A value that specifies additional format options.

Returns
Type Description
FormatResult

A FormatResult value represents the formatting result.

Format(bool, FormatOptions)

Formats the specified boolean value to display text.

Declaration
FormatResult Format(bool value, FormatOptions options = FormatOptions.None)
Function Format(value As Boolean, Optional options As FormatOptions = FormatOptions.None) As FormatResult
Parameters
Type Name Description
bool value

An bool value indicates the data to format.

FormatOptions options

A value that specifies additional format options.

Returns
Type Description
FormatResult

A FormatResult value represents the formatting result.

Format(object, FormatOptions)

Formats the specified object to display text.

Declaration
FormatResult Format(object obj, FormatOptions options = FormatOptions.None)
Function Format(obj As Object, Optional options As FormatOptions = FormatOptions.None) As FormatResult
Parameters
Type Name Description
object obj

An object value indicates the data to format.

FormatOptions options

A value that specifies additional format options.

Returns
Type Description
FormatResult

A FormatResult value represents the formatting result.