From 2d0ac967e94c5944ccccf9adad8da5a9d082df29 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sun, 20 Nov 2011 23:44:58 +0900 Subject: pushing docs --- doc/Axlsx/CellStyle.html | 949 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 949 insertions(+) create mode 100644 doc/Axlsx/CellStyle.html (limited to 'doc/Axlsx/CellStyle.html') diff --git a/doc/Axlsx/CellStyle.html b/doc/Axlsx/CellStyle.html new file mode 100644 index 00000000..042069c9 --- /dev/null +++ b/doc/Axlsx/CellStyle.html @@ -0,0 +1,949 @@ + + + + + + Class: Axlsx::CellStyle + + — Documentation by YARD 0.7.3 + + + + + + + + + + + + + + + + + + + + + + +

Class: Axlsx::CellStyle + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/axlsx/stylesheet/cell_style.rb
+ +
+
+ +

Overview

+
+ +
+ Note: +

+Using Styles#add_style is the recommended way to manage cell styling. +

+
+
+ +

+CellStyle defines named styles that reference defined formatting records +and can be used in your worksheet. +

+ + +
+
+
+ + +

See Also:

+ + +
+ +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (CellStyle) initialize(options = {}) + + + +

+
+

+Creats a new CellStyle object +

+ + +
+
+
+

Parameters:

+
    + +
  • + + options + + + (Hash) + + + (defaults to: {}) + + + — +

    +a customizable set of options +

    +
    + +
    • + +
+ + + + +

Options Hash (options):

+
    + +
  • + name + (String) + + + + +
    • + +
  • + xfId + (Integer) + + + + +
    • + +
  • + buildinId + (Integer) + + + + +
    • + +
  • + iLevel + (Integer) + + + + +
    • + +
  • + hidden + (Boolean) + + + + +
    • + +
  • + customBuiltIn + (Boolean) + + + + +
    • + +
+ + + +
+ + + + +
+ 
+
+
+39
+40
+41
+42
+43
+ 		+ 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 39
+
+def initialize(options={})
+  options.each do |o|
+    self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+  end
+end
+
+
+
+ +
+ +
+

Instance Attribute Details

+ + + + +
+

+ + - (Integer) builtinId + + + +

+
+

+The buildinId to use when this named style is applied +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + +
    • + +
+ +

See Also:

+ + +
+ + + + +
+ 
+
+
+18
+19
+20
+ 		+ 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 18
+
+def builtinId
+  @builtinId
+end
+
+
+
+ + + + +
+

+ + - (Boolean) customBuiltin + + + +

+
+

+Indicates that the build in style reference has been customized. +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+30
+31
+32
+ 		+ 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 30
+
+def customBuiltin
+  @customBuiltin
+end
+
+
+
+ + + + +
+

+ + - (Boolean) hidden + + + +

+
+

+Determines if this named style should show in the list of styles when using +excel +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+26
+27
+28
+ 		+ 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 26
+
+def 
+  @hidden
+end
+
+
+
+ + + + +
+

+ + - (Integer) iLevel + + + +

+
+

+Determines if this formatting is for an outline style, and what level of +the outline it is to be applied to. +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+22
+23
+24
+ 		+ 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 22
+
+def iLevel
+  @iLevel
+end
+
+
+
+ + + + +
+

+ + - (String) name + + + +

+
+

+The name of this cell style +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+8
+9
+10
+ 		+ 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 8
+
+def name
+  @name
+end
+
+
+
+ + + + +
+

+ + - (Integer) xfId + + + +

+
+

+The formatting record id this named style utilizes +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + +
    • + +
+ +

See Also:

+
    + +
  • Xf
    • + +
+ +
+ + + + +
+ 
+
+
+13
+14
+15
+ 		+ 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 13
+
+def xfId
+  @xfId
+end
+
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (String) to_xml(xml) + + + +

+
+

+Serializes the cell style +

+ + +
+
+
+

Parameters:

+
    + +
  • + + xml + + + (Nokogiri::XML::Builder) + + + + — +

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

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+55
+56
+57
+ 		+ 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 55
+
+def to_xml(xml)
+  xml.cellStyle(self.instance_values)
+end
+
+
+
+ +
+ +
+ + + + + \ No newline at end of file -- cgit v1.2.3