spire-xls 15.5.0__py3-none-win_amd64.whl → 15.7.1__py3-none-win_amd64.whl

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 (1032) hide show
  1. spire/xls/AddtionalFormatWrapper.py +98 -117
  2. spire/xls/Average.py +18 -4
  3. spire/xls/CellBaseStyle.py +13 -6
  4. spire/xls/CellBorder.py +25 -20
  5. spire/xls/CellRange.py +305 -269
  6. spire/xls/CellStyle.py +26 -12
  7. spire/xls/CellStyleFlag.py +181 -58
  8. spire/xls/CellStyleObject.py +36 -67
  9. spire/xls/CellValueChangedEventArgs.py +3 -9
  10. spire/xls/ColorScale.py +31 -39
  11. spire/xls/CommentsRange.py +185 -84
  12. spire/xls/CommonWrapper.py +23 -8
  13. spire/xls/ConverterSetting.py +19 -36
  14. spire/xls/DBConnection.py +41 -8
  15. spire/xls/DVAspect.py +8 -2
  16. spire/xls/DataBar.py +29 -28
  17. spire/xls/DocumentProperty.py +86 -38
  18. spire/xls/Excel2016Charttype.py +14 -2
  19. spire/xls/ExcelComment.py +1 -2
  20. spire/xls/ExcelCommentObject.py +206 -121
  21. spire/xls/ExcelFont.py +74 -59
  22. spire/xls/ExcelGradient.py +68 -24
  23. spire/xls/ExcelInterior.py +49 -20
  24. spire/xls/ExportTableOptions.py +33 -10
  25. spire/xls/ExternalConnection.py +85 -20
  26. spire/xls/ExternalLink.py +26 -10
  27. spire/xls/FileFormat.py +32 -4
  28. spire/xls/Font.py +95 -42
  29. spire/xls/FontArrayWrapper.py +135 -36
  30. spire/xls/FontWrapper.py +194 -92
  31. spire/xls/Format3D.py +130 -30
  32. spire/xls/GeomertyAdjustValue.py +22 -10
  33. spire/xls/GetText.py +8 -2
  34. spire/xls/GoalSeek.py +44 -14
  35. spire/xls/GoalSeekResult.py +36 -3
  36. spire/xls/GradientArrayWrapper.py +92 -28
  37. spire/xls/GradientStops.py +74 -24
  38. spire/xls/GradientType.py +10 -2
  39. spire/xls/GroupShape.py +1 -2
  40. spire/xls/HPageBreak.py +1 -2
  41. spire/xls/HTMLOptions.py +7 -19
  42. spire/xls/HyperLink.py +1 -2
  43. spire/xls/LOGFONT.py +78 -30
  44. spire/xls/OColor.py +62 -29
  45. spire/xls/OdsPageBackground.py +5 -10
  46. spire/xls/PageColRow.py +21 -10
  47. spire/xls/PageSetup.py +2 -3
  48. spire/xls/PaperSizeEntry.py +6 -0
  49. spire/xls/PicStretch.py +47 -14
  50. spire/xls/PicTile.py +35 -10
  51. spire/xls/QueryTableXls.py +19 -6
  52. spire/xls/RTFCommentArray.py +59 -22
  53. spire/xls/RTFStringArray.py +59 -22
  54. spire/xls/RangeRichTextString.py +20 -8
  55. spire/xls/ReferRangeArea.py +39 -16
  56. spire/xls/RichText.py +10 -8
  57. spire/xls/RichTextObject.py +63 -32
  58. spire/xls/RichTextShape.py +88 -32
  59. spire/xls/RichTextString.py +61 -24
  60. spire/xls/RtfTextWriter.py +68 -22
  61. spire/xls/SaveShapeTypeOption.py +19 -37
  62. spire/xls/ShapeGlow.py +34 -14
  63. spire/xls/ShapeReflection.py +55 -18
  64. spire/xls/StyleArrayWrapper.py +169 -78
  65. spire/xls/TextBoxShapeBase.py +63 -30
  66. spire/xls/TextSaveOptions.py +33 -18
  67. spire/xls/TopBottom.py +18 -6
  68. spire/xls/VPageBreak.py +3 -5
  69. spire/xls/Validation.py +12 -6
  70. spire/xls/WebQueryConnection.py +52 -20
  71. spire/xls/Workbook.py +810 -841
  72. spire/xls/Worksheet.py +444 -409
  73. spire/xls/WriteProtection.py +3 -6
  74. spire/xls/XlsAddInFunction.py +34 -20
  75. spire/xls/XlsArcShape.py +156 -40
  76. spire/xls/XlsBitmapShape.py +141 -43
  77. spire/xls/XlsBorder.py +72 -31
  78. spire/xls/XlsBorderArrayWrapper.py +50 -14
  79. spire/xls/XlsButtonShape.py +58 -16
  80. spire/xls/XlsCheckBoxShape.py +72 -18
  81. spire/xls/XlsComboBoxShape.py +53 -16
  82. spire/xls/XlsComment.py +108 -30
  83. spire/xls/XlsDataValidationTable.py +43 -16
  84. spire/xls/XlsDocumentProperty.py +163 -44
  85. spire/xls/XlsEventArgs.py +33 -24
  86. spire/xls/XlsEventHandler.py +10 -4
  87. spire/xls/XlsFill.py +64 -20
  88. spire/xls/XlsFont.py +182 -52
  89. spire/xls/XlsGradient.py +90 -26
  90. spire/xls/XlsGradientStop.py +57 -12
  91. spire/xls/XlsGroupBoxShape.py +36 -10
  92. spire/xls/XlsHPageBreak.py +47 -24
  93. spire/xls/XlsHyperLink.py +111 -42
  94. spire/xls/XlsLabelShape.py +27 -8
  95. spire/xls/XlsLineShape.py +188 -48
  96. spire/xls/XlsListBoxShape.py +63 -14
  97. spire/xls/XlsName.py +767 -318
  98. spire/xls/XlsObject.py +2 -4
  99. spire/xls/XlsOvalShape.py +78 -20
  100. spire/xls/XlsPageSetup.py +67 -34
  101. spire/xls/XlsPageSetupBase.py +29 -58
  102. spire/xls/XlsPrstGeomShape.py +29 -10
  103. spire/xls/XlsRadioButtonShape.py +94 -22
  104. spire/xls/XlsRange.py +881 -1077
  105. spire/xls/XlsRectangleShape.py +69 -22
  106. spire/xls/XlsScrollBarShape.py +78 -18
  107. spire/xls/XlsShape.py +391 -180
  108. spire/xls/XlsShapeFill.py +398 -92
  109. spire/xls/XlsShapeLineFormat.py +201 -44
  110. spire/xls/XlsSpinnerShape.py +57 -14
  111. spire/xls/XlsStyle.py +51 -20
  112. spire/xls/XlsTextBoxShape.py +263 -60
  113. spire/xls/XlsVPageBreak.py +9 -14
  114. spire/xls/XlsValidation.py +318 -68
  115. spire/xls/XlsValidationWrapper.py +217 -49
  116. spire/xls/XlsWorkbook.py +529 -65
  117. spire/xls/XlsWorksheet.py +1211 -1128
  118. spire/xls/XlsWorksheetBase.py +243 -168
  119. spire/xls/__init__.py +529 -528
  120. spire/xls/autofilter/AutoFitterOptions.py +84 -0
  121. spire/xls/autofilter/ColorFilter.py +61 -0
  122. spire/xls/autofilter/CustomFilter.py +199 -0
  123. spire/xls/autofilter/CustomFilterCollection.py +146 -0
  124. spire/xls/autofilter/DateTimeGroupItem.py +196 -0
  125. spire/xls/autofilter/DynamicFilter.py +89 -0
  126. spire/xls/autofilter/FilterColumn.py +289 -0
  127. spire/xls/autofilter/MultipleFilterCollection.py +218 -0
  128. spire/xls/autofilter/Top10Filter.py +109 -0
  129. spire/xls/autofilter/XlsAutoFiltersCollection.py +145 -0
  130. spire/xls/charts/Chart.py +369 -0
  131. spire/xls/charts/ChartArea.py +57 -0
  132. spire/xls/charts/ChartBackgroundMode.py +17 -0
  133. spire/xls/charts/ChartCategoryAxis.py +88 -0
  134. spire/xls/charts/ChartDataLabels.py +40 -0
  135. spire/xls/charts/ChartDataPoint.py +40 -0
  136. spire/xls/charts/ChartFormat.py +68 -0
  137. spire/xls/charts/ChartGridLine.py +26 -0
  138. spire/xls/charts/ChartLegend.py +40 -0
  139. spire/xls/charts/ChartLegendEntriesColl.py +165 -0
  140. spire/xls/charts/ChartLegendEntry.py +26 -0
  141. spire/xls/charts/ChartPlotArea.py +60 -0
  142. spire/xls/charts/ChartSerie.py +147 -0
  143. spire/xls/charts/ChartSerieDataFormat.py +54 -0
  144. spire/xls/charts/ChartSeriesAxis.py +68 -0
  145. spire/xls/charts/ChartShadow.py +288 -0
  146. spire/xls/charts/ChartSheet.py +269 -0
  147. spire/xls/charts/ChartTextArea.py +898 -0
  148. spire/xls/charts/ChartValueAxis.py +90 -0
  149. spire/xls/charts/HistogramAxisFormat.py +32 -0
  150. spire/xls/charts/XlsChart.py +1667 -0
  151. spire/xls/charts/XlsChartAxis.py +596 -0
  152. spire/xls/charts/XlsChartBorder.py +180 -0
  153. spire/xls/charts/XlsChartCategoryAxis.py +640 -0
  154. spire/xls/charts/XlsChartDataLabelArea.py +368 -0
  155. spire/xls/charts/XlsChartDataLabels.py +702 -0
  156. spire/xls/charts/XlsChartDataPoint.py +105 -0
  157. spire/xls/charts/XlsChartDataTable.py +373 -0
  158. spire/xls/charts/XlsChartDropBar.py +295 -0
  159. spire/xls/charts/XlsChartFill.py +659 -0
  160. spire/xls/charts/XlsChartFormat.py +1229 -0
  161. spire/xls/charts/XlsChartFrameFormat.py +612 -0
  162. spire/xls/charts/XlsChartGridLine.py +167 -0
  163. spire/xls/charts/XlsChartInterior.py +229 -0
  164. spire/xls/charts/XlsChartLegend.py +334 -0
  165. spire/xls/charts/XlsChartLegendArea.py +418 -0
  166. spire/xls/charts/XlsChartLegendEntry.py +152 -0
  167. spire/xls/charts/XlsChartSerie.py +607 -0
  168. spire/xls/charts/XlsChartSerieDataFormat.py +1070 -0
  169. spire/xls/charts/XlsChartSeriesAxis.py +306 -0
  170. spire/xls/charts/XlsChartShape.py +1256 -0
  171. spire/xls/charts/XlsChartTitleArea.py +399 -0
  172. spire/xls/charts/XlsChartValueAxis.py +344 -0
  173. spire/xls/charts/XlsChartWallOrFloor.py +349 -0
  174. spire/xls/charts/__init__.py +0 -0
  175. spire/xls/collection/AddInFunctionsCollection.py +31 -0
  176. spire/xls/collection/ArcShapeCollection.py +94 -0
  177. spire/xls/collection/AutoFiltersCollection.py +538 -0
  178. spire/xls/collection/BordersCollection.py +196 -0
  179. spire/xls/collection/BordersCollectionArrayWrapper.py +129 -0
  180. spire/xls/collection/BuiltInDocumentProperties.py +12 -0
  181. spire/xls/collection/ChartDataPointsCollection.py +72 -0
  182. spire/xls/collection/ChartFormatCollection.py +58 -0
  183. spire/xls/collection/ChartSeries.py +187 -0
  184. spire/xls/collection/ChartsCollection.py +119 -0
  185. spire/xls/collection/CollectionBase.py +201 -0
  186. spire/xls/collection/CollectionExtended.py +96 -0
  187. spire/xls/collection/ComboBoxCollection.py +89 -0
  188. spire/xls/collection/CommentsCollection.py +134 -0
  189. spire/xls/collection/GroupShapeCollection.py +45 -0
  190. spire/xls/collection/HPageBreaksCollection.py +116 -0
  191. spire/xls/collection/HyperLinksCollection.py +72 -0
  192. spire/xls/collection/ListObjectCollection.py +48 -0
  193. spire/xls/collection/OvalShapeCollection.py +89 -0
  194. spire/xls/collection/PicturesCollection.py +574 -0
  195. spire/xls/collection/PrstGeomShapeCollection.py +128 -0
  196. spire/xls/collection/RadioButtonCollection.py +139 -0
  197. spire/xls/collection/RangesCollection.py +555 -0
  198. spire/xls/collection/StylesCollection.py +140 -0
  199. spire/xls/collection/VPageBreaksCollection.py +95 -0
  200. spire/xls/collection/WorksheetsCollection.py +363 -0
  201. spire/xls/collection/XlsAddInFunctionsCollection.py +108 -0
  202. spire/xls/collection/XlsBordersCollection.py +98 -0
  203. spire/xls/collection/XlsBuiltInDocumentProperties.py +611 -0
  204. spire/xls/collection/XlsChartDataPointsCollection.py +119 -0
  205. spire/xls/collection/XlsChartFormatCollection.py +160 -0
  206. spire/xls/collection/XlsCommentsCollection.py +116 -0
  207. spire/xls/collection/XlsDataValidationCollection.py +155 -0
  208. spire/xls/collection/XlsHPageBreaksCollection.py +87 -0
  209. spire/xls/collection/XlsHyperLinksCollection.py +104 -0
  210. spire/xls/collection/XlsRangesCollection.py +1634 -0
  211. spire/xls/collection/XlsStylesCollection.py +74 -0
  212. spire/xls/collection/XlsVPageBreaksCollection.py +81 -0
  213. spire/xls/collection/XlsWorksheetsCollection.py +423 -0
  214. spire/xls/collection/__init__.py +0 -0
  215. spire/xls/collection/pivot_table/PivotConditionalFormatCollection.py +38 -0
  216. spire/xls/collection/pivot_table/PivotTableFields.py +108 -0
  217. spire/xls/collection/pivot_table/XlsPivotCachesCollection.py +123 -0
  218. spire/xls/collection/pivot_table/__init__.py +0 -0
  219. spire/xls/conditional_formatting/ColorConditionValue.py +102 -0
  220. spire/xls/conditional_formatting/CondFormatCollectionWrapper.py +153 -0
  221. spire/xls/conditional_formatting/ConditionValue.py +83 -0
  222. spire/xls/conditional_formatting/ConditionValuePosition.py +16 -0
  223. spire/xls/conditional_formatting/ConditionalFormat.py +13 -0
  224. spire/xls/conditional_formatting/ConditionalFormatScope.py +16 -0
  225. spire/xls/conditional_formatting/ConditionalFormatWrapper.py +1271 -0
  226. spire/xls/conditional_formatting/ConditionalFormats.py +65 -0
  227. spire/xls/conditional_formatting/DataBarBorder.py +51 -0
  228. spire/xls/conditional_formatting/NegativeBarFormat.py +90 -0
  229. spire/xls/conditional_formatting/XlsConditionValue.py +134 -0
  230. spire/xls/conditional_formatting/XlsConditionalFormat.py +1155 -0
  231. spire/xls/conditional_formatting/XlsConditionalFormats.py +679 -0
  232. spire/xls/conditional_formatting/__init__.py +0 -0
  233. spire/xls/enums/AlertStyleType.py +17 -0
  234. spire/xls/enums/AutoFormatOptions.py +22 -0
  235. spire/xls/enums/AutoFormatType.py +31 -0
  236. spire/xls/enums/AverageType.py +24 -0
  237. spire/xls/enums/AxisLineIdentifierType.py +18 -0
  238. spire/xls/enums/AxisTextDirectionType.py +17 -0
  239. spire/xls/enums/AxisType.py +17 -0
  240. spire/xls/enums/BaseFormatType.py +16 -0
  241. spire/xls/enums/BordersLineType.py +22 -0
  242. spire/xls/enums/BubbleSizeType.py +16 -0
  243. spire/xls/enums/BuiltInPropertyType.py +49 -0
  244. spire/xls/enums/BuiltInStyles.py +65 -0
  245. spire/xls/enums/CategoryType.py +17 -0
  246. spire/xls/enums/CellDataType.py +22 -0
  247. spire/xls/enums/CellFormatType.py +20 -0
  248. spire/xls/enums/ChartBaseUnitType.py +17 -0
  249. spire/xls/enums/ChartDisplayUnitType.py +25 -0
  250. spire/xls/enums/ChartLinePatternType.py +23 -0
  251. spire/xls/enums/ChartLineWeightType.py +18 -0
  252. spire/xls/enums/ChartMarkerType.py +26 -0
  253. spire/xls/enums/ChartParagraphType.py +17 -0
  254. spire/xls/enums/ChartPieType.py +17 -0
  255. spire/xls/enums/ChartPlotEmptyType.py +17 -0
  256. spire/xls/enums/CheckState.py +17 -0
  257. spire/xls/enums/ColorType.py +17 -0
  258. spire/xls/enums/CommentHAlignType.py +20 -0
  259. spire/xls/enums/CommentVAlignType.py +19 -0
  260. spire/xls/enums/ComparisonOperatorType.py +23 -0
  261. spire/xls/enums/ConditionalFormatType.py +32 -0
  262. spire/xls/enums/DataLabelPositionType.py +25 -0
  263. spire/xls/enums/DataSourceType.py +18 -0
  264. spire/xls/enums/DropLineStyleType.py +17 -0
  265. spire/xls/enums/ErrorBarIncludeType.py +18 -0
  266. spire/xls/enums/ErrorBarType.py +19 -0
  267. spire/xls/enums/ExcelCalculationMode.py +17 -0
  268. spire/xls/enums/ExcelChartType.py +95 -0
  269. spire/xls/enums/ExcelColors.py +120 -0
  270. spire/xls/enums/ExcelComboType.py +21 -0
  271. spire/xls/enums/ExcelHorizontalAlignment.py +20 -0
  272. spire/xls/enums/ExcelPatternType.py +51 -0
  273. spire/xls/enums/ExcelQuartileCalculation.py +16 -0
  274. spire/xls/enums/ExcelShapeType.py +40 -0
  275. spire/xls/enums/ExcelSheetType.py +19 -0
  276. spire/xls/enums/ExcelTreeMapLabelOption.py +17 -0
  277. spire/xls/enums/ExcelVersion.py +23 -0
  278. spire/xls/enums/ExcelVerticalAlignment.py +20 -0
  279. spire/xls/enums/ExpandCollapseFlags.py +17 -0
  280. spire/xls/enums/FilterConditionType.py +20 -0
  281. spire/xls/enums/FilterDataType.py +21 -0
  282. spire/xls/enums/FontUnderlineType.py +19 -0
  283. spire/xls/enums/FontVertialAlignmentType.py +17 -0
  284. spire/xls/enums/GradientColorType.py +17 -0
  285. spire/xls/enums/GradientPatternType.py +63 -0
  286. spire/xls/enums/GradientPresetType.py +38 -0
  287. spire/xls/enums/GradientStyleType.py +20 -0
  288. spire/xls/enums/GradientTextureType.py +39 -0
  289. spire/xls/enums/GradientVariantsType.py +18 -0
  290. spire/xls/enums/HorizontalAlignType.py +22 -0
  291. spire/xls/enums/HyperLinkType.py +19 -0
  292. spire/xls/enums/IgnoreErrorType.py +23 -0
  293. spire/xls/enums/ImageFormatType.py +17 -0
  294. spire/xls/enums/ImageType.py +16 -0
  295. spire/xls/enums/LegendPositionType.py +20 -0
  296. spire/xls/enums/LegendSpacingType.py +17 -0
  297. spire/xls/enums/LineStyleType.py +28 -0
  298. spire/xls/enums/OleObjectType.py +50 -0
  299. spire/xls/enums/OrderBy.py +18 -0
  300. spire/xls/enums/OrderType.py +16 -0
  301. spire/xls/enums/PageBreakExtentType.py +16 -0
  302. spire/xls/enums/PageBreakType.py +17 -0
  303. spire/xls/enums/PageOrientationType.py +16 -0
  304. spire/xls/enums/PagesOrderType.py +16 -0
  305. spire/xls/enums/PaperSizeType.py +134 -0
  306. spire/xls/enums/PivotGroupByTypes.py +22 -0
  307. spire/xls/enums/PrintCommentType.py +17 -0
  308. spire/xls/enums/PrintErrorsType.py +18 -0
  309. spire/xls/enums/ReadingOrderType.py +17 -0
  310. spire/xls/enums/RectangleStyleType.py +16 -0
  311. spire/xls/enums/ResizeBehaveType.py +17 -0
  312. spire/xls/enums/ShapeArrowLengthType.py +17 -0
  313. spire/xls/enums/ShapeArrowStyleType.py +20 -0
  314. spire/xls/enums/ShapeArrowWidthType.py +17 -0
  315. spire/xls/enums/ShapeDashLineStyleType.py +22 -0
  316. spire/xls/enums/ShapeFillType.py +21 -0
  317. spire/xls/enums/ShapeLayerChangeType.py +18 -0
  318. spire/xls/enums/ShapeLineStyleType.py +19 -0
  319. spire/xls/enums/SheetProtectionType.py +32 -0
  320. spire/xls/enums/SortComparsionType.py +18 -0
  321. spire/xls/enums/SortOrientationType.py +16 -0
  322. spire/xls/enums/SortedWayType.py +17 -0
  323. spire/xls/enums/SparklineType.py +17 -0
  324. spire/xls/enums/SplitType.py +18 -0
  325. spire/xls/enums/TextDirection.py +19 -0
  326. spire/xls/enums/TextRotationType.py +18 -0
  327. spire/xls/enums/ThemeColorType.py +26 -0
  328. spire/xls/enums/TickLabelPositionType.py +18 -0
  329. spire/xls/enums/TickMarkType.py +18 -0
  330. spire/xls/enums/TopBottomType.py +18 -0
  331. spire/xls/enums/TopFormatType.py +17 -0
  332. spire/xls/enums/TrendLineType.py +20 -0
  333. spire/xls/enums/UnknownVariableAction.py +17 -0
  334. spire/xls/enums/ValidationComparisonOperator.py +22 -0
  335. spire/xls/enums/VariableTypeAction.py +17 -0
  336. spire/xls/enums/VerticalAlignType.py +19 -0
  337. spire/xls/enums/ViewMode.py +17 -0
  338. spire/xls/enums/WorksheetVisibility.py +17 -0
  339. spire/xls/enums/XLSXBorderJoinType.py +18 -0
  340. spire/xls/enums/XLSXChartMaterialType.py +31 -0
  341. spire/xls/enums/XLSXChartPrespectiveType.py +20 -0
  342. spire/xls/enums/XLSXChartShadowInnerType.py +24 -0
  343. spire/xls/enums/XLSXChartShadowOuterType.py +24 -0
  344. spire/xls/enums/__init__.py +1 -0
  345. spire/xls/interfaces/IArcShape.py +285 -0
  346. spire/xls/interfaces/IChart.py +1597 -0
  347. spire/xls/interfaces/IChartAxis.py +786 -0
  348. spire/xls/interfaces/IChartBorder.py +203 -0
  349. spire/xls/interfaces/IChartCategoryAxis.py +522 -0
  350. spire/xls/interfaces/IChartDataLabels.py +419 -0
  351. spire/xls/interfaces/IChartDataPoint.py +114 -0
  352. spire/xls/interfaces/IChartDataTable.py +184 -0
  353. spire/xls/interfaces/IChartErrorBars.py +340 -0
  354. spire/xls/interfaces/IChartFillBorder.py +268 -0
  355. spire/xls/interfaces/IChartFormat.py +521 -0
  356. spire/xls/interfaces/IChartFrameFormat.py +85 -0
  357. spire/xls/interfaces/IChartGridLine.py +100 -0
  358. spire/xls/interfaces/IChartInterior.py +259 -0
  359. spire/xls/interfaces/IChartLegend.py +453 -0
  360. spire/xls/interfaces/IChartLegendEntry.py +167 -0
  361. spire/xls/interfaces/IChartPageSetup.py +51 -0
  362. spire/xls/interfaces/IChartSerie.py +727 -0
  363. spire/xls/interfaces/IChartSerieDataFormat.py +519 -0
  364. spire/xls/interfaces/IChartSeriesAxis.py +118 -0
  365. spire/xls/interfaces/IChartShape.py +88 -0
  366. spire/xls/interfaces/IChartTextArea.py +181 -0
  367. spire/xls/interfaces/IChartTrendLine.py +502 -0
  368. spire/xls/interfaces/IChartValueAxis.py +586 -0
  369. spire/xls/interfaces/IChartWallOrFloor.py +40 -0
  370. spire/xls/interfaces/ICheckBox.py +120 -0
  371. spire/xls/interfaces/ICloneParent.py +29 -0
  372. spire/xls/interfaces/IColorConditionValue.py +44 -0
  373. spire/xls/interfaces/IColorScale.py +39 -0
  374. spire/xls/interfaces/ICombinedRange.py +109 -0
  375. spire/xls/interfaces/IComboBoxShape.py +120 -0
  376. spire/xls/interfaces/IComment.py +110 -0
  377. spire/xls/interfaces/ICommentShape.py +20 -0
  378. spire/xls/interfaces/IConditionValue.py +83 -0
  379. spire/xls/interfaces/IConditionalFormat.py +757 -0
  380. spire/xls/interfaces/IConditionalFormats.py +66 -0
  381. spire/xls/interfaces/ICustomDocumentProperties.py +168 -0
  382. spire/xls/interfaces/IDataBar.py +127 -0
  383. spire/xls/interfaces/IDataValidation.py +506 -0
  384. spire/xls/interfaces/IDataValidationTable.py +84 -0
  385. spire/xls/interfaces/IDigitalSignature.py +111 -0
  386. spire/xls/interfaces/IDigitalSignatures.py +33 -0
  387. spire/xls/interfaces/IDocumentProperty.py +276 -0
  388. spire/xls/interfaces/IErrorIndicator.py +38 -0
  389. spire/xls/interfaces/IExtendIndex.py +26 -0
  390. spire/xls/interfaces/IExtendedFormat.py +631 -0
  391. spire/xls/interfaces/IFont.py +313 -0
  392. spire/xls/interfaces/IFormat3D.py +307 -0
  393. spire/xls/interfaces/IGeomPath.py +27 -0
  394. spire/xls/interfaces/IGeomPathInfo.py +141 -0
  395. spire/xls/interfaces/IGeomPathShape.py +40 -0
  396. spire/xls/interfaces/IGlow.py +104 -0
  397. spire/xls/interfaces/IGradient.py +203 -0
  398. spire/xls/interfaces/IGroupBox.py +82 -0
  399. spire/xls/interfaces/IHPageBreak.py +26 -0
  400. spire/xls/interfaces/IHyperLink.py +137 -0
  401. spire/xls/interfaces/IIconSet.py +115 -0
  402. spire/xls/interfaces/IInterior.py +137 -0
  403. spire/xls/interfaces/IInternalAddtionalFormat.py +277 -0
  404. spire/xls/interfaces/IInternalFont.py +38 -0
  405. spire/xls/interfaces/ILabelShape.py +60 -0
  406. spire/xls/interfaces/ILineShape.py +334 -0
  407. spire/xls/interfaces/IListObject.py +443 -0
  408. spire/xls/interfaces/IListObjectColumn.py +196 -0
  409. spire/xls/interfaces/IMarkersDesigner.py +133 -0
  410. spire/xls/interfaces/IMigrantRange.py +28 -0
  411. spire/xls/interfaces/INamedObject.py +27 -0
  412. spire/xls/interfaces/INamedRange.py +246 -0
  413. spire/xls/interfaces/INumberFormat.py +90 -0
  414. spire/xls/interfaces/IOleObject.py +225 -0
  415. spire/xls/interfaces/IOptimizedUpdate.py +35 -0
  416. spire/xls/interfaces/IOvalShape.py +201 -0
  417. spire/xls/interfaces/IPageSetup.py +260 -0
  418. spire/xls/interfaces/IPageSetupBase.py +849 -0
  419. spire/xls/interfaces/IPictureShape.py +118 -0
  420. spire/xls/interfaces/IPropertyData.py +100 -0
  421. spire/xls/interfaces/IPrstGeomShape.py +103 -0
  422. spire/xls/interfaces/IRadioButton.py +159 -0
  423. spire/xls/interfaces/IRectangleShape.py +90 -0
  424. spire/xls/interfaces/IReflectionEffect.py +217 -0
  425. spire/xls/interfaces/IScrollBarShape.py +139 -0
  426. spire/xls/interfaces/IShadow.py +385 -0
  427. spire/xls/interfaces/IShape.py +620 -0
  428. spire/xls/interfaces/IShapeFill.py +767 -0
  429. spire/xls/interfaces/IShapeLineFormat.py +488 -0
  430. spire/xls/interfaces/ISortColumn.py +138 -0
  431. spire/xls/interfaces/ISortColumns.py +106 -0
  432. spire/xls/interfaces/ISortedRule.py +154 -0
  433. spire/xls/interfaces/ISpinnerShape.py +124 -0
  434. spire/xls/interfaces/IStyle.py +60 -0
  435. spire/xls/interfaces/ITabSheet.py +364 -0
  436. spire/xls/interfaces/ITextBox.py +140 -0
  437. spire/xls/interfaces/ITextBoxLinkShape.py +48 -0
  438. spire/xls/interfaces/ITextBoxShape.py +27 -0
  439. spire/xls/interfaces/ITextFrame.py +146 -0
  440. spire/xls/interfaces/IVPageBreak.py +26 -0
  441. spire/xls/interfaces/IWorkbook.py +1736 -0
  442. spire/xls/interfaces/IWorksheet.py +2638 -0
  443. spire/xls/interfaces/IXLSRange.py +2241 -0
  444. spire/xls/interfaces/IXLSRanges.py +40 -0
  445. spire/xls/interfaces/IconSet.py +125 -0
  446. spire/xls/interfaces/ImageLocationTypes.py +17 -0
  447. spire/xls/interfaces/ImportObjectOptions.py +136 -0
  448. spire/xls/interfaces/InsertMoveOption.py +17 -0
  449. spire/xls/interfaces/InteriorArrayWrapper.py +181 -0
  450. spire/xls/interfaces/__init__.py +0 -0
  451. spire/xls/interfaces/collections/IDataValidationCollection.py +128 -0
  452. spire/xls/interfaces/collections/IHPageBreaks.py +37 -0
  453. spire/xls/interfaces/collections/IListObjects.py +34 -0
  454. spire/xls/interfaces/collections/IOleObjects.py +44 -0
  455. spire/xls/interfaces/collections/IPrstGeomShapes.py +87 -0
  456. spire/xls/interfaces/collections/IShapes.py +273 -0
  457. spire/xls/interfaces/collections/ITextBoxes.py +67 -0
  458. spire/xls/interfaces/collections/IVPageBreaks.py +37 -0
  459. spire/xls/interfaces/collections/__init__.py +0 -0
  460. spire/xls/interfaces/pivot_table/IPivotCache.py +50 -0
  461. spire/xls/interfaces/pivot_table/IPivotCaches.py +52 -0
  462. spire/xls/interfaces/pivot_table/IPivotCalculatedFields.py +69 -0
  463. spire/xls/interfaces/pivot_table/IPivotField.py +372 -0
  464. spire/xls/interfaces/pivot_table/IPivotTable.py +509 -0
  465. spire/xls/interfaces/pivot_table/IPivotTableOptions.py +507 -0
  466. spire/xls/interfaces/pivot_table/__init__.py +0 -0
  467. spire/xls/interfaces/sorting/__init__.py +0 -0
  468. spire/xls/lib/Spire.Xls.Base.dll +0 -0
  469. spire/xls/lib/_init_.py +0 -0
  470. spire/xls/license/LicenseProvider.py +107 -0
  471. spire/xls/license/__init__.py +0 -0
  472. spire/xls/pivot_tables/AutoSortScope.py +29 -0
  473. spire/xls/pivot_tables/PivotConditionalFormat.py +71 -0
  474. spire/xls/pivot_tables/PivotDataField.py +163 -0
  475. spire/xls/pivot_tables/PivotItem.py +228 -0
  476. spire/xls/pivot_tables/PivotReportFilter.py +199 -0
  477. spire/xls/pivot_tables/PivotReportFilters.py +95 -0
  478. spire/xls/pivot_tables/PivotStyle.py +104 -0
  479. spire/xls/pivot_tables/PivotTableStyle.py +76 -0
  480. spire/xls/pivot_tables/XlsPivotCache.py +506 -0
  481. spire/xls/pivot_tables/XlsPivotCacheField.py +276 -0
  482. spire/xls/pivot_tables/XlsPivotField.py +975 -0
  483. spire/xls/pivot_tables/XlsPivotTable.py +1189 -0
  484. spire/xls/pivot_tables/__init__.py +0 -0
  485. spire/xls/security/__init__.py +0 -0
  486. spire/xls/sorting/DataSorter.py +152 -0
  487. spire/xls/sorting/SortColumn.py +115 -0
  488. spire/xls/sorting/SortColumns.py +194 -0
  489. spire/xls/sorting/__init__.py +0 -0
  490. spire/xls/sparkline/ISparklines.py +72 -0
  491. spire/xls/sparkline/Sparkline.py +89 -0
  492. spire/xls/sparkline/SparklineCollection.py +107 -0
  493. spire/xls/sparkline/SparklineGroup.py +592 -0
  494. spire/xls/sparkline/SparklineGroupCollection.py +67 -0
  495. spire/xls/sparkline/__init__.py +0 -0
  496. spire/xls/template_markers/MarkerDesigner.py +171 -0
  497. spire/xls/template_markers/__init__.py +0 -0
  498. spire_xls-15.7.1.dist-info/METADATA +197 -0
  499. spire_xls-15.7.1.dist-info/RECORD +720 -0
  500. spire/xls/AddInFunctionsCollection.py +0 -29
  501. spire/xls/AlertStyleType.py +0 -18
  502. spire/xls/ArcShapeCollection.py +0 -70
  503. spire/xls/AutoFiltersCollection.py +0 -527
  504. spire/xls/AutoFitterOptions.py +0 -66
  505. spire/xls/AutoFormatOptions.py +0 -23
  506. spire/xls/AutoFormatType.py +0 -32
  507. spire/xls/AutoSortScope.py +0 -25
  508. spire/xls/AverageType.py +0 -25
  509. spire/xls/AxisLineIdentifierType.py +0 -19
  510. spire/xls/AxisTextDirectionType.py +0 -18
  511. spire/xls/AxisType.py +0 -18
  512. spire/xls/BaseFormatType.py +0 -17
  513. spire/xls/BordersCollection.py +0 -158
  514. spire/xls/BordersCollectionArrayWrapper.py +0 -95
  515. spire/xls/BordersLineType.py +0 -23
  516. spire/xls/BubbleSizeType.py +0 -17
  517. spire/xls/BuiltInDocumentProperties.py +0 -12
  518. spire/xls/BuiltInPropertyType.py +0 -50
  519. spire/xls/BuiltInStyles.py +0 -66
  520. spire/xls/CategoryType.py +0 -18
  521. spire/xls/CellDataType.py +0 -23
  522. spire/xls/CellFormatType.py +0 -21
  523. spire/xls/Chart.py +0 -404
  524. spire/xls/ChartArea.py +0 -61
  525. spire/xls/ChartBackgroundMode.py +0 -18
  526. spire/xls/ChartBaseUnitType.py +0 -18
  527. spire/xls/ChartCategoryAxis.py +0 -93
  528. spire/xls/ChartDataLabels.py +0 -42
  529. spire/xls/ChartDataPoint.py +0 -42
  530. spire/xls/ChartDataPointsCollection.py +0 -75
  531. spire/xls/ChartDisplayUnitType.py +0 -26
  532. spire/xls/ChartFormat.py +0 -72
  533. spire/xls/ChartFormatCollection.py +0 -59
  534. spire/xls/ChartGridLine.py +0 -27
  535. spire/xls/ChartLegend.py +0 -42
  536. spire/xls/ChartLegendEntriesColl.py +0 -128
  537. spire/xls/ChartLegendEntry.py +0 -27
  538. spire/xls/ChartLinePatternType.py +0 -24
  539. spire/xls/ChartLineWeightType.py +0 -19
  540. spire/xls/ChartMarkerType.py +0 -27
  541. spire/xls/ChartParagraphType.py +0 -18
  542. spire/xls/ChartPieType.py +0 -18
  543. spire/xls/ChartPlotArea.py +0 -53
  544. spire/xls/ChartPlotEmptyType.py +0 -18
  545. spire/xls/ChartSerie.py +0 -142
  546. spire/xls/ChartSerieDataFormat.py +0 -56
  547. spire/xls/ChartSeries.py +0 -154
  548. spire/xls/ChartSeriesAxis.py +0 -72
  549. spire/xls/ChartShadow.py +0 -235
  550. spire/xls/ChartSheet.py +0 -285
  551. spire/xls/ChartTextArea.py +0 -782
  552. spire/xls/ChartValueAxis.py +0 -92
  553. spire/xls/ChartsCollection.py +0 -113
  554. spire/xls/CheckState.py +0 -18
  555. spire/xls/CollectionBase.py +0 -184
  556. spire/xls/CollectionExtended.py +0 -92
  557. spire/xls/ColorConditionValue.py +0 -91
  558. spire/xls/ColorFilter.py +0 -45
  559. spire/xls/ColorType.py +0 -18
  560. spire/xls/ComboBoxCollection.py +0 -70
  561. spire/xls/CommentHAlignType.py +0 -21
  562. spire/xls/CommentVAlignType.py +0 -20
  563. spire/xls/CommentsCollection.py +0 -109
  564. spire/xls/ComparisonOperatorType.py +0 -24
  565. spire/xls/CondFormatCollectionWrapper.py +0 -125
  566. spire/xls/ConditionValue.py +0 -82
  567. spire/xls/ConditionValuePosition.py +0 -16
  568. spire/xls/ConditionalFormat.py +0 -14
  569. spire/xls/ConditionalFormatScope.py +0 -16
  570. spire/xls/ConditionalFormatType.py +0 -33
  571. spire/xls/ConditionalFormatWrapper.py +0 -986
  572. spire/xls/ConditionalFormats.py +0 -55
  573. spire/xls/CustomFilter.py +0 -147
  574. spire/xls/CustomFilterCollection.py +0 -113
  575. spire/xls/DataBarBorder.py +0 -47
  576. spire/xls/DataLabelPositionType.py +0 -26
  577. spire/xls/DataSorter.py +0 -154
  578. spire/xls/DataSourceType.py +0 -19
  579. spire/xls/DateTimeGroupItem.py +0 -132
  580. spire/xls/DropLineStyleType.py +0 -18
  581. spire/xls/DynamicFilter.py +0 -71
  582. spire/xls/ErrorBarIncludeType.py +0 -19
  583. spire/xls/ErrorBarType.py +0 -20
  584. spire/xls/ExcelCalculationMode.py +0 -18
  585. spire/xls/ExcelChartType.py +0 -96
  586. spire/xls/ExcelColors.py +0 -121
  587. spire/xls/ExcelComboType.py +0 -22
  588. spire/xls/ExcelHorizontalAlignment.py +0 -21
  589. spire/xls/ExcelPatternType.py +0 -52
  590. spire/xls/ExcelQuartileCalculation.py +0 -17
  591. spire/xls/ExcelShapeType.py +0 -41
  592. spire/xls/ExcelSheetType.py +0 -20
  593. spire/xls/ExcelTreeMapLabelOption.py +0 -18
  594. spire/xls/ExcelVersion.py +0 -24
  595. spire/xls/ExcelVerticalAlignment.py +0 -21
  596. spire/xls/ExpandCollapseFlags.py +0 -18
  597. spire/xls/FilterColumn.py +0 -258
  598. spire/xls/FilterConditionType.py +0 -21
  599. spire/xls/FilterDataType.py +0 -22
  600. spire/xls/FontUnderlineType.py +0 -20
  601. spire/xls/FontVertialAlignmentType.py +0 -20
  602. spire/xls/GradientColorType.py +0 -18
  603. spire/xls/GradientPatternType.py +0 -64
  604. spire/xls/GradientPresetType.py +0 -39
  605. spire/xls/GradientStyleType.py +0 -21
  606. spire/xls/GradientTextureType.py +0 -40
  607. spire/xls/GradientVariantsType.py +0 -19
  608. spire/xls/GroupShapeCollection.py +0 -46
  609. spire/xls/HPageBreaksCollection.py +0 -108
  610. spire/xls/HistogramAxisFormat.py +0 -30
  611. spire/xls/HorizontalAlignType.py +0 -23
  612. spire/xls/HyperLinkType.py +0 -20
  613. spire/xls/HyperLinksCollection.py +0 -72
  614. spire/xls/IArcShape.py +0 -259
  615. spire/xls/IChart.py +0 -1368
  616. spire/xls/IChartAxis.py +0 -722
  617. spire/xls/IChartBorder.py +0 -220
  618. spire/xls/IChartCategoryAxis.py +0 -410
  619. spire/xls/IChartDataLabels.py +0 -457
  620. spire/xls/IChartDataPoint.py +0 -131
  621. spire/xls/IChartDataTable.py +0 -197
  622. spire/xls/IChartErrorBars.py +0 -373
  623. spire/xls/IChartFillBorder.py +0 -303
  624. spire/xls/IChartFormat.py +0 -571
  625. spire/xls/IChartFrameFormat.py +0 -93
  626. spire/xls/IChartGridLine.py +0 -107
  627. spire/xls/IChartInterior.py +0 -278
  628. spire/xls/IChartLegend.py +0 -499
  629. spire/xls/IChartLegendEntry.py +0 -178
  630. spire/xls/IChartPageSetup.py +0 -56
  631. spire/xls/IChartSerie.py +0 -779
  632. spire/xls/IChartSerieDataFormat.py +0 -566
  633. spire/xls/IChartSeriesAxis.py +0 -128
  634. spire/xls/IChartShape.py +0 -92
  635. spire/xls/IChartTextArea.py +0 -197
  636. spire/xls/IChartTrendLine.py +0 -548
  637. spire/xls/IChartValueAxis.py +0 -518
  638. spire/xls/IChartWallOrFloor.py +0 -32
  639. spire/xls/ICheckBox.py +0 -96
  640. spire/xls/ICloneParent.py +0 -28
  641. spire/xls/IColorConditionValue.py +0 -31
  642. spire/xls/IColorScale.py +0 -32
  643. spire/xls/ICombinedRange.py +0 -87
  644. spire/xls/IComboBoxShape.py +0 -95
  645. spire/xls/IComment.py +0 -85
  646. spire/xls/ICommentShape.py +0 -12
  647. spire/xls/IConditionValue.py +0 -68
  648. spire/xls/IConditionalFormat.py +0 -606
  649. spire/xls/IConditionalFormats.py +0 -48
  650. spire/xls/ICustomDocumentProperties.py +0 -128
  651. spire/xls/IDataBar.py +0 -105
  652. spire/xls/IDataValidation.py +0 -421
  653. spire/xls/IDataValidationCollection.py +0 -132
  654. spire/xls/IDataValidationTable.py +0 -68
  655. spire/xls/IDigitalSignature.py +0 -99
  656. spire/xls/IDigitalSignatures.py +0 -29
  657. spire/xls/IDocumentProperty.py +0 -226
  658. spire/xls/IErrorIndicator.py +0 -31
  659. spire/xls/IExtendIndex.py +0 -21
  660. spire/xls/IExtendedFormat.py +0 -530
  661. spire/xls/IFont.py +0 -271
  662. spire/xls/IFormat3D.py +0 -252
  663. spire/xls/IGeomPath.py +0 -23
  664. spire/xls/IGeomPathInfo.py +0 -112
  665. spire/xls/IGeomPathShape.py +0 -30
  666. spire/xls/IGlow.py +0 -85
  667. spire/xls/IGradient.py +0 -174
  668. spire/xls/IGroupBox.py +0 -67
  669. spire/xls/IHPageBreak.py +0 -22
  670. spire/xls/IHPageBreaks.py +0 -31
  671. spire/xls/IHyperLink.py +0 -118
  672. spire/xls/IIconSet.py +0 -96
  673. spire/xls/IInterior.py +0 -117
  674. spire/xls/IInternalAddtionalFormat.py +0 -238
  675. spire/xls/IInternalFont.py +0 -31
  676. spire/xls/ILabelShape.py +0 -49
  677. spire/xls/ILineShape.py +0 -305
  678. spire/xls/IListObject.py +0 -493
  679. spire/xls/IListObjectColumn.py +0 -222
  680. spire/xls/IListObjects.py +0 -31
  681. spire/xls/IMarkersDesigner.py +0 -113
  682. spire/xls/IMigrantRange.py +0 -21
  683. spire/xls/INamedObject.py +0 -22
  684. spire/xls/INamedRange.py +0 -162
  685. spire/xls/INumberFormat.py +0 -77
  686. spire/xls/IOleObject.py +0 -176
  687. spire/xls/IOleObjects.py +0 -32
  688. spire/xls/IOptimizedUpdate.py +0 -28
  689. spire/xls/IOvalShape.py +0 -154
  690. spire/xls/IPageSetup.py +0 -195
  691. spire/xls/IPageSetupBase.py +0 -642
  692. spire/xls/IPictureShape.py +0 -99
  693. spire/xls/IPivotCache.py +0 -41
  694. spire/xls/IPivotCaches.py +0 -39
  695. spire/xls/IPivotCalculatedFields.py +0 -50
  696. spire/xls/IPivotField.py +0 -291
  697. spire/xls/IPivotTable.py +0 -393
  698. spire/xls/IPivotTableOptions.py +0 -428
  699. spire/xls/IPropertyData.py +0 -70
  700. spire/xls/IPrstGeomShape.py +0 -71
  701. spire/xls/IPrstGeomShapes.py +0 -81
  702. spire/xls/IRadioButton.py +0 -105
  703. spire/xls/IRectangleShape.py +0 -60
  704. spire/xls/IReflectionEffect.py +0 -138
  705. spire/xls/IScrollBarShape.py +0 -140
  706. spire/xls/IShadow.py +0 -244
  707. spire/xls/IShape.py +0 -409
  708. spire/xls/IShapeFill.py +0 -522
  709. spire/xls/IShapeLineFormat.py +0 -331
  710. spire/xls/IShapes.py +0 -270
  711. spire/xls/ISortColumn.py +0 -96
  712. spire/xls/ISortColumns.py +0 -70
  713. spire/xls/ISortedRule.py +0 -112
  714. spire/xls/ISparklines.py +0 -72
  715. spire/xls/ISpinnerShape.py +0 -102
  716. spire/xls/IStyle.py +0 -50
  717. spire/xls/ITabSheet.py +0 -302
  718. spire/xls/ITextBox.py +0 -116
  719. spire/xls/ITextBoxLinkShape.py +0 -40
  720. spire/xls/ITextBoxShape.py +0 -22
  721. spire/xls/ITextBoxes.py +0 -61
  722. spire/xls/ITextFrame.py +0 -120
  723. spire/xls/IVPageBreak.py +0 -22
  724. spire/xls/IVPageBreaks.py +0 -31
  725. spire/xls/IWorkbook.py +0 -1806
  726. spire/xls/IWorksheet.py +0 -2694
  727. spire/xls/IXLSRange.py +0 -2479
  728. spire/xls/IXLSRanges.py +0 -35
  729. spire/xls/IconSet.py +0 -103
  730. spire/xls/IgnoreErrorType.py +0 -24
  731. spire/xls/ImageFormatType.py +0 -18
  732. spire/xls/ImageLocationTypes.py +0 -15
  733. spire/xls/ImageType.py +0 -17
  734. spire/xls/ImportObjectOptions.py +0 -89
  735. spire/xls/InsertMoveOption.py +0 -15
  736. spire/xls/InteriorArrayWrapper.py +0 -126
  737. spire/xls/LegendPositionType.py +0 -21
  738. spire/xls/LegendSpacingType.py +0 -18
  739. spire/xls/LineStyleType.py +0 -29
  740. spire/xls/ListObjectCollection.py +0 -45
  741. spire/xls/MarkerDesigner.py +0 -172
  742. spire/xls/MultipleFilterCollection.py +0 -166
  743. spire/xls/NegativeBarFormat.py +0 -82
  744. spire/xls/OleObjectType.py +0 -51
  745. spire/xls/OrderBy.py +0 -19
  746. spire/xls/OrderType.py +0 -17
  747. spire/xls/OvalShapeCollection.py +0 -70
  748. spire/xls/PageBreakExtentType.py +0 -17
  749. spire/xls/PageBreakType.py +0 -18
  750. spire/xls/PageOrientationType.py +0 -17
  751. spire/xls/PagesOrderType.py +0 -17
  752. spire/xls/PaperSizeType.py +0 -135
  753. spire/xls/PicturesCollection.py +0 -532
  754. spire/xls/PivotConditionalFormat.py +0 -54
  755. spire/xls/PivotConditionalFormatCollection.py +0 -38
  756. spire/xls/PivotDataField.py +0 -118
  757. spire/xls/PivotGroupByTypes.py +0 -23
  758. spire/xls/PivotItem.py +0 -161
  759. spire/xls/PivotReportFilter.py +0 -92
  760. spire/xls/PivotReportFilters.py +0 -63
  761. spire/xls/PivotStyle.py +0 -79
  762. spire/xls/PivotTableFields.py +0 -85
  763. spire/xls/PivotTableStyle.py +0 -63
  764. spire/xls/PrintCommentType.py +0 -18
  765. spire/xls/PrintErrorsType.py +0 -19
  766. spire/xls/PrstGeomShapeCollection.py +0 -126
  767. spire/xls/RadioButtonCollection.py +0 -137
  768. spire/xls/RangesCollection.py +0 -537
  769. spire/xls/ReadingOrderType.py +0 -18
  770. spire/xls/RectangleStyleType.py +0 -17
  771. spire/xls/ResizeBehaveType.py +0 -18
  772. spire/xls/ShapeArrowLengthType.py +0 -18
  773. spire/xls/ShapeArrowStyleType.py +0 -21
  774. spire/xls/ShapeArrowWidthType.py +0 -18
  775. spire/xls/ShapeDashLineStyleType.py +0 -23
  776. spire/xls/ShapeFillType.py +0 -22
  777. spire/xls/ShapeLayerChangeType.py +0 -19
  778. spire/xls/ShapeLineStyleType.py +0 -20
  779. spire/xls/SheetProtectionType.py +0 -33
  780. spire/xls/SortColumn.py +0 -120
  781. spire/xls/SortColumns.py +0 -185
  782. spire/xls/SortComparsionType.py +0 -19
  783. spire/xls/SortOrientationType.py +0 -17
  784. spire/xls/SortedWayType.py +0 -18
  785. spire/xls/Sparkline.py +0 -70
  786. spire/xls/SparklineCollection.py +0 -112
  787. spire/xls/SparklineGroup.py +0 -523
  788. spire/xls/SparklineGroupCollection.py +0 -71
  789. spire/xls/SparklineType.py +0 -18
  790. spire/xls/SplitType.py +0 -19
  791. spire/xls/StylesCollection.py +0 -141
  792. spire/xls/TextDirection.py +0 -20
  793. spire/xls/TextRotationType.py +0 -19
  794. spire/xls/ThemeColorType.py +0 -27
  795. spire/xls/TickLabelPositionType.py +0 -19
  796. spire/xls/TickMarkType.py +0 -19
  797. spire/xls/Top10Filter.py +0 -75
  798. spire/xls/TopBottomType.py +0 -19
  799. spire/xls/TopFormatType.py +0 -18
  800. spire/xls/TrendLineType.py +0 -21
  801. spire/xls/UnknownVariableAction.py +0 -18
  802. spire/xls/VPageBreaksCollection.py +0 -96
  803. spire/xls/ValidationComparisonOperator.py +0 -23
  804. spire/xls/VariableTypeAction.py +0 -19
  805. spire/xls/VerticalAlignType.py +0 -20
  806. spire/xls/ViewMode.py +0 -18
  807. spire/xls/WorksheetVisibility.py +0 -18
  808. spire/xls/WorksheetsCollection.py +0 -341
  809. spire/xls/XLSXBorderJoinType.py +0 -19
  810. spire/xls/XLSXChartMaterialType.py +0 -32
  811. spire/xls/XLSXChartPrespectiveType.py +0 -21
  812. spire/xls/XLSXChartShadowInnerType.py +0 -25
  813. spire/xls/XLSXChartShadowOuterType.py +0 -25
  814. spire/xls/XlsAddInFunctionsCollection.py +0 -101
  815. spire/xls/XlsAutoFiltersCollection.py +0 -119
  816. spire/xls/XlsBordersCollection.py +0 -101
  817. spire/xls/XlsBuiltInDocumentProperties.py +0 -639
  818. spire/xls/XlsChart.py +0 -1510
  819. spire/xls/XlsChartAxis.py +0 -564
  820. spire/xls/XlsChartBorder.py +0 -165
  821. spire/xls/XlsChartCategoryAxis.py +0 -656
  822. spire/xls/XlsChartDataLabelArea.py +0 -387
  823. spire/xls/XlsChartDataLabels.py +0 -811
  824. spire/xls/XlsChartDataPoint.py +0 -108
  825. spire/xls/XlsChartDataPointsCollection.py +0 -120
  826. spire/xls/XlsChartDataTable.py +0 -393
  827. spire/xls/XlsChartDropBar.py +0 -301
  828. spire/xls/XlsChartFill.py +0 -571
  829. spire/xls/XlsChartFormat.py +0 -1069
  830. spire/xls/XlsChartFormatCollection.py +0 -162
  831. spire/xls/XlsChartFrameFormat.py +0 -614
  832. spire/xls/XlsChartGridLine.py +0 -171
  833. spire/xls/XlsChartInterior.py +0 -240
  834. spire/xls/XlsChartLegend.py +0 -355
  835. spire/xls/XlsChartLegendArea.py +0 -419
  836. spire/xls/XlsChartLegendEntry.py +0 -156
  837. spire/xls/XlsChartSerie.py +0 -589
  838. spire/xls/XlsChartSerieDataFormat.py +0 -1008
  839. spire/xls/XlsChartSeriesAxis.py +0 -212
  840. spire/xls/XlsChartShape.py +0 -1142
  841. spire/xls/XlsChartTitleArea.py +0 -392
  842. spire/xls/XlsChartValueAxis.py +0 -317
  843. spire/xls/XlsChartWallOrFloor.py +0 -319
  844. spire/xls/XlsCommentsCollection.py +0 -87
  845. spire/xls/XlsConditionValue.py +0 -111
  846. spire/xls/XlsConditionalFormat.py +0 -1119
  847. spire/xls/XlsConditionalFormats.py +0 -590
  848. spire/xls/XlsDataValidationCollection.py +0 -159
  849. spire/xls/XlsHPageBreaksCollection.py +0 -85
  850. spire/xls/XlsHyperLinksCollection.py +0 -102
  851. spire/xls/XlsPivotCache.py +0 -401
  852. spire/xls/XlsPivotCacheField.py +0 -209
  853. spire/xls/XlsPivotCachesCollection.py +0 -124
  854. spire/xls/XlsPivotField.py +0 -885
  855. spire/xls/XlsPivotTable.py +0 -905
  856. spire/xls/XlsRangesCollection.py +0 -1566
  857. spire/xls/XlsStylesCollection.py +0 -73
  858. spire/xls/XlsVPageBreaksCollection.py +0 -84
  859. spire/xls/XlsWorksheetsCollection.py +0 -416
  860. spire_xls-15.5.0.dist-info/METADATA +0 -197
  861. spire_xls-15.5.0.dist-info/RECORD +0 -703
  862. /spire/xls/{lib → autofilter}/__init__.py +0 -0
  863. /spire/xls/{ChartBorder.py → charts/ChartBorder.py} +0 -0
  864. /spire/xls/{ChartDataTable.py → charts/ChartDataTable.py} +0 -0
  865. /spire/xls/{ChartDropBar.py → charts/ChartDropBar.py} +0 -0
  866. /spire/xls/{ChartInterior.py → charts/ChartInterior.py} +0 -0
  867. /spire/xls/{ChartPageSetup.py → charts/ChartPageSetup.py} +0 -0
  868. /spire/xls/{ChartTitle.py → charts/ChartTitle.py} +0 -0
  869. /spire/xls/{ChartWallOrFloor.py → charts/ChartWallOrFloor.py} +0 -0
  870. /spire/xls/{XlsChartPageSetup.py → charts/XlsChartPageSetup.py} +0 -0
  871. /spire/xls/{XlsChartPlotArea.py → charts/XlsChartPlotArea.py} +0 -0
  872. /spire/xls/{ButtonShapeCollection.py → collection/ButtonShapeCollection.py} +0 -0
  873. /spire/xls/{CheckBoxCollection.py → collection/CheckBoxCollection.py} +0 -0
  874. /spire/xls/{CollectionChangeEventArgs.py → collection/CollectionChangeEventArgs.py} +0 -0
  875. /spire/xls/{DataConnections.py → collection/DataConnections.py} +0 -0
  876. /spire/xls/{ExternalLinkCollection.py → collection/ExternalLinkCollection.py} +0 -0
  877. /spire/xls/{FontsCollection.py → collection/FontsCollection.py} +0 -0
  878. /spire/xls/{GeomertyAdjustValuesCollection.py → collection/GeomertyAdjustValuesCollection.py} +0 -0
  879. /spire/xls/{GroupBoxCollection.py → collection/GroupBoxCollection.py} +0 -0
  880. /spire/xls/{LabelShapeCollection.py → collection/LabelShapeCollection.py} +0 -0
  881. /spire/xls/{LineCollection.py → collection/LineCollection.py} +0 -0
  882. /spire/xls/{ListBoxCollection.py → collection/ListBoxCollection.py} +0 -0
  883. /spire/xls/{QueryTableCollection.py → collection/QueryTableCollection.py} +0 -0
  884. /spire/xls/{RectangleCollection.py → collection/RectangleCollection.py} +0 -0
  885. /spire/xls/{ScrollBarCollection.py → collection/ScrollBarCollection.py} +0 -0
  886. /spire/xls/{ShapeCollectionBase.py → collection/ShapeCollectionBase.py} +0 -0
  887. /spire/xls/{SpinnerShapeCollection.py → collection/SpinnerShapeCollection.py} +0 -0
  888. /spire/xls/{TextBoxCollection.py → collection/TextBoxCollection.py} +0 -0
  889. /spire/xls/{WorkbookObjectsCollection.py → collection/WorkbookObjectsCollection.py} +0 -0
  890. /spire/xls/{WorksheetChartsCollection.py → collection/WorksheetChartsCollection.py} +0 -0
  891. /spire/xls/{WorksheetConditionalFormats.py → collection/WorksheetConditionalFormats.py} +0 -0
  892. /spire/xls/{XlsChartSeries.py → collection/XlsChartSeries.py} +0 -0
  893. /spire/xls/{XlsChartsCollection.py → collection/XlsChartsCollection.py} +0 -0
  894. /spire/xls/{XlsFontsCollection.py → collection/XlsFontsCollection.py} +0 -0
  895. /spire/xls/{XlsHeaderFooterShapeCollection.py → collection/XlsHeaderFooterShapeCollection.py} +0 -0
  896. /spire/xls/{XlsPicturesCollection.py → collection/XlsPicturesCollection.py} +0 -0
  897. /spire/xls/{XlsWorkbookObjectsCollection.py → collection/XlsWorkbookObjectsCollection.py} +0 -0
  898. /spire/xls/{XlsWorksheetChartsCollection.py → collection/XlsWorksheetChartsCollection.py} +0 -0
  899. /spire/xls/{XlsWorksheetConditionalFormats.py → collection/XlsWorksheetConditionalFormats.py} +0 -0
  900. /spire/xls/{PivotCachesCollection.py → collection/pivot_table/PivotCachesCollection.py} +0 -0
  901. /spire/xls/{PivotCalculatedFieldsCollection.py → collection/pivot_table/PivotCalculatedFieldsCollection.py} +0 -0
  902. /spire/xls/{PivotDataFields.py → collection/pivot_table/PivotDataFields.py} +0 -0
  903. /spire/xls/{PivotTablesCollection.py → collection/pivot_table/PivotTablesCollection.py} +0 -0
  904. /spire/xls/{XlsPivotTablesCollection.py → collection/pivot_table/XlsPivotTablesCollection.py} +0 -0
  905. /spire/xls/{AxisTypes.py → enums/AxisTypes.py} +0 -0
  906. /spire/xls/{CompoundLineType.py → enums/CompoundLineType.py} +0 -0
  907. /spire/xls/{ConditionValueType.py → enums/ConditionValueType.py} +0 -0
  908. /spire/xls/{ConditionalTopNType.py → enums/ConditionalTopNType.py} +0 -0
  909. /spire/xls/{ConnectionDataSourceType.py → enums/ConnectionDataSourceType.py} +0 -0
  910. /spire/xls/{CopyRangeOptions.py → enums/CopyRangeOptions.py} +0 -0
  911. /spire/xls/{DataBarAxisPosition.py → enums/DataBarAxisPosition.py} +0 -0
  912. /spire/xls/{DataBarBorderType.py → enums/DataBarBorderType.py} +0 -0
  913. /spire/xls/{DataBarFillType.py → enums/DataBarFillType.py} +0 -0
  914. /spire/xls/{DataBarNegativeColorType.py → enums/DataBarNegativeColorType.py} +0 -0
  915. /spire/xls/{DataMarkerDirection.py → enums/DataMarkerDirection.py} +0 -0
  916. /spire/xls/{DateTimeGroupingType.py → enums/DateTimeGroupingType.py} +0 -0
  917. /spire/xls/{DeleteOption.py → enums/DeleteOption.py} +0 -0
  918. /spire/xls/{DynamicFilterType.py → enums/DynamicFilterType.py} +0 -0
  919. /spire/xls/{ExcelClearOptions.py → enums/ExcelClearOptions.py} +0 -0
  920. /spire/xls/{ExcelFindOptions.py → enums/ExcelFindOptions.py} +0 -0
  921. /spire/xls/{ExcelSaveType.py → enums/ExcelSaveType.py} +0 -0
  922. /spire/xls/{ExcelTotalsCalculation.py → enums/ExcelTotalsCalculation.py} +0 -0
  923. /spire/xls/{FillPictureType.py → enums/FillPictureType.py} +0 -0
  924. /spire/xls/{FilterOperatorType.py → enums/FilterOperatorType.py} +0 -0
  925. /spire/xls/{FilterType.py → enums/FilterType.py} +0 -0
  926. /spire/xls/{FindType.py → enums/FindType.py} +0 -0
  927. /spire/xls/{GeomertyAdjustValueFormulaType.py → enums/GeomertyAdjustValueFormulaType.py} +0 -0
  928. /spire/xls/{GroupByType.py → enums/GroupByType.py} +0 -0
  929. /spire/xls/{HttpContentType.py → enums/HttpContentType.py} +0 -0
  930. /spire/xls/{IconSetType.py → enums/IconSetType.py} +0 -0
  931. /spire/xls/{InsertOptionsType.py → enums/InsertOptionsType.py} +0 -0
  932. /spire/xls/{LineShapeType.py → enums/LineShapeType.py} +0 -0
  933. /spire/xls/{MeasureUnits.py → enums/MeasureUnits.py} +0 -0
  934. /spire/xls/{MsoPathType.py → enums/MsoPathType.py} +0 -0
  935. /spire/xls/{OLEDBCommandType.py → enums/OLEDBCommandType.py} +0 -0
  936. /spire/xls/{OdsPageBackgroundImagePositionType.py → enums/OdsPageBackgroundImagePositionType.py} +0 -0
  937. /spire/xls/{OdsPageBackgroundImageType.py → enums/OdsPageBackgroundImageType.py} +0 -0
  938. /spire/xls/{OdsPageBackgroundType.py → enums/OdsPageBackgroundType.py} +0 -0
  939. /spire/xls/{OleLinkType.py → enums/OleLinkType.py} +0 -0
  940. /spire/xls/{PathFillMode.py → enums/PathFillMode.py} +0 -0
  941. /spire/xls/{PdfConformanceLevel.py → enums/PdfConformanceLevel.py} +0 -0
  942. /spire/xls/{PivotAutoFomatTypes.py → enums/PivotAutoFomatTypes.py} +0 -0
  943. /spire/xls/{PivotBuiltInStyles.py → enums/PivotBuiltInStyles.py} +0 -0
  944. /spire/xls/{PivotDataType.py → enums/PivotDataType.py} +0 -0
  945. /spire/xls/{PivotFieldFormatType.py → enums/PivotFieldFormatType.py} +0 -0
  946. /spire/xls/{PivotFieldSortType.py → enums/PivotFieldSortType.py} +0 -0
  947. /spire/xls/{PivotItemType.py → enums/PivotItemType.py} +0 -0
  948. /spire/xls/{PivotLabelFilterType.py → enums/PivotLabelFilterType.py} +0 -0
  949. /spire/xls/{PivotPageAreaFieldsOrderType.py → enums/PivotPageAreaFieldsOrderType.py} +0 -0
  950. /spire/xls/{PivotTableElement.py → enums/PivotTableElement.py} +0 -0
  951. /spire/xls/{PivotTableLayoutType.py → enums/PivotTableLayoutType.py} +0 -0
  952. /spire/xls/{PivotValueFilterType.py → enums/PivotValueFilterType.py} +0 -0
  953. /spire/xls/{PresetTextEffect.py → enums/PresetTextEffect.py} +0 -0
  954. /spire/xls/{PrintingPageType.py → enums/PrintingPageType.py} +0 -0
  955. /spire/xls/{PropertyType.py → enums/PropertyType.py} +0 -0
  956. /spire/xls/{PrstGeomShapeType.py → enums/PrstGeomShapeType.py} +0 -0
  957. /spire/xls/{RectangleShapeType.py → enums/RectangleShapeType.py} +0 -0
  958. /spire/xls/{RelationShip.py → enums/RelationShip.py} +0 -0
  959. /spire/xls/{RenameStrategy.py → enums/RenameStrategy.py} +0 -0
  960. /spire/xls/{RtfTags.py → enums/RtfTags.py} +0 -0
  961. /spire/xls/{SelectionType.py → enums/SelectionType.py} +0 -0
  962. /spire/xls/{SparklineEmptyCells.py → enums/SparklineEmptyCells.py} +0 -0
  963. /spire/xls/{SpartlineVerticalAxisType.py → enums/SpartlineVerticalAxisType.py} +0 -0
  964. /spire/xls/{StrikeThroughStyle.py → enums/StrikeThroughStyle.py} +0 -0
  965. /spire/xls/{StyleDefineType.py → enums/StyleDefineType.py} +0 -0
  966. /spire/xls/{SubtotalTypes.py → enums/SubtotalTypes.py} +0 -0
  967. /spire/xls/{TRangeValueType.py → enums/TRangeValueType.py} +0 -0
  968. /spire/xls/{TableBuiltInStyles.py → enums/TableBuiltInStyles.py} +0 -0
  969. /spire/xls/{TextDirectionType.py → enums/TextDirectionType.py} +0 -0
  970. /spire/xls/{TextVerticalValue.py → enums/TextVerticalValue.py} +0 -0
  971. /spire/xls/{TimePeriodType.py → enums/TimePeriodType.py} +0 -0
  972. /spire/xls/{UnderlineStyle.py → enums/UnderlineStyle.py} +0 -0
  973. /spire/xls/{WorksheetCopyType.py → enums/WorksheetCopyType.py} +0 -0
  974. /spire/xls/{XLSXChartBevelType.py → enums/XLSXChartBevelType.py} +0 -0
  975. /spire/xls/{XLSXChartLightingType.py → enums/XLSXChartLightingType.py} +0 -0
  976. /spire/xls/{XLSXPivotItemType.py → enums/XLSXPivotItemType.py} +0 -0
  977. /spire/xls/{XmlOpenType.py → enums/XmlOpenType.py} +0 -0
  978. /spire/xls/{IAddInFunction.py → interfaces/IAddInFunction.py} +0 -0
  979. /spire/xls/{IAutoFilter.py → interfaces/IAutoFilter.py} +0 -0
  980. /spire/xls/{IAutoFilterCondition.py → interfaces/IAutoFilterCondition.py} +0 -0
  981. /spire/xls/{IAutoFilters.py → interfaces/IAutoFilters.py} +0 -0
  982. /spire/xls/{IBorder.py → interfaces/IBorder.py} +0 -0
  983. /spire/xls/{IBuiltInDocumentProperties.py → interfaces/IBuiltInDocumentProperties.py} +0 -0
  984. /spire/xls/{IButtonShape.py → interfaces/IButtonShape.py} +0 -0
  985. /spire/xls/{IChartDropBar.py → interfaces/IChartDropBar.py} +0 -0
  986. /spire/xls/{IExcelApplication.py → interfaces/IExcelApplication.py} +0 -0
  987. /spire/xls/{IInternalWorksheet.py → interfaces/IInternalWorksheet.py} +0 -0
  988. /spire/xls/{IListBox.py → interfaces/IListBox.py} +0 -0
  989. /spire/xls/{IRichTextString.py → interfaces/IRichTextString.py} +0 -0
  990. /spire/xls/{IAddInFunctions.py → interfaces/collections/IAddInFunctions.py} +0 -0
  991. /spire/xls/{IArcShapes.py → interfaces/collections/IArcShapes.py} +0 -0
  992. /spire/xls/{IBorders.py → interfaces/collections/IBorders.py} +0 -0
  993. /spire/xls/{IButtonShapes.py → interfaces/collections/IButtonShapes.py} +0 -0
  994. /spire/xls/{IChartDataPoints.py → interfaces/collections/IChartDataPoints.py} +0 -0
  995. /spire/xls/{IChartLegendEntries.py → interfaces/collections/IChartLegendEntries.py} +0 -0
  996. /spire/xls/{IChartSeries.py → interfaces/collections/IChartSeries.py} +0 -0
  997. /spire/xls/{IChartShapes.py → interfaces/collections/IChartShapes.py} +0 -0
  998. /spire/xls/{IChartTrendLines.py → interfaces/collections/IChartTrendLines.py} +0 -0
  999. /spire/xls/{ICharts.py → interfaces/collections/ICharts.py} +0 -0
  1000. /spire/xls/{ICheckBoxes.py → interfaces/collections/ICheckBoxes.py} +0 -0
  1001. /spire/xls/{IComboBoxes.py → interfaces/collections/IComboBoxes.py} +0 -0
  1002. /spire/xls/{IComments.py → interfaces/collections/IComments.py} +0 -0
  1003. /spire/xls/{IConditionalFormatsCollection.py → interfaces/collections/IConditionalFormatsCollection.py} +0 -0
  1004. /spire/xls/{IGroupBoxes.py → interfaces/collections/IGroupBoxes.py} +0 -0
  1005. /spire/xls/{IHyperLinks.py → interfaces/collections/IHyperLinks.py} +0 -0
  1006. /spire/xls/{ILabelShapes.py → interfaces/collections/ILabelShapes.py} +0 -0
  1007. /spire/xls/{ILines.py → interfaces/collections/ILines.py} +0 -0
  1008. /spire/xls/{IListBoxes.py → interfaces/collections/IListBoxes.py} +0 -0
  1009. /spire/xls/{INameRanges.py → interfaces/collections/INameRanges.py} +0 -0
  1010. /spire/xls/{IOvalShapes.py → interfaces/collections/IOvalShapes.py} +0 -0
  1011. /spire/xls/{IPictures.py → interfaces/collections/IPictures.py} +0 -0
  1012. /spire/xls/{IRadioButtons.py → interfaces/collections/IRadioButtons.py} +0 -0
  1013. /spire/xls/{IRectangleShapes.py → interfaces/collections/IRectangleShapes.py} +0 -0
  1014. /spire/xls/{IScrollBarShapes.py → interfaces/collections/IScrollBarShapes.py} +0 -0
  1015. /spire/xls/{ISpinnerShapes.py → interfaces/collections/ISpinnerShapes.py} +0 -0
  1016. /spire/xls/{IStyles.py → interfaces/collections/IStyles.py} +0 -0
  1017. /spire/xls/{ITabSheets.py → interfaces/collections/ITabSheets.py} +0 -0
  1018. /spire/xls/{IWorksheetGroup.py → interfaces/collections/IWorksheetGroup.py} +0 -0
  1019. /spire/xls/{IWorksheets.py → interfaces/collections/IWorksheets.py} +0 -0
  1020. /spire/xls/{IPivotDataField.py → interfaces/pivot_table/IPivotDataField.py} +0 -0
  1021. /spire/xls/{IPivotDataFields.py → interfaces/pivot_table/IPivotDataFields.py} +0 -0
  1022. /spire/xls/{IPivotFields.py → interfaces/pivot_table/IPivotFields.py} +0 -0
  1023. /spire/xls/{IPivotTables.py → interfaces/pivot_table/IPivotTables.py} +0 -0
  1024. /spire/xls/{IDataSort.py → interfaces/sorting/IDataSort.py} +0 -0
  1025. /spire/xls/{PivotCache.py → pivot_tables/PivotCache.py} +0 -0
  1026. /spire/xls/{PivotField.py → pivot_tables/PivotField.py} +0 -0
  1027. /spire/xls/{PivotTable.py → pivot_tables/PivotTable.py} +0 -0
  1028. /spire/xls/{EncryptedKeyInfo.py → security/EncryptedKeyInfo.py} +0 -0
  1029. /spire/xls/{ISparkline.py → sparkline/ISparkline.py} +0 -0
  1030. /spire/xls/{ISparklineGroup.py → sparkline/ISparklineGroup.py} +0 -0
  1031. {spire_xls-15.5.0.dist-info → spire_xls-15.7.1.dist-info}/WHEEL +0 -0
  1032. {spire_xls-15.5.0.dist-info → spire_xls-15.7.1.dist-info}/top_level.txt +0 -0
spire/xls/Workbook.py CHANGED
@@ -26,9 +26,8 @@ class Workbook (SpireObject) :
26
26
  @property
27
27
  def ProhibitDtd(self)->bool:
28
28
  """
29
- <summary>
30
29
  prohibt dtd processing switch
31
- </summary>
30
+
32
31
  """
33
32
  GetDllLibXls().Workbook_get_ProhibitDtd.argtypes=[c_void_p]
34
33
  GetDllLibXls().Workbook_get_ProhibitDtd.restype=c_bool
@@ -44,10 +43,8 @@ class Workbook (SpireObject) :
44
43
  @dispatch
45
44
  def SetGlobalCustomFontsFolders(fontPath:List[str]):
46
45
  """
47
- <summary>
48
46
  Sets the path to the folder where the global custom font is located.
49
- </summary>
50
- <returns></returns>
47
+
51
48
  """
52
49
  countfontPath = len(fontPath)
53
50
  ArrayTypeFontPath = c_wchar_p * countfontPath
@@ -64,13 +61,13 @@ class Workbook (SpireObject) :
64
61
 
65
62
  def SaveAsImage(self ,sheetIndex:int,dpiX:float,dpiY:float)->Stream:
66
63
  """
67
- <summary>
68
64
  Save workbook to image.
69
- </summary>
70
- <param name="sheetIndex">sheet Index</param>
71
- <param name="dpiX">Dpi X</param>
72
- <param name="dpiY">Dpi Y</param>
73
- <returns></returns>
65
+
66
+ Args:
67
+ sheetIndex: sheet Index
68
+ dpiX: Dpi X
69
+ dpiY: Dpi Y
70
+
74
71
  """
75
72
 
76
73
  GetDllLibXls().Workbook_SaveAsImageIDD.argtypes=[c_void_p ,c_int,c_float,c_float]
@@ -84,10 +81,11 @@ class Workbook (SpireObject) :
84
81
 
85
82
  def SaveAsXml(self ,fileName:str):
86
83
  """
87
- <summary>
88
- Save workbook to an XML data file.
89
- </summary>
90
- <param name="fileName">XML file name.</param>
84
+ Save workbook to an XML data file.
85
+
86
+ Args:
87
+ fileName: XML file name.
88
+
91
89
  """
92
90
 
93
91
  GetDllLibXls().Workbook_SaveAsXml.argtypes=[c_void_p ,c_void_p]
@@ -97,10 +95,11 @@ class Workbook (SpireObject) :
97
95
 
98
96
  def SaveAsXml(self ,stream:Stream):
99
97
  """
100
- <summary>
101
- Save workbook as XML format to stream.
102
- </summary>
103
- <param name="stream">Stream object.</param>
98
+ Save workbook as XML format to stream.
99
+
100
+ Args:
101
+ stream: Stream object.
102
+
104
103
  """
105
104
  intPtrstream:c_void_p = stream.Ptr
106
105
 
@@ -129,11 +128,12 @@ class Workbook (SpireObject) :
129
128
 
130
129
  def SaveChartAsEmfImage(self ,worksheet:Worksheet,chartIndex:int)->Stream:
131
130
  """
132
- <summary>
133
131
  Save chart to vector image.
134
- </summary>
135
- <param name="worksheet">work sheet</param>
136
- <param name="chartIndex">chart index</param>
132
+
133
+ Args:
134
+ worksheet: work sheet
135
+ chartIndex: chart index
136
+
137
137
  """
138
138
  intPtrworksheet:c_void_p = worksheet.Ptr
139
139
 
@@ -148,12 +148,13 @@ class Workbook (SpireObject) :
148
148
 
149
149
  def SaveChartAsEmfImage(self ,worksheet:Worksheet,chartIndex:int,emfStream:Stream)->Stream:
150
150
  """
151
- <summary>
152
151
  Save chart to vector image.
153
- </summary>
154
- <param name="worksheet">work sheet</param>
155
- <param name="chartIndex">chart index</param>
156
- <param name="emfStream">output stream</param>
152
+
153
+ Args:
154
+ worksheet: work sheet
155
+ chartIndex: chart index
156
+ emfStream: output stream
157
+
157
158
  """
158
159
  intPtrworksheet:c_void_p = worksheet.Ptr
159
160
  intPtremfStream:c_void_p = emfStream.Ptr
@@ -169,10 +170,11 @@ class Workbook (SpireObject) :
169
170
 
170
171
  def SaveChartAsImage(self ,chartSheet:ChartSheet)->Stream:
171
172
  """
172
- <summary>
173
173
  Save chart to image.
174
- </summary>
175
- <param name="worksheet">chart sheet</param>
174
+
175
+ Args:
176
+ worksheet: chart sheet
177
+
176
178
  """
177
179
  intPtrchartSheet:c_void_p = chartSheet.Ptr
178
180
 
@@ -187,10 +189,11 @@ class Workbook (SpireObject) :
187
189
 
188
190
  def SaveChartAsImage(self ,worksheet:Worksheet)->List[Stream]:
189
191
  """
190
- <summary>
191
192
  Save chart to images.
192
- </summary>
193
- <param name="worksheet">worksheet instance</param>
193
+
194
+ Args:
195
+ worksheet: worksheet instance
196
+
194
197
  """
195
198
  intPtrworksheet:c_void_p = worksheet.Ptr
196
199
 
@@ -205,11 +208,12 @@ class Workbook (SpireObject) :
205
208
 
206
209
  def SaveChartAsImage(self ,worksheet:Worksheet,chartIndex:int)->Stream:
207
210
  """
208
- <summary>
209
211
  Save chart to image.
210
- </summary>
211
- <param name="worksheet">work sheet</param>
212
- <param name="chartIndex">chart index</param>
212
+
213
+ Args:
214
+ worksheet: work sheet
215
+ chartIndex: chart index
216
+
213
217
  """
214
218
  intPtrworksheet:c_void_p = worksheet.Ptr
215
219
 
@@ -224,10 +228,11 @@ class Workbook (SpireObject) :
224
228
 
225
229
  def SaveAsTemplate(self ,fileName:str):
226
230
  """
227
- <summary>
228
231
  Save workbook as template to file.
229
- </summary>
230
- <param name="fileName">File name.</param>
232
+
233
+ Args:
234
+ fileName: File name.
235
+
231
236
  """
232
237
 
233
238
  GetDllLibXls().Workbook_SaveAsTemplate.argtypes=[c_void_p ,c_void_p]
@@ -324,10 +329,11 @@ class Workbook (SpireObject) :
324
329
 
325
330
  def SaveToStream(self ,Stream:Stream):
326
331
  """
327
- <summary>
328
332
  Save workbook the stream
329
- </summary>
330
- <param name="Stream">Stream object</param>
333
+
334
+ Args:
335
+ Stream: Stream object
336
+
331
337
  """
332
338
  intPtrStream:c_void_p = Stream.Ptr
333
339
 
@@ -338,11 +344,12 @@ class Workbook (SpireObject) :
338
344
 
339
345
  def SaveToStream(self ,Stream:Stream,fileFormat:FileFormat):
340
346
  """
341
- <summary>
342
347
  Save workbook to stream.
343
- </summary>
344
- <param name="Stream"></param>
345
- <param name="fileFormat"></param>
348
+
349
+ Args:
350
+ Stream:
351
+ fileFormat:
352
+
346
353
  """
347
354
  intPtrStream:c_void_p = Stream.Ptr
348
355
  enumfileFormat:c_int = fileFormat.value
@@ -354,21 +361,20 @@ class Workbook (SpireObject) :
354
361
 
355
362
  def SaveToStream(self ,stream:Stream,separator:str):
356
363
  """
357
- <summary>
358
- Save workbook the stream.
359
- <example>The following code illustrates how to saves the active worksheet as stream with separator:
360
- <code>
361
- //Create workbook
362
- Workbook workbook = new Workbook();
363
- workbook.LoadFromFile("Sample.xlsx");
364
- //Save to stream
365
- Stream stream = new MemoryStream();
366
- workbook.SaveToFile(stream , ",");
367
- </code>
368
- </example>
369
- </summary>
370
- <param name="stream">Stream object.</param>
371
- <param name="separator">Separator.</param>
364
+ Save workbook the stream.
365
+
366
+ Args:
367
+ stream: Stream object.
368
+ separator: Separator.
369
+ Example::
370
+
371
+ #Create workbook
372
+ workbook = Workbook()
373
+ workbook.LoadFromFile("Sample.xlsx")
374
+ #Save to stream
375
+ stream = MemoryStream()
376
+ workbook.SaveToFile(stream , ",")
377
+
372
378
  """
373
379
  intPtrstream:c_void_p = stream.Ptr
374
380
 
@@ -387,13 +393,14 @@ class Workbook (SpireObject) :
387
393
 
388
394
  def SetOleSize(self ,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int):
389
395
  """
390
- <summary>
391
396
  set the size of the visible range of cells when this workbook is displyed as an embedded obect in another document;
392
- </summary>
393
- <param name="firstRow">the visible range's first row index</param>
394
- <param name="firstColumn">the visible range's first column index</param>
395
- <param name="lastRow">the visible range's last row index</param>
396
- <param name="lastColumn">the visible range's last column index</param>
397
+
398
+ Args:
399
+ firstRow: the visible range's first row index
400
+ firstColumn: the visible range's first column index
401
+ lastRow: the visible range's last row index
402
+ lastColumn: the visible range's last column index
403
+
397
404
  """
398
405
 
399
406
  GetDllLibXls().Workbook_SetOleSize.argtypes=[c_void_p ,c_int,c_int,c_int,c_int]
@@ -402,10 +409,11 @@ class Workbook (SpireObject) :
402
409
 
403
410
  def SetWriteProtectionPassword(self ,password:str):
404
411
  """
405
- <summary>
406
412
  Sets write protection password.
407
- </summary>
408
- <param name="password">Password to set</param>
413
+
414
+ Args:
415
+ password: Password to set
416
+
409
417
  """
410
418
 
411
419
  GetDllLibXls().Workbook_SetWriteProtectionPassword.argtypes=[c_void_p ,c_void_p]
@@ -414,10 +422,8 @@ class Workbook (SpireObject) :
414
422
  @dispatch
415
423
  def UnProtect(self):
416
424
  """
417
- <summary>
418
- unprotect file
419
- also upprotect workbook window and structure
420
- </summary>
425
+ unprotect file also upprotect workbook window and structure
426
+
421
427
  """
422
428
  GetDllLibXls().Workbook_UnProtect.argtypes=[c_void_p]
423
429
  CallCFunction(GetDllLibXls().Workbook_UnProtect, self.Ptr)
@@ -426,11 +432,11 @@ class Workbook (SpireObject) :
426
432
 
427
433
  def UnProtect(self ,bookWindowAndStructurePassword:str):
428
434
  """
429
- <summary>
430
- unprotect file
431
- also upprotect workbook window and structure
432
- </summary>
433
- <param name="bookWindowAndStructurePassword">password for protect workbook window and structure</param>
435
+ unprotect file also upprotect workbook window and structure
436
+
437
+ Args:
438
+ bookWindowAndStructurePassword: password for protect workbook window and structure
439
+
434
440
  """
435
441
 
436
442
  GetDllLibXls().Workbook_UnProtectB.argtypes=[c_void_p ,c_void_p]
@@ -439,10 +445,11 @@ class Workbook (SpireObject) :
439
445
 
440
446
  def UnProtectWorkbook(self ,password:str):
441
447
  """
442
- <summary>
443
448
  unprotect workbook window and structure
444
- </summary>
445
- <param name="password">password</param>
449
+
450
+ Args:
451
+ password: password
452
+
446
453
  """
447
454
 
448
455
  GetDllLibXls().Workbook_UnProtectWorkbook.argtypes=[c_void_p ,c_void_p]
@@ -464,10 +471,11 @@ class Workbook (SpireObject) :
464
471
 
465
472
  def GetOleSize(self)->'IXLSRange':
466
473
  """
467
- <summary>
468
474
  get the size of the visible range of cells when this workbook is displyed as an embedded obect in another document;
469
- </summary>
470
- <returns>if there does not set the size ,return null</returns>
475
+
476
+ Returns:
477
+ if there does not set the size ,return null
478
+
471
479
  """
472
480
  GetDllLibXls().Workbook_GetOleSize.argtypes=[c_void_p]
473
481
  GetDllLibXls().Workbook_GetOleSize.restype=c_void_p
@@ -479,9 +487,8 @@ class Workbook (SpireObject) :
479
487
  @property
480
488
  def HasTrackedChanges(self)->bool:
481
489
  """
482
- <summary>
483
490
  Indicates whether the workbook has any tracked changes
484
- </summary>
491
+
485
492
  """
486
493
  GetDllLibXls().Workbook_get_HasTrackedChanges.argtypes=[c_void_p]
487
494
  GetDllLibXls().Workbook_get_HasTrackedChanges.restype=c_bool
@@ -490,27 +497,24 @@ class Workbook (SpireObject) :
490
497
 
491
498
  def RejectAllTrackedChanges(self):
492
499
  """
493
- <summary>
494
- Reject all tracked changes in the workbook.
495
- </summary>
500
+ Reject all tracked changes in the workbook.
501
+
496
502
  """
497
503
  GetDllLibXls().Workbook_RejectAllTrackedChanges.argtypes=[c_void_p]
498
504
  CallCFunction(GetDllLibXls().Workbook_RejectAllTrackedChanges, self.Ptr)
499
505
 
500
506
  def AcceptAllTrackedChanges(self):
501
507
  """
502
- <summary>
503
- Accept all tracked changes in the workbook.
504
- </summary>
508
+ Accept all tracked changes in the workbook.
509
+
505
510
  """
506
511
  GetDllLibXls().Workbook_AcceptAllTrackedChanges.argtypes=[c_void_p]
507
512
  CallCFunction(GetDllLibXls().Workbook_AcceptAllTrackedChanges, self.Ptr)
508
513
 
509
514
  def TrackedChanges(self,switchValue:bool):
510
515
  """
511
- <summary>
512
516
  Turn revision mode on or off.
513
- </summary>
517
+
514
518
  """
515
519
  GetDllLibXls().Workbook_TrackedChanges.argtypes=[c_void_p,c_bool]
516
520
  CallCFunction(GetDllLibXls().Workbook_TrackedChanges, self.Ptr,switchValue)
@@ -540,10 +544,11 @@ class Workbook (SpireObject) :
540
544
 
541
545
  def GetDigitalSignatures(self)->'IDigitalSignatures':
542
546
  """
543
- <summary>
544
547
  Get collection of DigitalSignature in this file.
545
- </summary>
546
- <returns>Collection of DigitalSignature</returns>
548
+
549
+ Returns:
550
+ Collection of DigitalSignature
551
+
547
552
  """
548
553
  GetDllLibXls().Workbook_GetDigitalSignatures.argtypes=[c_void_p]
549
554
  GetDllLibXls().Workbook_GetDigitalSignatures.restype=c_void_p
@@ -554,9 +559,8 @@ class Workbook (SpireObject) :
554
559
 
555
560
  def RemoveAllDigitalSignatures(self):
556
561
  """
557
- <summary>
558
562
  Remove all DigitalSignature in this file.
559
- </summary>
563
+
560
564
  """
561
565
  GetDllLibXls().Workbook_RemoveAllDigitalSignatures.argtypes=[c_void_p]
562
566
  CallCFunction(GetDllLibXls().Workbook_RemoveAllDigitalSignatures, self.Ptr)
@@ -564,9 +568,8 @@ class Workbook (SpireObject) :
564
568
  @property
565
569
  def IsDigitallySigned(self)->bool:
566
570
  """
567
- <summary>
568
571
  Indicates whether this spreadsheet is digitally signed.
569
- </summary>
572
+
570
573
  """
571
574
  GetDllLibXls().Workbook_get_IsDigitallySigned.argtypes=[c_void_p]
572
575
  GetDllLibXls().Workbook_get_IsDigitallySigned.restype=c_bool
@@ -576,11 +579,14 @@ class Workbook (SpireObject) :
576
579
 
577
580
  def GetThemeColor(self ,type:'ThemeColorType')->'Color':
578
581
  """
579
- <summary>
580
582
  Gets theme color.
581
- </summary>
582
- <param name="type">The theme color type.</param>
583
- <returns>The theme color.</returns>
583
+
584
+ Args:
585
+ type: The theme color type.
586
+
587
+ Returns:
588
+ The theme color.
589
+
584
590
  """
585
591
  enumtype:c_int = type.value
586
592
 
@@ -594,11 +600,12 @@ class Workbook (SpireObject) :
594
600
 
595
601
  def SetThemeColor(self ,type:'ThemeColorType',color:'Color'):
596
602
  """
597
- <summary>
598
603
  Sets the theme color
599
- </summary>
600
- <param name="type">The theme color type.</param>
601
- <param name="color">the theme color</param>
604
+
605
+ Args:
606
+ type: The theme color type.
607
+ color: the theme color
608
+
602
609
  """
603
610
  enumtype:c_int = type.value
604
611
  intPtrcolor:c_void_p = color.Ptr
@@ -609,10 +616,11 @@ class Workbook (SpireObject) :
609
616
 
610
617
  def CopyTheme(self ,srcWorkbook:'Workbook'):
611
618
  """
612
- <summary>
613
619
  Copy the theme from source workbook
614
- </summary>
615
- <param name="srcWorkbook">source workbook.</param>
620
+
621
+ Args:
622
+ srcWorkbook: source workbook.
623
+
616
624
  """
617
625
  intPtrsrcWorkbook:c_void_p = srcWorkbook.Ptr
618
626
 
@@ -622,10 +630,11 @@ class Workbook (SpireObject) :
622
630
 
623
631
  def CopyThemeColor(self ,srcWorkbook:'Workbook'):
624
632
  """
625
- <summary>
626
633
  Copy the theme color from source workbook
627
- </summary>
628
- <param name="srcWorkbook">source workbook.</param>
634
+
635
+ Args:
636
+ srcWorkbook: source workbook.
637
+
629
638
  """
630
639
  intPtrsrcWorkbook:c_void_p = srcWorkbook.Ptr
631
640
 
@@ -636,10 +645,11 @@ class Workbook (SpireObject) :
636
645
 
637
646
  def LoadFromFile(self ,fileName:str):
638
647
  """
639
- <summary>
640
- Loads a file and imports its data.
641
- </summary>
642
- <param name="FileName">File name.</param>
648
+ Loads a file and imports its data.
649
+
650
+ Args:
651
+ FileName: File name.
652
+
643
653
  """
644
654
 
645
655
  GetDllLibXls().Workbook_LoadFromFile.argtypes=[c_void_p ,c_void_p]
@@ -649,11 +659,12 @@ class Workbook (SpireObject) :
649
659
 
650
660
  def LoadFromFile(self ,fileName:str,preserveMode:bool):
651
661
  """
652
- <summary>
653
- Loads a file and imports its data.
654
- </summary>
655
- <param name="fileName">File name</param>
656
- <param name="preserveMode">Preserve mode</param>
662
+ Loads a file and imports its data.
663
+
664
+ Args:
665
+ fileName: File name
666
+ preserveMode: Preserve mode
667
+
657
668
  """
658
669
 
659
670
  GetDllLibXls().Workbook_LoadFromFileByMode.argtypes=[c_void_p ,c_void_p,c_bool]
@@ -663,11 +674,12 @@ class Workbook (SpireObject) :
663
674
 
664
675
  def LoadFromFile(self ,fileName:str,version:ExcelVersion):
665
676
  """
666
- <summary>
667
- Loads a file and imports its data.
668
- </summary>
669
- <param name="fileName">File name</param>
670
- <param name="version">Excel version</param>
677
+ Loads a file and imports its data.
678
+
679
+ Args:
680
+ fileName: File name
681
+ version: Excel version
682
+
671
683
  """
672
684
  enumversion:c_int = version.value
673
685
 
@@ -678,11 +690,12 @@ class Workbook (SpireObject) :
678
690
 
679
691
  def LoadFromFile(self ,fileName:str,separator:str):
680
692
  """
681
- <summary>
682
- Loads text files stream with user defined separator.
683
- </summary>
684
- <param name="fileName">File name</param>
685
- <param name="separator">Delimiter of text file. </param>
693
+ Loads text files stream with user defined separator.
694
+
695
+ Args:
696
+ fileName: File name
697
+ separator: Delimiter of text file.
698
+
686
699
  """
687
700
 
688
701
  GetDllLibXls().Workbook_LoadFromFileBySeparator.argtypes=[c_void_p ,c_void_p,c_void_p]
@@ -692,13 +705,14 @@ class Workbook (SpireObject) :
692
705
 
693
706
  def LoadFromFile(self ,fileName:str,separator:str,row:int,column:int):
694
707
  """
695
- <summary>
696
708
  Loads text files with user defined separator.
697
- </summary>
698
- <param name="fileName">File name.</param>
699
- <param name="separator">Delimiter of text file.</param>
700
- <param name="row">Start row.</param>
701
- <param name="column">Start column.</param>
709
+
710
+ Args:
711
+ fileName: File name.
712
+ separator: Delimiter of text file.
713
+ row: Start row.
714
+ column: Start column.
715
+
702
716
  """
703
717
 
704
718
  GetDllLibXls().Workbook_LoadFromFileBySRC.argtypes=[c_void_p ,c_void_p,c_void_p,c_int,c_int]
@@ -708,14 +722,15 @@ class Workbook (SpireObject) :
708
722
 
709
723
  def LoadFromFile(self ,fileName:str,separator:str,row:int,column:int,version:ExcelVersion):
710
724
  """
711
- <summary>
712
725
  Loads text files with user defined separator.
713
- </summary>
714
- <param name="fileName">File name.</param>
715
- <param name="separator">Delimiter of text file.</param>
716
- <param name="row">Start row.</param>
717
- <param name="column">Start column.</param>
718
- <param name="version">workbook version</param>
726
+
727
+ Args:
728
+ fileName: File name.
729
+ separator: Delimiter of text file.
730
+ row: Start row.
731
+ column: Start column.
732
+ version: workbook version
733
+
719
734
  """
720
735
  enumversion:c_int = version.value
721
736
 
@@ -726,15 +741,16 @@ class Workbook (SpireObject) :
726
741
 
727
742
  def LoadFromFile(self ,fileName:str,separator:str,row:int,column:int,version:ExcelVersion,encoding:Encoding):
728
743
  """
729
- <summary>
730
744
  Loads text files with user defined separator.
731
- </summary>
732
- <param name="fileName">File name.</param>
733
- <param name="separator">Delimiter of text file.</param>
734
- <param name="row">Start row.</param>
735
- <param name="column">Start column.</param>
736
- <param name="version">workbook version</param>
737
- <param name="encoding">Text Encoding</param>
745
+
746
+ Args:
747
+ fileName: File name.
748
+ separator: Delimiter of text file.
749
+ row: Start row.
750
+ column: Start column.
751
+ version: workbook version
752
+ encoding: Text Encoding
753
+
738
754
  """
739
755
  enumversion:c_int = version.value
740
756
  intPtrencoding:c_void_p = encoding.Ptr
@@ -746,10 +762,11 @@ class Workbook (SpireObject) :
746
762
 
747
763
  def LoadFromStream(self ,stream:Stream):
748
764
  """
749
- <summary>
750
765
  Load workbook from the stream.
751
- </summary>
752
- <param name="stream">Stream contains data.</param>
766
+
767
+ Args:
768
+ stream: Stream contains data.
769
+
753
770
  """
754
771
  intPtrstream:c_void_p = stream.Ptr
755
772
 
@@ -760,11 +777,12 @@ class Workbook (SpireObject) :
760
777
 
761
778
  def LoadFromStream(self ,stream:Stream,loadStyles:bool):
762
779
  """
763
- <summary>
764
780
  Load workbook from the stream.
765
- </summary>
766
- <param name="stream">Stream contains data.</param>
767
- <param name="loadStyles">Indicates whether loads styles.</param>
781
+
782
+ Args:
783
+ stream: Stream contains data.
784
+ loadStyles: Indicates whether loads styles.
785
+
768
786
  """
769
787
  intPtrstream:c_void_p = stream.Ptr
770
788
 
@@ -775,11 +793,12 @@ class Workbook (SpireObject) :
775
793
 
776
794
  def LoadFromStream(self ,stream:Stream,version:ExcelVersion):
777
795
  """
778
- <summary>
779
796
  Load workbook from the stream.
780
- </summary>
781
- <param name="stream">Stream contains data</param>
782
- <param name="version">Excel version</param>
797
+
798
+ Args:
799
+ stream: Stream contains data
800
+ version: Excel version
801
+
783
802
  """
784
803
  intPtrstream:c_void_p = stream.Ptr
785
804
  enumversion:c_int = version.value
@@ -791,13 +810,14 @@ class Workbook (SpireObject) :
791
810
 
792
811
  def LoadFromStream(self ,stream:Stream,separator:str,row:int,column:int):
793
812
  """
794
- <summary>
795
813
  Loads text files stream with user defined separator.max row 60000.
796
- </summary>
797
- <param name="stream">File stream.</param>
798
- <param name="separator">Delimiter of text file.</param>
799
- <param name="row">Start row.</param>
800
- <param name="column">Start column.</param>
814
+
815
+ Args:
816
+ stream: File stream.
817
+ separator: Delimiter of text file.
818
+ row: Start row.
819
+ column: Start column.
820
+
801
821
  """
802
822
  intPtrstream:c_void_p = stream.Ptr
803
823
 
@@ -808,14 +828,15 @@ class Workbook (SpireObject) :
808
828
 
809
829
  def LoadFromStream(self ,stream:Stream,separator:str,row:int,column:int,version:ExcelVersion):
810
830
  """
811
- <summary>
812
- Loads text files stream with user defined separator. Version2007 support 60000+ row
813
- </summary>
814
- <param name="stream">File stream.</param>
815
- <param name="separator">Delimiter of text file.</param>
816
- <param name="row">Start row.</param>
817
- <param name="column">Start column.</param>
818
- <param name="version">Excel version.</param>
831
+ Loads text files stream with user defined separator. Version2007 support 60000+ row
832
+
833
+ Args:
834
+ stream: File stream.
835
+ separator: Delimiter of text file.
836
+ row: Start row.
837
+ column: Start column.
838
+ version: Excel version.
839
+
819
840
  """
820
841
  intPtrstream:c_void_p = stream.Ptr
821
842
  enumversion:c_int = version.value
@@ -827,10 +848,11 @@ class Workbook (SpireObject) :
827
848
 
828
849
  def LoadFromXml(self ,fileName:str):
829
850
  """
830
- <summary>
831
- Loads a xml file and imports its data.
832
- </summary>
833
- <param name="fileName">File name.</param>
851
+ Loads a xml file and imports its data.
852
+
853
+ Args:
854
+ fileName: File name.
855
+
834
856
  """
835
857
 
836
858
  GetDllLibXls().Workbook_LoadFromXml.argtypes=[c_void_p ,c_void_p]
@@ -840,10 +862,11 @@ class Workbook (SpireObject) :
840
862
 
841
863
  def LoadFromXml(self ,stream:Stream):
842
864
  """
843
- <summary>
844
- Loads a xml file and imports its data.
845
- </summary>
846
- <param name="stream">Stream contains data.</param>
865
+ Loads a xml file and imports its data.
866
+
867
+ Args:
868
+ stream: Stream contains data.
869
+
847
870
  """
848
871
  intPtrstream:c_void_p = stream.Ptr
849
872
 
@@ -854,10 +877,11 @@ class Workbook (SpireObject) :
854
877
 
855
878
  def LoadFromHtml(self ,fileName:str):
856
879
  """
857
- <summary>
858
- Loads a html file and imports its data.
859
- </summary>
860
- <param name="fileName">File name.</param>
880
+ Loads a html file and imports its data.
881
+
882
+ Args:
883
+ fileName: File name.
884
+
861
885
  """
862
886
 
863
887
  GetDllLibXls().Workbook_LoadFromHtml.argtypes=[c_void_p ,c_void_p]
@@ -867,10 +891,11 @@ class Workbook (SpireObject) :
867
891
 
868
892
  def LoadFromHtml(self ,stream:Stream):
869
893
  """
870
- <summary>
871
- Loads a html file and imports its data.
872
- </summary>
873
- <param name="stream">Stream contains data.</param>
894
+ Loads a html file and imports its data.
895
+
896
+ Args:
897
+ stream: Stream contains data.
898
+
874
899
  """
875
900
  intPtrstream:c_void_p = stream.Ptr
876
901
 
@@ -881,10 +906,11 @@ class Workbook (SpireObject) :
881
906
 
882
907
  def LoadFromMHtml(self ,fileName:str):
883
908
  """
884
- <summary>
885
- Loads a Mhtml file and imports its data.
886
- </summary>
887
- <param name="fileName">File name.</param>
909
+ Loads a Mhtml file and imports its data.
910
+
911
+ Args:
912
+ fileName: File name.
913
+
888
914
  """
889
915
 
890
916
  GetDllLibXls().Workbook_LoadFromMHtml.argtypes=[c_void_p ,c_void_p]
@@ -894,10 +920,11 @@ class Workbook (SpireObject) :
894
920
 
895
921
  def LoadFromMHtml(self ,stream:Stream):
896
922
  """
897
- <summary>
898
- Loads a Mhtml file and imports its data.
899
- </summary>
900
- <param name="stream">Stream contains data.</param>
923
+ Loads a Mhtml file and imports its data.
924
+
925
+ Args:
926
+ stream: Stream contains data.
927
+
901
928
  """
902
929
  intPtrstream:c_void_p = stream.Ptr
903
930
 
@@ -908,10 +935,11 @@ class Workbook (SpireObject) :
908
935
 
909
936
  def LoadTemplateFromFile(self ,fileName:str):
910
937
  """
911
- <summary>
912
938
  Load workbook from the excel template.
913
- </summary>
914
- <param name="fileName">File name</param>
939
+
940
+ Args:
941
+ fileName: File name
942
+
915
943
  """
916
944
 
917
945
  GetDllLibXls().Workbook_LoadTemplateFromFile.argtypes=[c_void_p ,c_void_p]
@@ -921,11 +949,12 @@ class Workbook (SpireObject) :
921
949
 
922
950
  def LoadTemplateFromFile(self ,fileName:str,loadStyles:bool):
923
951
  """
924
- <summary>
925
952
  Load workbook from the excel template.
926
- </summary>
927
- <param name="fileName">File name</param>
928
- <param name="loadStyles">Indicates whehter load styles.</param>
953
+
954
+ Args:
955
+ fileName: File name
956
+ loadStyles: Indicates whehter load styles.
957
+
929
958
  """
930
959
 
931
960
  GetDllLibXls().Workbook_LoadTemplateFromFileFL.argtypes=[c_void_p ,c_void_p,c_bool]
@@ -935,10 +964,11 @@ class Workbook (SpireObject) :
935
964
 
936
965
  def SaveToHtml(self ,fileName:str):
937
966
  """
938
- <summary>
939
967
  Saves the workbook to html
940
- </summary>
941
- <param name="fileName">File name.</param>
968
+
969
+ Args:
970
+ fileName: File name.
971
+
942
972
  """
943
973
 
944
974
  GetDllLibXls().Workbook_SaveToHtml.argtypes=[c_void_p ,c_void_p]
@@ -948,11 +978,12 @@ class Workbook (SpireObject) :
948
978
 
949
979
  def SaveToHtml(self ,fileName:str,skipHideSheet:bool):
950
980
  """
951
- <summary>
952
981
  Saves the workbook to html
953
- </summary>
954
- <param name="fileName">File name.</param>
955
- <param name="skipHideSheet">Whether skip hidden sheet.</param>
982
+
983
+ Args:
984
+ fileName: File name.
985
+ skipHideSheet: Whether skip hidden sheet.
986
+
956
987
  """
957
988
 
958
989
  GetDllLibXls().Workbook_SaveToHtmlS.argtypes=[c_void_p ,c_void_p,c_bool]
@@ -962,10 +993,11 @@ class Workbook (SpireObject) :
962
993
 
963
994
  def SaveToFile(self ,fileName:str):
964
995
  """
965
- <summary>
966
996
  Saves changes to the workbook in a different file
967
- </summary>
968
- <param name="fileName">File name.</param>
997
+
998
+ Args:
999
+ fileName: File name.
1000
+
969
1001
  """
970
1002
 
971
1003
  GetDllLibXls().Workbook_SaveToFile.argtypes=[c_void_p ,c_void_p]
@@ -975,11 +1007,12 @@ class Workbook (SpireObject) :
975
1007
 
976
1008
  def SaveToFile(self ,fileName:str,fileFormat:FileFormat):
977
1009
  """
978
- <summary>
979
1010
  Saves changes to the workbook in a different file
980
- </summary>
981
- <param name="fileName">File name</param>
982
- <param name="fileFormat">File format</param>
1011
+
1012
+ Args:
1013
+ fileName: File name
1014
+ fileFormat: File format
1015
+
983
1016
  """
984
1017
  enumfileFormat:c_int = fileFormat.value
985
1018
 
@@ -990,20 +1023,19 @@ class Workbook (SpireObject) :
990
1023
 
991
1024
  def SaveToFile(self ,fileName:str,separator:str):
992
1025
  """
993
- <summary>
994
- Saves changes to the workbook in a different file.
995
- <example>The following code illustrates how to save the active worksheet in a different file with separator:
996
- <code>
997
- //Create workbook
998
- Workbook workbook = new Workbook();
999
- workbook.LoadFromFile("Sample.xlsx");
1000
- //Save to file
1001
- workbook.SaveToFile("Result.csv" , ",");
1002
- </code>
1003
- </example>
1004
- </summary>
1005
- <param name="fileName">File name.</param>
1006
- <param name="separator">Current separator.</param>
1026
+ Saves changes to the workbook in a different file.
1027
+
1028
+ Args:
1029
+ fileName: File name.
1030
+ separator: Current separator.
1031
+ Example::
1032
+
1033
+ #Create workbook
1034
+ workbook = Workbook()
1035
+ workbook.LoadFromFile("Sample.xlsx")
1036
+ #Save to file
1037
+ workbook.SaveToFile("Result.csv" , ",")
1038
+
1007
1039
  """
1008
1040
 
1009
1041
  GetDllLibXls().Workbook_SaveToFileS.argtypes=[c_void_p ,c_void_p,c_void_p]
@@ -1013,22 +1045,21 @@ class Workbook (SpireObject) :
1013
1045
 
1014
1046
  def SaveToFile(self ,fileName:str,separator:str,addQuotationsForStringValue:bool):
1015
1047
  """
1016
- <summary>
1017
1048
  Saves changes to the workbook in a different file.
1018
- <example>The following code illustrates how to save the active worksheet in a different file with separator:
1019
- <code>
1020
- <para>//Create workbook</para>
1021
- <para>Workbook workbook = new Workbook();</para>
1022
- <para>workbook.LoadFromFile("Sample.xlsx");</para>
1023
-
1024
- <para>//Save to file</para>
1025
- <para>workbook.SaveToFile("Result.csv" , ",", true);</para>
1026
- </code>
1027
- </example>
1028
- </summary>
1029
- <param name="fileName">File name.</param>
1030
- <param name="separator">Current separator.</param>
1031
- <param name="addQuotationsForStringValue">Add double Quotation marks for string value.</param>
1049
+
1050
+ Args:
1051
+ fileName: File name.
1052
+ separator: Current separator.
1053
+ addQuotationsForStringValue: Add double Quotation marks for string value.
1054
+ Example::
1055
+
1056
+ <para>#Create workbook</para>
1057
+ <para>workbook = Workbook();</para>
1058
+ <para>workbook.LoadFromFile("Sample.xlsx");</para>
1059
+
1060
+ <para>#Save to file</para>
1061
+ <para>workbook.SaveToFile("Result.csv" , ",", true);</para>
1062
+
1032
1063
  """
1033
1064
 
1034
1065
  GetDllLibXls().Workbook_SaveToFileFSA.argtypes=[c_void_p ,c_void_p,c_void_p,c_bool]
@@ -1038,12 +1069,13 @@ class Workbook (SpireObject) :
1038
1069
 
1039
1070
  def SaveToFile(self ,fileName:str,fileFormat:FileFormat,retainHiddenDataToCSV:bool):
1040
1071
  """
1041
- <summary>
1042
1072
  Saves changes to the workbook in a different file
1043
- </summary>
1044
- <param name="fileName">File name</param>
1045
- <param name="fileFormat">File format</param>
1046
- <param name="retainHiddenDataToCSV">Retain hidden data when save to csv.</param>
1073
+
1074
+ Args:
1075
+ fileName: File name
1076
+ fileFormat: File format
1077
+ retainHiddenDataToCSV: Retain hidden data when save to csv.
1078
+
1047
1079
  """
1048
1080
  enumfileFormat:c_int = fileFormat.value
1049
1081
 
@@ -1054,11 +1086,12 @@ class Workbook (SpireObject) :
1054
1086
 
1055
1087
  def SaveToFile(self ,fileName:str,textSaveOptions:TextSaveOptions):
1056
1088
  """
1057
- <summary>
1058
1089
  Saves changes to the workbook in a different file
1059
- </summary>
1060
- <param name="fileName">File name</param>
1061
- <param name="textSaveOptions">Text save options.</param>
1090
+
1091
+ Args:
1092
+ fileName: File name
1093
+ textSaveOptions: Text save options.
1094
+
1062
1095
  """
1063
1096
  intPtrtextSaveOptions:c_void_p = textSaveOptions.Ptr
1064
1097
 
@@ -1069,11 +1102,12 @@ class Workbook (SpireObject) :
1069
1102
 
1070
1103
  def SaveToFile(self ,fileName:str,version:ExcelVersion):
1071
1104
  """
1072
- <summary>
1073
1105
  Saves changes to the workbook in a different file
1074
- </summary>
1075
- <param name="fileName">File name</param>
1076
- <param name="version">Excel version</param>
1106
+
1107
+ Args:
1108
+ fileName: File name
1109
+ version: Excel version
1110
+
1077
1111
  """
1078
1112
  enumversion:c_int = version.value
1079
1113
 
@@ -1100,11 +1134,11 @@ class Workbook (SpireObject) :
1100
1134
 
1101
1135
  def CaculateFormulaValue(self ,text:str)->'str':
1102
1136
  """
1103
- <summary>
1104
1137
  Computes the string formula
1105
- </summary>
1106
- <param name="text"></param>
1107
- <returns></returns>
1138
+
1139
+ Args:
1140
+ text:
1141
+
1108
1142
  """
1109
1143
 
1110
1144
  GetDllLibXls().Workbook_CaculateFormulaValue.argtypes=[c_void_p ,c_void_p]
@@ -1116,9 +1150,8 @@ class Workbook (SpireObject) :
1116
1150
 
1117
1151
  def CalculateAllValue(self):
1118
1152
  """
1119
- <summary>
1120
1153
  Caculate all formula for the workbook
1121
- </summary>
1154
+
1122
1155
  """
1123
1156
  GetDllLibXls().Workbook_CalculateAllValue.argtypes=[c_void_p]
1124
1157
  CallCFunction(GetDllLibXls().Workbook_CalculateAllValue, self.Ptr)
@@ -1126,24 +1159,23 @@ class Workbook (SpireObject) :
1126
1159
 
1127
1160
  def ChangePaletteColor(self ,color:'Color',index:int):
1128
1161
  """
1129
- <summary>
1130
- Changes the palette for the spreadsheet in the specified index.
1131
- <example>The following code snippet illustrates how to set palette color:
1132
- <code>
1133
- //Create worksheet
1134
- Workbook workbook = new Workbook();
1135
- Worksheet worksheet = workbook.Worksheets[0];
1136
- //Set palette color
1137
- workbook.ChangePaletteColor(System.Drawing.Color.Red , 10);
1138
- //Set color
1139
- worksheet["B2"].Style.Color = workbook.Colors[10];
1140
- //Save to file
1141
- workbook.SaveToFile("CellFormats.xlsx");
1142
- </code>
1143
- </example>
1144
- </summary>
1145
- <param name="color">Color structure</param>
1146
- <param name="index">Palette index,Value should be from 0 to 55</param>
1162
+ Changes the palette for the spreadsheet in the specified index.
1163
+
1164
+ Args:
1165
+ color: Color structure
1166
+ index: Palette index,Value should be from 0 to 55
1167
+ Example::
1168
+
1169
+ #Create worksheet
1170
+ workbook = Workbook()
1171
+ worksheet = workbook.Worksheets[0]
1172
+ #Set palette color
1173
+ workbook.ChangePaletteColor(System.Drawing.Color.Red , 10)
1174
+ #Set color
1175
+ worksheet["B2"].Style.Color = workbook.Colors[10]
1176
+ #Save to file
1177
+ workbook.SaveToFile("CellFormats.xlsx")
1178
+
1147
1179
  """
1148
1180
  intPtrcolor:c_void_p = color.Ptr
1149
1181
 
@@ -1153,11 +1185,14 @@ class Workbook (SpireObject) :
1153
1185
 
1154
1186
  def ColumnWidthToPixels(self ,columnWidth:float)->float:
1155
1187
  """
1156
- <summary>
1157
1188
  onverts column width in characters into column width in pixels.
1158
- </summary>
1159
- <param name="columnWidth">Column width in characters.</param>
1160
- <returns>Column width in pixels.</returns>
1189
+
1190
+ Args:
1191
+ columnWidth: Column width in characters.
1192
+
1193
+ Returns:
1194
+ Column width in pixels.
1195
+
1161
1196
  """
1162
1197
 
1163
1198
  GetDllLibXls().Workbook_ColumnWidthToPixels.argtypes=[c_void_p ,c_double]
@@ -1168,11 +1203,11 @@ class Workbook (SpireObject) :
1168
1203
 
1169
1204
  def ContainsFont(self ,font:'ExcelFont')->bool:
1170
1205
  """
1171
- <summary>
1172
1206
  Indicates whether the workbook contains specified font.
1173
- </summary>
1174
- <param name="font"></param>
1175
- <returns></returns>
1207
+
1208
+ Args:
1209
+ font:
1210
+
1176
1211
  """
1177
1212
  intPtrfont:c_void_p = font.Ptr
1178
1213
 
@@ -1184,9 +1219,8 @@ class Workbook (SpireObject) :
1184
1219
  @dispatch
1185
1220
  def CopyToClipboard(self):
1186
1221
  """
1187
- <summary>
1188
1222
  Copies whole workbook to the clipboard.
1189
- </summary>
1223
+
1190
1224
  """
1191
1225
  GetDllLibXls().Workbook_CopyToClipboard.argtypes=[c_void_p]
1192
1226
  CallCFunction(GetDllLibXls().Workbook_CopyToClipboard, self.Ptr)
@@ -1195,10 +1229,11 @@ class Workbook (SpireObject) :
1195
1229
 
1196
1230
  def CopyToClipboard(self ,worksheet:Worksheet):
1197
1231
  """
1198
- <summary>
1199
1232
  Copies the selected worksheet to clipboard.
1200
- </summary>
1201
- <param name="worksheet"></param>
1233
+
1234
+ Args:
1235
+ worksheet:
1236
+
1202
1237
  """
1203
1238
  intPtrworksheet:c_void_p = worksheet.Ptr
1204
1239
 
@@ -1209,10 +1244,8 @@ class Workbook (SpireObject) :
1209
1244
 
1210
1245
  def CreateEmptySheet(self)->Worksheet:
1211
1246
  """
1212
- <summary>
1213
1247
  Create a new worksheet.
1214
- </summary>
1215
- <returns></returns>
1248
+
1216
1249
  """
1217
1250
  GetDllLibXls().Workbook_CreateEmptySheet.argtypes=[c_void_p]
1218
1251
  GetDllLibXls().Workbook_CreateEmptySheet.restype=c_void_p
@@ -1225,11 +1258,11 @@ class Workbook (SpireObject) :
1225
1258
 
1226
1259
  def CreateEmptySheet(self ,name:str)->Worksheet:
1227
1260
  """
1228
- <summary>
1229
- Create a new worksheet.
1230
- </summary>
1231
- <param name="name">Sheet name.</param>
1232
- <returns></returns>
1261
+ Create a new worksheet.
1262
+
1263
+ Args:
1264
+ name: Sheet name.
1265
+
1233
1266
  """
1234
1267
 
1235
1268
  GetDllLibXls().Workbook_CreateEmptySheetN.argtypes=[c_void_p ,c_void_p]
@@ -1243,10 +1276,11 @@ class Workbook (SpireObject) :
1243
1276
 
1244
1277
  def CreateEmptySheets(self ,sheetCount:int):
1245
1278
  """
1246
- <summary>
1247
1279
  Create workbook with specified number of worksheets.
1248
- </summary>
1249
- <param name="sheetCount"></param>
1280
+
1281
+ Args:
1282
+ sheetCount:
1283
+
1250
1284
  """
1251
1285
 
1252
1286
  GetDllLibXls().Workbook_CreateEmptySheets.argtypes=[c_void_p ,c_int]
@@ -1256,10 +1290,11 @@ class Workbook (SpireObject) :
1256
1290
 
1257
1291
  def CreateEmptySheets(self ,sheetNames:List[str]):
1258
1292
  """
1259
- <summary>
1260
1293
  Create workbook with specified names of worksheets.
1261
- </summary>
1262
- <param name="sheetNames"></param>
1294
+
1295
+ Args:
1296
+ sheetNames:
1297
+
1263
1298
  """
1264
1299
  #arraysheetNames:ArrayTypesheetNames = ""
1265
1300
  countsheetNames = len(sheetNames)
@@ -1276,29 +1311,25 @@ class Workbook (SpireObject) :
1276
1311
 
1277
1312
  def CreateFont(self)->ExcelFont:
1278
1313
  """
1279
- <summary>
1280
- Creates a font object and add it to the workbook.
1281
- <example>The following code illustrates how to create IFont object:
1282
- <code>
1283
- //Create worksheet
1284
- Workbook workbook = new Workbook();
1285
- Worksheet worksheet = workbook.Worksheets[0];
1286
- //Set text
1287
- IRichTextString richText = worksheet["B2"].RichText;
1288
- //Create font
1289
- IFont font = workbook.CreateFont();
1290
- //Set color
1291
- font.Color = Color.Red;
1292
- //Set text
1293
- richText.Text = "Sample";
1294
- //Set font
1295
- richText.SetFont(0, 5, font);
1296
- //Save to file
1297
- workbook.SaveToFile("CellFormats.xlsx");
1298
- </code>
1299
- </example>
1300
- </summary>
1301
- <returns></returns>
1314
+ Creates a font object and add it to the workbook.
1315
+ Example::
1316
+
1317
+ #Create worksheet
1318
+ workbook = Workbook()
1319
+ worksheet = workbook.Worksheets[0]
1320
+ #Set text
1321
+ richText = worksheet["B2"].RichText
1322
+ #Create font
1323
+ font = workbook.CreateFont()
1324
+ #Set color
1325
+ font.Color = Color.Red
1326
+ #Set text
1327
+ richText.Text = "Sample"
1328
+ #Set font
1329
+ richText.SetFont(0, 5, font)
1330
+ #Save to file
1331
+ workbook.SaveToFile("CellFormats.xlsx")
1332
+
1302
1333
  """
1303
1334
  GetDllLibXls().Workbook_CreateFont.argtypes=[c_void_p]
1304
1335
  GetDllLibXls().Workbook_CreateFont.restype=c_void_p
@@ -1474,20 +1505,21 @@ class Workbook (SpireObject) :
1474
1505
 
1475
1506
  def FindBool(self ,boolValue:bool)->'CellRange':
1476
1507
  """
1477
- <summary>
1478
- Finds the cell with the input bool.
1479
- <example>This sample shows how to find the first cell with specified bool value:
1480
- <code>
1481
- //Create workbook
1482
- Workbook workbook = new Workbook();
1483
- workbook.LoadFromFile("Sample.xlsx");
1484
- //Find cell with specified bool value
1485
- IXLSRange result = workbook.FindBool(true);
1486
- </code>
1487
- </example>
1488
- </summary>
1489
- <param name="boolValue">Bool value to search for.</param>
1490
- <returns>Found range.</returns>
1508
+ Finds the cell with the input bool.
1509
+
1510
+ Args:
1511
+ boolValue: Bool value to search for.
1512
+
1513
+ Returns:
1514
+ Found range.
1515
+ Example::
1516
+
1517
+ #Create workbook
1518
+ workbook = Workbook()
1519
+ workbook.LoadFromFile("Sample.xlsx")
1520
+ #Find cell with specified bool value
1521
+ result = workbook.FindBool(true)
1522
+
1491
1523
  """
1492
1524
 
1493
1525
  GetDllLibXls().Workbook_FindBool.argtypes=[c_void_p ,c_bool]
@@ -1500,22 +1532,23 @@ class Workbook (SpireObject) :
1500
1532
 
1501
1533
  def FindNumber(self ,doubleValue:float,formulaValue:bool)->'CellRange':
1502
1534
  """
1503
- <summary>
1504
- Finds the cell with the input number.
1505
- <example>This sample shows how to find the first cell with specified double value:
1506
- <code>
1507
- //Create workbook
1508
- Workbook workbook = new Workbook();
1509
- workbook.LoadFromFile("Sample.xlsx");
1510
- //Find cell with specified double value
1511
- double value = 9.00;
1512
- IXLSRange result = workbook.FindNumber(value, false);
1513
- </code>
1514
- </example>
1515
- </summary>
1516
- <param name="doubleValue">Double value to search for.</param>
1517
- <param name="formulaValue">Indicates whether includes formula value to search for.</param>
1518
- <returns>Found range.</returns>
1535
+ Finds the cell with the input number.
1536
+
1537
+ Args:
1538
+ doubleValue: Double value to search for.
1539
+ formulaValue: Indicates whether includes formula value to search for.
1540
+
1541
+ Returns:
1542
+ Found range.
1543
+ Example::
1544
+
1545
+ #Create workbook
1546
+ workbook = Workbook()
1547
+ workbook.LoadFromFile("Sample.xlsx")
1548
+ #Find cell with specified double value
1549
+ value = 9.00
1550
+ result = workbook.FindNumber(value, false)
1551
+
1519
1552
  """
1520
1553
 
1521
1554
  GetDllLibXls().Workbook_FindNumber.argtypes=[c_void_p ,c_double,c_bool]
@@ -1528,23 +1561,24 @@ class Workbook (SpireObject) :
1528
1561
 
1529
1562
  def FindString(self ,stringValue:str,formula:bool,formulaValue:bool)->'CellRange':
1530
1563
  """
1531
- <summary>
1532
- Finds the cell with the input string.
1533
- <example>This sample shows how to find the first cell with specified string value:
1534
- <code>
1535
- //Create workbook
1536
- Workbook workbook = new Workbook();
1537
- workbook.LoadFromFile("Sample.xlsx");
1538
- //Find cell with specified string value
1539
- string value = "value";
1540
- IXLSRange result = workbook.FindString(value, false, false);
1541
- </code>
1542
- </example>
1543
- </summary>
1544
- <param name="stringValue">String value to search for.</param>
1545
- <param name="formula">Indicates whether includes formula to search for.</param>
1546
- <param name="formulaValue">Indicates whether includes formula value to search for.</param>
1547
- <returns>Found range.</returns>
1564
+ Finds the cell with the input string.
1565
+
1566
+ Args:
1567
+ stringValue: String value to search for.
1568
+ formula: Indicates whether includes formula to search for.
1569
+ formulaValue: Indicates whether includes formula value to search for.
1570
+
1571
+ Returns:
1572
+ Found range.
1573
+ Example::
1574
+
1575
+ #Create workbook
1576
+ workbook = Workbook()
1577
+ workbook.LoadFromFile("Sample.xlsx")
1578
+ #Find cell with specified string value
1579
+ value = "value"
1580
+ result = workbook.FindString(value, false, false)
1581
+
1548
1582
  """
1549
1583
 
1550
1584
  GetDllLibXls().Workbook_FindString.argtypes=[c_void_p ,c_void_p,c_bool,c_bool]
@@ -1557,21 +1591,22 @@ class Workbook (SpireObject) :
1557
1591
 
1558
1592
  def FindDateTime(self ,dateTimeValue:'DateTime')->'CellRange':
1559
1593
  """
1560
- <summary>
1561
- Finds the cell with the input datetime.
1562
- <example>This sample shows how to find the first cell with specified DataTime value:
1563
- <code>
1564
- //Create workbook
1565
- Workbook workbook = new Workbook();
1566
- workbook.LoadFromFile("Sample.xlsx");
1567
- //Find cell with specified DataTime value
1568
- DateTime dateTime = DateTime.Now;
1569
- IXLSRange result = workbook.FindDateTime(dateTime);
1570
- </code>
1571
- </example>
1572
- </summary>
1573
- <param name="dateTimeValue">Datetime value to search for.</param>
1574
- <returns>Found range.</returns>
1594
+ Finds the cell with the input datetime.
1595
+
1596
+ Args:
1597
+ dateTimeValue: Datetime value to search for.
1598
+
1599
+ Returns:
1600
+ Found range.
1601
+ Example::
1602
+
1603
+ #Create workbook
1604
+ workbook = Workbook()
1605
+ workbook.LoadFromFile("Sample.xlsx")
1606
+ #Find cell with specified DataTime value
1607
+ dateTime = DateTime.Now
1608
+ result = workbook.FindDateTime(dateTime)
1609
+
1575
1610
  """
1576
1611
  intPtrdateTimeValue:c_void_p = dateTimeValue.Ptr
1577
1612
 
@@ -1585,21 +1620,22 @@ class Workbook (SpireObject) :
1585
1620
 
1586
1621
  def FindTimeSpan(self ,timeSpanValue:'TimeSpan')->'CellRange':
1587
1622
  """
1588
- <summary>
1589
- Finds the cell with the input time span.
1590
- <example>This sample shows how to find the first cell with specified TimeSpan value:
1591
- <code>
1592
- //Create workbook
1593
- Workbook workbook = new Workbook();
1594
- workbook.LoadFromFile("Sample.xlsx");
1595
- //Find cell with specified TimeSpan value
1596
- TimeSpan timeSpan = new TimeSpan(2, 30, 30);
1597
- IXLSRange result = workbook.FindTimeSpan(timeSpan);
1598
- </code>
1599
- </example>
1600
- </summary>
1601
- <param name="timeSpanValue">Time span value to search for.</param>
1602
- <returns>Found range.</returns>
1623
+ Finds the cell with the input time span.
1624
+
1625
+ Args:
1626
+ timeSpanValue: Time span value to search for.
1627
+
1628
+ Returns:
1629
+ Found range.
1630
+ Example::
1631
+
1632
+ #Create workbook
1633
+ workbook = Workbook()
1634
+ workbook.LoadFromFile("Sample.xlsx")
1635
+ #Find cell with specified TimeSpan value
1636
+ timeSpan = new TimeSpan(2, 30, 30)
1637
+ result = workbook.FindTimeSpan(timeSpan)
1638
+
1603
1639
  """
1604
1640
  intPtrtimeSpanValue:c_void_p = timeSpanValue.Ptr
1605
1641
 
@@ -1614,24 +1650,25 @@ class Workbook (SpireObject) :
1614
1650
 
1615
1651
  def GetMatchingColor(self ,color:Color)->ExcelColors:
1616
1652
  """
1617
- <summary>
1618
- Find best matching Color in workbook palette.
1619
- <example>The following code illustrates how to get the indexed color from ExcelColors for the given color from Color structure:
1620
- <code>
1621
- //Create worksheet
1622
- Workbook workbook = new Workbook();
1623
- Worksheet worksheet = workbook.Worksheets[0];
1624
- //Get color
1625
- ExcelColors color = workbook.GetMatchingColor(System.Drawing.Color.Red);
1626
- //Set color
1627
- worksheet["B2"].Style.KnownColor = color;
1628
- //Save to file
1629
- workbook.SaveToFile("CellFormats.xlsx");
1630
- </code>
1631
- </example>
1632
- </summary>
1633
- <param name="color">Color to search for.</param>
1634
- <returns>Workbook palette color.</returns>
1653
+ Find best matching Color in workbook palette.
1654
+
1655
+ Args:
1656
+ color: Color to search for.
1657
+
1658
+ Returns:
1659
+ Workbook palette color.
1660
+ Example::
1661
+
1662
+ #Create worksheet
1663
+ workbook = Workbook()
1664
+ worksheet = workbook.Worksheets[0]
1665
+ #Get color
1666
+ color = workbook.GetMatchingColor(System.Drawing.Color.Red)
1667
+ #Set color
1668
+ worksheet["B2"].Style.KnownColor = color
1669
+ #Save to file
1670
+ workbook.SaveToFile("CellFormats.xlsx")
1671
+
1635
1672
  """
1636
1673
  intPtrcolor:c_void_p = color.Ptr
1637
1674
 
@@ -1645,26 +1682,27 @@ class Workbook (SpireObject) :
1645
1682
 
1646
1683
  def GetMatchingColor(self ,r:int,g:int,b:int)->ExcelColors:
1647
1684
  """
1648
- <summary>
1649
- Find best matching Color in workbook palette.
1650
- <example>The following code illustrates how to get the indexed color from ExcelColors for the given color from Color structure:
1651
- <code>
1652
- //Create worksheet
1653
- Workbook workbook = new Workbook();
1654
- Worksheet worksheet = workbook.Worksheets[0];
1655
- //Get color
1656
- ExcelColors color = workbook.GetMatchingColor(255, 0, 0);
1657
- //Set color
1658
- worksheet["B2"].Style.KnownColor = color;
1659
- //Save to file
1660
- workbook.SaveToFile("CellFormats.xlsx");
1661
- </code>
1662
- </example>
1663
- </summary>
1664
- <param name="r">Red color.</param>
1665
- <param name="g">Green color.</param>
1666
- <param name="b">Blue color.</param>
1667
- <returns>Workbook palette color.</returns>
1685
+ Find best matching Color in workbook palette.
1686
+
1687
+ Args:
1688
+ r: Red color.
1689
+ g: Green color.
1690
+ b: Blue color.
1691
+
1692
+ Returns:
1693
+ Workbook palette color.
1694
+ Example::
1695
+
1696
+ #Create worksheet
1697
+ workbook = Workbook()
1698
+ worksheet = workbook.Worksheets[0]
1699
+ #Get color
1700
+ color = workbook.GetMatchingColor(255, 0, 0)
1701
+ #Set color
1702
+ worksheet["B2"].Style.KnownColor = color
1703
+ #Save to file
1704
+ workbook.SaveToFile("CellFormats.xlsx")
1705
+
1668
1706
  """
1669
1707
 
1670
1708
  GetDllLibXls().Workbook_GetMatchingColorRGB.argtypes=[c_void_p ,c_int,c_int,c_int]
@@ -1676,24 +1714,25 @@ class Workbook (SpireObject) :
1676
1714
 
1677
1715
  def GetPaletteColor(self ,color:'ExcelColors')->'Color':
1678
1716
  """
1679
- <summary>
1680
- Gets excel color from workbook palette.
1681
- <example>The following code illustrates how to get the RGB color value for the specified color from ExcelColors enumeration:
1682
- <code>
1683
- //Create worksheet
1684
- Workbook workbook = new Workbook();
1685
- Worksheet worksheet = workbook.Worksheets[0];
1686
- //Get color
1687
- System.Drawing.Color color = workbook.GetPaletteColor(ExcelColors.Red);
1688
- //Set color
1689
- worksheet["B2"].Style.Color = workbook.Colors[10];
1690
- //Save to file
1691
- workbook.SaveToFile("CellFormats.xlsx");
1692
- </code>
1693
- </example>
1694
- </summary>
1695
- <param name="color">Index from palette array.</param>
1696
- <returns>RGB Color.</returns>
1717
+ Gets excel color from workbook palette.
1718
+
1719
+ Args:
1720
+ color: Index from palette array.
1721
+
1722
+ Returns:
1723
+ RGB Color.
1724
+ Example::
1725
+
1726
+ #Create worksheet
1727
+ workbook = Workbook()
1728
+ worksheet = workbook.Worksheets[0]
1729
+ #Get color
1730
+ System.Drawing.color = workbook.GetPaletteColor(ExcelColors.Red)
1731
+ #Set color
1732
+ worksheet["B2"].Style.Color = workbook.Colors[10]
1733
+ #Save to file
1734
+ workbook.SaveToFile("CellFormats.xlsx")
1735
+
1697
1736
  """
1698
1737
  enumcolor:c_int = color.value
1699
1738
 
@@ -1734,9 +1773,8 @@ class Workbook (SpireObject) :
1734
1773
 
1735
1774
  def InitCalcEngine(self):
1736
1775
  """
1737
- <summary>
1738
1776
  Initilize Calc engine
1739
- </summary>
1777
+
1740
1778
  """
1741
1779
  GetDllLibXls().Workbook_InitCalcEngine.argtypes=[c_void_p]
1742
1780
  CallCFunction(GetDllLibXls().Workbook_InitCalcEngine, self.Ptr)
@@ -1746,11 +1784,11 @@ class Workbook (SpireObject) :
1746
1784
 
1747
1785
  def IsPasswordProtected(fileName:str)->bool:
1748
1786
  """
1749
- <summary>
1750
1787
  check file is password protect
1751
- </summary>
1752
- <param name="fileName"></param>
1753
- <returns></returns>
1788
+
1789
+ Args:
1790
+ fileName:
1791
+
1754
1792
  """
1755
1793
 
1756
1794
  GetDllLibXls().Workbook_IsPasswordProtected.argtypes=[ c_void_p]
@@ -1774,9 +1812,8 @@ class Workbook (SpireObject) :
1774
1812
 
1775
1813
  def PasteFromClipboard(self):
1776
1814
  """
1777
- <summary>
1778
1815
  Copies workbook and all its worksheets from the clipboard.
1779
- </summary>
1816
+
1780
1817
  """
1781
1818
  GetDllLibXls().Workbook_PasteFromClipboard.argtypes=[c_void_p]
1782
1819
  CallCFunction(GetDllLibXls().Workbook_PasteFromClipboard, self.Ptr)
@@ -1784,11 +1821,14 @@ class Workbook (SpireObject) :
1784
1821
 
1785
1822
  def PixelsToColumnWidth(self ,pixels:float)->float:
1786
1823
  """
1787
- <summary>
1788
1824
  Converts column width in pixels into column width in characters.
1789
- </summary>
1790
- <param name="pixels">Column width in pixels.</param>
1791
- <returns>Column width in characters.</returns>
1825
+
1826
+ Args:
1827
+ pixels: Column width in pixels.
1828
+
1829
+ Returns:
1830
+ Column width in characters.
1831
+
1792
1832
  """
1793
1833
 
1794
1834
  GetDllLibXls().Workbook_PixelsToColumnWidth.argtypes=[c_void_p ,c_double]
@@ -1800,10 +1840,11 @@ class Workbook (SpireObject) :
1800
1840
 
1801
1841
  def Protect(self ,passwordToOpen:str):
1802
1842
  """
1803
- <summary>
1804
1843
  protect file also protect workbook window and structure.
1805
- </summary>
1806
- <param name="passwordToOpen">password to open file.</param>
1844
+
1845
+ Args:
1846
+ passwordToOpen: password to open file.
1847
+
1807
1848
  """
1808
1849
 
1809
1850
  GetDllLibXls().Workbook_Protect.argtypes=[c_void_p ,c_void_p]
@@ -1813,12 +1854,13 @@ class Workbook (SpireObject) :
1813
1854
 
1814
1855
  def Protect(self ,passwordToOpen:str,bIsProtectWindow:bool,bIsProtectContent:bool):
1815
1856
  """
1816
- <summary>
1817
1857
  protect file,also Indicates whether protect workbook window and structure or not
1818
- </summary>
1819
- <param name="passwordToOpen">password to open file.</param>
1820
- <param name="bIsProtectWindow">Indicates if protect workbook window.</param>
1821
- <param name="bIsProtectContent">Indicates if protect workbook content.</param>
1858
+
1859
+ Args:
1860
+ passwordToOpen: password to open file.
1861
+ bIsProtectWindow: Indicates if protect workbook window.
1862
+ bIsProtectContent: Indicates if protect workbook content.
1863
+
1822
1864
  """
1823
1865
 
1824
1866
  GetDllLibXls().Workbook_ProtectB.argtypes=[c_void_p ,c_void_p,c_bool,c_bool]
@@ -1827,12 +1869,13 @@ class Workbook (SpireObject) :
1827
1869
 
1828
1870
  def ProtectWorkbook(self ,bIsProtectWindow:bool,bIsProtectContent:bool,password:str):
1829
1871
  """
1830
- <summary>
1831
1872
  Sets protection for workbook.
1832
- </summary>
1833
- <param name="bIsProtectWindow">Indicates if protect workbook window.</param>
1834
- <param name="bIsProtectContent">Indicates if protect workbook content.</param>
1835
- <param name="password">password</param>
1873
+
1874
+ Args:
1875
+ bIsProtectWindow: Indicates if protect workbook window.
1876
+ bIsProtectContent: Indicates if protect workbook content.
1877
+ password: password
1878
+
1836
1879
  """
1837
1880
 
1838
1881
  GetDllLibXls().Workbook_ProtectWorkbook.argtypes=[c_void_p ,c_bool,c_bool,c_void_p]
@@ -1907,24 +1950,23 @@ class Workbook (SpireObject) :
1907
1950
 
1908
1951
  def Replace(self ,oldValue:str,newValue:DateTime):
1909
1952
  """
1910
- <summary>
1911
- Replaces cell's value by specified value.
1912
- <example>The following code illustrates how to replace the string value with datetime:
1913
- <code>
1914
- //Create workbook
1915
- Workbook workbook = new Workbook();
1916
- workbook.LoadFromFile("Sample.xlsx");
1917
- //Replace the oldValue by dateTime
1918
- string oldValue = "Find";
1919
- DateTime dateTime = DateTime.Now;
1920
- workbook.Replace(oldValue, dateTime);
1921
- //Save to file
1922
- workbook.SaveToFile("Replace.xlsx");
1923
- </code>
1924
- </example>
1925
- </summary>
1926
- <param name="oldValue">Value to replace.</param>
1927
- <param name="newValue">New value</param>
1953
+ Replaces cell's value by specified value.
1954
+
1955
+ Args:
1956
+ oldValue: Value to replace.
1957
+ newValue: New value
1958
+ Example::
1959
+
1960
+ #Create workbook
1961
+ workbook = Workbook()
1962
+ workbook.LoadFromFile("Sample.xlsx")
1963
+ #Replace the oldValue by dateTime
1964
+ oldValue = "Find"
1965
+ dateTime = DateTime.Now
1966
+ workbook.Replace(oldValue, dateTime)
1967
+ #Save to file
1968
+ workbook.SaveToFile("Replace.xlsx")
1969
+
1928
1970
  """
1929
1971
  intPtrnewValue:c_void_p = newValue.Ptr
1930
1972
 
@@ -1935,23 +1977,22 @@ class Workbook (SpireObject) :
1935
1977
 
1936
1978
  def Replace(self ,oldValue:str,newValue:float):
1937
1979
  """
1938
- <summary>
1939
- Replaces cell's value by specified value.
1940
- <example>The following code snippet illustrates how to replace the string with double:
1941
- <code>
1942
- //Create workbook
1943
- Workbook workbook = new Workbook();
1944
- workbook.LoadFromFile("Sample.xlsx");
1945
- //Replace the oldValue by double
1946
- string oldValue = "Ten";
1947
- workbook.Replace(oldValue, 10.0);
1948
- //Save to file
1949
- workbook.SaveToFile("Replace.xlsx");
1950
- </code>
1951
- </example>
1952
- </summary>
1953
- <param name="oldValue">Value to replace.</param>
1954
- <param name="newValue">New value.</param>
1980
+ Replaces cell's value by specified value.
1981
+
1982
+ Args:
1983
+ oldValue: Value to replace.
1984
+ newValue: New value.
1985
+ Example::
1986
+
1987
+ #Create workbook
1988
+ workbook = Workbook()
1989
+ workbook.LoadFromFile("Sample.xlsx")
1990
+ #Replace the oldValue by double
1991
+ oldValue = "Ten"
1992
+ workbook.Replace(oldValue, 10.0)
1993
+ #Save to file
1994
+ workbook.SaveToFile("Replace.xlsx")
1995
+
1955
1996
  """
1956
1997
 
1957
1998
  GetDllLibXls().Workbook_ReplaceD.argtypes=[c_void_p ,c_void_p,c_double]
@@ -1961,25 +2002,24 @@ class Workbook (SpireObject) :
1961
2002
 
1962
2003
  def Replace(self ,oldValue:str,newValues:List[float],isVertical:bool):
1963
2004
  """
1964
- <summary>
1965
- Replaces cell's value from array.
1966
- <example>The following code snippet illustrates how to replace the string with array of double values:
1967
- <code>
1968
- //Create workbook
1969
- Workbook workbook = new Workbook();
1970
- workbook.LoadFromFile("Sample.xlsx");
1971
- //Replace the oldValue by array of double values
1972
- string oldValue = "Find";
1973
- double[] newValues = { 1.0, 2.0 };
1974
- workbook.Replace(oldValue, newValues, true);
1975
- //Save to file
1976
- workbook.SaveToFile("Replace.xlsx");
1977
- </code>
1978
- </example>
1979
- </summary>
1980
- <param name="oldValue">Value to replace.</param>
1981
- <param name="newValues">New values.</param>
1982
- <param name="isVertical">Indicates whether new values should be inserted vertically.</param>
2005
+ Replaces cell's value from array.
2006
+
2007
+ Args:
2008
+ oldValue: Value to replace.
2009
+ newValues: New values.
2010
+ isVertical: Indicates whether new values should be inserted vertically.
2011
+ Example::
2012
+
2013
+ #Create workbook
2014
+ workbook = Workbook()
2015
+ workbook.LoadFromFile("Sample.xlsx")
2016
+ #Replace the oldValue by array of double values
2017
+ oldValue = "Find"
2018
+ double[] newValues = { 1.0, 2.0 }
2019
+ workbook.Replace(oldValue, newValues, true)
2020
+ #Save to file
2021
+ workbook.SaveToFile("Replace.xlsx")
2022
+
1983
2023
  """
1984
2024
  #arraynewValues:ArrayTypenewValues = ""
1985
2025
  countnewValues = len(newValues)
@@ -1996,25 +2036,24 @@ class Workbook (SpireObject) :
1996
2036
 
1997
2037
  def Replace(self ,oldValue:str,newValues:List[int],isVertical:bool):
1998
2038
  """
1999
- <summary>
2000
- Replaces cell's value from array.
2001
- <example>The following code snippet illustrates how to replace the string with array of int values:
2002
- <code>
2003
- //Create workbook
2004
- Workbook workbook = new Workbook();
2005
- workbook.LoadFromFile("Sample.xlsx");
2006
- //Replace the oldValue by array of int values
2007
- string oldValue = "Find";
2008
- int[] newValues = { 1, 2 };
2009
- workbook.Replace(oldValue, newValues, true);
2010
- //Save to file
2011
- workbook.SaveToFile("Replace.xlsx");
2012
- </code>
2013
- </example>
2014
- </summary>
2015
- <param name="oldValue">Value to replace.</param>
2016
- <param name="newValues">New values.</param>
2017
- <param name="isVertical">Indicates whether new values should be inserted vertically.</param>
2039
+ Replaces cell's value from array.
2040
+
2041
+ Args:
2042
+ oldValue: Value to replace.
2043
+ newValues: New values.
2044
+ isVertical: Indicates whether new values should be inserted vertically.
2045
+ Example::
2046
+
2047
+ #Create workbook
2048
+ workbook = Workbook()
2049
+ workbook.LoadFromFile("Sample.xlsx")
2050
+ #Replace the oldValue by array of int values
2051
+ oldValue = "Find"
2052
+ int[] newValues = { 1, 2 }
2053
+ workbook.Replace(oldValue, newValues, true)
2054
+ #Save to file
2055
+ workbook.SaveToFile("Replace.xlsx")
2056
+
2018
2057
  """
2019
2058
  #arraynewValues:ArrayTypenewValues = ""
2020
2059
  countnewValues = len(newValues)
@@ -2031,24 +2070,23 @@ class Workbook (SpireObject) :
2031
2070
 
2032
2071
  def Replace(self ,oldValue:str,newValue:str):
2033
2072
  """
2034
- <summary>
2035
- Replaces cell's value by specified value.
2036
- <example>The following code snippet illustrates how to replace the string with another string:
2037
- <code>
2038
- //Create workbook
2039
- Workbook workbook = new Workbook();
2040
- workbook.LoadFromFile("Sample.xlsx");
2041
- //Replace the oldValue by newValue
2042
- string oldValue = "Find";
2043
- string newValue = "NewValue";
2044
- workbook.Replace(oldValue, newValue);
2045
- //Save to file
2046
- workbook.SaveToFile("Replace.xlsx");
2047
- </code>
2048
- </example>
2049
- </summary>
2050
- <param name="oldValue">Value to replace.</param>
2051
- <param name="newValue">New value</param>
2073
+ Replaces cell's value by specified value.
2074
+
2075
+ Args:
2076
+ oldValue: Value to replace.
2077
+ newValue: New value
2078
+ Example::
2079
+
2080
+ #Create workbook
2081
+ workbook = Workbook()
2082
+ workbook.LoadFromFile("Sample.xlsx")
2083
+ #Replace the oldValue by newValue
2084
+ oldValue = "Find"
2085
+ newValue = "NewValue"
2086
+ workbook.Replace(oldValue, newValue)
2087
+ #Save to file
2088
+ workbook.SaveToFile("Replace.xlsx")
2089
+
2052
2090
  """
2053
2091
 
2054
2092
  GetDllLibXls().Workbook_ReplaceS.argtypes=[c_void_p ,c_void_p,c_void_p]
@@ -2058,25 +2096,24 @@ class Workbook (SpireObject) :
2058
2096
 
2059
2097
  def Replace(self ,oldValue:str,newValues:List[str],isVertical:bool):
2060
2098
  """
2061
- <summary>
2062
- Replaces cell's value from array.
2063
- <example>The following code snippet illustrates how to replace the string with array of string values:
2064
- <code>
2065
- //Create workbook
2066
- Workbook workbook = new Workbook();
2067
- workbook.LoadFromFile("Sample.xlsx");
2068
- //Replace the oldValue by array of string values
2069
- string oldValue = "Find";
2070
- string[] newValues = { "X values", "Y values" };
2071
- workbook.Replace(oldValue, newValues , true);
2072
- //Save to file
2073
- workbook.SaveToFile("Replace.xlsx");
2074
- </code>
2075
- </example>
2076
- </summary>
2077
- <param name="oldValue">Value to replace.</param>
2078
- <param name="newValues">New values.</param>
2079
- <param name="isVertical">Indicates whether new values should be inserted vertically.</param>
2099
+ Replaces cell's value from array.
2100
+
2101
+ Args:
2102
+ oldValue: Value to replace.
2103
+ newValues: New values.
2104
+ isVertical: Indicates whether new values should be inserted vertically.
2105
+ Example::
2106
+
2107
+ #Create workbook
2108
+ workbook = Workbook()
2109
+ workbook.LoadFromFile("Sample.xlsx")
2110
+ #Replace the oldValue by array of string values
2111
+ oldValue = "Find"
2112
+ string[] newValues = { "X values", "Y values" }
2113
+ workbook.Replace(oldValue, newValues , true)
2114
+ #Save to file
2115
+ workbook.SaveToFile("Replace.xlsx")
2116
+
2080
2117
  """
2081
2118
  #arraynewValues:ArrayTypenewValues = ""
2082
2119
  countnewValues = len(newValues)
@@ -2091,37 +2128,33 @@ class Workbook (SpireObject) :
2091
2128
 
2092
2129
  def ResetPalette(self):
2093
2130
  """
2094
- <summary>
2095
- Resets the color palette to the default colors.
2096
- <example>The following code snippets illustrates how to reset the palette:
2097
- <code>
2098
- //Create worksheet
2099
- Workbook workbook = new Workbook();
2100
- Worksheet worksheet = workbook.Worksheets[0];
2101
- //Get colors
2102
- System.Drawing.Color[] colors = workbook.Colors;
2103
- //Check color
2104
- Console.WriteLine(colors[2].Name);
2105
- //Set color
2106
- colors[2] = System.Drawing.Color.Yellow;
2107
- //Reset palette
2108
- workbook.ResetPalette();
2109
- //Check color
2110
- Console.WriteLine(workbook.Colors[2].Name);
2111
- //Save to file
2112
- workbook.SaveToFile("CellFormats.xlsx");
2113
- </code>
2114
- </example>
2115
- </summary>
2131
+ Resets the color palette to the default colors.
2132
+ Example::
2133
+
2134
+ #Create worksheet
2135
+ workbook = Workbook()
2136
+ worksheet = workbook.Worksheets[0]
2137
+ #Get colors
2138
+ System.Drawing.Color[] colors = workbook.Colors
2139
+ #Check color
2140
+ print(colors[2].Name)
2141
+ #Set color
2142
+ colors[2] = System.Drawing.Color.Yellow
2143
+ #Reset palette
2144
+ workbook.ResetPalette()
2145
+ #Check color
2146
+ print(workbook.Colors[2].Name)
2147
+ #Save to file
2148
+ workbook.SaveToFile("CellFormats.xlsx")
2149
+
2116
2150
  """
2117
2151
  GetDllLibXls().Workbook_ResetPalette.argtypes=[c_void_p]
2118
2152
  CallCFunction(GetDllLibXls().Workbook_ResetPalette, self.Ptr)
2119
2153
 
2120
2154
  def Save(self):
2121
2155
  """
2122
- <summary>
2123
2156
  Saves changes to the specified workbook
2124
- </summary>
2157
+
2125
2158
  """
2126
2159
  GetDllLibXls().Workbook_Save.argtypes=[c_void_p]
2127
2160
  CallCFunction(GetDllLibXls().Workbook_Save, self.Ptr)
@@ -2143,9 +2176,8 @@ class Workbook (SpireObject) :
2143
2176
 
2144
2177
  def Worksheets(self)->'WorksheetsCollection':
2145
2178
  """
2146
- <summary>
2147
2179
  Returns a Sheets collection that represents all the worksheets in the specified workbook. Read-only Sheets object.
2148
- </summary>
2180
+
2149
2181
  """
2150
2182
  GetDllLibXls().Workbook_get_Worksheets.argtypes=[c_void_p]
2151
2183
  GetDllLibXls().Workbook_get_Worksheets.restype=c_void_p
@@ -2158,19 +2190,15 @@ class Workbook (SpireObject) :
2158
2190
 
2159
2191
  def NameRanges(self)->'INameRanges':
2160
2192
  """
2161
- <summary>
2162
- Gets Names collection that represents all the names in the specified
2163
- workbook.
2164
- <example>The following code snippet illustrates how to get names:
2165
- <code>
2166
- //Create workbook
2167
- Workbook workbook = new Workbook();
2168
- workbook.LoadFromFile("Sample.xlsx");
2169
- //Get names
2170
- INameRanges names = workbook.NameRanges;
2171
- </code>
2172
- </example>
2173
- </summary>
2193
+ Gets Names collection that represents all the names in the specified workbook.
2194
+ Example::
2195
+
2196
+ #Create workbook
2197
+ workbook = Workbook()
2198
+ workbook.LoadFromFile("Sample.xlsx")
2199
+ #Get names
2200
+ names = workbook.NameRanges
2201
+
2174
2202
  """
2175
2203
  GetDllLibXls().Workbook_get_NameRanges.argtypes=[c_void_p]
2176
2204
  GetDllLibXls().Workbook_get_NameRanges.restype=c_void_p
@@ -2268,11 +2296,8 @@ class Workbook (SpireObject) :
2268
2296
 
2269
2297
  def ActiveSheet(self)->'Worksheet':
2270
2298
  """
2271
- <summary>
2272
- Returns an object that represents the active sheet (the sheet
2273
- on top) in the active workbook or in the specified window or
2274
- workbook. Returns Nothing if no sheet is active. Read-only.
2275
- </summary>
2299
+ Returns an object that represents the active sheet (the sheet on top) in the active workbook or in the specified window or workbook. Returns Nothing if no sheet is active. Read-only.
2300
+
2276
2301
  """
2277
2302
  GetDllLibXls().Workbook_get_ActiveSheet.argtypes=[c_void_p]
2278
2303
  GetDllLibXls().Workbook_get_ActiveSheet.restype=c_void_p
@@ -2299,9 +2324,8 @@ class Workbook (SpireObject) :
2299
2324
  @property
2300
2325
  def ActiveSheetIndex(self)->int:
2301
2326
  """
2302
- <summary>
2303
2327
  Gets or sets index of the active worksheet.
2304
- </summary>
2328
+
2305
2329
  """
2306
2330
  GetDllLibXls().Workbook_get_ActiveSheetIndex.argtypes=[c_void_p]
2307
2331
  GetDllLibXls().Workbook_get_ActiveSheetIndex.restype=c_int
@@ -2317,9 +2341,8 @@ class Workbook (SpireObject) :
2317
2341
 
2318
2342
  def AddInFunctions(self)->'AddInFunctionsCollection':
2319
2343
  """
2320
- <summary>
2321
- Returns collection of add-in functions.
2322
- </summary>
2344
+ Returns collection of add-in functions.
2345
+
2323
2346
  """
2324
2347
  GetDllLibXls().Workbook_get_AddInFunctions.argtypes=[c_void_p]
2325
2348
  GetDllLibXls().Workbook_get_AddInFunctions.restype=c_void_p
@@ -2332,9 +2355,8 @@ class Workbook (SpireObject) :
2332
2355
 
2333
2356
  def CalculationMode(self)->'ExcelCalculationMode':
2334
2357
  """
2335
- <summary>
2336
2358
  Get or set calculation mode.
2337
- </summary>
2359
+
2338
2360
  """
2339
2361
  GetDllLibXls().Workbook_get_CalculationMode.argtypes=[c_void_p]
2340
2362
  GetDllLibXls().Workbook_get_CalculationMode.restype=c_int
@@ -2351,9 +2373,8 @@ class Workbook (SpireObject) :
2351
2373
 
2352
2374
  def DataSorter(self)->'DataSorter':
2353
2375
  """
2354
- <summary>
2355
2376
  Gets Data sorter to sort the data..
2356
- </summary>
2377
+
2357
2378
  """
2358
2379
  GetDllLibXls().Workbook_get_DataSorter.argtypes=[c_void_p]
2359
2380
  GetDllLibXls().Workbook_get_DataSorter.restype=c_void_p
@@ -2386,9 +2407,8 @@ class Workbook (SpireObject) :
2386
2407
 
2387
2408
  def CodeName(self)->str:
2388
2409
  """
2389
- <summary>
2390
2410
  Name which used by macros to access to workbook items.
2391
- </summary>
2411
+
2392
2412
  """
2393
2413
  GetDllLibXls().Workbook_get_CodeName.argtypes=[c_void_p]
2394
2414
  GetDllLibXls().Workbook_get_CodeName.restype=c_void_p
@@ -2405,24 +2425,21 @@ class Workbook (SpireObject) :
2405
2425
 
2406
2426
  def Colors(self)->List['Color']:
2407
2427
  """
2408
- <summary>
2409
- Returns colors in the palette for the workbook. The palette has 56 entries, each represented by an RGB value. Read/write Object.
2410
- <example>The following code illustrates how to access the default colors of excel color palette:
2411
- <code>
2412
- //Create worksheet
2413
- Workbook workbook = new Workbook();
2414
- Worksheet worksheet = workbook.Worksheets[0];
2415
- //Get colors
2416
- System.Drawing.Color[] colors = workbook.Colors;
2417
- //Get color
2418
- System.Drawing.Color color = colors[2];
2419
- //Set color
2420
- worksheet["B2"].Style.Color = color;
2421
- //Save to file
2422
- workbook.SaveToFile("CellFormats.xlsx");
2423
- </code>
2424
- </example>
2425
- </summary>
2428
+ Returns colors in the palette for the workbook. The palette has 56 entries, each represented by an RGB value. Read/write Object.
2429
+ Example::
2430
+
2431
+ #Create worksheet
2432
+ workbook = Workbook()
2433
+ worksheet = workbook.Worksheets[0]
2434
+ #Get colors
2435
+ System.Drawing.Color[] colors = workbook.Colors
2436
+ #Get color
2437
+ System.Drawing.color = colors[2]
2438
+ #Set color
2439
+ worksheet["B2"].Style.Color = color
2440
+ #Save to file
2441
+ workbook.SaveToFile("CellFormats.xlsx")
2442
+
2426
2443
  """
2427
2444
  GetDllLibXls().Workbook_get_Colors.argtypes=[c_void_p]
2428
2445
  GetDllLibXls().Workbook_get_Colors.restype=IntPtrArray
@@ -2452,9 +2469,8 @@ class Workbook (SpireObject) :
2452
2469
  @property
2453
2470
  def Date1904(self)->bool:
2454
2471
  """
2455
- <summary>
2456
2472
  True if the workbook uses the 1904 date system. Read/write Boolean.
2457
- </summary>
2473
+
2458
2474
  """
2459
2475
  GetDllLibXls().Workbook_get_Date1904.argtypes=[c_void_p]
2460
2476
  GetDllLibXls().Workbook_get_Date1904.restype=c_bool
@@ -2485,24 +2501,21 @@ class Workbook (SpireObject) :
2485
2501
 
2486
2502
  def DefaultFontName(self)->str:
2487
2503
  """
2488
- <summary>
2489
- Returns or sets the name of the default font.
2490
- <example>The following code illustrates how to set the standard font for the workbook:
2491
- <code>
2492
- //Create worksheet
2493
- Workbook workbook = new Workbook();
2494
- Worksheet worksheet = workbook.Worksheets[0];
2495
- //Set text
2496
- worksheet["B2"].Text = "Text";
2497
- //Set standard font
2498
- workbook.DefaultFontName = "Arial";
2499
- //Set standard font size
2500
- workbook.DefaultFontSize = 18;
2501
- //Save to file
2502
- workbook.SaveToFile("CellFormats.xlsx");
2503
- </code>
2504
- </example>
2505
- </summary>
2504
+ Returns or sets the name of the default font.
2505
+ Example::
2506
+
2507
+ #Create worksheet
2508
+ workbook = Workbook()
2509
+ worksheet = workbook.Worksheets[0]
2510
+ #Set text
2511
+ worksheet["B2"].Text = "Text"
2512
+ #Set standard font
2513
+ workbook.DefaultFontName = "Arial"
2514
+ #Set standard font size
2515
+ workbook.DefaultFontSize = 18
2516
+ #Save to file
2517
+ workbook.SaveToFile("CellFormats.xlsx")
2518
+
2506
2519
  """
2507
2520
  GetDllLibXls().Workbook_get_DefaultFontName.argtypes=[c_void_p]
2508
2521
  GetDllLibXls().Workbook_get_DefaultFontName.restype=c_void_p
@@ -2518,24 +2531,21 @@ class Workbook (SpireObject) :
2518
2531
  @property
2519
2532
  def DefaultFontSize(self)->float:
2520
2533
  """
2521
- <summary>
2522
- Returns or sets the default font size.
2523
- <example>The following code illustrates how to set the standard font size for the workbook:
2524
- <code>
2525
- //Create worksheet
2526
- Workbook workbook = new Workbook();
2527
- Worksheet worksheet = workbook.Worksheets[0];
2528
- //Set text
2529
- worksheet["B2"].Text = "Text";
2530
- //Set standard font
2531
- workbook.DefaultFontName = "Arial";
2532
- //Set standard font size
2533
- workbook.DefaultFontSize = 18;
2534
- //Save to file
2535
- workbook.SaveToFile("CellFormats.xlsx");
2536
- </code>
2537
- </example>
2538
- </summary>
2534
+ Returns or sets the default font size.
2535
+ Example::
2536
+
2537
+ #Create worksheet
2538
+ workbook = Workbook()
2539
+ worksheet = workbook.Worksheets[0]
2540
+ #Set text
2541
+ worksheet["B2"].Text = "Text"
2542
+ #Set standard font
2543
+ workbook.DefaultFontName = "Arial"
2544
+ #Set standard font size
2545
+ workbook.DefaultFontSize = 18
2546
+ #Save to file
2547
+ workbook.SaveToFile("CellFormats.xlsx")
2548
+
2539
2549
  """
2540
2550
  GetDllLibXls().Workbook_get_DefaultFontSize.argtypes=[c_void_p]
2541
2551
  GetDllLibXls().Workbook_get_DefaultFontSize.restype=c_double
@@ -2551,9 +2561,8 @@ class Workbook (SpireObject) :
2551
2561
 
2552
2562
  def CustomFontFilePaths(self)->List[str]:
2553
2563
  """
2554
- <summary>
2555
2564
  Returns or sets the custom path of font files.
2556
- </summary>
2565
+
2557
2566
  """
2558
2567
  GetDllLibXls().Workbook_get_CustomFontFilePaths.argtypes=[c_void_p]
2559
2568
  GetDllLibXls().Workbook_get_CustomFontFilePaths.restype=IntPtrArray
@@ -2590,9 +2599,8 @@ class Workbook (SpireObject) :
2590
2599
 
2591
2600
  def CustomFontFileDirectory(self)->List[str]:
2592
2601
  """
2593
- <summary>
2594
2602
  Sets the custom directory of font files.
2595
- </summary>
2603
+
2596
2604
  """
2597
2605
  GetDllLibXls().Workbook_get_CustomFontFileDirectory.argtypes=[c_void_p]
2598
2606
  GetDllLibXls().Workbook_get_CustomFontFileDirectory.restype=IntPtrArray
@@ -2613,9 +2621,8 @@ class Workbook (SpireObject) :
2613
2621
  @property
2614
2622
  def DisableMacrosStart(self)->bool:
2615
2623
  """
2616
- <summary>
2617
2624
  Allows users to disable load of macros from document.
2618
- </summary>
2625
+
2619
2626
  """
2620
2627
  GetDllLibXls().Workbook_get_DisableMacrosStart.argtypes=[c_void_p]
2621
2628
  GetDllLibXls().Workbook_get_DisableMacrosStart.restype=c_bool
@@ -2631,9 +2638,8 @@ class Workbook (SpireObject) :
2631
2638
 
2632
2639
  def FileName(self)->str:
2633
2640
  """
2634
- <summary>
2635
2641
  Gets file name.
2636
- </summary>
2642
+
2637
2643
  """
2638
2644
  GetDllLibXls().Workbook_get_FileName.argtypes=[c_void_p]
2639
2645
  GetDllLibXls().Workbook_get_FileName.restype=c_void_p
@@ -2644,9 +2650,8 @@ class Workbook (SpireObject) :
2644
2650
  @property
2645
2651
  def HasMacros(self)->bool:
2646
2652
  """
2647
- <summary>
2648
2653
  Indicates whether contains VBA macros.
2649
- </summary>
2654
+
2650
2655
  """
2651
2656
  GetDllLibXls().Workbook_get_HasMacros.argtypes=[c_void_p]
2652
2657
  GetDllLibXls().Workbook_get_HasMacros.restype=c_bool
@@ -2661,9 +2666,8 @@ class Workbook (SpireObject) :
2661
2666
  @property
2662
2667
  def IsCellProtection(self)->bool:
2663
2668
  """
2664
- <summary>
2665
2669
  Indicates whether cells are protected.
2666
- </summary>
2670
+
2667
2671
  """
2668
2672
  GetDllLibXls().Workbook_get_IsCellProtection.argtypes=[c_void_p]
2669
2673
  GetDllLibXls().Workbook_get_IsCellProtection.restype=c_bool
@@ -2673,9 +2677,8 @@ class Workbook (SpireObject) :
2673
2677
  @property
2674
2678
  def IsRightToLeft(self)->bool:
2675
2679
  """
2676
- <summary>
2677
2680
  Indicates whether worksheet is displayed right to left.
2678
- </summary>
2681
+
2679
2682
  """
2680
2683
  GetDllLibXls().Workbook_get_IsRightToLeft.argtypes=[c_void_p]
2681
2684
  GetDllLibXls().Workbook_get_IsRightToLeft.restype=c_bool
@@ -2690,9 +2693,8 @@ class Workbook (SpireObject) :
2690
2693
  @property
2691
2694
  def IsSaved(self)->bool:
2692
2695
  """
2693
- <summary>
2694
- Indicates whether workbook changes have been saved.
2695
- </summary>
2696
+ Indicates whether workbook changes have been saved.
2697
+
2696
2698
  """
2697
2699
  GetDllLibXls().Workbook_get_IsSaved.argtypes=[c_void_p]
2698
2700
  GetDllLibXls().Workbook_get_IsSaved.restype=c_bool
@@ -2707,9 +2709,8 @@ class Workbook (SpireObject) :
2707
2709
  @property
2708
2710
  def IsWindowProtection(self)->bool:
2709
2711
  """
2710
- <summary>
2711
2712
  Indicates window is protected.
2712
- </summary>
2713
+
2713
2714
  """
2714
2715
  GetDllLibXls().Workbook_get_IsWindowProtection.argtypes=[c_void_p]
2715
2716
  GetDllLibXls().Workbook_get_IsWindowProtection.restype=c_bool
@@ -2743,9 +2744,8 @@ class Workbook (SpireObject) :
2743
2744
 
2744
2745
  def OpenPassword(self)->str:
2745
2746
  """
2746
- <summary>
2747
2747
  Returns or sets password to encrypt document.
2748
- </summary>
2748
+
2749
2749
  """
2750
2750
  GetDllLibXls().Workbook_get_OpenPassword.argtypes=[c_void_p]
2751
2751
  GetDllLibXls().Workbook_get_OpenPassword.restype=c_void_p
@@ -2762,9 +2762,8 @@ class Workbook (SpireObject) :
2762
2762
 
2763
2763
  def WriteProtection(self)->'WriteProtection':
2764
2764
  """
2765
- <summary>
2766
2765
  Returns options of the workbook write protection.
2767
- </summary>
2766
+
2768
2767
  """
2769
2768
  GetDllLibXls().Workbook_get_WriteProtection.argtypes=[c_void_p]
2770
2769
  GetDllLibXls().Workbook_get_WriteProtection.restype=c_void_p
@@ -2776,19 +2775,16 @@ class Workbook (SpireObject) :
2776
2775
  @property
2777
2776
  def IsVScrollBarVisible(self)->bool:
2778
2777
  """
2779
- <summary>
2780
- Returns or sets whether show vertical scroll bar.
2781
- <example>This sample shows how to hide vertical scroll bar:
2782
- <code>
2783
- //Create workbook
2784
- Workbook workbook = new Workbook();
2785
- //Hide vertical scroll bar
2786
- workbook.IsVScrollBarVisible = false;
2787
- //Save to file
2788
- workbook.SaveToFile("IsVScrollBarVisible.xlsx");
2789
- </code>
2790
- </example>
2791
- </summary>
2778
+ Returns or sets whether show vertical scroll bar.
2779
+ Example::
2780
+
2781
+ #Create workbook
2782
+ workbook = Workbook()
2783
+ #Hide vertical scroll bar
2784
+ workbook.IsVScrollBarVisible = false
2785
+ #Save to file
2786
+ workbook.SaveToFile("IsVScrollBarVisible.xlsx")
2787
+
2792
2788
  """
2793
2789
  GetDllLibXls().Workbook_get_IsVScrollBarVisible.argtypes=[c_void_p]
2794
2790
  GetDllLibXls().Workbook_get_IsVScrollBarVisible.restype=c_bool
@@ -2803,19 +2799,16 @@ class Workbook (SpireObject) :
2803
2799
  @property
2804
2800
  def IsHScrollBarVisible(self)->bool:
2805
2801
  """
2806
- <summary>
2807
- Returns or sets whether show horizontal scroll bar.
2808
- <example>This sample shows how to hide horizontal scroll bar:
2809
- <code>
2810
- //Create workbook
2811
- Workbook workbook = new Workbook();
2812
- //Hide horizontal scroll bar
2813
- workbook.IsHScrollBarVisible = false;
2814
- //Save to file
2815
- workbook.SaveToFile("IsHScrollBarVisible.xlsx");
2816
- </code>
2817
- </example>
2818
- </summary>
2802
+ Returns or sets whether show horizontal scroll bar.
2803
+ Example::
2804
+
2805
+ #Create workbook
2806
+ workbook = Workbook()
2807
+ #Hide horizontal scroll bar
2808
+ workbook.IsHScrollBarVisible = false
2809
+ #Save to file
2810
+ workbook.SaveToFile("IsHScrollBarVisible.xlsx")
2811
+
2819
2812
  """
2820
2813
  GetDllLibXls().Workbook_get_IsHScrollBarVisible.argtypes=[c_void_p]
2821
2814
  GetDllLibXls().Workbook_get_IsHScrollBarVisible.restype=c_bool
@@ -2830,9 +2823,8 @@ class Workbook (SpireObject) :
2830
2823
  @property
2831
2824
  def SheetTabBarWidth(self)->int:
2832
2825
  """
2833
- <summary>
2834
2826
  Returns or sets the width of worksheet tab bar. 1/1000 of window width.
2835
- </summary>
2827
+
2836
2828
  """
2837
2829
  GetDllLibXls().Workbook_get_SheetTabBarWidth.argtypes=[c_void_p]
2838
2830
  GetDllLibXls().Workbook_get_SheetTabBarWidth.restype=c_int
@@ -2847,12 +2839,8 @@ class Workbook (SpireObject) :
2847
2839
  @property
2848
2840
  def OptimizeImport(self)->bool:
2849
2841
  """
2850
- <summary>
2851
- Indicates whether to optimize Import data. This option will
2852
- take effect only on Import methods that are available with the worksheet
2853
- WARNING: Setting this property to True can decrease memory significantly,
2854
- but will increase the performance of data import .
2855
- </summary>
2842
+ Indicates whether to optimize Import data. This option will take effect only on Import methods that are available with the worksheet WARNING: Setting this property to True can decrease memory significantly, but will increase the performance of data import .
2843
+
2856
2844
  """
2857
2845
  GetDllLibXls().Workbook_get_OptimizeImport.argtypes=[c_void_p]
2858
2846
  GetDllLibXls().Workbook_get_OptimizeImport.restype=c_bool
@@ -2868,19 +2856,16 @@ class Workbook (SpireObject) :
2868
2856
 
2869
2857
  def PivotCaches(self)->'PivotCachesCollection':
2870
2858
  """
2871
- <summary>
2872
2859
  Returns pivot caches collection. Read-only.
2873
- <example>The following code snippet illustrates how to get pivot caches:
2874
- <code>
2875
- //Create worksheet
2876
- Workbook workbook = new Workbook();
2877
- workbook.LoadFromFile("Sample.xlsx");
2878
- Worksheet worksheet = workbook.Worksheets[0];
2879
- //Gets pivot caches collection
2880
- IPivotCaches pivotCaches = workbook.PivotCaches;
2881
- </code>
2882
- </example>
2883
- </summary>
2860
+ Example::
2861
+
2862
+ #Create worksheet
2863
+ workbook = Workbook()
2864
+ workbook.LoadFromFile("Sample.xlsx")
2865
+ worksheet = workbook.Worksheets[0]
2866
+ #Gets pivot caches collection
2867
+ pivotCaches = workbook.PivotCaches
2868
+
2884
2869
  """
2885
2870
  GetDllLibXls().Workbook_get_PivotCaches.argtypes=[c_void_p]
2886
2871
  GetDllLibXls().Workbook_get_PivotCaches.restype=c_void_p
@@ -2914,9 +2899,8 @@ class Workbook (SpireObject) :
2914
2899
  @property
2915
2900
  def ReadOnly(self)->bool:
2916
2901
  """
2917
- <summary>
2918
2902
  Indicates whether the workbook has been opened as Read-only.
2919
- </summary>
2903
+
2920
2904
  """
2921
2905
  GetDllLibXls().Workbook_get_ReadOnly.argtypes=[c_void_p]
2922
2906
  GetDllLibXls().Workbook_get_ReadOnly.restype=c_bool
@@ -2926,9 +2910,8 @@ class Workbook (SpireObject) :
2926
2910
  @property
2927
2911
  def SelectedTab(self)->int:
2928
2912
  """
2929
- <summary>
2930
2913
  Gets or sets tab index of selected.
2931
- </summary>
2914
+
2932
2915
  """
2933
2916
  GetDllLibXls().Workbook_get_SelectedTab.argtypes=[c_void_p]
2934
2917
  GetDllLibXls().Workbook_get_SelectedTab.restype=c_int
@@ -2943,9 +2926,8 @@ class Workbook (SpireObject) :
2943
2926
  @property
2944
2927
  def ShowTabs(self)->bool:
2945
2928
  """
2946
- <summary>
2947
2929
  Get or sets a value whether the Workbook tabs are displayed.
2948
- </summary>
2930
+
2949
2931
  """
2950
2932
  GetDllLibXls().Workbook_get_ShowTabs.argtypes=[c_void_p]
2951
2933
  GetDllLibXls().Workbook_get_ShowTabs.restype=c_bool
@@ -2961,18 +2943,15 @@ class Workbook (SpireObject) :
2961
2943
 
2962
2944
  def Styles(self)->'StylesCollection':
2963
2945
  """
2964
- <summary>
2965
- Returns a Styles collection that represents all the styles in the specified workbook. Read-only.
2966
- <example>The following code snippet illustrates how to get the Styles:
2967
- <code>
2968
- //Create worksheet
2969
- Workbook workbook = new Workbook();
2970
- Worksheet worksheet = workbook.Worksheets[0];
2971
- //Set styles
2972
- IStyles styles = workbook.Styles;
2973
- </code>
2974
- </example>
2975
- </summary>
2946
+ Returns a Styles collection that represents all the styles in the specified workbook. Read-only.
2947
+ Example::
2948
+
2949
+ #Create worksheet
2950
+ workbook = Workbook()
2951
+ worksheet = workbook.Worksheets[0]
2952
+ #Set styles
2953
+ styles = workbook.Styles
2954
+
2976
2955
  """
2977
2956
  GetDllLibXls().Workbook_get_Styles.argtypes=[c_void_p]
2978
2957
  GetDllLibXls().Workbook_get_Styles.restype=c_void_p
@@ -2984,9 +2963,8 @@ class Workbook (SpireObject) :
2984
2963
  @property
2985
2964
  def UseStorageMode(self)->bool:
2986
2965
  """
2987
- <summary>
2988
2966
  User Compound storage mode
2989
- </summary>
2967
+
2990
2968
  """
2991
2969
  GetDllLibXls().Workbook_get_UseStorageMode.argtypes=[c_void_p]
2992
2970
  GetDllLibXls().Workbook_get_UseStorageMode.restype=c_bool
@@ -3018,9 +2996,8 @@ class Workbook (SpireObject) :
3018
2996
  @property
3019
2997
  def IsHideWindow(self)->bool:
3020
2998
  """
3021
- <summary>
3022
2999
  Hide window
3023
- </summary>
3000
+
3024
3001
  """
3025
3002
  GetDllLibXls().Workbook_get_IsHideWindow.argtypes=[c_void_p]
3026
3003
  GetDllLibXls().Workbook_get_IsHideWindow.restype=c_bool
@@ -3036,9 +3013,8 @@ class Workbook (SpireObject) :
3036
3013
 
3037
3014
  def Charts(self)->'ChartsCollection':
3038
3015
  """
3039
- <summary>
3040
3016
  Returns a Sheets collection that represents all the chart sheets in the specified workbook. Read-only.
3041
- </summary>
3017
+
3042
3018
  """
3043
3019
  GetDllLibXls().Workbook_get_Charts.argtypes=[c_void_p]
3044
3020
  GetDllLibXls().Workbook_get_Charts.restype=c_void_p
@@ -3065,19 +3041,15 @@ class Workbook (SpireObject) :
3065
3041
 
3066
3042
  def CustomDocumentProperties(self)->'ICustomDocumentProperties':
3067
3043
  """
3068
- <summary>
3069
- Returns collection that represents all the custom document properties
3070
- for the specified workbook. Read-only.
3071
- <example>The following code snippet illustrates how to get the custom document properties:
3072
- <code>
3073
- //Create workbook
3074
- Workbook workbook = new Workbook();
3075
- workbook.LoadFromFile("Sample.xlsx");
3076
- //Get the document properties
3077
- ICustomDocumentProperties documentProperties = workbook.CustomDocumentProperties;
3078
- </code>
3079
- </example>
3080
- </summary>
3044
+ Returns collection that represents all the custom document properties for the specified workbook. Read-only.
3045
+ Example::
3046
+
3047
+ #Create workbook
3048
+ workbook = Workbook()
3049
+ workbook.LoadFromFile("Sample.xlsx")
3050
+ #Get the document properties
3051
+ documentProperties = workbook.CustomDocumentProperties
3052
+
3081
3053
  """
3082
3054
  GetDllLibXls().Workbook_get_CustomDocumentProperties.argtypes=[c_void_p]
3083
3055
  GetDllLibXls().Workbook_get_CustomDocumentProperties.restype=c_void_p
@@ -3104,18 +3076,15 @@ class Workbook (SpireObject) :
3104
3076
 
3105
3077
  def DocumentProperties(self)->'BuiltInDocumentProperties':
3106
3078
  """
3107
- <summary>
3108
- Returns a BuiltInDocumentProperties collection that represents all the built-in document properties for the specified workbook. Read-only.
3109
- <example>The following code snippet illustrates how to get the built in document properties:
3110
- <code>
3111
- //Create workbook
3112
- Workbook workbook = new Workbook();
3113
- workbook.LoadFromFile("Sample.xlsx");
3114
- //Get the built in document properties
3115
- IBuiltInDocumentProperties builtInDocumentProperties = workbook.DocumentProperties;
3116
- </code>
3117
- </example>
3118
- </summary>
3079
+ Returns a BuiltInDocumentProperties collection that represents all the built-in document properties for the specified workbook. Read-only.
3080
+ Example::
3081
+
3082
+ #Create workbook
3083
+ workbook = Workbook()
3084
+ workbook.LoadFromFile("Sample.xlsx")
3085
+ #Get the built in document properties
3086
+ builtInDocumentProperties = workbook.DocumentProperties
3087
+
3119
3088
  """
3120
3089
  GetDllLibXls().Workbook_get_DocumentProperties.argtypes=[c_void_p]
3121
3090
  GetDllLibXls().Workbook_get_DocumentProperties.restype=c_void_p