rubyXL 3.4.34 → 3.4.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (402) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/VERSION +1 -1
  4. data/lib/rubyXL/objects/root.rb +1 -1
  5. data/rdoc/README_rdoc.html +358 -59
  6. data/rdoc/RubyXL/AExtension.html +157 -50
  7. data/rdoc/RubyXL/AExtensionStorageArea.html +69 -22
  8. data/rdoc/RubyXL/ActiveX.html +119 -38
  9. data/rdoc/RubyXL/ActiveXBinary.html +78 -23
  10. data/rdoc/RubyXL/AdjustHandleList.html +69 -22
  11. data/rdoc/RubyXL/Alignment.html +69 -22
  12. data/rdoc/RubyXL/AlternateContent.html +69 -22
  13. data/rdoc/RubyXL/AlternateUrls.html +69 -22
  14. data/rdoc/RubyXL/Authors.html +69 -22
  15. data/rdoc/RubyXL/AutoFilter.html +69 -22
  16. data/rdoc/RubyXL/AutoFilterColumn.html +69 -22
  17. data/rdoc/RubyXL/BinaryImageFile.html +85 -24
  18. data/rdoc/RubyXL/BodyProperties.html +69 -22
  19. data/rdoc/RubyXL/BooleanNode.html +69 -22
  20. data/rdoc/RubyXL/BooleanValue.html +69 -22
  21. data/rdoc/RubyXL/Border.html +196 -61
  22. data/rdoc/RubyXL/BorderEdge.html +136 -45
  23. data/rdoc/RubyXL/Borders.html +105 -36
  24. data/rdoc/RubyXL/Break.html +69 -22
  25. data/rdoc/RubyXL/BreakList.html +69 -22
  26. data/rdoc/RubyXL/CT_AdjPoint2D.html +69 -22
  27. data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +69 -22
  28. data/rdoc/RubyXL/CT_AlphaModulateEffect.html +69 -22
  29. data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +69 -22
  30. data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +69 -22
  31. data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +69 -22
  32. data/rdoc/RubyXL/CT_Backdrop.html +69 -22
  33. data/rdoc/RubyXL/CT_Bevel.html +69 -22
  34. data/rdoc/RubyXL/CT_BiLevelEffect.html +69 -22
  35. data/rdoc/RubyXL/CT_BlendEffect.html +69 -22
  36. data/rdoc/RubyXL/CT_Blip.html +69 -22
  37. data/rdoc/RubyXL/CT_BlipFillProperties.html +69 -22
  38. data/rdoc/RubyXL/CT_BlurEffect.html +69 -22
  39. data/rdoc/RubyXL/CT_Camera.html +69 -22
  40. data/rdoc/RubyXL/CT_Color.html +69 -22
  41. data/rdoc/RubyXL/CT_ColorChangeEffect.html +69 -22
  42. data/rdoc/RubyXL/CT_ColorMapping.html +69 -22
  43. data/rdoc/RubyXL/CT_ColorScheme.html +69 -22
  44. data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +69 -22
  45. data/rdoc/RubyXL/CT_ConnectionSite.html +69 -22
  46. data/rdoc/RubyXL/CT_ConnectionSiteList.html +69 -22
  47. data/rdoc/RubyXL/CT_DashStop.html +69 -22
  48. data/rdoc/RubyXL/CT_DashStopList.html +69 -22
  49. data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +69 -22
  50. data/rdoc/RubyXL/CT_DuotoneEffect.html +69 -22
  51. data/rdoc/RubyXL/CT_EffectContainer.html +69 -22
  52. data/rdoc/RubyXL/CT_EffectList.html +69 -22
  53. data/rdoc/RubyXL/CT_EffectReference.html +69 -22
  54. data/rdoc/RubyXL/CT_EffectStyleItem.html +69 -22
  55. data/rdoc/RubyXL/CT_EffectStyleList.html +69 -22
  56. data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +69 -22
  57. data/rdoc/RubyXL/CT_FillEffect.html +69 -22
  58. data/rdoc/RubyXL/CT_FillOverlayEffect.html +69 -22
  59. data/rdoc/RubyXL/CT_FillStyleList.html +69 -22
  60. data/rdoc/RubyXL/CT_FlatText.html +69 -22
  61. data/rdoc/RubyXL/CT_FontCollection.html +69 -22
  62. data/rdoc/RubyXL/CT_FontReference.html +69 -22
  63. data/rdoc/RubyXL/CT_GeomGuideList.html +69 -22
  64. data/rdoc/RubyXL/CT_GlowEffect.html +69 -22
  65. data/rdoc/RubyXL/CT_GradientFillProperties.html +69 -22
  66. data/rdoc/RubyXL/CT_GradientStop.html +69 -22
  67. data/rdoc/RubyXL/CT_GradientStopList.html +69 -22
  68. data/rdoc/RubyXL/CT_HSLEffect.html +69 -22
  69. data/rdoc/RubyXL/CT_HslColor.html +69 -22
  70. data/rdoc/RubyXL/CT_Hyperlink.html +69 -22
  71. data/rdoc/RubyXL/CT_InnerShadowEffect.html +69 -22
  72. data/rdoc/RubyXL/CT_LightRig.html +69 -22
  73. data/rdoc/RubyXL/CT_LineEndProperties.html +69 -22
  74. data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +69 -22
  75. data/rdoc/RubyXL/CT_LineProperties.html +69 -22
  76. data/rdoc/RubyXL/CT_LineStyleList.html +69 -22
  77. data/rdoc/RubyXL/CT_LinearShadeProperties.html +69 -22
  78. data/rdoc/RubyXL/CT_LuminanceEffect.html +69 -22
  79. data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +69 -22
  80. data/rdoc/RubyXL/CT_OuterShadowEffect.html +69 -22
  81. data/rdoc/RubyXL/CT_Path2D.html +69 -22
  82. data/rdoc/RubyXL/CT_Path2DArcTo.html +69 -22
  83. data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +69 -22
  84. data/rdoc/RubyXL/CT_Path2DList.html +69 -22
  85. data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +69 -22
  86. data/rdoc/RubyXL/CT_Path2DTo.html +69 -22
  87. data/rdoc/RubyXL/CT_PathShadeProperties.html +69 -22
  88. data/rdoc/RubyXL/CT_PatternFillProperties.html +69 -22
  89. data/rdoc/RubyXL/CT_Point3D.html +69 -22
  90. data/rdoc/RubyXL/CT_PolarAdjustHandle.html +69 -22
  91. data/rdoc/RubyXL/CT_PresetColor.html +69 -22
  92. data/rdoc/RubyXL/CT_PresetLineDashProperties.html +69 -22
  93. data/rdoc/RubyXL/CT_PresetShadowEffect.html +69 -22
  94. data/rdoc/RubyXL/CT_PresetTextShape.html +69 -22
  95. data/rdoc/RubyXL/CT_ReflectionEffect.html +69 -22
  96. data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +69 -22
  97. data/rdoc/RubyXL/CT_RelativeRect.html +69 -22
  98. data/rdoc/RubyXL/CT_SRgbColor.html +69 -22
  99. data/rdoc/RubyXL/CT_ScRgbColor.html +69 -22
  100. data/rdoc/RubyXL/CT_Scene3D.html +69 -22
  101. data/rdoc/RubyXL/CT_SchemeColor.html +69 -22
  102. data/rdoc/RubyXL/CT_Shape3D.html +69 -22
  103. data/rdoc/RubyXL/CT_ShapeStyle.html +69 -22
  104. data/rdoc/RubyXL/CT_SoftEdgesEffect.html +69 -22
  105. data/rdoc/RubyXL/CT_SphereCoords.html +69 -22
  106. data/rdoc/RubyXL/CT_StretchInfoProperties.html +69 -22
  107. data/rdoc/RubyXL/CT_StyleMatrix.html +69 -22
  108. data/rdoc/RubyXL/CT_StyleMatrixReference.html +69 -22
  109. data/rdoc/RubyXL/CT_SupplementalFont.html +69 -22
  110. data/rdoc/RubyXL/CT_SystemColor.html +69 -22
  111. data/rdoc/RubyXL/CT_TextAutonumberBullet.html +69 -22
  112. data/rdoc/RubyXL/CT_TextBlipBullet.html +69 -22
  113. data/rdoc/RubyXL/CT_TextCharBullet.html +69 -22
  114. data/rdoc/RubyXL/CT_TextCharacterProperties.html +69 -22
  115. data/rdoc/RubyXL/CT_TextFont.html +69 -22
  116. data/rdoc/RubyXL/CT_TextListStyle.html +69 -22
  117. data/rdoc/RubyXL/CT_TextNormalAutofit.html +69 -22
  118. data/rdoc/RubyXL/CT_TextParagraphProperties.html +69 -22
  119. data/rdoc/RubyXL/CT_TextSpacing.html +69 -22
  120. data/rdoc/RubyXL/CT_TextTabStop.html +69 -22
  121. data/rdoc/RubyXL/CT_TextTabStopList.html +69 -22
  122. data/rdoc/RubyXL/CT_TileInfoProperties.html +69 -22
  123. data/rdoc/RubyXL/CT_TintEffect.html +69 -22
  124. data/rdoc/RubyXL/CT_Transform2D.html +69 -22
  125. data/rdoc/RubyXL/CT_TransformEffect.html +69 -22
  126. data/rdoc/RubyXL/CT_Vector3D.html +69 -22
  127. data/rdoc/RubyXL/CT_XYAdjustHandle.html +69 -22
  128. data/rdoc/RubyXL/CalculationChain.html +121 -38
  129. data/rdoc/RubyXL/CalculationChainCell.html +69 -22
  130. data/rdoc/RubyXL/CalculationProperties.html +69 -22
  131. data/rdoc/RubyXL/Cell.html +522 -147
  132. data/rdoc/RubyXL/CellConvenienceMethods.html +1188 -325
  133. data/rdoc/RubyXL/CellExt.html +69 -22
  134. data/rdoc/RubyXL/CellSmartTag.html +69 -22
  135. data/rdoc/RubyXL/CellSmartTagProperty.html +69 -22
  136. data/rdoc/RubyXL/CellSmartTags.html +69 -22
  137. data/rdoc/RubyXL/CellStyle.html +69 -22
  138. data/rdoc/RubyXL/CellStyleXFs.html +105 -36
  139. data/rdoc/RubyXL/CellStyles.html +105 -36
  140. data/rdoc/RubyXL/CellValue.html +105 -36
  141. data/rdoc/RubyXL/CellWatch.html +69 -22
  142. data/rdoc/RubyXL/CellWatches.html +69 -22
  143. data/rdoc/RubyXL/CellXFs.html +105 -36
  144. data/rdoc/RubyXL/ChartColorsFile.html +85 -24
  145. data/rdoc/RubyXL/ChartFile.html +126 -39
  146. data/rdoc/RubyXL/ChartStyleFile.html +85 -24
  147. data/rdoc/RubyXL/ChartUserShapesFile.html +85 -24
  148. data/rdoc/RubyXL/Chartsheet.html +174 -55
  149. data/rdoc/RubyXL/ChartsheetPageSetup.html +69 -22
  150. data/rdoc/RubyXL/ChartsheetProperties.html +69 -22
  151. data/rdoc/RubyXL/ChartsheetProtection.html +69 -22
  152. data/rdoc/RubyXL/ChartsheetView.html +69 -22
  153. data/rdoc/RubyXL/ChartsheetViews.html +69 -22
  154. data/rdoc/RubyXL/Color.html +114 -37
  155. data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +181 -58
  156. data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +220 -67
  157. data/rdoc/RubyXL/ColorConvenienceClasses.html +67 -19
  158. data/rdoc/RubyXL/ColorConvenienceMethods.html +103 -33
  159. data/rdoc/RubyXL/ColorFilter.html +69 -22
  160. data/rdoc/RubyXL/ColorScale.html +69 -22
  161. data/rdoc/RubyXL/ColorSet.html +69 -22
  162. data/rdoc/RubyXL/Colors.html +69 -22
  163. data/rdoc/RubyXL/ColumnRange.html +214 -63
  164. data/rdoc/RubyXL/ColumnRanges.html +196 -61
  165. data/rdoc/RubyXL/Comment.html +69 -22
  166. data/rdoc/RubyXL/CommentList.html +69 -22
  167. data/rdoc/RubyXL/CommentsFile.html +133 -42
  168. data/rdoc/RubyXL/ConditionalFormatValue.html +69 -22
  169. data/rdoc/RubyXL/ConditionalFormatting.html +69 -22
  170. data/rdoc/RubyXL/ConditionalFormattingRule.html +69 -22
  171. data/rdoc/RubyXL/Connection.html +69 -22
  172. data/rdoc/RubyXL/ConnectionTable.html +69 -22
  173. data/rdoc/RubyXL/ConnectionTables.html +69 -22
  174. data/rdoc/RubyXL/ConnectionTextField.html +69 -22
  175. data/rdoc/RubyXL/ConnectionTextFields.html +69 -22
  176. data/rdoc/RubyXL/Connections.html +121 -38
  177. data/rdoc/RubyXL/ContentTypeDefault.html +69 -22
  178. data/rdoc/RubyXL/ContentTypeOverride.html +69 -22
  179. data/rdoc/RubyXL/ContentTypes.html +152 -47
  180. data/rdoc/RubyXL/ControlPropertiesFile.html +85 -24
  181. data/rdoc/RubyXL/CorePropertiesFile.html +374 -107
  182. data/rdoc/RubyXL/CustomColor.html +69 -22
  183. data/rdoc/RubyXL/CustomColorList.html +69 -22
  184. data/rdoc/RubyXL/CustomFilter.html +69 -22
  185. data/rdoc/RubyXL/CustomFilters.html +69 -22
  186. data/rdoc/RubyXL/CustomGeometry.html +69 -22
  187. data/rdoc/RubyXL/CustomProperties.html +69 -22
  188. data/rdoc/RubyXL/CustomPropertiesFile.html +85 -24
  189. data/rdoc/RubyXL/CustomProperty.html +69 -22
  190. data/rdoc/RubyXL/CustomPropertyFile.html +85 -24
  191. data/rdoc/RubyXL/CustomSheetView.html +69 -22
  192. data/rdoc/RubyXL/CustomSheetViews.html +69 -22
  193. data/rdoc/RubyXL/CustomWorkbookView.html +69 -22
  194. data/rdoc/RubyXL/CustomWorkbookViews.html +69 -22
  195. data/rdoc/RubyXL/CustomXMLFile.html +78 -23
  196. data/rdoc/RubyXL/DXF.html +69 -22
  197. data/rdoc/RubyXL/DXFs.html +69 -22
  198. data/rdoc/RubyXL/DataBar.html +69 -22
  199. data/rdoc/RubyXL/DataConsolidate.html +69 -22
  200. data/rdoc/RubyXL/DataConsolidationReference.html +69 -22
  201. data/rdoc/RubyXL/DataConsolidationReferences.html +69 -22
  202. data/rdoc/RubyXL/DataType.html +118 -26
  203. data/rdoc/RubyXL/DataValidation.html +69 -22
  204. data/rdoc/RubyXL/DataValidations.html +69 -22
  205. data/rdoc/RubyXL/DateGroupItem.html +69 -22
  206. data/rdoc/RubyXL/DefinedName.html +69 -22
  207. data/rdoc/RubyXL/DefinedNameExt.html +69 -22
  208. data/rdoc/RubyXL/DefinedNames.html +69 -22
  209. data/rdoc/RubyXL/DefinedNamesExt.html +69 -22
  210. data/rdoc/RubyXL/DocumentPropertiesFile.html +164 -51
  211. data/rdoc/RubyXL/DrawingFile.html +126 -39
  212. data/rdoc/RubyXL/DynamicFilter.html +69 -22
  213. data/rdoc/RubyXL/EmbeddedControl.html +69 -22
  214. data/rdoc/RubyXL/EmbeddedControls.html +69 -22
  215. data/rdoc/RubyXL/Extension.html +69 -22
  216. data/rdoc/RubyXL/ExtensionStorageArea.html +69 -22
  217. data/rdoc/RubyXL/Extents.html +69 -22
  218. data/rdoc/RubyXL/ExternalBook.html +69 -22
  219. data/rdoc/RubyXL/ExternalLinksFile.html +126 -39
  220. data/rdoc/RubyXL/ExternalReference.html +69 -22
  221. data/rdoc/RubyXL/ExternalReferences.html +69 -22
  222. data/rdoc/RubyXL/ExtraColorSchemeList.html +69 -22
  223. data/rdoc/RubyXL/FieldItem.html +69 -22
  224. data/rdoc/RubyXL/FileRecoveryProperties.html +69 -22
  225. data/rdoc/RubyXL/FileSharing.html +69 -22
  226. data/rdoc/RubyXL/FileVersion.html +69 -22
  227. data/rdoc/RubyXL/Fill.html +105 -36
  228. data/rdoc/RubyXL/Fills.html +105 -36
  229. data/rdoc/RubyXL/FilterContainer.html +69 -22
  230. data/rdoc/RubyXL/FloatNode.html +69 -22
  231. data/rdoc/RubyXL/FloatValue.html +69 -22
  232. data/rdoc/RubyXL/Font.html +115 -38
  233. data/rdoc/RubyXL/FontConvenienceMethods.html +494 -138
  234. data/rdoc/RubyXL/FontScheme.html +69 -22
  235. data/rdoc/RubyXL/Fonts.html +105 -36
  236. data/rdoc/RubyXL/Formula.html +69 -22
  237. data/rdoc/RubyXL/FunctionGroup.html +69 -22
  238. data/rdoc/RubyXL/FunctionGroups.html +69 -22
  239. data/rdoc/RubyXL/GenericStorageObject.html +214 -65
  240. data/rdoc/RubyXL/GradientFill.html +69 -22
  241. data/rdoc/RubyXL/HeaderFooterSettings.html +69 -22
  242. data/rdoc/RubyXL/Hyperlink.html +69 -22
  243. data/rdoc/RubyXL/HyperlinkRelFile.html +78 -23
  244. data/rdoc/RubyXL/Hyperlinks.html +69 -22
  245. data/rdoc/RubyXL/IconFilter.html +69 -22
  246. data/rdoc/RubyXL/IconSet.html +69 -22
  247. data/rdoc/RubyXL/IgnoredError.html +69 -22
  248. data/rdoc/RubyXL/IgnoredErrors.html +69 -22
  249. data/rdoc/RubyXL/IndexedColors.html +69 -22
  250. data/rdoc/RubyXL/InputCells.html +69 -22
  251. data/rdoc/RubyXL/IntegerNode.html +69 -22
  252. data/rdoc/RubyXL/IntegerValue.html +69 -22
  253. data/rdoc/RubyXL/LegacyCell.html +103 -33
  254. data/rdoc/RubyXL/LegacyWorksheet.html +252 -73
  255. data/rdoc/RubyXL/MRUColors.html +69 -22
  256. data/rdoc/RubyXL/MacrosFile.html +85 -24
  257. data/rdoc/RubyXL/MergedCell.html +69 -22
  258. data/rdoc/RubyXL/MergedCells.html +69 -22
  259. data/rdoc/RubyXL/NumFmt.html +69 -22
  260. data/rdoc/RubyXL/NumberFormat.html +105 -36
  261. data/rdoc/RubyXL/NumberFormats.html +115 -38
  262. data/rdoc/RubyXL/OLEObject.html +69 -22
  263. data/rdoc/RubyXL/OLEObjectFile.html +85 -24
  264. data/rdoc/RubyXL/OLEObjects.html +69 -22
  265. data/rdoc/RubyXL/OLESize.html +69 -22
  266. data/rdoc/RubyXL/OOXMLContainerObject.html +289 -93
  267. data/rdoc/RubyXL/OOXMLIgnored.html +145 -46
  268. data/rdoc/RubyXL/OOXMLObject.html +74 -23
  269. data/rdoc/RubyXL/OOXMLObjectClassMethods.html +287 -107
  270. data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +362 -117
  271. data/rdoc/RubyXL/OOXMLRelationshipsFile.html +429 -124
  272. data/rdoc/RubyXL/OOXMLTopLevelObject.html +280 -93
  273. data/rdoc/RubyXL/OdbcOleDbProperties.html +69 -22
  274. data/rdoc/RubyXL/Offset.html +69 -22
  275. data/rdoc/RubyXL/OlapProperties.html +69 -22
  276. data/rdoc/RubyXL/OleItem.html +69 -22
  277. data/rdoc/RubyXL/OleItems.html +69 -22
  278. data/rdoc/RubyXL/OleLink.html +69 -22
  279. data/rdoc/RubyXL/OutlineProperties.html +69 -22
  280. data/rdoc/RubyXL/PageMargins.html +69 -22
  281. data/rdoc/RubyXL/PageSetup.html +69 -22
  282. data/rdoc/RubyXL/PageSetupProperties.html +69 -22
  283. data/rdoc/RubyXL/Pane.html +69 -22
  284. data/rdoc/RubyXL/Parser.html +136 -45
  285. data/rdoc/RubyXL/PatternFill.html +69 -22
  286. data/rdoc/RubyXL/PersonMetadata.html +85 -24
  287. data/rdoc/RubyXL/PhoneticProperties.html +69 -22
  288. data/rdoc/RubyXL/PhoneticRun.html +69 -22
  289. data/rdoc/RubyXL/PivotArea.html +69 -22
  290. data/rdoc/RubyXL/PivotCache.html +69 -22
  291. data/rdoc/RubyXL/PivotCacheDefinitionFile.html +90 -25
  292. data/rdoc/RubyXL/PivotCacheRecordsFile.html +85 -24
  293. data/rdoc/RubyXL/PivotCaches.html +69 -22
  294. data/rdoc/RubyXL/PivotReference.html +69 -22
  295. data/rdoc/RubyXL/PivotReferences.html +69 -22
  296. data/rdoc/RubyXL/PivotTableFile.html +90 -25
  297. data/rdoc/RubyXL/PivotTableSelection.html +69 -22
  298. data/rdoc/RubyXL/PresetGeometry.html +69 -22
  299. data/rdoc/RubyXL/PrintOptions.html +69 -22
  300. data/rdoc/RubyXL/PrinterSettingsFile.html +85 -24
  301. data/rdoc/RubyXL/ProtectedRange.html +69 -22
  302. data/rdoc/RubyXL/ProtectedRanges.html +69 -22
  303. data/rdoc/RubyXL/Protection.html +69 -22
  304. data/rdoc/RubyXL/QueryParameter.html +69 -22
  305. data/rdoc/RubyXL/QueryParameters.html +69 -22
  306. data/rdoc/RubyXL/QueryTable.html +126 -39
  307. data/rdoc/RubyXL/QueryTableDeletedField.html +69 -22
  308. data/rdoc/RubyXL/QueryTableDeletedFields.html +69 -22
  309. data/rdoc/RubyXL/QueryTableField.html +69 -22
  310. data/rdoc/RubyXL/QueryTableFields.html +69 -22
  311. data/rdoc/RubyXL/QueryTableRefresh.html +69 -22
  312. data/rdoc/RubyXL/RID.html +69 -22
  313. data/rdoc/RubyXL/RawOOXML.html +157 -50
  314. data/rdoc/RubyXL/Reference.html +512 -143
  315. data/rdoc/RubyXL/Relationship.html +69 -22
  316. data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +109 -33
  317. data/rdoc/RubyXL/RelationshipSupport.html +290 -84
  318. data/rdoc/RubyXL/RevisionPointer.html +69 -22
  319. data/rdoc/RubyXL/RichText.html +105 -36
  320. data/rdoc/RubyXL/RichTextRun.html +105 -36
  321. data/rdoc/RubyXL/Row.html +367 -106
  322. data/rdoc/RubyXL/RowExt.html +69 -22
  323. data/rdoc/RubyXL/RunProperties.html +69 -22
  324. data/rdoc/RubyXL/Scenario.html +69 -22
  325. data/rdoc/RubyXL/Scenarios.html +69 -22
  326. data/rdoc/RubyXL/Selection.html +105 -36
  327. data/rdoc/RubyXL/ShapeGuide.html +69 -22
  328. data/rdoc/RubyXL/ShapeTextRectangle.html +69 -22
  329. data/rdoc/RubyXL/SharedStringsTable.html +321 -96
  330. data/rdoc/RubyXL/Sheet.html +69 -22
  331. data/rdoc/RubyXL/SheetCalculationProperties.html +69 -22
  332. data/rdoc/RubyXL/SheetData.html +136 -45
  333. data/rdoc/RubyXL/SheetDataExt.html +69 -22
  334. data/rdoc/RubyXL/SheetDataSet.html +69 -22
  335. data/rdoc/RubyXL/SheetMetadata.html +85 -24
  336. data/rdoc/RubyXL/SheetName.html +69 -22
  337. data/rdoc/RubyXL/SheetNames.html +69 -22
  338. data/rdoc/RubyXL/Sheets.html +69 -22
  339. data/rdoc/RubyXL/SlicerCacheFile.html +85 -24
  340. data/rdoc/RubyXL/SlicerFile.html +85 -24
  341. data/rdoc/RubyXL/SmartTagProperties.html +69 -22
  342. data/rdoc/RubyXL/SmartTagType.html +69 -22
  343. data/rdoc/RubyXL/SmartTagTypes.html +69 -22
  344. data/rdoc/RubyXL/SmartTags.html +69 -22
  345. data/rdoc/RubyXL/SortCondition.html +69 -22
  346. data/rdoc/RubyXL/SortState.html +69 -22
  347. data/rdoc/RubyXL/Sqref.html +145 -46
  348. data/rdoc/RubyXL/Stop.html +69 -22
  349. data/rdoc/RubyXL/StringNode.html +69 -22
  350. data/rdoc/RubyXL/StringNodeW3C.html +145 -46
  351. data/rdoc/RubyXL/StringValue.html +69 -22
  352. data/rdoc/RubyXL/Stylesheet.html +256 -76
  353. data/rdoc/RubyXL/TableFile.html +85 -24
  354. data/rdoc/RubyXL/TableParts.html +69 -22
  355. data/rdoc/RubyXL/TableStyle.html +69 -22
  356. data/rdoc/RubyXL/TableStyles.html +69 -22
  357. data/rdoc/RubyXL/Text.html +153 -48
  358. data/rdoc/RubyXL/TextImportSettings.html +69 -22
  359. data/rdoc/RubyXL/Theme.html +191 -56
  360. data/rdoc/RubyXL/ThemeElements.html +69 -22
  361. data/rdoc/RubyXL/ThumbnailFile.html +85 -24
  362. data/rdoc/RubyXL/Top10.html +69 -22
  363. data/rdoc/RubyXL/VMLDrawingFile.html +91 -26
  364. data/rdoc/RubyXL/Variant.html +69 -22
  365. data/rdoc/RubyXL/Vector.html +105 -36
  366. data/rdoc/RubyXL/VectorValue.html +69 -22
  367. data/rdoc/RubyXL/VisualProperties.html +69 -22
  368. data/rdoc/RubyXL/WebPublishObject.html +69 -22
  369. data/rdoc/RubyXL/WebPublishObjects.html +69 -22
  370. data/rdoc/RubyXL/WebPublishingItem.html +69 -22
  371. data/rdoc/RubyXL/WebPublishingItems.html +69 -22
  372. data/rdoc/RubyXL/WebPublishingProperties.html +69 -22
  373. data/rdoc/RubyXL/WebQueryProperties.html +69 -22
  374. data/rdoc/RubyXL/Workbook.html +1053 -284
  375. data/rdoc/RubyXL/WorkbookConvenienceMethods.html +614 -170
  376. data/rdoc/RubyXL/WorkbookProperties.html +69 -22
  377. data/rdoc/RubyXL/WorkbookProtection.html +69 -22
  378. data/rdoc/RubyXL/WorkbookRoot.html +271 -82
  379. data/rdoc/RubyXL/WorkbookView.html +69 -22
  380. data/rdoc/RubyXL/WorkbookViews.html +69 -22
  381. data/rdoc/RubyXL/Worksheet.html +373 -110
  382. data/rdoc/RubyXL/WorksheetConvenienceMethods.html +2195 -585
  383. data/rdoc/RubyXL/WorksheetDimensions.html +69 -22
  384. data/rdoc/RubyXL/WorksheetFormatProperties.html +69 -22
  385. data/rdoc/RubyXL/WorksheetProperties.html +69 -22
  386. data/rdoc/RubyXL/WorksheetProtection.html +69 -22
  387. data/rdoc/RubyXL/WorksheetView.html +69 -22
  388. data/rdoc/RubyXL/WorksheetViews.html +69 -22
  389. data/rdoc/RubyXL/XF.html +69 -22
  390. data/rdoc/RubyXL.html +778 -134
  391. data/rdoc/created.rid +4 -4
  392. data/rdoc/css/rdoc.css +393 -397
  393. data/rdoc/index.html +42 -408
  394. data/rdoc/js/darkfish.js +45 -2
  395. data/rdoc/js/navigation.js.gz +0 -0
  396. data/rdoc/js/search.js +11 -1
  397. data/rdoc/js/search_index.js.gz +0 -0
  398. data/rdoc/js/searcher.js +44 -6
  399. data/rdoc/js/searcher.js.gz +0 -0
  400. data/rdoc/table_of_contents.html +1280 -53
  401. data/rubyXL.gemspec +4 -4
  402. metadata +6 -6
@@ -1,10 +1,21 @@
1
1
  <!DOCTYPE html>
2
2
 
3
- <html>
3
+ <html lang="en">
4
4
  <head>
5
5
  <meta charset="UTF-8">
6
+ <meta name="viewport" content="width=device-width, initial-scale=1">
7
+
8
+ <title>module RubyXL::OOXMLObjectInstanceMethods - rubyXL 3.4.35</title>
9
+
10
+
11
+ <meta name="keywords" content="ruby,module,RubyXL::OOXMLObjectInstanceMethods">
12
+
13
+
14
+ <meta name="description" content="Documentation for the RubyXL::OOXMLObjectInstanceMethods module">
15
+
16
+
17
+
6
18
 
7
- <title>module RubyXL::OOXMLObjectInstanceMethods - rubyXL 3.4.34</title>
8
19
 
9
20
  <script type="text/javascript">
10
21
  var rdoc_rel_prefix = "../";
@@ -21,8 +32,14 @@
21
32
  <link href="../css/rdoc.css" rel="stylesheet">
22
33
 
23
34
 
35
+
24
36
  <body id="top" role="document" class="module">
25
- <nav role="navigation">
37
+ <div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
38
+ <span aria-hidden="true">&#9776;</span>
39
+ </div>
40
+
41
+
42
+ <nav id="navigation" role="navigation">
26
43
  <div id="project-navigation">
27
44
  <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
45
  <h2>
@@ -55,41 +72,90 @@
55
72
 
56
73
 
57
74
 
58
- <div id="class-metadata">
59
-
60
-
61
-
62
-
75
+
76
+
77
+
78
+
79
+
80
+
81
+
63
82
  <div id="extends-section" class="nav-section">
64
83
  <h3>Extended With Modules</h3>
65
84
 
66
85
  <ul class="link-list">
67
- <li><a class="extend" href="OOXMLObjectClassMethods.html">RubyXL::OOXMLObjectClassMethods</a>
68
- </ul>
69
- </div>
70
86
 
71
-
72
- <!-- Method Quickref -->
73
- <div id="method-list-section" class="nav-section">
74
- <h3>Methods</h3>
75
-
76
- <ul class="link-list" role="directory">
77
- <li ><a href="#method-c-included">::included</a>
78
- <li ><a href="#method-c-new">::new</a>
79
- <li ><a href="#method-i-3D-3D">#==</a>
80
- <li ><a href="#method-i-before_write_xml">#before_write_xml</a>
81
- <li ><a href="#method-i-get_node_object">#get_node_object</a>
82
- <li ><a href="#method-i-index_in_collection">#index_in_collection</a>
83
- <li ><a href="#method-i-init_child_nodes">#init_child_nodes</a>
84
- <li ><a href="#method-i-write_xml">#write_xml</a>
87
+
88
+ <li><a class="extend" href="OOXMLObjectClassMethods.html">RubyXL::OOXMLObjectClassMethods</a></li>
89
+
90
+
85
91
  </ul>
86
92
  </div>
87
93
 
94
+
95
+
96
+ <div class="nav-section">
97
+ <h3>Class Methods</h3>
98
+ <ul class="link-list" role="directory">
99
+
100
+ <li ><a href="#method-c-included">included</a></li>
101
+
102
+ <li ><a href="#method-c-new">new</a></li>
103
+
104
+ </ul>
88
105
  </div>
106
+
107
+
108
+
109
+ <div class="nav-section">
110
+ <h3>Instance Methods</h3>
111
+ <ul class="link-list" role="directory">
112
+
113
+ <li ><a href="#method-i-3D-3D">==</a></li>
114
+
115
+ <li ><a href="#method-i-before_write_xml">before_write_xml</a></li>
116
+
117
+ <li ><a href="#method-i-get_node_object">get_node_object</a></li>
118
+
119
+ <li ><a href="#method-i-index_in_collection">index_in_collection</a></li>
120
+
121
+ <li ><a href="#method-i-init_child_nodes">init_child_nodes</a></li>
122
+
123
+ <li ><a href="#method-i-write_xml">write_xml</a></li>
124
+
125
+ </ul>
126
+ </div>
127
+
128
+
129
+
130
+ <footer id="validator-badges" role="contentinfo">
131
+ <p><a href="https://validator.w3.org/check/referer">Validate</a></p>
132
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.15.1.</p>
133
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>
134
+ </footer>
135
+
89
136
  </nav>
90
137
 
91
138
  <main role="main" aria-labelledby="module-RubyXL::OOXMLObjectInstanceMethods">
92
- <h1 id="module-RubyXL::OOXMLObjectInstanceMethods" class="module">
139
+
140
+
141
+ <ol role="navigation" aria-label="Breadcrumb navigation" class="breadcrumb">
142
+
143
+ <li>
144
+
145
+ <a href="../RubyXL.html">RubyXL</a><span>::</span>
146
+
147
+ </li>
148
+
149
+ <li>
150
+
151
+ <span>OOXMLObjectInstanceMethods</span>
152
+
153
+ </li>
154
+
155
+ </ol>
156
+
157
+
158
+ <h1 id="module-RubyXL::OOXMLObjectInstanceMethods" class="anchor-link module">
93
159
  module RubyXL::OOXMLObjectInstanceMethods
94
160
  </h1>
95
161
 
@@ -97,44 +163,69 @@
97
163
 
98
164
  </section>
99
165
 
100
- <section id="5Buntitled-5D" class="documentation-section">
166
+
167
+ <section id="5Buntitled-5D" class="documentation-section anchor-link">
101
168
 
102
169
 
103
170
 
104
- <section class="attribute-method-details" class="method-section">
171
+
172
+
173
+
174
+
175
+ <section class="attribute-method-details method-section">
105
176
  <header>
106
177
  <h3>Attributes</h3>
107
178
  </header>
108
179
 
109
- <div id="attribute-i-local_namespaces" class="method-detail">
180
+
181
+ <div id="attribute-i-local_namespaces" class="method-detail anchor-link">
110
182
  <div class="method-heading attribute-method-heading">
111
- <span class="method-name">local_namespaces</span><span
112
- class="attribute-access-type">[RW]</span>
183
+ <a href="#attribute-i-local_namespaces" title="Link to this attribute">
184
+ <span class="method-name">local_namespaces</span>
185
+ <span class="attribute-access-type">[RW]</span>
186
+ </a>
113
187
  </div>
114
188
 
115
189
  <div class="method-description">
190
+
191
+
116
192
 
193
+
117
194
  </div>
118
195
  </div>
196
+
119
197
  </section>
120
198
 
121
199
 
122
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
200
+
201
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section anchor-link">
123
202
  <header>
124
203
  <h3>Public Class Methods</h3>
125
204
  </header>
126
205
 
127
- <div id="method-c-included" class="method-detail ">
206
+
207
+ <div id="method-c-included" class="method-detail anchor-link ">
128
208
  <div class="method-header">
129
- <div class="method-heading">
130
- <span class="method-name">included</span><span
131
- class="method-args">(klass)</span>
132
- <span class="method-click-advice">click to toggle source</span>
133
- </div>
209
+
210
+ <div class="method-heading">
211
+ <a href="#method-c-included" title="Link to this method">
212
+ <span class="method-name">included</span>
213
+ <span class="method-args">(klass)</span>
214
+ </a>
215
+ </div>
216
+
134
217
  </div>
135
218
 
219
+
220
+ <div class="method-controls">
221
+ <details class="method-source-toggle">
222
+ <summary>Source</summary>
223
+ </details>
224
+ </div>
225
+
226
+
227
+
136
228
  <div class="method-description">
137
-
138
229
 
139
230
  <div class="method-source-code" id="included-source">
140
231
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 222</span>
@@ -142,22 +233,43 @@
142
233
  <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">OOXMLObjectClassMethods</span>
143
234
  <span class="ruby-keyword">end</span></pre>
144
235
  </div>
236
+
237
+
238
+
239
+
240
+
241
+
145
242
  </div>
146
243
 
147
244
 
245
+
246
+
247
+
148
248
  </div>
149
249
 
150
- <div id="method-c-new" class="method-detail ">
250
+
251
+ <div id="method-c-new" class="method-detail anchor-link ">
151
252
  <div class="method-header">
152
- <div class="method-heading">
153
- <span class="method-name">new</span><span
154
- class="method-args">(params = nil)</span>
155
- <span class="method-click-advice">click to toggle source</span>
156
- </div>
253
+
254
+ <div class="method-heading">
255
+ <a href="#method-c-new" title="Link to this method">
256
+ <span class="method-name">new</span>
257
+ <span class="method-args">(params = nil)</span>
258
+ </a>
259
+ </div>
260
+
157
261
  </div>
158
262
 
263
+
264
+ <div class="method-controls">
265
+ <details class="method-source-toggle">
266
+ <summary>Source</summary>
267
+ </details>
268
+ </div>
269
+
270
+
271
+
159
272
  <div class="method-description">
160
-
161
273
 
162
274
  <div class="method-source-code" id="new-source">
163
275
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 231</span>
@@ -172,29 +284,51 @@
172
284
  <span class="ruby-identifier">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
173
285
  <span class="ruby-keyword">end</span></pre>
174
286
  </div>
287
+
288
+
289
+
290
+
291
+
292
+
175
293
  </div>
176
294
 
177
295
 
296
+
297
+
298
+
178
299
  </div>
179
300
 
301
+
180
302
  </section>
181
303
 
182
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
304
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section anchor-link">
183
305
  <header>
184
306
  <h3>Public Instance Methods</h3>
185
307
  </header>
186
308
 
187
- <div id="method-i-3D-3D" class="method-detail ">
309
+
310
+ <div id="method-i-3D-3D" class="method-detail anchor-link ">
188
311
  <div class="method-header">
189
- <div class="method-heading">
190
- <span class="method-name">==</span><span
191
- class="method-args">(other)</span>
192
- <span class="method-click-advice">click to toggle source</span>
193
- </div>
312
+
313
+ <div class="method-heading">
314
+ <a href="#method-i-3D-3D" title="Link to this method">
315
+ <span class="method-name">==</span>
316
+ <span class="method-args">(other)</span>
317
+ </a>
318
+ </div>
319
+
194
320
  </div>
195
321
 
322
+
323
+ <div class="method-controls">
324
+ <details class="method-source-toggle">
325
+ <summary>Source</summary>
326
+ </details>
327
+ </div>
328
+
329
+
330
+
196
331
  <div class="method-description">
197
-
198
332
 
199
333
  <div class="method-source-code" id="3D-3D-source">
200
334
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 260</span>
@@ -204,22 +338,43 @@
204
338
  <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>).<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">_k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) }
205
339
  <span class="ruby-keyword">end</span></pre>
206
340
  </div>
341
+
342
+
343
+
344
+
345
+
346
+
207
347
  </div>
208
348
 
209
349
 
350
+
351
+
352
+
210
353
  </div>
211
354
 
212
- <div id="method-i-before_write_xml" class="method-detail ">
355
+
356
+ <div id="method-i-before_write_xml" class="method-detail anchor-link ">
213
357
  <div class="method-header">
214
- <div class="method-heading">
215
- <span class="method-name">before_write_xml</span><span
216
- class="method-args">()</span>
217
- <span class="method-click-advice">click to toggle source</span>
218
- </div>
358
+
359
+ <div class="method-heading">
360
+ <a href="#method-i-before_write_xml" title="Link to this method">
361
+ <span class="method-name">before_write_xml</span>
362
+ <span class="method-args">()</span>
363
+ </a>
364
+ </div>
365
+
219
366
  </div>
220
367
 
368
+
369
+ <div class="method-controls">
370
+ <details class="method-source-toggle">
371
+ <summary>Source</summary>
372
+ </details>
373
+ </div>
374
+
375
+
376
+
221
377
  <div class="method-description">
222
- <p>Subclass provided filter to perform last-minute operations (cleanup, count, etc.) immediately prior to write, along with option to terminate the actual write if <code>false</code> is returned (for example, to avoid writing the collection’s root node if the collection is empty).</p>
223
378
 
224
379
  <div class="method-source-code" id="before_write_xml-source">
225
380
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 359</span>
@@ -232,22 +387,43 @@
232
387
  <span class="ruby-keyword">true</span>
233
388
  <span class="ruby-keyword">end</span></pre>
234
389
  </div>
390
+
391
+
392
+
393
+ <p>Subclass provided filter to perform last-minute operations (cleanup, count, etc.) immediately prior to write, along with option to terminate the actual write if <code>false</code> is returned (for example, to avoid writing the collection’s root node if the collection is empty).</p>
394
+
395
+
235
396
  </div>
236
397
 
237
398
 
399
+
400
+
401
+
238
402
  </div>
239
403
 
240
- <div id="method-i-index_in_collection" class="method-detail ">
404
+
405
+ <div id="method-i-index_in_collection" class="method-detail anchor-link ">
241
406
  <div class="method-header">
242
- <div class="method-heading">
243
- <span class="method-name">index_in_collection</span><span
244
- class="method-args">()</span>
245
- <span class="method-click-advice">click to toggle source</span>
246
- </div>
407
+
408
+ <div class="method-heading">
409
+ <a href="#method-i-index_in_collection" title="Link to this method">
410
+ <span class="method-name">index_in_collection</span>
411
+ <span class="method-args">()</span>
412
+ </a>
413
+ </div>
414
+
247
415
  </div>
248
416
 
417
+
418
+ <div class="method-controls">
419
+ <details class="method-source-toggle">
420
+ <summary>Source</summary>
421
+ </details>
422
+ </div>
423
+
424
+
425
+
249
426
  <div class="method-description">
250
- <p>Prototype method. For sparse collections (<code>Rows</code>, <code>Cells</code>, etc.) must return index at which this object is expected to reside in the collection. If <code>nil</code> is returned, then object is simply added to the end of the collection.</p>
251
427
 
252
428
  <div class="method-source-code" id="index_in_collection-source">
253
429
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 347</span>
@@ -255,46 +431,43 @@
255
431
  <span class="ruby-keyword">nil</span>
256
432
  <span class="ruby-keyword">end</span></pre>
257
433
  </div>
258
- </div>
259
434
 
260
435
 
261
- </div>
262
436
 
263
- <div id="method-i-write_xml" class="method-detail ">
264
- <div class="method-header">
265
- <div class="method-heading">
266
- <span class="method-name">write_xml</span><span
267
- class="method-args">(xml = nil, node_name_override = nil)</span>
268
- <span class="method-click-advice">click to toggle source</span>
269
- </div>
437
+ <p>Prototype method. For sparse collections (<code>Rows</code>, <code>Cells</code>, etc.) must return index at which this object is expected to reside in the collection. If <code>nil</code> is returned, then object is simply added to the end of the collection.</p>
438
+
439
+
270
440
  </div>
271
441
 
272
- <div class="method-description">
273
- <p>Recursively write the OOXML object and all its children out as Nokogiri::XML. Immediately before the actual generation, +before_write_xml()+ is called to perform last-minute cleanup and validation operations; if it returns <code>false</code>, an empty string is returned (rather than <code>nil</code>, so Nokogiri::XML’s <code>&amp;lt;&amp;lt;</code> operator can be used without additional <code>nil</code> checking)</p>
274
442
 
275
- <h3 id="method-i-write_xml-label-Parameters">Parameters<span><a href="#method-i-write_xml-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
276
- <ul><li>
277
- <p><code>xml</code> - Base Nokogiri::XML object used for building. If omitted, a blank document will be generated.</p>
278
- </li><li>
279
- <p><code>node_name_override</code> - if present, is used instead of the default element name for this object provided by <code>define_element_name</code></p>
280
- </li></ul>
281
443
 
282
- <h4 id="method-i-write_xml-label-Examples">Examples<span><a href="#method-i-write_xml-label-Examples">&para;</a> <a href="#top">&uarr;</a></span></h4>
283
444
 
284
- <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>()
285
- </pre>
286
445
 
287
- <p>Creates a new empty <code>Nokogiri::XML</code>, populates it with the OOXML structure as described in the respective definition, and returns the resulting <code>Nokogiri::XML</code> object.</p>
446
+ </div>
288
447
 
289
- <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>)
290
- </pre>
291
448
 
292
- <p>Using the passed-in <code>Nokogiri</code> <code>xml</code> object, creates a new element corresponding to <code>obj</code> according to its definition, along with all its properties and children, and returns the newly created element.</p>
449
+ <div id="method-i-write_xml" class="method-detail anchor-link ">
450
+ <div class="method-header">
293
451
 
294
- <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>, <span class="ruby-string">&#39;overriden_element_name&#39;</span>)
295
- </pre>
452
+ <div class="method-heading">
453
+ <a href="#method-i-write_xml" title="Link to this method">
454
+ <span class="method-name">write_xml</span>
455
+ <span class="method-args">(xml = nil, node_name_override = nil)</span>
456
+ </a>
457
+ </div>
458
+
459
+ </div>
296
460
 
297
- <p>Same as above, but uses the passed-in <code>node_name_override</code> as the new element name, instead of its default name set by <code>define_element_name</code>.</p>
461
+
462
+ <div class="method-controls">
463
+ <details class="method-source-toggle">
464
+ <summary>Source</summary>
465
+ </details>
466
+ </div>
467
+
468
+
469
+
470
+ <div class="method-description">
298
471
 
299
472
  <div class="method-source-code" id="write_xml-source">
300
473
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 280</span>
@@ -362,29 +535,75 @@
362
535
  <span class="ruby-identifier">elem</span>
363
536
  <span class="ruby-keyword">end</span></pre>
364
537
  </div>
538
+
539
+
540
+
541
+ <p>Recursively write the OOXML object and all its children out as Nokogiri::XML. Immediately before the actual generation, +before_write_xml()+ is called to perform last-minute cleanup and validation operations; if it returns <code>false</code>, an empty string is returned (rather than <code>nil</code>, so Nokogiri::XML’s <code>&amp;lt;&amp;lt;</code> operator can be used without additional <code>nil</code> checking)</p>
542
+
543
+ <h3 id="method-i-write_xml-label-Parameters">Parameters<span><a href="#method-i-write_xml-label-Parameters">&para;</a> <a href="#top">&uarr;</a></span></h3>
544
+ <ul><li>
545
+ <p><code>xml</code> - Base Nokogiri::XML object used for building. If omitted, a blank document will be generated.</p>
546
+ </li><li>
547
+ <p><code>node_name_override</code> - if present, is used instead of the default element name for this object provided by <code>define_element_name</code></p>
548
+ </li></ul>
549
+
550
+ <h4 id="method-i-write_xml-label-Examples">Examples<span><a href="#method-i-write_xml-label-Examples">&para;</a> <a href="#top">&uarr;</a></span></h4>
551
+
552
+ <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>()
553
+ </pre>
554
+
555
+ <p>Creates a new empty <code>Nokogiri::XML</code>, populates it with the OOXML structure as described in the respective definition, and returns the resulting <code>Nokogiri::XML</code> object.</p>
556
+
557
+ <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>)
558
+ </pre>
559
+
560
+ <p>Using the passed-in <code>Nokogiri</code> <code>xml</code> object, creates a new element corresponding to <code>obj</code> according to its definition, along with all its properties and children, and returns the newly created element.</p>
561
+
562
+ <pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>, <span class="ruby-string">&#39;overriden_element_name&#39;</span>)
563
+ </pre>
564
+
565
+ <p>Same as above, but uses the passed-in <code>node_name_override</code> as the new element name, instead of its default name set by <code>define_element_name</code>.</p>
566
+
567
+
365
568
  </div>
366
569
 
367
570
 
571
+
572
+
573
+
368
574
  </div>
369
575
 
576
+
370
577
  </section>
371
578
 
372
- <section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
579
+ <section id="protected-instance-5Buntitled-5D-method-details" class="method-section anchor-link">
373
580
  <header>
374
581
  <h3>Protected Instance Methods</h3>
375
582
  </header>
376
583
 
377
- <div id="method-i-get_node_object" class="method-detail ">
584
+
585
+ <div id="method-i-get_node_object" class="method-detail anchor-link ">
378
586
  <div class="method-header">
379
- <div class="method-heading">
380
- <span class="method-name">get_node_object</span><span
381
- class="method-args">(child_node_params)</span>
382
- <span class="method-click-advice">click to toggle source</span>
383
- </div>
587
+
588
+ <div class="method-heading">
589
+ <a href="#method-i-get_node_object" title="Link to this method">
590
+ <span class="method-name">get_node_object</span>
591
+ <span class="method-args">(child_node_params)</span>
592
+ </a>
593
+ </div>
594
+
384
595
  </div>
385
596
 
597
+
598
+ <div class="method-controls">
599
+ <details class="method-source-toggle">
600
+ <summary>Source</summary>
601
+ </details>
602
+ </div>
603
+
604
+
605
+
386
606
  <div class="method-description">
387
-
388
607
 
389
608
  <div class="method-source-code" id="get_node_object-source">
390
609
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 351</span>
@@ -392,22 +611,43 @@
392
611
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">child_node_params</span>[<span class="ruby-value">:accessor</span>])
393
612
  <span class="ruby-keyword">end</span></pre>
394
613
  </div>
614
+
615
+
616
+
617
+
618
+
619
+
395
620
  </div>
396
621
 
397
622
 
623
+
624
+
625
+
398
626
  </div>
399
627
 
400
- <div id="method-i-init_child_nodes" class="method-detail ">
628
+
629
+ <div id="method-i-init_child_nodes" class="method-detail anchor-link ">
401
630
  <div class="method-header">
402
- <div class="method-heading">
403
- <span class="method-name">init_child_nodes</span><span
404
- class="method-args">(params)</span>
405
- <span class="method-click-advice">click to toggle source</span>
406
- </div>
631
+
632
+ <div class="method-heading">
633
+ <a href="#method-i-init_child_nodes" title="Link to this method">
634
+ <span class="method-name">init_child_nodes</span>
635
+ <span class="method-args">(params)</span>
636
+ </a>
637
+ </div>
638
+
407
639
  </div>
408
640
 
641
+
642
+ <div class="method-controls">
643
+ <details class="method-source-toggle">
644
+ <summary>Source</summary>
645
+ </details>
646
+ </div>
647
+
648
+
649
+
409
650
  <div class="method-description">
410
-
411
651
 
412
652
  <div class="method-source-code" id="init_child_nodes-source">
413
653
  <pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 242</span>
@@ -423,20 +663,25 @@
423
663
  }
424
664
  <span class="ruby-keyword">end</span></pre>
425
665
  </div>
666
+
667
+
668
+
669
+
670
+
671
+
426
672
  </div>
427
673
 
428
674
 
675
+
676
+
677
+
429
678
  </div>
430
679
 
680
+
431
681
  </section>
432
682
 
433
683
  </section>
434
- </main>
435
-
436
684
 
437
- <footer id="validator-badges" role="contentinfo">
438
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
439
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.3.1.
440
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
441
- </footer>
685
+ </main>
686
+ </body>
442
687