GetBuiltInFormatter Method

In This Topic

Gets a built-in formatter string by the specified ID.

Syntax

Visual Basic
C#

'Declaration
 
Public Shared Function GetBuiltInFormatter( _
   ByVal workbook As IWorkbook, _
   ByVal numFmtId As Integer, _
   Optional ByVal culture As CultureInfo _
) As IFormatter

'Usage
 
Dim workbook As IWorkbook
Dim numFmtId As Integer
Dim culture As CultureInfo
Dim value As IFormatter
 
value = BuiltInNumberFormats.GetBuiltInFormatter(workbook, numFmtId, culture)

public static IFormatter GetBuiltInFormatter( 
   IWorkbook workbook,
   int numFmtId,
   CultureInfo culture
)

Parameters

workbook: The workook that defines the number format.
numFmtId: An integer value indicates the number format ID.
culture

Return Value

A System.String value represents the built-in formatter.

Remarks

This function has better performance than using NumberFormat.GetFormatterInternal.

Reference

BuiltInNumberFormats Class
BuiltInNumberFormats Members