From cdfc7251bde8347678d355e5fe65fc20e120bc23 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sun, 27 Nov 2011 21:45:19 +0900 Subject: updating docs for 1.0.10a release --- doc/Axlsx/NumFmt.html | 179 ++++++++++++++++++++++++++++---------------------- 1 file changed, 99 insertions(+), 80 deletions(-) (limited to 'doc/Axlsx/NumFmt.html') diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html index 6d519adf..a087eb2f 100644 --- a/doc/Axlsx/NumFmt.html +++ b/doc/Axlsx/NumFmt.html @@ -97,14 +97,16 @@
Note: -
-

The recommended way to manage styles is Styles#add_style

+

+The recommended way to manage styles is Styles#add_style +

- -

A NumFmt object defines an identifier and formatting code for data in -cells.

+

+A NumFmt object defines an identifier and formatting code for data in +cells. +

@@ -136,8 +138,9 @@ cells.

-
-

The formatting to use for this number format.

+

+The formatting to use for this number format. +

 @@ -162,8 +165,9 @@ cells.

-
-

An unsinged integer referencing a standard or custom number format.

+

+An unsinged integer referencing a standard or custom number format. +

 @@ -200,8 +204,9 @@ cells.

-
-

A new instance of NumFmt.

+

+A new instance of NumFmt. +

 @@ -223,9 +228,10 @@ cells.

-
-

Creates a numFmt element applying the instance values of this object as -attributes.

+

+Creates a numFmt element applying the instance values of this object as +attributes. +

 @@ -246,8 +252,9 @@ attributes.

- -

A new instance of NumFmt

+

+A new instance of NumFmt +

@@ -272,13 +279,14 @@ attributes.

# File 'lib/axlsx/stylesheet/num_fmt.rb', line 45
 
-def initialize(options={})
-  @numFmtId = 0
-  @formatCode = ""
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-  end
-end
+def initialize(options={}) + @numFmtId = 0 + @formatCode = "" + options.each do |o| + self.send("#{o[0]}=", o[1]) if self.respond_to? o[0] + end +end + @@ -301,8 +309,9 @@ attributes.

- -

The formatting to use for this number format.

+

+The formatting to use for this number format. +

@@ -320,8 +329,9 @@ attributes.

— -
-

The formatting to use for this number format.

+

+The formatting to use for this number format. +

@@ -348,9 +358,10 @@ attributes.

# File 'lib/axlsx/stylesheet/num_fmt.rb', line 44
 
-def formatCode
-  @formatCode
-end
+def formatCode + @formatCode +end + @@ -371,48 +382,51 @@ attributes.

Note: -
-

These are the known formats I can dig up. The constant NUM_FMT_PERCENT is +

+These are the known formats I can dig up. The constant NUM_FMT_PERCENT is 9, and uses the default % formatting. Axlsx also defines a few formats for date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and -NUM_FRM_YYYYMMDDHHMMSS.

- -
1 0
-2 0.00
-3 #,##0
-4 #,##0.00
-5 $#,##0_);($#,##0)
-6 $#,##0_);[Red]($#,##0)
-7 $#,##0.00_);($#,##0.00)
-8 $#,##0.00_);[Red]($#,##0.00)
-9 0%
-10 0.00%
-11 0.00E+00
-12 # ?/?
-13 # ??/??
-14 m/d/yyyy
-15 d-mmm-yy
-16 d-mmm
-17 mmm-yy
-18 h:mm AM/PM
-19 h:mm:ss AM/PM
-20 h:mm
-21 h:mm:ss
-22 m/d/yyyy h:mm
-37 #,##0_);(#,##0)
-38 #,##0_);[Red](#,##0)
-39 #,##0.00_);(#,##0.00)
-40 #,##0.00_);[Red](#,##0.00)
-45 mm:ss
-46 [h]:mm:ss
-47 mm:ss.0
-48 ##0.0E+0
-49 @
+NUM_FRM_YYYYMMDDHHMMSS. +

+
+ 1 0
+ 2 0.00
+ 3 #,##0
+ 4 #,##0.00
+ 5 $#,##0_);($#,##0)
+ 6 $#,##0_);[Red]($#,##0)
+ 7 $#,##0.00_);($#,##0.00)
+ 8 $#,##0.00_);[Red]($#,##0.00)
+ 9 0%
+ 10 0.00%
+ 11 0.00E+00
+ 12 # ?/?
+ 13 # ??/??
+ 14 m/d/yyyy
+ 15 d-mmm-yy
+ 16 d-mmm
+ 17 mmm-yy
+ 18 h:mm AM/PM
+ 19 h:mm:ss AM/PM
+ 20 h:mm
+ 21 h:mm:ss
+ 22 m/d/yyyy h:mm
+ 37 #,##0_);(#,##0)
+ 38 #,##0_);[Red](#,##0)
+ 39 #,##0.00_);(#,##0.00)
+ 40 #,##0.00_);[Red](#,##0.00)
+ 45 mm:ss
+ 46 [h]:mm:ss
+ 47 mm:ss.0
+ 48 ##0.0E+0
+ 49 @
+
- -

An unsinged integer referencing a standard or custom number format.

+

+An unsinged integer referencing a standard or custom number format. +

@@ -430,8 +444,9 @@ NUM_FRM_YYYYMMDDHHMMSS.

— -
-

An unsinged integer referencing a standard or custom number format.

+

+An unsinged integer referencing a standard or custom number format. +

@@ -458,9 +473,10 @@ NUM_FRM_YYYYMMDDHHMMSS.

# File 'lib/axlsx/stylesheet/num_fmt.rb', line 40
 
-def numFmtId
-  @numFmtId
-end
+def numFmtId + @numFmtId +end + @@ -482,9 +498,10 @@ NUM_FRM_YYYYMMDDHHMMSS.

- -

Creates a numFmt element applying the instance values of this object as -attributes.

+

+Creates a numFmt element applying the instance values of this object as +attributes. +

@@ -503,8 +520,9 @@ attributes.

— -
-

The document builder instance this objects xml will be added to.

+

+The document builder instance this objects xml will be added to. +

@@ -523,7 +541,8 @@ attributes.

# File 'lib/axlsx/stylesheet/num_fmt.rb', line 60
 
-def to_xml(xml) xml.numFmt(self.instance_values) end
+def to_xml(xml) xml.numFmt(self.instance_values) end + @@ -534,9 +553,9 @@ attributes.

-- cgit v1.2.3