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/XlsWorksheet.py CHANGED
@@ -7,15 +7,17 @@ from ctypes import *
7
7
  import abc
8
8
 
9
9
  class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
10
- """
11
-
10
+ """Represents a worksheet in an Excel workbook.
11
+
12
+ This class provides properties and methods for manipulating worksheets in Excel,
13
+ including cell operations, formatting, ranges, rows, columns, and other worksheet-specific
14
+ functionality. It extends XlsWorksheetBase and implements the IInternalWorksheet interface.
12
15
  """
13
16
  def GetActiveSelectionRange(self)->List['CellRange']:
14
- """
15
- <summary>
16
- Get active selection range.
17
- </summary>
18
- <returns></returns>
17
+ """Gets the currently selected ranges in the worksheet.
18
+
19
+ Returns:
20
+ List[CellRange]: A list of CellRange objects representing the selected ranges.
19
21
  """
20
22
  GetDllLibXls().XlsWorksheet_get_ActiveSelectionRange.argtypes=[c_void_p]
21
23
  GetDllLibXls().XlsWorksheet_get_ActiveSelectionRange.restype=IntPtrArray
@@ -25,14 +27,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
25
27
 
26
28
 
27
29
  def GroupByColumns(self ,firstColumn:int,lastColumn:int,isCollapsed:bool)->'CellRange':
28
- """
29
- <summary>
30
- Groups columns.
31
- </summary>
32
- <param name="firstColumn">The first column index to be grouped.</param>
33
- <param name="lastColumn">The last column index to be grouped.</param>
34
- <param name="isCollapsed">Indicates whether group should be collapsed.</param>
35
- <returns></returns>
30
+ """Groups a range of columns in the worksheet.
31
+
32
+ Args:
33
+ firstColumn (int): The index of the first column to be grouped.
34
+ lastColumn (int): The index of the last column to be grouped.
35
+ isCollapsed (bool): Indicates whether the group should be collapsed initially.
36
+
37
+ Returns:
38
+ CellRange: A CellRange object representing the grouped columns.
36
39
  """
37
40
 
38
41
  GetDllLibXls().XlsWorksheet_GroupByColumns.argtypes=[c_void_p ,c_int,c_int,c_bool]
@@ -44,14 +47,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
44
47
 
45
48
 
46
49
  def GroupByRows(self ,firstRow:int,lastRow:int,isCollapsed:bool)->'CellRange':
47
- """
48
- <summary>
49
- Groups rows.
50
- </summary>
51
- <param name="firstRow">The first row index to be grouped.</param>
52
- <param name="lastRow">The last row index to be grouped.</param>
53
- <param name="isCollapsed">Indicates whether group should be collapsed.</param>
54
- <returns></returns>
50
+ """Groups a range of rows in the worksheet.
51
+
52
+ Args:
53
+ firstRow (int): The index of the first row to be grouped.
54
+ lastRow (int): The index of the last row to be grouped.
55
+ isCollapsed (bool): Indicates whether the group should be collapsed initially.
56
+
57
+ Returns:
58
+ CellRange: A CellRange object representing the grouped rows.
55
59
  """
56
60
 
57
61
  GetDllLibXls().XlsWorksheet_GroupByRows.argtypes=[c_void_p ,c_int,c_int,c_bool]
@@ -63,13 +67,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
63
67
 
64
68
 
65
69
  def UngroupByColumns(self ,firstColumn:int,lastColumn:int)->'CellRange':
66
- """
67
- <summary>
68
- Ungroups columns.
69
- </summary>
70
- <param name="firstColumn">The first column index to be grouped.</param>
71
- <param name="lastColumn">The last column index to be grouped.</param>
72
- <returns></returns>
70
+ """Ungroups a range of previously grouped columns in the worksheet.
71
+
72
+ Args:
73
+ firstColumn (int): The index of the first column to be ungrouped.
74
+ lastColumn (int): The index of the last column to be ungrouped.
75
+
76
+ Returns:
77
+ CellRange: A CellRange object representing the ungrouped columns.
73
78
  """
74
79
 
75
80
  GetDllLibXls().XlsWorksheet_UngroupByColumns.argtypes=[c_void_p ,c_int,c_int]
@@ -81,13 +86,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
81
86
 
82
87
 
83
88
  def UngroupByRows(self ,firstRow:int,lastRow:int)->'CellRange':
84
- """
85
- <summary>
86
- Ungroups rows.
87
- </summary>
88
- <param name="firstRow">The first row index to be grouped.</param>
89
- <param name="lastRow">The last row index to be grouped.</param>
90
- <returns></returns>
89
+ """Ungroups a range of previously grouped rows in the worksheet.
90
+
91
+ Args:
92
+ firstRow (int): The index of the first row to be ungrouped.
93
+ lastRow (int): The index of the last row to be ungrouped.
94
+
95
+ Returns:
96
+ CellRange: A CellRange object representing the ungrouped rows.
91
97
  """
92
98
 
93
99
  GetDllLibXls().XlsWorksheet_UngroupByRows.argtypes=[c_void_p ,c_int,c_int]
@@ -99,8 +105,17 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
99
105
 
100
106
 
101
107
  def SaveShapesToImage(self ,option:'SaveShapeTypeOption')->List['Stream']:
102
- """
103
-
108
+ """Saves all shapes in the worksheet to images.
109
+
110
+ This method converts all shapes in the worksheet to images according to the
111
+ specified options.
112
+
113
+ Args:
114
+ option (SaveShapeTypeOption): The options for saving shapes as images, including
115
+ format settings and other parameters.
116
+
117
+ Returns:
118
+ List[Stream]: A list of Stream objects containing the image data for each shape.
104
119
  """
105
120
  GetDllLibXls().XlsWorksheet_SaveShapesToImage.argtypes=[c_void_p ,c_void_p]
106
121
  GetDllLibXls().XlsWorksheet_SaveShapesToImage.restype=IntPtrArray
@@ -111,26 +126,30 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
111
126
 
112
127
 
113
128
  @dispatch
114
-
115
129
  def ApplyStyle(self ,style:CellStyle):
116
- """
117
-
130
+ """Applies a cell style to the entire worksheet.
131
+
132
+ This method applies the specified cell style to all cells in the worksheet.
133
+
134
+ Args:
135
+ style (CellStyle): The cell style to apply to the entire worksheet.
118
136
  """
119
137
  intPtrstyle:c_void_p = style.Ptr
120
-
121
138
  GetDllLibXls().XlsWorksheet_ApplyStyle.argtypes=[c_void_p ,c_void_p]
122
139
  CallCFunction(GetDllLibXls().XlsWorksheet_ApplyStyle, self.Ptr, intPtrstyle)
123
140
 
124
141
  @dispatch
125
142
 
126
143
  def ApplyStyle(self ,style:CellStyle,applyRowStyle:bool,applyColumnStyle:bool):
127
- """
128
- <summary>
129
- Apply style to whole sheet.
130
- </summary>
131
- <param name="style">style to apply</param>
132
- <param name="applyRowStyle">true means apply style to all rows</param>
133
- <param name="applyColumnStyle">true means apply style to all columns</param>
144
+ """Applies a cell style to the worksheet with options for rows and columns.
145
+
146
+ This method applies the specified cell style to the worksheet with options to
147
+ control whether the style is applied to rows, columns, or both.
148
+
149
+ Args:
150
+ style (CellStyle): The cell style to apply.
151
+ applyRowStyle (bool): True to apply the style to all rows; otherwise, False.
152
+ applyColumnStyle (bool): True to apply the style to all columns; otherwise, False.
134
153
  """
135
154
  intPtrstyle:c_void_p = style.Ptr
136
155
 
@@ -140,14 +159,17 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
140
159
  @dispatch
141
160
 
142
161
  def Subtotal(self ,range:IXLSRange,groupByIndex:int,totalFields:List[int],subtotalType:SubtotalTypes):
143
- """
144
- <summary>
145
- Creates subtotals for the range.
146
- </summary>
147
- <param name="range">The range</param>
148
- <param name="groupByIndex">The field index to group by, offset from zero</param>
149
- <param name="totalFields">An array of zero-based field index offsets, indicating the fields to which the subtotals are added.</param>
150
- <param name="subtotalType">The subtotal type.</param>
162
+ """Creates subtotals for the specified range.
163
+
164
+ This method creates subtotals for the specified range using the given grouping field,
165
+ total fields, and subtotal type.
166
+
167
+ Args:
168
+ range (IXLSRange): The range to create subtotals for.
169
+ groupByIndex (int): The zero-based index of the field to group by.
170
+ totalFields (List[int]): A list of zero-based field indices indicating the fields
171
+ to which the subtotals are added.
172
+ subtotalType (SubtotalTypes): The type of subtotal to calculate (e.g., sum, average, count).
151
173
  """
152
174
  intPtrrange:c_void_p = range.Ptr
153
175
  #arraytotalFields:ArrayTypetotalFields = ""
@@ -165,17 +187,21 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
165
187
  @dispatch
166
188
 
167
189
  def Subtotal(self ,r:IXLSRange,groupByIndex:int,totalFields:List[int],subtotalType:SubtotalTypes,replace:bool,addPageBreak:bool,addsummaryBelowData:bool):
168
- """
169
- <summary>
170
- Creates subtotals for the range.
171
- </summary>
172
- <param name="range">The range</param>
173
- <param name="groupByIndex">The field index to group by, offset from zero</param>
174
- <param name="totalFields">An array of zero-based field index offsets, indicating the fields to which the subtotals are added.</param>
175
- <param name="subtotalType">The subtotal type.</param>
176
- <param name="replace">Indicates whether replace the current subtotals</param>
177
- <param name="addPageBreak">Indicates whether add page break between groups</param>
178
- <param name="addsummaryBelowData">Indicates whether add summarry below data.</param>
190
+ """Creates subtotals for the specified range with additional options.
191
+
192
+ This method creates subtotals for the specified range using the given grouping field,
193
+ total fields, subtotal type, and additional formatting options.
194
+
195
+ Args:
196
+ r (IXLSRange): The range to create subtotals for.
197
+ groupByIndex (int): The zero-based index of the field to group by.
198
+ totalFields (List[int]): A list of zero-based field indices indicating the fields
199
+ to which the subtotals are added.
200
+ subtotalType (SubtotalTypes): The type of subtotal to calculate (e.g., sum, average, count).
201
+ replace (bool): True to replace existing subtotals; otherwise, False.
202
+ addPageBreak (bool): True to add page breaks between groups; otherwise, False.
203
+ addsummaryBelowData (bool): True to add summary rows below the data; otherwise, False
204
+ to add summary rows above the data.
179
205
  """
180
206
  intPtrrange:c_void_p = r.Ptr
181
207
  #arraytotalFields:ArrayTypetotalFields = ""
@@ -193,11 +219,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
193
219
 
194
220
  def GetRowIsAutoFit(self ,rowIndex:int)->bool:
195
221
  """
196
- <summary>
197
222
  Get GetRowIsAutoFit By rowIndex
198
- </summary>
199
- <param name="rowIndex"></param>
200
- <returns>If the row is null Return false,else if the row height is Autofit Return true, the row height is CustomHeight Return false</returns>
223
+
224
+ Args:
225
+ rowIndex:
226
+
227
+ Returns:
228
+ If the row is null Return false,else if the row height is Autofit Return true, the row height is CustomHeight Return false
229
+
201
230
  """
202
231
 
203
232
  GetDllLibXls().XlsWorksheet_GetRowIsAutoFit.argtypes=[c_void_p ,c_int]
@@ -208,11 +237,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
208
237
 
209
238
  def GetColumnIsAutoFit(self ,columnIndex:int)->bool:
210
239
  """
211
- <summary>
212
240
  Get ColumnIsAutofit By columnIndex
213
- </summary>
214
- <param name="columnIndex"></param>
215
- <returns>If the column is null Return false,else if the column width is Autofit Return true, the column width is CustomWidth Return false</returns>
241
+
242
+ Args:
243
+ columnIndex:
244
+
245
+ Returns:
246
+ If the column is null Return false,else if the column width is Autofit Return true, the column width is CustomWidth Return false
247
+
216
248
  """
217
249
 
218
250
  GetDllLibXls().XlsWorksheet_GetColumnIsAutoFit.argtypes=[c_void_p ,c_int]
@@ -223,9 +255,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
223
255
 
224
256
  def GetDefaultRowStyle(self ,rowIndex:int)->'IStyle':
225
257
  """
258
+ Get the default row style for a given row index.
259
+
260
+ Args:
261
+ rowIndex (int): The row index.
226
262
 
263
+ Returns:
264
+ IStyle: The default style of the row.
227
265
  """
228
-
229
266
  GetDllLibXls().XlsWorksheet_GetDefaultRowStyle.argtypes=[c_void_p ,c_int]
230
267
  GetDllLibXls().XlsWorksheet_GetDefaultRowStyle.restype=c_void_p
231
268
  intPtr = CallCFunction(GetDllLibXls().XlsWorksheet_GetDefaultRowStyle, self.Ptr, rowIndex)
@@ -236,12 +273,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
236
273
 
237
274
  def GetError(self ,row:int,column:int)->str:
238
275
  """
239
- <summary>
240
276
  Gets error value from cell.
241
- </summary>
242
- <param name="row">Row index.</param>
243
- <param name="column">Column index.</param>
244
- <returns>Returns error value or null.</returns>
277
+
278
+ Args:
279
+ row: Row index.
280
+ column: Column index.
281
+
282
+ Returns:
283
+ Returns error value or null.
284
+
245
285
  """
246
286
 
247
287
  GetDllLibXls().XlsWorksheet_GetError.argtypes=[c_void_p ,c_int,c_int]
@@ -253,12 +293,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
253
293
 
254
294
  def GetFormulaErrorValue(self ,row:int,column:int)->str:
255
295
  """
256
- <summary>
257
296
  Gets formula error value from cell.
258
- </summary>
259
- <param name="row">Row index.</param>
260
- <param name="column">Column index.</param>
261
- <returns>Returns error value or null.</returns>
297
+
298
+ Args:
299
+ row: Row index.
300
+ column: Column index.
301
+
302
+ Returns:
303
+ Returns error value or null.
304
+
262
305
  """
263
306
 
264
307
  GetDllLibXls().XlsWorksheet_GetFormulaErrorValue.argtypes=[c_void_p ,c_int,c_int]
@@ -270,12 +313,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
270
313
 
271
314
  def GetFormulaNumberValue(self ,row:int,column:int)->float:
272
315
  """
273
- <summary>
274
316
  Returns formula number value corresponding to the cell.
275
- </summary>
276
- <param name="row">One-based row index of the cell to get value from.</param>
277
- <param name="column">One-based column index of the cell to get value from.</param>
278
- <returns>Number contained by the cell.</returns>
317
+
318
+ Args:
319
+ row: One-based row index of the cell to get value from.
320
+ column: One-based column index of the cell to get value from.
321
+
322
+ Returns:
323
+ Number contained by the cell.
324
+
279
325
  """
280
326
 
281
327
  GetDllLibXls().XlsWorksheet_GetFormulaNumberValue.argtypes=[c_void_p ,c_int,c_int]
@@ -286,12 +332,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
286
332
 
287
333
  def GetFormulaStringValue(self ,row:int,column:int)->str:
288
334
  """
289
- <summary>
290
335
  Returns formula string value corresponding to the cell.
291
- </summary>
292
- <param name="row">One-based row index of the cell to get value from.</param>
293
- <param name="column">One-based column index of the cell to get value from.</param>
294
- <returns>String contained by the cell.</returns>
336
+
337
+ Args:
338
+ row: One-based row index of the cell to get value from.
339
+ column: One-based column index of the cell to get value from.
340
+
341
+ Returns:
342
+ String contained by the cell.
343
+
295
344
  """
296
345
 
297
346
  GetDllLibXls().XlsWorksheet_GetFormulaStringValue.argtypes=[c_void_p ,c_int,c_int]
@@ -304,9 +353,16 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
304
353
 
305
354
  def GetFormula(self ,row:int,column:int,bR1C1:bool)->str:
306
355
  """
356
+ Get the formula from a cell.
357
+
358
+ Args:
359
+ row (int): Row index.
360
+ column (int): Column index.
361
+ bR1C1 (bool): Whether to use R1C1 notation.
307
362
 
363
+ Returns:
364
+ str: The formula string.
308
365
  """
309
-
310
366
  GetDllLibXls().XlsWorksheet_GetFormula.argtypes=[c_void_p ,c_int,c_int,c_bool]
311
367
  GetDllLibXls().XlsWorksheet_GetFormula.restype=c_void_p
312
368
  ret = PtrToStr(CallCFunction(GetDllLibXls().XlsWorksheet_GetFormula, self.Ptr, row,column,bR1C1))
@@ -317,9 +373,17 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
317
373
 
318
374
  def GetFormula(self ,row:int,column:int,bR1C1:bool,isForSerialization:bool)->str:
319
375
  """
376
+ Get the formula from a cell, with serialization option.
377
+
378
+ Args:
379
+ row (int): Row index.
380
+ column (int): Column index.
381
+ bR1C1 (bool): Whether to use R1C1 notation.
382
+ isForSerialization (bool): Whether for serialization.
320
383
 
384
+ Returns:
385
+ str: The formula string.
321
386
  """
322
-
323
387
  GetDllLibXls().XlsWorksheet_GetFormulaRCBI.argtypes=[c_void_p ,c_int,c_int,c_bool,c_bool]
324
388
  GetDllLibXls().XlsWorksheet_GetFormulaRCBI.restype=c_void_p
325
389
  ret = PtrToStr(CallCFunction(GetDllLibXls().XlsWorksheet_GetFormulaRCBI, self.Ptr, row,column,bR1C1,isForSerialization))
@@ -329,12 +393,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
329
393
 
330
394
  def GetFormulaBoolValue(self ,row:int,column:int)->bool:
331
395
  """
332
- <summary>
333
396
  Gets formula bool value from cell.
334
- </summary>
335
- <param name="row">Represents row index.</param>
336
- <param name="column">Represents column index.</param>
337
- <returns>Returns found bool value. If cannot found returns false.</returns>
397
+
398
+ Args:
399
+ row: Represents row index.
400
+ column: Represents column index.
401
+
402
+ Returns:
403
+ Returns found bool value. If cannot found returns false.
404
+
338
405
  """
339
406
 
340
407
  GetDllLibXls().XlsWorksheet_GetFormulaBoolValue.argtypes=[c_void_p ,c_int,c_int]
@@ -345,12 +412,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
345
412
 
346
413
  def GetNumber(self ,row:int,column:int)->float:
347
414
  """
348
- <summary>
349
415
  Returns number value corresponding to the cell.
350
- </summary>
351
- <param name="row">One-based row index of the cell to get value from.</param>
352
- <param name="column">One-based column index of the cell to get value from.</param>
353
- <returns>Number contained by the cell.</returns>
416
+
417
+ Args:
418
+ row: One-based row index of the cell to get value from.
419
+ column: One-based column index of the cell to get value from.
420
+
421
+ Returns:
422
+ Number contained by the cell.
423
+
354
424
  """
355
425
 
356
426
  GetDllLibXls().XlsWorksheet_GetNumber.argtypes=[c_void_p ,c_int,c_int]
@@ -361,11 +431,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
361
431
 
362
432
  def GetRowHeight(self ,row:int)->float:
363
433
  """
364
- <summary>
365
- Gets the height of a specified row.
366
- </summary>
367
- <param name="row">Row index.</param>
368
- <returns>Height of row</returns>
434
+ Gets the height of a specified row.
435
+
436
+ Args:
437
+ row: Row index.
438
+
439
+ Returns:
440
+ Height of row
441
+
369
442
  """
370
443
 
371
444
  GetDllLibXls().XlsWorksheet_GetRowHeight.argtypes=[c_void_p ,c_int]
@@ -376,11 +449,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
376
449
 
377
450
  def GetColumnIsHide(self ,columnIndex:int)->bool:
378
451
  """
379
- <summary>
380
452
  Indicates whether the column is hidden.
381
- </summary>
382
- <param name="columnIndex">Column index.</param>
383
- <returns></returns>
453
+
454
+ Args:
455
+ columnIndex: Column index.
456
+
384
457
  """
385
458
 
386
459
  GetDllLibXls().XlsWorksheet_GetColumnIsHide.argtypes=[c_void_p ,c_int]
@@ -391,11 +464,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
391
464
 
392
465
  def GetRowIsHide(self ,rowIndex:int)->bool:
393
466
  """
394
- <summary>
395
467
  Indicates whether the row is hidden.
396
- </summary>
397
- <param name="rowIndex">Row index.</param>
398
- <returns></returns>
468
+
469
+ Args:
470
+ rowIndex: Row index.
471
+
399
472
  """
400
473
 
401
474
  GetDllLibXls().XlsWorksheet_GetRowIsHide.argtypes=[c_void_p ,c_int]
@@ -406,10 +479,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
406
479
 
407
480
  def HideColumn(self ,columnIndex:int):
408
481
  """
409
- <summary>
410
482
  Hides a column.
411
- </summary>
412
- <param name="columnIndex">Column index.</param>
483
+
484
+ Args:
485
+ columnIndex: Column index.
486
+
413
487
  """
414
488
 
415
489
  GetDllLibXls().XlsWorksheet_HideColumn.argtypes=[c_void_p ,c_int]
@@ -418,11 +492,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
418
492
 
419
493
  def HideColumns(self ,columnIndex:int,columnCount:int):
420
494
  """
421
- <summary>
422
495
  Hides columns.
423
- </summary>
424
- <param name="columnIndex">Column index.</param>
425
- <param name="columnCount">Column count.</param>
496
+
497
+ Args:
498
+ columnIndex: Column index.
499
+ columnCount: Column count.
500
+
426
501
  """
427
502
 
428
503
  GetDllLibXls().XlsWorksheet_HideColumns.argtypes=[c_void_p ,c_int,c_int]
@@ -431,10 +506,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
431
506
 
432
507
  def HideRow(self ,rowIndex:int):
433
508
  """
434
- <summary>
435
509
  Hides a row.
436
- </summary>
437
- <param name="rowIndex">Row index.</param>
510
+
511
+ Args:
512
+ rowIndex: Row index.
513
+
438
514
  """
439
515
 
440
516
  GetDllLibXls().XlsWorksheet_HideRow.argtypes=[c_void_p ,c_int]
@@ -443,11 +519,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
443
519
 
444
520
  def HideRows(self ,rowIndex:int,rowCount:int):
445
521
  """
446
- <summary>
447
522
  Hides a row.
448
- </summary>
449
- <param name="rowIndex">Row index.</param>
450
- <param name="rowCount">Row count.</param>
523
+
524
+ Args:
525
+ rowIndex: Row index.
526
+ rowCount: Row count.
527
+
451
528
  """
452
529
 
453
530
  GetDllLibXls().XlsWorksheet_HideRows.argtypes=[c_void_p ,c_int,c_int]
@@ -456,27 +533,27 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
456
533
 
457
534
  def GetRowHeightPixels(self ,rowIndex:int)->int:
458
535
  """
459
- <summary>
460
- Gets the height of a specified row in unit of pixel.
461
- <example>The following code illustrates how to get the row height for a particular row:
462
- <code>
463
- //Create worksheet
464
- Workbook workbook = new Workbook();
465
- Worksheet worksheet = workbook.Worksheets[0];
466
- //Set text
467
- worksheet["C2"].Text = "Sample text";
468
- worksheet["C2"].Style.Font.Size = 18;
469
- //Set auto fit
470
- worksheet.AutoFitRow(2);
471
- //Get row height
472
- Console.WriteLine(worksheet.GetRowHeightPixels(2));
473
- //Save to file
474
- workbook.SaveToFile("UsedRange.xlsx");
475
- </code>
476
- </example>
477
- </summary>
478
- <param name="rowIndex">Row index.</param>
479
- <returns>Height of row</returns>
536
+ Gets the height of a specified row in unit of pixel.
537
+
538
+ Args:
539
+ rowIndex: Row index.
540
+
541
+ Returns:
542
+ Height of row
543
+ Example::
544
+
545
+ #Create worksheet
546
+ workbook = Workbook()
547
+ worksheet = workbook.Worksheets[0]
548
+ #Set text
549
+ worksheet["C2"].Text = "Sample text"
550
+ #Set auto fit
551
+ worksheet.AutoFitRow(2)
552
+ #Get row height
553
+ print(worksheet.GetRowHeightPixels(2))
554
+ #Save to file
555
+ workbook.SaveToFile("UsedRange.xlsx")
556
+
480
557
  """
481
558
 
482
559
  GetDllLibXls().XlsWorksheet_GetRowHeightPixels.argtypes=[c_void_p ,c_int]
@@ -487,12 +564,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
487
564
 
488
565
  def GetText(self ,row:int,column:int)->str:
489
566
  """
490
- <summary>
491
567
  Returns string value corresponding to the cell.
492
- </summary>
493
- <param name="row">One-based row index of the cell to get value from.</param>
494
- <param name="column">One-based column index of the cell to get value from.</param>
495
- <returns>String contained by the cell.</returns>
568
+
569
+ Args:
570
+ row: One-based row index of the cell to get value from.
571
+ column: One-based column index of the cell to get value from.
572
+
573
+ Returns:
574
+ String contained by the cell.
575
+
496
576
  """
497
577
 
498
578
  GetDllLibXls().XlsWorksheet_GetText.argtypes=[c_void_p ,c_int,c_int]
@@ -504,11 +584,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
504
584
 
505
585
  def DeleteRange(self ,range:'CellRange',deleteOption:'DeleteOption'):
506
586
  """
507
- <summary>
508
587
  delete a range in worksheet
509
- </summary>
510
- <param name="range">the range to be deleted</param>
511
- <param name="deleteOption">Choose to move the right range to left or move the below range to above</param>
588
+
589
+ Args:
590
+ range: the range to be deleted
591
+ deleteOption: Choose to move the right range to left or move the below range to above
592
+
512
593
  """
513
594
  intPtrrange:c_void_p = range.Ptr
514
595
  enumdeleteOption:c_int = deleteOption.value
@@ -519,10 +600,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
519
600
 
520
601
  def MoveWorksheet(self ,destIndex:int):
521
602
  """
522
- <summary>
523
603
  Moves worksheet into new position.
524
- </summary>
525
- <param name="destIndex">Destination index.</param>
604
+
605
+ Args:
606
+ destIndex: Destination index.
607
+
526
608
  """
527
609
 
528
610
  GetDllLibXls().XlsWorksheet_MoveWorksheet.argtypes=[c_void_p ,c_int]
@@ -533,7 +615,7 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
533
615
  """
534
616
 
535
617
  """
536
-
618
+
537
619
  GetDllLibXls().XlsWorksheet_PixelsToColumnWidth.argtypes=[c_void_p ,c_double]
538
620
  GetDllLibXls().XlsWorksheet_PixelsToColumnWidth.restype=c_double
539
621
  ret = CallCFunction(GetDllLibXls().XlsWorksheet_PixelsToColumnWidth, self.Ptr, pixels)
@@ -541,9 +623,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
541
623
 
542
624
  def Remove(self):
543
625
  """
544
- <summary>
545
626
  Removes worksheet from parernt worksheets collection.
546
- </summary>
627
+
547
628
  """
548
629
  GetDllLibXls().XlsWorksheet_Remove.argtypes=[c_void_p]
549
630
  CallCFunction(GetDllLibXls().XlsWorksheet_Remove, self.Ptr)
@@ -560,9 +641,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
560
641
 
561
642
  def RemovePanes(self):
562
643
  """
563
- <summary>
564
644
  Removes panes from a worksheet.
565
- </summary>
645
+
566
646
  """
567
647
  GetDllLibXls().XlsWorksheet_RemovePanes.argtypes=[c_void_p]
568
648
  CallCFunction(GetDllLibXls().XlsWorksheet_RemovePanes, self.Ptr)
@@ -648,30 +728,24 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
648
728
 
649
729
  def Replace(self ,oldValue:str,newValue:DateTime):
650
730
  """
651
- <summary>
652
- Replaces cells' values with new data.
653
- <example>The following code illustrates how to replace the string value with datetime:
654
- <code>
655
- //Create worksheet
656
- Workbook workbook = new Workbook();
657
- workbook.LoadFromFile("Sample.xlsx");
658
- Worksheet worksheet = workbook.Worksheets[0];
659
- //Replace the oldValue by dateTime
660
- string oldValue = "Find";
661
- DateTime dateTime = DateTime.Now;
662
- worksheet.Replace(oldValue, dateTime);
663
- //Save to file
664
- workbook.SaveToFile("Replace.xlsx");
665
- </code>
666
- </example>
667
- </summary>
668
- <param name="oldValue">String value to replace.</param>
669
- <param name="newValue">New value for the range with specified string.</param>
670
- <remarks>
671
- This can be long operation (needs iteration through all cells
672
- in the worksheet). Better use named ranges instead and call
673
- Import function instead of placeholders.
674
- </remarks>
731
+ Replaces cells' values with new data.
732
+
733
+ Args:
734
+ oldValue: String value to replace.
735
+ newValue: New value for the range with specified string.
736
+ Example::
737
+
738
+ #Create worksheet
739
+ workbook = Workbook()
740
+ workbook.LoadFromFile("Sample.xlsx")
741
+ worksheet = workbook.Worksheets[0]
742
+ #Replace the oldValue by dateTime
743
+ oldValue = "Find"
744
+ dateTime = DateTime.Now
745
+ worksheet.Replace(oldValue, dateTime)
746
+ #Save to file
747
+ workbook.SaveToFile("Replace.xlsx")
748
+
675
749
  """
676
750
  intPtrnewValue:c_void_p = newValue.Ptr
677
751
 
@@ -682,24 +756,23 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
682
756
 
683
757
  def Replace(self ,oldValue:str,newValue:float):
684
758
  """
685
- <summary>
686
- Replaces cells' values with new data.
687
- <example>The following code snippet illustrates how to replace the string with double:
688
- <code>
689
- //Create worksheet
690
- Workbook workbook = new Workbook();
691
- workbook.LoadFromFile("Sample.xlsx");
692
- Worksheet worksheet = workbook.Worksheets[0];
693
- //Replace the oldValue by double
694
- string oldValue = "Ten";
695
- worksheet.Replace(oldValue, 10.0);
696
- //Save to file
697
- workbook.SaveToFile("Replace.xlsx");
698
- </code>
699
- </example>
700
- </summary>
701
- <param name="oldValue">String value to replace.</param>
702
- <param name="newValue">New value for the range with specified string.</param>
759
+ Replaces cells' values with new data.
760
+
761
+ Args:
762
+ oldValue: String value to replace.
763
+ newValue: New value for the range with specified string.
764
+ Example::
765
+
766
+ #Create worksheet
767
+ workbook = Workbook()
768
+ workbook.LoadFromFile("Sample.xlsx")
769
+ worksheet = workbook.Worksheets[0]
770
+ #Replace the oldValue by double
771
+ oldValue = "Ten"
772
+ worksheet.Replace(oldValue, 10.0)
773
+ #Save to file
774
+ workbook.SaveToFile("Replace.xlsx")
775
+
703
776
  """
704
777
 
705
778
  GetDllLibXls().XlsWorksheet_ReplaceON1.argtypes=[c_void_p ,c_void_p,c_double]
@@ -709,31 +782,25 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
709
782
 
710
783
  def Replace(self ,oldValue:str,newValues:List[float],isVertical:bool):
711
784
  """
712
- <summary>
713
- Replaces cells' values with new data.
714
- <example>The following code snippet illustrates how to replace the string with array of double values:
715
- <code>
716
- //Create worksheet
717
- Workbook workbook = new Workbook();
718
- workbook.LoadFromFile("Sample.xlsx");
719
- Worksheet worksheet = workbook.Worksheets[0];
720
- //Replace the oldValue by array of double values
721
- string oldValue = "Find";
722
- double[] newValues = { 1.0, 2.0 };
723
- worksheet.Replace(oldValue, newValues, true);
724
- //Save to file
725
- workbook.SaveToFile("Replace.xlsx");
726
- </code>
727
- </example>
728
- </summary>
729
- <param name="oldValue">String value to replace.</param>
730
- <param name="newValues">Array of new values.</param>
731
- <param name="isVertical">Indicates whether array should be inserted vertically.</param>
732
- <remarks>
733
- This can be long operation (needs iteration through all cells
734
- in the worksheet). Better use named ranges instead and call
735
- Import function instead of placeholders.
736
- </remarks>
785
+ Replaces cells' values with new data.
786
+
787
+ Args:
788
+ oldValue: String value to replace.
789
+ newValues: Array of new values.
790
+ isVertical: Indicates whether array should be inserted vertically.
791
+ Example::
792
+
793
+ #Create worksheet
794
+ workbook = Workbook()
795
+ workbook.LoadFromFile("Sample.xlsx")
796
+ worksheet = workbook.Worksheets[0]
797
+ #Replace the oldValue by array of double values
798
+ oldValue = "Find"
799
+ double[] newValues = { 1.0, 2.0 }
800
+ worksheet.Replace(oldValue, newValues, true)
801
+ #Save to file
802
+ workbook.SaveToFile("Replace.xlsx")
803
+
737
804
  """
738
805
  #arraynewValues:ArrayTypenewValues = ""
739
806
  countnewValues = len(newValues)
@@ -750,31 +817,25 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
750
817
 
751
818
  def Replace(self ,oldValue:str,newValues:List[int],isVertical:bool):
752
819
  """
753
- <summary>
754
- Replaces cells' values with new data.
755
- <example>The following code snippet illustrates how to replace the string with array of int values:
756
- <code>
757
- //Create worksheet
758
- Workbook workbook = new Workbook();
759
- workbook.LoadFromFile("Sample.xlsx");
760
- Worksheet worksheet = workbook.Worksheets[0];
761
- //Replace the oldValue by array of int values
762
- string oldValue = "Find";
763
- int[] newValues = { 1, 2 };
764
- worksheet.Replace(oldValue, newValues, true);
765
- //Save to file
766
- workbook.SaveToFile("Replace.xlsx");
767
- </code>
768
- </example>
769
- </summary>
770
- <param name="oldValue">String value to replace.</param>
771
- <param name="newValues">Array of new values.</param>
772
- <param name="isVertical">Indicates whether array should be inserted vertically.</param>
773
- <remarks>
774
- This can be long operation (needs iteration through all cells
775
- in the worksheet). Better use named ranges instead and call
776
- Import function instead of placeholders.
777
- </remarks>
820
+ Replaces cells' values with new data.
821
+
822
+ Args:
823
+ oldValue: String value to replace.
824
+ newValues: Array of new values.
825
+ isVertical: Indicates whether array should be inserted vertically.
826
+ Example::
827
+
828
+ #Create worksheet
829
+ workbook = Workbook()
830
+ workbook.LoadFromFile("Sample.xlsx")
831
+ worksheet = workbook.Worksheets[0]
832
+ #Replace the oldValue by array of int values
833
+ oldValue = "Find"
834
+ int[] newValues = { 1, 2 }
835
+ worksheet.Replace(oldValue, newValues, true)
836
+ #Save to file
837
+ workbook.SaveToFile("Replace.xlsx")
838
+
778
839
  """
779
840
  #arraynewValues:ArrayTypenewValues = ""
780
841
  countnewValues = len(newValues)
@@ -791,30 +852,24 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
791
852
 
792
853
  def Replace(self ,oldValue:str,newValue:str):
793
854
  """
794
- <summary>
795
- Replaces cells' values with new data.
796
- <example>The following code snippet illustrates how to replace the string with another string:
797
- <code>
798
- //Create worksheet
799
- Workbook workbook = new Workbook();
800
- workbook.LoadFromFile("Sample.xlsx");
801
- Worksheet worksheet = workbook.Worksheets[0];
802
- //Replace the oldValue by newValue
803
- string oldValue = "Find";
804
- string newValue = "NewValue";
805
- worksheet.Replace(oldValue, newValue);
806
- //Save to file
807
- workbook.SaveToFile("Replace.xlsx");
808
- </code>
809
- </example>
810
- </summary>
811
- <param name="oldValue">String value to replace.</param>
812
- <param name="newValue">New value for the range with specified string.</param>
813
- <remarks>
814
- This can be long operation (needs iteration through all cells
815
- in the worksheet). Better use named ranges instead and call
816
- Import function instead of placeholders.
817
- </remarks>
855
+ Replaces cells' values with new data.
856
+
857
+ Args:
858
+ oldValue: String value to replace.
859
+ newValue: New value for the range with specified string.
860
+ Example::
861
+
862
+ #Create worksheet
863
+ workbook = Workbook()
864
+ workbook.LoadFromFile("Sample.xlsx")
865
+ worksheet = workbook.Worksheets[0]
866
+ #Replace the oldValue by newValue
867
+ oldValue = "Find"
868
+ newValue = "NewValue"
869
+ worksheet.Replace(oldValue, newValue)
870
+ #Save to file
871
+ workbook.SaveToFile("Replace.xlsx")
872
+
818
873
  """
819
874
 
820
875
  GetDllLibXls().XlsWorksheet_ReplaceON11.argtypes=[c_void_p ,c_void_p,c_void_p]
@@ -847,31 +902,25 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
847
902
 
848
903
  def Replace(self ,oldValue:str,newValues:List[str],isVertical:bool):
849
904
  """
850
- <summary>
851
- Replaces cells' values with new data.
852
- <example>The following code snippet illustrates how to replace the string with array of string values:
853
- <code>
854
- //Create worksheet
855
- Workbook workbook = new Workbook();
856
- workbook.LoadFromFile("Sample.xlsx");
857
- Worksheet worksheet = workbook.Worksheets[0];
858
- //Replace the oldValue by array of string values
859
- string oldValue = "Find";
860
- string[] newValues = { "X values", "Y values" };
861
- worksheet.Replace(oldValue, newValues , true);
862
- //Save to file
863
- workbook.SaveToFile("Replace.xlsx");
864
- </code>
865
- </example>
866
- </summary>
867
- <param name="oldValue">String value to replace.</param>
868
- <param name="newValues">Array of new values.</param>
869
- <param name="isVertical">Indicates whether array should be inserted vertically.</param>
870
- <remarks>
871
- This can be long operation (needs iteration through all cells
872
- in the worksheet). Better use named ranges instead and call
873
- Import function instead of placeholders.
874
- </remarks>
905
+ Replaces cells' values with new data.
906
+
907
+ Args:
908
+ oldValue: String value to replace.
909
+ newValues: Array of new values.
910
+ isVertical: Indicates whether array should be inserted vertically.
911
+ Example::
912
+
913
+ #Create worksheet
914
+ workbook = Workbook()
915
+ workbook.LoadFromFile("Sample.xlsx")
916
+ worksheet = workbook.Worksheets[0]
917
+ #Replace the oldValue by array of string values
918
+ oldValue = "Find"
919
+ string[] newValues = { "X values", "Y values" }
920
+ worksheet.Replace(oldValue, newValues , true)
921
+ #Save to file
922
+ workbook.SaveToFile("Replace.xlsx")
923
+
875
924
  """
876
925
  #arraynewValues:ArrayTypenewValues = ""
877
926
  countnewValues = len(newValues)
@@ -902,15 +951,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
902
951
 
903
952
  def SaveToImage(self ,fileName:str,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int):
904
953
  """
905
- <summary>
906
954
  Save worksheet to image.
907
- </summary>
908
- <param name="fileName">file Name</param>
909
- <param name="firstRow"></param>
910
- <param name="firstColumn"></param>
911
- <param name="lastRow"></param>
912
- <param name="lastColumn"></param>
913
- <returns></returns>
955
+
956
+ Args:
957
+ fileName: file Name
958
+ firstRow:
959
+ firstColumn:
960
+ lastRow:
961
+ lastColumn:
962
+
914
963
  """
915
964
 
916
965
  GetDllLibXls().XlsWorksheet_SaveToImageFFFLL.argtypes=[c_void_p ,c_void_p,c_int,c_int,c_int,c_int]
@@ -920,11 +969,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
920
969
 
921
970
  def SaveToImage(self ,fileName:str):
922
971
  """
923
- <summary>
924
972
  Save worksheet to image.
925
- </summary>
926
- <param name="fileName">file Name</param>
927
- <returns></returns>
973
+
974
+ Args:
975
+ fileName: file Name
976
+
928
977
  """
929
978
 
930
979
  GetDllLibXls().XlsWorksheet_SaveToImageF.argtypes=[c_void_p ,c_void_p]
@@ -946,11 +995,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
946
995
 
947
996
  def ToImage(self ,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int)->'Stream':
948
997
  """
949
- <summary></summary>
950
- <param name="firstRow">One-based index of the first row to convert.</param>
951
- <param name="firstColumn">One-based index of the first column to convert.</param>
952
- <param name="lastRow">One-based index of the last row to convert.</param>
953
- <param name="lastColumn">One-based index of the last column to convert.</param>
998
+ Args:
999
+ firstRow: One-based index of the first row to convert.
1000
+ firstColumn: One-based index of the first column to convert.
1001
+ lastRow: One-based index of the last row to convert.
1002
+ lastColumn: One-based index of the last column to convert.
1003
+
954
1004
  """
955
1005
 
956
1006
  GetDllLibXls().XlsWorksheet_ToImage.argtypes=[c_void_p ,c_int,c_int,c_int,c_int]
@@ -964,29 +1014,30 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
964
1014
 
965
1015
  def SaveToImage(self ,stream:Stream,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int,imageType:ImageType)->Stream:
966
1016
  """
967
- <summary>
968
- Save worksheet into image.
969
- <example>The following code illustrates how to convert the specified range into image with the specified type:
970
- <code>
971
- //Create worksheet
972
- Workbook workbook = new Workbook();
973
- workbook.LoadFromFile("Sample.xlsx");
974
- Worksheet worksheet = workbook.Worksheets[0];
975
- //Creat stream
976
- Stream stream = new MemoryStream();
977
- //Save to image
978
- System.Drawing.Image image = worksheet.SaveToImage(stream,1, 1, 10, 20, Spire.Xls.ImageType.Bitmap);
979
- image.Save("Sample.png", System.Drawing.Imaging.ImageFormat.Png);
980
- </code>
981
- </example>
982
- </summary>
983
- <param name="stream">Output stream. It is ignored if null.</param>
984
- <param name="firstRow">One-based index of the first row to convert.</param>
985
- <param name="firstColumn">One-based index of the first column to convert.</param>
986
- <param name="lastRow">One-based index of the last row to convert.</param>
987
- <param name="lastColumn">One-based index of the last column to convert.</param>
988
- <param name="imageType">Type of the image to create.</param>
989
- <returns>Created image.</returns>
1017
+ Save worksheet into image.
1018
+
1019
+ Args:
1020
+ stream: Output stream. It is ignored if null.
1021
+ firstRow: One-based index of the first row to convert.
1022
+ firstColumn: One-based index of the first column to convert.
1023
+ lastRow: One-based index of the last row to convert.
1024
+ lastColumn: One-based index of the last column to convert.
1025
+ imageType: Type of the image to create.
1026
+
1027
+ Returns:
1028
+ Created image.
1029
+ Example::
1030
+
1031
+ #Create worksheet
1032
+ workbook = Workbook()
1033
+ workbook.LoadFromFile("Sample.xlsx")
1034
+ worksheet = workbook.Worksheets[0]
1035
+ #Creat stream
1036
+ stream = MemoryStream()
1037
+ #Save to image
1038
+ System.Drawing.image = worksheet.SaveToImage(stream,1, 1, 10, 20, Spire.Xls.ImageType.Bitmap)
1039
+ image.Save("Sample.png", System.Drawing.Imaging.ImageFormat.Png)
1040
+
990
1041
  """
991
1042
  intPtrstream:c_void_p = stream.Ptr
992
1043
  enumimageType:c_int = imageType.value
@@ -1002,16 +1053,19 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1002
1053
 
1003
1054
  def SaveToImage(self ,stream:Stream,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int,emfType:EmfType)->Stream:
1004
1055
  """
1005
- <summary>
1006
1056
  Converts range into image.
1007
- </summary>
1008
- <param name="outputStream">Output stream. It is ignored if null.</param>
1009
- <param name="firstRow">One-based index of the first row to convert.</param>
1010
- <param name="firstColumn">One-based index of the first column to convert.</param>
1011
- <param name="lastRow">One-based index of the last row to convert.</param>
1012
- <param name="lastColumn">One-based index of the last column to convert.</param>
1013
- <param name="emfType">Metafile EmfType.</param>
1014
- <returns>Created image.</returns>
1057
+
1058
+ Args:
1059
+ outputStream: Output stream. It is ignored if null.
1060
+ firstRow: One-based index of the first row to convert.
1061
+ firstColumn: One-based index of the first column to convert.
1062
+ lastRow: One-based index of the last row to convert.
1063
+ lastColumn: One-based index of the last column to convert.
1064
+ emfType: Metafile EmfType.
1065
+
1066
+ Returns:
1067
+ Created image.
1068
+
1015
1069
  """
1016
1070
  intPtrstream:c_void_p = stream.Ptr
1017
1071
  enumemfType:c_int = emfType.value
@@ -1027,17 +1081,20 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1027
1081
 
1028
1082
  def SaveToImage(self ,stream:Stream,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int,imageType:ImageType,emfType:EmfType)->Stream:
1029
1083
  """
1030
- <summary>
1031
1084
  Converts range into image.
1032
- </summary>
1033
- <param name="firstRow">One-based index of the first row to convert.</param>
1034
- <param name="firstColumn">One-based index of the first column to convert.</param>
1035
- <param name="lastRow">One-based index of the last row to convert.</param>
1036
- <param name="lastColumn">One-based index of the last column to convert.</param>
1037
- <param name="imageType">Type of the image to create.</param>
1038
- <param name="outputStream">Output stream. It is ignored if null.</param>
1039
- <param name="emfType">Metafile EmfType.</param>
1040
- <returns>Created image.</returns>
1085
+
1086
+ Args:
1087
+ firstRow: One-based index of the first row to convert.
1088
+ firstColumn: One-based index of the first column to convert.
1089
+ lastRow: One-based index of the last row to convert.
1090
+ lastColumn: One-based index of the last column to convert.
1091
+ imageType: Type of the image to create.
1092
+ outputStream: Output stream. It is ignored if null.
1093
+ emfType: Metafile EmfType.
1094
+
1095
+ Returns:
1096
+ Created image.
1097
+
1041
1098
  """
1042
1099
  intPtrstream:c_void_p = stream.Ptr
1043
1100
  enumimageType:c_int = imageType.value
@@ -1064,22 +1121,21 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1064
1121
 
1065
1122
  def SaveToHtml(self ,stream:Stream):
1066
1123
  """
1067
- <summary>
1068
1124
  Save to HTML stream.
1069
- <example>The following code snippets illustrates how to save as html as stream:
1070
- <code>
1071
- //Create worksheet
1072
- Workbook workbook = new Workbook();
1073
- workbook.LoadFromFile("Sample.xlsx");
1074
- Worksheet worksheet = workbook.Worksheets[0];
1075
- //Creat stream
1076
- Stream stream = new MemoryStream();
1077
- //Save to HTML stream
1078
- worksheet.SaveToHtml(stream);
1079
- </code>
1080
- </example>
1081
- </summary>
1082
- <param name="stream">Stream object</param>
1125
+
1126
+ Args:
1127
+ stream: Stream object
1128
+ Example::
1129
+
1130
+ #Create worksheet
1131
+ workbook = Workbook()
1132
+ workbook.LoadFromFile("Sample.xlsx")
1133
+ worksheet = workbook.Worksheets[0]
1134
+ #Creat stream
1135
+ stream = MemoryStream()
1136
+ #Save to HTML stream
1137
+ worksheet.SaveToHtml(stream)
1138
+
1083
1139
  """
1084
1140
  intPtrstream:c_void_p = stream.Ptr
1085
1141
 
@@ -1090,23 +1146,22 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1090
1146
 
1091
1147
  def SaveToHtml(self ,stream:Stream,saveOption:HTMLOptions):
1092
1148
  """
1093
- <summary>
1094
1149
  Saves work sheet to HTML.
1095
- <example>The following code snippets illustrates how to save as html as stream with Save option:
1096
- <code>
1097
- //Create worksheet
1098
- Workbook workbook = new Workbook();
1099
- workbook.LoadFromFile("Sample.xlsx");
1100
- Worksheet worksheet = workbook.Worksheets[0];
1101
- //Creat stream
1102
- Stream stream = new MemoryStream();
1103
- //Save to HTML stream
1104
- worksheet.SaveToHtml(stream, Spire.Xls.Core.Spreadsheet.HTMLOptions.Default);
1105
- </code>
1106
- </example>
1107
- </summary>
1108
- <param name="stream">The stream</param>
1109
- <param name="saveOption">The option</param>
1150
+
1151
+ Args:
1152
+ stream: The stream
1153
+ saveOption: The option
1154
+ Example::
1155
+
1156
+ #Create worksheet
1157
+ workbook = Workbook()
1158
+ workbook.LoadFromFile("Sample.xlsx")
1159
+ worksheet = workbook.Worksheets[0]
1160
+ #Creat stream
1161
+ stream = MemoryStream()
1162
+ #Save to HTML stream
1163
+ worksheet.SaveToHtml(stream, Spire.Xls.Core.Spreadsheet.HTMLOptions.Default)
1164
+
1110
1165
  """
1111
1166
  intPtrstream:c_void_p = stream.Ptr
1112
1167
  intPtrsaveOption:c_void_p = saveOption.Ptr
@@ -1118,20 +1173,19 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1118
1173
 
1119
1174
  def SaveToHtml(self ,filename:str):
1120
1175
  """
1121
- <summary>
1122
1176
  Save to HTML file.
1123
- <example>The following code snippets illustrates how to save as html to the specified file name:
1124
- <code>
1125
- //Create worksheet
1126
- Workbook workbook = new Workbook();
1127
- workbook.LoadFromFile("Sample.xlsx");
1128
- Worksheet worksheet = workbook.Worksheets[0];
1129
- //Save to HTML file
1130
- worksheet.SaveToHtml("Output.html");
1131
- </code>
1132
- </example>
1133
- </summary>
1134
- <param name="filename">File name</param>
1177
+
1178
+ Args:
1179
+ filename: File name
1180
+ Example::
1181
+
1182
+ #Create worksheet
1183
+ workbook = Workbook()
1184
+ workbook.LoadFromFile("Sample.xlsx")
1185
+ worksheet = workbook.Worksheets[0]
1186
+ #Save to HTML file
1187
+ worksheet.SaveToHtml("Output.html")
1188
+
1135
1189
  """
1136
1190
 
1137
1191
  GetDllLibXls().XlsWorksheet_SaveToHtmlF.argtypes=[c_void_p ,c_void_p]
@@ -1141,21 +1195,20 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1141
1195
 
1142
1196
  def SaveToHtml(self ,fileName:str,saveOption:HTMLOptions):
1143
1197
  """
1144
- <summary>
1145
1198
  Saves as HTML.
1146
- <example>The following code snippets illustrates how to save as html to the specified file name and save option:
1147
- <code>
1148
- //Create worksheet
1149
- Workbook workbook = new Workbook();
1150
- workbook.LoadFromFile("Sample.xlsx");
1151
- Worksheet worksheet = workbook.Worksheets[0];
1152
- //Save to HTML file
1153
- worksheet.SaveToHtml("Sample.html" , Spire.Xls.Core.Spreadsheet.HTMLOptions.Default);
1154
- </code>
1155
- </example>
1156
- </summary>
1157
- <param name="fileName">The filename</param>
1158
- <param name="saveOption">The option</param>
1199
+
1200
+ Args:
1201
+ fileName: The filename
1202
+ saveOption: The option
1203
+ Example::
1204
+
1205
+ #Create worksheet
1206
+ workbook = Workbook()
1207
+ workbook.LoadFromFile("Sample.xlsx")
1208
+ worksheet = workbook.Worksheets[0]
1209
+ #Save to HTML file
1210
+ worksheet.SaveToHtml("Sample.html" , Spire.Xls.Core.Spreadsheet.HTMLOptions.Default)
1211
+
1159
1212
  """
1160
1213
  intPtrsaveOption:c_void_p = saveOption.Ptr
1161
1214
 
@@ -1166,21 +1219,20 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1166
1219
 
1167
1220
  def SaveToFile(self ,fileName:str,separator:str):
1168
1221
  """
1169
- <summary>
1170
1222
  Save worksheet to file.
1171
- <example>The following code illustrates how to saves the worksheet in a different file with separator:
1172
- <code>
1173
- //Create worksheet
1174
- Workbook workbook = new Workbook();
1175
- workbook.LoadFromFile("Sample.xlsx");
1176
- Worksheet worksheet = workbook.Worksheets[0];
1177
- //Save to file
1178
- worksheet.SaveToFile("SaveToFile.csv" , ",");
1179
- </code>
1180
- </example>
1181
- </summary>
1182
- <param name="fileName">File name.</param>
1183
- <param name="separator">Seperator.</param>
1223
+
1224
+ Args:
1225
+ fileName: File name.
1226
+ separator: Seperator.
1227
+ Example::
1228
+
1229
+ #Create worksheet
1230
+ workbook = Workbook()
1231
+ workbook.LoadFromFile("Sample.xlsx")
1232
+ worksheet = workbook.Worksheets[0]
1233
+ #Save to file
1234
+ worksheet.SaveToFile("SaveToFile.csv" , ",")
1235
+
1184
1236
  """
1185
1237
 
1186
1238
  GetDllLibXls().XlsWorksheet_SaveToFile.argtypes=[c_void_p ,c_void_p,c_void_p]
@@ -1190,12 +1242,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1190
1242
 
1191
1243
  def SaveToFile(self ,fileName:str,separator:str,retainHiddenData:bool):
1192
1244
  """
1193
- <summary>
1194
1245
  Save worksheet to file.
1195
- </summary>
1196
- <param name="fileName">File name.</param>
1197
- <param name="separator">Seperator.</param>
1198
- <param name="retainHiddenData">retain hidden data</param>
1246
+
1247
+ Args:
1248
+ fileName: File name.
1249
+ separator: Seperator.
1250
+ retainHiddenData: retain hidden data
1251
+
1199
1252
  """
1200
1253
 
1201
1254
  GetDllLibXls().XlsWorksheet_SaveToFileFSR.argtypes=[c_void_p ,c_void_p,c_void_p,c_bool]
@@ -1205,12 +1258,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1205
1258
 
1206
1259
  def SaveToFile(self ,fileName:str,separator:str,encoding:Encoding):
1207
1260
  """
1208
- <summary>
1209
1261
  Save worksheet to file..
1210
- </summary>
1211
- <param name="fileName">File name.</param>
1212
- <param name="separator">Seperator.</param>
1213
- <param name="encoding">Encoding to use.</param>
1262
+
1263
+ Args:
1264
+ fileName: File name.
1265
+ separator: Seperator.
1266
+ encoding: Encoding to use.
1267
+
1214
1268
  """
1215
1269
  intPtrencoding:c_void_p = encoding.Ptr
1216
1270
 
@@ -1221,23 +1275,22 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1221
1275
 
1222
1276
  def SaveToStream(self ,stream:Stream,separator:str):
1223
1277
  """
1224
- <summary>
1225
1278
  Save worksheet to stream.
1226
- <example>The following code illustrates how to saves the worksheet as stream with separator:
1227
- <code>
1228
- //Create worksheet
1229
- Workbook workbook = new Workbook();
1230
- workbook.LoadFromFile("Sample.xlsx");
1231
- Worksheet worksheet = workbook.Worksheets[0];
1232
- //Create stream
1233
- Stream stream = new MemoryStream();
1234
- //Save to stream
1235
- worksheet.SaveToStream(stream , ",");
1236
- </code>
1237
- </example>
1238
- </summary>
1239
- <param name="stream">Stream object.</param>
1240
- <param name="separator">Seperator.</param>
1279
+
1280
+ Args:
1281
+ stream: Stream object.
1282
+ separator: Seperator.
1283
+ Example::
1284
+
1285
+ #Create worksheet
1286
+ workbook = Workbook()
1287
+ workbook.LoadFromFile("Sample.xlsx")
1288
+ worksheet = workbook.Worksheets[0]
1289
+ #Create stream
1290
+ stream = MemoryStream()
1291
+ #Save to stream
1292
+ worksheet.SaveToStream(stream , ",")
1293
+
1241
1294
  """
1242
1295
  intPtrstream:c_void_p = stream.Ptr
1243
1296
 
@@ -1248,12 +1301,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1248
1301
 
1249
1302
  def SaveToStream(self ,stream:Stream,separator:str,retainHiddenData:bool):
1250
1303
  """
1251
- <summary>
1252
1304
  Save worksheet to stream.
1253
- </summary>
1254
- <param name="stream">Stream object.</param>
1255
- <param name="separator">Seperator.</param>
1256
- <param name="retainHiddenData">retain hidden data</param>
1305
+
1306
+ Args:
1307
+ stream: Stream object.
1308
+ separator: Seperator.
1309
+ retainHiddenData: retain hidden data
1310
+
1257
1311
  """
1258
1312
  intPtrstream:c_void_p = stream.Ptr
1259
1313
 
@@ -1264,12 +1318,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1264
1318
 
1265
1319
  def SaveToStream(self ,stream:Stream,separator:str,encoding:Encoding):
1266
1320
  """
1267
- <summary>
1268
1321
  Save worksheet to stream.
1269
- </summary>
1270
- <param name="stream">Stream to save.</param>
1271
- <param name="separator">Current seperator.</param>
1272
- <param name="encoding">Encoding to use.</param>
1322
+
1323
+ Args:
1324
+ stream: Stream to save.
1325
+ separator: Current seperator.
1326
+ encoding: Encoding to use.
1327
+
1273
1328
  """
1274
1329
  intPtrstream:c_void_p = stream.Ptr
1275
1330
  intPtrencoding:c_void_p = encoding.Ptr
@@ -1280,10 +1335,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1280
1335
 
1281
1336
  def SaveToXps(self ,fileName:str):
1282
1337
  """
1283
- <summary>
1284
- Saves specific worksheet to xps.
1285
- </summary>
1286
- <param name="fileName">File name.</param>
1338
+ Saves specific worksheet to xps.
1339
+
1340
+ Args:
1341
+ fileName: File name.
1342
+
1287
1343
  """
1288
1344
 
1289
1345
  GetDllLibXls().XlsWorksheet_SaveToXps.argtypes=[c_void_p ,c_void_p]
@@ -1293,10 +1349,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1293
1349
 
1294
1350
  def SaveToPdf(self ,fileName:str,fileFormat:FileFormat):
1295
1351
  """
1296
- <summary>
1297
1352
  Save worksheet to pdf.
1298
- </summary>
1299
- <param name="fileName">File name.</param>
1353
+
1354
+ Args:
1355
+ fileName: File name.
1356
+
1300
1357
  """
1301
1358
  enumfileFormat:c_int = fileFormat.value
1302
1359
 
@@ -1307,10 +1364,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1307
1364
 
1308
1365
  def SaveToPdf(self ,fileName:str):
1309
1366
  """
1310
- <summary>
1311
1367
  Save worksheet to pdf.
1312
- </summary>
1313
- <param name="fileName">File name.</param>
1368
+
1369
+ Args:
1370
+ fileName: File name.
1371
+
1314
1372
  """
1315
1373
 
1316
1374
  GetDllLibXls().XlsWorksheet_SaveToPdfF.argtypes=[c_void_p ,c_void_p]
@@ -1332,10 +1390,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1332
1390
 
1333
1391
  def SaveToPdfStream(self ,stream:Stream):
1334
1392
  """
1335
- <summary>
1336
1393
  Save worksheet to pdf Stream.
1337
- </summary>
1338
- <param name="stream">Stream.</param>
1394
+
1395
+ Args:
1396
+ stream: Stream.
1397
+
1339
1398
  """
1340
1399
  intPtrstream:c_void_p = stream.Ptr
1341
1400
 
@@ -1345,14 +1404,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1345
1404
 
1346
1405
  def ToSVGStream(self ,stream:'Stream',firstRow:int,firstColumn:int,lastRow:int,lastColumn:int):
1347
1406
  """
1348
- <summary>
1349
1407
  Convert CellRange to Svg stream
1350
- </summary>
1351
- <param name="stream">stream.</param>
1352
- <param name="firstRow">One-based index of the first row to convert.</param>
1353
- <param name="firstColumn">One-based index of the first column to convert.</param>
1354
- <param name="lastRow">One-based index of the last row to convert.</param>
1355
- <param name="lastColumn">One-based index of the last column to convert.</param>
1408
+
1409
+ Args:
1410
+ stream: stream.
1411
+ firstRow: One-based index of the first row to convert.
1412
+ firstColumn: One-based index of the first column to convert.
1413
+ lastRow: One-based index of the last row to convert.
1414
+ lastColumn: One-based index of the last column to convert.
1415
+
1356
1416
  """
1357
1417
  intPtrstream:c_void_p = stream.Ptr
1358
1418
 
@@ -1362,11 +1422,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1362
1422
 
1363
1423
  def SetBlank(self ,iRow:int,iColumn:int):
1364
1424
  """
1365
- <summary>
1366
1425
  Sets blank in specified cell.
1367
- </summary>
1368
- <param name="iRow">One-based row index of the cell to set value.</param>
1369
- <param name="iColumn">One-based column index of the cell to set value.</param>
1426
+
1427
+ Args:
1428
+ iRow: One-based row index of the cell to set value.
1429
+ iColumn: One-based column index of the cell to set value.
1430
+
1370
1431
  """
1371
1432
 
1372
1433
  GetDllLibXls().XlsWorksheet_SetBlank.argtypes=[c_void_p ,c_int,c_int]
@@ -1375,12 +1436,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1375
1436
 
1376
1437
  def SetBoolean(self ,iRow:int,iColumn:int,value:bool):
1377
1438
  """
1378
- <summary>
1379
1439
  Sets value in the specified cell.
1380
- </summary>
1381
- <param name="iRow">One-based row index of the cell to set value.</param>
1382
- <param name="iColumn">One-based column index of the cell to set value.</param>
1383
- <param name="value">Value to set.</param>
1440
+
1441
+ Args:
1442
+ iRow: One-based row index of the cell to set value.
1443
+ iColumn: One-based column index of the cell to set value.
1444
+ value: Value to set.
1445
+
1384
1446
  """
1385
1447
 
1386
1448
  GetDllLibXls().XlsWorksheet_SetBoolean.argtypes=[c_void_p ,c_int,c_int,c_bool]
@@ -1390,22 +1452,21 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1390
1452
 
1391
1453
  def SetColumnWidthInPixels(self ,iColumn:int,value:int):
1392
1454
  """
1393
- <summary>
1394
- Sets column width in pixels.
1395
- <example>The following code illustrates how to set width for a column:
1396
- <code>
1397
- //Create worksheet
1398
- Workbook workbook = new Workbook();
1399
- Worksheet worksheet = workbook.Worksheets[0];
1400
- //Set column width
1401
- worksheet.SetColumnWidthInPixels(2, 160);
1402
- //Save to file
1403
- workbook.SaveToFile("SetColumnWidthInPixels.xlsx");
1404
- </code>
1405
- </example>
1406
- </summary>
1407
- <param name="iColumn">One-based column index.</param>
1408
- <param name="value">Width in pixels to set.</param>
1455
+ Sets column width in pixels.
1456
+
1457
+ Args:
1458
+ iColumn: One-based column index.
1459
+ value: Width in pixels to set.
1460
+ Example::
1461
+
1462
+ #Create worksheet
1463
+ workbook = Workbook()
1464
+ worksheet = workbook.Worksheets[0]
1465
+ #Set column width
1466
+ worksheet.SetColumnWidthInPixels(2, 160)
1467
+ #Save to file
1468
+ workbook.SaveToFile("SetColumnWidthInPixels.xlsx")
1469
+
1409
1470
  """
1410
1471
 
1411
1472
  GetDllLibXls().XlsWorksheet_SetColumnWidthInPixels.argtypes=[c_void_p ,c_int,c_int]
@@ -1414,11 +1475,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1414
1475
 
1415
1476
  def SetColumnWidth(self ,columnIndex:int,width:float):
1416
1477
  """
1417
- <summary>
1418
1478
  Set solumn width
1419
- </summary>
1420
- <param name="columnIndex">Column index.</param>
1421
- <param name="width">Width to set.</param>
1479
+
1480
+ Args:
1481
+ columnIndex: Column index.
1482
+ width: Width to set.
1483
+
1422
1484
  """
1423
1485
 
1424
1486
  GetDllLibXls().XlsWorksheet_SetColumnWidth.argtypes=[c_void_p ,c_int,c_double]
@@ -1428,12 +1490,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1428
1490
 
1429
1491
  def SetColumnWidthInPixels(self ,columnIndex:int,count:int,value:int):
1430
1492
  """
1431
- <summary>
1432
- Sets the width of the specified columns.
1433
- </summary>
1434
- <param name="columnIndex">Column index</param>
1435
- <param name="count">count</param>
1436
- <param name="value">Value</param>
1493
+ Sets the width of the specified columns.
1494
+
1495
+ Args:
1496
+ columnIndex: Column index
1497
+ count: count
1498
+ value: Value
1499
+
1437
1500
  """
1438
1501
 
1439
1502
  GetDllLibXls().XlsWorksheet_SetColumnWidthInPixelsCCV.argtypes=[c_void_p ,c_int,c_int,c_int]
@@ -1443,11 +1506,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1443
1506
 
1444
1507
  def SetDefaultColumnStyle(self ,columnIndex:int,defaultStyle:IStyle):
1445
1508
  """
1446
- <summary>
1447
1509
  Sets default style for column.
1448
- </summary>
1449
- <param name="columnIndex">Column index.</param>
1450
- <param name="defaultStyle">Default style.</param>
1510
+
1511
+ Args:
1512
+ columnIndex: Column index.
1513
+ defaultStyle: Default style.
1514
+
1451
1515
  """
1452
1516
  intPtrdefaultStyle:c_void_p = defaultStyle.Ptr
1453
1517
 
@@ -1491,12 +1555,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1491
1555
 
1492
1556
  def SetError(self ,iRow:int,iColumn:int,value:str):
1493
1557
  """
1494
- <summary>
1495
1558
  Sets error in the specified cell.
1496
- </summary>
1497
- <param name="iRow">One-based row index of the cell to set value.</param>
1498
- <param name="iColumn">One-based column index of the cell to set value.</param>
1499
- <param name="value">Error to set.</param>
1559
+
1560
+ Args:
1561
+ iRow: One-based row index of the cell to set value.
1562
+ iColumn: One-based column index of the cell to set value.
1563
+ value: Error to set.
1564
+
1500
1565
  """
1501
1566
 
1502
1567
  GetDllLibXls().XlsWorksheet_SetError.argtypes=[c_void_p ,c_int,c_int,c_void_p]
@@ -1506,11 +1571,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1506
1571
 
1507
1572
  def SetError(self ,iRow:int,iColumn:int,value:str,isSetText:bool):
1508
1573
  """
1509
- <summary></summary>
1510
- <param name="iRow"></param>
1511
- <param name="iColumn"></param>
1512
- <param name="value"></param>
1513
- <param name="isSetText"></param>
1574
+ Args:
1575
+ iRow:
1576
+ iColumn:
1577
+ value:
1578
+ isSetText:
1579
+
1514
1580
  """
1515
1581
 
1516
1582
  GetDllLibXls().XlsWorksheet_SetErrorIIVI.argtypes=[c_void_p ,c_int,c_int,c_void_p,c_bool]
@@ -1520,12 +1586,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1520
1586
 
1521
1587
  def SetFormula(self ,iRow:int,iColumn:int,value:str):
1522
1588
  """
1523
- <summary>
1524
1589
  Sets formula in the specified cell.
1525
- </summary>
1526
- <param name="iRow">One-based row index of the cell to set value.</param>
1527
- <param name="iColumn">One-based column index of the cell to set value.</param>
1528
- <param name="value">Formula to set.</param>
1590
+
1591
+ Args:
1592
+ iRow: One-based row index of the cell to set value.
1593
+ iColumn: One-based column index of the cell to set value.
1594
+ value: Formula to set.
1595
+
1529
1596
  """
1530
1597
 
1531
1598
  GetDllLibXls().XlsWorksheet_SetFormula.argtypes=[c_void_p ,c_int,c_int,c_void_p]
@@ -1535,13 +1602,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1535
1602
 
1536
1603
  def SetFormula(self ,iRow:int,iColumn:int,value:str,bIsR1C1:bool):
1537
1604
  """
1538
- <summary>
1539
1605
  Sets formula in the specified cell.
1540
- </summary>
1541
- <param name="iRow">One-based row index of the cell to set value.</param>
1542
- <param name="iColumn">One-based column index of the cell to set value.</param>
1543
- <param name="value">Formula to set.</param>
1544
- <param name="bIsR1C1">Indicates is formula in R1C1 notation.</param>
1606
+
1607
+ Args:
1608
+ iRow: One-based row index of the cell to set value.
1609
+ iColumn: One-based column index of the cell to set value.
1610
+ value: Formula to set.
1611
+ bIsR1C1: Indicates is formula in R1C1 notation.
1612
+
1545
1613
  """
1546
1614
 
1547
1615
  GetDllLibXls().XlsWorksheet_SetFormulaIIVB.argtypes=[c_void_p ,c_int,c_int,c_void_p,c_bool]
@@ -1550,12 +1618,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1550
1618
 
1551
1619
  def SetFormulaBoolValue(self ,iRow:int,iColumn:int,value:bool):
1552
1620
  """
1553
- <summary>
1554
1621
  Sets formula bool value.
1555
- </summary>
1556
- <param name="iRow">One based row index.</param>
1557
- <param name="iColumn">One based column index.</param>
1558
- <param name="value">Represents formula bool value for set.</param>
1622
+
1623
+ Args:
1624
+ iRow: One based row index.
1625
+ iColumn: One based column index.
1626
+ value: Represents formula bool value for set.
1627
+
1559
1628
  """
1560
1629
 
1561
1630
  GetDllLibXls().XlsWorksheet_SetFormulaBoolValue.argtypes=[c_void_p ,c_int,c_int,c_bool]
@@ -1564,12 +1633,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1564
1633
 
1565
1634
  def SetFormulaErrorValue(self ,iRow:int,iColumn:int,value:str):
1566
1635
  """
1567
- <summary>
1568
1636
  Sets formula error value.
1569
- </summary>
1570
- <param name="iRow">One based row index.</param>
1571
- <param name="iColumn">One based column index.</param>
1572
- <param name="value">Represents formula error value for set.</param>
1637
+
1638
+ Args:
1639
+ iRow: One based row index.
1640
+ iColumn: One based column index.
1641
+ value: Represents formula error value for set.
1642
+
1573
1643
  """
1574
1644
 
1575
1645
  GetDllLibXls().XlsWorksheet_SetFormulaErrorValue.argtypes=[c_void_p ,c_int,c_int,c_void_p]
@@ -1578,12 +1648,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1578
1648
 
1579
1649
  def SetFormulaNumberValue(self ,iRow:int,iColumn:int,value:float):
1580
1650
  """
1581
- <summary>
1582
1651
  Sets formula number value.
1583
- </summary>
1584
- <param name="iRow">One based row index.</param>
1585
- <param name="iColumn">One based column index.</param>
1586
- <param name="value">Represents formula number value for set.</param>
1652
+
1653
+ Args:
1654
+ iRow: One based row index.
1655
+ iColumn: One based column index.
1656
+ value: Represents formula number value for set.
1657
+
1587
1658
  """
1588
1659
 
1589
1660
  GetDllLibXls().XlsWorksheet_SetFormulaNumberValue.argtypes=[c_void_p ,c_int,c_int,c_double]
@@ -1592,12 +1663,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1592
1663
 
1593
1664
  def SetFormulaStringValue(self ,iRow:int,iColumn:int,value:str):
1594
1665
  """
1595
- <summary>
1596
1666
  Sets formula string value.
1597
- </summary>
1598
- <param name="iRow">One based row index.</param>
1599
- <param name="iColumn">One based column index.</param>
1600
- <param name="value">Represents formula string value for set.</param>
1667
+
1668
+ Args:
1669
+ iRow: One based row index.
1670
+ iColumn: One based column index.
1671
+ value: Represents formula string value for set.
1672
+
1601
1673
  """
1602
1674
 
1603
1675
  GetDllLibXls().XlsWorksheet_SetFormulaStringValue.argtypes=[c_void_p ,c_int,c_int,c_void_p]
@@ -1606,12 +1678,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1606
1678
 
1607
1679
  def SetNumber(self ,iRow:int,iColumn:int,value:float):
1608
1680
  """
1609
- <summary>
1610
1681
  Sets value in the specified cell.
1611
- </summary>
1612
- <param name="iRow">One-based row index of the cell to set value.</param>
1613
- <param name="iColumn">One-based column index of the cell to set value.</param>
1614
- <param name="value">Value to set.</param>
1682
+
1683
+ Args:
1684
+ iRow: One-based row index of the cell to set value.
1685
+ iColumn: One-based column index of the cell to set value.
1686
+ value: Value to set.
1687
+
1615
1688
  """
1616
1689
 
1617
1690
  GetDllLibXls().XlsWorksheet_SetNumber.argtypes=[c_void_p ,c_int,c_int,c_double]
@@ -1620,12 +1693,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1620
1693
 
1621
1694
  def SetRowHeightInPixels(self ,rowIndex:int,count:int,value:float):
1622
1695
  """
1623
- <summary>
1624
1696
  Set Row height from Start Row index
1625
- </summary>
1626
- <param name="rowIndex">Row index</param>
1627
- <param name="Count">count</param>
1628
- <param name="value">Value</param>
1697
+
1698
+ Args:
1699
+ rowIndex: Row index
1700
+ Count: count
1701
+ value: Value
1702
+
1629
1703
  """
1630
1704
 
1631
1705
  GetDllLibXls().XlsWorksheet_SetRowHeightInPixels.argtypes=[c_void_p ,c_int,c_int,c_double]
@@ -1634,11 +1708,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1634
1708
 
1635
1709
  def SetRowHeight(self ,rowIndex:int,height:float):
1636
1710
  """
1637
- <summary>
1638
- Sets the height of the specified row.
1639
- </summary>
1640
- <param name="rowIndex">Row index.</param>
1641
- <param name="height">Height.</param>
1711
+ Sets the height of the specified row.
1712
+
1713
+ Args:
1714
+ rowIndex: Row index.
1715
+ height: Height.
1716
+
1642
1717
  """
1643
1718
 
1644
1719
  GetDllLibXls().XlsWorksheet_SetRowHeight.argtypes=[c_void_p ,c_int,c_double]
@@ -1647,22 +1722,21 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1647
1722
 
1648
1723
  def SetRowHeightPixels(self ,rowIndex:int,height:float):
1649
1724
  """
1650
- <summary>
1651
- Sets the height of the specified row.
1652
- <example>The following code illustrates how to set height for a row:
1653
- <code>
1654
- //Create worksheet
1655
- Workbook workbook = new Workbook();
1656
- Worksheet worksheet = workbook.Worksheets[0];
1657
- //Set row height
1658
- worksheet.SetRowHeightPixels(3, 150);
1659
- //Save to file
1660
- workbook.SaveToFile("SetRowHeightPixels.xlsx");
1661
- </code>
1662
- </example>
1663
- </summary>
1664
- <param name="rowIndex">Row index.</param>
1665
- <param name="height">Height.</param>
1725
+ Sets the height of the specified row.
1726
+
1727
+ Args:
1728
+ rowIndex: Row index.
1729
+ height: Height.
1730
+ Example::
1731
+
1732
+ #Create worksheet
1733
+ workbook = Workbook()
1734
+ worksheet = workbook.Worksheets[0]
1735
+ #Set row height
1736
+ worksheet.SetRowHeightPixels(3, 150)
1737
+ #Save to file
1738
+ workbook.SaveToFile("SetRowHeightPixels.xlsx")
1739
+
1666
1740
  """
1667
1741
 
1668
1742
  GetDllLibXls().XlsWorksheet_SetRowHeightPixels.argtypes=[c_void_p ,c_int,c_double]
@@ -1671,12 +1745,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1671
1745
 
1672
1746
  def SetText(self ,iRow:int,iColumn:int,value:str):
1673
1747
  """
1674
- <summary>
1675
1748
  Sets text in the specified cell.
1676
- </summary>
1677
- <param name="iRow">One-based row index of the cell to set value.</param>
1678
- <param name="iColumn">One-based column index of the cell to set value.</param>
1679
- <param name="value">Text to set.</param>
1749
+
1750
+ Args:
1751
+ iRow: One-based row index of the cell to set value.
1752
+ iColumn: One-based column index of the cell to set value.
1753
+ value: Text to set.
1754
+
1680
1755
  """
1681
1756
 
1682
1757
  GetDllLibXls().XlsWorksheet_SetText.argtypes=[c_void_p ,c_int,c_int,c_void_p]
@@ -1695,12 +1770,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1695
1770
 
1696
1771
  def SetCellValue(self ,rowIndex:int,columnIndex:int,boolValue:bool):
1697
1772
  """
1698
- <summary>
1699
1773
  Sets value in the specified cell.
1700
- </summary>
1701
- <param name="rowIndex">Row index.</param>
1702
- <param name="columnIndex">Column index.</param>
1703
- <param name="boolValue">Value to set.</param>
1774
+
1775
+ Args:
1776
+ rowIndex: Row index.
1777
+ columnIndex: Column index.
1778
+ boolValue: Value to set.
1779
+
1704
1780
  """
1705
1781
 
1706
1782
  GetDllLibXls().XlsWorksheet_SetCellValue.argtypes=[c_void_p ,c_int,c_int,c_bool]
@@ -1710,12 +1786,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1710
1786
 
1711
1787
  def SetCellValue(self ,rowIndex:int,columnIndex:int,stringValue:str):
1712
1788
  """
1713
- <summary>
1714
1789
  Sets value in the specified cell.
1715
- </summary>
1716
- <param name="rowIndex">Row index</param>
1717
- <param name="columnIndex">Column index.</param>
1718
- <param name="stringValue">Value to set.</param>
1790
+
1791
+ Args:
1792
+ rowIndex: Row index
1793
+ columnIndex: Column index.
1794
+ stringValue: Value to set.
1795
+
1719
1796
  """
1720
1797
 
1721
1798
  GetDllLibXls().XlsWorksheet_SetCellValueRCS.argtypes=[c_void_p ,c_int,c_int,c_void_p]
@@ -1724,9 +1801,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1724
1801
  @property
1725
1802
  def HasMergedCells(self)->bool:
1726
1803
  """
1727
- <summary>
1728
1804
  Indicates whether worksheet has merged cells.
1729
- </summary>
1805
+
1730
1806
  """
1731
1807
  GetDllLibXls().XlsWorksheet_get_HasMergedCells.argtypes=[c_void_p]
1732
1808
  GetDllLibXls().XlsWorksheet_get_HasMergedCells.restype=c_bool
@@ -1736,28 +1812,22 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1736
1812
  @property
1737
1813
  def HasOleObjects(self)->bool:
1738
1814
  """
1739
- <summary>
1740
- Indicats whether there is OLE object.
1741
- <example>The following code illustrates how to access the IListObjects collection in the worksheet to add a new IOleObject and check Ole Object:
1742
- <code>
1743
- //Create worksheet
1744
- Workbook workbook = new Workbook();
1745
- Worksheet worksheet = workbook.Worksheets[0];
1746
- //Create image stream
1747
- System.Drawing.Image image = System.Drawing.Image.FromFile("image.png");
1748
- //Add ole object
1749
- IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed);
1750
- //Check HasOleObject.Output will be true.</para>
1751
- Console.Write(worksheet.HasOleObjects);
1752
-
1753
- <para>//Save to file
1754
- workbook.SaveToFile("HasOleObjects.xlsx");
1755
- </code>
1756
- </example>
1757
- </summary>
1758
- <value>
1759
- <c>true</c> if this instance is OLE object; otherwise, <c>false</c>.
1760
- </value>
1815
+ Indicats whether there is OLE object.
1816
+ Example::
1817
+
1818
+ #Create worksheet
1819
+ workbook = Workbook()
1820
+ worksheet = workbook.Worksheets[0]
1821
+ #Create image stream
1822
+ System.Drawing.image = System.Drawing.Image.FromFile("image.png")
1823
+ #Add ole object
1824
+ oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed)
1825
+ #Check HasOleObject.Output will be true.</para>
1826
+ Console.Write(worksheet.HasOleObjects)
1827
+
1828
+ <para>#Save to file
1829
+ workbook.SaveToFile("HasOleObjects.xlsx");
1830
+
1761
1831
  """
1762
1832
  GetDllLibXls().XlsWorksheet_get_HasOleObjects.argtypes=[c_void_p]
1763
1833
  GetDllLibXls().XlsWorksheet_get_HasOleObjects.restype=c_bool
@@ -1808,9 +1878,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1808
1878
  @property
1809
1879
  def IsDisplayZeros(self)->bool:
1810
1880
  """
1811
- <summary>
1812
1881
  Indicates whether zero values to be displayed
1813
- </summary>
1882
+
1814
1883
  """
1815
1884
  GetDllLibXls().XlsWorksheet_get_IsDisplayZeros.argtypes=[c_void_p]
1816
1885
  GetDllLibXls().XlsWorksheet_get_IsDisplayZeros.restype=c_bool
@@ -1825,9 +1894,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1825
1894
  @property
1826
1895
  def IsEmpty(self)->bool:
1827
1896
  """
1828
- <summary>
1829
1897
  Indicates whether worksheet is empty. Read-only.
1830
- </summary>
1898
+
1831
1899
  """
1832
1900
  GetDllLibXls().XlsWorksheet_get_IsEmpty.argtypes=[c_void_p]
1833
1901
  GetDllLibXls().XlsWorksheet_get_IsEmpty.restype=c_bool
@@ -1837,9 +1905,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1837
1905
  @property
1838
1906
  def IsFreezePanes(self)->bool:
1839
1907
  """
1840
- <summary>
1841
1908
  Indicates whether freezed panes are applied.
1842
- </summary>
1909
+
1843
1910
  """
1844
1911
  GetDllLibXls().XlsWorksheet_get_IsFreezePanes.argtypes=[c_void_p]
1845
1912
  GetDllLibXls().XlsWorksheet_get_IsFreezePanes.restype=c_bool
@@ -1849,9 +1916,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1849
1916
  @property
1850
1917
  def IsStringsPreserved(self)->bool:
1851
1918
  """
1852
- <summary>
1853
1919
  Indicates if all values in the workbook are preserved as strings.
1854
- </summary>
1920
+
1855
1921
  """
1856
1922
  GetDllLibXls().XlsWorksheet_get_IsStringsPreserved.argtypes=[c_void_p]
1857
1923
  GetDllLibXls().XlsWorksheet_get_IsStringsPreserved.restype=c_bool
@@ -1867,12 +1933,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1867
1933
 
1868
1934
  def AddAllowEditRange(self ,title:str,range:CellRange,password:str)->bool:
1869
1935
  """
1870
- <summary>
1871
1936
  AddAllowEditRange : add a range of cells that allow editing
1872
- </summary>
1873
- <param name="title">title</param>
1874
- <param name="range">range</param>
1875
- <param name="password">password</param>
1937
+
1938
+ Args:
1939
+ title: title
1940
+ range: range
1941
+ password: password
1942
+
1876
1943
  """
1877
1944
  intPtrrange:c_void_p = range.Ptr
1878
1945
 
@@ -1885,11 +1952,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1885
1952
 
1886
1953
  def AddAllowEditRange(self ,title:str,range:CellRange)->bool:
1887
1954
  """
1888
- <summary>
1889
1955
  AddAllowEditRange : add a range of cells that allow editing
1890
- </summary>
1891
- <param name="title">title</param>
1892
- <param name="range">range</param>
1956
+
1957
+ Args:
1958
+ title: title
1959
+ range: range
1960
+
1893
1961
  """
1894
1962
  intPtrrange:c_void_p = range.Ptr
1895
1963
 
@@ -1902,9 +1970,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1902
1970
 
1903
1971
  def ListObjects(self)->'IListObjects':
1904
1972
  """
1905
- <summary>
1906
1973
  Returns all list objects in the worksheet.
1907
- </summary>
1974
+
1908
1975
  """
1909
1976
  GetDllLibXls().XlsWorksheet_get_ListObjects.argtypes=[c_void_p]
1910
1977
  GetDllLibXls().XlsWorksheet_get_ListObjects.restype=c_void_p
@@ -1931,10 +1998,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1931
1998
  @property
1932
1999
  def RowColumnHeadersVisible(self)->bool:
1933
2000
  """
1934
- <summary>
1935
- True if row and column headers are visible.
1936
- False otherwise.
1937
- </summary>
2001
+ True if row and column headers are visible. False otherwise.
2002
+
1938
2003
  """
1939
2004
  GetDllLibXls().XlsWorksheet_get_RowColumnHeadersVisible.argtypes=[c_void_p]
1940
2005
  GetDllLibXls().XlsWorksheet_get_RowColumnHeadersVisible.restype=c_bool
@@ -1949,9 +2014,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1949
2014
  @property
1950
2015
  def ProtectContents(self)->bool:
1951
2016
  """
1952
- <summary>
1953
2017
  Indicates whether current sheet is protected.
1954
- </summary>
2018
+
1955
2019
  """
1956
2020
  GetDllLibXls().XlsWorksheet_get_ProtectContents.argtypes=[c_void_p]
1957
2021
  GetDllLibXls().XlsWorksheet_get_ProtectContents.restype=c_bool
@@ -1962,9 +2026,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1962
2026
 
1963
2027
  def PivotTables(self)->'PivotTablesCollection':
1964
2028
  """
1965
- <summary>
1966
2029
  Returns charts collection. Read-only.
1967
- </summary>
2030
+
1968
2031
  """
1969
2032
  GetDllLibXls().XlsWorksheet_get_PivotTables.argtypes=[c_void_p]
1970
2033
  GetDllLibXls().XlsWorksheet_get_PivotTables.restype=c_void_p
@@ -1977,9 +2040,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
1977
2040
 
1978
2041
  def QuotedName(self)->str:
1979
2042
  """
1980
- <summary>
1981
2043
  Returns quoted name of the worksheet.
1982
- </summary>
2044
+
1983
2045
  """
1984
2046
  GetDllLibXls().XlsWorksheet_get_QuotedName.argtypes=[c_void_p]
1985
2047
  GetDllLibXls().XlsWorksheet_get_QuotedName.restype=c_void_p
@@ -2002,9 +2064,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2002
2064
 
2003
2065
  def CalculateAllValue(self):
2004
2066
  """
2005
- <summary>
2006
2067
  Caculate all formula for the specified worksheet
2007
- </summary>
2068
+
2008
2069
  """
2009
2070
  GetDllLibXls().XlsWorksheet_CalculateAllValue.argtypes=[c_void_p]
2010
2071
  CallCFunction(GetDllLibXls().XlsWorksheet_CalculateAllValue, self.Ptr)
@@ -2076,27 +2137,25 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2076
2137
 
2077
2138
  def InsertArray(self ,doubleArray:List[float],firstRow:int,firstColumn:int,isVertical:bool)->int:
2078
2139
  """
2079
- <summary>
2080
- Imports an array of doubles into a worksheet.
2081
- <example>The following code illustrates how to Imports an array of Double values into a worksheet with the specified row and column:
2082
- <code>
2083
- //Create worksheet
2084
- Workbook workbook = new Workbook();
2085
- Worksheet worksheet = workbook.Worksheets[0];
2086
- //Initialize the double Array
2087
- double[] arrayDouble = new double[4] { 344.0045, 345.0045, 346.0045, 347.0045 };
2088
- //Insert the double Array to Sheet
2089
- worksheet.InsertArray(arrayDouble, 1, 1, true);
2090
- //Save to file
2091
- workbook.SaveToFile(InsertArray.xlsx");
2092
- </code>
2093
- </example>
2094
- </summary>
2095
- <param name="doubleArray">Double array</param>
2096
- <param name="firstRow">The row number of the first cell to import in.</param>
2097
- <param name="firstColumn">The column number of the first cell to import in.</param>
2098
- <param name="isVertical">Specifies to import data vertically or horizontally.</param>
2099
- <returns></returns>
2140
+ Imports an array of doubles into a worksheet.
2141
+
2142
+ Args:
2143
+ doubleArray: Double array
2144
+ firstRow: The row number of the first cell to import in.
2145
+ firstColumn: The column number of the first cell to import in.
2146
+ isVertical: Specifies to import data vertically or horizontally.
2147
+ Example::
2148
+
2149
+ #Create worksheet
2150
+ workbook = Workbook()
2151
+ worksheet = workbook.Worksheets[0]
2152
+ #Initialize the double Array
2153
+ double[] arrayDouble = new double[4] { 344.0045, 345.0045, 346.0045, 347.0045 }
2154
+ #Insert the double Array to Sheet
2155
+ worksheet.InsertArray(arrayDouble, 1, 1, true)
2156
+ #Save to file
2157
+ workbook.SaveToFile(InsertArray.xlsx")
2158
+
2100
2159
  """
2101
2160
  #arraydoubleArray:ArrayTypedoubleArray = ""
2102
2161
  countdoubleArray = len(doubleArray)
@@ -2129,27 +2188,25 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2129
2188
 
2130
2189
  def InsertArray(self ,intArray:List[int],firstRow:int,firstColumn:int,isVertical:bool)->int:
2131
2190
  """
2132
- <summary>
2133
- Imports an array of integer into a worksheet.
2134
- <example>The following code illustrates how to Imports an array of integer values into a worksheet with the specified row and column:
2135
- <code>
2136
- //Create worksheet
2137
- Workbook workbook = new Workbook();
2138
- Worksheet worksheet = workbook.Worksheets[0];
2139
- //Initialize the integer Array
2140
- int[] arrayInt = new int[4] {1000, 2000, 3000, 4000};
2141
- //Insert the integer Array to Sheet
2142
- worksheet.InsertArray(arrayInt, 1, 1, true);
2143
- //Save to file
2144
- workbook.SaveToFile(InsertArray.xlsx");
2145
- </code>
2146
- </example>
2147
- </summary>
2148
- <param name="intArray">Integer array.</param>
2149
- <param name="firstRow">The row number of the first cell to import in.</param>
2150
- <param name="firstColumn">The column number of the first cell to import in.</param>
2151
- <param name="isVertical">Specifies to import data vertically or horizontally.</param>
2152
- <returns></returns>
2191
+ Imports an array of integer into a worksheet.
2192
+
2193
+ Args:
2194
+ intArray: Integer array.
2195
+ firstRow: The row number of the first cell to import in.
2196
+ firstColumn: The column number of the first cell to import in.
2197
+ isVertical: Specifies to import data vertically or horizontally.
2198
+ Example::
2199
+
2200
+ #Create worksheet
2201
+ workbook = Workbook()
2202
+ worksheet = workbook.Worksheets[0]
2203
+ #Initialize the integer Array
2204
+ int[] arrayInt = new int[4] {1000, 2000, 3000, 4000}
2205
+ #Insert the integer Array to Sheet
2206
+ worksheet.InsertArray(arrayInt, 1, 1, true)
2207
+ #Save to file
2208
+ workbook.SaveToFile(InsertArray.xlsx")
2209
+
2153
2210
  """
2154
2211
  #arrayintArray:ArrayTypeintArray = ""
2155
2212
  countintArray = len(intArray)
@@ -2228,27 +2285,25 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2228
2285
 
2229
2286
  def InsertArray(self ,stringArray:List[str],firstRow:int,firstColumn:int,isVertical:bool)->int:
2230
2287
  """
2231
- <summary>
2232
- Imports an array of strings into a worksheet.
2233
- <example>The following code illustrates how to Imports an array of String into a worksheet with specified row and column:
2234
- <code>
2235
- //Create worksheet
2236
- Workbook workbook = new Workbook();
2237
- Worksheet worksheet = workbook.Worksheets[0];
2238
- //Initialize the string Array
2239
- string[] arrayString = new string[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" };
2240
- //Insert the string Array to Sheet
2241
- worksheet.InsertArray(arrayString, 1, 1, true);
2242
- //Save to file
2243
- workbook.SaveToFile(InsertArray.xlsx");
2244
- </code>
2245
- </example>
2246
- </summary>
2247
- <param name="stringArray">String array.</param>
2248
- <param name="firstRow">The row number of the first cell to import in.</param>
2249
- <param name="firstColumn">The column number of the first cell to import in.</param>
2250
- <param name="isVertical">Specifies to import data vertically or horizontally.</param>
2251
- <returns></returns>
2288
+ Imports an array of strings into a worksheet.
2289
+
2290
+ Args:
2291
+ stringArray: String array.
2292
+ firstRow: The row number of the first cell to import in.
2293
+ firstColumn: The column number of the first cell to import in.
2294
+ isVertical: Specifies to import data vertically or horizontally.
2295
+ Example::
2296
+
2297
+ #Create worksheet
2298
+ workbook = Workbook()
2299
+ worksheet = workbook.Worksheets[0]
2300
+ #Initialize the string Array
2301
+ string[] arrayString = new string[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" }
2302
+ #Insert the string Array to Sheet
2303
+ worksheet.InsertArray(arrayString, 1, 1, true)
2304
+ #Save to file
2305
+ workbook.SaveToFile(InsertArray.xlsx")
2306
+
2252
2307
  """
2253
2308
  #arraystringArray:ArrayTypestringArray = ""
2254
2309
  countstringArray = len(stringArray)
@@ -2267,27 +2322,28 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2267
2322
 
2268
2323
  def InsertArray(self ,arrObject:List[SpireObject],firstRow:int,firstColumn:int,isVertical:bool)->int:
2269
2324
  """
2270
- <summary>
2271
- Imports an array of objects into a worksheet.
2272
- <example>The following code illustrates how to Imports an array of Object into a worksheet with specified alignment:
2273
- <code>
2274
- //Create worksheet
2275
- Workbook workbook = new Workbook();
2276
- Worksheet worksheet = workbook.Worksheets[0];
2277
- //Initialize the Object Array
2278
- object[] array = new object[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" };
2279
- //Insert the Object Array to Sheet
2280
- worksheet.InsertArray(array, 1, 1, true);
2281
- //Save to file
2282
- workbook.SaveToFile(InsertArray.xlsx");
2283
- </code>
2284
- </example>
2285
- </summary>
2286
- <param name="arrObject">Array to import.</param>
2287
- <param name="firstRow">The row number of the first cell to import in.</param>
2288
- <param name="firstColumn">The column number of the first cell to import in.</param>
2289
- <param name="isVertical">TRUE if array should be imported vertically; FALSE - horizontally.</param>
2290
- <returns>Number of imported elements.</returns>
2325
+ Imports an array of objects into a worksheet.
2326
+
2327
+ Args:
2328
+ arrObject: Array to import.
2329
+ firstRow: The row number of the first cell to import in.
2330
+ firstColumn: The column number of the first cell to import in.
2331
+ isVertical: TRUE if array should be imported vertically; FALSE - horizontally.
2332
+
2333
+ Returns:
2334
+ Number of imported elements.
2335
+ Example::
2336
+
2337
+ #Create worksheet
2338
+ workbook = Workbook()
2339
+ worksheet = workbook.Worksheets[0]
2340
+ #Initialize the Object Array
2341
+ object[] array = new object[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" }
2342
+ #Insert the Object Array to Sheet
2343
+ worksheet.InsertArray(array, 1, 1, true)
2344
+ #Save to file
2345
+ workbook.SaveToFile(InsertArray.xlsx")
2346
+
2291
2347
  """
2292
2348
  #arrayarrObject:ArrayTypearrObject = ""
2293
2349
  countarrObject = len(arrObject)
@@ -2797,11 +2853,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2797
2853
 
2798
2854
  def IsColumnVisible(self ,columnIndex:int)->bool:
2799
2855
  """
2800
- <summary>
2801
2856
  Indicates whether column is visible.
2802
- </summary>
2803
- <param name="columnIndex">Column index.</param>
2804
- <returns>true - visible, otherwise false.</returns>
2857
+
2858
+ Args:
2859
+ columnIndex: Column index.
2860
+
2861
+ Returns:
2862
+ true - visible, otherwise false.
2863
+
2805
2864
  """
2806
2865
 
2807
2866
  GetDllLibXls().XlsWorksheet_IsColumnVisible.argtypes=[c_void_p ,c_int]
@@ -2812,12 +2871,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2812
2871
 
2813
2872
  def IsExternalFormula(self ,row:int,column:int)->bool:
2814
2873
  """
2815
- <summary>
2816
2874
  Indicates is formula in cell is formula to external workbook.
2817
- </summary>
2818
- <param name="row">Represents row index.</param>
2819
- <param name="column">Represents column index.</param>
2820
- <returns>If contain extern formula returns true; otherwise false.</returns>
2875
+
2876
+ Args:
2877
+ row: Represents row index.
2878
+ column: Represents column index.
2879
+
2880
+ Returns:
2881
+ If contain extern formula returns true; otherwise false.
2882
+
2821
2883
  """
2822
2884
 
2823
2885
  GetDllLibXls().XlsWorksheet_IsExternalFormula.argtypes=[c_void_p ,c_int,c_int]
@@ -2828,11 +2890,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2828
2890
 
2829
2891
  def IsRowVisible(self ,rowIndex:int)->bool:
2830
2892
  """
2831
- <summary>
2832
2893
  Indicates whether row is visible.
2833
- </summary>
2834
- <param name="rowIndex">Row index.</param>
2835
- <returns>true - visible, otherwise false.</returns>
2894
+
2895
+ Args:
2896
+ rowIndex: Row index.
2897
+
2898
+ Returns:
2899
+ true - visible, otherwise false.
2900
+
2836
2901
  """
2837
2902
 
2838
2903
  GetDllLibXls().XlsWorksheet_IsRowVisible.argtypes=[c_void_p ,c_int]
@@ -2844,23 +2909,22 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2844
2909
 
2845
2910
  def AutoFitColumn(self ,columnIndex:int):
2846
2911
  """
2847
- <summary>
2848
- Autofit the column width.
2849
- <example>The following code illustrates how to Auto-fit the column:
2850
- <code>
2851
- //Create worksheet
2852
- Workbook workbook = new Workbook();
2853
- Worksheet worksheet = workbook.Worksheets[0];
2854
- //Set text
2855
- worksheet["A1"].Text = "Sample text in cell";
2856
- //Set auto fit
2857
- worksheet.AutoFitColumn(1);
2858
- //Save to file
2859
- workbook.SaveToFile("AutoFitColumn.xlsx");
2860
- </code>
2861
- </example>
2862
- </summary>
2863
- <param name="columnIndex">Column index.</param>
2912
+ Autofit the column width.
2913
+
2914
+ Args:
2915
+ columnIndex: Column index.
2916
+ Example::
2917
+
2918
+ #Create worksheet
2919
+ workbook = Workbook()
2920
+ worksheet = workbook.Worksheets[0]
2921
+ #Set text
2922
+ worksheet["A1"].Text = "Sample text in cell"
2923
+ #Set auto fit
2924
+ worksheet.AutoFitColumn(1)
2925
+ #Save to file
2926
+ workbook.SaveToFile("AutoFitColumn.xlsx")
2927
+
2864
2928
  """
2865
2929
 
2866
2930
  GetDllLibXls().XlsWorksheet_AutoFitColumn.argtypes=[c_void_p ,c_int]
@@ -2870,11 +2934,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2870
2934
 
2871
2935
  def AutoFitColumn(self ,columnIndex:int,options:AutoFitterOptions):
2872
2936
  """
2873
- <summary>
2874
2937
  Autofit the column width.
2875
- </summary>
2876
- <param name="columnIndex">Column index.</param>
2877
- <param name="options">auto fit options</param>
2938
+
2939
+ Args:
2940
+ columnIndex: Column index.
2941
+ options: auto fit options
2942
+
2878
2943
  """
2879
2944
  intPtroptions:c_void_p = options.Ptr
2880
2945
 
@@ -2885,12 +2950,13 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2885
2950
 
2886
2951
  def AutoFitColumn(self ,columnIndex:int,firstRow:int,lastRow:int):
2887
2952
  """
2888
- <summary>
2889
2953
  Autofit the column width.
2890
- </summary>
2891
- <param name="columnIndex">Column index.</param>
2892
- <param name="firstRow">One-based index of the first row to be used for autofit operation.</param>
2893
- <param name="lastRow">One-based index of the last row to be used for autofit operation.</param>
2954
+
2955
+ Args:
2956
+ columnIndex: Column index.
2957
+ firstRow: One-based index of the first row to be used for autofit operation.
2958
+ lastRow: One-based index of the last row to be used for autofit operation.
2959
+
2894
2960
  """
2895
2961
 
2896
2962
  GetDllLibXls().XlsWorksheet_AutoFitColumnCFL.argtypes=[c_void_p ,c_int,c_int,c_int]
@@ -2900,13 +2966,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2900
2966
 
2901
2967
  def AutoFitColumn(self ,columnIndex:int,firstRow:int,lastRow:int,options:AutoFitterOptions):
2902
2968
  """
2903
- <summary>
2904
2969
  Autofit the column width.
2905
- </summary>
2906
- <param name="columnIndex">Column index.</param>
2907
- <param name="firstRow">One-based index of the first row to be used for autofit operation.</param>
2908
- <param name="lastRow">One-based index of the last row to be used for autofit operation.</param>
2909
- <param name="options">auto fit options</param>
2970
+
2971
+ Args:
2972
+ columnIndex: Column index.
2973
+ firstRow: One-based index of the first row to be used for autofit operation.
2974
+ lastRow: One-based index of the last row to be used for autofit operation.
2975
+ options: auto fit options
2976
+
2910
2977
  """
2911
2978
  intPtroptions:c_void_p = options.Ptr
2912
2979
 
@@ -2917,28 +2984,27 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2917
2984
 
2918
2985
  def AutoFitRow(self ,rowIndex:int):
2919
2986
  """
2920
- <summary>
2921
- Autofit the row height.
2922
- <example>The following code illustrates how to Auto-fit the row:
2923
- <code>
2924
- //Create worksheet
2925
- Workbook workbook = new Workbook();
2926
- Worksheet worksheet = workbook.Worksheets[0];
2927
- //Set text
2928
- worksheet["C2"].Value = "Sample text";
2929
- //Set Style
2930
- CellStyle style = workbook.Styles.Add("CustomStyle");
2931
- IFont font = style.Font;
2932
- font.Size = 18;
2933
- worksheet["C2"].Style = style;
2934
- //Set auto fit
2935
- worksheet.AutoFitRow(2);
2936
- //Save to file
2937
- workbook.SaveToFile("AutoFitRow.xlsx");
2938
- </code>
2939
- </example>
2940
- </summary>
2941
- <param name="rowIndex">Row index</param>
2987
+ Autofit the row height.
2988
+
2989
+ Args:
2990
+ rowIndex: Row index
2991
+ Example::
2992
+
2993
+ #Create worksheet
2994
+ workbook = Workbook()
2995
+ worksheet = workbook.Worksheets[0]
2996
+ #Set text
2997
+ worksheet["C2"].Value = "Sample text"
2998
+ #Set Style
2999
+ style = workbook.Styles.Add("CustomStyle")
3000
+ font = style.Font
3001
+ font.Size = 18
3002
+ worksheet["C2"].Style = style
3003
+ #Set auto fit
3004
+ worksheet.AutoFitRow(2)
3005
+ #Save to file
3006
+ workbook.SaveToFile("AutoFitRow.xlsx")
3007
+
2942
3008
  """
2943
3009
 
2944
3010
  GetDllLibXls().XlsWorksheet_AutoFitRow.argtypes=[c_void_p ,c_int]
@@ -2948,13 +3014,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2948
3014
 
2949
3015
  def AutoFitRow(self ,rowIndex:int,firstColumn:int,lastColumn:int,options:AutoFitterOptions):
2950
3016
  """
2951
- <summary>
2952
3017
  Autofit the row height.
2953
- </summary>
2954
- <param name="rowIndex">Row index</param>
2955
- <param name="firstColumn">One-based index of the first column to be used for autofit operation.</param>
2956
- <param name="lastColumn">One-based index of the last column to be used for autofit operation.</param>
2957
- <param name="options">auto fit options</param>
3018
+
3019
+ Args:
3020
+ rowIndex: Row index
3021
+ firstColumn: One-based index of the first column to be used for autofit operation.
3022
+ lastColumn: One-based index of the last column to be used for autofit operation.
3023
+ options: auto fit options
3024
+
2958
3025
  """
2959
3026
  intPtroptions:c_void_p = options.Ptr
2960
3027
 
@@ -2965,13 +3032,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2965
3032
 
2966
3033
  def AutoFitRow(self ,rowIndex:int,firstColumn:int,lastColumn:int,bRaiseEvents:bool):
2967
3034
  """
2968
- <summary>
2969
3035
  Autofit the row height.
2970
- </summary>
2971
- <param name="rowIndex">Row index</param>
2972
- <param name="firstColumn">One-based index of the first column to be used for autofit operation.</param>
2973
- <param name="lastColumn">One-based index of the last column to be used for autofit operation.</param>
2974
- <param name="bRaiseEvents">If true then raise events.</param>
3036
+
3037
+ Args:
3038
+ rowIndex: Row index
3039
+ firstColumn: One-based index of the first column to be used for autofit operation.
3040
+ lastColumn: One-based index of the last column to be used for autofit operation.
3041
+ bRaiseEvents: If true then raise events.
3042
+
2975
3043
  """
2976
3044
 
2977
3045
  GetDllLibXls().XlsWorksheet_AutoFitRowRFLB.argtypes=[c_void_p ,c_int,c_int,c_int,c_bool]
@@ -2981,14 +3049,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2981
3049
 
2982
3050
  def AutoFitRow(self ,rowIndex:int,firstColumn:int,lastColumn:int,bRaiseEvents:bool,options:AutoFitterOptions):
2983
3051
  """
2984
- <summary>
2985
3052
  Autofit the row height.
2986
- </summary>
2987
- <param name="rowIndex">Row index</param>
2988
- <param name="firstColumn">One-based index of the first column to be used for autofit operation.</param>
2989
- <param name="lastColumn">One-based index of the last column to be used for autofit operation.</param>
2990
- <param name="bRaiseEvents">If true then raise events.</param>
2991
- <param name="options">auto fit options</param>
3053
+
3054
+ Args:
3055
+ rowIndex: Row index
3056
+ firstColumn: One-based index of the first column to be used for autofit operation.
3057
+ lastColumn: One-based index of the last column to be used for autofit operation.
3058
+ bRaiseEvents: If true then raise events.
3059
+ options: auto fit options
3060
+
2992
3061
  """
2993
3062
  intPtroptions:c_void_p = options.Ptr
2994
3063
 
@@ -2998,25 +3067,26 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
2998
3067
 
2999
3068
  def CheckExistence(self ,row:int,column:int)->bool:
3000
3069
  """
3001
- <summary>
3002
- Indicates whether cell has been initialized.
3003
- <example>The following code illustrates if the cells was initialized or accessed by the user:
3004
- <code>
3005
- //Create worksheet
3006
- Workbook workbook = new Workbook();
3007
- Worksheet worksheet = workbook.Worksheets[0];
3008
- //Set text
3009
- worksheet.Range["A1"].Text = "Hello";
3010
- //Check the cell.Output will be true.
3011
- Console.Write(worksheet.CheckExistence(1, 1));
3012
- //Save to file
3013
- workbook.SaveToFile("CheckExistence.xlsx");
3014
- </code>
3015
- </example>
3016
- </summary>
3017
- <param name="row">Row index.</param>
3018
- <param name="column">Column index.</param>
3019
- <returns>Value indicating whether the cell was initialized or accessed by the user.</returns>
3070
+ Indicates whether cell has been initialized.
3071
+
3072
+ Args:
3073
+ row: Row index.
3074
+ column: Column index.
3075
+
3076
+ Returns:
3077
+ Value indicating whether the cell was initialized or accessed by the user.
3078
+ Example::
3079
+
3080
+ #Create worksheet
3081
+ workbook = Workbook()
3082
+ worksheet = workbook.Worksheets[0]
3083
+ #Set text
3084
+ worksheet.Range["A1"].Text = "Hello"
3085
+ #Check the cell.Output will be true.
3086
+ Console.Write(worksheet.CheckExistence(1, 1))
3087
+ #Save to file
3088
+ workbook.SaveToFile("CheckExistence.xlsx")
3089
+
3020
3090
  """
3021
3091
 
3022
3092
  GetDllLibXls().XlsWorksheet_CheckExistence.argtypes=[c_void_p ,c_int,c_int]
@@ -3026,18 +3096,16 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3026
3096
 
3027
3097
  def Clear(self):
3028
3098
  """
3029
- <summary>
3030
3099
  Clears data the worksheet.
3031
- </summary>
3100
+
3032
3101
  """
3033
3102
  GetDllLibXls().XlsWorksheet_Clear.argtypes=[c_void_p]
3034
3103
  CallCFunction(GetDllLibXls().XlsWorksheet_Clear, self.Ptr)
3035
3104
 
3036
3105
  def ClearData(self):
3037
3106
  """
3038
- <summary>
3039
- Clears contents of a range.
3040
- </summary>
3107
+ Clears contents of a range.
3108
+
3041
3109
  """
3042
3110
  GetDllLibXls().XlsWorksheet_ClearData.argtypes=[c_void_p]
3043
3111
  CallCFunction(GetDllLibXls().XlsWorksheet_ClearData, self.Ptr)
@@ -3074,13 +3142,16 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3074
3142
 
3075
3143
  def GetCellType(self ,row:int,column:int,bNeedFormulaSubType:bool)->'TRangeValueType':
3076
3144
  """
3077
- <summary>
3078
3145
  Gets cell type from current column.
3079
- </summary>
3080
- <param name="row">Indicates row.</param>
3081
- <param name="column">Indicates column.</param>
3082
- <param name="bNeedFormulaSubType">Indicates is need to indified formula sub type.</param>
3083
- <returns>Returns cell type.</returns>
3146
+
3147
+ Args:
3148
+ row: Indicates row.
3149
+ column: Indicates column.
3150
+ bNeedFormulaSubType: Indicates is need to indified formula sub type.
3151
+
3152
+ Returns:
3153
+ Returns cell type.
3154
+
3084
3155
  """
3085
3156
 
3086
3157
  GetDllLibXls().XlsWorksheet_GetCellType.argtypes=[c_void_p ,c_int,c_int,c_bool]
@@ -3109,11 +3180,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3109
3180
 
3110
3181
  def GetStringValue(self ,cellIndex:int)->str:
3111
3182
  """
3112
- <summary>
3113
3183
  Returns string value corresponding to the cell.
3114
- </summary>
3115
- <param name="iCellIndex">Cell index to get value from.</param>
3116
- <returns>String contained by the cell.</returns>
3184
+
3185
+ Args:
3186
+ iCellIndex: Cell index to get value from.
3187
+
3188
+ Returns:
3189
+ String contained by the cell.
3190
+
3117
3191
  """
3118
3192
 
3119
3193
  GetDllLibXls().XlsWorksheet_GetStringValue.argtypes=[c_void_p ,c_long]
@@ -3126,12 +3200,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3126
3200
 
3127
3201
  def GetStringValue(self ,row:int,column:int)->str:
3128
3202
  """
3129
- <summary>
3130
3203
  Returns string value corresponding to the cell.
3131
- </summary>
3132
- <param name="row">Represents row index.</param>
3133
- <param name="column">Represents column index.</param>
3134
- <returns>String contained by the cell.</returns>
3204
+
3205
+ Args:
3206
+ row: Represents row index.
3207
+ column: Represents column index.
3208
+
3209
+ Returns:
3210
+ String contained by the cell.
3211
+
3135
3212
  """
3136
3213
 
3137
3214
  GetDllLibXls().XlsWorksheet_GetStringValueRC.argtypes=[c_void_p ,c_int,c_int]
@@ -3144,11 +3221,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3144
3221
 
3145
3222
  def GetTextObject(self ,cellIndex:int)->SpireObject:
3146
3223
  """
3147
- <summary>
3148
3224
  Returns TextWithFormat object corresponding to the specified cell.
3149
- </summary>
3150
- <param name="cellIndex">Cell index.</param>
3151
- <returns>Object corresponding to the specified cell.</returns>
3225
+
3226
+ Args:
3227
+ cellIndex: Cell index.
3228
+
3229
+ Returns:
3230
+ Object corresponding to the specified cell.
3231
+
3152
3232
  """
3153
3233
 
3154
3234
  GetDllLibXls().XlsWorksheet_GetTextObject.argtypes=[c_void_p ,c_long]
@@ -3162,12 +3242,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3162
3242
 
3163
3243
  def GetTextObject(self ,row:int,column:int)->SpireObject:
3164
3244
  """
3165
- <summary>
3166
3245
  Returns TextWithFormat object corresponding to the specified cell.
3167
- </summary>
3168
- <param name="row">Represents row index.</param>
3169
- <param name="column">Represents column index.</param>
3170
- <returns>Object corresponding to the specified cell.</returns>
3246
+
3247
+ Args:
3248
+ row: Represents row index.
3249
+ column: Represents column index.
3250
+
3251
+ Returns:
3252
+ Object corresponding to the specified cell.
3253
+
3171
3254
  """
3172
3255
 
3173
3256
  GetDllLibXls().XlsWorksheet_GetTextObjectRC.argtypes=[c_void_p ,c_int,c_int]
@@ -3180,11 +3263,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3180
3263
 
3181
3264
  def HasArrayFormula(self ,cellIndex:int)->bool:
3182
3265
  """
3183
- <summary>
3184
3266
  Indicates whether cell contains array-entered formula.
3185
- </summary>
3186
- <param name="cellIndex">cell index.</param>
3187
- <returns></returns>
3267
+
3268
+ Args:
3269
+ cellIndex: cell index.
3270
+
3188
3271
  """
3189
3272
 
3190
3273
  GetDllLibXls().XlsWorksheet_HasArrayFormula.argtypes=[c_void_p ,c_long]
@@ -3195,12 +3278,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3195
3278
 
3196
3279
  def HasArrayFormulaRecord(self ,row:int,column:int)->bool:
3197
3280
  """
3198
- <summary>
3199
3281
  Indicates is has array formula.
3200
- </summary>
3201
- <param name="row">Represents row index.</param>
3202
- <param name="column">Represents column index.</param>
3203
- <returns>Indicates is contain array formula record.</returns>
3282
+
3283
+ Args:
3284
+ row: Represents row index.
3285
+ column: Represents column index.
3286
+
3287
+ Returns:
3288
+ Indicates is contain array formula record.
3289
+
3204
3290
  """
3205
3291
 
3206
3292
  GetDllLibXls().XlsWorksheet_HasArrayFormulaRecord.argtypes=[c_void_p ,c_int,c_int]
@@ -3211,16 +3297,19 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3211
3297
 
3212
3298
  def InsertRange(self ,rowIndex:int,columnIndex:int,rowCount:int,columnCount:int,moveOptions:'InsertMoveOption',insertOptions:'InsertOptionsType')->'IXLSRange':
3213
3299
  """
3214
- <summary>
3215
3300
  Insert a cell range into worksheet
3216
- </summary>
3217
- <param name="rowIndex">the cell range first row index</param>
3218
- <param name="columnIndex">the cell range first column index</param>
3219
- <param name="rowCount">the number of rows</param>
3220
- <param name="columnCount">the number of columns</param>
3221
- <param name="moveOptions">Insert options.</param>
3222
- <param name="insertOptions">Move the cell on the right to right or Move the cell below down</param>
3223
- <returns>return the range that insert into worksheet</returns>
3301
+
3302
+ Args:
3303
+ rowIndex: the cell range first row index
3304
+ columnIndex: the cell range first column index
3305
+ rowCount: the number of rows
3306
+ columnCount: the number of columns
3307
+ moveOptions: Insert options.
3308
+ insertOptions: Move the cell on the right to right or Move the cell below down
3309
+
3310
+ Returns:
3311
+ return the range that insert into worksheet
3312
+
3224
3313
  """
3225
3314
  enummoveOptions:c_int = moveOptions.value
3226
3315
  enuminsertOptions:c_int = insertOptions.value
@@ -3235,13 +3324,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3235
3324
 
3236
3325
  def InsertCutRange(self ,cutRange:'IXLSRange',rowIndex:int,colIndex:int,moveOptions:'InsertMoveOption'):
3237
3326
  """
3238
- <summary>
3239
3327
  Insert cut range into worksheet at specified position.
3240
- </summary>
3241
- <param name="cutRange">the cut range</param>
3242
- <param name="rowIndex">the dest range first row index</param>
3243
- <param name="colIndex">the dest range first column index</param>
3244
- <param name="moveOptions">insert options.</param>
3328
+
3329
+ Args:
3330
+ cutRange: the cut range
3331
+ rowIndex: the dest range first row index
3332
+ colIndex: the dest range first column index
3333
+ moveOptions: insert options.
3334
+
3245
3335
  """
3246
3336
  intPtrcutRange:c_void_p = cutRange.Ptr
3247
3337
  enummoveOptions:c_int = moveOptions.value
@@ -3265,12 +3355,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3265
3355
 
3266
3356
  def IsArrayFormula(self ,row:int,column:int)->bool:
3267
3357
  """
3268
- <summary>
3269
3358
  Indicates whether cell contains array-entered formula.
3270
- </summary>
3271
- <param name="row">Represents row index.</param>
3272
- <param name="column">Represents column index.</param>
3273
- <returns>True if cell contains array-entered formula.</returns>
3359
+
3360
+ Args:
3361
+ row: Represents row index.
3362
+ column: Represents column index.
3363
+
3364
+ Returns:
3365
+ True if cell contains array-entered formula.
3366
+
3274
3367
  """
3275
3368
 
3276
3369
  GetDllLibXls().XlsWorksheet_IsArrayFormulaRC.argtypes=[c_void_p ,c_int,c_int]
@@ -3326,10 +3419,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3326
3419
 
3327
3420
  def DeleteColumn(self ,index:int):
3328
3421
  """
3329
- <summary>
3330
3422
  Deletes a column.
3331
- </summary>
3332
- <param name="columnIndex">Column index to remove..</param>
3423
+
3424
+ Args:
3425
+ columnIndex: Column index to remove..
3426
+
3333
3427
  """
3334
3428
 
3335
3429
  GetDllLibXls().XlsWorksheet_DeleteColumn.argtypes=[c_void_p ,c_int]
@@ -3339,11 +3433,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3339
3433
 
3340
3434
  def DeleteColumn(self ,index:int,count:int):
3341
3435
  """
3342
- <summary>
3343
3436
  Removes specified column.
3344
- </summary>
3345
- <param name="index">One-based column index to remove.</param>
3346
- <param name="count">Number of columns to remove.</param>
3437
+
3438
+ Args:
3439
+ index: One-based column index to remove.
3440
+ count: Number of columns to remove.
3441
+
3347
3442
  """
3348
3443
 
3349
3444
  GetDllLibXls().XlsWorksheet_DeleteColumnIC.argtypes=[c_void_p ,c_int,c_int]
@@ -3353,10 +3448,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3353
3448
 
3354
3449
  def DeleteRow(self ,index:int):
3355
3450
  """
3356
- <summary>
3357
3451
  Delete a row.
3358
- </summary>
3359
- <param name="index">Row index to remove</param>
3452
+
3453
+ Args:
3454
+ index: Row index to remove
3455
+
3360
3456
  """
3361
3457
 
3362
3458
  GetDllLibXls().XlsWorksheet_DeleteRow.argtypes=[c_void_p ,c_int]
@@ -3366,11 +3462,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3366
3462
 
3367
3463
  def DeleteRow(self ,index:int,count:int):
3368
3464
  """
3369
- <summary>
3370
3465
  Removes specified row.
3371
- </summary>
3372
- <param name="index">One-based row index to remove</param>
3373
- <param name="count">Number of rows to delete.</param>
3466
+
3467
+ Args:
3468
+ index: One-based row index to remove
3469
+ count: Number of rows to delete.
3470
+
3374
3471
  """
3375
3472
 
3376
3473
  GetDllLibXls().XlsWorksheet_DeleteRowIC.argtypes=[c_void_p ,c_int,c_int]
@@ -3380,10 +3477,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3380
3477
 
3381
3478
  def InsertColumn(self ,columnIndex:int):
3382
3479
  """
3383
- <summary>
3384
- Inserts a new column into the worksheet.
3385
- </summary>
3386
- <param name="columnIndex">Column index</param>
3480
+ Inserts a new column into the worksheet.
3481
+
3482
+ Args:
3483
+ columnIndex: Column index
3484
+
3387
3485
  """
3388
3486
 
3389
3487
  GetDllLibXls().XlsWorksheet_InsertColumn.argtypes=[c_void_p ,c_int]
@@ -3404,11 +3502,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3404
3502
 
3405
3503
  def InsertColumn(self ,columnIndex:int,columnCount:int):
3406
3504
  """
3407
- <summary>
3408
- Inserts specified number column into the worksheet.
3409
- </summary>
3410
- <param name="columnIndex">Column index</param>
3411
- <param name="columnCount">Number of columns to insert.</param>
3505
+ Inserts specified number column into the worksheet.
3506
+
3507
+ Args:
3508
+ columnIndex: Column index
3509
+ columnCount: Number of columns to insert.
3510
+
3412
3511
  """
3413
3512
 
3414
3513
  GetDllLibXls().XlsWorksheet_InsertColumnCC.argtypes=[c_void_p ,c_int,c_int]
@@ -3418,10 +3517,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3418
3517
 
3419
3518
  def InsertRow(self ,rowIndex:int):
3420
3519
  """
3421
- <summary>
3422
- Inserts a new row into the worksheet.
3423
- </summary>
3424
- <param name="rowIndex">Index at which new row should be inserted</param>
3520
+ Inserts a new row into the worksheet.
3521
+
3522
+ Args:
3523
+ rowIndex: Index at which new row should be inserted
3524
+
3425
3525
  """
3426
3526
 
3427
3527
  GetDllLibXls().XlsWorksheet_InsertRow.argtypes=[c_void_p ,c_int]
@@ -3455,11 +3555,12 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3455
3555
 
3456
3556
  def InsertRow(self ,rowIndex:int,rowCount:int):
3457
3557
  """
3458
- <summary>
3459
- Inserts multiple rows into the worksheet.
3460
- </summary>
3461
- <param name="rowIndex">Index at which new row should be inserted</param>
3462
- <param name="rowCount">Number of rows to be inserted. </param>
3558
+ Inserts multiple rows into the worksheet.
3559
+
3560
+ Args:
3561
+ rowIndex: Index at which new row should be inserted
3562
+ rowCount: Number of rows to be inserted.
3563
+
3463
3564
  """
3464
3565
 
3465
3566
  GetDllLibXls().XlsWorksheet_InsertRowRR.argtypes=[c_void_p ,c_int,c_int]
@@ -3468,12 +3569,15 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3468
3569
 
3469
3570
  def GetBoolean(self ,row:int,column:int)->bool:
3470
3571
  """
3471
- <summary>
3472
3572
  Gets bool value from cell.
3473
- </summary>
3474
- <param name="row">Represents row index.</param>
3475
- <param name="column">Represents column index.</param>
3476
- <returns>Returns found bool value. If cannot found returns false.</returns>
3573
+
3574
+ Args:
3575
+ row: Represents row index.
3576
+ column: Represents column index.
3577
+
3578
+ Returns:
3579
+ Returns found bool value. If cannot found returns false.
3580
+
3477
3581
  """
3478
3582
 
3479
3583
  GetDllLibXls().XlsWorksheet_GetBoolean.argtypes=[c_void_p ,c_int,c_int]
@@ -3484,11 +3588,14 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3484
3588
 
3485
3589
  def GetColumnWidth(self ,columnIndex:int)->float:
3486
3590
  """
3487
- <summary>
3488
- Gets the width of the specified column
3489
- </summary>
3490
- <param name="columnIndex">Column index</param>
3491
- <returns>Width of column</returns>
3591
+ Gets the width of the specified column
3592
+
3593
+ Args:
3594
+ columnIndex: Column index
3595
+
3596
+ Returns:
3597
+ Width of column
3598
+
3492
3599
  """
3493
3600
 
3494
3601
  GetDllLibXls().XlsWorksheet_GetColumnWidth.argtypes=[c_void_p ,c_int]
@@ -3499,26 +3606,27 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3499
3606
 
3500
3607
  def GetColumnWidthPixels(self ,columnIndex:int)->int:
3501
3608
  """
3502
- <summary>
3503
- Gets the width of the specified column, in units of pixel.
3504
- <example>The following code illustrates how to get the column width for a particular column:
3505
- <code>
3506
- //Create worksheet
3507
- Workbook workbook = new Workbook();
3508
- Worksheet worksheet = workbook.Worksheets[0];
3509
- //Set text
3510
- worksheet["A1"].Text = "Sample text in cell";
3511
- //Set auto fit
3512
- worksheet.AutoFitColumn(1);
3513
- //Get column width
3514
- Console.WriteLine(worksheet.GetColumnWidthPixels(1));
3515
- //Save to file
3516
- workbook.SaveToFile("UsedRange.xlsx");
3517
- </code>
3518
- </example>
3519
- </summary>
3520
- <param name="columnIndex">Column index.</param>
3521
- <returns>Width of column</returns>
3609
+ Gets the width of the specified column, in units of pixel.
3610
+
3611
+ Args:
3612
+ columnIndex: Column index.
3613
+
3614
+ Returns:
3615
+ Width of column
3616
+ Example::
3617
+
3618
+ #Create worksheet
3619
+ workbook = Workbook()
3620
+ worksheet = workbook.Worksheets[0]
3621
+ #Set text
3622
+ worksheet["A1"].Text = "Sample text in cell"
3623
+ #Set auto fit
3624
+ worksheet.AutoFitColumn(1)
3625
+ #Get column width
3626
+ print(worksheet.GetColumnWidthPixels(1))
3627
+ #Save to file
3628
+ workbook.SaveToFile("UsedRange.xlsx")
3629
+
3522
3630
  """
3523
3631
 
3524
3632
  GetDllLibXls().XlsWorksheet_GetColumnWidthPixels.argtypes=[c_void_p ,c_int]
@@ -3578,23 +3686,19 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3578
3686
 
3579
3687
  def OleObjects(self)->'IOleObjects':
3580
3688
  """
3581
- <summary>
3582
- Gets the OLE objects.
3583
- <example>The following code illustrates how to access the IListObjects collection in the worksheet to add a new IOleObject:
3584
- <code>
3585
- //Create worksheet
3586
- Workbook workbook = new Workbook();
3587
- Worksheet worksheet = workbook.Worksheets[0];
3588
- //Create image stream
3589
- System.Drawing.Image image = System.Drawing.Image.FromFile("image.png");
3590
- //Add ole object
3591
- IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed);
3592
- //Save to file
3593
- workbook.SaveToFile("OLEObjects.xlsx");
3594
- </code>
3595
- </example>
3596
- </summary>
3597
- <value>The OLE objects.</value>
3689
+ Gets the OLE objects.
3690
+ Example::
3691
+
3692
+ #Create worksheet
3693
+ workbook = Workbook()
3694
+ worksheet = workbook.Worksheets[0]
3695
+ #Create image stream
3696
+ System.Drawing.image = System.Drawing.Image.FromFile("image.png")
3697
+ #Add ole object
3698
+ oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed)
3699
+ #Save to file
3700
+ workbook.SaveToFile("OLEObjects.xlsx")
3701
+
3598
3702
  """
3599
3703
  GetDllLibXls().XlsWorksheet_get_OleObjects.argtypes=[c_void_p]
3600
3704
  GetDllLibXls().XlsWorksheet_get_OleObjects.restype=c_void_p
@@ -3619,8 +3723,10 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3619
3723
  @property
3620
3724
 
3621
3725
  def Cells(self)->ListXlsRanges:
3622
- """
3623
-
3726
+ """Gets a collection of all cells in the worksheet.
3727
+
3728
+ Returns:
3729
+ ListXlsRanges: A collection of XlsRange objects representing all cells in the worksheet.
3624
3730
  """
3625
3731
  GetDllLibXls().XlsWorksheet_get_Cells.argtypes=[c_void_p]
3626
3732
  GetDllLibXls().XlsWorksheet_get_Cells.restype=c_void_p
@@ -3646,10 +3752,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3646
3752
  @property
3647
3753
  def DisplayPageBreaks(self)->bool:
3648
3754
  """
3649
- <summary>
3650
- True if page breaks (both automatic and manual) on the specified
3651
- worksheet are displayed.
3652
- </summary>
3755
+ True if page breaks (both automatic and manual) on the specified worksheet are displayed.
3756
+
3653
3757
  """
3654
3758
  GetDllLibXls().XlsWorksheet_get_DisplayPageBreaks.argtypes=[c_void_p]
3655
3759
  GetDllLibXls().XlsWorksheet_get_DisplayPageBreaks.restype=c_bool
@@ -3678,9 +3782,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3678
3782
 
3679
3783
  def Names(self)->'INameRanges':
3680
3784
  """
3681
- <summary>
3682
3785
  Name range used by macros to access to workbook items.
3683
- </summary>
3786
+
3684
3787
  """
3685
3788
  GetDllLibXls().XlsWorksheet_get_Names.argtypes=[c_void_p]
3686
3789
  GetDllLibXls().XlsWorksheet_get_Names.restype=c_void_p
@@ -3746,8 +3849,10 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3746
3849
  @property
3747
3850
 
3748
3851
  def Rows(self)->ListXlsRanges:
3749
- """
3750
-
3852
+ """Gets a collection of all rows in the worksheet.
3853
+
3854
+ Returns:
3855
+ ListXlsRanges: A collection of XlsRange objects representing all rows in the worksheet.
3751
3856
  """
3752
3857
  GetDllLibXls().XlsWorksheet_get_Rows.argtypes=[c_void_p]
3753
3858
  GetDllLibXls().XlsWorksheet_get_Rows.restype=c_void_p
@@ -3759,8 +3864,10 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3759
3864
  @property
3760
3865
 
3761
3866
  def Columns(self)->ListXlsRanges:
3762
- """
3763
-
3867
+ """Gets a collection of all columns in the worksheet.
3868
+
3869
+ Returns:
3870
+ ListXlsRanges: A collection of XlsRange objects representing all columns in the worksheet.
3764
3871
  """
3765
3872
  GetDllLibXls().XlsWorksheet_get_Columns.argtypes=[c_void_p]
3766
3873
  GetDllLibXls().XlsWorksheet_get_Columns.restype=c_void_p
@@ -3773,9 +3880,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3773
3880
 
3774
3881
  def ConditionalFormats(self)->'IConditionalFormatsCollection':
3775
3882
  """
3776
- <summary>
3777
3883
  Returns collection with all conditional formats in the worksheet. Read-only.
3778
- </summary>
3884
+
3779
3885
  """
3780
3886
  GetDllLibXls().XlsWorksheet_get_ConditionalFormats.argtypes=[c_void_p]
3781
3887
  GetDllLibXls().XlsWorksheet_get_ConditionalFormats.restype=c_void_p
@@ -3787,23 +3893,19 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3787
3893
  @property
3788
3894
  def DefaultRowHeight(self)->float:
3789
3895
  """
3790
- <summary>
3791
- Gets or sets default height of all the rows in the worksheet,
3792
- in points.Read/write Double.
3793
- <example>The following code illustrates how to get the default row height:
3794
- <code>
3795
- //Create worksheet
3796
- Workbook workbook = new Workbook();
3797
- Worksheet worksheet = workbook.Worksheets[0];
3798
- //Get row height
3799
- Console.Write(worksheet.DefaultRowHeight);
3800
- //Set default height
3801
- worksheet.DefaultRowHeight = 40;
3802
- //Save to file
3803
- workbook.SaveToFile("DefaultRowHeight.xlsx");
3804
- </code>
3805
- </example>
3806
- </summary>
3896
+ Gets or sets default height of all the rows in the worksheet, in points.Read/write Double.
3897
+ Example::
3898
+
3899
+ #Create worksheet
3900
+ workbook = Workbook()
3901
+ worksheet = workbook.Worksheets[0]
3902
+ #Get row height
3903
+ Console.Write(worksheet.DefaultRowHeight)
3904
+ #Set default height
3905
+ worksheet.DefaultRowHeight = 40
3906
+ #Save to file
3907
+ workbook.SaveToFile("DefaultRowHeight.xlsx")
3908
+
3807
3909
  """
3808
3910
  GetDllLibXls().XlsWorksheet_get_DefaultRowHeight.argtypes=[c_void_p]
3809
3911
  GetDllLibXls().XlsWorksheet_get_DefaultRowHeight.restype=c_double
@@ -3818,9 +3920,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3818
3920
  @property
3819
3921
  def DefaultPrintRowHeight(self)->int:
3820
3922
  """
3821
- <summary>
3822
3923
  Return default row height.
3823
- </summary>
3924
+
3824
3925
  """
3825
3926
  GetDllLibXls().XlsWorksheet_get_DefaultPrintRowHeight.argtypes=[c_void_p]
3826
3927
  GetDllLibXls().XlsWorksheet_get_DefaultPrintRowHeight.restype=c_int
@@ -3836,10 +3937,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3836
3937
 
3837
3938
  def ViewMode(self)->'ViewMode':
3838
3939
  """
3839
- <summary>
3840
3940
  Gets or sets the view mode of the sheet.
3841
- </summary>
3842
- <value></value>
3941
+
3843
3942
  """
3844
3943
  GetDllLibXls().XlsWorksheet_get_ViewMode.argtypes=[c_void_p]
3845
3944
  GetDllLibXls().XlsWorksheet_get_ViewMode.restype=c_int
@@ -3855,22 +3954,19 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3855
3954
  @property
3856
3955
  def DefaultColumnWidth(self)->float:
3857
3956
  """
3858
- <summary>
3859
- Returns or sets the default width of all the columns in the worksheet. Read/write Double.
3860
- <example>The following code illustrates how to get the default column width:
3861
- <code>
3862
- //Create worksheet
3863
- Workbook workbook = new Workbook();
3864
- Worksheet worksheet = workbook.Worksheets[0];
3865
- //Get column width
3866
- Console.Write(worksheet.DefaultColumnWidth);
3867
- //Set default width
3868
- worksheet.DefaultColumnWidth = 40;
3869
- //Save to file
3870
- workbook.SaveToFile("DefaultColumnWidth.xlsx");
3871
- </code>
3872
- </example>
3873
- </summary>
3957
+ Returns or sets the default width of all the columns in the worksheet. Read/write Double.
3958
+ Example::
3959
+
3960
+ #Create worksheet
3961
+ workbook = Workbook()
3962
+ worksheet = workbook.Worksheets[0]
3963
+ #Get column width
3964
+ Console.Write(worksheet.DefaultColumnWidth)
3965
+ #Set default width
3966
+ worksheet.DefaultColumnWidth = 40
3967
+ #Save to file
3968
+ workbook.SaveToFile("DefaultColumnWidth.xlsx")
3969
+
3874
3970
  """
3875
3971
  GetDllLibXls().XlsWorksheet_get_DefaultColumnWidth.argtypes=[c_void_p]
3876
3972
  GetDllLibXls().XlsWorksheet_get_DefaultColumnWidth.restype=c_double
@@ -3885,21 +3981,17 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3885
3981
  @property
3886
3982
  def Zoom(self)->int:
3887
3983
  """
3888
- <summary>
3889
- Zoom factor of document.
3890
- <example>The following code illustrates how to set zoom level of the sheet:
3891
- <code>
3892
- //Create worksheet
3893
- Workbook workbook = new Workbook();
3894
- Worksheet worksheet = workbook.Worksheets[0];
3895
- //Set zoom
3896
- worksheet.Zoom = 200;
3897
- //Save to file
3898
- workbook.SaveToFile("Zoom.xlsx");
3899
- </code>
3900
- </example>
3901
- </summary>
3902
- <remarks> Value of zoom should be between 10 and 400.</remarks>
3984
+ Zoom factor of document.
3985
+ Example::
3986
+
3987
+ #Create worksheet
3988
+ workbook = Workbook()
3989
+ worksheet = workbook.Worksheets[0]
3990
+ #Set zoom
3991
+ worksheet.Zoom = 200
3992
+ #Save to file
3993
+ workbook.SaveToFile("Zoom.xlsx")
3994
+
3903
3995
  """
3904
3996
  GetDllLibXls().XlsWorksheet_get_Zoom.argtypes=[c_void_p]
3905
3997
  GetDllLibXls().XlsWorksheet_get_Zoom.restype=c_int
@@ -3914,10 +4006,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3914
4006
  @property
3915
4007
  def ZoomScaleNormal(self)->int:
3916
4008
  """
3917
- <summary>
3918
4009
  Gets or sets the zoom scale of normal view of the sheet.
3919
- </summary>
3920
- <value></value>
4010
+
3921
4011
  """
3922
4012
  GetDllLibXls().XlsWorksheet_get_ZoomScaleNormal.argtypes=[c_void_p]
3923
4013
  GetDllLibXls().XlsWorksheet_get_ZoomScaleNormal.restype=c_int
@@ -3932,10 +4022,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3932
4022
  @property
3933
4023
  def ZoomScalePageBreakView(self)->int:
3934
4024
  """
3935
- <summary>
3936
4025
  Gets or sets the zoom scale of page break preview of the sheet.
3937
- </summary>
3938
- <value></value>
4026
+
3939
4027
  """
3940
4028
  GetDllLibXls().XlsWorksheet_get_ZoomScalePageBreakView.argtypes=[c_void_p]
3941
4029
  GetDllLibXls().XlsWorksheet_get_ZoomScalePageBreakView.restype=c_int
@@ -3950,10 +4038,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3950
4038
  @property
3951
4039
  def ZoomScalePageLayoutView(self)->int:
3952
4040
  """
3953
- <summary>
3954
4041
  Gets or sets the zoom scale of page layout view of the sheet.
3955
- </summary>
3956
- <value></value>
4042
+
3957
4043
  """
3958
4044
  GetDllLibXls().XlsWorksheet_get_ZoomScalePageLayoutView.argtypes=[c_void_p]
3959
4045
  GetDllLibXls().XlsWorksheet_get_ZoomScalePageLayoutView.restype=c_int
@@ -3979,9 +4065,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
3979
4065
 
3980
4066
  def Version(self)->'ExcelVersion':
3981
4067
  """
3982
- <summary>
3983
4068
  Gets or sets excel file version.
3984
- </summary>
4069
+
3985
4070
  """
3986
4071
  GetDllLibXls().XlsWorksheet_get_Version.argtypes=[c_void_p]
3987
4072
  GetDllLibXls().XlsWorksheet_get_Version.restype=c_int
@@ -4010,10 +4095,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4010
4095
  @property
4011
4096
  def StandardHeightFlag(self)->bool:
4012
4097
  """
4013
- <summary>
4014
- Gets or sets the standard (default) height option flag, which defines that
4015
- standard (default) row height and book default font height do not match. Bool.
4016
- </summary>
4098
+ Gets or sets the standard (default) height option flag, which defines that standard (default) row height and book default font height do not match. Bool.
4099
+
4017
4100
  """
4018
4101
  GetDllLibXls().XlsWorksheet_get_StandardHeightFlag.argtypes=[c_void_p]
4019
4102
  GetDllLibXls().XlsWorksheet_get_StandardHeightFlag.restype=c_bool
@@ -4040,8 +4123,10 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4040
4123
  @property
4041
4124
 
4042
4125
  def Range(self)->'XlsRange':
4043
- """
4044
-
4126
+ """Gets the range object representing the entire worksheet.
4127
+
4128
+ Returns:
4129
+ XlsRange: A range object representing the entire worksheet.
4045
4130
  """
4046
4131
  GetDllLibXls().XlsWorksheet_get_Range.argtypes=[c_void_p]
4047
4132
  GetDllLibXls().XlsWorksheet_get_Range.restype=c_void_p
@@ -4096,10 +4181,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4096
4181
 
4097
4182
  def TopLeftCell(self)->'CellRange':
4098
4183
  """
4099
- <summary>
4100
4184
  Gets top left cell of the worksheet.
4101
- </summary>
4102
- <returns></returns>
4185
+
4103
4186
  """
4104
4187
  GetDllLibXls().XlsWorksheet_get_TopLeftCell.argtypes=[c_void_p]
4105
4188
  GetDllLibXls().XlsWorksheet_get_TopLeftCell.restype=c_void_p
@@ -4116,9 +4199,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4116
4199
  @property
4117
4200
  def UseRangesCache(self)->bool:
4118
4201
  """
4119
- <summary>
4120
4202
  Indicates whether all created range objects should be cached. Default value is true.
4121
- </summary>
4203
+
4122
4204
  """
4123
4205
  GetDllLibXls().XlsWorksheet_get_UseRangesCache.argtypes=[c_void_p]
4124
4206
  GetDllLibXls().XlsWorksheet_get_UseRangesCache.restype=c_bool
@@ -4161,9 +4243,8 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4161
4243
  @property
4162
4244
  def ActivePane(self)->int:
4163
4245
  """
4164
- <summary>
4165
4246
  Gets or sets index of the active pane.
4166
- </summary>
4247
+
4167
4248
  """
4168
4249
  GetDllLibXls().XlsWorksheet_get_ActivePane.argtypes=[c_void_p]
4169
4250
  GetDllLibXls().XlsWorksheet_get_ActivePane.restype=c_int
@@ -4187,10 +4268,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4187
4268
 
4188
4269
  def SetLastColumn(self ,columnIndex:int):
4189
4270
  """
4190
- <summary>
4191
4271
  Updates last column index.
4192
- </summary>
4193
- <param name="columnIndex">Column index.</param>
4272
+
4273
+ Args:
4274
+ columnIndex: Column index.
4275
+
4194
4276
  """
4195
4277
 
4196
4278
  GetDllLibXls().XlsWorksheet_SetLastColumn.argtypes=[c_void_p ,c_int]
@@ -4199,10 +4281,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4199
4281
 
4200
4282
  def SetFirstRow(self ,rowIndex:int):
4201
4283
  """
4202
- <summary>
4203
4284
  Updates first row index.
4204
- </summary>
4205
- <param name="rowIndex">Row index.</param>
4285
+
4286
+ Args:
4287
+ rowIndex: Row index.
4288
+
4206
4289
  """
4207
4290
 
4208
4291
  GetDllLibXls().XlsWorksheet_SetFirstRow.argtypes=[c_void_p ,c_int]
@@ -4211,10 +4294,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4211
4294
 
4212
4295
  def SetLastRow(self ,rowIndex:int):
4213
4296
  """
4214
- <summary>
4215
4297
  Updates last row index.
4216
- </summary>
4217
- <param name="rowIndex">Row index.</param>
4298
+
4299
+ Args:
4300
+ rowIndex: Row index.
4301
+
4218
4302
  """
4219
4303
 
4220
4304
  GetDllLibXls().XlsWorksheet_SetLastRow.argtypes=[c_void_p ,c_int]
@@ -4223,10 +4307,11 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4223
4307
 
4224
4308
  def ShowColumn(self ,columnIndex:int):
4225
4309
  """
4226
- <summary>
4227
4310
  Shows a column.
4228
- </summary>
4229
- <param name="columnIndex">Column index.</param>
4311
+
4312
+ Args:
4313
+ columnIndex: Column index.
4314
+
4230
4315
  """
4231
4316
 
4232
4317
  GetDllLibXls().XlsWorksheet_ShowColumn.argtypes=[c_void_p ,c_int]
@@ -4324,21 +4409,17 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4324
4409
  @property
4325
4410
  def GridLinesVisible(self)->bool:
4326
4411
  """
4327
- <summary>
4328
- True if gridlines are visible;
4329
- False otherwise.
4330
- <example>The following code illustrates how to set visibility for grid lines:
4331
- <code>
4332
- //Create worksheet
4333
- Workbook workbook = new Workbook();
4334
- Worksheet worksheet = workbook.Worksheets[0];
4335
- //Set grid line visibility
4336
- worksheet.GridLinesVisible = false;
4337
- //Save to file
4338
- workbook.SaveToFile("GridLinesVisible.xlsx");
4339
- </code>
4340
- </example>
4341
- </summary>
4412
+ True if gridlines are visible; False otherwise.
4413
+ Example::
4414
+
4415
+ #Create worksheet
4416
+ workbook = Workbook()
4417
+ worksheet = workbook.Worksheets[0]
4418
+ #Set grid line visibility
4419
+ worksheet.GridLinesVisible = false
4420
+ #Save to file
4421
+ workbook.SaveToFile("GridLinesVisible.xlsx")
4422
+
4342
4423
  """
4343
4424
  GetDllLibXls().XlsWorksheet_get_GridLinesVisible.argtypes=[c_void_p]
4344
4425
  GetDllLibXls().XlsWorksheet_get_GridLinesVisible.restype=c_bool
@@ -4350,3 +4431,5 @@ class XlsWorksheet ( XlsWorksheetBase, IInternalWorksheet) :
4350
4431
  GetDllLibXls().XlsWorksheet_set_GridLinesVisible.argtypes=[c_void_p, c_bool]
4351
4432
  CallCFunction(GetDllLibXls().XlsWorksheet_set_GridLinesVisible, self.Ptr, value)
4352
4433
 
4434
+
4435
+