diff options
| author | Randy Morgan <[email protected]> | 2011-11-30 08:53:14 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-30 08:53:14 +0900 |
| commit | 076be316935180341d7ee7a9335281a4b18d1fa9 (patch) | |
| tree | 8754af1eaadb7fa1585aaedcd7845d68b7985d3c /doc/Axlsx/Workbook.html | |
| parent | e99f1ecbe8311f1dbe2b889a82a528f3e85e366d (diff) | |
| download | caxlsx-076be316935180341d7ee7a9335281a4b18d1fa9.tar.gz caxlsx-076be316935180341d7ee7a9335281a4b18d1fa9.zip | |
pre 1.0.10 release commit
Diffstat (limited to 'doc/Axlsx/Workbook.html')
| -rw-r--r-- | doc/Axlsx/Workbook.html | 233 |
1 files changed, 98 insertions, 135 deletions
diff --git a/doc/Axlsx/Workbook.html b/doc/Axlsx/Workbook.html index 6d18fd7c..915b139b 100644 --- a/doc/Axlsx/Workbook.html +++ b/doc/Axlsx/Workbook.html @@ -94,32 +94,31 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - <p> -The Workbook class is an xlsx workbook that manages worksheets, charts, + +<p>The Workbook class is an xlsx workbook that manages worksheets, charts, drawings and styles. The following parts of the Office Open XML spreadsheet -specification are not implimented in this version. -</p> -<pre class="code"> - <span class='bookViews identifier id'>bookViews</span> - <span class='calcPr identifier id'>calcPr</span> - <span class='customWorkbookViews identifier id'>customWorkbookViews</span> - <span class='definedNames identifier id'>definedNames</span> - <span class='externalReferences identifier id'>externalReferences</span> - <span class='extLst identifier id'>extLst</span> - <span class='fileRecoveryPr identifier id'>fileRecoveryPr</span> - <span class='fileSharing identifier id'>fileSharing</span> - <span class='fileVersion identifier id'>fileVersion</span> - <span class='functionGroups identifier id'>functionGroups</span> - <span class='oleSize identifier id'>oleSize</span> - <span class='pivotCaches identifier id'>pivotCaches</span> - <span class='smartTagPr identifier id'>smartTagPr</span> - <span class='smartTagTypes identifier id'>smartTagTypes</span> - <span class='webPublishing identifier id'>webPublishing</span> - <span class='webPublishObjects identifier id'>webPublishObjects</span> - <span class='workbookProtection identifier id'>workbookProtection</span> - <span class='workbookPr identifier id'>workbookPr</span><span class='mult op'>*</span> - - <span class='mult op'>*</span><span class='workbookPr identifier id'>workbookPr</span> <span class='is identifier id'>is</span> <span class='only identifier id'>only</span> <span class='supported identifier id'>supported</span> <span class='to identifier id'>to</span> <span class='the identifier id'>the</span> <span class='extend identifier id'>extend</span> <span class='of identifier id'>of</span> <span class='date1904 identifier id'>date1904</span> +specification are not implimented in this version.</p> + +<pre class="code"><span class='bookViews identifier id'>bookViews</span> +<span class='calcPr identifier id'>calcPr</span> +<span class='customWorkbookViews identifier id'>customWorkbookViews</span> +<span class='definedNames identifier id'>definedNames</span> +<span class='externalReferences identifier id'>externalReferences</span> +<span class='extLst identifier id'>extLst</span> +<span class='fileRecoveryPr identifier id'>fileRecoveryPr</span> +<span class='fileSharing identifier id'>fileSharing</span> +<span class='fileVersion identifier id'>fileVersion</span> +<span class='functionGroups identifier id'>functionGroups</span> +<span class='oleSize identifier id'>oleSize</span> +<span class='pivotCaches identifier id'>pivotCaches</span> +<span class='smartTagPr identifier id'>smartTagPr</span> +<span class='smartTagTypes identifier id'>smartTagTypes</span> +<span class='webPublishing identifier id'>webPublishing</span> +<span class='webPublishObjects identifier id'>webPublishObjects</span> +<span class='workbookProtection identifier id'>workbookProtection</span> +<span class='workbookPr identifier id'>workbookPr</span><span class='mult op'>*</span> + +<span class='mult op'>*</span><span class='workbookPr identifier id'>workbookPr</span> <span class='is identifier id'>is</span> <span class='only identifier id'>only</span> <span class='supported identifier id'>supported</span> <span class='to identifier id'>to</span> <span class='the identifier id'>the</span> <span class='extend identifier id'>extend</span> <span class='of identifier id'>of</span> <span class='date1904 identifier id'>date1904</span> </pre> @@ -136,10 +135,9 @@ specification are not implimented in this version. <dt id="date1904-classvariable" class="">@@date1904 = <div class="docstring"> <div class="discussion"> - <p> -Indicates if the epoc date for serialization should be 1904. If false, 1900 -is used. -</p> + +<p>Indicates if the epoc date for serialization should be 1904. If false, 1900 +is used.</p> </div> @@ -178,9 +176,8 @@ is used. - <span class="summary_desc"><div class='inline'><p> -A colllection of charts associated with this workbook. -</p> + <span class="summary_desc"><div class='inline'> +<p>A colllection of charts associated with this workbook.</p> </div></span> </li> @@ -205,9 +202,8 @@ A colllection of charts associated with this workbook. - <span class="summary_desc"><div class='inline'><p> -A colllection of drawings associated with this workbook. -</p> + <span class="summary_desc"><div class='inline'> +<p>A colllection of drawings associated with this workbook.</p> </div></span> </li> @@ -232,9 +228,8 @@ A colllection of drawings associated with this workbook. - <span class="summary_desc"><div class='inline'><p> -A colllection of images associated with this workbook. -</p> + <span class="summary_desc"><div class='inline'> +<p>A colllection of images associated with this workbook.</p> </div></span> </li> @@ -259,9 +254,8 @@ A colllection of images associated with this workbook. - <span class="summary_desc"><div class='inline'><p> -A collection of worksheets associated with this workbook. -</p> + <span class="summary_desc"><div class='inline'> +<p>A collection of worksheets associated with this workbook.</p> </div></span> </li> @@ -296,9 +290,8 @@ A collection of worksheets associated with this workbook. - <span class="summary_desc"><div class='inline'><p> -retrieves the date1904 attribute. -</p> + <span class="summary_desc"><div class='inline'> +<p>retrieves the date1904 attribute.</p> </div></span> </li> @@ -320,9 +313,8 @@ retrieves the date1904 attribute. - <span class="summary_desc"><div class='inline'><p> -Sets the date1904 attribute to the provided boolean. -</p> + <span class="summary_desc"><div class='inline'> +<p>Sets the date1904 attribute to the provided boolean.</p> </div></span> </li> @@ -353,9 +345,8 @@ Sets the date1904 attribute to the provided boolean. - <span class="summary_desc"><div class='inline'><p> -Adds a worksheet to this workbook. -</p> + <span class="summary_desc"><div class='inline'> +<p>Adds a worksheet to this workbook.</p> </div></span> </li> @@ -377,9 +368,8 @@ Adds a worksheet to this workbook. - <span class="summary_desc"><div class='inline'><p> -Instance level access to the class variable 1904. -</p> + <span class="summary_desc"><div class='inline'> +<p>Instance level access to the class variable 1904.</p> </div></span> </li> @@ -401,9 +391,8 @@ Instance level access to the class variable 1904. - <span class="summary_desc"><div class='inline'><p> -see @date1904. -</p> + <span class="summary_desc"><div class='inline'> +<p>see @date1904.</p> </div></span> </li> @@ -427,9 +416,8 @@ see @date1904. - <span class="summary_desc"><div class='inline'><p> -Creates a new Workbook. -</p> + <span class="summary_desc"><div class='inline'> +<p>Creates a new Workbook.</p> </div></span> </li> @@ -451,9 +439,8 @@ Creates a new Workbook. - <span class="summary_desc"><div class='inline'><p> -The workbook relationships. -</p> + <span class="summary_desc"><div class='inline'> +<p>The workbook relationships.</p> </div></span> </li> @@ -475,9 +462,8 @@ The workbook relationships. - <span class="summary_desc"><div class='inline'><p> -The styles associated with this workbook. -</p> + <span class="summary_desc"><div class='inline'> +<p>The styles associated with this workbook.</p> </div></span> </li> @@ -499,9 +485,8 @@ The styles associated with this workbook. - <span class="summary_desc"><div class='inline'><p> -Serializes the workbook document. -</p> + <span class="summary_desc"><div class='inline'> +<p>Serializes the workbook document.</p> </div></span> </li> @@ -522,9 +507,8 @@ Serializes the workbook document. </p><div class="docstring"> <div class="discussion"> - <p> -Creates a new Workbook -</p> + +<p>Creates a new Workbook</p> </div> @@ -545,9 +529,8 @@ Creates a new Workbook — - <div class='inline'><p> -a customizable set of options -</p> + <div class='inline'> +<p>a customizable set of options</p> </div> </li> @@ -598,9 +581,8 @@ a customizable set of options — - <div class='inline'><p> -the object that the method was called on -</p> + <div class='inline'> +<p>the object that the method was called on</p> </div> </li> @@ -661,15 +643,13 @@ the object that the method was called on <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage charts is Worksheet#add_chart -</p> + <div class='inline'> +<p>The recommended way to manage charts is Worksheet#add_chart</p> </div> </div> -<p> -A colllection of charts associated with this workbook -</p> + +<p>A colllection of charts associated with this workbook</p> </div> @@ -736,15 +716,13 @@ A colllection of charts associated with this workbook <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage drawings is Worksheet#add_chart -</p> + <div class='inline'> +<p>The recommended way to manage drawings is Worksheet#add_chart</p> </div> </div> -<p> -A colllection of drawings associated with this workbook -</p> + +<p>A colllection of drawings associated with this workbook</p> </div> @@ -811,15 +789,13 @@ A colllection of drawings associated with this workbook <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage images is Worksheet#add_image -</p> + <div class='inline'> +<p>The recommended way to manage images is Worksheet#add_image</p> </div> </div> -<p> -A colllection of images associated with this workbook -</p> + +<p>A colllection of images associated with this workbook</p> </div> @@ -886,15 +862,13 @@ A colllection of images associated with this workbook <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage worksheets is add_worksheet -</p> + <div class='inline'> +<p>The recommended way to manage worksheets is add_worksheet</p> </div> </div> -<p> -A collection of worksheets associated with this workbook. -</p> + +<p>A collection of worksheets associated with this workbook.</p> </div> @@ -962,9 +936,8 @@ A collection of worksheets associated with this workbook. </p><div class="docstring"> <div class="discussion"> - <p> -retrieves the date1904 attribute -</p> + +<p>retrieves the date1904 attribute</p> </div> @@ -1012,9 +985,8 @@ retrieves the date1904 attribute </p><div class="docstring"> <div class="discussion"> - <p> -Sets the date1904 attribute to the provided boolean -</p> + +<p>Sets the date1904 attribute to the provided boolean</p> </div> @@ -1068,9 +1040,8 @@ Sets the date1904 attribute to the provided boolean </p><div class="docstring"> <div class="discussion"> - <p> -Adds a worksheet to this workbook -</p> + +<p>Adds a worksheet to this workbook</p> </div> @@ -1091,9 +1062,8 @@ Adds a worksheet to this workbook — - <div class='inline'><p> -a customizable set of options -</p> + <div class='inline'> +<p>a customizable set of options</p> </div> </li> @@ -1112,9 +1082,8 @@ a customizable set of options <span class="default"> </span> - — <div class='inline'><p> -The name of the worksheet. -</p> + — <div class='inline'> +<p>The name of the worksheet.</p> </div> </li> @@ -1190,9 +1159,8 @@ The name of the worksheet. </p><div class="docstring"> <div class="discussion"> - <p> -Instance level access to the class variable 1904 -</p> + +<p>Instance level access to the class variable 1904</p> </div> @@ -1240,9 +1208,8 @@ Instance level access to the class variable 1904 </p><div class="docstring"> <div class="discussion"> - <p> -see @date1904 -</p> + +<p>see @date1904</p> </div> @@ -1277,9 +1244,8 @@ see @date1904 </p><div class="docstring"> <div class="discussion"> - <p> -The workbook relationships. This is managed automatically by the workbook -</p> + +<p>The workbook relationships. This is managed automatically by the workbook</p> </div> @@ -1344,15 +1310,13 @@ The workbook relationships. This is managed automatically by the workbook <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage styles is Styles#add_style -</p> + <div class='inline'> +<p>The recommended way to manage styles is Styles#add_style</p> </div> </div> -<p> -The styles associated with this workbook -</p> + +<p>The styles associated with this workbook</p> </div> @@ -1428,9 +1392,8 @@ The styles associated with this workbook </p><div class="docstring"> <div class="discussion"> - <p> -Serializes the workbook document -</p> + +<p>Serializes the workbook document</p> </div> @@ -1500,7 +1463,7 @@ Serializes the workbook document </div> <div id="footer"> - Generated on Tue Nov 29 13:28:45 2011 by + Generated on Wed Nov 30 08:46:37 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.7.3 (ruby-1.8.7). </div> |
