Xbasic

Office::ExcelDocumentAddCustomNumericFormat Method

Syntax

N AddCustomNumericFormat(C FormatString)

Arguments

FormatStringCharacter: An Excel format expression. The contents of the format string must be a valid format expression for Excel. Consult Microsoft's documentation for rules for valid Excel format expressions.

Returns

ResultNumeric: Returns the index for the Number Format. This index can be used with the CustomNumberFormat() method to retrieve the format.

Description

Add a new numeric format to the document.

Example

dim excel as Office::ExcelDocument
dim formatIndex as N = excel.AddCustomNumericFormat("0 ??/??")
? formatIndex
= 166

? excel.CustomNumericFormat(formatIndex)
= "0 ??/??"