spire-xls 15.5.0__py3-none-win_amd64.whl → 15.11.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 (1043) hide show
  1. spire/xls/AddtionalFormatWrapper.py +116 -132
  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 +315 -277
  6. spire/xls/CellStyle.py +26 -12
  7. spire/xls/CellStyleFlag.py +187 -57
  8. spire/xls/CellStyleObject.py +55 -79
  9. spire/xls/CellValueChangedEventArgs.py +3 -9
  10. spire/xls/ColorScale.py +31 -39
  11. spire/xls/CommentsRange.py +185 -95
  12. spire/xls/CommonWrapper.py +23 -8
  13. spire/xls/ConverterSetting.py +34 -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 +87 -39
  18. spire/xls/Excel2016Charttype.py +14 -2
  19. spire/xls/ExcelComment.py +1 -2
  20. spire/xls/ExcelCommentObject.py +212 -122
  21. spire/xls/ExcelFont.py +94 -73
  22. spire/xls/ExcelGradient.py +70 -24
  23. spire/xls/ExcelInterior.py +43 -27
  24. spire/xls/ExportTableOptions.py +38 -9
  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 +165 -112
  29. spire/xls/FontArrayWrapper.py +135 -36
  30. spire/xls/FontWrapper.py +207 -103
  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 +75 -25
  38. spire/xls/GradientType.py +10 -2
  39. spire/xls/GroupShape.py +1 -2
  40. spire/xls/HPageBreak.py +2 -2
  41. spire/xls/HTMLOptions.py +7 -19
  42. spire/xls/HyperLink.py +2 -2
  43. spire/xls/LOGFONT.py +78 -30
  44. spire/xls/MsoTextFrame.py +102 -0
  45. spire/xls/OColor.py +62 -29
  46. spire/xls/OdsPageBackground.py +5 -10
  47. spire/xls/PageColRow.py +21 -10
  48. spire/xls/PageSetup.py +2 -3
  49. spire/xls/PaperSizeEntry.py +6 -0
  50. spire/xls/PicStretch.py +47 -14
  51. spire/xls/PicTile.py +35 -10
  52. spire/xls/QueryTableXls.py +19 -6
  53. spire/xls/RTFCommentArray.py +59 -22
  54. spire/xls/RTFStringArray.py +59 -22
  55. spire/xls/RangeRichTextString.py +22 -10
  56. spire/xls/ReferRangeArea.py +33 -18
  57. spire/xls/RichText.py +11 -9
  58. spire/xls/RichTextObject.py +63 -32
  59. spire/xls/RichTextShape.py +90 -33
  60. spire/xls/RichTextString.py +62 -24
  61. spire/xls/RtfTextWriter.py +68 -22
  62. spire/xls/SaveShapeTypeOption.py +19 -37
  63. spire/xls/ShapeGlow.py +35 -15
  64. spire/xls/ShapeReflection.py +55 -18
  65. spire/xls/StyleArrayWrapper.py +169 -78
  66. spire/xls/TextBoxShapeBase.py +63 -30
  67. spire/xls/TextSaveOptions.py +39 -17
  68. spire/xls/TopBottom.py +18 -6
  69. spire/xls/VPageBreak.py +4 -5
  70. spire/xls/Validation.py +12 -6
  71. spire/xls/WebQueryConnection.py +52 -20
  72. spire/xls/Workbook.py +884 -916
  73. spire/xls/Worksheet.py +507 -421
  74. spire/xls/WriteProtection.py +3 -6
  75. spire/xls/XlsAddInFunction.py +36 -22
  76. spire/xls/XlsArcShape.py +157 -41
  77. spire/xls/XlsBitmapShape.py +141 -43
  78. spire/xls/XlsBorder.py +73 -31
  79. spire/xls/XlsBorderArrayWrapper.py +50 -14
  80. spire/xls/XlsButtonShape.py +59 -17
  81. spire/xls/XlsCheckBoxShape.py +72 -18
  82. spire/xls/XlsComboBoxShape.py +53 -16
  83. spire/xls/XlsComment.py +109 -31
  84. spire/xls/XlsDataValidationTable.py +46 -17
  85. spire/xls/XlsDocumentProperty.py +163 -44
  86. spire/xls/XlsEventArgs.py +33 -24
  87. spire/xls/XlsEventHandler.py +10 -4
  88. spire/xls/XlsFill.py +64 -20
  89. spire/xls/XlsFont.py +202 -66
  90. spire/xls/XlsGradient.py +90 -26
  91. spire/xls/XlsGradientStop.py +57 -12
  92. spire/xls/XlsGroupBoxShape.py +36 -10
  93. spire/xls/XlsHPageBreak.py +47 -24
  94. spire/xls/XlsHyperLink.py +111 -42
  95. spire/xls/XlsLabelShape.py +27 -8
  96. spire/xls/XlsLineShape.py +188 -48
  97. spire/xls/XlsListBoxShape.py +63 -14
  98. spire/xls/XlsName.py +779 -331
  99. spire/xls/XlsObject.py +2 -4
  100. spire/xls/XlsOvalShape.py +79 -21
  101. spire/xls/XlsPageSetup.py +71 -32
  102. spire/xls/XlsPageSetupBase.py +29 -58
  103. spire/xls/XlsPrstGeomShape.py +29 -10
  104. spire/xls/XlsRadioButtonShape.py +84 -42
  105. spire/xls/XlsRange.py +907 -1087
  106. spire/xls/XlsRectangleShape.py +70 -23
  107. spire/xls/XlsScrollBarShape.py +78 -18
  108. spire/xls/XlsShape.py +396 -183
  109. spire/xls/XlsShapeFill.py +401 -92
  110. spire/xls/XlsShapeLineFormat.py +201 -44
  111. spire/xls/XlsSpinnerShape.py +57 -14
  112. spire/xls/XlsStyle.py +54 -23
  113. spire/xls/XlsTextBoxShape.py +263 -60
  114. spire/xls/XlsVPageBreak.py +9 -14
  115. spire/xls/XlsValidation.py +325 -72
  116. spire/xls/XlsValidationWrapper.py +217 -49
  117. spire/xls/XlsWorkbook.py +573 -88
  118. spire/xls/XlsWorksheet.py +1312 -1232
  119. spire/xls/XlsWorksheetBase.py +279 -185
  120. spire/xls/__init__.py +531 -529
  121. spire/xls/autofilter/AutoFitterOptions.py +91 -0
  122. spire/xls/autofilter/ColorFilter.py +61 -0
  123. spire/xls/autofilter/CustomFilter.py +207 -0
  124. spire/xls/autofilter/CustomFilterCollection.py +146 -0
  125. spire/xls/autofilter/DateTimeGroupItem.py +196 -0
  126. spire/xls/autofilter/DynamicFilter.py +89 -0
  127. spire/xls/autofilter/FilterColumn.py +289 -0
  128. spire/xls/autofilter/MultipleFilterCollection.py +218 -0
  129. spire/xls/autofilter/Top10Filter.py +109 -0
  130. spire/xls/autofilter/XlsAutoFiltersCollection.py +146 -0
  131. spire/xls/charts/Chart.py +369 -0
  132. spire/xls/charts/ChartArea.py +58 -0
  133. spire/xls/charts/ChartBackgroundMode.py +17 -0
  134. spire/xls/charts/ChartCategoryAxis.py +88 -0
  135. spire/xls/charts/ChartDataLabels.py +40 -0
  136. spire/xls/charts/ChartDataPoint.py +40 -0
  137. spire/xls/charts/ChartFormat.py +68 -0
  138. spire/xls/charts/ChartGridLine.py +26 -0
  139. spire/xls/charts/ChartLegend.py +40 -0
  140. spire/xls/charts/ChartLegendEntriesColl.py +165 -0
  141. spire/xls/charts/ChartLegendEntry.py +26 -0
  142. spire/xls/charts/ChartPlotArea.py +60 -0
  143. spire/xls/charts/ChartSerie.py +147 -0
  144. spire/xls/charts/ChartSerieDataFormat.py +54 -0
  145. spire/xls/charts/ChartSeriesAxis.py +68 -0
  146. spire/xls/charts/ChartShadow.py +288 -0
  147. spire/xls/charts/ChartSheet.py +269 -0
  148. spire/xls/charts/ChartTextArea.py +898 -0
  149. spire/xls/charts/ChartValueAxis.py +90 -0
  150. spire/xls/charts/HistogramAxisFormat.py +32 -0
  151. spire/xls/charts/XlsChart.py +1667 -0
  152. spire/xls/charts/XlsChartAxis.py +596 -0
  153. spire/xls/charts/XlsChartBorder.py +180 -0
  154. spire/xls/charts/XlsChartCategoryAxis.py +640 -0
  155. spire/xls/charts/XlsChartDataLabelArea.py +368 -0
  156. spire/xls/charts/XlsChartDataLabels.py +702 -0
  157. spire/xls/charts/XlsChartDataPoint.py +105 -0
  158. spire/xls/charts/XlsChartDataTable.py +373 -0
  159. spire/xls/charts/XlsChartDropBar.py +295 -0
  160. spire/xls/charts/XlsChartFill.py +659 -0
  161. spire/xls/charts/XlsChartFormat.py +1229 -0
  162. spire/xls/charts/XlsChartFrameFormat.py +613 -0
  163. spire/xls/charts/XlsChartGridLine.py +167 -0
  164. spire/xls/charts/XlsChartInterior.py +229 -0
  165. spire/xls/charts/XlsChartLegend.py +334 -0
  166. spire/xls/charts/XlsChartLegendArea.py +418 -0
  167. spire/xls/charts/XlsChartLegendEntry.py +152 -0
  168. spire/xls/charts/XlsChartSerie.py +607 -0
  169. spire/xls/charts/XlsChartSerieDataFormat.py +1070 -0
  170. spire/xls/charts/XlsChartSeriesAxis.py +306 -0
  171. spire/xls/charts/XlsChartShape.py +1256 -0
  172. spire/xls/charts/XlsChartTitleArea.py +399 -0
  173. spire/xls/charts/XlsChartValueAxis.py +344 -0
  174. spire/xls/charts/XlsChartWallOrFloor.py +349 -0
  175. spire/xls/charts/__init__.py +0 -0
  176. spire/xls/collection/AddInFunctionsCollection.py +31 -0
  177. spire/xls/collection/ArcShapeCollection.py +94 -0
  178. spire/xls/collection/AutoFiltersCollection.py +539 -0
  179. spire/xls/collection/BordersCollection.py +196 -0
  180. spire/xls/collection/BordersCollectionArrayWrapper.py +129 -0
  181. spire/xls/collection/BuiltInDocumentProperties.py +12 -0
  182. spire/xls/collection/ButtonShapeCollection.py +70 -0
  183. spire/xls/collection/ChartDataPointsCollection.py +72 -0
  184. spire/xls/collection/ChartFormatCollection.py +58 -0
  185. spire/xls/collection/ChartSeries.py +187 -0
  186. spire/xls/collection/ChartsCollection.py +119 -0
  187. spire/xls/collection/CollectionBase.py +201 -0
  188. spire/xls/collection/CollectionExtended.py +96 -0
  189. spire/xls/collection/ComboBoxCollection.py +89 -0
  190. spire/xls/collection/CommentsCollection.py +134 -0
  191. spire/xls/collection/DataConnections.py +25 -0
  192. spire/xls/collection/ExternalLinkCollection.py +26 -0
  193. spire/xls/collection/GroupBoxCollection.py +70 -0
  194. spire/xls/collection/GroupShapeCollection.py +45 -0
  195. spire/xls/collection/HPageBreaksCollection.py +116 -0
  196. spire/xls/collection/HyperLinksCollection.py +72 -0
  197. spire/xls/collection/ListObjectCollection.py +48 -0
  198. spire/xls/collection/OvalShapeCollection.py +89 -0
  199. spire/xls/collection/PicturesCollection.py +574 -0
  200. spire/xls/collection/PrstGeomShapeCollection.py +128 -0
  201. spire/xls/collection/QueryTableCollection.py +25 -0
  202. spire/xls/collection/RadioButtonCollection.py +139 -0
  203. spire/xls/collection/RangesCollection.py +556 -0
  204. spire/xls/collection/ShapeCollectionBase.py +87 -0
  205. spire/xls/collection/StylesCollection.py +140 -0
  206. spire/xls/collection/VPageBreaksCollection.py +95 -0
  207. spire/xls/collection/WorksheetsCollection.py +363 -0
  208. spire/xls/collection/XlsAddInFunctionsCollection.py +108 -0
  209. spire/xls/collection/XlsBordersCollection.py +98 -0
  210. spire/xls/collection/XlsBuiltInDocumentProperties.py +611 -0
  211. spire/xls/collection/XlsChartDataPointsCollection.py +119 -0
  212. spire/xls/collection/XlsChartFormatCollection.py +160 -0
  213. spire/xls/collection/XlsChartsCollection.py +91 -0
  214. spire/xls/collection/XlsCommentsCollection.py +116 -0
  215. spire/xls/collection/XlsDataValidationCollection.py +157 -0
  216. spire/xls/collection/XlsFontsCollection.py +52 -0
  217. spire/xls/collection/XlsHPageBreaksCollection.py +87 -0
  218. spire/xls/collection/XlsHyperLinksCollection.py +104 -0
  219. spire/xls/collection/XlsRangesCollection.py +1641 -0
  220. spire/xls/collection/XlsStylesCollection.py +74 -0
  221. spire/xls/collection/XlsVPageBreaksCollection.py +81 -0
  222. spire/xls/collection/XlsWorkbookObjectsCollection.py +95 -0
  223. spire/xls/collection/XlsWorksheetsCollection.py +423 -0
  224. spire/xls/collection/__init__.py +0 -0
  225. spire/xls/collection/pivot_table/PivotConditionalFormatCollection.py +38 -0
  226. spire/xls/collection/pivot_table/PivotTableFields.py +108 -0
  227. spire/xls/collection/pivot_table/XlsPivotCachesCollection.py +124 -0
  228. spire/xls/collection/pivot_table/XlsPivotTablesCollection.py +132 -0
  229. spire/xls/collection/pivot_table/__init__.py +0 -0
  230. spire/xls/conditional_formatting/ColorConditionValue.py +102 -0
  231. spire/xls/conditional_formatting/CondFormatCollectionWrapper.py +153 -0
  232. spire/xls/conditional_formatting/ConditionValue.py +83 -0
  233. spire/xls/conditional_formatting/ConditionValuePosition.py +16 -0
  234. spire/xls/conditional_formatting/ConditionalFormat.py +13 -0
  235. spire/xls/conditional_formatting/ConditionalFormatScope.py +16 -0
  236. spire/xls/conditional_formatting/ConditionalFormatWrapper.py +1271 -0
  237. spire/xls/conditional_formatting/ConditionalFormats.py +65 -0
  238. spire/xls/conditional_formatting/DataBarBorder.py +51 -0
  239. spire/xls/conditional_formatting/NegativeBarFormat.py +90 -0
  240. spire/xls/conditional_formatting/XlsConditionValue.py +134 -0
  241. spire/xls/conditional_formatting/XlsConditionalFormat.py +1163 -0
  242. spire/xls/conditional_formatting/XlsConditionalFormats.py +684 -0
  243. spire/xls/conditional_formatting/__init__.py +0 -0
  244. spire/xls/enums/AlertStyleType.py +17 -0
  245. spire/xls/enums/AutoFormatOptions.py +22 -0
  246. spire/xls/enums/AutoFormatType.py +31 -0
  247. spire/xls/enums/AverageType.py +24 -0
  248. spire/xls/enums/AxisLineIdentifierType.py +18 -0
  249. spire/xls/enums/AxisTextDirectionType.py +17 -0
  250. spire/xls/enums/AxisType.py +17 -0
  251. spire/xls/enums/BaseFormatType.py +16 -0
  252. spire/xls/enums/BordersLineType.py +22 -0
  253. spire/xls/enums/BubbleSizeType.py +16 -0
  254. spire/xls/enums/BuiltInPropertyType.py +49 -0
  255. spire/xls/enums/BuiltInStyles.py +65 -0
  256. spire/xls/enums/CategoryType.py +17 -0
  257. spire/xls/enums/CellDataType.py +22 -0
  258. spire/xls/enums/CellFormatType.py +20 -0
  259. spire/xls/enums/ChartBaseUnitType.py +17 -0
  260. spire/xls/enums/ChartDisplayUnitType.py +25 -0
  261. spire/xls/enums/ChartLinePatternType.py +23 -0
  262. spire/xls/enums/ChartLineWeightType.py +18 -0
  263. spire/xls/enums/ChartMarkerType.py +26 -0
  264. spire/xls/enums/ChartParagraphType.py +17 -0
  265. spire/xls/enums/ChartPieType.py +17 -0
  266. spire/xls/enums/ChartPlotEmptyType.py +17 -0
  267. spire/xls/enums/CheckState.py +17 -0
  268. spire/xls/enums/ColorType.py +17 -0
  269. spire/xls/enums/CommentHAlignType.py +20 -0
  270. spire/xls/enums/CommentVAlignType.py +19 -0
  271. spire/xls/enums/ComparisonOperatorType.py +23 -0
  272. spire/xls/enums/ConditionalFormatType.py +32 -0
  273. spire/xls/enums/DataLabelPositionType.py +25 -0
  274. spire/xls/enums/DataSourceType.py +18 -0
  275. spire/xls/enums/DropLineStyleType.py +17 -0
  276. spire/xls/enums/ErrorBarIncludeType.py +18 -0
  277. spire/xls/enums/ErrorBarType.py +19 -0
  278. spire/xls/enums/ExcelCalculationMode.py +17 -0
  279. spire/xls/enums/ExcelChartType.py +95 -0
  280. spire/xls/enums/ExcelColors.py +120 -0
  281. spire/xls/enums/ExcelComboType.py +21 -0
  282. spire/xls/enums/ExcelHorizontalAlignment.py +20 -0
  283. spire/xls/enums/ExcelPatternType.py +51 -0
  284. spire/xls/enums/ExcelQuartileCalculation.py +16 -0
  285. spire/xls/enums/ExcelShapeType.py +40 -0
  286. spire/xls/enums/ExcelSheetType.py +19 -0
  287. spire/xls/enums/ExcelTreeMapLabelOption.py +17 -0
  288. spire/xls/enums/ExcelVersion.py +23 -0
  289. spire/xls/enums/ExcelVerticalAlignment.py +20 -0
  290. spire/xls/enums/ExpandCollapseFlags.py +17 -0
  291. spire/xls/enums/FilterConditionType.py +20 -0
  292. spire/xls/enums/FilterDataType.py +21 -0
  293. spire/xls/enums/FontUnderlineType.py +19 -0
  294. spire/xls/enums/FontVertialAlignmentType.py +17 -0
  295. spire/xls/enums/GradientColorType.py +17 -0
  296. spire/xls/enums/GradientPatternType.py +63 -0
  297. spire/xls/enums/GradientPresetType.py +38 -0
  298. spire/xls/enums/GradientStyleType.py +20 -0
  299. spire/xls/enums/GradientTextureType.py +39 -0
  300. spire/xls/enums/GradientVariantsType.py +18 -0
  301. spire/xls/enums/HorizontalAlignType.py +22 -0
  302. spire/xls/enums/HyperLinkType.py +19 -0
  303. spire/xls/enums/IgnoreErrorType.py +23 -0
  304. spire/xls/enums/ImageFormatType.py +17 -0
  305. spire/xls/enums/ImageType.py +16 -0
  306. spire/xls/enums/LegendPositionType.py +20 -0
  307. spire/xls/enums/LegendSpacingType.py +17 -0
  308. spire/xls/enums/LineStyleType.py +28 -0
  309. spire/xls/enums/OleObjectType.py +50 -0
  310. spire/xls/enums/OrderBy.py +18 -0
  311. spire/xls/enums/OrderType.py +16 -0
  312. spire/xls/enums/PageBreakExtentType.py +16 -0
  313. spire/xls/enums/PageBreakType.py +17 -0
  314. spire/xls/enums/PageOrientationType.py +16 -0
  315. spire/xls/enums/PagesOrderType.py +16 -0
  316. spire/xls/enums/PaperSizeType.py +134 -0
  317. spire/xls/enums/PivotGroupByTypes.py +22 -0
  318. spire/xls/enums/PrintCommentType.py +17 -0
  319. spire/xls/enums/PrintErrorsType.py +18 -0
  320. spire/xls/enums/ReadingOrderType.py +17 -0
  321. spire/xls/enums/RectangleStyleType.py +16 -0
  322. spire/xls/enums/ResizeBehaveType.py +17 -0
  323. spire/xls/enums/ShapeArrowLengthType.py +17 -0
  324. spire/xls/enums/ShapeArrowStyleType.py +20 -0
  325. spire/xls/enums/ShapeArrowWidthType.py +17 -0
  326. spire/xls/enums/ShapeDashLineStyleType.py +22 -0
  327. spire/xls/enums/ShapeFillType.py +21 -0
  328. spire/xls/enums/ShapeLayerChangeType.py +18 -0
  329. spire/xls/enums/ShapeLineStyleType.py +19 -0
  330. spire/xls/enums/SheetProtectionType.py +32 -0
  331. spire/xls/enums/SortComparsionType.py +18 -0
  332. spire/xls/enums/SortOrientationType.py +16 -0
  333. spire/xls/enums/SortedWayType.py +17 -0
  334. spire/xls/enums/SparklineType.py +17 -0
  335. spire/xls/enums/SplitType.py +18 -0
  336. spire/xls/enums/TextDirection.py +19 -0
  337. spire/xls/enums/TextRotationType.py +18 -0
  338. spire/xls/enums/ThemeColorType.py +26 -0
  339. spire/xls/enums/TickLabelPositionType.py +18 -0
  340. spire/xls/enums/TickMarkType.py +18 -0
  341. spire/xls/enums/TopBottomType.py +18 -0
  342. spire/xls/enums/TopFormatType.py +17 -0
  343. spire/xls/enums/TrendLineType.py +20 -0
  344. spire/xls/enums/UnknownVariableAction.py +17 -0
  345. spire/xls/enums/ValidationComparisonOperator.py +22 -0
  346. spire/xls/enums/VariableTypeAction.py +17 -0
  347. spire/xls/enums/VerticalAlignType.py +19 -0
  348. spire/xls/enums/ViewMode.py +17 -0
  349. spire/xls/enums/WorksheetVisibility.py +17 -0
  350. spire/xls/enums/XLSXBorderJoinType.py +18 -0
  351. spire/xls/enums/XLSXChartMaterialType.py +31 -0
  352. spire/xls/enums/XLSXChartPrespectiveType.py +20 -0
  353. spire/xls/enums/XLSXChartShadowInnerType.py +24 -0
  354. spire/xls/enums/XLSXChartShadowOuterType.py +24 -0
  355. spire/xls/enums/__init__.py +1 -0
  356. spire/xls/interfaces/IArcShape.py +285 -0
  357. spire/xls/interfaces/IChart.py +1597 -0
  358. spire/xls/interfaces/IChartAxis.py +786 -0
  359. spire/xls/interfaces/IChartBorder.py +203 -0
  360. spire/xls/interfaces/IChartCategoryAxis.py +522 -0
  361. spire/xls/interfaces/IChartDataLabels.py +419 -0
  362. spire/xls/interfaces/IChartDataPoint.py +114 -0
  363. spire/xls/interfaces/IChartDataTable.py +184 -0
  364. spire/xls/interfaces/IChartErrorBars.py +340 -0
  365. spire/xls/interfaces/IChartFillBorder.py +268 -0
  366. spire/xls/interfaces/IChartFormat.py +521 -0
  367. spire/xls/interfaces/IChartFrameFormat.py +85 -0
  368. spire/xls/interfaces/IChartGridLine.py +100 -0
  369. spire/xls/interfaces/IChartInterior.py +259 -0
  370. spire/xls/interfaces/IChartLegend.py +453 -0
  371. spire/xls/interfaces/IChartLegendEntry.py +167 -0
  372. spire/xls/interfaces/IChartPageSetup.py +51 -0
  373. spire/xls/interfaces/IChartSerie.py +727 -0
  374. spire/xls/interfaces/IChartSerieDataFormat.py +519 -0
  375. spire/xls/interfaces/IChartSeriesAxis.py +118 -0
  376. spire/xls/interfaces/IChartShape.py +88 -0
  377. spire/xls/interfaces/IChartTextArea.py +181 -0
  378. spire/xls/interfaces/IChartTrendLine.py +502 -0
  379. spire/xls/interfaces/IChartValueAxis.py +586 -0
  380. spire/xls/interfaces/IChartWallOrFloor.py +40 -0
  381. spire/xls/interfaces/ICheckBox.py +120 -0
  382. spire/xls/interfaces/ICloneParent.py +29 -0
  383. spire/xls/interfaces/IColorConditionValue.py +44 -0
  384. spire/xls/interfaces/IColorScale.py +39 -0
  385. spire/xls/interfaces/ICombinedRange.py +109 -0
  386. spire/xls/interfaces/IComboBoxShape.py +120 -0
  387. spire/xls/interfaces/IComment.py +110 -0
  388. spire/xls/interfaces/ICommentShape.py +20 -0
  389. spire/xls/interfaces/IConditionValue.py +83 -0
  390. spire/xls/interfaces/IConditionalFormat.py +757 -0
  391. spire/xls/interfaces/IConditionalFormats.py +66 -0
  392. spire/xls/interfaces/ICustomDocumentProperties.py +168 -0
  393. spire/xls/interfaces/IDataBar.py +127 -0
  394. spire/xls/interfaces/IDataValidation.py +506 -0
  395. spire/xls/interfaces/IDataValidationTable.py +84 -0
  396. spire/xls/interfaces/IDigitalSignature.py +111 -0
  397. spire/xls/interfaces/IDigitalSignatures.py +33 -0
  398. spire/xls/interfaces/IDocumentProperty.py +276 -0
  399. spire/xls/interfaces/IErrorIndicator.py +38 -0
  400. spire/xls/interfaces/IExtendIndex.py +26 -0
  401. spire/xls/interfaces/IExtendedFormat.py +631 -0
  402. spire/xls/interfaces/IFont.py +313 -0
  403. spire/xls/interfaces/IFormat3D.py +307 -0
  404. spire/xls/interfaces/IGeomPath.py +27 -0
  405. spire/xls/interfaces/IGeomPathInfo.py +141 -0
  406. spire/xls/interfaces/IGeomPathShape.py +40 -0
  407. spire/xls/interfaces/IGlow.py +104 -0
  408. spire/xls/interfaces/IGradient.py +203 -0
  409. spire/xls/interfaces/IGroupBox.py +82 -0
  410. spire/xls/interfaces/IHPageBreak.py +26 -0
  411. spire/xls/interfaces/IHyperLink.py +137 -0
  412. spire/xls/interfaces/IIconSet.py +115 -0
  413. spire/xls/interfaces/IInterior.py +137 -0
  414. spire/xls/interfaces/IInternalAddtionalFormat.py +277 -0
  415. spire/xls/interfaces/IInternalFont.py +38 -0
  416. spire/xls/interfaces/ILabelShape.py +60 -0
  417. spire/xls/interfaces/ILineShape.py +334 -0
  418. spire/xls/interfaces/IListObject.py +443 -0
  419. spire/xls/interfaces/IListObjectColumn.py +196 -0
  420. spire/xls/interfaces/IMarkersDesigner.py +133 -0
  421. spire/xls/interfaces/IMigrantRange.py +28 -0
  422. spire/xls/interfaces/INamedObject.py +27 -0
  423. spire/xls/interfaces/INamedRange.py +246 -0
  424. spire/xls/interfaces/INumberFormat.py +90 -0
  425. spire/xls/interfaces/IOleObject.py +225 -0
  426. spire/xls/interfaces/IOptimizedUpdate.py +35 -0
  427. spire/xls/interfaces/IOvalShape.py +201 -0
  428. spire/xls/interfaces/IPageSetup.py +260 -0
  429. spire/xls/interfaces/IPageSetupBase.py +849 -0
  430. spire/xls/interfaces/IPictureShape.py +118 -0
  431. spire/xls/interfaces/IPropertyData.py +100 -0
  432. spire/xls/interfaces/IPrstGeomShape.py +103 -0
  433. spire/xls/interfaces/IRadioButton.py +159 -0
  434. spire/xls/interfaces/IRectangleShape.py +90 -0
  435. spire/xls/interfaces/IReflectionEffect.py +217 -0
  436. spire/xls/interfaces/IScrollBarShape.py +139 -0
  437. spire/xls/interfaces/IShadow.py +385 -0
  438. spire/xls/interfaces/IShape.py +620 -0
  439. spire/xls/interfaces/IShapeFill.py +767 -0
  440. spire/xls/interfaces/IShapeLineFormat.py +488 -0
  441. spire/xls/interfaces/ISortColumn.py +138 -0
  442. spire/xls/interfaces/ISortColumns.py +106 -0
  443. spire/xls/interfaces/ISortedRule.py +154 -0
  444. spire/xls/interfaces/ISpinnerShape.py +124 -0
  445. spire/xls/interfaces/IStyle.py +60 -0
  446. spire/xls/interfaces/ITabSheet.py +364 -0
  447. spire/xls/interfaces/ITextBox.py +140 -0
  448. spire/xls/interfaces/ITextBoxLinkShape.py +48 -0
  449. spire/xls/interfaces/ITextBoxShape.py +27 -0
  450. spire/xls/interfaces/ITextFrame.py +146 -0
  451. spire/xls/interfaces/IVPageBreak.py +26 -0
  452. spire/xls/interfaces/IWorkbook.py +1736 -0
  453. spire/xls/interfaces/IWorksheet.py +2638 -0
  454. spire/xls/interfaces/IXLSRange.py +2241 -0
  455. spire/xls/interfaces/IXLSRanges.py +40 -0
  456. spire/xls/interfaces/IconSet.py +125 -0
  457. spire/xls/interfaces/ImageLocationTypes.py +17 -0
  458. spire/xls/interfaces/ImportObjectOptions.py +143 -0
  459. spire/xls/interfaces/InsertMoveOption.py +17 -0
  460. spire/xls/interfaces/InteriorArrayWrapper.py +181 -0
  461. spire/xls/interfaces/__init__.py +0 -0
  462. spire/xls/interfaces/collections/IDataValidationCollection.py +128 -0
  463. spire/xls/interfaces/collections/IHPageBreaks.py +37 -0
  464. spire/xls/interfaces/collections/IListObjects.py +34 -0
  465. spire/xls/interfaces/collections/IOleObjects.py +44 -0
  466. spire/xls/interfaces/collections/IPrstGeomShapes.py +87 -0
  467. spire/xls/interfaces/collections/IShapes.py +273 -0
  468. spire/xls/interfaces/collections/ITextBoxes.py +67 -0
  469. spire/xls/interfaces/collections/IVPageBreaks.py +37 -0
  470. spire/xls/interfaces/collections/__init__.py +0 -0
  471. spire/xls/interfaces/pivot_table/IPivotCache.py +50 -0
  472. spire/xls/interfaces/pivot_table/IPivotCaches.py +52 -0
  473. spire/xls/interfaces/pivot_table/IPivotCalculatedFields.py +69 -0
  474. spire/xls/interfaces/pivot_table/IPivotField.py +372 -0
  475. spire/xls/interfaces/pivot_table/IPivotTable.py +509 -0
  476. spire/xls/interfaces/pivot_table/IPivotTableOptions.py +507 -0
  477. spire/xls/interfaces/pivot_table/__init__.py +0 -0
  478. spire/xls/interfaces/sorting/__init__.py +0 -0
  479. spire/xls/lib/Spire.Xls.Base.dll +0 -0
  480. spire/xls/lib/_init_.py +0 -0
  481. spire/xls/license/LicenseProvider.py +107 -0
  482. spire/xls/license/__init__.py +0 -0
  483. spire/xls/pivot_tables/AutoSortScope.py +29 -0
  484. spire/xls/pivot_tables/PivotConditionalFormat.py +71 -0
  485. spire/xls/pivot_tables/PivotDataField.py +163 -0
  486. spire/xls/pivot_tables/PivotItem.py +228 -0
  487. spire/xls/pivot_tables/PivotReportFilter.py +199 -0
  488. spire/xls/pivot_tables/PivotReportFilters.py +95 -0
  489. spire/xls/pivot_tables/PivotStyle.py +105 -0
  490. spire/xls/pivot_tables/PivotTableStyle.py +83 -0
  491. spire/xls/pivot_tables/XlsPivotCache.py +506 -0
  492. spire/xls/pivot_tables/XlsPivotCacheField.py +276 -0
  493. spire/xls/pivot_tables/XlsPivotField.py +975 -0
  494. spire/xls/pivot_tables/XlsPivotTable.py +1189 -0
  495. spire/xls/pivot_tables/__init__.py +0 -0
  496. spire/xls/security/__init__.py +0 -0
  497. spire/xls/sorting/DataSorter.py +152 -0
  498. spire/xls/sorting/SortColumn.py +115 -0
  499. spire/xls/sorting/SortColumns.py +194 -0
  500. spire/xls/sorting/__init__.py +0 -0
  501. spire/xls/sparkline/ISparklines.py +72 -0
  502. spire/xls/sparkline/Sparkline.py +89 -0
  503. spire/xls/sparkline/SparklineCollection.py +107 -0
  504. spire/xls/sparkline/SparklineGroup.py +592 -0
  505. spire/xls/sparkline/SparklineGroupCollection.py +67 -0
  506. spire/xls/sparkline/__init__.py +0 -0
  507. spire/xls/template_markers/MarkerDesigner.py +171 -0
  508. spire/xls/template_markers/__init__.py +0 -0
  509. spire_xls-15.11.1.dist-info/METADATA +197 -0
  510. spire_xls-15.11.1.dist-info/RECORD +721 -0
  511. spire/xls/AddInFunctionsCollection.py +0 -29
  512. spire/xls/AlertStyleType.py +0 -18
  513. spire/xls/ArcShapeCollection.py +0 -70
  514. spire/xls/AutoFiltersCollection.py +0 -527
  515. spire/xls/AutoFitterOptions.py +0 -66
  516. spire/xls/AutoFormatOptions.py +0 -23
  517. spire/xls/AutoFormatType.py +0 -32
  518. spire/xls/AutoSortScope.py +0 -25
  519. spire/xls/AverageType.py +0 -25
  520. spire/xls/AxisLineIdentifierType.py +0 -19
  521. spire/xls/AxisTextDirectionType.py +0 -18
  522. spire/xls/AxisType.py +0 -18
  523. spire/xls/BaseFormatType.py +0 -17
  524. spire/xls/BordersCollection.py +0 -158
  525. spire/xls/BordersCollectionArrayWrapper.py +0 -95
  526. spire/xls/BordersLineType.py +0 -23
  527. spire/xls/BubbleSizeType.py +0 -17
  528. spire/xls/BuiltInDocumentProperties.py +0 -12
  529. spire/xls/BuiltInPropertyType.py +0 -50
  530. spire/xls/BuiltInStyles.py +0 -66
  531. spire/xls/ButtonShapeCollection.py +0 -70
  532. spire/xls/CategoryType.py +0 -18
  533. spire/xls/CellDataType.py +0 -23
  534. spire/xls/CellFormatType.py +0 -21
  535. spire/xls/Chart.py +0 -404
  536. spire/xls/ChartArea.py +0 -61
  537. spire/xls/ChartBackgroundMode.py +0 -18
  538. spire/xls/ChartBaseUnitType.py +0 -18
  539. spire/xls/ChartCategoryAxis.py +0 -93
  540. spire/xls/ChartDataLabels.py +0 -42
  541. spire/xls/ChartDataPoint.py +0 -42
  542. spire/xls/ChartDataPointsCollection.py +0 -75
  543. spire/xls/ChartDisplayUnitType.py +0 -26
  544. spire/xls/ChartFormat.py +0 -72
  545. spire/xls/ChartFormatCollection.py +0 -59
  546. spire/xls/ChartGridLine.py +0 -27
  547. spire/xls/ChartLegend.py +0 -42
  548. spire/xls/ChartLegendEntriesColl.py +0 -128
  549. spire/xls/ChartLegendEntry.py +0 -27
  550. spire/xls/ChartLinePatternType.py +0 -24
  551. spire/xls/ChartLineWeightType.py +0 -19
  552. spire/xls/ChartMarkerType.py +0 -27
  553. spire/xls/ChartParagraphType.py +0 -18
  554. spire/xls/ChartPieType.py +0 -18
  555. spire/xls/ChartPlotArea.py +0 -53
  556. spire/xls/ChartPlotEmptyType.py +0 -18
  557. spire/xls/ChartSerie.py +0 -142
  558. spire/xls/ChartSerieDataFormat.py +0 -56
  559. spire/xls/ChartSeries.py +0 -154
  560. spire/xls/ChartSeriesAxis.py +0 -72
  561. spire/xls/ChartShadow.py +0 -235
  562. spire/xls/ChartSheet.py +0 -285
  563. spire/xls/ChartTextArea.py +0 -782
  564. spire/xls/ChartValueAxis.py +0 -92
  565. spire/xls/ChartsCollection.py +0 -113
  566. spire/xls/CheckState.py +0 -18
  567. spire/xls/CollectionBase.py +0 -184
  568. spire/xls/CollectionExtended.py +0 -92
  569. spire/xls/ColorConditionValue.py +0 -91
  570. spire/xls/ColorFilter.py +0 -45
  571. spire/xls/ColorType.py +0 -18
  572. spire/xls/ComboBoxCollection.py +0 -70
  573. spire/xls/CommentHAlignType.py +0 -21
  574. spire/xls/CommentVAlignType.py +0 -20
  575. spire/xls/CommentsCollection.py +0 -109
  576. spire/xls/ComparisonOperatorType.py +0 -24
  577. spire/xls/CondFormatCollectionWrapper.py +0 -125
  578. spire/xls/ConditionValue.py +0 -82
  579. spire/xls/ConditionValuePosition.py +0 -16
  580. spire/xls/ConditionalFormat.py +0 -14
  581. spire/xls/ConditionalFormatScope.py +0 -16
  582. spire/xls/ConditionalFormatType.py +0 -33
  583. spire/xls/ConditionalFormatWrapper.py +0 -986
  584. spire/xls/ConditionalFormats.py +0 -55
  585. spire/xls/CustomFilter.py +0 -147
  586. spire/xls/CustomFilterCollection.py +0 -113
  587. spire/xls/DataBarBorder.py +0 -47
  588. spire/xls/DataConnections.py +0 -25
  589. spire/xls/DataLabelPositionType.py +0 -26
  590. spire/xls/DataSorter.py +0 -154
  591. spire/xls/DataSourceType.py +0 -19
  592. spire/xls/DateTimeGroupItem.py +0 -132
  593. spire/xls/DropLineStyleType.py +0 -18
  594. spire/xls/DynamicFilter.py +0 -71
  595. spire/xls/ErrorBarIncludeType.py +0 -19
  596. spire/xls/ErrorBarType.py +0 -20
  597. spire/xls/ExcelCalculationMode.py +0 -18
  598. spire/xls/ExcelChartType.py +0 -96
  599. spire/xls/ExcelColors.py +0 -121
  600. spire/xls/ExcelComboType.py +0 -22
  601. spire/xls/ExcelHorizontalAlignment.py +0 -21
  602. spire/xls/ExcelPatternType.py +0 -52
  603. spire/xls/ExcelQuartileCalculation.py +0 -17
  604. spire/xls/ExcelShapeType.py +0 -41
  605. spire/xls/ExcelSheetType.py +0 -20
  606. spire/xls/ExcelTreeMapLabelOption.py +0 -18
  607. spire/xls/ExcelVersion.py +0 -24
  608. spire/xls/ExcelVerticalAlignment.py +0 -21
  609. spire/xls/ExpandCollapseFlags.py +0 -18
  610. spire/xls/ExternalLinkCollection.py +0 -25
  611. spire/xls/FilterColumn.py +0 -258
  612. spire/xls/FilterConditionType.py +0 -21
  613. spire/xls/FilterDataType.py +0 -22
  614. spire/xls/FontUnderlineType.py +0 -20
  615. spire/xls/FontVertialAlignmentType.py +0 -20
  616. spire/xls/GradientColorType.py +0 -18
  617. spire/xls/GradientPatternType.py +0 -64
  618. spire/xls/GradientPresetType.py +0 -39
  619. spire/xls/GradientStyleType.py +0 -21
  620. spire/xls/GradientTextureType.py +0 -40
  621. spire/xls/GradientVariantsType.py +0 -19
  622. spire/xls/GroupBoxCollection.py +0 -70
  623. spire/xls/GroupShapeCollection.py +0 -46
  624. spire/xls/HPageBreaksCollection.py +0 -108
  625. spire/xls/HistogramAxisFormat.py +0 -30
  626. spire/xls/HorizontalAlignType.py +0 -23
  627. spire/xls/HyperLinkType.py +0 -20
  628. spire/xls/HyperLinksCollection.py +0 -72
  629. spire/xls/IArcShape.py +0 -259
  630. spire/xls/IChart.py +0 -1368
  631. spire/xls/IChartAxis.py +0 -722
  632. spire/xls/IChartBorder.py +0 -220
  633. spire/xls/IChartCategoryAxis.py +0 -410
  634. spire/xls/IChartDataLabels.py +0 -457
  635. spire/xls/IChartDataPoint.py +0 -131
  636. spire/xls/IChartDataTable.py +0 -197
  637. spire/xls/IChartErrorBars.py +0 -373
  638. spire/xls/IChartFillBorder.py +0 -303
  639. spire/xls/IChartFormat.py +0 -571
  640. spire/xls/IChartFrameFormat.py +0 -93
  641. spire/xls/IChartGridLine.py +0 -107
  642. spire/xls/IChartInterior.py +0 -278
  643. spire/xls/IChartLegend.py +0 -499
  644. spire/xls/IChartLegendEntry.py +0 -178
  645. spire/xls/IChartPageSetup.py +0 -56
  646. spire/xls/IChartSerie.py +0 -779
  647. spire/xls/IChartSerieDataFormat.py +0 -566
  648. spire/xls/IChartSeriesAxis.py +0 -128
  649. spire/xls/IChartShape.py +0 -92
  650. spire/xls/IChartTextArea.py +0 -197
  651. spire/xls/IChartTrendLine.py +0 -548
  652. spire/xls/IChartValueAxis.py +0 -518
  653. spire/xls/IChartWallOrFloor.py +0 -32
  654. spire/xls/ICheckBox.py +0 -96
  655. spire/xls/ICloneParent.py +0 -28
  656. spire/xls/IColorConditionValue.py +0 -31
  657. spire/xls/IColorScale.py +0 -32
  658. spire/xls/ICombinedRange.py +0 -87
  659. spire/xls/IComboBoxShape.py +0 -95
  660. spire/xls/IComment.py +0 -85
  661. spire/xls/ICommentShape.py +0 -12
  662. spire/xls/IConditionValue.py +0 -68
  663. spire/xls/IConditionalFormat.py +0 -606
  664. spire/xls/IConditionalFormats.py +0 -48
  665. spire/xls/ICustomDocumentProperties.py +0 -128
  666. spire/xls/IDataBar.py +0 -105
  667. spire/xls/IDataValidation.py +0 -421
  668. spire/xls/IDataValidationCollection.py +0 -132
  669. spire/xls/IDataValidationTable.py +0 -68
  670. spire/xls/IDigitalSignature.py +0 -99
  671. spire/xls/IDigitalSignatures.py +0 -29
  672. spire/xls/IDocumentProperty.py +0 -226
  673. spire/xls/IErrorIndicator.py +0 -31
  674. spire/xls/IExtendIndex.py +0 -21
  675. spire/xls/IExtendedFormat.py +0 -530
  676. spire/xls/IFont.py +0 -271
  677. spire/xls/IFormat3D.py +0 -252
  678. spire/xls/IGeomPath.py +0 -23
  679. spire/xls/IGeomPathInfo.py +0 -112
  680. spire/xls/IGeomPathShape.py +0 -30
  681. spire/xls/IGlow.py +0 -85
  682. spire/xls/IGradient.py +0 -174
  683. spire/xls/IGroupBox.py +0 -67
  684. spire/xls/IHPageBreak.py +0 -22
  685. spire/xls/IHPageBreaks.py +0 -31
  686. spire/xls/IHyperLink.py +0 -118
  687. spire/xls/IIconSet.py +0 -96
  688. spire/xls/IInterior.py +0 -117
  689. spire/xls/IInternalAddtionalFormat.py +0 -238
  690. spire/xls/IInternalFont.py +0 -31
  691. spire/xls/ILabelShape.py +0 -49
  692. spire/xls/ILineShape.py +0 -305
  693. spire/xls/IListObject.py +0 -493
  694. spire/xls/IListObjectColumn.py +0 -222
  695. spire/xls/IListObjects.py +0 -31
  696. spire/xls/IMarkersDesigner.py +0 -113
  697. spire/xls/IMigrantRange.py +0 -21
  698. spire/xls/INamedObject.py +0 -22
  699. spire/xls/INamedRange.py +0 -162
  700. spire/xls/INumberFormat.py +0 -77
  701. spire/xls/IOleObject.py +0 -176
  702. spire/xls/IOleObjects.py +0 -32
  703. spire/xls/IOptimizedUpdate.py +0 -28
  704. spire/xls/IOvalShape.py +0 -154
  705. spire/xls/IPageSetup.py +0 -195
  706. spire/xls/IPageSetupBase.py +0 -642
  707. spire/xls/IPictureShape.py +0 -99
  708. spire/xls/IPivotCache.py +0 -41
  709. spire/xls/IPivotCaches.py +0 -39
  710. spire/xls/IPivotCalculatedFields.py +0 -50
  711. spire/xls/IPivotField.py +0 -291
  712. spire/xls/IPivotTable.py +0 -393
  713. spire/xls/IPivotTableOptions.py +0 -428
  714. spire/xls/IPropertyData.py +0 -70
  715. spire/xls/IPrstGeomShape.py +0 -71
  716. spire/xls/IPrstGeomShapes.py +0 -81
  717. spire/xls/IRadioButton.py +0 -105
  718. spire/xls/IRectangleShape.py +0 -60
  719. spire/xls/IReflectionEffect.py +0 -138
  720. spire/xls/IScrollBarShape.py +0 -140
  721. spire/xls/IShadow.py +0 -244
  722. spire/xls/IShape.py +0 -409
  723. spire/xls/IShapeFill.py +0 -522
  724. spire/xls/IShapeLineFormat.py +0 -331
  725. spire/xls/IShapes.py +0 -270
  726. spire/xls/ISortColumn.py +0 -96
  727. spire/xls/ISortColumns.py +0 -70
  728. spire/xls/ISortedRule.py +0 -112
  729. spire/xls/ISparklines.py +0 -72
  730. spire/xls/ISpinnerShape.py +0 -102
  731. spire/xls/IStyle.py +0 -50
  732. spire/xls/ITabSheet.py +0 -302
  733. spire/xls/ITextBox.py +0 -116
  734. spire/xls/ITextBoxLinkShape.py +0 -40
  735. spire/xls/ITextBoxShape.py +0 -22
  736. spire/xls/ITextBoxes.py +0 -61
  737. spire/xls/ITextFrame.py +0 -120
  738. spire/xls/IVPageBreak.py +0 -22
  739. spire/xls/IVPageBreaks.py +0 -31
  740. spire/xls/IWorkbook.py +0 -1806
  741. spire/xls/IWorksheet.py +0 -2694
  742. spire/xls/IXLSRange.py +0 -2479
  743. spire/xls/IXLSRanges.py +0 -35
  744. spire/xls/IconSet.py +0 -103
  745. spire/xls/IgnoreErrorType.py +0 -24
  746. spire/xls/ImageFormatType.py +0 -18
  747. spire/xls/ImageLocationTypes.py +0 -15
  748. spire/xls/ImageType.py +0 -17
  749. spire/xls/ImportObjectOptions.py +0 -89
  750. spire/xls/InsertMoveOption.py +0 -15
  751. spire/xls/InteriorArrayWrapper.py +0 -126
  752. spire/xls/LegendPositionType.py +0 -21
  753. spire/xls/LegendSpacingType.py +0 -18
  754. spire/xls/LineStyleType.py +0 -29
  755. spire/xls/ListObjectCollection.py +0 -45
  756. spire/xls/MarkerDesigner.py +0 -172
  757. spire/xls/MultipleFilterCollection.py +0 -166
  758. spire/xls/NegativeBarFormat.py +0 -82
  759. spire/xls/OleObjectType.py +0 -51
  760. spire/xls/OrderBy.py +0 -19
  761. spire/xls/OrderType.py +0 -17
  762. spire/xls/OvalShapeCollection.py +0 -70
  763. spire/xls/PageBreakExtentType.py +0 -17
  764. spire/xls/PageBreakType.py +0 -18
  765. spire/xls/PageOrientationType.py +0 -17
  766. spire/xls/PagesOrderType.py +0 -17
  767. spire/xls/PaperSizeType.py +0 -135
  768. spire/xls/PicturesCollection.py +0 -532
  769. spire/xls/PivotConditionalFormat.py +0 -54
  770. spire/xls/PivotConditionalFormatCollection.py +0 -38
  771. spire/xls/PivotDataField.py +0 -118
  772. spire/xls/PivotGroupByTypes.py +0 -23
  773. spire/xls/PivotItem.py +0 -161
  774. spire/xls/PivotReportFilter.py +0 -92
  775. spire/xls/PivotReportFilters.py +0 -63
  776. spire/xls/PivotStyle.py +0 -79
  777. spire/xls/PivotTableFields.py +0 -85
  778. spire/xls/PivotTableStyle.py +0 -63
  779. spire/xls/PrintCommentType.py +0 -18
  780. spire/xls/PrintErrorsType.py +0 -19
  781. spire/xls/PrstGeomShapeCollection.py +0 -126
  782. spire/xls/QueryTableCollection.py +0 -25
  783. spire/xls/RadioButtonCollection.py +0 -137
  784. spire/xls/RangesCollection.py +0 -537
  785. spire/xls/ReadingOrderType.py +0 -18
  786. spire/xls/RectangleStyleType.py +0 -17
  787. spire/xls/ResizeBehaveType.py +0 -18
  788. spire/xls/ShapeArrowLengthType.py +0 -18
  789. spire/xls/ShapeArrowStyleType.py +0 -21
  790. spire/xls/ShapeArrowWidthType.py +0 -18
  791. spire/xls/ShapeCollectionBase.py +0 -87
  792. spire/xls/ShapeDashLineStyleType.py +0 -23
  793. spire/xls/ShapeFillType.py +0 -22
  794. spire/xls/ShapeLayerChangeType.py +0 -19
  795. spire/xls/ShapeLineStyleType.py +0 -20
  796. spire/xls/SheetProtectionType.py +0 -33
  797. spire/xls/SortColumn.py +0 -120
  798. spire/xls/SortColumns.py +0 -185
  799. spire/xls/SortComparsionType.py +0 -19
  800. spire/xls/SortOrientationType.py +0 -17
  801. spire/xls/SortedWayType.py +0 -18
  802. spire/xls/Sparkline.py +0 -70
  803. spire/xls/SparklineCollection.py +0 -112
  804. spire/xls/SparklineGroup.py +0 -523
  805. spire/xls/SparklineGroupCollection.py +0 -71
  806. spire/xls/SparklineType.py +0 -18
  807. spire/xls/SplitType.py +0 -19
  808. spire/xls/StylesCollection.py +0 -141
  809. spire/xls/TextDirection.py +0 -20
  810. spire/xls/TextRotationType.py +0 -19
  811. spire/xls/ThemeColorType.py +0 -27
  812. spire/xls/TickLabelPositionType.py +0 -19
  813. spire/xls/TickMarkType.py +0 -19
  814. spire/xls/Top10Filter.py +0 -75
  815. spire/xls/TopBottomType.py +0 -19
  816. spire/xls/TopFormatType.py +0 -18
  817. spire/xls/TrendLineType.py +0 -21
  818. spire/xls/UnknownVariableAction.py +0 -18
  819. spire/xls/VPageBreaksCollection.py +0 -96
  820. spire/xls/ValidationComparisonOperator.py +0 -23
  821. spire/xls/VariableTypeAction.py +0 -19
  822. spire/xls/VerticalAlignType.py +0 -20
  823. spire/xls/ViewMode.py +0 -18
  824. spire/xls/WorksheetVisibility.py +0 -18
  825. spire/xls/WorksheetsCollection.py +0 -341
  826. spire/xls/XLSXBorderJoinType.py +0 -19
  827. spire/xls/XLSXChartMaterialType.py +0 -32
  828. spire/xls/XLSXChartPrespectiveType.py +0 -21
  829. spire/xls/XLSXChartShadowInnerType.py +0 -25
  830. spire/xls/XLSXChartShadowOuterType.py +0 -25
  831. spire/xls/XlsAddInFunctionsCollection.py +0 -101
  832. spire/xls/XlsAutoFiltersCollection.py +0 -119
  833. spire/xls/XlsBordersCollection.py +0 -101
  834. spire/xls/XlsBuiltInDocumentProperties.py +0 -639
  835. spire/xls/XlsChart.py +0 -1510
  836. spire/xls/XlsChartAxis.py +0 -564
  837. spire/xls/XlsChartBorder.py +0 -165
  838. spire/xls/XlsChartCategoryAxis.py +0 -656
  839. spire/xls/XlsChartDataLabelArea.py +0 -387
  840. spire/xls/XlsChartDataLabels.py +0 -811
  841. spire/xls/XlsChartDataPoint.py +0 -108
  842. spire/xls/XlsChartDataPointsCollection.py +0 -120
  843. spire/xls/XlsChartDataTable.py +0 -393
  844. spire/xls/XlsChartDropBar.py +0 -301
  845. spire/xls/XlsChartFill.py +0 -571
  846. spire/xls/XlsChartFormat.py +0 -1069
  847. spire/xls/XlsChartFormatCollection.py +0 -162
  848. spire/xls/XlsChartFrameFormat.py +0 -614
  849. spire/xls/XlsChartGridLine.py +0 -171
  850. spire/xls/XlsChartInterior.py +0 -240
  851. spire/xls/XlsChartLegend.py +0 -355
  852. spire/xls/XlsChartLegendArea.py +0 -419
  853. spire/xls/XlsChartLegendEntry.py +0 -156
  854. spire/xls/XlsChartSerie.py +0 -589
  855. spire/xls/XlsChartSerieDataFormat.py +0 -1008
  856. spire/xls/XlsChartSeriesAxis.py +0 -212
  857. spire/xls/XlsChartShape.py +0 -1142
  858. spire/xls/XlsChartTitleArea.py +0 -392
  859. spire/xls/XlsChartValueAxis.py +0 -317
  860. spire/xls/XlsChartWallOrFloor.py +0 -319
  861. spire/xls/XlsChartsCollection.py +0 -89
  862. spire/xls/XlsCommentsCollection.py +0 -87
  863. spire/xls/XlsConditionValue.py +0 -111
  864. spire/xls/XlsConditionalFormat.py +0 -1119
  865. spire/xls/XlsConditionalFormats.py +0 -590
  866. spire/xls/XlsDataValidationCollection.py +0 -159
  867. spire/xls/XlsFontsCollection.py +0 -51
  868. spire/xls/XlsHPageBreaksCollection.py +0 -85
  869. spire/xls/XlsHyperLinksCollection.py +0 -102
  870. spire/xls/XlsPivotCache.py +0 -401
  871. spire/xls/XlsPivotCacheField.py +0 -209
  872. spire/xls/XlsPivotCachesCollection.py +0 -124
  873. spire/xls/XlsPivotField.py +0 -885
  874. spire/xls/XlsPivotTable.py +0 -905
  875. spire/xls/XlsPivotTablesCollection.py +0 -131
  876. spire/xls/XlsRangesCollection.py +0 -1566
  877. spire/xls/XlsStylesCollection.py +0 -73
  878. spire/xls/XlsVPageBreaksCollection.py +0 -84
  879. spire/xls/XlsWorkbookObjectsCollection.py +0 -94
  880. spire/xls/XlsWorksheetsCollection.py +0 -416
  881. spire_xls-15.5.0.dist-info/METADATA +0 -197
  882. spire_xls-15.5.0.dist-info/RECORD +0 -703
  883. /spire/xls/{lib → autofilter}/__init__.py +0 -0
  884. /spire/xls/{ChartBorder.py → charts/ChartBorder.py} +0 -0
  885. /spire/xls/{ChartDataTable.py → charts/ChartDataTable.py} +0 -0
  886. /spire/xls/{ChartDropBar.py → charts/ChartDropBar.py} +0 -0
  887. /spire/xls/{ChartInterior.py → charts/ChartInterior.py} +0 -0
  888. /spire/xls/{ChartPageSetup.py → charts/ChartPageSetup.py} +0 -0
  889. /spire/xls/{ChartTitle.py → charts/ChartTitle.py} +0 -0
  890. /spire/xls/{ChartWallOrFloor.py → charts/ChartWallOrFloor.py} +0 -0
  891. /spire/xls/{XlsChartPageSetup.py → charts/XlsChartPageSetup.py} +0 -0
  892. /spire/xls/{XlsChartPlotArea.py → charts/XlsChartPlotArea.py} +0 -0
  893. /spire/xls/{CheckBoxCollection.py → collection/CheckBoxCollection.py} +0 -0
  894. /spire/xls/{CollectionChangeEventArgs.py → collection/CollectionChangeEventArgs.py} +0 -0
  895. /spire/xls/{FontsCollection.py → collection/FontsCollection.py} +0 -0
  896. /spire/xls/{GeomertyAdjustValuesCollection.py → collection/GeomertyAdjustValuesCollection.py} +0 -0
  897. /spire/xls/{LabelShapeCollection.py → collection/LabelShapeCollection.py} +0 -0
  898. /spire/xls/{LineCollection.py → collection/LineCollection.py} +0 -0
  899. /spire/xls/{ListBoxCollection.py → collection/ListBoxCollection.py} +0 -0
  900. /spire/xls/{RectangleCollection.py → collection/RectangleCollection.py} +0 -0
  901. /spire/xls/{ScrollBarCollection.py → collection/ScrollBarCollection.py} +0 -0
  902. /spire/xls/{SpinnerShapeCollection.py → collection/SpinnerShapeCollection.py} +0 -0
  903. /spire/xls/{TextBoxCollection.py → collection/TextBoxCollection.py} +0 -0
  904. /spire/xls/{WorkbookObjectsCollection.py → collection/WorkbookObjectsCollection.py} +0 -0
  905. /spire/xls/{WorksheetChartsCollection.py → collection/WorksheetChartsCollection.py} +0 -0
  906. /spire/xls/{WorksheetConditionalFormats.py → collection/WorksheetConditionalFormats.py} +0 -0
  907. /spire/xls/{XlsChartSeries.py → collection/XlsChartSeries.py} +0 -0
  908. /spire/xls/{XlsHeaderFooterShapeCollection.py → collection/XlsHeaderFooterShapeCollection.py} +0 -0
  909. /spire/xls/{XlsPicturesCollection.py → collection/XlsPicturesCollection.py} +0 -0
  910. /spire/xls/{XlsWorksheetChartsCollection.py → collection/XlsWorksheetChartsCollection.py} +0 -0
  911. /spire/xls/{XlsWorksheetConditionalFormats.py → collection/XlsWorksheetConditionalFormats.py} +0 -0
  912. /spire/xls/{PivotCachesCollection.py → collection/pivot_table/PivotCachesCollection.py} +0 -0
  913. /spire/xls/{PivotCalculatedFieldsCollection.py → collection/pivot_table/PivotCalculatedFieldsCollection.py} +0 -0
  914. /spire/xls/{PivotDataFields.py → collection/pivot_table/PivotDataFields.py} +0 -0
  915. /spire/xls/{PivotTablesCollection.py → collection/pivot_table/PivotTablesCollection.py} +0 -0
  916. /spire/xls/{AxisTypes.py → enums/AxisTypes.py} +0 -0
  917. /spire/xls/{CompoundLineType.py → enums/CompoundLineType.py} +0 -0
  918. /spire/xls/{ConditionValueType.py → enums/ConditionValueType.py} +0 -0
  919. /spire/xls/{ConditionalTopNType.py → enums/ConditionalTopNType.py} +0 -0
  920. /spire/xls/{ConnectionDataSourceType.py → enums/ConnectionDataSourceType.py} +0 -0
  921. /spire/xls/{CopyRangeOptions.py → enums/CopyRangeOptions.py} +0 -0
  922. /spire/xls/{DataBarAxisPosition.py → enums/DataBarAxisPosition.py} +0 -0
  923. /spire/xls/{DataBarBorderType.py → enums/DataBarBorderType.py} +0 -0
  924. /spire/xls/{DataBarFillType.py → enums/DataBarFillType.py} +0 -0
  925. /spire/xls/{DataBarNegativeColorType.py → enums/DataBarNegativeColorType.py} +0 -0
  926. /spire/xls/{DataMarkerDirection.py → enums/DataMarkerDirection.py} +0 -0
  927. /spire/xls/{DateTimeGroupingType.py → enums/DateTimeGroupingType.py} +0 -0
  928. /spire/xls/{DeleteOption.py → enums/DeleteOption.py} +0 -0
  929. /spire/xls/{DynamicFilterType.py → enums/DynamicFilterType.py} +0 -0
  930. /spire/xls/{ExcelClearOptions.py → enums/ExcelClearOptions.py} +0 -0
  931. /spire/xls/{ExcelFindOptions.py → enums/ExcelFindOptions.py} +0 -0
  932. /spire/xls/{ExcelSaveType.py → enums/ExcelSaveType.py} +0 -0
  933. /spire/xls/{ExcelTotalsCalculation.py → enums/ExcelTotalsCalculation.py} +0 -0
  934. /spire/xls/{FillPictureType.py → enums/FillPictureType.py} +0 -0
  935. /spire/xls/{FilterOperatorType.py → enums/FilterOperatorType.py} +0 -0
  936. /spire/xls/{FilterType.py → enums/FilterType.py} +0 -0
  937. /spire/xls/{FindType.py → enums/FindType.py} +0 -0
  938. /spire/xls/{GeomertyAdjustValueFormulaType.py → enums/GeomertyAdjustValueFormulaType.py} +0 -0
  939. /spire/xls/{GroupByType.py → enums/GroupByType.py} +0 -0
  940. /spire/xls/{HttpContentType.py → enums/HttpContentType.py} +0 -0
  941. /spire/xls/{IconSetType.py → enums/IconSetType.py} +0 -0
  942. /spire/xls/{InsertOptionsType.py → enums/InsertOptionsType.py} +0 -0
  943. /spire/xls/{LineShapeType.py → enums/LineShapeType.py} +0 -0
  944. /spire/xls/{MeasureUnits.py → enums/MeasureUnits.py} +0 -0
  945. /spire/xls/{MsoPathType.py → enums/MsoPathType.py} +0 -0
  946. /spire/xls/{OLEDBCommandType.py → enums/OLEDBCommandType.py} +0 -0
  947. /spire/xls/{OdsPageBackgroundImagePositionType.py → enums/OdsPageBackgroundImagePositionType.py} +0 -0
  948. /spire/xls/{OdsPageBackgroundImageType.py → enums/OdsPageBackgroundImageType.py} +0 -0
  949. /spire/xls/{OdsPageBackgroundType.py → enums/OdsPageBackgroundType.py} +0 -0
  950. /spire/xls/{OleLinkType.py → enums/OleLinkType.py} +0 -0
  951. /spire/xls/{PathFillMode.py → enums/PathFillMode.py} +0 -0
  952. /spire/xls/{PdfConformanceLevel.py → enums/PdfConformanceLevel.py} +0 -0
  953. /spire/xls/{PivotAutoFomatTypes.py → enums/PivotAutoFomatTypes.py} +0 -0
  954. /spire/xls/{PivotBuiltInStyles.py → enums/PivotBuiltInStyles.py} +0 -0
  955. /spire/xls/{PivotDataType.py → enums/PivotDataType.py} +0 -0
  956. /spire/xls/{PivotFieldFormatType.py → enums/PivotFieldFormatType.py} +0 -0
  957. /spire/xls/{PivotFieldSortType.py → enums/PivotFieldSortType.py} +0 -0
  958. /spire/xls/{PivotItemType.py → enums/PivotItemType.py} +0 -0
  959. /spire/xls/{PivotLabelFilterType.py → enums/PivotLabelFilterType.py} +0 -0
  960. /spire/xls/{PivotPageAreaFieldsOrderType.py → enums/PivotPageAreaFieldsOrderType.py} +0 -0
  961. /spire/xls/{PivotTableElement.py → enums/PivotTableElement.py} +0 -0
  962. /spire/xls/{PivotTableLayoutType.py → enums/PivotTableLayoutType.py} +0 -0
  963. /spire/xls/{PivotValueFilterType.py → enums/PivotValueFilterType.py} +0 -0
  964. /spire/xls/{PresetTextEffect.py → enums/PresetTextEffect.py} +0 -0
  965. /spire/xls/{PrintingPageType.py → enums/PrintingPageType.py} +0 -0
  966. /spire/xls/{PropertyType.py → enums/PropertyType.py} +0 -0
  967. /spire/xls/{PrstGeomShapeType.py → enums/PrstGeomShapeType.py} +0 -0
  968. /spire/xls/{RectangleShapeType.py → enums/RectangleShapeType.py} +0 -0
  969. /spire/xls/{RelationShip.py → enums/RelationShip.py} +0 -0
  970. /spire/xls/{RenameStrategy.py → enums/RenameStrategy.py} +0 -0
  971. /spire/xls/{RtfTags.py → enums/RtfTags.py} +0 -0
  972. /spire/xls/{SelectionType.py → enums/SelectionType.py} +0 -0
  973. /spire/xls/{SparklineEmptyCells.py → enums/SparklineEmptyCells.py} +0 -0
  974. /spire/xls/{SpartlineVerticalAxisType.py → enums/SpartlineVerticalAxisType.py} +0 -0
  975. /spire/xls/{StrikeThroughStyle.py → enums/StrikeThroughStyle.py} +0 -0
  976. /spire/xls/{StyleDefineType.py → enums/StyleDefineType.py} +0 -0
  977. /spire/xls/{SubtotalTypes.py → enums/SubtotalTypes.py} +0 -0
  978. /spire/xls/{TRangeValueType.py → enums/TRangeValueType.py} +0 -0
  979. /spire/xls/{TableBuiltInStyles.py → enums/TableBuiltInStyles.py} +0 -0
  980. /spire/xls/{TextDirectionType.py → enums/TextDirectionType.py} +0 -0
  981. /spire/xls/{TextVerticalValue.py → enums/TextVerticalValue.py} +0 -0
  982. /spire/xls/{TimePeriodType.py → enums/TimePeriodType.py} +0 -0
  983. /spire/xls/{UnderlineStyle.py → enums/UnderlineStyle.py} +0 -0
  984. /spire/xls/{WorksheetCopyType.py → enums/WorksheetCopyType.py} +0 -0
  985. /spire/xls/{XLSXChartBevelType.py → enums/XLSXChartBevelType.py} +0 -0
  986. /spire/xls/{XLSXChartLightingType.py → enums/XLSXChartLightingType.py} +0 -0
  987. /spire/xls/{XLSXPivotItemType.py → enums/XLSXPivotItemType.py} +0 -0
  988. /spire/xls/{XmlOpenType.py → enums/XmlOpenType.py} +0 -0
  989. /spire/xls/{IAddInFunction.py → interfaces/IAddInFunction.py} +0 -0
  990. /spire/xls/{IAutoFilter.py → interfaces/IAutoFilter.py} +0 -0
  991. /spire/xls/{IAutoFilterCondition.py → interfaces/IAutoFilterCondition.py} +0 -0
  992. /spire/xls/{IAutoFilters.py → interfaces/IAutoFilters.py} +0 -0
  993. /spire/xls/{IBorder.py → interfaces/IBorder.py} +0 -0
  994. /spire/xls/{IBuiltInDocumentProperties.py → interfaces/IBuiltInDocumentProperties.py} +0 -0
  995. /spire/xls/{IButtonShape.py → interfaces/IButtonShape.py} +0 -0
  996. /spire/xls/{IChartDropBar.py → interfaces/IChartDropBar.py} +0 -0
  997. /spire/xls/{IExcelApplication.py → interfaces/IExcelApplication.py} +0 -0
  998. /spire/xls/{IInternalWorksheet.py → interfaces/IInternalWorksheet.py} +0 -0
  999. /spire/xls/{IListBox.py → interfaces/IListBox.py} +0 -0
  1000. /spire/xls/{IRichTextString.py → interfaces/IRichTextString.py} +0 -0
  1001. /spire/xls/{IAddInFunctions.py → interfaces/collections/IAddInFunctions.py} +0 -0
  1002. /spire/xls/{IArcShapes.py → interfaces/collections/IArcShapes.py} +0 -0
  1003. /spire/xls/{IBorders.py → interfaces/collections/IBorders.py} +0 -0
  1004. /spire/xls/{IButtonShapes.py → interfaces/collections/IButtonShapes.py} +0 -0
  1005. /spire/xls/{IChartDataPoints.py → interfaces/collections/IChartDataPoints.py} +0 -0
  1006. /spire/xls/{IChartLegendEntries.py → interfaces/collections/IChartLegendEntries.py} +0 -0
  1007. /spire/xls/{IChartSeries.py → interfaces/collections/IChartSeries.py} +0 -0
  1008. /spire/xls/{IChartShapes.py → interfaces/collections/IChartShapes.py} +0 -0
  1009. /spire/xls/{IChartTrendLines.py → interfaces/collections/IChartTrendLines.py} +0 -0
  1010. /spire/xls/{ICharts.py → interfaces/collections/ICharts.py} +0 -0
  1011. /spire/xls/{ICheckBoxes.py → interfaces/collections/ICheckBoxes.py} +0 -0
  1012. /spire/xls/{IComboBoxes.py → interfaces/collections/IComboBoxes.py} +0 -0
  1013. /spire/xls/{IComments.py → interfaces/collections/IComments.py} +0 -0
  1014. /spire/xls/{IConditionalFormatsCollection.py → interfaces/collections/IConditionalFormatsCollection.py} +0 -0
  1015. /spire/xls/{IGroupBoxes.py → interfaces/collections/IGroupBoxes.py} +0 -0
  1016. /spire/xls/{IHyperLinks.py → interfaces/collections/IHyperLinks.py} +0 -0
  1017. /spire/xls/{ILabelShapes.py → interfaces/collections/ILabelShapes.py} +0 -0
  1018. /spire/xls/{ILines.py → interfaces/collections/ILines.py} +0 -0
  1019. /spire/xls/{IListBoxes.py → interfaces/collections/IListBoxes.py} +0 -0
  1020. /spire/xls/{INameRanges.py → interfaces/collections/INameRanges.py} +0 -0
  1021. /spire/xls/{IOvalShapes.py → interfaces/collections/IOvalShapes.py} +0 -0
  1022. /spire/xls/{IPictures.py → interfaces/collections/IPictures.py} +0 -0
  1023. /spire/xls/{IRadioButtons.py → interfaces/collections/IRadioButtons.py} +0 -0
  1024. /spire/xls/{IRectangleShapes.py → interfaces/collections/IRectangleShapes.py} +0 -0
  1025. /spire/xls/{IScrollBarShapes.py → interfaces/collections/IScrollBarShapes.py} +0 -0
  1026. /spire/xls/{ISpinnerShapes.py → interfaces/collections/ISpinnerShapes.py} +0 -0
  1027. /spire/xls/{IStyles.py → interfaces/collections/IStyles.py} +0 -0
  1028. /spire/xls/{ITabSheets.py → interfaces/collections/ITabSheets.py} +0 -0
  1029. /spire/xls/{IWorksheetGroup.py → interfaces/collections/IWorksheetGroup.py} +0 -0
  1030. /spire/xls/{IWorksheets.py → interfaces/collections/IWorksheets.py} +0 -0
  1031. /spire/xls/{IPivotDataField.py → interfaces/pivot_table/IPivotDataField.py} +0 -0
  1032. /spire/xls/{IPivotDataFields.py → interfaces/pivot_table/IPivotDataFields.py} +0 -0
  1033. /spire/xls/{IPivotFields.py → interfaces/pivot_table/IPivotFields.py} +0 -0
  1034. /spire/xls/{IPivotTables.py → interfaces/pivot_table/IPivotTables.py} +0 -0
  1035. /spire/xls/{IDataSort.py → interfaces/sorting/IDataSort.py} +0 -0
  1036. /spire/xls/{PivotCache.py → pivot_tables/PivotCache.py} +0 -0
  1037. /spire/xls/{PivotField.py → pivot_tables/PivotField.py} +0 -0
  1038. /spire/xls/{PivotTable.py → pivot_tables/PivotTable.py} +0 -0
  1039. /spire/xls/{EncryptedKeyInfo.py → security/EncryptedKeyInfo.py} +0 -0
  1040. /spire/xls/{ISparkline.py → sparkline/ISparkline.py} +0 -0
  1041. /spire/xls/{ISparklineGroup.py → sparkline/ISparklineGroup.py} +0 -0
  1042. {spire_xls-15.5.0.dist-info → spire_xls-15.11.1.dist-info}/WHEEL +0 -0
  1043. {spire_xls-15.5.0.dist-info → spire_xls-15.11.1.dist-info}/top_level.txt +0 -0
spire/xls/XlsRange.py CHANGED
@@ -3,8 +3,8 @@ from plum import dispatch
3
3
  from typing import TypeVar,Union,Generic,List,Tuple
4
4
  from spire.xls.common import *
5
5
  from spire.xls import *
6
- from spire.xls.XlsBordersCollection import *
7
- from spire.xls.XlsHyperLinksCollection import *
6
+ from spire.xls.collection.XlsBordersCollection import *
7
+ from spire.xls.collection.XlsHyperLinksCollection import *
8
8
  from ctypes import *
9
9
  import abc
10
10
  from spire.xls.Validation import Validation
@@ -16,9 +16,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
16
16
 
17
17
  def GetNamedRange(self)->'INamedRange':
18
18
  """
19
- <summary>
20
19
  Get the named range object of current Range.
21
- </summary>
20
+
22
21
  """
23
22
  from spire.xls.XlsName import XlsName
24
23
  GetDllLibXls().XlsRange_GetNamedRange.argtypes=[c_void_p]
@@ -31,12 +30,12 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
31
30
 
32
31
  def InsertOrUpdateCellImage(self ,stream:Stream,scale:bool):
33
32
  """
34
- <summary>
35
- Adds CellImage from the specified file stream.
36
- this method only support WPS
37
- </summary>
38
- <param name="stream">Represents image stream to set.</param>
39
- <param name="scale">scale if true scale for cell else clip the image.</param>
33
+ Adds CellImage from the specified file stream. this method only support WPS
34
+
35
+ Args:
36
+ stream: Represents image stream to set.
37
+ scale: scale if true scale for cell else clip the image.
38
+
40
39
  """
41
40
  intPtrstream:c_void_p = stream.Ptr
42
41
 
@@ -47,12 +46,12 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
47
46
 
48
47
  def InsertOrUpdateCellImage(self ,fileName:str,scale:bool):
49
48
  """
50
- <summary>
51
- Adds CellImage from the specified file.
52
- this method only support WPS
53
- </summary>
54
- <param name="fileName">Represents image path to set.</param>
55
- <param name="scale">scale if true scale for cell else clip the image.</param>
49
+ Adds CellImage from the specified file. this method only support WPS
50
+
51
+ Args:
52
+ fileName: Represents image path to set.
53
+ scale: scale if true scale for cell else clip the image.
54
+
56
55
  """
57
56
 
58
57
  GetDllLibXls().XlsRange_InsertOrUpdateCellImageFS.argtypes=[c_void_p ,c_wchar_p,c_bool]
@@ -60,9 +59,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
60
59
 
61
60
  def RemoveCellImage(self):
62
61
  """
63
- <summary>
64
62
  Remove CellImage.
65
- </summary>
63
+
66
64
  """
67
65
  GetDllLibXls().XlsRange_RemoveCellImage.argtypes=[c_void_p]
68
66
  CallCFunction(GetDllLibXls().XlsRange_RemoveCellImage,self.Ptr)
@@ -71,11 +69,14 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
71
69
 
72
70
  def Merge(self ,range:IXLSRange)->IXLSRange:
73
71
  """
74
- <summary>
75
72
  Creates a merged cell from the specified Range object.
76
- </summary>
77
- <param name="range">The Range to merge with.</param>
78
- <returns>Merged ranges or null if wasn't able to merge ranges.</returns>
73
+
74
+ Args:
75
+ range: The Range to merge with.
76
+
77
+ Returns:
78
+ Merged ranges or null if wasn't able to merge ranges.
79
+
79
80
  """
80
81
  intPtrrange:c_void_p = range.Ptr
81
82
 
@@ -89,23 +90,24 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
89
90
 
90
91
  def Intersect(self ,range:'IXLSRange')->'IXLSRange':
91
92
  """
92
- <summary>
93
- Returns intersection of this range with the specified one.
94
- <example>The following code illustrates how to perform intersectwith in the Range:
95
- <code>
96
- //Create worksheet
97
- Workbook workbook = new Workbook();
98
- Worksheet worksheet = workbook.Worksheets[0];
99
- //Get intersect range
100
- IXLSRange range = worksheet.Range["A16:C16"];
101
- IXLSRange commonRange = worksheet.Range["B16:D16"].Intersect(range);
102
- //Save to file
103
- workbook.SaveToFile("Intersect.xlsx");
104
- </code>
105
- </example>
106
- </summary>
107
- <param name="range">The Range with which to intersect.</param>
108
- <returns>Range intersection. If there is no intersection, NULL is returned.</returns>
93
+ Returns intersection of this range with the specified one.
94
+
95
+ Args:
96
+ range: The Range with which to intersect.
97
+
98
+ Returns:
99
+ Range intersection. If there is no intersection, NULL is returned.
100
+ Example::
101
+
102
+ #Create worksheet
103
+ workbook = Workbook()
104
+ worksheet = workbook.Worksheets[0]
105
+ #Get intersect range
106
+ range = worksheet.Range["A16:C16"]
107
+ commonRange = worksheet.Range["B16:D16"].Intersect(range)
108
+ #Save to file
109
+ workbook.SaveToFile("Intersect.xlsx")
110
+
109
111
  """
110
112
  intPtrrange:c_void_p = range.Ptr
111
113
 
@@ -131,11 +133,14 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
131
133
 
132
134
  def MeasureString(self ,measureString:str)->'SizeF':
133
135
  """
134
- <summary>
135
136
  Measures size of the string.
136
- </summary>
137
- <param name="measureString">String to measure.</param>
138
- <returns>Size of the string.</returns>
137
+
138
+ Args:
139
+ measureString: String to measure.
140
+
141
+ Returns:
142
+ Size of the string.
143
+
139
144
  """
140
145
 
141
146
  GetDllLibXls().XlsRange_MeasureString.argtypes=[c_void_p ,c_void_p]
@@ -148,22 +153,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
148
153
  @dispatch
149
154
  def Merge(self):
150
155
  """
151
- <summary>
152
- Creates a merged cell from the specified Range object.
153
- <example>The following code illustrates how to merge the Range:
154
- <code>
155
- //Create worksheet
156
- Workbook workbook = new Workbook();
157
- Worksheet worksheet = workbook.Worksheets[0];
158
- //Set text
159
- worksheet["A1"].Text = "Merged cell";
160
- //Merge cells
161
- worksheet["A1:B1"].Merge();
162
- //Save to file
163
- workbook.SaveToFile("Merge.xlsx");
164
- </code>
165
- </example>
166
- </summary>
156
+ Creates a merged cell from the specified Range object.
157
+ Example::
158
+
159
+ #Create worksheet
160
+ workbook = Workbook()
161
+ worksheet = workbook.Worksheets[0]
162
+ #Set text
163
+ worksheet["A1"].Text = "Merged cell"
164
+ #Merge cells
165
+ worksheet["A1:B1"].Merge()
166
+ #Save to file
167
+ workbook.SaveToFile("Merge.xlsx")
168
+
167
169
  """
168
170
  GetDllLibXls().XlsRange_Merge1.argtypes=[c_void_p]
169
171
  CallCFunction(GetDllLibXls().XlsRange_Merge1, self.Ptr)
@@ -179,24 +181,23 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
179
181
 
180
182
  def Merge(self ,clearCells:bool):
181
183
  """
182
- <summary>
183
- Creates a merged cell from the specified Range object.
184
- <example>The following code illustrates how to merge the Range with clear option:
185
- <code>
186
- //Create worksheet
187
- Workbook workbook = new Workbook();
188
- Worksheet worksheet = workbook.Worksheets[0];
189
- //Set text
190
- worksheet["A1"].Text = "Merged cell";
191
- worksheet["B1"].Text = "sample";
192
- //Merge cells
193
- worksheet["A1:B1"].Merge(true);
194
- //Save to file
195
- workbook.SaveToFile("Merge.xlsx");
196
- </code>
197
- </example>
198
- </summary>
199
- <param name="clearCells">Indicates whether to clear unnecessary cells.</param>
184
+ Creates a merged cell from the specified Range object.
185
+
186
+ Args:
187
+ clearCells: Indicates whether to clear unnecessary cells.
188
+ Example::
189
+
190
+ #Create worksheet
191
+ workbook = Workbook()
192
+ worksheet = workbook.Worksheets[0]
193
+ #Set text
194
+ worksheet["A1"].Text = "Merged cell"
195
+ worksheet["B1"].Text = "sample"
196
+ #Merge cells
197
+ worksheet["A1:B1"].Merge(true)
198
+ #Save to file
199
+ workbook.SaveToFile("Merge.xlsx")
200
+
200
201
  """
201
202
 
202
203
  GetDllLibXls().XlsRange_MergeC.argtypes=[c_void_p ,c_bool]
@@ -204,9 +205,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
204
205
 
205
206
  def PartialClear(self):
206
207
  """
207
- <summary>
208
208
  Partially clear range.
209
- </summary>
209
+
210
210
  """
211
211
  GetDllLibXls().XlsRange_PartialClear.argtypes=[c_void_p]
212
212
  CallCFunction(GetDllLibXls().XlsRange_PartialClear, self.Ptr)
@@ -214,11 +214,12 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
214
214
 
215
215
  def TextPartReplace(self ,oldPartValue:str,newPartValue:str):
216
216
  """
217
- <summary>
218
217
  Replaces cell's part text and reserve text's format.
219
- </summary>
220
- <param name="oldPartValue">Part value of cell's text to search for.</param>
221
- <param name="newPartValue">The replacement value.</param>
218
+
219
+ Args:
220
+ oldPartValue: Part value of cell's text to search for.
221
+ newPartValue: The replacement value.
222
+
222
223
  """
223
224
 
224
225
  GetDllLibXls().XlsRange_TextPartReplace.argtypes=[c_void_p ,c_void_p,c_void_p]
@@ -252,10 +253,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
252
253
 
253
254
  def CombinedAddress(self)->str:
254
255
  """
255
- <summary>
256
- Returns the combined range reference in the language.
257
- Read-only String.
258
- </summary>
256
+ Returns the combined range reference in the language. Read-only String.
257
+
259
258
  """
260
259
  GetDllLibXls().XlsRange_get_CombinedAddress.argtypes=[c_void_p]
261
260
  GetDllLibXls().XlsRange_get_CombinedAddress.restype=c_void_p
@@ -265,33 +264,29 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
265
264
 
266
265
  def UnMerge(self):
267
266
  """
268
- <summary>
269
- Separates a merged area into individual cells.
270
- <example>The following code illustrates how to UnMerge the merged cells:
271
- <code>
272
- //Create worksheet
273
- Workbook workbook = new Workbook();
274
- Worksheet worksheet = workbook.Worksheets[0];
275
- //Set text
276
- worksheet["A1"].Text = "Merged cell";
277
- //Merge cells
278
- worksheet["A1:B1"].Merge(true);
279
- //Unmerge cells
280
- worksheet["A1:B1"].UnMerge();
281
- //Save to file
282
- workbook.SaveToFile("UnMerge.xlsx");
283
- </code>
284
- </example>
285
- </summary>
267
+ Separates a merged area into individual cells.
268
+ Example::
269
+
270
+ #Create worksheet
271
+ workbook = Workbook()
272
+ worksheet = workbook.Worksheets[0]
273
+ #Set text
274
+ worksheet["A1"].Text = "Merged cell"
275
+ #Merge cells
276
+ worksheet["A1:B1"].Merge(true)
277
+ #Unmerge cells
278
+ worksheet["A1:B1"].UnMerge()
279
+ #Save to file
280
+ workbook.SaveToFile("UnMerge.xlsx")
281
+
286
282
  """
287
283
  GetDllLibXls().XlsRange_UnMerge.argtypes=[c_void_p]
288
284
  CallCFunction(GetDllLibXls().XlsRange_UnMerge, self.Ptr)
289
285
 
290
286
  def ReparseFormulaString(self):
291
287
  """
292
- <summary>
293
288
  Reparses formula.
294
- </summary>
289
+
295
290
  """
296
291
  GetDllLibXls().XlsRange_ReparseFormulaString.argtypes=[c_void_p]
297
292
  CallCFunction(GetDllLibXls().XlsRange_ReparseFormulaString, self.Ptr)
@@ -315,7 +310,7 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
315
310
  """
316
311
 
317
312
  """
318
-
313
+ from spire.xls.XlsComment import XlsComment
319
314
  GetDllLibXls().XlsRange_AddComment.argtypes=[c_void_p ,c_bool]
320
315
  GetDllLibXls().XlsRange_AddComment.restype=c_void_p
321
316
  intPtr = CallCFunction(GetDllLibXls().XlsRange_AddComment, self.Ptr, bIsParseOptions)
@@ -360,12 +355,13 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
360
355
 
361
356
  def Replace(self ,oldValue:str,newValues:List[str],isVertical:bool):
362
357
  """
363
- <summary>
364
358
  Replaces cells' values with new data.
365
- </summary>
366
- <param name="oldValue">Value to search for.</param>
367
- <param name="newValues">The replacement value.</param>
368
- <param name="isVertical">Indicates whether to insert values vertically or horizontally.</param>
359
+
360
+ Args:
361
+ oldValue: Value to search for.
362
+ newValues: The replacement value.
363
+ isVertical: Indicates whether to insert values vertically or horizontally.
364
+
369
365
  """
370
366
  #arraynewValues:ArrayTypenewValues = ""
371
367
  countnewValues = len(newValues)
@@ -382,11 +378,12 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
382
378
 
383
379
  def Replace(self ,oldValue:str,newValue:str):
384
380
  """
385
- <summary>
386
- Replaces cells' values with new data.
387
- </summary>
388
- <param name="oldValue">Value to search for.</param>
389
- <param name="newValue">The replacement value.</param>
381
+ Replaces cells' values with new data.
382
+
383
+ Args:
384
+ oldValue: Value to search for.
385
+ newValue: The replacement value.
386
+
390
387
  """
391
388
 
392
389
  GetDllLibXls().XlsRange_ReplaceON.argtypes=[c_void_p ,c_void_p,c_void_p]
@@ -396,12 +393,13 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
396
393
 
397
394
  def Replace(self ,oldValue:str,newValues:List[float],isVertical:bool):
398
395
  """
399
- <summary>
400
396
  Replaces cells' values with new data.
401
- </summary>
402
- <param name="oldValue">Value to search for.</param>
403
- <param name="newValues">DataColumn to replace.</param>
404
- <param name="isFieldNamesShown">Indicates whether to insert values vertically or horizontally.</param>
397
+
398
+ Args:
399
+ oldValue: Value to search for.
400
+ newValues: DataColumn to replace.
401
+ isFieldNamesShown: Indicates whether to insert values vertically or horizontally.
402
+
405
403
  """
406
404
  #arraynewValues:ArrayTypenewValues = ""
407
405
  countnewValues = len(newValues)
@@ -418,12 +416,13 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
418
416
 
419
417
  def Replace(self ,oldValue:str,newValues:List[int],isVertical:bool):
420
418
  """
421
- <summary>
422
419
  Replaces cells' values with new data.
423
- </summary>
424
- <param name="oldValue">Value to search for.</param>
425
- <param name="newValues">The replacement value.</param>
426
- <param name="isVertical">Indicates whether to insert values vertically or horizontally.</param>
420
+
421
+ Args:
422
+ oldValue: Value to search for.
423
+ newValues: The replacement value.
424
+ isVertical: Indicates whether to insert values vertically or horizontally.
425
+
427
426
  """
428
427
  #arraynewValues:ArrayTypenewValues = ""
429
428
  countnewValues = len(newValues)
@@ -457,11 +456,12 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
457
456
 
458
457
  def Replace(self ,oldValue:str,newValue:DateTime):
459
458
  """
460
- <summary>
461
- Replaces cells' values with new data.
462
- </summary>
463
- <param name="oldValue">Value to search for.</param>
464
- <param name="newValue">The replacement value.</param>
459
+ Replaces cells' values with new data.
460
+
461
+ Args:
462
+ oldValue: Value to search for.
463
+ newValue: The replacement value.
464
+
465
465
  """
466
466
  intPtrnewValue:c_void_p = newValue.Ptr
467
467
 
@@ -472,11 +472,12 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
472
472
 
473
473
  def Replace(self ,oldValue:str,newValue:float):
474
474
  """
475
- <summary>
476
- Replaces cells' values with new data.
477
- </summary>
478
- <param name="oldValue">Value to search for.</param>
479
- <param name="newValue">The replacement value.</param>
475
+ Replaces cells' values with new data.
476
+
477
+ Args:
478
+ oldValue: Value to search for.
479
+ newValue: The replacement value.
480
+
480
481
  """
481
482
 
482
483
  GetDllLibXls().XlsRange_ReplaceON11.argtypes=[c_void_p ,c_void_p,c_double]
@@ -488,6 +489,7 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
488
489
 
489
490
  """
490
491
  intPtrrange:c_void_p = range.Ptr
492
+ from spire.xls.collection.RangesCollection import RangesCollection
491
493
 
492
494
  GetDllLibXls().XlsRange_Union.argtypes=[c_void_p ,c_void_p]
493
495
  GetDllLibXls().XlsRange_Union.restype=c_void_p
@@ -545,13 +547,14 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
545
547
 
546
548
  def UpdateRange(self ,startRow:int,startColumn:int,endRow:int,endColumn:int):
547
549
  """
548
- <summary>
549
550
  Update region of range
550
- </summary>
551
- <param name="startRow">first Row</param>
552
- <param name="startColumn">first Column</param>
553
- <param name="endRow">last Row</param>
554
- <param name="endColumn">last Column</param>
551
+
552
+ Args:
553
+ startRow: first Row
554
+ startColumn: first Column
555
+ endRow: last Row
556
+ endColumn: last Column
557
+
555
558
  """
556
559
 
557
560
  GetDllLibXls().XlsRange_UpdateRange.argtypes=[c_void_p ,c_int,c_int,c_int,c_int]
@@ -559,9 +562,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
559
562
 
560
563
  def ConvertToNumber(self):
561
564
  """
562
- <summary>
563
565
  Convert number that stored as text to number
564
- </summary>
566
+
565
567
  """
566
568
  GetDllLibXls().XlsRange_ConvertToNumber.argtypes=[c_void_p]
567
569
  CallCFunction(GetDllLibXls().XlsRange_ConvertToNumber, self.Ptr)
@@ -578,11 +580,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
578
580
 
579
581
  def GetConditionFormatsStyle(self)->'CellStyle':
580
582
  """
581
- <summary>
582
- Get the calculated condition format style of current Range.
583
- If style of every cell is not same, return null.
584
- If current range without condition format, return null.
585
- </summary>
583
+ Get the calculated condition format style of current Range. If style of every cell is not same, return null. If current range without condition format, return null.
584
+
586
585
  """
587
586
  GetDllLibXls().XlsRange_GetConditionFormatsStyle.argtypes=[c_void_p]
588
587
  GetDllLibXls().XlsRange_GetConditionFormatsStyle.restype=c_void_p
@@ -595,18 +594,15 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
595
594
 
596
595
  def RangeR1C1Address(self)->str:
597
596
  """
598
- <summary>
599
- Returns the range reference using R1C1 notation.
600
- <example>The following code illustrates how to access AddressR1C1 property of the Range:
601
- <code>
602
- //Create worksheet
603
- Workbook workbook = new Workbook();
604
- Worksheet worksheet = workbook.Worksheets[0];
605
- //Get RangeR1C1Address
606
- string address = worksheet.Range[3, 4].RangeR1C1Address;
607
- </code>
608
- </example>
609
- </summary>
597
+ Returns the range reference using R1C1 notation.
598
+ Example::
599
+
600
+ #Create worksheet
601
+ workbook = Workbook()
602
+ worksheet = workbook.Worksheets[0]
603
+ #Get RangeR1C1Address
604
+ address = worksheet.Range[3, 4].RangeR1C1Address
605
+
610
606
  """
611
607
  GetDllLibXls().XlsRange_get_RangeR1C1Address.argtypes=[c_void_p]
612
608
  GetDllLibXls().XlsRange_get_RangeR1C1Address.restype=c_void_p
@@ -618,18 +614,15 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
618
614
 
619
615
  def RangeR1C1AddressLocal(self)->str:
620
616
  """
621
- <summary>
622
- Returns the range reference using R1C1 notation.
623
- <example>The following code illustrates how to access AddressR1C1Local property of the Range:
624
- <code>
625
- //Create worksheet
626
- Workbook workbook = new Workbook();
627
- Worksheet worksheet = workbook.Worksheets[0];
628
- //Get RangeR1C1AddressLocal
629
- string address = worksheet.Range[3, 4].RangeR1C1Address;
630
- </code>
631
- </example>
632
- </summary>
617
+ Returns the range reference using R1C1 notation.
618
+ Example::
619
+
620
+ #Create worksheet
621
+ workbook = Workbook()
622
+ worksheet = workbook.Worksheets[0]
623
+ #Get RangeR1C1AddressLocal
624
+ address = worksheet.Range[3, 4].RangeR1C1Address
625
+
633
626
  """
634
627
  GetDllLibXls().XlsRange_get_RangeR1C1AddressLocal.argtypes=[c_void_p]
635
628
  GetDllLibXls().XlsRange_get_RangeR1C1AddressLocal.restype=c_void_p
@@ -643,11 +636,14 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
643
636
  """
644
637
 
645
638
  """
646
- from spire.xls.RichTextString import RichTextString
639
+ from spire.xls.RangeRichTextString import RangeRichTextString
640
+ from spire.xls.RTFStringArray import RTFStringArray
647
641
  GetDllLibXls().XlsRange_get_RichText.argtypes=[c_void_p]
648
642
  GetDllLibXls().XlsRange_get_RichText.restype=c_void_p
649
643
  intPtr = CallCFunction(GetDllLibXls().XlsRange_get_RichText, self.Ptr)
650
- ret = None if intPtr==None else RichTextString(intPtr)
644
+ if intPtr==None:
645
+ return None
646
+ ret = RangeRichTextString(intPtr) if self.__Is_Single_Cell__() else RTFStringArray(intPtr)
651
647
  return ret
652
648
 
653
649
 
@@ -655,9 +651,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
655
651
 
656
652
  def HtmlString(self)->str:
657
653
  """
658
- <summary>
659
654
  Gets and sets the html string which contains data and some formattings in this cell.
660
- </summary>
655
+
661
656
  """
662
657
  GetDllLibXls().XlsRange_get_HtmlString.argtypes=[c_void_p]
663
658
  GetDllLibXls().XlsRange_get_HtmlString.restype=c_void_p
@@ -673,9 +668,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
673
668
  @property
674
669
  def Row(self)->int:
675
670
  """
676
- <summary>
677
671
  Returns the number of the first row of the first area in the range.
678
- </summary>
672
+
679
673
  """
680
674
  GetDllLibXls().XlsRange_get_Row.argtypes=[c_void_p]
681
675
  GetDllLibXls().XlsRange_get_Row.restype=c_int
@@ -685,14 +679,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
685
679
  @property
686
680
  def RowGroupLevel(self)->int:
687
681
  """
688
- <summary>
689
682
  Row group level.
690
- </summary>
691
- <remarks>
692
- -1 - column group is not same.
693
- 0 - Not group
694
- 1 - 7 - group level.
695
- </remarks>
683
+
696
684
  """
697
685
  GetDllLibXls().XlsRange_get_RowGroupLevel.argtypes=[c_void_p]
698
686
  GetDllLibXls().XlsRange_get_RowGroupLevel.restype=c_int
@@ -702,22 +690,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
702
690
  @property
703
691
  def RowHeight(self)->float:
704
692
  """
705
- <summary>
706
- Returns the height of all the rows in the range specified, measured in points.
707
- <example>The following code illustrates how to set row height:
708
- <code>
709
- //Create worksheet
710
- Workbook workbook = new Workbook();
711
- Worksheet worksheet = workbook.Worksheets[0];
712
- //Set text
713
- worksheet["A1"].Text = "Test";
714
- //Set row height
715
- worksheet["A1"].RowHeight = 30;
716
- //Save to file
717
- workbook.SaveToFile("RowHeight.xlsx");
718
- </code>
719
- </example>
720
- </summary>
693
+ Returns the height of all the rows in the range specified, measured in points.
694
+ Example::
695
+
696
+ #Create worksheet
697
+ workbook = Workbook()
698
+ worksheet = workbook.Worksheets[0]
699
+ #Set text
700
+ worksheet["A1"].Text = "Test"
701
+ #Set row height
702
+ worksheet["A1"].RowHeight = 30
703
+ #Save to file
704
+ workbook.SaveToFile("RowHeight.xlsx")
705
+
721
706
  """
722
707
  GetDllLibXls().XlsRange_get_RowHeight.argtypes=[c_void_p]
723
708
  GetDllLibXls().XlsRange_get_RowHeight.restype=c_double
@@ -744,21 +729,25 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
744
729
 
745
730
  @property
746
731
 
747
- def ExtendedFormatIndex(self)->'UInt16':
732
+ def ExtendedFormatIndex(self)->int:
748
733
  """
749
734
 
750
735
  """
751
736
  GetDllLibXls().XlsRange_get_ExtendedFormatIndex.argtypes=[c_void_p]
752
737
  GetDllLibXls().XlsRange_get_ExtendedFormatIndex.restype=c_void_p
753
738
  intPtr = CallCFunction(GetDllLibXls().XlsRange_get_ExtendedFormatIndex, self.Ptr)
754
- ret = None if intPtr==None else UInt16(intPtr)
739
+ if intPtr == None:
740
+ return None
741
+ dlllib.UInt16_Value.argtypes=[c_void_p]
742
+ dlllib.UInt16_Value.restype=c_int
743
+ ret = CallCFunction(dlllib.UInt16_Value, intPtr)
755
744
  return ret
756
745
 
757
746
 
758
747
  @ExtendedFormatIndex.setter
759
- def ExtendedFormatIndex(self, value:'UInt16'):
760
- GetDllLibXls().XlsRange_set_ExtendedFormatIndex.argtypes=[c_void_p, c_void_p]
761
- CallCFunction(GetDllLibXls().XlsRange_set_ExtendedFormatIndex, self.Ptr, value.Ptr)
748
+ def ExtendedFormatIndex(self, value:int):
749
+ GetDllLibXls().XlsRange_SetExtendedFormatIndex.argtypes=[c_void_p, c_int]
750
+ CallCFunction(GetDllLibXls().XlsRange_SetExtendedFormatIndex, self.Ptr, value)
762
751
 
763
752
 
764
753
  def SetExtendedFormatIndex(self ,index:int):
@@ -811,9 +800,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
811
800
 
812
801
  def Text(self)->str:
813
802
  """
814
- <summary>
815
803
  Gets / sets text of range.
816
- </summary>
804
+
817
805
  """
818
806
  GetDllLibXls().XlsRange_get_Text.argtypes=[c_void_p]
819
807
  GetDllLibXls().XlsRange_get_Text.restype=c_void_p
@@ -896,9 +884,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
896
884
 
897
885
  def TimeSpanValue(self)->'TimeSpan':
898
886
  """
899
- <summary>
900
887
  Gets or sets timespan value of cell.
901
- </summary>
888
+
902
889
  """
903
890
  GetDllLibXls().XlsRange_get_TimeSpanValue.argtypes=[c_void_p]
904
891
  GetDllLibXls().XlsRange_get_TimeSpanValue.restype=c_void_p
@@ -916,21 +903,18 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
916
903
 
917
904
  def Value(self)->str:
918
905
  """
919
- <summary>
920
- Returns or sets the value of the specified range.
921
- <example>The following code illustrates how to set Value of the specified range:
922
- <code>
923
- //Create worksheet
924
- Workbook workbook = new Workbook();
925
- Worksheet worksheet = workbook.Worksheets[0];
926
- //Set value of the range
927
- XlsRange range= worksheet.Range[3, 1];
928
- range.Value = "1/1/2015";
929
- //Save to file
930
- workbook.SaveToFile("Value.xlsx");
931
- </code>
932
- </example>
933
- </summary>
906
+ Returns or sets the value of the specified range.
907
+ Example::
908
+
909
+ #Create worksheet
910
+ workbook = Workbook()
911
+ worksheet = workbook.Worksheets[0]
912
+ #Set value of the range
913
+ XlsRange range= worksheet.Range[3, 1]
914
+ range.Value = "1/1/2015"
915
+ #Save to file
916
+ workbook.SaveToFile("Value.xlsx")
917
+
934
918
  """
935
919
  GetDllLibXls().XlsRange_get_Value.argtypes=[c_void_p]
936
920
  GetDllLibXls().XlsRange_get_Value.restype=c_void_p
@@ -946,23 +930,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
946
930
  @property
947
931
  def Value2(self)->'SpireObject':
948
932
  """
949
- <summary>
950
- Returns or sets the cell value.
951
- It's not use for current and datetime types.
952
- <example>The following code illustrates how to access Value2 property of the Range:
953
- <code>
954
- //Create worksheet
955
- Workbook workbook = new Workbook();
956
- Worksheet worksheet = workbook.Worksheets[0];
957
- //Assigning Value2 property of the Range
958
- worksheet["A1"].Value2 = DateTime.Now;
959
- worksheet["A3"].Value2 = false;
960
- //Checking Range types
961
- Console.WriteLine(worksheet["A1"].HasDateTime);
962
- Console.WriteLine(worksheet["A3"].HasBoolean);
963
- </code>
964
- </example>
965
- </summary>
933
+ Returns or sets the cell value. It's not use for current and datetime types.
934
+ Example::
935
+
936
+ #Create worksheet
937
+ workbook = Workbook()
938
+ worksheet = workbook.Worksheets[0]
939
+ #Assigning Value2 property of the Range
940
+ worksheet["A1"].Value2 = DateTime.Now
941
+ worksheet["A3"].Value2 = false
942
+ #Checking Range types
943
+ print(worksheet["A1"].HasDateTime)
944
+ print(worksheet["A3"].HasBoolean)
945
+
966
946
  """
967
947
  GetDllLibXls().XlsRange_get_Value2.argtypes=[c_void_p]
968
948
  GetDllLibXls().XlsRange_get_Value2.restype=c_void_p
@@ -980,22 +960,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
980
960
 
981
961
  def VerticalAlignment(self)->'VerticalAlignType':
982
962
  """
983
- <summary>
984
- Returns or sets the vertical alignment of the specified object.
985
- <example>The following code illustrates how to set vertical alignment type:
986
- <code>
987
- //Create worksheet
988
- Workbook workbook = new Workbook();
989
- Worksheet worksheet = workbook.Worksheets[0];
990
- //Set text
991
- worksheet["A1"].Text = "Test";
992
- //Set alignment
993
- worksheet["A1"].VerticalAlignment = VerticalAlignType.Top;
994
- //Save to file
995
- workbook.SaveToFile("VerticalAlignment.xlsx");
996
- </code>
997
- </example>
998
- </summary>
963
+ Returns or sets the vertical alignment of the specified object.
964
+ Example::
965
+
966
+ #Create worksheet
967
+ workbook = Workbook()
968
+ worksheet = workbook.Worksheets[0]
969
+ #Set text
970
+ worksheet["A1"].Text = "Test"
971
+ #Set alignment
972
+ worksheet["A1"].VerticalAlignment = VerticalAlignType.Top
973
+ #Save to file
974
+ workbook.SaveToFile("VerticalAlignment.xlsx")
975
+
999
976
  """
1000
977
  GetDllLibXls().XlsRange_get_VerticalAlignment.argtypes=[c_void_p]
1001
978
  GetDllLibXls().XlsRange_get_VerticalAlignment.restype=c_int
@@ -1012,11 +989,10 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1012
989
 
1013
990
  def Worksheet(self)->'IWorksheet':
1014
991
  """
1015
- <summary>
1016
- Returns a worksheet object that represents the worksheet
1017
- containing the specified range.
1018
- </summary>
992
+ Returns a worksheet object that represents the worksheet containing the specified range.
993
+
1019
994
  """
995
+ from spire.xls.XlsWorksheet import XlsWorksheet
1020
996
  GetDllLibXls().XlsRange_get_Worksheet.argtypes=[c_void_p]
1021
997
  GetDllLibXls().XlsRange_get_Worksheet.restype=c_void_p
1022
998
  intPtr = CallCFunction(GetDllLibXls().XlsRange_get_Worksheet, self.Ptr)
@@ -1058,9 +1034,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1058
1034
 
1059
1035
  def ClearConditionalFormats(self):
1060
1036
  """
1061
- <summary>
1062
1037
  Clears conditional formats.
1063
- </summary>
1038
+
1064
1039
  """
1065
1040
  GetDllLibXls().XlsRange_ClearConditionalFormats.argtypes=[c_void_p]
1066
1041
  CallCFunction(GetDllLibXls().XlsRange_ClearConditionalFormats, self.Ptr)
@@ -1068,24 +1043,26 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1068
1043
 
1069
1044
  def GetRectangles(self)->List['Rectangle']:
1070
1045
  """
1071
- <summary>
1072
1046
  Gets rectangle information of current range.
1073
- </summary>
1074
- <returns>Rectangles information</returns>
1047
+
1048
+ Returns:
1049
+ Rectangles information
1050
+
1075
1051
  """
1076
1052
  GetDllLibXls().XlsRange_GetRectangles.argtypes=[c_void_p]
1077
1053
  GetDllLibXls().XlsRange_GetRectangles.restype=IntPtrArray
1078
1054
  intPtrArray = CallCFunction(GetDllLibXls().XlsRange_GetRectangles, self.Ptr)
1079
- ret = GetVectorFromArray(intPtrArray, Rectangle)
1055
+ ret = GetObjVectorFromArray(intPtrArray, Rectangle)
1080
1056
  return ret
1081
1057
 
1082
1058
 
1083
1059
  def GetRectanglesCount(self)->int:
1084
1060
  """
1085
- <summary>
1086
1061
  Returns number of rectangles..
1087
- </summary>
1088
- <returns>Number of rectangles.</returns>
1062
+
1063
+ Returns:
1064
+ Number of rectangles.
1065
+
1089
1066
  """
1090
1067
  GetDllLibXls().XlsRange_GetRectanglesCount.argtypes=[c_void_p]
1091
1068
  GetDllLibXls().XlsRange_GetRectanglesCount.restype=c_int
@@ -1096,9 +1073,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1096
1073
 
1097
1074
  def WorksheetName(self)->str:
1098
1075
  """
1099
- <summary>
1100
1076
  Returns name of the parent worksheet.
1101
- </summary>
1077
+
1102
1078
  """
1103
1079
  GetDllLibXls().XlsRange_get_WorksheetName.argtypes=[c_void_p]
1104
1080
  GetDllLibXls().XlsRange_get_WorksheetName.restype=c_void_p
@@ -1109,9 +1085,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1109
1085
  @property
1110
1086
  def CellsCount(self)->int:
1111
1087
  """
1112
- <summary>
1113
1088
  Gets number of cells.
1114
- </summary>
1089
+
1115
1090
  """
1116
1091
  GetDllLibXls().XlsRange_get_CellsCount.argtypes=[c_void_p]
1117
1092
  GetDllLibXls().XlsRange_get_CellsCount.restype=c_int
@@ -1122,9 +1097,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1122
1097
 
1123
1098
  def RangeGlobalAddress2007(self)->str:
1124
1099
  """
1125
- <summary>
1126
1100
  Gets address global in the format required by Excel 2007.
1127
- </summary>
1101
+
1128
1102
  """
1129
1103
  GetDllLibXls().XlsRange_get_RangeGlobalAddress2007.argtypes=[c_void_p]
1130
1104
  GetDllLibXls().XlsRange_get_RangeGlobalAddress2007.restype=c_void_p
@@ -1134,9 +1108,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1134
1108
 
1135
1109
  def CalculateAllValue(self):
1136
1110
  """
1137
- <summary>
1138
1111
  Caculate all formula for the specified range
1139
- </summary>
1112
+
1140
1113
  """
1141
1114
  GetDllLibXls().XlsRange_CalculateAllValue.argtypes=[c_void_p]
1142
1115
  CallCFunction(GetDllLibXls().XlsRange_CalculateAllValue, self.Ptr)
@@ -1145,23 +1118,23 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1145
1118
 
1146
1119
  def Activate(self ,scroll:bool)->IXLSRange:
1147
1120
  """
1148
- <summary>
1149
- Activates a single cell, scroll to it and activates the corresponding sheet.
1150
- To select a range of cells, use the Select method.
1151
- <example>The following code illustrates how to activate a Range with scroll flag:
1152
- <code>
1153
- //Create worksheet
1154
- Workbook workbook = new Workbook();
1155
- Worksheet worksheet = workbook.Worksheets[0];
1156
- //Activates 'F1' cell.
1157
- worksheet.Range["F1"].Activate(true);
1158
- //Save to file
1159
- workbook.SaveToFile("Activate.xlsx");
1160
- </code>
1161
- </example>
1162
- </summary>
1163
- <param name="scroll">True to scroll to the cell</param>
1164
- <returns>Returns the active cell.</returns>
1121
+ Activates a single cell, scroll to it and activates the corresponding sheet. To select a range of cells, use the Select method.
1122
+
1123
+ Args:
1124
+ scroll: True to scroll to the cell
1125
+
1126
+ Returns:
1127
+ Returns the active cell.
1128
+ Example::
1129
+
1130
+ #Create worksheet
1131
+ workbook = Workbook()
1132
+ worksheet = workbook.Worksheets[0]
1133
+ #Activates 'F1' cell.
1134
+ worksheet.Range["F1"].Activate(true)
1135
+ #Save to file
1136
+ workbook.SaveToFile("Activate.xlsx")
1137
+
1165
1138
  """
1166
1139
 
1167
1140
  GetDllLibXls().XlsRange_Activate.argtypes=[c_void_p ,c_bool]
@@ -1175,10 +1148,11 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1175
1148
 
1176
1149
  def Activate(self)->IXLSRange:
1177
1150
  """
1178
- <summary>
1179
1151
  Active single cell in the worksheet
1180
- </summary>
1181
- <returns>Returns the active cell.</returns>
1152
+
1153
+ Returns:
1154
+ Returns the active cell.
1155
+
1182
1156
  """
1183
1157
  GetDllLibXls().XlsRange_Activate1.argtypes=[c_void_p]
1184
1158
  GetDllLibXls().XlsRange_Activate1.restype=c_void_p
@@ -1191,11 +1165,13 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1191
1165
 
1192
1166
  def AddComment(self)->ICommentShape:
1193
1167
  """
1194
- <summary>
1195
1168
  Adds a comment to the range.
1196
- </summary>
1197
- <returns>Created comment or exists one.</returns>
1169
+
1170
+ Returns:
1171
+ Created comment or exists one.
1172
+
1198
1173
  """
1174
+ from spire.xls.XlsComment import XlsComment
1199
1175
  GetDllLibXls().XlsRange_AddComment1.argtypes=[c_void_p]
1200
1176
  GetDllLibXls().XlsRange_AddComment1.restype=c_void_p
1201
1177
  intPtr = CallCFunction(GetDllLibXls().XlsRange_AddComment1, self.Ptr)
@@ -1205,43 +1181,37 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1205
1181
 
1206
1182
  def AutoFitColumns(self):
1207
1183
  """
1208
- <summary>
1209
- Changes the width of the columns in the range in the range to achieve the best fit.
1210
- <example>The following code illustrates how to auto-size column width to its cell content:
1211
- <code>
1212
- //Create worksheet
1213
- Workbook workbook = new Workbook();
1214
- Worksheet worksheet = workbook.Worksheets[0];
1215
- //Auto-fit columns
1216
- worksheet.Range["B4"].Text = "Fit the content to column";
1217
- worksheet.Range["B4"].AutoFitColumns();
1218
- //Save to file
1219
- workbook.SaveToFile("AutoFitRows.xlsx");
1220
- </code>
1221
- </example>
1222
- </summary>
1184
+ Changes the width of the columns in the range in the range to achieve the best fit.
1185
+ Example::
1186
+
1187
+ #Create worksheet
1188
+ workbook = Workbook()
1189
+ worksheet = workbook.Worksheets[0]
1190
+ #Auto-fit columns
1191
+ worksheet.Range["B4"].Text = "Fit the content to column"
1192
+ worksheet.Range["B4"].AutoFitColumns()
1193
+ #Save to file
1194
+ workbook.SaveToFile("AutoFitRows.xlsx")
1195
+
1223
1196
  """
1224
1197
  GetDllLibXls().XlsRange_AutoFitColumns.argtypes=[c_void_p]
1225
1198
  CallCFunction(GetDllLibXls().XlsRange_AutoFitColumns, self.Ptr)
1226
1199
 
1227
1200
  def AutoFitRows(self):
1228
1201
  """
1229
- <summary>
1230
- Changes the width of the height of the rows in the range to achieve the best fit.
1231
- <example>The following code illustrates how to auto-size row height to its cell content:
1232
- <code>
1233
- //Create worksheet
1234
- Workbook workbook = new Workbook();
1235
- Worksheet worksheet = workbook.Worksheets[0];
1236
- //Auto-fit rows
1237
- worksheet.Range["A2"].Text = "Fit the content to row";
1238
- worksheet.Range["A2"].IsWrapText = true;
1239
- worksheet.Range["A2"].AutoFitRows();
1240
- //Save to file
1241
- workbook.SaveToFile("AutoFitRows.xlsx");
1242
- </code>
1243
- </example>
1244
- </summary>
1202
+ Changes the width of the height of the rows in the range to achieve the best fit.
1203
+ Example::
1204
+
1205
+ #Create worksheet
1206
+ workbook = Workbook()
1207
+ worksheet = workbook.Worksheets[0]
1208
+ #Auto-fit rows
1209
+ worksheet.Range["A2"].Text = "Fit the content to row"
1210
+ worksheet.Range["A2"].IsWrapText = true
1211
+ worksheet.Range["A2"].AutoFitRows()
1212
+ #Save to file
1213
+ workbook.SaveToFile("AutoFitRows.xlsx")
1214
+
1245
1215
  """
1246
1216
  GetDllLibXls().XlsRange_AutoFitRows.argtypes=[c_void_p]
1247
1217
  CallCFunction(GetDllLibXls().XlsRange_AutoFitRows, self.Ptr)
@@ -1249,25 +1219,22 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1249
1219
  @dispatch
1250
1220
  def BorderAround(self):
1251
1221
  """
1252
- <summary>
1253
- Sets around border for current range.
1254
- <example>The following code illustrates how to apply border around the Range:
1255
- <code>
1256
- //Create worksheet
1257
- Workbook workbook = new Workbook();
1258
- Worksheet worksheet = workbook.Worksheets[0];
1259
- //Set text
1260
- worksheet["C2"].Text = "Sample";
1261
- worksheet["D2"].Text = "text";
1262
- worksheet["C3"].Text = "in";
1263
- worksheet["D3"].Text = "cell";
1264
- //Set border
1265
- worksheet["C2:D3"].BorderAround();
1266
- //Save to file
1267
- workbook.SaveToFile("BorderAround.xlsx");
1268
- </code>
1269
- </example>
1270
- </summary>
1222
+ Sets around border for current range.
1223
+ Example::
1224
+
1225
+ #Create worksheet
1226
+ workbook = Workbook()
1227
+ worksheet = workbook.Worksheets[0]
1228
+ #Set text
1229
+ worksheet["C2"].Text = "Sample"
1230
+ worksheet["D2"].Text = "text"
1231
+ worksheet["C3"].Text = "in"
1232
+ worksheet["D3"].Text = "cell"
1233
+ #Set border
1234
+ worksheet["C2:D3"].BorderAround()
1235
+ #Save to file
1236
+ workbook.SaveToFile("BorderAround.xlsx")
1237
+
1271
1238
  """
1272
1239
  GetDllLibXls().XlsRange_BorderAround.argtypes=[c_void_p]
1273
1240
  CallCFunction(GetDllLibXls().XlsRange_BorderAround, self.Ptr)
@@ -1276,26 +1243,25 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1276
1243
 
1277
1244
  def BorderAround(self ,borderLine:LineStyleType):
1278
1245
  """
1279
- <summary>
1280
- Sets around border for current range.
1281
- <example>The following code illustrates how to apply border around the Range:
1282
- <code>
1283
- //Create worksheet
1284
- Workbook workbook = new Workbook();
1285
- Worksheet worksheet = workbook.Worksheets[0];
1286
- //Set text
1287
- worksheet["C2"].Text = "Sample";
1288
- worksheet["D2"].Text = "text";
1289
- worksheet["C3"].Text = "in";
1290
- worksheet["D3"].Text = "cell";
1291
- //Set border
1292
- worksheet["C2:D3"].BorderAround(LineStyleType.Thick);
1293
- //Save to file
1294
- workbook.SaveToFile("BorderAround.xlsx");
1295
- </code>
1296
- </example>
1297
- </summary>
1298
- <param name="borderLine">Represents border line.</param>
1246
+ Sets around border for current range.
1247
+
1248
+ Args:
1249
+ borderLine: Represents border line.
1250
+ Example::
1251
+
1252
+ #Create worksheet
1253
+ workbook = Workbook()
1254
+ worksheet = workbook.Worksheets[0]
1255
+ #Set text
1256
+ worksheet["C2"].Text = "Sample"
1257
+ worksheet["D2"].Text = "text"
1258
+ worksheet["C3"].Text = "in"
1259
+ worksheet["D3"].Text = "cell"
1260
+ #Set border
1261
+ worksheet["C2:D3"].BorderAround(LineStyleType.Thick)
1262
+ #Save to file
1263
+ workbook.SaveToFile("BorderAround.xlsx")
1264
+
1299
1265
  """
1300
1266
  enumborderLine:c_int = borderLine.value
1301
1267
 
@@ -1306,27 +1272,26 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1306
1272
 
1307
1273
  def BorderAround(self ,borderLine:LineStyleType,borderColor:Color):
1308
1274
  """
1309
- <summary>
1310
- Sets around border for current range.
1311
- <example>The following code illustrates how to apply border around the Range with color from System.Drawing.Color structure:
1312
- <code>
1313
- //Create worksheet
1314
- Workbook workbook = new Workbook();
1315
- Worksheet worksheet = workbook.Worksheets[0];
1316
- //Set text
1317
- worksheet["C2"].Text = "Sample";
1318
- worksheet["D2"].Text = "text";
1319
- worksheet["C3"].Text = "in";
1320
- worksheet["D3"].Text = "cell";
1321
- //Set border
1322
- worksheet["C2:D3"].BorderAround(LineStyleType.Thick , Color.Red);
1323
- //Save to file
1324
- workbook.SaveToFile("BorderAround.xlsx");
1325
- </code>
1326
- </example>
1327
- </summary>
1328
- <param name="borderLine">Represents border line.</param>
1329
- <param name="borderColor">Represents border color.</param>
1275
+ Sets around border for current range.
1276
+
1277
+ Args:
1278
+ borderLine: Represents border line.
1279
+ borderColor: Represents border color.
1280
+ Example::
1281
+
1282
+ #Create worksheet
1283
+ workbook = Workbook()
1284
+ worksheet = workbook.Worksheets[0]
1285
+ #Set text
1286
+ worksheet["C2"].Text = "Sample"
1287
+ worksheet["D2"].Text = "text"
1288
+ worksheet["C3"].Text = "in"
1289
+ worksheet["D3"].Text = "cell"
1290
+ #Set border
1291
+ worksheet["C2:D3"].BorderAround(LineStyleType.Thick , Color.Red)
1292
+ #Save to file
1293
+ workbook.SaveToFile("BorderAround.xlsx")
1294
+
1330
1295
  """
1331
1296
  enumborderLine:c_int = borderLine.value
1332
1297
  intPtrborderColor:c_void_p = borderColor.Ptr
@@ -1338,27 +1303,26 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1338
1303
 
1339
1304
  def BorderAround(self ,borderLine:LineStyleType,borderColor:ExcelColors):
1340
1305
  """
1341
- <summary>
1342
- Sets around border for current range.
1343
- <example>The following code illustrates how to apply border around the Range with color from Spire.Xls.ExcelColors structure:
1344
- <code>
1345
- //Create worksheet
1346
- Workbook workbook = new Workbook();
1347
- Worksheet worksheet = workbook.Worksheets[0];
1348
- //Set text
1349
- worksheet["C2"].Text = "Sample";
1350
- worksheet["D2"].Text = "text";
1351
- worksheet["C3"].Text = "in";
1352
- worksheet["D3"].Text = "cell";
1353
- //Set border
1354
- worksheet["C2:D3"].BorderAround(LineStyleType.Thick , ExcelColors.Red);
1355
- //Save to file
1356
- workbook.SaveToFile("BorderAround.xlsx");
1357
- </code>
1358
- </example>
1359
- </summary>
1360
- <param name="borderLine">Represents border line.</param>
1361
- <param name="borderColor">Represents border color as ExcelColors.</param>
1306
+ Sets around border for current range.
1307
+
1308
+ Args:
1309
+ borderLine: Represents border line.
1310
+ borderColor: Represents border color as ExcelColors.
1311
+ Example::
1312
+
1313
+ #Create worksheet
1314
+ workbook = Workbook()
1315
+ worksheet = workbook.Worksheets[0]
1316
+ #Set text
1317
+ worksheet["C2"].Text = "Sample"
1318
+ worksheet["D2"].Text = "text"
1319
+ worksheet["C3"].Text = "in"
1320
+ worksheet["D3"].Text = "cell"
1321
+ #Set border
1322
+ worksheet["C2:D3"].BorderAround(LineStyleType.Thick , ExcelColors.Red)
1323
+ #Save to file
1324
+ workbook.SaveToFile("BorderAround.xlsx")
1325
+
1362
1326
  """
1363
1327
  enumborderLine:c_int = borderLine.value
1364
1328
  enumborderColor:c_int = borderColor.value
@@ -1369,25 +1333,22 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1369
1333
  @dispatch
1370
1334
  def BorderInside(self):
1371
1335
  """
1372
- <summary>
1373
- Sets inside border for current range.
1374
- <example>The following code illustrates how to apply border inside the Range:
1375
- <code>
1376
- //Create worksheet
1377
- Workbook workbook = new Workbook();
1378
- Worksheet worksheet = workbook.Worksheets[0];
1379
- //Set text
1380
- worksheet["C2"].Text = "Sample";
1381
- worksheet["D2"].Text = "text";
1382
- worksheet["C3"].Text = "in";
1383
- worksheet["D3"].Text = "cell";
1384
- //Set border
1385
- worksheet["C2:D3"].BorderInside();
1386
- //Save to file
1387
- workbook.SaveToFile("BorderInside.xlsx");
1388
- </code>
1389
- </example>
1390
- </summary>
1336
+ Sets inside border for current range.
1337
+ Example::
1338
+
1339
+ #Create worksheet
1340
+ workbook = Workbook()
1341
+ worksheet = workbook.Worksheets[0]
1342
+ #Set text
1343
+ worksheet["C2"].Text = "Sample"
1344
+ worksheet["D2"].Text = "text"
1345
+ worksheet["C3"].Text = "in"
1346
+ worksheet["D3"].Text = "cell"
1347
+ #Set border
1348
+ worksheet["C2:D3"].BorderInside()
1349
+ #Save to file
1350
+ workbook.SaveToFile("BorderInside.xlsx")
1351
+
1391
1352
  """
1392
1353
  GetDllLibXls().XlsRange_BorderInside.argtypes=[c_void_p]
1393
1354
  CallCFunction(GetDllLibXls().XlsRange_BorderInside, self.Ptr)
@@ -1396,26 +1357,25 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1396
1357
 
1397
1358
  def BorderInside(self ,borderLine:LineStyleType):
1398
1359
  """
1399
- <summary>
1400
- Sets inside border for current range.
1401
- <example>The following code illustrates how to apply border inside the Range:
1402
- <code>
1403
- //Create worksheet
1404
- Workbook workbook = new Workbook();
1405
- Worksheet worksheet = workbook.Worksheets[0];
1406
- //Set text
1407
- worksheet["C2"].Text = "Sample";
1408
- worksheet["D2"].Text = "text";
1409
- worksheet["C3"].Text = "in";
1410
- worksheet["D3"].Text = "cell";
1411
- //Set border
1412
- worksheet["C2:D3"].BorderInside(LineStyleType.Thick);
1413
- //Save to file
1414
- workbook.SaveToFile("BorderInside.xlsx");
1415
- </code>
1416
- </example>
1417
- </summary>
1418
- <param name="borderLine">Represents border line.</param>
1360
+ Sets inside border for current range.
1361
+
1362
+ Args:
1363
+ borderLine: Represents border line.
1364
+ Example::
1365
+
1366
+ #Create worksheet
1367
+ workbook = Workbook()
1368
+ worksheet = workbook.Worksheets[0]
1369
+ #Set text
1370
+ worksheet["C2"].Text = "Sample"
1371
+ worksheet["D2"].Text = "text"
1372
+ worksheet["C3"].Text = "in"
1373
+ worksheet["D3"].Text = "cell"
1374
+ #Set border
1375
+ worksheet["C2:D3"].BorderInside(LineStyleType.Thick)
1376
+ #Save to file
1377
+ workbook.SaveToFile("BorderInside.xlsx")
1378
+
1419
1379
  """
1420
1380
  enumborderLine:c_int = borderLine.value
1421
1381
 
@@ -1426,27 +1386,26 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1426
1386
 
1427
1387
  def BorderInside(self ,borderLine:LineStyleType,borderColor:Color):
1428
1388
  """
1429
- <summary>
1430
- Sets inside border for current range.
1431
- <example>The following code illustrates how to apply border inside the Range with color from System.Drawing.Color structure:
1432
- <code>
1433
- //Create worksheet
1434
- Workbook workbook = new Workbook();
1435
- Worksheet worksheet = workbook.Worksheets[0];
1436
- //Set text
1437
- worksheet["C2"].Text = "Sample";
1438
- worksheet["D2"].Text = "text";
1439
- worksheet["C3"].Text = "in";
1440
- worksheet["D3"].Text = "cell";
1441
- //Set border
1442
- worksheet["C2:D3"].BorderInside(LineStyleType.Thick , Color.Red);
1443
- //Save to file
1444
- workbook.SaveToFile("BorderInside.xlsx");
1445
- </code>
1446
- </example>
1447
- </summary>
1448
- <param name="borderLine">Represents border line.</param>
1449
- <param name="borderColor">Represents border color.</param>
1389
+ Sets inside border for current range.
1390
+
1391
+ Args:
1392
+ borderLine: Represents border line.
1393
+ borderColor: Represents border color.
1394
+ Example::
1395
+
1396
+ #Create worksheet
1397
+ workbook = Workbook()
1398
+ worksheet = workbook.Worksheets[0]
1399
+ #Set text
1400
+ worksheet["C2"].Text = "Sample"
1401
+ worksheet["D2"].Text = "text"
1402
+ worksheet["C3"].Text = "in"
1403
+ worksheet["D3"].Text = "cell"
1404
+ #Set border
1405
+ worksheet["C2:D3"].BorderInside(LineStyleType.Thick , Color.Red)
1406
+ #Save to file
1407
+ workbook.SaveToFile("BorderInside.xlsx")
1408
+
1450
1409
  """
1451
1410
  enumborderLine:c_int = borderLine.value
1452
1411
  intPtrborderColor:c_void_p = borderColor.Ptr
@@ -1458,27 +1417,26 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1458
1417
 
1459
1418
  def BorderInside(self ,borderLine:LineStyleType,borderColor:ExcelColors):
1460
1419
  """
1461
- <summary>
1462
- Sets inside border for current range.
1463
- <example>The following code illustrates how to apply border inside the Range with color from Spire.Xls.ExcelColors structure:
1464
- <code>
1465
- //Create worksheet
1466
- Workbook workbook = new Workbook();
1467
- Worksheet worksheet = workbook.Worksheets[0];
1468
- //Set text
1469
- worksheet["C2"].Text = "Sample";
1470
- worksheet["D2"].Text = "text";
1471
- worksheet["C3"].Text = "in";
1472
- worksheet["D3"].Text = "cell";
1473
- //Set border
1474
- worksheet["C2:D3"].BorderInside(LineStyleType.Thick , ExcelColors.Red);
1475
- //Save to file
1476
- workbook.SaveToFile("BorderInside.xlsx");
1477
- </code>
1478
- </example>
1479
- </summary>
1480
- <param name="borderLine">Represents border line.</param>
1481
- <param name="borderColor">Represents border color as ExcelColors.</param>
1420
+ Sets inside border for current range.
1421
+
1422
+ Args:
1423
+ borderLine: Represents border line.
1424
+ borderColor: Represents border color as ExcelColors.
1425
+ Example::
1426
+
1427
+ #Create worksheet
1428
+ workbook = Workbook()
1429
+ worksheet = workbook.Worksheets[0]
1430
+ #Set text
1431
+ worksheet["C2"].Text = "Sample"
1432
+ worksheet["D2"].Text = "text"
1433
+ worksheet["C3"].Text = "in"
1434
+ worksheet["D3"].Text = "cell"
1435
+ #Set border
1436
+ worksheet["C2:D3"].BorderInside(LineStyleType.Thick , ExcelColors.Red)
1437
+ #Save to file
1438
+ workbook.SaveToFile("BorderInside.xlsx")
1439
+
1482
1440
  """
1483
1441
  enumborderLine:c_int = borderLine.value
1484
1442
  enumborderColor:c_int = borderColor.value
@@ -1488,21 +1446,18 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1488
1446
 
1489
1447
  def BorderNone(self):
1490
1448
  """
1491
- <summary>
1492
- Sets none border for current range.
1493
- <example>The following code illustrates how to remove borders in the Range:
1494
- <code>
1495
- //Create worksheet
1496
- Workbook workbook = new Workbook();
1497
- workbook.LoadFromFile("Sample.xlsx");
1498
- Worksheet worksheet = workbook.Worksheets[0];
1499
- //Remove borders
1500
- worksheet["C2"].BorderNone();
1501
- //Save to file
1502
- workbook.SaveToFile("BorderNone.xlsx");
1503
- </code>
1504
- </example>
1505
- </summary>
1449
+ Sets none border for current range.
1450
+ Example::
1451
+
1452
+ #Create worksheet
1453
+ workbook = Workbook()
1454
+ workbook.LoadFromFile("Sample.xlsx")
1455
+ worksheet = workbook.Worksheets[0]
1456
+ #Remove borders
1457
+ worksheet["C2"].BorderNone()
1458
+ #Save to file
1459
+ workbook.SaveToFile("BorderNone.xlsx")
1460
+
1506
1461
  """
1507
1462
  GetDllLibXls().XlsRange_BorderNone.argtypes=[c_void_p]
1508
1463
  CallCFunction(GetDllLibXls().XlsRange_BorderNone, self.Ptr)
@@ -1510,22 +1465,21 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1510
1465
 
1511
1466
  def Clear(self ,option:'ExcelClearOptions'):
1512
1467
  """
1513
- <summary>
1514
- Clears the cell based on clear options.
1515
- <example>The following code illustrates how to clear the Range with clear options:
1516
- <code>
1517
- //Create worksheet
1518
- Workbook workbook = new Workbook();
1519
- workbook.LoadFromFile("Sample.xlsx");
1520
- Worksheet worksheet = workbook.Worksheets[0];
1521
- //Clears the Range C2 with its clear options
1522
- worksheet.Range["C2"].Clear(ExcelClearOptions.ClearAll);
1523
- //Save to file
1524
- workbook.SaveToFile("ClearContents.xlsx");
1525
- </code>
1526
- </example>
1527
- </summary>
1528
- <param name="option">Represents the clear options.</param>
1468
+ Clears the cell based on clear options.
1469
+
1470
+ Args:
1471
+ option: Represents the clear options.
1472
+ Example::
1473
+
1474
+ #Create worksheet
1475
+ workbook = Workbook()
1476
+ workbook.LoadFromFile("Sample.xlsx")
1477
+ worksheet = workbook.Worksheets[0]
1478
+ #Clears the Range C2 with its clear options
1479
+ worksheet.Range["C2"].Clear(ExcelClearOptions.ClearAll)
1480
+ #Save to file
1481
+ workbook.SaveToFile("ClearContents.xlsx")
1482
+
1529
1483
  """
1530
1484
  enumoption:c_int = option.value
1531
1485
 
@@ -1534,30 +1488,26 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1534
1488
 
1535
1489
  def ClearAll(self):
1536
1490
  """
1537
- <summary>
1538
1491
  Clears the entire object.
1539
- </summary>
1492
+
1540
1493
  """
1541
1494
  GetDllLibXls().XlsRange_ClearAll.argtypes=[c_void_p]
1542
1495
  CallCFunction(GetDllLibXls().XlsRange_ClearAll, self.Ptr)
1543
1496
 
1544
1497
  def ClearContents(self):
1545
1498
  """
1546
- <summary>
1547
- Clear the contents of the Range.
1548
- <example>The following code illustrates how to clear the Range:
1549
- <code>
1550
- //Create worksheet
1551
- Workbook workbook = new Workbook();
1552
- workbook.LoadFromFile("Sample.xlsx");
1553
- Worksheet worksheet = workbook.Worksheets[0];
1554
- //Clears the Range C2
1555
- worksheet.Range["C2"].ClearContents();
1556
- //Save to file
1557
- workbook.SaveToFile("ClearContents.xlsx");
1558
- </code>
1559
- </example>
1560
- </summary>
1499
+ Clear the contents of the Range.
1500
+ Example::
1501
+
1502
+ #Create worksheet
1503
+ workbook = Workbook()
1504
+ workbook.LoadFromFile("Sample.xlsx")
1505
+ worksheet = workbook.Worksheets[0]
1506
+ #Clears the Range C2
1507
+ worksheet.Range["C2"].ClearContents()
1508
+ #Save to file
1509
+ workbook.SaveToFile("ClearContents.xlsx")
1510
+
1561
1511
  """
1562
1512
  GetDllLibXls().XlsRange_ClearContents.argtypes=[c_void_p]
1563
1513
  CallCFunction(GetDllLibXls().XlsRange_ClearContents, self.Ptr)
@@ -1565,11 +1515,11 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1565
1515
 
1566
1516
  def GroupByColumns(self ,isCollapsed:bool)->'XlsRange':
1567
1517
  """
1568
- <summary>
1569
- Groups columns.
1570
- </summary>
1571
- <param name="isCollapsed">Indicates whether group should be collapsed.</param>
1572
- <returns></returns>
1518
+ Groups columns.
1519
+
1520
+ Args:
1521
+ isCollapsed: Indicates whether group should be collapsed.
1522
+
1573
1523
  """
1574
1524
 
1575
1525
  GetDllLibXls().XlsRange_GroupByColumns.argtypes=[c_void_p ,c_bool]
@@ -1582,11 +1532,11 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1582
1532
 
1583
1533
  def GroupByRows(self ,isCollapsed:bool)->'XlsRange':
1584
1534
  """
1585
- <summary>
1586
- Groups row.
1587
- </summary>
1588
- <param name="isCollapsed">Indicates whether group should be collapsed.</param>
1589
- <returns></returns>
1535
+ Groups row.
1536
+
1537
+ Args:
1538
+ isCollapsed: Indicates whether group should be collapsed.
1539
+
1590
1540
  """
1591
1541
 
1592
1542
  GetDllLibXls().XlsRange_GroupByRows.argtypes=[c_void_p ,c_bool]
@@ -1599,10 +1549,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1599
1549
 
1600
1550
  def UngroupByColumns(self)->'XlsRange':
1601
1551
  """
1602
- <summary>
1603
1552
  Ungroups column.
1604
- </summary>
1605
- <returns></returns>
1553
+
1606
1554
  """
1607
1555
  GetDllLibXls().XlsRange_UngroupByColumns.argtypes=[c_void_p]
1608
1556
  GetDllLibXls().XlsRange_UngroupByColumns.restype=c_void_p
@@ -1614,10 +1562,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1614
1562
 
1615
1563
  def UngroupByRows(self)->'XlsRange':
1616
1564
  """
1617
- <summary>
1618
1565
  Ungroups row.
1619
- </summary>
1620
- <returns></returns>
1566
+
1621
1567
  """
1622
1568
  GetDllLibXls().XlsRange_UngroupByRows.argtypes=[c_void_p]
1623
1569
  GetDllLibXls().XlsRange_UngroupByRows.restype=c_void_p
@@ -1629,24 +1575,21 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1629
1575
 
1630
1576
  def CollapseGroup(self ,groupBy:'GroupByType'):
1631
1577
  """
1632
- <summary>
1633
- Collapses current group.
1634
- <example>The following code illustrates how to remove borders in the Range:
1635
- <code>
1636
- //Create worksheet
1637
- Workbook workbook = new Workbook();
1638
- workbook.LoadFromFile("Sample.xlsx");
1639
- Worksheet worksheet = workbook.Worksheets[0];
1640
- //Collapse group
1641
- worksheet.Range["A5:A15"].CollapseGroup(GroupByType.ByRows);
1642
- //Save to file
1643
- workbook.SaveToFile("CollapseGroup.xlsx");
1644
- </code>
1645
- </example>
1646
- </summary>
1647
- <param name="groupBy">
1648
- This parameter specifies whether the grouping should be performed by rows or by columns.
1649
- </param>
1578
+ Collapses current group.
1579
+
1580
+ Args:
1581
+ groupBy:
1582
+ Example::
1583
+
1584
+ #Create worksheet
1585
+ workbook = Workbook()
1586
+ workbook.LoadFromFile("Sample.xlsx")
1587
+ worksheet = workbook.Worksheets[0]
1588
+ #Collapse group
1589
+ worksheet.Range["A5:A15"].CollapseGroup(GroupByType.ByRows)
1590
+ #Save to file
1591
+ workbook.SaveToFile("CollapseGroup.xlsx")
1592
+
1650
1593
  """
1651
1594
  enumgroupBy:c_int = groupBy.value
1652
1595
 
@@ -1671,24 +1614,21 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1671
1614
 
1672
1615
  def ExpandGroup(self ,groupBy:GroupByType):
1673
1616
  """
1674
- <summary>
1675
- Expands current group.
1676
- <example>The following code illustrates how to expand the group in the Range:
1677
- <code>
1678
- //Create worksheet
1679
- Workbook workbook = new Workbook();
1680
- workbook.LoadFromFile("Sample.xlsx");
1681
- Worksheet worksheet = workbook.Worksheets[0];
1682
- //Expand group with flag set to expand parent
1683
- worksheet.Range["A5:A15"].ExpandGroup(GroupByType.ByRows);
1684
- //Save to file
1685
- workbook.SaveToFile("ExpandGroup.xlsx");
1686
- </code>
1687
- </example>
1688
- </summary>
1689
- <param name="groupBy">
1690
- This parameter specifies whether the grouping should be performed by rows or by columns.
1691
- </param>
1617
+ Expands current group.
1618
+
1619
+ Args:
1620
+ groupBy:
1621
+ Example::
1622
+
1623
+ #Create worksheet
1624
+ workbook = Workbook()
1625
+ workbook.LoadFromFile("Sample.xlsx")
1626
+ worksheet = workbook.Worksheets[0]
1627
+ #Expand group with flag set to expand parent
1628
+ worksheet.Range["A5:A15"].ExpandGroup(GroupByType.ByRows)
1629
+ #Save to file
1630
+ workbook.SaveToFile("ExpandGroup.xlsx")
1631
+
1692
1632
  """
1693
1633
  enumgroupBy:c_int = groupBy.value
1694
1634
 
@@ -1699,25 +1639,22 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1699
1639
 
1700
1640
  def ExpandGroup(self ,groupBy:GroupByType,flags:ExpandCollapseFlags):
1701
1641
  """
1702
- <summary>
1703
- Expands current group.
1704
- <example>The following code illustrates how to perform ExpandGroup in the Range with collapse option:
1705
- <code>
1706
- //Create worksheet
1707
- Workbook workbook = new Workbook();
1708
- workbook.LoadFromFile("Sample.xlsx");
1709
- Worksheet worksheet = workbook.Worksheets[0];
1710
- //Expand group with flag set to expand parent
1711
- worksheet.Range["A5:A15"].ExpandGroup(GroupByType.ByRows, ExpandCollapseFlags.ExpandParent);
1712
- //Save to file
1713
- workbook.SaveToFile("ExpandGroup.xlsx");
1714
- </code>
1715
- </example>
1716
- </summary>
1717
- <param name="groupBy">
1718
- This parameter specifies whether the grouping should be performed by rows or by columns.
1719
- </param>
1720
- <param name="flags">Additional option flags.</param>
1642
+ Expands current group.
1643
+
1644
+ Args:
1645
+ groupBy:
1646
+ flags: Additional option flags.
1647
+ Example::
1648
+
1649
+ #Create worksheet
1650
+ workbook = Workbook()
1651
+ workbook.LoadFromFile("Sample.xlsx")
1652
+ worksheet = workbook.Worksheets[0]
1653
+ #Expand group with flag set to expand parent
1654
+ worksheet.Range["A5:A15"].ExpandGroup(GroupByType.ByRows, ExpandCollapseFlags.ExpandParent)
1655
+ #Save to file
1656
+ workbook.SaveToFile("ExpandGroup.xlsx")
1657
+
1721
1658
  """
1722
1659
  enumgroupBy:c_int = groupBy.value
1723
1660
  enumflags:c_int = flags.value
@@ -1727,20 +1664,17 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1727
1664
 
1728
1665
  def FreezePanes(self):
1729
1666
  """
1730
- <summary>
1731
- Freezes panes at the current range in the worksheet. current range should be single cell range.
1732
- <example>The following code illustrates how to freeze a pane in the Range:
1733
- <code>
1734
- //Create worksheet
1735
- Workbook workbook = new Workbook();
1736
- Worksheet worksheet = workbook.Worksheets[0];
1737
- //Applying Freeze Pane to the sheet by specifying a cell
1738
- worksheet.Range["B2"].FreezePanes();
1739
- //Save to file
1740
- workbook.SaveToFile("FreezePanes.xlsx");
1741
- </code>
1742
- </example>
1743
- </summary>
1667
+ Freezes panes at the current range in the worksheet. current range should be single cell range.
1668
+ Example::
1669
+
1670
+ #Create worksheet
1671
+ workbook = Workbook()
1672
+ worksheet = workbook.Worksheets[0]
1673
+ #Applying Freeze Pane to the sheet by specifying a cell
1674
+ worksheet.Range["B2"].FreezePanes()
1675
+ #Save to file
1676
+ workbook.SaveToFile("FreezePanes.xlsx")
1677
+
1744
1678
  """
1745
1679
  GetDllLibXls().XlsRange_FreezePanes.argtypes=[c_void_p]
1746
1680
  CallCFunction(GetDllLibXls().XlsRange_FreezePanes, self.Ptr)
@@ -1748,19 +1682,16 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1748
1682
  @property
1749
1683
  def BooleanValue(self)->bool:
1750
1684
  """
1751
- <summary>
1752
- Returns or sets the bool value of the specified range.
1753
- <example>The following code illustrates how to access Boolean property of the Range:
1754
- <code>
1755
- //Create worksheet
1756
- Workbook workbook = new Workbook();
1757
- Worksheet worksheet = workbook.Worksheets[0];
1758
- //Set and get BooleanValue
1759
- worksheet.Range[2, 4].BooleanValue = true;
1760
- bool boolean = worksheet.Range[2, 4].BooleanValue;
1761
- </code>
1762
- </example>
1763
- </summary>
1685
+ Returns or sets the bool value of the specified range.
1686
+ Example::
1687
+
1688
+ #Create worksheet
1689
+ workbook = Workbook()
1690
+ worksheet = workbook.Worksheets[0]
1691
+ #Set and get BooleanValue
1692
+ worksheet.Range[2, 4].BooleanValue = true
1693
+ boolean = worksheet.Range[2, 4].BooleanValue
1694
+
1764
1695
  """
1765
1696
  GetDllLibXls().XlsRange_get_BooleanValue.argtypes=[c_void_p]
1766
1697
  GetDllLibXls().XlsRange_get_BooleanValue.restype=c_bool
@@ -1778,7 +1709,7 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1778
1709
  """
1779
1710
 
1780
1711
  """
1781
- from spire.xls.XlsBordersCollection import XlsBordersCollection
1712
+ from spire.xls.collection.XlsBordersCollection import XlsBordersCollection
1782
1713
  GetDllLibXls().XlsRange_get_Borders.argtypes=[c_void_p]
1783
1714
  GetDllLibXls().XlsRange_get_Borders.restype=c_void_p
1784
1715
  intPtr = CallCFunction(GetDllLibXls().XlsRange_get_Borders, self.Ptr)
@@ -1790,22 +1721,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1790
1721
 
1791
1722
  def BuiltInStyle(self)->BuiltInStyles:
1792
1723
  """
1793
- <summary>
1794
- Gets/sets built in style.
1795
- <example>The following code illustrates how to access BuiltInStyle property:
1796
- <code>
1797
- //Create worksheet
1798
- Workbook workbook = new Workbook();
1799
- Worksheet worksheet = workbook.Worksheets[0];
1800
- //Set text
1801
- worksheet["C2"].Text = "Sample";
1802
- //Set built in style
1803
- worksheet["C2"].BuiltInStyle = BuiltInStyles.Accent3;
1804
- //Save to file
1805
- workbook.SaveToFile("BuiltInStyle.xlsx");
1806
- </code>
1807
- </example>
1808
- </summary>
1724
+ Gets/sets built in style.
1725
+ Example::
1726
+
1727
+ #Create worksheet
1728
+ workbook = Workbook()
1729
+ worksheet = workbook.Worksheets[0]
1730
+ #Set text
1731
+ worksheet["C2"].Text = "Sample"
1732
+ #Set built in style
1733
+ worksheet["C2"].BuiltInStyle = BuiltInStyles.Accent3
1734
+ #Save to file
1735
+ workbook.SaveToFile("BuiltInStyle.xlsx")
1736
+
1809
1737
  """
1810
1738
  GetDllLibXls().XlsRange_get_BuiltInStyle.argtypes=[c_void_p]
1811
1739
  GetDllLibXls().XlsRange_get_BuiltInStyle.restype=c_int
@@ -1852,21 +1780,18 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1852
1780
 
1853
1781
  def CellStyleName(self)->str:
1854
1782
  """
1855
- <summary>
1856
- Gets/sets name of the style for the current range.
1857
- <example>The following code illustrates how to access CellStyleName of the specified range:
1858
- <code>
1859
- //Create worksheet
1860
- Workbook workbook = new Workbook();
1861
- Worksheet worksheet = workbook.Worksheets[0];
1862
- //Add and set style
1863
- CellStyle style = workbook.Styles.Add("CustomStyle");
1864
- worksheet["C2"].Style = style;
1865
- //Check Style name
1866
- Console.Write(worksheet["C2"].CellStyleName);
1867
- </code>
1868
- </example>
1869
- </summary>
1783
+ Gets/sets name of the style for the current range.
1784
+ Example::
1785
+
1786
+ #Create worksheet
1787
+ workbook = Workbook()
1788
+ worksheet = workbook.Worksheets[0]
1789
+ #Add and set style
1790
+ style = workbook.Styles.Add("CustomStyle")
1791
+ worksheet["C2"].Style = style
1792
+ #Check Style name
1793
+ Console.Write(worksheet["C2"].CellStyleName)
1794
+
1870
1795
  """
1871
1796
  GetDllLibXls().XlsRange_get_CellStyleName.argtypes=[c_void_p]
1872
1797
  GetDllLibXls().XlsRange_get_CellStyleName.restype=c_void_p
@@ -1882,18 +1807,15 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1882
1807
  @property
1883
1808
  def Column(self)->int:
1884
1809
  """
1885
- <summary>
1886
1810
  Returns the number of the first column in the first area in the specified range.
1887
- <example>The following code illustrates how to access Column property of the Range:
1888
- <code>
1889
- //Create worksheet
1890
- Workbook workbook = new Workbook();
1891
- Worksheet worksheet = workbook.Worksheets[0];
1892
- //Get specified column
1893
- int firstColumn = worksheet["E1:R3"].Column;
1894
- </code>
1895
- </example>
1896
- </summary>
1811
+ Example::
1812
+
1813
+ #Create worksheet
1814
+ workbook = Workbook()
1815
+ worksheet = workbook.Worksheets[0]
1816
+ #Get specified column
1817
+ firstColumn = worksheet["E1:R3"].Column
1818
+
1897
1819
  """
1898
1820
  GetDllLibXls().XlsRange_get_Column.argtypes=[c_void_p]
1899
1821
  GetDllLibXls().XlsRange_get_Column.restype=c_int
@@ -1903,14 +1825,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1903
1825
  @property
1904
1826
  def ColumnGroupLevel(self)->int:
1905
1827
  """
1906
- <summary>
1907
1828
  Column group level.
1908
- </summary>
1909
- <remarks>
1910
- -1 - column group is not same.
1911
- 0 - Not group
1912
- 1 - 7 - group level.
1913
- </remarks>
1829
+
1914
1830
  """
1915
1831
  GetDllLibXls().XlsRange_get_ColumnGroupLevel.argtypes=[c_void_p]
1916
1832
  GetDllLibXls().XlsRange_get_ColumnGroupLevel.restype=c_int
@@ -1933,21 +1849,18 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1933
1849
  @property
1934
1850
  def ColumnWidth(self)->float:
1935
1851
  """
1936
- <summary>
1937
- Returns or sets the width of all columns in the specified range.
1938
- <example>The following code illustrates how to set the width of all columns in the specified range:
1939
- <code>
1940
- //Create worksheet
1941
- Workbook workbook = new Workbook();
1942
- Worksheet worksheet = workbook.Worksheets[0];
1943
- //Set the ColumnWidth
1944
- worksheet["A1"].Text = "This cell contains sample text";
1945
- worksheet["A1"].ColumnWidth = 25;
1946
- //Save to file
1947
- workbook.SaveToFile("ColumnWidth.xlsx");
1948
- </code>
1949
- </example>
1950
- </summary>
1852
+ Returns or sets the width of all columns in the specified range.
1853
+ Example::
1854
+
1855
+ #Create worksheet
1856
+ workbook = Workbook()
1857
+ worksheet = workbook.Worksheets[0]
1858
+ #Set the ColumnWidth
1859
+ worksheet["A1"].Text = "This cell contains sample text"
1860
+ worksheet["A1"].ColumnWidth = 25
1861
+ #Save to file
1862
+ workbook.SaveToFile("ColumnWidth.xlsx")
1863
+
1951
1864
  """
1952
1865
  GetDllLibXls().XlsRange_get_ColumnWidth.argtypes=[c_void_p]
1953
1866
  GetDllLibXls().XlsRange_get_ColumnWidth.restype=c_double
@@ -1963,16 +1876,21 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1963
1876
 
1964
1877
  def Comment(self)->'ICommentShape':
1965
1878
  """
1966
- <summary>
1967
1879
  Returns a Comment object that represents the comment associated with the cell in the upper-left corner of the range.
1968
- </summary>
1880
+
1969
1881
  """
1882
+ from spire.xls.XlsComment import XlsComment
1883
+ from spire.xls.CommentsRange import CommentsRange
1970
1884
  GetDllLibXls().XlsRange_get_Comment.argtypes=[c_void_p]
1971
1885
  GetDllLibXls().XlsRange_get_Comment.restype=c_void_p
1972
1886
  intPtr = CallCFunction(GetDllLibXls().XlsRange_get_Comment, self.Ptr)
1973
- ret = None if intPtr==None else XlsComment(intPtr)
1887
+ if intPtr==None:
1888
+ return None
1889
+ ret = XlsComment(intPtr) if self.__Is_Single_Cell__() else CommentsRange(intPtr)
1974
1890
  return ret
1975
1891
 
1892
+ def __Is_Single_Cell__(self)->bool:
1893
+ return self.Row == self.LastRow and self.Column == self.LastColumn
1976
1894
 
1977
1895
  @property
1978
1896
 
@@ -1990,9 +1908,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
1990
1908
  @property
1991
1909
  def Count(self)->int:
1992
1910
  """
1993
- <summary>
1994
1911
  Returns the number of objects in the collection.
1995
- </summary>
1912
+
1996
1913
  """
1997
1914
  GetDllLibXls().XlsRange_get_Count.argtypes=[c_void_p]
1998
1915
  GetDllLibXls().XlsRange_get_Count.restype=c_int
@@ -2003,9 +1920,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2003
1920
 
2004
1921
  def CurrentRegion(self)->'IXLSRange':
2005
1922
  """
2006
- <summary>
2007
1923
  Get the range associated with a range.
2008
- </summary>
1924
+
2009
1925
  """
2010
1926
  GetDllLibXls().XlsRange_get_CurrentRegion.argtypes=[c_void_p]
2011
1927
  GetDllLibXls().XlsRange_get_CurrentRegion.restype=c_void_p
@@ -2018,25 +1934,22 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2018
1934
 
2019
1935
  def DataValidation(self)->'Validation':
2020
1936
  """
2021
- <summary>
2022
- Get dataValidation of the sheet. Read Only.
2023
- <example>The following code illustrates how to access DataValidation property of the Range:
2024
- <code>
2025
- //Create worksheet
2026
- Workbook workbook = new Workbook();
2027
- Worksheet worksheet = workbook.Worksheets[0];
2028
- //Data validation for number
2029
- IDataValidation validation = worksheet.Range["A3"].DataValidation;
2030
- validation.AllowType = CellDataType.Integer;
2031
- //Value between 0 to 10
2032
- validation.CompareOperator = ValidationComparisonOperator.Between;
2033
- validation.Formula1 = "0";
2034
- validation.Formula2 = "10";
2035
- //Save to file
2036
- workbook.SaveToFile("DataValidation.xlsx");
2037
- </code>
2038
- </example>
2039
- </summary>
1937
+ Get dataValidation of the sheet. Read Only.
1938
+ Example::
1939
+
1940
+ #Create worksheet
1941
+ workbook = Workbook()
1942
+ worksheet = workbook.Worksheets[0]
1943
+ #Data validation for number
1944
+ validation = worksheet.Range["A3"].DataValidation
1945
+ validation.AllowType = CellDataType.Integer
1946
+ #Value between 0 to 10
1947
+ validation.CompareOperator = ValidationComparisonOperator.Between
1948
+ validation.Formula1 = "0"
1949
+ validation.Formula2 = "10"
1950
+ #Save to file
1951
+ workbook.SaveToFile("DataValidation.xlsx")
1952
+
2040
1953
  """
2041
1954
  GetDllLibXls().XlsRange_get_DataValidation.argtypes=[c_void_p]
2042
1955
  GetDllLibXls().XlsRange_get_DataValidation.restype=c_void_p
@@ -2049,21 +1962,18 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2049
1962
 
2050
1963
  def DateTimeValue(self)->'DateTime':
2051
1964
  """
2052
- <summary>
2053
1965
  Gets/sets DateTime value of the range.
2054
- <example>The following code illustrates how to set and access DateTimeValue property of the Range:
2055
- <code>
2056
- //Create worksheet
2057
- Workbook workbook = new Workbook();
2058
- Worksheet worksheet = workbook.Worksheets[0];
2059
- //Set and get the DateTimeValue of specified range
2060
- worksheet.Range[2, 4].DateTimeValue = DateTime.Now;
2061
- DateTime dateTime = worksheet.Range[2, 4].DateTimeValue;
2062
- //Save to file
2063
- workbook.SaveToFile("DateTimeValue.xlsx");
2064
- </code>
2065
- </example>
2066
- </summary>
1966
+ Example::
1967
+
1968
+ #Create worksheet
1969
+ workbook = Workbook()
1970
+ worksheet = workbook.Worksheets[0]
1971
+ #Set and get the DateTimeValue of specified range
1972
+ worksheet.Range[2, 4].DateTimeValue = DateTime.Now
1973
+ dateTime = worksheet.Range[2, 4].DateTimeValue
1974
+ #Save to file
1975
+ workbook.SaveToFile("DateTimeValue.xlsx")
1976
+
2067
1977
  """
2068
1978
  GetDllLibXls().XlsRange_get_DateTimeValue.argtypes=[c_void_p]
2069
1979
  GetDllLibXls().XlsRange_get_DateTimeValue.restype=c_void_p
@@ -2107,10 +2017,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2107
2017
 
2108
2018
  def EntireRow(self)->'IXLSRange':
2109
2019
  """
2110
- <summary>
2111
- Returns a Range object that represents the entire row (or
2112
- rows) that contains the specified range. Read-only.
2113
- </summary>
2020
+ Returns a Range object that represents the entire row (or rows) that contains the specified range. Read-only.
2021
+
2114
2022
  """
2115
2023
  GetDllLibXls().XlsRange_get_EntireRow.argtypes=[c_void_p]
2116
2024
  GetDllLibXls().XlsRange_get_EntireRow.restype=c_void_p
@@ -2123,20 +2031,17 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2123
2031
 
2124
2032
  def EnvalutedValue(self)->str:
2125
2033
  """
2126
- <summary>
2127
- Returns the calculated value of a formula.
2128
- <example>The following code illustrates how to access a calculated value:
2129
- <code>
2130
- //Create worksheet
2131
- Workbook workbook = new Workbook();
2132
- workbook.LoadFromFile("Sample.xlsx");
2133
- Worksheet worksheet = workbook.Worksheets[0];
2134
- //Returns the calculated value of a formula using the most current inputs
2135
- string calculatedValue = worksheet["C1"].EnvalutedValue;
2136
- Console.WriteLine(calculatedValue);
2137
- </code>
2138
- </example>
2139
- </summary>
2034
+ Returns the calculated value of a formula.
2035
+ Example::
2036
+
2037
+ #Create worksheet
2038
+ workbook = Workbook()
2039
+ workbook.LoadFromFile("Sample.xlsx")
2040
+ worksheet = workbook.Worksheets[0]
2041
+ #Returns the calculated value of a formula using the most current inputs
2042
+ calculatedValue = worksheet["C1"].EnvalutedValue
2043
+ print(calculatedValue)
2044
+
2140
2045
  """
2141
2046
  GetDllLibXls().XlsRange_get_EnvalutedValue.argtypes=[c_void_p]
2142
2047
  GetDllLibXls().XlsRange_get_EnvalutedValue.restype=c_void_p
@@ -2148,9 +2053,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2148
2053
 
2149
2054
  def ErrorValue(self)->str:
2150
2055
  """
2151
- <summary>
2152
2056
  Gets or sets error value of this range.
2153
- </summary>
2057
+
2154
2058
  """
2155
2059
  GetDllLibXls().XlsRange_get_ErrorValue.argtypes=[c_void_p]
2156
2060
  GetDllLibXls().XlsRange_get_ErrorValue.restype=c_void_p
@@ -2167,10 +2071,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2167
2071
 
2168
2072
  def Formula(self)->str:
2169
2073
  """
2170
- <summary>
2171
- Returns or sets the object's formula in A1-style notation and in
2172
- the language of the macro.
2173
- </summary>
2074
+ Returns or sets the object's formula in A1-style notation and in the language of the macro.
2075
+
2174
2076
  """
2175
2077
  GetDllLibXls().XlsRange_get_Formula.argtypes=[c_void_p]
2176
2078
  GetDllLibXls().XlsRange_get_Formula.restype=c_void_p
@@ -2187,24 +2089,21 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2187
2089
 
2188
2090
  def FormulaArray(self)->str:
2189
2091
  """
2190
- <summary>
2191
- Returns or sets the array formula of a range.
2192
- <example>The following code illustrates how to set and access FormulaArray property of the range:
2193
- <code>
2194
- //Create worksheet
2195
- Workbook workbook = new Workbook();
2196
- Worksheet worksheet = workbook.Worksheets[0];
2197
- //Assign array formula
2198
- worksheet.Range["A1:D1"].FormulaArray = "{1,2,3,4}";
2199
- //Adding a named range for the range A1 to D1
2200
- worksheet.Names.Add("ArrayRange", worksheet.Range["A1:D1"]);
2201
- //Assign formula array with named range
2202
- worksheet.Range["A2:D2"].FormulaArray = "ArrayRange+100";
2203
- //Save to file
2204
- workbook.SaveToFile("FormulaArray.xlsx");
2205
- </code>
2206
- </example>
2207
- </summary>
2092
+ Returns or sets the array formula of a range.
2093
+ Example::
2094
+
2095
+ #Create worksheet
2096
+ workbook = Workbook()
2097
+ worksheet = workbook.Worksheets[0]
2098
+ #Assign array formula
2099
+ worksheet.Range["A1:D1"].FormulaArray = "{1,2,3,4}"
2100
+ #Adding a named range for the range A1 to D1
2101
+ worksheet.Names.Add("ArrayRange", worksheet.Range["A1:D1"])
2102
+ #Assign formula array with named range
2103
+ worksheet.Range["A2:D2"].FormulaArray = "ArrayRange+100"
2104
+ #Save to file
2105
+ workbook.SaveToFile("FormulaArray.xlsx")
2106
+
2208
2107
  """
2209
2108
  GetDllLibXls().XlsRange_get_FormulaArray.argtypes=[c_void_p]
2210
2109
  GetDllLibXls().XlsRange_get_FormulaArray.restype=c_void_p
@@ -2221,9 +2120,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2221
2120
 
2222
2121
  def FormulaArrayR1C1(self)->str:
2223
2122
  """
2224
- <summary>
2225
2123
  Returns or sets the formula for the object, using R1C1-style notation in the language of the macro
2226
- </summary>
2124
+
2227
2125
  """
2228
2126
  GetDllLibXls().XlsRange_get_FormulaArrayR1C1.argtypes=[c_void_p]
2229
2127
  GetDllLibXls().XlsRange_get_FormulaArrayR1C1.restype=c_void_p
@@ -2255,9 +2153,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2255
2153
 
2256
2154
  def FormulaDateTime(self)->'DateTime':
2257
2155
  """
2258
- <summary>
2259
2156
  Gets or sets bool value of the formula.
2260
- </summary>
2157
+
2261
2158
  """
2262
2159
  GetDllLibXls().XlsRange_get_FormulaDateTime.argtypes=[c_void_p]
2263
2160
  GetDllLibXls().XlsRange_get_FormulaDateTime.restype=c_void_p
@@ -2275,9 +2172,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2275
2172
 
2276
2173
  def FormulaErrorValue(self)->str:
2277
2174
  """
2278
- <summary>
2279
2175
  Gets or sets error value of the formula.
2280
- </summary>
2176
+
2281
2177
  """
2282
2178
  GetDllLibXls().XlsRange_get_FormulaErrorValue.argtypes=[c_void_p]
2283
2179
  GetDllLibXls().XlsRange_get_FormulaErrorValue.restype=c_void_p
@@ -2293,9 +2189,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2293
2189
  @property
2294
2190
  def FormulaNumberValue(self)->float:
2295
2191
  """
2296
- <summary>
2297
2192
  Gets or sets double value of the formula.
2298
- </summary>
2193
+
2299
2194
  """
2300
2195
  GetDllLibXls().XlsRange_get_FormulaNumberValue.argtypes=[c_void_p]
2301
2196
  GetDllLibXls().XlsRange_get_FormulaNumberValue.restype=c_double
@@ -2311,9 +2206,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2311
2206
 
2312
2207
  def FormulaR1C1(self)->str:
2313
2208
  """
2314
- <summary>
2315
2209
  Returns or sets the formula for the object, using R1C1-style notation in the language of the macro
2316
- </summary>
2210
+
2317
2211
  """
2318
2212
  GetDllLibXls().XlsRange_get_FormulaR1C1.argtypes=[c_void_p]
2319
2213
  GetDllLibXls().XlsRange_get_FormulaR1C1.restype=c_void_p
@@ -2330,9 +2224,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2330
2224
 
2331
2225
  def FormulaStringValue(self)->str:
2332
2226
  """
2333
- <summary>
2334
2227
  Gets or sets string value of the range.
2335
- </summary>
2228
+
2336
2229
  """
2337
2230
  GetDllLibXls().XlsRange_get_FormulaStringValue.argtypes=[c_void_p]
2338
2231
  GetDllLibXls().XlsRange_get_FormulaStringValue.restype=c_void_p
@@ -2349,9 +2242,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2349
2242
 
2350
2243
  def FormulaValue(self)->'str':
2351
2244
  """
2352
- <summary>
2353
2245
  Gets formula value.
2354
- </summary>
2246
+
2355
2247
  """
2356
2248
  GetDllLibXls().XlsRange_get_FormulaValue.argtypes=[c_void_p]
2357
2249
  GetDllLibXls().XlsRange_get_FormulaValue.restype=c_void_p
@@ -2363,22 +2255,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2363
2255
  @property
2364
2256
  def HasBoolean(self)->bool:
2365
2257
  """
2366
- <summary>
2367
- Indicates whether range contains bool value.
2368
- <example>The following code illustrates how to set and access HasBoolean property of the Range:
2369
- <code>
2370
- //Create worksheet
2371
- Workbook workbook = new Workbook();
2372
- Worksheet worksheet = workbook.Worksheets[0];
2373
- //Assigning Value2 property of the Range
2374
- worksheet["A3"].Value2 = false;
2375
- //Checking Range types
2376
- bool isboolean = worksheet["A3"].HasBoolean;
2377
- //Save to file
2378
- workbook.SaveToFile("HasBoolean.xlsx");
2379
- </code>
2380
- </example>
2381
- </summary>
2258
+ Indicates whether range contains bool value.
2259
+ Example::
2260
+
2261
+ #Create worksheet
2262
+ workbook = Workbook()
2263
+ worksheet = workbook.Worksheets[0]
2264
+ #Assigning Value2 property of the Range
2265
+ worksheet["A3"].Value2 = false
2266
+ #Checking Range types
2267
+ isboolean = worksheet["A3"].HasBoolean
2268
+ #Save to file
2269
+ workbook.SaveToFile("HasBoolean.xlsx")
2270
+
2382
2271
  """
2383
2272
  GetDllLibXls().XlsRange_get_HasBoolean.argtypes=[c_void_p]
2384
2273
  GetDllLibXls().XlsRange_get_HasBoolean.restype=c_bool
@@ -2398,9 +2287,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2398
2287
  @property
2399
2288
  def ColumnCount(self)->int:
2400
2289
  """
2401
- <summary>
2402
2290
  Gets number of columns.
2403
- </summary>
2291
+
2404
2292
  """
2405
2293
  GetDllLibXls().XlsRange_get_ColumnCount.argtypes=[c_void_p]
2406
2294
  GetDllLibXls().XlsRange_get_ColumnCount.restype=c_int
@@ -2410,9 +2298,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2410
2298
  @property
2411
2299
  def RowCount(self)->int:
2412
2300
  """
2413
- <summary>
2414
2301
  Gets number of rows.
2415
- </summary>
2302
+
2416
2303
  """
2417
2304
  GetDllLibXls().XlsRange_get_RowCount.argtypes=[c_void_p]
2418
2305
  GetDllLibXls().XlsRange_get_RowCount.restype=c_int
@@ -2422,10 +2309,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2422
2309
  @property
2423
2310
  def HasDataValidation(self)->bool:
2424
2311
  """
2425
- <summary>
2426
- Indicates whether specified range object has data validation.
2427
- If Range is not single cell, then returns true only if all cells have data validation. Read-only.
2428
- </summary>
2312
+ Indicates whether specified range object has data validation. If Range is not single cell, then returns true only if all cells have data validation. Read-only.
2313
+
2429
2314
  """
2430
2315
  GetDllLibXls().XlsRange_get_HasDataValidation.argtypes=[c_void_p]
2431
2316
  GetDllLibXls().XlsRange_get_HasDataValidation.restype=c_bool
@@ -2435,22 +2320,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2435
2320
  @property
2436
2321
  def HasDateTime(self)->bool:
2437
2322
  """
2438
- <summary>
2439
- Determines if all cells in the range contain datetime.
2440
- <example>The following code illustrates how to set and access HasDateTime property of the Range:
2441
- <code>
2442
- //Create worksheet
2443
- Workbook workbook = new Workbook();
2444
- Worksheet worksheet = workbook.Worksheets[0];
2445
- //Assigning Value2 property of the Range
2446
- worksheet["A1"].Value2 = DateTime.Now;
2447
- //Checking Range types
2448
- bool isDateTime = worksheet["A1"].HasDateTime;
2449
- //Save to file
2450
- workbook.SaveToFile("HasDateTime.xlsx");
2451
- </code>
2452
- </example>
2453
- </summary>
2323
+ Determines if all cells in the range contain datetime.
2324
+ Example::
2325
+
2326
+ #Create worksheet
2327
+ workbook = Workbook()
2328
+ worksheet = workbook.Worksheets[0]
2329
+ #Assigning Value2 property of the Range
2330
+ worksheet["A1"].Value2 = DateTime.Now
2331
+ #Checking Range types
2332
+ isDateTime = worksheet["A1"].HasDateTime
2333
+ #Save to file
2334
+ workbook.SaveToFile("HasDateTime.xlsx")
2335
+
2454
2336
  """
2455
2337
  GetDllLibXls().XlsRange_get_HasDateTime.argtypes=[c_void_p]
2456
2338
  GetDllLibXls().XlsRange_get_HasDateTime.restype=c_bool
@@ -2460,9 +2342,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2460
2342
  @property
2461
2343
  def HasError(self)->bool:
2462
2344
  """
2463
- <summary>
2464
2345
  Indicates whether range contains error value.
2465
- </summary>
2346
+
2466
2347
  """
2467
2348
  GetDllLibXls().XlsRange_get_HasError.argtypes=[c_void_p]
2468
2349
  GetDllLibXls().XlsRange_get_HasError.restype=c_bool
@@ -2472,9 +2353,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2472
2353
  @property
2473
2354
  def HasExternalFormula(self)->bool:
2474
2355
  """
2475
- <summary>
2476
2356
  Check if the formula in the range has external links. Read-only.
2477
- </summary>
2357
+
2478
2358
  """
2479
2359
  GetDllLibXls().XlsRange_get_HasExternalFormula.argtypes=[c_void_p]
2480
2360
  GetDllLibXls().XlsRange_get_HasExternalFormula.restype=c_bool
@@ -2484,9 +2364,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2484
2364
  @property
2485
2365
  def HasFormula(self)->bool:
2486
2366
  """
2487
- <summary>
2488
- True if all cells in the range contain formulas;
2489
- </summary>
2367
+ True if all cells in the range contain formulas;
2368
+
2490
2369
  """
2491
2370
  GetDllLibXls().XlsRange_get_HasFormula.argtypes=[c_void_p]
2492
2371
  GetDllLibXls().XlsRange_get_HasFormula.restype=c_bool
@@ -2496,9 +2375,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2496
2375
  @property
2497
2376
  def HasFormulaArray(self)->bool:
2498
2377
  """
2499
- <summary>
2500
2378
  Determines if all cells in the range contain array-entered formula.
2501
- </summary>
2379
+
2502
2380
  """
2503
2381
  GetDllLibXls().XlsRange_get_HasFormulaArray.argtypes=[c_void_p]
2504
2382
  GetDllLibXls().XlsRange_get_HasFormulaArray.restype=c_bool
@@ -2508,9 +2386,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2508
2386
  @property
2509
2387
  def HasFormulaBoolValue(self)->bool:
2510
2388
  """
2511
- <summary>
2512
2389
  Determines if all cells in the range contain formula bool value..
2513
- </summary>
2390
+
2514
2391
  """
2515
2392
  GetDllLibXls().XlsRange_get_HasFormulaBoolValue.argtypes=[c_void_p]
2516
2393
  GetDllLibXls().XlsRange_get_HasFormulaBoolValue.restype=c_bool
@@ -2520,9 +2397,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2520
2397
  @property
2521
2398
  def HasFormulaDateTime(self)->bool:
2522
2399
  """
2523
- <summary>
2524
2400
  Indicates if current range has formula value formatted as DateTime. Read-only.
2525
- </summary>
2401
+
2526
2402
  """
2527
2403
  GetDllLibXls().XlsRange_get_HasFormulaDateTime.argtypes=[c_void_p]
2528
2404
  GetDllLibXls().XlsRange_get_HasFormulaDateTime.restype=c_bool
@@ -2532,9 +2408,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2532
2408
  @property
2533
2409
  def HasFormulaErrorValue(self)->bool:
2534
2410
  """
2535
- <summary>
2536
2411
  Determines if all cells in the range contain error value.
2537
- </summary>
2412
+
2538
2413
  """
2539
2414
  GetDllLibXls().XlsRange_get_HasFormulaErrorValue.argtypes=[c_void_p]
2540
2415
  GetDllLibXls().XlsRange_get_HasFormulaErrorValue.restype=c_bool
@@ -2544,9 +2419,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2544
2419
  @property
2545
2420
  def HasFormulaNumberValue(self)->bool:
2546
2421
  """
2547
- <summary>
2548
2422
  Indicates whether current range has formula number value.
2549
- </summary>
2423
+
2550
2424
  """
2551
2425
  GetDllLibXls().XlsRange_get_HasFormulaNumberValue.argtypes=[c_void_p]
2552
2426
  GetDllLibXls().XlsRange_get_HasFormulaNumberValue.restype=c_bool
@@ -2566,22 +2440,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2566
2440
  @property
2567
2441
  def HasMerged(self)->bool:
2568
2442
  """
2569
- <summary>
2570
- Indicates whether this range is part of merged range.
2571
- <example>The following code illustrates how to access HasMerged property:
2572
- <code>
2573
- //Create worksheet
2574
- Workbook workbook = new Workbook();
2575
- Worksheet worksheet = workbook.Worksheets[0];
2576
- //Set text
2577
- worksheet["A1"].Text = "Sample text in cell";
2578
- //Set merge
2579
- worksheet["A1:B1"].Merge();
2580
- //Check merge
2581
- Console.Write(worksheet["A1:B1"].HasMerged);
2582
- </code>
2583
- </example>
2584
- </summary>
2443
+ Indicates whether this range is part of merged range.
2444
+ Example::
2445
+
2446
+ #Create worksheet
2447
+ workbook = Workbook()
2448
+ worksheet = workbook.Worksheets[0]
2449
+ #Set text
2450
+ worksheet["A1"].Text = "Sample text in cell"
2451
+ #Set merge
2452
+ worksheet["A1:B1"].Merge()
2453
+ #Check merge
2454
+ Console.Write(worksheet["A1:B1"].HasMerged)
2455
+
2585
2456
  """
2586
2457
  GetDllLibXls().XlsRange_get_HasMerged.argtypes=[c_void_p]
2587
2458
  GetDllLibXls().XlsRange_get_HasMerged.restype=c_bool
@@ -2591,22 +2462,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2591
2462
  @property
2592
2463
  def HasNumber(self)->bool:
2593
2464
  """
2594
- <summary>
2595
- Determines if any one cell in the range contain number.
2596
- <example>The following code illustrates how to set and access Value2 property of the Range:
2597
- <code>
2598
- //Create worksheet
2599
- Workbook workbook = new Workbook();
2600
- Worksheet worksheet = workbook.Worksheets[0];
2601
- //Assigning Value2 property of the Range
2602
- worksheet["A2"].Value2 = 45;
2603
- //Checking Range types
2604
- bool isNumber = worksheet["A2"].HasNumber;
2605
- //Save to file
2606
- workbook.SaveToFile("HasNumber.xlsx");
2607
- </code>
2608
- </example>
2609
- </summary>
2465
+ Determines if any one cell in the range contain number.
2466
+ Example::
2467
+
2468
+ #Create worksheet
2469
+ workbook = Workbook()
2470
+ worksheet = workbook.Worksheets[0]
2471
+ #Assigning Value2 property of the Range
2472
+ worksheet["A2"].Value2 = 45
2473
+ #Checking Range types
2474
+ isNumber = worksheet["A2"].HasNumber
2475
+ #Save to file
2476
+ workbook.SaveToFile("HasNumber.xlsx")
2477
+
2610
2478
  """
2611
2479
  GetDllLibXls().XlsRange_get_HasNumber.argtypes=[c_void_p]
2612
2480
  GetDllLibXls().XlsRange_get_HasNumber.restype=c_bool
@@ -2616,9 +2484,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2616
2484
  @property
2617
2485
  def HasPictures(self)->bool:
2618
2486
  """
2619
- <summary>
2620
2487
  Indicates whether the range is blank.
2621
- </summary>
2488
+
2622
2489
  """
2623
2490
  GetDllLibXls().XlsRange_get_HasPictures.argtypes=[c_void_p]
2624
2491
  GetDllLibXls().XlsRange_get_HasPictures.restype=c_bool
@@ -2628,28 +2495,25 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2628
2495
  @property
2629
2496
  def HasRichText(self)->bool:
2630
2497
  """
2631
- <summary>
2632
- Determines if all cells in the range contain rich text string.
2633
- <example>The following code illustrates how to access HasRichText property:
2634
- <code>
2635
- //Create worksheet
2636
- Workbook workbook = new Workbook();
2637
- Worksheet worksheet = workbook.Worksheets[0];
2638
- //Create style
2639
- IStyle style = workbook.Styles.Add("CustomStyle");
2640
- //Set rich text
2641
- IRichTextString richText = worksheet["C2"].RichText;
2642
- richText.Text = "Sample";
2643
- IFont font = style.Font;
2644
- font.Color = Color.Red;
2645
- richText.SetFont(0, 5, font);
2646
- //Check HasRichText
2647
- Console.Write(worksheet["C2"].HasRichText);
2648
- //Save to file
2649
- workbook.SaveToFile("HasRichText.xlsx");
2650
- </code>
2651
- </example>
2652
- </summary>
2498
+ Determines if all cells in the range contain rich text string.
2499
+ Example::
2500
+
2501
+ #Create worksheet
2502
+ workbook = Workbook()
2503
+ worksheet = workbook.Worksheets[0]
2504
+ #Create style
2505
+ style = workbook.Styles.Add("CustomStyle")
2506
+ #Set rich text
2507
+ richText = worksheet["C2"].RichText
2508
+ richText.Text = "Sample"
2509
+ font = style.Font
2510
+ font.Color = Color.Red
2511
+ richText.SetFont(0, 5, font)
2512
+ #Check HasRichText
2513
+ Console.Write(worksheet["C2"].HasRichText)
2514
+ #Save to file
2515
+ workbook.SaveToFile("HasRichText.xlsx")
2516
+
2653
2517
  """
2654
2518
  GetDllLibXls().XlsRange_get_HasRichText.argtypes=[c_void_p]
2655
2519
  GetDllLibXls().XlsRange_get_HasRichText.restype=c_bool
@@ -2659,9 +2523,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2659
2523
  @property
2660
2524
  def HasString(self)->bool:
2661
2525
  """
2662
- <summary>
2663
2526
  Determines if all cells in the range contain string.
2664
- </summary>
2527
+
2665
2528
  """
2666
2529
  GetDllLibXls().XlsRange_get_HasString.argtypes=[c_void_p]
2667
2530
  GetDllLibXls().XlsRange_get_HasString.restype=c_bool
@@ -2671,25 +2534,22 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2671
2534
  @property
2672
2535
  def HasStyle(self)->bool:
2673
2536
  """
2674
- <summary>
2675
- Determines if all cells in the range contain differs from default style.
2676
- <example>The following code illustrates how to access HasStyle property:
2677
- <code>
2678
- //Create worksheet
2679
- Workbook workbook = new Workbook();
2680
- Worksheet worksheet = workbook.Worksheets[0];
2681
- //Add style
2682
- CellStyle style = workbook.Styles.Add("CustomStyle");
2683
- //Set color and style
2684
- style.Color = Color.Red;
2685
- worksheet["C2"].Style = style;
2686
- //Check HasStyle
2687
- Console.Write(worksheet["C2"].HasStyle);
2688
- //Save to file
2689
- workbook.SaveToFile("HasStyle.xlsx");
2690
- </code>
2691
- </example>
2692
- </summary>
2537
+ Determines if all cells in the range contain differs from default style.
2538
+ Example::
2539
+
2540
+ #Create worksheet
2541
+ workbook = Workbook()
2542
+ worksheet = workbook.Worksheets[0]
2543
+ #Add style
2544
+ style = workbook.Styles.Add("CustomStyle")
2545
+ #Set color and style
2546
+ style.Color = Color.Red
2547
+ worksheet["C2"].Style = style
2548
+ #Check HasStyle
2549
+ Console.Write(worksheet["C2"].HasStyle)
2550
+ #Save to file
2551
+ workbook.SaveToFile("HasStyle.xlsx")
2552
+
2693
2553
  """
2694
2554
  GetDllLibXls().XlsRange_get_HasStyle.argtypes=[c_void_p]
2695
2555
  GetDllLibXls().XlsRange_get_HasStyle.restype=c_bool
@@ -2700,22 +2560,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2700
2560
 
2701
2561
  def HorizontalAlignment(self)->'HorizontalAlignType':
2702
2562
  """
2703
- <summary>
2704
- Returns or sets the horizontal alignment for the specified object.
2705
- <example>The following code illustrates how to set and access HasStyle property:
2706
- <code>
2707
- //Create worksheet
2708
- Workbook workbook = new Workbook();
2709
- Worksheet worksheet = workbook.Worksheets[0];
2710
- //Set text
2711
- worksheet["A1"].Text = "Test";
2712
- //Set alignment
2713
- worksheet["A1"].HorizontalAlignment = HorizontalAlignType.Right;
2714
- //Save to file
2715
- workbook.SaveToFile("HorizontalAlignment.xlsx");
2716
- </code>
2717
- </example>
2718
- </summary>
2563
+ Returns or sets the horizontal alignment for the specified object.
2564
+ Example::
2565
+
2566
+ #Create worksheet
2567
+ workbook = Workbook()
2568
+ worksheet = workbook.Worksheets[0]
2569
+ #Set text
2570
+ worksheet["A1"].Text = "Test"
2571
+ #Set alignment
2572
+ worksheet["A1"].HorizontalAlignment = HorizontalAlignType.Right
2573
+ #Save to file
2574
+ workbook.SaveToFile("HorizontalAlignment.xlsx")
2575
+
2719
2576
  """
2720
2577
  GetDllLibXls().XlsRange_get_HorizontalAlignment.argtypes=[c_void_p]
2721
2578
  GetDllLibXls().XlsRange_get_HorizontalAlignment.restype=c_int
@@ -2732,9 +2589,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2732
2589
 
2733
2590
  def Hyperlinks(self)->'IHyperLinks':
2734
2591
  """
2735
- <summary>
2736
2592
  Returns hyperlinks for this range.
2737
- </summary>
2593
+
2738
2594
  """
2739
2595
  GetDllLibXls().XlsRange_get_Hyperlinks.argtypes=[c_void_p]
2740
2596
  GetDllLibXls().XlsRange_get_Hyperlinks.restype=c_void_p
@@ -2747,9 +2603,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2747
2603
 
2748
2604
  def IgnoreErrorOptions(self)->'IgnoreErrorType':
2749
2605
  """
2750
- <summary>
2751
2606
  Represents ignore error options. If not single cell returs concatenateed flags.
2752
- </summary>
2607
+
2753
2608
  """
2754
2609
  GetDllLibXls().XlsRange_get_IgnoreErrorOptions.argtypes=[c_void_p]
2755
2610
  GetDllLibXls().XlsRange_get_IgnoreErrorOptions.restype=c_int
@@ -2765,22 +2620,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2765
2620
  @property
2766
2621
  def IndentLevel(self)->int:
2767
2622
  """
2768
- <summary>
2769
- Returns or sets the indent level for the cell or range. value should be 0 between 15.
2770
- <example>The following code illustrates how to set indent level for a cell:
2771
- <code>
2772
- //Create worksheet
2773
- Workbook workbook = new Workbook();
2774
- Worksheet worksheet = workbook.Worksheets[0];
2775
- //Set text
2776
- worksheet["C2"].Text = "Sample";
2777
- //Set indent level
2778
- worksheet["C2"].IndentLevel = 2;
2779
- //Save to file
2780
- workbook.SaveToFile("IndentLevel.xlsx");
2781
- </code>
2782
- </example>
2783
- </summary>
2623
+ Returns or sets the indent level for the cell or range. value should be 0 between 15.
2624
+ Example::
2625
+
2626
+ #Create worksheet
2627
+ workbook = Workbook()
2628
+ worksheet = workbook.Worksheets[0]
2629
+ #Set text
2630
+ worksheet["C2"].Text = "Sample"
2631
+ #Set indent level
2632
+ worksheet["C2"].IndentLevel = 2
2633
+ #Save to file
2634
+ workbook.SaveToFile("IndentLevel.xlsx")
2635
+
2784
2636
  """
2785
2637
  GetDllLibXls().XlsRange_get_IndentLevel.argtypes=[c_void_p]
2786
2638
  GetDllLibXls().XlsRange_get_IndentLevel.restype=c_int
@@ -2795,9 +2647,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2795
2647
  @property
2796
2648
  def IsAllNumber(self)->bool:
2797
2649
  """
2798
- <summary>
2799
2650
  Determines if all cells in the range contain number.
2800
- </summary>
2651
+
2801
2652
  """
2802
2653
  GetDllLibXls().XlsRange_get_IsAllNumber.argtypes=[c_void_p]
2803
2654
  GetDllLibXls().XlsRange_get_IsAllNumber.restype=c_bool
@@ -2807,9 +2658,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2807
2658
  @property
2808
2659
  def IsBlank(self)->bool:
2809
2660
  """
2810
- <summary>
2811
2661
  Indicates whether the range is blank.
2812
- </summary>
2662
+
2813
2663
  """
2814
2664
  GetDllLibXls().XlsRange_get_IsBlank.argtypes=[c_void_p]
2815
2665
  GetDllLibXls().XlsRange_get_IsBlank.restype=c_bool
@@ -2819,9 +2669,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2819
2669
  @property
2820
2670
  def IsFormulaHidden(self)->bool:
2821
2671
  """
2822
- <summary>
2823
2672
  Determines if the formula will be hidden when the worksheet is protected.
2824
- </summary>
2673
+
2825
2674
  """
2826
2675
  GetDllLibXls().XlsRange_get_IsFormulaHidden.argtypes=[c_void_p]
2827
2676
  GetDllLibXls().XlsRange_get_IsFormulaHidden.restype=c_bool
@@ -2836,9 +2685,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2836
2685
  @property
2837
2686
  def IsGroupedByColumn(self)->bool:
2838
2687
  """
2839
- <summary>
2840
2688
  Indicates whether this range is grouped by column.
2841
- </summary>
2689
+
2842
2690
  """
2843
2691
  GetDllLibXls().XlsRange_get_IsGroupedByColumn.argtypes=[c_void_p]
2844
2692
  GetDllLibXls().XlsRange_get_IsGroupedByColumn.restype=c_bool
@@ -2848,9 +2696,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2848
2696
  @property
2849
2697
  def IsGroupedByRow(self)->bool:
2850
2698
  """
2851
- <summary>
2852
2699
  Indicates whether this range is grouped by row.
2853
- </summary>
2700
+
2854
2701
  """
2855
2702
  GetDllLibXls().XlsRange_get_IsGroupedByRow.argtypes=[c_void_p]
2856
2703
  GetDllLibXls().XlsRange_get_IsGroupedByRow.restype=c_bool
@@ -2860,9 +2707,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2860
2707
  @property
2861
2708
  def IsInitialized(self)->bool:
2862
2709
  """
2863
- <summary>
2864
2710
  Indicates whether range has been initialized.
2865
- </summary>
2711
+
2866
2712
  """
2867
2713
  GetDllLibXls().XlsRange_get_IsInitialized.argtypes=[c_void_p]
2868
2714
  GetDllLibXls().XlsRange_get_IsInitialized.restype=c_bool
@@ -2873,9 +2719,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2873
2719
 
2874
2720
  def IsStringsPreserved(self)->bool:
2875
2721
  """
2876
- <summary>
2877
2722
  Indicates whether all values in the range are preserved as strings.
2878
- </summary>
2723
+
2879
2724
  """
2880
2725
  GetDllLibXls().XlsRange_get_IsStringsPreserved.argtypes=[c_void_p]
2881
2726
  GetDllLibXls().XlsRange_get_IsStringsPreserved.restype=c_bool
@@ -2892,22 +2737,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2892
2737
  @property
2893
2738
  def IsWrapText(self)->bool:
2894
2739
  """
2895
- <summary>
2896
- Determines if Microsoft Excel wraps the text in the object.
2897
- <example>The following code illustrates how to access WrapText property:
2898
- <code>
2899
- //Create worksheet
2900
- Workbook workbook = new Workbook();
2901
- Worksheet worksheet = workbook.Worksheets[0];
2902
- //Set text
2903
- worksheet["A1"].Text = "This cell contains sample text";
2904
- //Set wrap text
2905
- worksheet["A1"].IsWrapText = true;
2906
- //Save to file
2907
- workbook.SaveToFile("IsWrapText.xlsx");
2908
- </code>
2909
- </example>
2910
- </summary>
2740
+ Determines if Microsoft Excel wraps the text in the object.
2741
+ Example::
2742
+
2743
+ #Create worksheet
2744
+ workbook = Workbook()
2745
+ worksheet = workbook.Worksheets[0]
2746
+ #Set text
2747
+ worksheet["A1"].Text = "This cell contains sample text"
2748
+ #Set wrap text
2749
+ worksheet["A1"].IsWrapText = true
2750
+ #Save to file
2751
+ workbook.SaveToFile("IsWrapText.xlsx")
2752
+
2911
2753
  """
2912
2754
  GetDllLibXls().XlsRange_get_IsWrapText.argtypes=[c_void_p]
2913
2755
  GetDllLibXls().XlsRange_get_IsWrapText.restype=c_bool
@@ -2922,9 +2764,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2922
2764
  @property
2923
2765
  def LastColumn(self)->int:
2924
2766
  """
2925
- <summary>
2926
2767
  Gets or sets last column of the range.
2927
- </summary>
2768
+
2928
2769
  """
2929
2770
  GetDllLibXls().XlsRange_get_LastColumn.argtypes=[c_void_p]
2930
2771
  GetDllLibXls().XlsRange_get_LastColumn.restype=c_int
@@ -2939,9 +2780,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2939
2780
  @property
2940
2781
  def LastRow(self)->int:
2941
2782
  """
2942
- <summary>
2943
2783
  Gets or sets last row of the range.
2944
- </summary>
2784
+
2945
2785
  """
2946
2786
  GetDllLibXls().XlsRange_get_LastRow.argtypes=[c_void_p]
2947
2787
  GetDllLibXls().XlsRange_get_LastRow.restype=c_int
@@ -2970,9 +2810,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2970
2810
 
2971
2811
  def DisplayedText(self)->str:
2972
2812
  """
2973
- <summary>
2974
2813
  Gets cell displayed text.
2975
- </summary>
2814
+
2976
2815
  """
2977
2816
  GetDllLibXls().XlsRange_get_DisplayedText.argtypes=[c_void_p]
2978
2817
  GetDllLibXls().XlsRange_get_DisplayedText.restype=c_void_p
@@ -2983,9 +2822,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2983
2822
  @property
2984
2823
  def HasConditionFormats(self)->bool:
2985
2824
  """
2986
- <summary>
2987
- Indicates whether each cell of the range has some conditional formatting.
2988
- </summary>
2825
+ Indicates whether each cell of the range has some conditional formatting.
2826
+
2989
2827
  """
2990
2828
  GetDllLibXls().XlsRange_get_HasConditionFormats.argtypes=[c_void_p]
2991
2829
  GetDllLibXls().XlsRange_get_HasConditionFormats.restype=c_bool
@@ -2996,22 +2834,19 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
2996
2834
 
2997
2835
  def NumberFormat(self)->str:
2998
2836
  """
2999
- <summary>
3000
- Returns or sets the format code for the object.
3001
- <example>The following code illustrates how to set NumberFormat property:
3002
- <code>
3003
- //Create worksheet
3004
- Workbook workbook = new Workbook();
3005
- Worksheet worksheet = workbook.Worksheets[0];
3006
- //Set data
3007
- worksheet["C2"].Value = "3100.23";
3008
- //Set number format
3009
- worksheet["C2"].NumberFormat = "#,##1.##";
3010
- //Save to file
3011
- workbook.SaveToFile("NumberFormat.xlsx");
3012
- </code>
3013
- </example>
3014
- </summary>
2837
+ Returns or sets the format code for the object.
2838
+ Example::
2839
+
2840
+ #Create worksheet
2841
+ workbook = Workbook()
2842
+ worksheet = workbook.Worksheets[0]
2843
+ #Set data
2844
+ worksheet["C2"].Value = "3100.23"
2845
+ #Set number format
2846
+ worksheet["C2"].NumberFormat = "#,#1.#"
2847
+ #Save to file
2848
+ workbook.SaveToFile("NumberFormat.xlsx")
2849
+
3015
2850
  """
3016
2851
  GetDllLibXls().XlsRange_get_NumberFormat.argtypes=[c_void_p]
3017
2852
  GetDllLibXls().XlsRange_get_NumberFormat.restype=c_void_p
@@ -3028,23 +2863,20 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
3028
2863
 
3029
2864
  def NumberText(self)->str:
3030
2865
  """
3031
- <summary>
3032
2866
  Returns cell text for number format.
3033
- <example>The following code illustrates how to access NumberText property of the Range:
3034
- <code>
3035
- //Create worksheet
3036
- Workbook workbook = new Workbook();
3037
- Worksheet worksheet = workbook.Worksheets[0];
3038
- //Gets cell value with its number format
3039
- XlsRange range= worksheet.Range[3, 1];
3040
- range.Value = "1/1/2015";
3041
- range.NumberFormat = "dd-MMM-yyyy";
3042
- string numberText = range.NumberText;
3043
- //Save to file
3044
- workbook.SaveToFile("NumberText.xlsx");
3045
- </code>
3046
- </example>
3047
- </summary>
2867
+ Example::
2868
+
2869
+ #Create worksheet
2870
+ workbook = Workbook()
2871
+ worksheet = workbook.Worksheets[0]
2872
+ #Gets cell value with its number format
2873
+ XlsRange range= worksheet.Range[3, 1]
2874
+ range.Value = "1/1/2015"
2875
+ range.NumberFormat = "dd-MMM-yyyy"
2876
+ numberText = range.NumberText
2877
+ #Save to file
2878
+ workbook.SaveToFile("NumberText.xlsx")
2879
+
3048
2880
  """
3049
2881
  GetDllLibXls().XlsRange_get_NumberText.argtypes=[c_void_p]
3050
2882
  GetDllLibXls().XlsRange_get_NumberText.restype=c_void_p
@@ -3055,9 +2887,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
3055
2887
  @property
3056
2888
  def NumberValue(self)->float:
3057
2889
  """
3058
- <summary>
3059
2890
  Gets or sets number value of the range.
3060
- </summary>
2891
+
3061
2892
  """
3062
2893
  GetDllLibXls().XlsRange_get_NumberValue.argtypes=[c_void_p]
3063
2894
  GetDllLibXls().XlsRange_get_NumberValue.restype=c_double
@@ -3086,19 +2917,15 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
3086
2917
 
3087
2918
  def RangeAddress(self)->str:
3088
2919
  """
3089
- <summary>
3090
- Returns the range reference in the language of the macro.
3091
- Read-only String.
3092
- <example>The following code illustrates how to access Address property of the Range:
3093
- <code>
3094
- //Create worksheet
3095
- Workbook workbook = new Workbook();
3096
- Worksheet worksheet = workbook.Worksheets[0];
3097
- //Get RangeAddress
3098
- string address = worksheet.Range[3, 4].RangeAddress;
3099
- </code>
3100
- </example>
3101
- </summary>
2920
+ Returns the range reference in the language of the macro. Read-only String.
2921
+ Example::
2922
+
2923
+ #Create worksheet
2924
+ workbook = Workbook()
2925
+ worksheet = workbook.Worksheets[0]
2926
+ #Get RangeAddress
2927
+ address = worksheet.Range[3, 4].RangeAddress
2928
+
3102
2929
  """
3103
2930
  GetDllLibXls().XlsRange_get_RangeAddress.argtypes=[c_void_p]
3104
2931
  GetDllLibXls().XlsRange_get_RangeAddress.restype=c_void_p
@@ -3110,18 +2937,15 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
3110
2937
 
3111
2938
  def RangeAddressLocal(self)->str:
3112
2939
  """
3113
- <summary>
3114
- Returns the range reference for the specified range in the language of the user.
3115
- <example>The following code illustrates how to access AddressLocal property of the Range:
3116
- <code>
3117
- //Create worksheet
3118
- Workbook workbook = new Workbook();
3119
- Worksheet worksheet = workbook.Worksheets[0];
3120
- //Get RangeAddressLocal
3121
- string address = worksheet.Range[3, 4].RangeAddressLocal;
3122
- </code>
3123
- </example>
3124
- </summary>
2940
+ Returns the range reference for the specified range in the language of the user.
2941
+ Example::
2942
+
2943
+ #Create worksheet
2944
+ workbook = Workbook()
2945
+ worksheet = workbook.Worksheets[0]
2946
+ #Get RangeAddressLocal
2947
+ address = worksheet.Range[3, 4].RangeAddressLocal
2948
+
3125
2949
  """
3126
2950
  GetDllLibXls().XlsRange_get_RangeAddressLocal.argtypes=[c_void_p]
3127
2951
  GetDllLibXls().XlsRange_get_RangeAddressLocal.restype=c_void_p
@@ -3133,9 +2957,8 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
3133
2957
 
3134
2958
  def RangeGlobalAddressWithoutSheetName(self)->str:
3135
2959
  """
3136
- <summary>
3137
2960
  Return global address without worksheet name.
3138
- </summary>
2961
+
3139
2962
  """
3140
2963
  GetDllLibXls().XlsRange_get_RangeGlobalAddressWithoutSheetName.argtypes=[c_void_p]
3141
2964
  GetDllLibXls().XlsRange_get_RangeGlobalAddressWithoutSheetName.restype=c_void_p
@@ -3147,18 +2970,15 @@ class XlsRange ( XlsObject, ICombinedRange,IEnumerable[IXLSRange]) :
3147
2970
 
3148
2971
  def RangeGlobalAddress(self)->str:
3149
2972
  """
3150
- <summary>
3151
- Returns the range reference in the language of the macro.
3152
- <example>The following code illustrates how to access AddressGlobal property of the Range:
3153
- <code>
3154
- //Create worksheet
3155
- Workbook workbook = new Workbook();
3156
- Worksheet worksheet = workbook.Worksheets[0];
3157
- //Get RangeAddress
3158
- string address = worksheet.Range[3, 4].RangeGlobalAddress;
3159
- </code>
3160
- </example>
3161
- </summary>
2973
+ Returns the range reference in the language of the macro.
2974
+ Example::
2975
+
2976
+ #Create worksheet
2977
+ workbook = Workbook()
2978
+ worksheet = workbook.Worksheets[0]
2979
+ #Get RangeAddress
2980
+ address = worksheet.Range[3, 4].RangeGlobalAddress
2981
+
3162
2982
  """
3163
2983
  GetDllLibXls().XlsRange_get_RangeGlobalAddress.argtypes=[c_void_p]
3164
2984
  GetDllLibXls().XlsRange_get_RangeGlobalAddress.restype=c_void_p