spire-xls 15.5.0__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.
- spire/__init__.py +0 -0
- spire/xls/AddInFunctionsCollection.py +29 -0
- spire/xls/AddtionalFormatWrapper.py +976 -0
- spire/xls/AlertStyleType.py +18 -0
- spire/xls/ArcShapeCollection.py +70 -0
- spire/xls/AutoFiltersCollection.py +527 -0
- spire/xls/AutoFitterOptions.py +66 -0
- spire/xls/AutoFormatOptions.py +23 -0
- spire/xls/AutoFormatType.py +32 -0
- spire/xls/AutoSortScope.py +25 -0
- spire/xls/Average.py +29 -0
- spire/xls/AverageType.py +25 -0
- spire/xls/AxisLineIdentifierType.py +19 -0
- spire/xls/AxisTextDirectionType.py +18 -0
- spire/xls/AxisType.py +18 -0
- spire/xls/AxisTypes.py +18 -0
- spire/xls/BaseFormatType.py +17 -0
- spire/xls/BordersCollection.py +158 -0
- spire/xls/BordersCollectionArrayWrapper.py +95 -0
- spire/xls/BordersLineType.py +23 -0
- spire/xls/BubbleSizeType.py +17 -0
- spire/xls/BuiltInDocumentProperties.py +12 -0
- spire/xls/BuiltInPropertyType.py +50 -0
- spire/xls/BuiltInStyles.py +66 -0
- spire/xls/ButtonShapeCollection.py +70 -0
- spire/xls/CategoryType.py +18 -0
- spire/xls/CellBaseStyle.py +26 -0
- spire/xls/CellBorder.py +154 -0
- spire/xls/CellDataType.py +23 -0
- spire/xls/CellFormatType.py +21 -0
- spire/xls/CellRange.py +915 -0
- spire/xls/CellStyle.py +85 -0
- spire/xls/CellStyleFlag.py +432 -0
- spire/xls/CellStyleObject.py +617 -0
- spire/xls/CellValueChangedEventArgs.py +75 -0
- spire/xls/CellValueChangedEventHandler.py +52 -0
- spire/xls/Chart.py +404 -0
- spire/xls/ChartArea.py +61 -0
- spire/xls/ChartBackgroundMode.py +18 -0
- spire/xls/ChartBaseUnitType.py +18 -0
- spire/xls/ChartBorder.py +12 -0
- spire/xls/ChartCategoryAxis.py +93 -0
- spire/xls/ChartDataLabels.py +42 -0
- spire/xls/ChartDataPoint.py +42 -0
- spire/xls/ChartDataPointsCollection.py +75 -0
- spire/xls/ChartDataTable.py +12 -0
- spire/xls/ChartDisplayUnitType.py +26 -0
- spire/xls/ChartDropBar.py +12 -0
- spire/xls/ChartFormat.py +72 -0
- spire/xls/ChartFormatCollection.py +59 -0
- spire/xls/ChartGridLine.py +27 -0
- spire/xls/ChartInterior.py +12 -0
- spire/xls/ChartLegend.py +42 -0
- spire/xls/ChartLegendEntriesColl.py +128 -0
- spire/xls/ChartLegendEntry.py +27 -0
- spire/xls/ChartLinePatternType.py +24 -0
- spire/xls/ChartLineWeightType.py +19 -0
- spire/xls/ChartMarkerType.py +27 -0
- spire/xls/ChartPageSetup.py +12 -0
- spire/xls/ChartParagraphType.py +18 -0
- spire/xls/ChartPieType.py +18 -0
- spire/xls/ChartPlotArea.py +53 -0
- spire/xls/ChartPlotEmptyType.py +18 -0
- spire/xls/ChartSerie.py +142 -0
- spire/xls/ChartSerieDataFormat.py +56 -0
- spire/xls/ChartSeries.py +154 -0
- spire/xls/ChartSeriesAxis.py +72 -0
- spire/xls/ChartShadow.py +235 -0
- spire/xls/ChartSheet.py +285 -0
- spire/xls/ChartTextArea.py +782 -0
- spire/xls/ChartTitle.py +12 -0
- spire/xls/ChartValueAxis.py +92 -0
- spire/xls/ChartWallOrFloor.py +12 -0
- spire/xls/ChartsCollection.py +113 -0
- spire/xls/CheckBoxCollection.py +70 -0
- spire/xls/CheckState.py +18 -0
- spire/xls/CollectionBase.py +184 -0
- spire/xls/CollectionChangeEventArgs.py +36 -0
- spire/xls/CollectionExtended.py +92 -0
- spire/xls/ColorConditionValue.py +91 -0
- spire/xls/ColorFilter.py +45 -0
- spire/xls/ColorScale.py +172 -0
- spire/xls/ColorType.py +18 -0
- spire/xls/ComboBoxCollection.py +70 -0
- spire/xls/CommentHAlignType.py +21 -0
- spire/xls/CommentVAlignType.py +20 -0
- spire/xls/CommentsCollection.py +109 -0
- spire/xls/CommentsRange.py +578 -0
- spire/xls/CommonWrapper.py +40 -0
- spire/xls/ComparisonOperatorType.py +24 -0
- spire/xls/CompoundLineType.py +18 -0
- spire/xls/CondFormatCollectionWrapper.py +125 -0
- spire/xls/ConditionValue.py +82 -0
- spire/xls/ConditionValuePosition.py +16 -0
- spire/xls/ConditionValueType.py +20 -0
- spire/xls/ConditionalFormat.py +14 -0
- spire/xls/ConditionalFormatScope.py +16 -0
- spire/xls/ConditionalFormatType.py +33 -0
- spire/xls/ConditionalFormatWrapper.py +986 -0
- spire/xls/ConditionalFormats.py +55 -0
- spire/xls/ConditionalTopNType.py +17 -0
- spire/xls/ConnectionDataSourceType.py +26 -0
- spire/xls/ConverterSetting.py +347 -0
- spire/xls/CopyRangeOptions.py +23 -0
- spire/xls/CustomFilter.py +147 -0
- spire/xls/CustomFilterCollection.py +113 -0
- spire/xls/DBConnection.py +198 -0
- spire/xls/DVAspect.py +15 -0
- spire/xls/DataBar.py +220 -0
- spire/xls/DataBarAxisPosition.py +16 -0
- spire/xls/DataBarBorder.py +47 -0
- spire/xls/DataBarBorderType.py +15 -0
- spire/xls/DataBarFillType.py +15 -0
- spire/xls/DataBarNegativeColorType.py +15 -0
- spire/xls/DataConnections.py +25 -0
- spire/xls/DataLabelPositionType.py +26 -0
- spire/xls/DataMarkerDirection.py +17 -0
- spire/xls/DataSorter.py +154 -0
- spire/xls/DataSourceType.py +19 -0
- spire/xls/DateTimeGroupItem.py +132 -0
- spire/xls/DateTimeGroupingType.py +19 -0
- spire/xls/DeleteOption.py +15 -0
- spire/xls/DocumentProperty.py +304 -0
- spire/xls/DropLineStyleType.py +18 -0
- spire/xls/DynamicFilter.py +71 -0
- spire/xls/DynamicFilterType.py +48 -0
- spire/xls/EncryptedKeyInfo.py +12 -0
- spire/xls/ErrorBarIncludeType.py +19 -0
- spire/xls/ErrorBarType.py +20 -0
- spire/xls/Excel2016Charttype.py +20 -0
- spire/xls/ExcelAddInFunction.py +12 -0
- spire/xls/ExcelCalculationMode.py +18 -0
- spire/xls/ExcelChartType.py +96 -0
- spire/xls/ExcelClearOptions.py +18 -0
- spire/xls/ExcelColors.py +121 -0
- spire/xls/ExcelComboType.py +22 -0
- spire/xls/ExcelComment.py +27 -0
- spire/xls/ExcelCommentObject.py +618 -0
- spire/xls/ExcelFindOptions.py +16 -0
- spire/xls/ExcelFont.py +310 -0
- spire/xls/ExcelGradient.py +174 -0
- spire/xls/ExcelHorizontalAlignment.py +21 -0
- spire/xls/ExcelInterior.py +128 -0
- spire/xls/ExcelPatternType.py +52 -0
- spire/xls/ExcelPicture.py +12 -0
- spire/xls/ExcelQuartileCalculation.py +17 -0
- spire/xls/ExcelSaveType.py +15 -0
- spire/xls/ExcelShapeType.py +41 -0
- spire/xls/ExcelSheetType.py +20 -0
- spire/xls/ExcelTotalsCalculation.py +23 -0
- spire/xls/ExcelTreeMapLabelOption.py +18 -0
- spire/xls/ExcelVersion.py +24 -0
- spire/xls/ExcelVerticalAlignment.py +21 -0
- spire/xls/ExpandCollapseFlags.py +18 -0
- spire/xls/ExportTableOptions.py +74 -0
- spire/xls/ExternalConnection.py +147 -0
- spire/xls/ExternalLink.py +58 -0
- spire/xls/ExternalLinkCollection.py +25 -0
- spire/xls/FileFormat.py +40 -0
- spire/xls/FillPictureType.py +16 -0
- spire/xls/FilterColumn.py +258 -0
- spire/xls/FilterConditionType.py +21 -0
- spire/xls/FilterDataType.py +22 -0
- spire/xls/FilterOperatorType.py +20 -0
- spire/xls/FilterType.py +20 -0
- spire/xls/FindType.py +19 -0
- spire/xls/Font.py +376 -0
- spire/xls/FontArrayWrapper.py +265 -0
- spire/xls/FontUnderlineType.py +20 -0
- spire/xls/FontVertialAlignmentType.py +20 -0
- spire/xls/FontWrapper.py +450 -0
- spire/xls/FontsCollection.py +87 -0
- spire/xls/Format3D.py +235 -0
- spire/xls/GeomertyAdjustValue.py +63 -0
- spire/xls/GeomertyAdjustValueFormulaType.py +30 -0
- spire/xls/GeomertyAdjustValuesCollection.py +39 -0
- spire/xls/GetText.py +15 -0
- spire/xls/GoalSeek.py +65 -0
- spire/xls/GoalSeekResult.py +57 -0
- spire/xls/GradientArrayWrapper.py +188 -0
- spire/xls/GradientColorType.py +18 -0
- spire/xls/GradientPatternType.py +64 -0
- spire/xls/GradientPresetType.py +39 -0
- spire/xls/GradientStops.py +146 -0
- spire/xls/GradientStyleType.py +21 -0
- spire/xls/GradientTextureType.py +40 -0
- spire/xls/GradientType.py +17 -0
- spire/xls/GradientVariantsType.py +19 -0
- spire/xls/GroupBoxCollection.py +70 -0
- spire/xls/GroupByType.py +15 -0
- spire/xls/GroupShape.py +21 -0
- spire/xls/GroupShapeCollection.py +46 -0
- spire/xls/HPageBreak.py +32 -0
- spire/xls/HPageBreaksCollection.py +108 -0
- spire/xls/HTMLOptions.py +144 -0
- spire/xls/HistogramAxisFormat.py +30 -0
- spire/xls/HorizontalAlignType.py +23 -0
- spire/xls/HttpContentType.py +18 -0
- spire/xls/HyperLink.py +32 -0
- spire/xls/HyperLinkType.py +20 -0
- spire/xls/HyperLinksCollection.py +72 -0
- spire/xls/IAddInFunction.py +22 -0
- spire/xls/IAddInFunctions.py +50 -0
- spire/xls/IArcShape.py +259 -0
- spire/xls/IArcShapes.py +50 -0
- spire/xls/IAutoFilter.py +167 -0
- spire/xls/IAutoFilterCondition.py +123 -0
- spire/xls/IAutoFilters.py +49 -0
- spire/xls/IBorder.py +116 -0
- spire/xls/IBorders.py +106 -0
- spire/xls/IBuiltInDocumentProperties.py +579 -0
- spire/xls/IButtonShape.py +12 -0
- spire/xls/IButtonShapes.py +50 -0
- spire/xls/IChart.py +1368 -0
- spire/xls/IChartAxis.py +722 -0
- spire/xls/IChartBorder.py +220 -0
- spire/xls/IChartCategoryAxis.py +410 -0
- spire/xls/IChartDataLabels.py +457 -0
- spire/xls/IChartDataPoint.py +131 -0
- spire/xls/IChartDataPoints.py +31 -0
- spire/xls/IChartDataTable.py +197 -0
- spire/xls/IChartDropBar.py +12 -0
- spire/xls/IChartErrorBars.py +373 -0
- spire/xls/IChartFillBorder.py +303 -0
- spire/xls/IChartFormat.py +571 -0
- spire/xls/IChartFrameFormat.py +93 -0
- spire/xls/IChartGridLine.py +107 -0
- spire/xls/IChartInterior.py +278 -0
- spire/xls/IChartLegend.py +499 -0
- spire/xls/IChartLegendEntries.py +30 -0
- spire/xls/IChartLegendEntry.py +178 -0
- spire/xls/IChartPageSetup.py +56 -0
- spire/xls/IChartSerie.py +779 -0
- spire/xls/IChartSerieDataFormat.py +566 -0
- spire/xls/IChartSeries.py +39 -0
- spire/xls/IChartSeriesAxis.py +128 -0
- spire/xls/IChartShape.py +92 -0
- spire/xls/IChartShapes.py +39 -0
- spire/xls/IChartTextArea.py +197 -0
- spire/xls/IChartTrendLine.py +548 -0
- spire/xls/IChartTrendLines.py +79 -0
- spire/xls/IChartValueAxis.py +518 -0
- spire/xls/IChartWallOrFloor.py +32 -0
- spire/xls/ICharts.py +70 -0
- spire/xls/ICheckBox.py +96 -0
- spire/xls/ICheckBoxes.py +50 -0
- spire/xls/ICloneParent.py +28 -0
- spire/xls/IColorConditionValue.py +31 -0
- spire/xls/IColorScale.py +32 -0
- spire/xls/ICombinedRange.py +87 -0
- spire/xls/IComboBoxShape.py +95 -0
- spire/xls/IComboBoxes.py +50 -0
- spire/xls/IComment.py +85 -0
- spire/xls/ICommentShape.py +12 -0
- spire/xls/IComments.py +50 -0
- spire/xls/IConditionValue.py +68 -0
- spire/xls/IConditionalFormat.py +606 -0
- spire/xls/IConditionalFormats.py +48 -0
- spire/xls/IConditionalFormatsCollection.py +134 -0
- spire/xls/ICustomDocumentProperties.py +128 -0
- spire/xls/IDataBar.py +105 -0
- spire/xls/IDataSort.py +95 -0
- spire/xls/IDataValidation.py +421 -0
- spire/xls/IDataValidationCollection.py +132 -0
- spire/xls/IDataValidationTable.py +68 -0
- spire/xls/IDigitalSignature.py +99 -0
- spire/xls/IDigitalSignatures.py +29 -0
- spire/xls/IDocumentProperty.py +226 -0
- spire/xls/IErrorIndicator.py +31 -0
- spire/xls/IExcelApplication.py +22 -0
- spire/xls/IExtendIndex.py +21 -0
- spire/xls/IExtendedFormat.py +530 -0
- spire/xls/IFont.py +271 -0
- spire/xls/IFormat3D.py +252 -0
- spire/xls/IGeomPath.py +23 -0
- spire/xls/IGeomPathInfo.py +112 -0
- spire/xls/IGeomPathShape.py +30 -0
- spire/xls/IGlow.py +85 -0
- spire/xls/IGradient.py +174 -0
- spire/xls/IGroupBox.py +67 -0
- spire/xls/IGroupBoxes.py +50 -0
- spire/xls/IHPageBreak.py +22 -0
- spire/xls/IHPageBreaks.py +31 -0
- spire/xls/IHyperLink.py +118 -0
- spire/xls/IHyperLinks.py +48 -0
- spire/xls/IIconSet.py +96 -0
- spire/xls/IInterior.py +117 -0
- spire/xls/IInternalAddtionalFormat.py +238 -0
- spire/xls/IInternalFont.py +31 -0
- spire/xls/IInternalWorksheet.py +132 -0
- spire/xls/ILabelShape.py +49 -0
- spire/xls/ILabelShapes.py +50 -0
- spire/xls/ILineShape.py +305 -0
- spire/xls/ILines.py +50 -0
- spire/xls/IListBox.py +86 -0
- spire/xls/IListBoxes.py +50 -0
- spire/xls/IListObject.py +493 -0
- spire/xls/IListObjectColumn.py +222 -0
- spire/xls/IListObjects.py +31 -0
- spire/xls/IMarkersDesigner.py +113 -0
- spire/xls/IMigrantRange.py +21 -0
- spire/xls/INameRanges.py +162 -0
- spire/xls/INamedObject.py +22 -0
- spire/xls/INamedRange.py +162 -0
- spire/xls/INumberFormat.py +77 -0
- spire/xls/IOleObject.py +176 -0
- spire/xls/IOleObjects.py +32 -0
- spire/xls/IOptimizedUpdate.py +28 -0
- spire/xls/IOvalShape.py +154 -0
- spire/xls/IOvalShapes.py +50 -0
- spire/xls/IPageSetup.py +195 -0
- spire/xls/IPageSetupBase.py +642 -0
- spire/xls/IPictureShape.py +99 -0
- spire/xls/IPictures.py +250 -0
- spire/xls/IPivotCache.py +41 -0
- spire/xls/IPivotCaches.py +39 -0
- spire/xls/IPivotCalculatedFields.py +50 -0
- spire/xls/IPivotDataField.py +68 -0
- spire/xls/IPivotDataFields.py +50 -0
- spire/xls/IPivotField.py +291 -0
- spire/xls/IPivotFields.py +41 -0
- spire/xls/IPivotTable.py +393 -0
- spire/xls/IPivotTableOptions.py +428 -0
- spire/xls/IPivotTables.py +68 -0
- spire/xls/IPropertyData.py +70 -0
- spire/xls/IPrstGeomShape.py +71 -0
- spire/xls/IPrstGeomShapes.py +81 -0
- spire/xls/IRadioButton.py +105 -0
- spire/xls/IRadioButtons.py +71 -0
- spire/xls/IRectangleShape.py +60 -0
- spire/xls/IRectangleShapes.py +50 -0
- spire/xls/IReflectionEffect.py +138 -0
- spire/xls/IRichTextString.py +93 -0
- spire/xls/IScrollBarShape.py +140 -0
- spire/xls/IScrollBarShapes.py +50 -0
- spire/xls/IShadow.py +244 -0
- spire/xls/IShape.py +409 -0
- spire/xls/IShapeFill.py +522 -0
- spire/xls/IShapeLineFormat.py +331 -0
- spire/xls/IShapes.py +270 -0
- spire/xls/ISortColumn.py +96 -0
- spire/xls/ISortColumns.py +70 -0
- spire/xls/ISortedRule.py +112 -0
- spire/xls/ISparkline.py +68 -0
- spire/xls/ISparklineGroup.py +428 -0
- spire/xls/ISparklines.py +72 -0
- spire/xls/ISpinnerShape.py +102 -0
- spire/xls/ISpinnerShapes.py +50 -0
- spire/xls/IStyle.py +50 -0
- spire/xls/IStyles.py +69 -0
- spire/xls/ITabSheet.py +302 -0
- spire/xls/ITabSheets.py +57 -0
- spire/xls/ITextBox.py +116 -0
- spire/xls/ITextBoxLinkShape.py +40 -0
- spire/xls/ITextBoxShape.py +22 -0
- spire/xls/ITextBoxes.py +61 -0
- spire/xls/ITextFrame.py +120 -0
- spire/xls/IVPageBreak.py +22 -0
- spire/xls/IVPageBreaks.py +31 -0
- spire/xls/IWorkbook.py +1806 -0
- spire/xls/IWorksheet.py +2694 -0
- spire/xls/IWorksheetGroup.py +48 -0
- spire/xls/IWorksheets.py +159 -0
- spire/xls/IXLSRange.py +2479 -0
- spire/xls/IXLSRanges.py +35 -0
- spire/xls/IconSet.py +103 -0
- spire/xls/IconSetType.py +35 -0
- spire/xls/IgnoreErrorType.py +24 -0
- spire/xls/ImageFormatType.py +18 -0
- spire/xls/ImageLocationTypes.py +15 -0
- spire/xls/ImageType.py +17 -0
- spire/xls/ImportObjectOptions.py +89 -0
- spire/xls/InsertMoveOption.py +15 -0
- spire/xls/InsertOptionsType.py +16 -0
- spire/xls/InteriorArrayWrapper.py +126 -0
- spire/xls/LOGFONT.py +140 -0
- spire/xls/LabelShapeCollection.py +71 -0
- spire/xls/LegendPositionType.py +21 -0
- spire/xls/LegendSpacingType.py +18 -0
- spire/xls/LineCollection.py +85 -0
- spire/xls/LineShapeType.py +17 -0
- spire/xls/LineStyleType.py +29 -0
- spire/xls/ListBoxCollection.py +71 -0
- spire/xls/ListObjectCollection.py +45 -0
- spire/xls/MarkerDesigner.py +172 -0
- spire/xls/MeasureUnits.py +21 -0
- spire/xls/MsoPathInfo.py +38 -0
- spire/xls/MsoPathType.py +21 -0
- spire/xls/MultipleFilterCollection.py +166 -0
- spire/xls/NegativeBarFormat.py +82 -0
- spire/xls/OColor.py +165 -0
- spire/xls/OLEDBCommandType.py +19 -0
- spire/xls/OdsPageBackground.py +129 -0
- spire/xls/OdsPageBackgroundImagePositionType.py +22 -0
- spire/xls/OdsPageBackgroundImageType.py +16 -0
- spire/xls/OdsPageBackgroundType.py +16 -0
- spire/xls/OleLinkType.py +15 -0
- spire/xls/OleObjectType.py +51 -0
- spire/xls/OrderBy.py +19 -0
- spire/xls/OrderType.py +17 -0
- spire/xls/OvalShapeCollection.py +70 -0
- spire/xls/PageBreakExtentType.py +17 -0
- spire/xls/PageBreakType.py +18 -0
- spire/xls/PageColRow.py +48 -0
- spire/xls/PageOrientationType.py +17 -0
- spire/xls/PageSetup.py +14 -0
- spire/xls/PagesOrderType.py +17 -0
- spire/xls/PaperSizeEntry.py +30 -0
- spire/xls/PaperSizeType.py +135 -0
- spire/xls/PathFillMode.py +19 -0
- spire/xls/PdfConformanceLevel.py +20 -0
- spire/xls/PicStretch.py +104 -0
- spire/xls/PicTile.py +72 -0
- spire/xls/PicturesCollection.py +532 -0
- spire/xls/PivotAutoFomatTypes.py +35 -0
- spire/xls/PivotBuiltInStyles.py +97 -0
- spire/xls/PivotCache.py +12 -0
- spire/xls/PivotCachesCollection.py +12 -0
- spire/xls/PivotCalculatedFieldsCollection.py +38 -0
- spire/xls/PivotConditionalFormat.py +54 -0
- spire/xls/PivotConditionalFormatCollection.py +38 -0
- spire/xls/PivotDataField.py +118 -0
- spire/xls/PivotDataFields.py +104 -0
- spire/xls/PivotDataType.py +21 -0
- spire/xls/PivotField.py +12 -0
- spire/xls/PivotFieldFormatType.py +28 -0
- spire/xls/PivotFieldSortType.py +16 -0
- spire/xls/PivotGroupByTypes.py +23 -0
- spire/xls/PivotItem.py +161 -0
- spire/xls/PivotItemType.py +28 -0
- spire/xls/PivotLabelFilterType.py +27 -0
- spire/xls/PivotPageAreaFieldsOrderType.py +15 -0
- spire/xls/PivotReportFilter.py +92 -0
- spire/xls/PivotReportFilters.py +63 -0
- spire/xls/PivotStyle.py +79 -0
- spire/xls/PivotTable.py +12 -0
- spire/xls/PivotTableElement.py +38 -0
- spire/xls/PivotTableFields.py +85 -0
- spire/xls/PivotTableLayoutType.py +16 -0
- spire/xls/PivotTableStyle.py +63 -0
- spire/xls/PivotTablesCollection.py +12 -0
- spire/xls/PivotValueFilterType.py +21 -0
- spire/xls/PresetTextEffect.py +43 -0
- spire/xls/PrintCommentType.py +18 -0
- spire/xls/PrintErrorsType.py +19 -0
- spire/xls/PrintingPageType.py +16 -0
- spire/xls/PropertyType.py +31 -0
- spire/xls/PrstGeomShapeCollection.py +126 -0
- spire/xls/PrstGeomShapeType.py +201 -0
- spire/xls/QueryTableCollection.py +25 -0
- spire/xls/QueryTableXls.py +42 -0
- spire/xls/RTFCommentArray.py +112 -0
- spire/xls/RTFStringArray.py +112 -0
- spire/xls/RadioButtonCollection.py +137 -0
- spire/xls/RangeRichTextString.py +42 -0
- spire/xls/RangesCollection.py +537 -0
- spire/xls/ReadingOrderType.py +18 -0
- spire/xls/RectangleCollection.py +71 -0
- spire/xls/RectangleShapeType.py +22 -0
- spire/xls/RectangleStyleType.py +17 -0
- spire/xls/ReferRangeArea.py +88 -0
- spire/xls/RelationShip.py +15 -0
- spire/xls/RenameStrategy.py +16 -0
- spire/xls/ResizeBehaveType.py +18 -0
- spire/xls/RichText.py +49 -0
- spire/xls/RichTextObject.py +133 -0
- spire/xls/RichTextShape.py +168 -0
- spire/xls/RichTextString.py +126 -0
- spire/xls/RtfTags.py +30 -0
- spire/xls/RtfTextWriter.py +629 -0
- spire/xls/SaveShapeTypeOption.py +310 -0
- spire/xls/ScrollBarCollection.py +71 -0
- spire/xls/SelectionType.py +16 -0
- spire/xls/ShapeArrowLengthType.py +18 -0
- spire/xls/ShapeArrowStyleType.py +21 -0
- spire/xls/ShapeArrowWidthType.py +18 -0
- spire/xls/ShapeCollectionBase.py +87 -0
- spire/xls/ShapeDashLineStyleType.py +23 -0
- spire/xls/ShapeFillType.py +22 -0
- spire/xls/ShapeGeomPath.py +26 -0
- spire/xls/ShapeGlow.py +91 -0
- spire/xls/ShapeLayerChangeType.py +19 -0
- spire/xls/ShapeLineStyleType.py +20 -0
- spire/xls/ShapeReflection.py +131 -0
- spire/xls/ShapeSegmentPath.py +26 -0
- spire/xls/SheetProtectionType.py +33 -0
- spire/xls/SortColumn.py +120 -0
- spire/xls/SortColumns.py +185 -0
- spire/xls/SortComparsionType.py +19 -0
- spire/xls/SortOrientationType.py +17 -0
- spire/xls/SortedWayType.py +18 -0
- spire/xls/Sparkline.py +70 -0
- spire/xls/SparklineCollection.py +112 -0
- spire/xls/SparklineEmptyCells.py +16 -0
- spire/xls/SparklineGroup.py +523 -0
- spire/xls/SparklineGroupCollection.py +71 -0
- spire/xls/SparklineType.py +18 -0
- spire/xls/SpartlineVerticalAxisType.py +16 -0
- spire/xls/SpinnerShapeCollection.py +70 -0
- spire/xls/SplitType.py +19 -0
- spire/xls/StrikeThroughStyle.py +17 -0
- spire/xls/StringUtil.py +12 -0
- spire/xls/StyleArrayWrapper.py +621 -0
- spire/xls/StyleDefineType.py +15 -0
- spire/xls/StylesCollection.py +141 -0
- spire/xls/SubtotalTypes.py +26 -0
- spire/xls/TRangeValueType.py +19 -0
- spire/xls/TableBuiltInStyles.py +75 -0
- spire/xls/TextBoxCollection.py +70 -0
- spire/xls/TextBoxShapeBase.py +140 -0
- spire/xls/TextDirection.py +20 -0
- spire/xls/TextDirectionType.py +16 -0
- spire/xls/TextRotationType.py +19 -0
- spire/xls/TextSaveOptions.py +85 -0
- spire/xls/TextVerticalValue.py +19 -0
- spire/xls/ThemeColorType.py +27 -0
- spire/xls/TickLabelPositionType.py +19 -0
- spire/xls/TickMarkType.py +19 -0
- spire/xls/TimePeriodType.py +23 -0
- spire/xls/Top10Filter.py +75 -0
- spire/xls/TopBottom.py +44 -0
- spire/xls/TopBottomType.py +19 -0
- spire/xls/TopFormatType.py +18 -0
- spire/xls/TrendLineType.py +21 -0
- spire/xls/UnderlineStyle.py +32 -0
- spire/xls/UnknownVariableAction.py +18 -0
- spire/xls/UtilityMethods.py +55 -0
- spire/xls/VPageBreak.py +34 -0
- spire/xls/VPageBreaksCollection.py +96 -0
- spire/xls/Validation.py +33 -0
- spire/xls/ValidationComparisonOperator.py +23 -0
- spire/xls/VariableTypeAction.py +19 -0
- spire/xls/VerticalAlignType.py +20 -0
- spire/xls/ViewMode.py +18 -0
- spire/xls/WebQueryConnection.py +224 -0
- spire/xls/Workbook.py +3152 -0
- spire/xls/WorkbookObjectsCollection.py +25 -0
- spire/xls/Worksheet.py +1319 -0
- spire/xls/WorksheetChartsCollection.py +83 -0
- spire/xls/WorksheetConditionalFormats.py +12 -0
- spire/xls/WorksheetCopyType.py +31 -0
- spire/xls/WorksheetVisibility.py +18 -0
- spire/xls/WorksheetsCollection.py +341 -0
- spire/xls/WriteProtection.py +64 -0
- spire/xls/XLSXBorderJoinType.py +19 -0
- spire/xls/XLSXChartBevelType.py +26 -0
- spire/xls/XLSXChartLightingType.py +40 -0
- spire/xls/XLSXChartMaterialType.py +32 -0
- spire/xls/XLSXChartPrespectiveType.py +21 -0
- spire/xls/XLSXChartShadowInnerType.py +25 -0
- spire/xls/XLSXChartShadowOuterType.py +25 -0
- spire/xls/XLSXPivotItemType.py +28 -0
- spire/xls/XlsAddInFunction.py +78 -0
- spire/xls/XlsAddInFunctionsCollection.py +101 -0
- spire/xls/XlsArcShape.py +331 -0
- spire/xls/XlsAutoFiltersCollection.py +119 -0
- spire/xls/XlsBitmapShape.py +297 -0
- spire/xls/XlsBorder.py +172 -0
- spire/xls/XlsBorderArrayWrapper.py +116 -0
- spire/xls/XlsBordersCollection.py +101 -0
- spire/xls/XlsBuiltInDocumentProperties.py +639 -0
- spire/xls/XlsButtonShape.py +137 -0
- spire/xls/XlsChart.py +1510 -0
- spire/xls/XlsChartAxis.py +564 -0
- spire/xls/XlsChartBorder.py +165 -0
- spire/xls/XlsChartCategoryAxis.py +656 -0
- spire/xls/XlsChartDataLabelArea.py +387 -0
- spire/xls/XlsChartDataLabels.py +811 -0
- spire/xls/XlsChartDataPoint.py +108 -0
- spire/xls/XlsChartDataPointsCollection.py +120 -0
- spire/xls/XlsChartDataTable.py +393 -0
- spire/xls/XlsChartDropBar.py +301 -0
- spire/xls/XlsChartFill.py +571 -0
- spire/xls/XlsChartFormat.py +1069 -0
- spire/xls/XlsChartFormatCollection.py +162 -0
- spire/xls/XlsChartFrameFormat.py +614 -0
- spire/xls/XlsChartGridLine.py +171 -0
- spire/xls/XlsChartInterior.py +240 -0
- spire/xls/XlsChartLegend.py +355 -0
- spire/xls/XlsChartLegendArea.py +419 -0
- spire/xls/XlsChartLegendEntry.py +156 -0
- spire/xls/XlsChartPageSetup.py +56 -0
- spire/xls/XlsChartPlotArea.py +12 -0
- spire/xls/XlsChartSerie.py +589 -0
- spire/xls/XlsChartSerieDataFormat.py +1008 -0
- spire/xls/XlsChartSeries.py +111 -0
- spire/xls/XlsChartSeriesAxis.py +212 -0
- spire/xls/XlsChartShape.py +1142 -0
- spire/xls/XlsChartTitleArea.py +392 -0
- spire/xls/XlsChartValueAxis.py +317 -0
- spire/xls/XlsChartWallOrFloor.py +319 -0
- spire/xls/XlsChartsCollection.py +89 -0
- spire/xls/XlsCheckBoxShape.py +156 -0
- spire/xls/XlsComboBoxShape.py +128 -0
- spire/xls/XlsComment.py +234 -0
- spire/xls/XlsCommentsCollection.py +87 -0
- spire/xls/XlsConditionValue.py +111 -0
- spire/xls/XlsConditionalFormat.py +1119 -0
- spire/xls/XlsConditionalFormats.py +590 -0
- spire/xls/XlsDataValidationCollection.py +159 -0
- spire/xls/XlsDataValidationTable.py +105 -0
- spire/xls/XlsDocumentProperty.py +370 -0
- spire/xls/XlsEventArgs.py +93 -0
- spire/xls/XlsEventHandler.py +52 -0
- spire/xls/XlsFill.py +139 -0
- spire/xls/XlsFont.py +364 -0
- spire/xls/XlsFontStyle.py +12 -0
- spire/xls/XlsFontsCollection.py +51 -0
- spire/xls/XlsGradient.py +185 -0
- spire/xls/XlsGradientStop.py +85 -0
- spire/xls/XlsGroupBoxShape.py +88 -0
- spire/xls/XlsHPageBreak.py +105 -0
- spire/xls/XlsHPageBreaksCollection.py +85 -0
- spire/xls/XlsHeaderFooterShapeCollection.py +57 -0
- spire/xls/XlsHyperLink.py +229 -0
- spire/xls/XlsHyperLinksCollection.py +102 -0
- spire/xls/XlsLabelShape.py +73 -0
- spire/xls/XlsLineShape.py +367 -0
- spire/xls/XlsListBoxShape.py +124 -0
- spire/xls/XlsName.py +1871 -0
- spire/xls/XlsObject.py +36 -0
- spire/xls/XlsOvalShape.py +176 -0
- spire/xls/XlsPageSetup.py +220 -0
- spire/xls/XlsPageSetupBase.py +1354 -0
- spire/xls/XlsPicturesCollection.py +365 -0
- spire/xls/XlsPivotCache.py +401 -0
- spire/xls/XlsPivotCacheField.py +209 -0
- spire/xls/XlsPivotCachesCollection.py +124 -0
- spire/xls/XlsPivotField.py +885 -0
- spire/xls/XlsPivotTable.py +905 -0
- spire/xls/XlsPivotTablesCollection.py +131 -0
- spire/xls/XlsPrstGeomShape.py +97 -0
- spire/xls/XlsRadioButtonShape.py +188 -0
- spire/xls/XlsRange.py +3193 -0
- spire/xls/XlsRangesCollection.py +1566 -0
- spire/xls/XlsRectangleShape.py +174 -0
- spire/xls/XlsScrollBarShape.py +146 -0
- spire/xls/XlsShape.py +967 -0
- spire/xls/XlsShapeFill.py +627 -0
- spire/xls/XlsShapeLineFormat.py +341 -0
- spire/xls/XlsSpinnerShape.py +116 -0
- spire/xls/XlsStyle.py +106 -0
- spire/xls/XlsStylesCollection.py +73 -0
- spire/xls/XlsTextBoxShape.py +480 -0
- spire/xls/XlsVPageBreak.py +98 -0
- spire/xls/XlsVPageBreaksCollection.py +84 -0
- spire/xls/XlsValidation.py +520 -0
- spire/xls/XlsValidationWrapper.py +397 -0
- spire/xls/XlsWorkbook.py +1947 -0
- spire/xls/XlsWorkbookObjectsCollection.py +94 -0
- spire/xls/XlsWorksheet.py +4352 -0
- spire/xls/XlsWorksheetBase.py +1273 -0
- spire/xls/XlsWorksheetChartsCollection.py +25 -0
- spire/xls/XlsWorksheetConditionalFormats.py +215 -0
- spire/xls/XlsWorksheetsCollection.py +416 -0
- spire/xls/XmlOpenType.py +14 -0
- spire/xls/__init__.py +723 -0
- spire/xls/common/Boolean.py +192 -0
- spire/xls/common/Byte.py +256 -0
- spire/xls/common/Char.py +740 -0
- spire/xls/common/Color.py +2187 -0
- spire/xls/common/Common.py +150 -0
- spire/xls/common/CultureInfo.py +565 -0
- spire/xls/common/DateTime.py +1147 -0
- spire/xls/common/Double.py +438 -0
- spire/xls/common/EmfType.py +23 -0
- spire/xls/common/Encoding.py +928 -0
- spire/xls/common/FontStyle.py +25 -0
- spire/xls/common/GraphicsUnit.py +27 -0
- spire/xls/common/ICollection.py +70 -0
- spire/xls/common/IDictionary.py +122 -0
- spire/xls/common/IEnumerable.py +41 -0
- spire/xls/common/IEnumerator.py +60 -0
- spire/xls/common/IList.py +145 -0
- spire/xls/common/Int16.py +272 -0
- spire/xls/common/Int32.py +280 -0
- spire/xls/common/Int64.py +256 -0
- spire/xls/common/License.py +175 -0
- spire/xls/common/PixelFormat.py +43 -0
- spire/xls/common/Point.py +298 -0
- spire/xls/common/PointF.py +274 -0
- spire/xls/common/Rectangle.py +449 -0
- spire/xls/common/RectangleF.py +436 -0
- spire/xls/common/Regex.py +962 -0
- spire/xls/common/RegexOptions.py +29 -0
- spire/xls/common/Single.py +416 -0
- spire/xls/common/Size.py +271 -0
- spire/xls/common/SizeF.py +259 -0
- spire/xls/common/SpireObject.py +79 -0
- spire/xls/common/Stream.py +550 -0
- spire/xls/common/String.py +1878 -0
- spire/xls/common/TimeSpan.py +872 -0
- spire/xls/common/UInt16.py +272 -0
- spire/xls/common/UInt32.py +272 -0
- spire/xls/common/UInt64.py +272 -0
- spire/xls/common/__init__.py +316 -0
- spire/xls/lib/Spire.Xls.Base.dll +0 -0
- spire/xls/lib/__init__.py +0 -0
- spire/xls/lib/libSkiaSharp.dll +0 -0
- spire_xls-15.5.0.dist-info/METADATA +197 -0
- spire_xls-15.5.0.dist-info/RECORD +703 -0
- spire_xls-15.5.0.dist-info/WHEEL +5 -0
- spire_xls-15.5.0.dist-info/top_level.txt +1 -0
spire/xls/IWorksheet.py
ADDED
|
@@ -0,0 +1,2694 @@
|
|
|
1
|
+
from enum import Enum
|
|
2
|
+
from plum import dispatch
|
|
3
|
+
from typing import TypeVar,Union,Generic,List,Tuple
|
|
4
|
+
from spire.xls.common import *
|
|
5
|
+
from spire.xls import *
|
|
6
|
+
from ctypes import *
|
|
7
|
+
import abc
|
|
8
|
+
|
|
9
|
+
class IWorksheet ( ITabSheet, IExcelApplication) :
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
@abc.abstractmethod
|
|
15
|
+
def Protect(self ,password:str):
|
|
16
|
+
"""
|
|
17
|
+
<summary>
|
|
18
|
+
Protects worksheet's content with password.
|
|
19
|
+
<example>The following code illustrates how to protect the sheet except select lock/unlock cells:
|
|
20
|
+
<code>
|
|
21
|
+
//Create worksheet
|
|
22
|
+
Workbook workbook = new Workbook();
|
|
23
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
24
|
+
//Protects the first worksheet's content with password
|
|
25
|
+
worksheet.Protect("123456");
|
|
26
|
+
//Save to file
|
|
27
|
+
workbook.SaveToFile("Protect.xlsx");
|
|
28
|
+
</code>
|
|
29
|
+
</example>
|
|
30
|
+
</summary>
|
|
31
|
+
<param name="password">Password to protect with.</param>
|
|
32
|
+
"""
|
|
33
|
+
pass
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
@abc.abstractmethod
|
|
38
|
+
def Unprotect(self ,password:str):
|
|
39
|
+
"""
|
|
40
|
+
<summary>
|
|
41
|
+
Unprotects worksheet's content with password.
|
|
42
|
+
</summary>
|
|
43
|
+
<param name="password">Password to unprotect.</param>
|
|
44
|
+
"""
|
|
45
|
+
pass
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
@abc.abstractmethod
|
|
50
|
+
def AutoFitRow(self ,rowIndex:int):
|
|
51
|
+
"""
|
|
52
|
+
<summary>
|
|
53
|
+
Autofits specified row.
|
|
54
|
+
<example>The following code illustrates how to Auto-fit the row:
|
|
55
|
+
<code>
|
|
56
|
+
//Create worksheet
|
|
57
|
+
Workbook workbook = new Workbook();
|
|
58
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
59
|
+
//Set text
|
|
60
|
+
worksheet["C2"].Value = "Sample text";
|
|
61
|
+
//Set Style
|
|
62
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
63
|
+
IFont font = style.Font;
|
|
64
|
+
font.Size = 18;
|
|
65
|
+
worksheet["C2"].Style = style;
|
|
66
|
+
//Set auto fit
|
|
67
|
+
worksheet.AutoFitRow(2);
|
|
68
|
+
//Save to file
|
|
69
|
+
workbook.SaveToFile("AutoFitRow.xlsx");
|
|
70
|
+
</code>
|
|
71
|
+
</example>
|
|
72
|
+
</summary>
|
|
73
|
+
<param name="rowIndex">One-based row index.</param>
|
|
74
|
+
"""
|
|
75
|
+
pass
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
@abc.abstractmethod
|
|
80
|
+
def AutoFitColumn(self ,columnIndex:int):
|
|
81
|
+
"""
|
|
82
|
+
<summary>
|
|
83
|
+
Autofits specified column.
|
|
84
|
+
<example>The following code illustrates how to Auto-fit the column:
|
|
85
|
+
<code>
|
|
86
|
+
//Create worksheet
|
|
87
|
+
Workbook workbook = new Workbook();
|
|
88
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
89
|
+
//Set text
|
|
90
|
+
worksheet["A1"].Text = "Sample text in cell";
|
|
91
|
+
//Set auto fit
|
|
92
|
+
worksheet.AutoFitColumn(1);
|
|
93
|
+
//Save to file
|
|
94
|
+
workbook.SaveToFile("AutoFitColumn.xlsx");
|
|
95
|
+
</code>
|
|
96
|
+
</example>
|
|
97
|
+
</summary>
|
|
98
|
+
<param name="columnIndex">One-based column index.</param>
|
|
99
|
+
"""
|
|
100
|
+
pass
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
@dispatch
|
|
104
|
+
|
|
105
|
+
@abc.abstractmethod
|
|
106
|
+
def Replace(self ,oldValue:str,newValue:str):
|
|
107
|
+
"""
|
|
108
|
+
<summary>
|
|
109
|
+
Replaces specified string by specified value.
|
|
110
|
+
<example>The following code snippet illustrates how to replace the string with another string:
|
|
111
|
+
<code>
|
|
112
|
+
//Create worksheet
|
|
113
|
+
Workbook workbook = new Workbook();
|
|
114
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
115
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
116
|
+
//Replace the oldValue by newValue
|
|
117
|
+
string oldValue = "Find";
|
|
118
|
+
string newValue = "NewValue";
|
|
119
|
+
worksheet.Replace(oldValue, newValue);
|
|
120
|
+
//Save to file
|
|
121
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
122
|
+
</code>
|
|
123
|
+
</example>
|
|
124
|
+
</summary>
|
|
125
|
+
<param name="oldValue">String value to replace.</param>
|
|
126
|
+
<param name="newValue">New value for the range with specified string.</param>
|
|
127
|
+
"""
|
|
128
|
+
pass
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
@dispatch
|
|
132
|
+
|
|
133
|
+
@abc.abstractmethod
|
|
134
|
+
def Replace(self ,oldValue:str,newValue:float):
|
|
135
|
+
"""
|
|
136
|
+
<summary>
|
|
137
|
+
Replaces specified string by specified value.
|
|
138
|
+
<example>The following code snippet illustrates how to replace the string with double:
|
|
139
|
+
<code>
|
|
140
|
+
//Create worksheet
|
|
141
|
+
Workbook workbook = new Workbook();
|
|
142
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
143
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
144
|
+
//Replace the oldValue by double
|
|
145
|
+
string oldValue = "Ten";
|
|
146
|
+
worksheet.Replace(oldValue, 10.0);
|
|
147
|
+
//Save to file
|
|
148
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
149
|
+
</code>
|
|
150
|
+
</example>
|
|
151
|
+
</summary>
|
|
152
|
+
<param name="oldValue">String value to replace.</param>
|
|
153
|
+
<param name="newValue">New value for the range with specified string.</param>
|
|
154
|
+
"""
|
|
155
|
+
pass
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
@dispatch
|
|
159
|
+
|
|
160
|
+
@abc.abstractmethod
|
|
161
|
+
def Replace(self ,oldValue:str,newValue:DateTime):
|
|
162
|
+
"""
|
|
163
|
+
<summary>
|
|
164
|
+
Replaces specified string by specified value.
|
|
165
|
+
<example>The following code illustrates how to replace the string value with datetime:
|
|
166
|
+
<code>
|
|
167
|
+
//Create worksheet
|
|
168
|
+
Workbook workbook = new Workbook();
|
|
169
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
170
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
171
|
+
//Replace the oldValue by dateTime
|
|
172
|
+
string oldValue = "Find";
|
|
173
|
+
DateTime dateTime = DateTime.Now;
|
|
174
|
+
worksheet.Replace(oldValue, dateTime);
|
|
175
|
+
//Save to file
|
|
176
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
177
|
+
</code>
|
|
178
|
+
</example>
|
|
179
|
+
</summary>
|
|
180
|
+
<param name="oldValue">String value to replace.</param>
|
|
181
|
+
<param name="newValue">New value for the range with specified string.</param>
|
|
182
|
+
"""
|
|
183
|
+
pass
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
@dispatch
|
|
187
|
+
|
|
188
|
+
@abc.abstractmethod
|
|
189
|
+
def Replace(self ,oldValue:str,newValues:List[str],isVertical:bool):
|
|
190
|
+
"""
|
|
191
|
+
<summary>
|
|
192
|
+
Replaces specified string by data from array.
|
|
193
|
+
<example>The following code snippet illustrates how to replace the string with array of string values:
|
|
194
|
+
<code>
|
|
195
|
+
//Create worksheet
|
|
196
|
+
Workbook workbook = new Workbook();
|
|
197
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
198
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
199
|
+
//Replace the oldValue by array of string values
|
|
200
|
+
string oldValue = "Find";
|
|
201
|
+
string[] newValues = { "X values", "Y values" };
|
|
202
|
+
worksheet.Replace(oldValue, newValues , true);
|
|
203
|
+
//Save to file
|
|
204
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
205
|
+
</code>
|
|
206
|
+
</example>
|
|
207
|
+
</summary>
|
|
208
|
+
<param name="oldValue">String value to replace.</param>
|
|
209
|
+
<param name="newValues">Array of new values.</param>
|
|
210
|
+
<param name="isVertical">Indicates whether array should be inserted vertically.</param>
|
|
211
|
+
"""
|
|
212
|
+
pass
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
@dispatch
|
|
216
|
+
|
|
217
|
+
@abc.abstractmethod
|
|
218
|
+
def Replace(self ,oldValue:str,newValues:List[int],isVertical:bool):
|
|
219
|
+
"""
|
|
220
|
+
<summary>
|
|
221
|
+
Replaces specified string by data from array.
|
|
222
|
+
<example>The following code snippet illustrates how to replace the string with array of int values:
|
|
223
|
+
<code>
|
|
224
|
+
//Create worksheet
|
|
225
|
+
Workbook workbook = new Workbook();
|
|
226
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
227
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
228
|
+
//Replace the oldValue by array of int values
|
|
229
|
+
string oldValue = "Find";
|
|
230
|
+
int[] newValues = { 1, 2 };
|
|
231
|
+
worksheet.Replace(oldValue, newValues, true);
|
|
232
|
+
//Save to file
|
|
233
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
234
|
+
</code>
|
|
235
|
+
</example>
|
|
236
|
+
</summary>
|
|
237
|
+
<param name="oldValue">String value to replace.</param>
|
|
238
|
+
<param name="newValues">Array of new values.</param>
|
|
239
|
+
<param name="isVertical">Indicates whether array should be inserted vertically.</param>
|
|
240
|
+
"""
|
|
241
|
+
pass
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
@dispatch
|
|
245
|
+
|
|
246
|
+
@abc.abstractmethod
|
|
247
|
+
def Replace(self ,oldValue:str,newValues:List[float],isVertical:bool):
|
|
248
|
+
"""
|
|
249
|
+
<summary>
|
|
250
|
+
Replaces specified string by data from array.
|
|
251
|
+
<example>The following code snippet illustrates how to replace the string with array of double values:
|
|
252
|
+
<code>
|
|
253
|
+
//Create worksheet
|
|
254
|
+
Workbook workbook = new Workbook();
|
|
255
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
256
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
257
|
+
//Replace the oldValue by array of double values
|
|
258
|
+
string oldValue = "Find";
|
|
259
|
+
double[] newValues = { 1.0, 2.0 };
|
|
260
|
+
worksheet.Replace(oldValue, newValues, true);
|
|
261
|
+
//Save to file
|
|
262
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
263
|
+
</code>
|
|
264
|
+
</example>
|
|
265
|
+
</summary>
|
|
266
|
+
<param name="oldValue">String value to replace.</param>
|
|
267
|
+
<param name="newValues">Array of new values.</param>
|
|
268
|
+
<param name="isVertical">Indicates whether array should be inserted vertically.</param>
|
|
269
|
+
"""
|
|
270
|
+
pass
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
# @dispatch
|
|
274
|
+
#
|
|
275
|
+
# @abc.abstractmethod
|
|
276
|
+
# def Replace(self ,oldValue:str,newValues:'DataTable',isFieldNamesShown:bool):
|
|
277
|
+
# """
|
|
278
|
+
# <summary>
|
|
279
|
+
# Replaces specified string by data table values.
|
|
280
|
+
# <example>The following code snippet illustrates how to replace the string value with data table:
|
|
281
|
+
# <code>
|
|
282
|
+
# //Create worksheet
|
|
283
|
+
# Workbook workbook = new Workbook();
|
|
284
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
285
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
286
|
+
# //Replace the oldValue by data table
|
|
287
|
+
# string oldValue = "Find";
|
|
288
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
289
|
+
# table.Columns.Add("Dosage", typeof(int));
|
|
290
|
+
# table.Rows.Add(1);
|
|
291
|
+
# worksheet.Replace(oldValue, table, true);
|
|
292
|
+
# //Save to file
|
|
293
|
+
# workbook.SaveToFile("Replace.xlsx");
|
|
294
|
+
# </code>
|
|
295
|
+
# </example>
|
|
296
|
+
# </summary>
|
|
297
|
+
# <param name="oldValue">String value to replace.</param>
|
|
298
|
+
# <param name="newValues">Data table with new data.</param>
|
|
299
|
+
# <param name="isFieldNamesShown">Indicates wheter field name must be shown.</param>
|
|
300
|
+
# """
|
|
301
|
+
# pass
|
|
302
|
+
#
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
# @dispatch
|
|
306
|
+
#
|
|
307
|
+
# @abc.abstractmethod
|
|
308
|
+
# def Replace(self ,oldValue:str,newValues:'DataColumn',isFieldNamesShown:bool):
|
|
309
|
+
# """
|
|
310
|
+
# <summary>
|
|
311
|
+
# Replaces specified string by data column values.
|
|
312
|
+
# <example>The following code snippet illustrates how to replace the string value with data column:
|
|
313
|
+
# <code>
|
|
314
|
+
# //Create worksheet
|
|
315
|
+
# Workbook workbook = new Workbook();
|
|
316
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
317
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
318
|
+
# //Replace the oldValue by data column
|
|
319
|
+
# string oldValue = "Find";
|
|
320
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
321
|
+
# table.Columns.Add("Dosage", typeof(int));
|
|
322
|
+
# table.Rows.Add(1);
|
|
323
|
+
# System.Data.DataColumn dataColumn = table.Columns[0];
|
|
324
|
+
# worksheet.Replace(oldValue, dataColumn, true);
|
|
325
|
+
# //Save to file
|
|
326
|
+
# workbook.SaveToFile("Replace.xlsx");
|
|
327
|
+
# </code>
|
|
328
|
+
# </example>
|
|
329
|
+
# </summary>
|
|
330
|
+
# <param name="oldValue">String value to replace.</param>
|
|
331
|
+
# <param name="newValues">Data table with new data.</param>
|
|
332
|
+
# <param name="isFieldNamesShown">Indicates whether field name must be shown.</param>
|
|
333
|
+
# """
|
|
334
|
+
# pass
|
|
335
|
+
#
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
@abc.abstractmethod
|
|
339
|
+
def Remove(self):
|
|
340
|
+
"""
|
|
341
|
+
<summary>
|
|
342
|
+
Removes worksheet from parent worksheets collection.
|
|
343
|
+
</summary>
|
|
344
|
+
"""
|
|
345
|
+
pass
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
@abc.abstractmethod
|
|
350
|
+
def MoveWorksheet(self ,iNewIndex:int):
|
|
351
|
+
"""
|
|
352
|
+
<summary>
|
|
353
|
+
Moves worksheet.
|
|
354
|
+
</summary>
|
|
355
|
+
<param name="iNewIndex">New index of the worksheet.</param>
|
|
356
|
+
"""
|
|
357
|
+
pass
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
@abc.abstractmethod
|
|
362
|
+
def ColumnWidthToPixels(self ,widthInChars:float)->int:
|
|
363
|
+
"""
|
|
364
|
+
<summary>
|
|
365
|
+
Converts column width into pixels.
|
|
366
|
+
</summary>
|
|
367
|
+
<param name="widthInChars">Width in characters.</param>
|
|
368
|
+
<returns>Width in pixels</returns>
|
|
369
|
+
"""
|
|
370
|
+
pass
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
@abc.abstractmethod
|
|
375
|
+
def PixelsToColumnWidth(self ,pixels:float)->float:
|
|
376
|
+
"""
|
|
377
|
+
<summary>
|
|
378
|
+
Converts pixels into column width (in characters).
|
|
379
|
+
</summary>
|
|
380
|
+
<param name="pixels">Width in pixels</param>
|
|
381
|
+
<returns>Widht in characters.</returns>
|
|
382
|
+
"""
|
|
383
|
+
pass
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
@abc.abstractmethod
|
|
388
|
+
def SetColumnWidthInPixels(self ,columnIndex:int,value:int):
|
|
389
|
+
"""
|
|
390
|
+
<summary>
|
|
391
|
+
Sets column width in pixels.
|
|
392
|
+
<example>The following code illustrates how to set width for a column:
|
|
393
|
+
<code>
|
|
394
|
+
//Create worksheet
|
|
395
|
+
Workbook workbook = new Workbook();
|
|
396
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
397
|
+
//Set column width
|
|
398
|
+
worksheet.SetColumnWidthInPixels(2, 160);
|
|
399
|
+
//Save to file
|
|
400
|
+
workbook.SaveToFile("SetColumnWidthInPixels.xlsx");
|
|
401
|
+
</code>
|
|
402
|
+
</example>
|
|
403
|
+
</summary>
|
|
404
|
+
<param name="columnIndex">One-based column index.</param>
|
|
405
|
+
<param name="value">Width to set.</param>
|
|
406
|
+
"""
|
|
407
|
+
pass
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
@abc.abstractmethod
|
|
412
|
+
def SetRowHeightPixels(self ,Row:int,value:float):
|
|
413
|
+
"""
|
|
414
|
+
<summary>
|
|
415
|
+
Sets row height in pixels.
|
|
416
|
+
<example>The following code illustrates how to set height for a row:
|
|
417
|
+
<code>
|
|
418
|
+
//Create worksheet
|
|
419
|
+
Workbook workbook = new Workbook();
|
|
420
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
421
|
+
//Set row height
|
|
422
|
+
worksheet.SetRowHeightPixels(3, 150);
|
|
423
|
+
//Save to file
|
|
424
|
+
workbook.SaveToFile("SetRowHeightPixels.xlsx");
|
|
425
|
+
</code>
|
|
426
|
+
</example>
|
|
427
|
+
</summary>
|
|
428
|
+
<param name="Row">One-based row index to set height.</param>
|
|
429
|
+
<param name="value">Value in pixels to set.</param>
|
|
430
|
+
"""
|
|
431
|
+
pass
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
@abc.abstractmethod
|
|
436
|
+
def GetColumnWidthPixels(self ,Column:int)->int:
|
|
437
|
+
"""
|
|
438
|
+
<summary>
|
|
439
|
+
Returns width in pixels from ColumnInfoRecord if there is corresponding ColumnInfoRecord
|
|
440
|
+
or StandardWidth if not.
|
|
441
|
+
<example>The following code illustrates how to get the column width for a particular column:
|
|
442
|
+
<code>
|
|
443
|
+
//Create worksheet
|
|
444
|
+
Workbook workbook = new Workbook();
|
|
445
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
446
|
+
//Set text
|
|
447
|
+
worksheet["A1"].Text = "Sample text in cell";
|
|
448
|
+
//Set auto fit
|
|
449
|
+
worksheet.AutoFitColumn(1);
|
|
450
|
+
//Get column width
|
|
451
|
+
Console.WriteLine(worksheet.GetColumnWidthPixels(1));
|
|
452
|
+
//Save to file
|
|
453
|
+
workbook.SaveToFile("UsedRange.xlsx");
|
|
454
|
+
</code>
|
|
455
|
+
</example>
|
|
456
|
+
</summary>
|
|
457
|
+
<param name="Column">One-based index of the column.</param>
|
|
458
|
+
<returns>Width in pixels of the specified column.</returns>
|
|
459
|
+
"""
|
|
460
|
+
pass
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
@abc.abstractmethod
|
|
465
|
+
def GetRowHeightPixels(self ,Row:int)->int:
|
|
466
|
+
"""
|
|
467
|
+
<summary>
|
|
468
|
+
Returns height from RowRecord if there is a corresponding RowRecord.
|
|
469
|
+
Otherwise returns StandardHeight.
|
|
470
|
+
<example>The following code illustrates how to get the row height for a particular row:
|
|
471
|
+
<code>
|
|
472
|
+
//Create worksheet
|
|
473
|
+
Workbook workbook = new Workbook();
|
|
474
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
475
|
+
//Set text
|
|
476
|
+
worksheet["C2"].Text = "Sample text";
|
|
477
|
+
worksheet["C2"].Style.Font.Size = 18;
|
|
478
|
+
//Set auto fit
|
|
479
|
+
worksheet.AutoFitRow(2);
|
|
480
|
+
//Get row height
|
|
481
|
+
Console.WriteLine(worksheet.GetRowHeightPixels(2));
|
|
482
|
+
//Save to file
|
|
483
|
+
workbook.SaveToFile("UsedRange.xlsx");
|
|
484
|
+
</code>
|
|
485
|
+
</example>
|
|
486
|
+
</summary>
|
|
487
|
+
<param name="Row">One-bazed index of the row.</param>
|
|
488
|
+
<returns>
|
|
489
|
+
Height in pixels from RowRecord if there is corresponding RowRecord.
|
|
490
|
+
Otherwise returns StandardHeight.
|
|
491
|
+
</returns>
|
|
492
|
+
"""
|
|
493
|
+
pass
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
@abc.abstractmethod
|
|
498
|
+
def SaveToFile(self ,fileName:str,separator:str):
|
|
499
|
+
"""
|
|
500
|
+
<summary>
|
|
501
|
+
Save tabsheet using separator.
|
|
502
|
+
</summary>
|
|
503
|
+
<example>The following code illustrates how to saves the worksheet in a different file with separator:
|
|
504
|
+
<code>
|
|
505
|
+
//Create worksheet
|
|
506
|
+
Workbook workbook = new Workbook();
|
|
507
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
508
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
509
|
+
//Save to file
|
|
510
|
+
worksheet.SaveToFile("SaveToFile.csv" , ",");</para></code></example>
|
|
511
|
+
<param name="fileName">File to save.</param>
|
|
512
|
+
<param name="separator">Current seperator.</param>
|
|
513
|
+
"""
|
|
514
|
+
pass
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
@abc.abstractmethod
|
|
519
|
+
def SaveToStream(self ,stream:'Stream',separator:str):
|
|
520
|
+
"""
|
|
521
|
+
<summary>
|
|
522
|
+
Save tabsheet using separator.
|
|
523
|
+
<example>The following code illustrates how to saves the worksheet as stream with separator:
|
|
524
|
+
<code>
|
|
525
|
+
//Create worksheet
|
|
526
|
+
Workbook workbook = new Workbook();
|
|
527
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
528
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
529
|
+
//Create stream
|
|
530
|
+
Stream stream = new MemoryStream();
|
|
531
|
+
//Save to stream
|
|
532
|
+
worksheet.SaveToStream(stream , ",");
|
|
533
|
+
</code>
|
|
534
|
+
</example>
|
|
535
|
+
</summary>
|
|
536
|
+
<param name="stream">Stream to save. </param>
|
|
537
|
+
<param name="separator">Current seperator.</param>
|
|
538
|
+
"""
|
|
539
|
+
pass
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
@dispatch
|
|
543
|
+
|
|
544
|
+
@abc.abstractmethod
|
|
545
|
+
def SetDefaultColumnStyle(self ,iColumnIndex:int,defaultStyle:IStyle):
|
|
546
|
+
"""
|
|
547
|
+
<summary>
|
|
548
|
+
Sets by column index default style for column.
|
|
549
|
+
<example>The following code illustrates how to set the default style for a column:
|
|
550
|
+
<code>
|
|
551
|
+
//Create worksheet
|
|
552
|
+
Workbook workbook = new Workbook();
|
|
553
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
554
|
+
//Create style
|
|
555
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
556
|
+
//Set Color
|
|
557
|
+
style.Color = Color.Red;
|
|
558
|
+
//Set default style
|
|
559
|
+
worksheet.SetDefaultColumnStyle(2, style);
|
|
560
|
+
//Save to file
|
|
561
|
+
workbook.SaveToFile("SetDefaultColumnStyle.xlsx");
|
|
562
|
+
</code>
|
|
563
|
+
</example>
|
|
564
|
+
</summary>
|
|
565
|
+
<param name="iColumnIndex">Column index.</param>
|
|
566
|
+
<param name="defaultStyle">Default style.</param>
|
|
567
|
+
"""
|
|
568
|
+
pass
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
@dispatch
|
|
572
|
+
|
|
573
|
+
@abc.abstractmethod
|
|
574
|
+
def SetDefaultColumnStyle(self ,iStartColumnIndex:int,iEndColumnIndex:int,defaultStyle:IStyle):
|
|
575
|
+
"""
|
|
576
|
+
<summary>
|
|
577
|
+
Sets by column index default style for column.
|
|
578
|
+
<example>The following code illustrates how to set the default style for columns:
|
|
579
|
+
<code>
|
|
580
|
+
//Create worksheet
|
|
581
|
+
Workbook workbook = new Workbook();
|
|
582
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
583
|
+
//Create style
|
|
584
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
585
|
+
//Set Color
|
|
586
|
+
style.Color = Color.Red;
|
|
587
|
+
//Set default style
|
|
588
|
+
worksheet.SetDefaultColumnStyle(2, 5, style);
|
|
589
|
+
//Save to file
|
|
590
|
+
workbook.SaveToFile("SetDefaultColumnStyle.xlsx");
|
|
591
|
+
</code>
|
|
592
|
+
</example>
|
|
593
|
+
</summary>
|
|
594
|
+
<param name="iStartColumnIndex">Start column index.</param>
|
|
595
|
+
<param name="iEndColumnIndex">End column index.</param>
|
|
596
|
+
<param name="defaultStyle">Default style.</param>
|
|
597
|
+
"""
|
|
598
|
+
pass
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
@dispatch
|
|
602
|
+
|
|
603
|
+
@abc.abstractmethod
|
|
604
|
+
def SetDefaultRowStyle(self ,rowIndex:int,defaultStyle:IStyle):
|
|
605
|
+
"""
|
|
606
|
+
<summary>
|
|
607
|
+
Sets by column index default style for row.
|
|
608
|
+
<example>The following code illustrates how to set the default style for a row:
|
|
609
|
+
<code>
|
|
610
|
+
//Create worksheet
|
|
611
|
+
Workbook workbook = new Workbook();
|
|
612
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
613
|
+
//Create style
|
|
614
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
615
|
+
//Set Color
|
|
616
|
+
style.Color = Color.Red;
|
|
617
|
+
//Set default style
|
|
618
|
+
worksheet.SetDefaultRowStyle(2, style);
|
|
619
|
+
//Save to file
|
|
620
|
+
workbook.SaveToFile("SetDefaultRowStyle.xlsx");
|
|
621
|
+
</code>
|
|
622
|
+
</example>
|
|
623
|
+
</summary>
|
|
624
|
+
<param name="rowIndex">Row index.</param>
|
|
625
|
+
<param name="defaultStyle">Default style.</param>
|
|
626
|
+
"""
|
|
627
|
+
pass
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
@dispatch
|
|
631
|
+
|
|
632
|
+
@abc.abstractmethod
|
|
633
|
+
def SetDefaultRowStyle(self ,iStartRowIndex:int,iEndRowIndex:int,defaultStyle:IStyle):
|
|
634
|
+
"""
|
|
635
|
+
<summary>
|
|
636
|
+
Sets by column index default style for row.
|
|
637
|
+
<example>The following code illustrates how to set the default style for rows:
|
|
638
|
+
<code>
|
|
639
|
+
//Create worksheet
|
|
640
|
+
Workbook workbook = new Workbook();
|
|
641
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
642
|
+
//Create style
|
|
643
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
644
|
+
//Set Color
|
|
645
|
+
style.Color = Color.Red;
|
|
646
|
+
//Set default style
|
|
647
|
+
worksheet.SetDefaultRowStyle(2, 5, style);
|
|
648
|
+
//Save to file
|
|
649
|
+
workbook.SaveToFile("SetDefaultRowStyle.xlsx");
|
|
650
|
+
</code>
|
|
651
|
+
</example>
|
|
652
|
+
</summary>
|
|
653
|
+
<param name="iStartRowIndex">Start row index.</param>
|
|
654
|
+
<param name="iEndRowIndex">End row index.</param>
|
|
655
|
+
<param name="defaultStyle">Default style.</param>
|
|
656
|
+
"""
|
|
657
|
+
pass
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
@abc.abstractmethod
|
|
662
|
+
def GetDefaultColumnStyle(self ,iColumnIndex:int)->'IStyle':
|
|
663
|
+
"""
|
|
664
|
+
<summary>
|
|
665
|
+
Returns default column style.
|
|
666
|
+
<example>The following code illustrates how to get default column style:
|
|
667
|
+
<code>
|
|
668
|
+
//Create worksheet
|
|
669
|
+
Workbook workbook = new Workbook();
|
|
670
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
671
|
+
//Create style
|
|
672
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
673
|
+
//Set Color
|
|
674
|
+
style.Color = Color.Red;
|
|
675
|
+
//Set default style
|
|
676
|
+
worksheet.SetDefaultColumnStyle(2,style);
|
|
677
|
+
//Get default style
|
|
678
|
+
CellStyle defaultStyle = worksheet.GetDefaultColumnStyle(2);
|
|
679
|
+
//Set color
|
|
680
|
+
defaultStyle.Color = Color.Blue;
|
|
681
|
+
worksheet.SetDefaultColumnStyle(3, defaultStyle);
|
|
682
|
+
//Save to file
|
|
683
|
+
workbook.SaveToFile("GetDefaultColumnStyle.xlsx");
|
|
684
|
+
</code>
|
|
685
|
+
</example>
|
|
686
|
+
</summary>
|
|
687
|
+
<param name="iColumnIndex">Column index.</param>
|
|
688
|
+
<returns>Default column style or null if style wasn't set.</returns>
|
|
689
|
+
"""
|
|
690
|
+
pass
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
@abc.abstractmethod
|
|
695
|
+
def GetDefaultRowStyle(self ,rowIndex:int)->'IStyle':
|
|
696
|
+
"""
|
|
697
|
+
<summary>
|
|
698
|
+
Returns default row style.
|
|
699
|
+
<example>The following code illustrates how to get default row style:
|
|
700
|
+
<code>
|
|
701
|
+
//Create worksheet
|
|
702
|
+
Workbook workbook = new Workbook();
|
|
703
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
704
|
+
//Create style
|
|
705
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
706
|
+
//Set Color
|
|
707
|
+
style.Color = Color.Red;
|
|
708
|
+
//Set default style
|
|
709
|
+
worksheet.SetDefaultRowStyle(2,style);
|
|
710
|
+
//Get default style
|
|
711
|
+
CellStyle defaultStyle = worksheet.GetDefaultRowStyle(2);
|
|
712
|
+
//Set color
|
|
713
|
+
defaultStyle.Color = Color.Blue;
|
|
714
|
+
worksheet.SetDefaultRowStyle(3, defaultStyle);
|
|
715
|
+
//Save to file
|
|
716
|
+
workbook.SaveToFile("GetDefaultColumnStyle.xlsx");
|
|
717
|
+
</code>
|
|
718
|
+
</example>
|
|
719
|
+
</summary>
|
|
720
|
+
<param name="rowIndex">Row index.</param>
|
|
721
|
+
<returns>Default row style or null if style wasn't set.</returns>
|
|
722
|
+
"""
|
|
723
|
+
pass
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
@abc.abstractmethod
|
|
728
|
+
def SetValue(self ,iRow:int,iColumn:int,value:str):
|
|
729
|
+
"""
|
|
730
|
+
<summary>
|
|
731
|
+
Sets value in the specified cell.
|
|
732
|
+
</summary>
|
|
733
|
+
<param name="iRow">One-based row index of the cell to set value.</param>
|
|
734
|
+
<param name="iColumn">One-based column index of the cell to set value.</param>
|
|
735
|
+
<param name="value">Value to set.</param>
|
|
736
|
+
"""
|
|
737
|
+
pass
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
@abc.abstractmethod
|
|
742
|
+
def SetNumber(self ,iRow:int,iColumn:int,value:float):
|
|
743
|
+
"""
|
|
744
|
+
<summary>
|
|
745
|
+
Sets value in the specified cell.
|
|
746
|
+
</summary>
|
|
747
|
+
<param name="iRow">One-based row index of the cell to set value.</param>
|
|
748
|
+
<param name="iColumn">One-based column index of the cell to set value.</param>
|
|
749
|
+
<param name="value">Value to set.</param>
|
|
750
|
+
"""
|
|
751
|
+
pass
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
@abc.abstractmethod
|
|
756
|
+
def SetBoolean(self ,iRow:int,iColumn:int,value:bool):
|
|
757
|
+
"""
|
|
758
|
+
<summary>
|
|
759
|
+
Sets value in the specified cell.
|
|
760
|
+
</summary>
|
|
761
|
+
<param name="iRow">One-based row index of the cell to set value.</param>
|
|
762
|
+
<param name="iColumn">One-based column index of the cell to set value.</param>
|
|
763
|
+
<param name="value">Value to set.</param>
|
|
764
|
+
"""
|
|
765
|
+
pass
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
@abc.abstractmethod
|
|
770
|
+
def SetText(self ,iRow:int,iColumn:int,value:str):
|
|
771
|
+
"""
|
|
772
|
+
<summary>
|
|
773
|
+
Sets text in the specified cell.
|
|
774
|
+
</summary>
|
|
775
|
+
<param name="iRow">One-based row index of the cell to set value.</param>
|
|
776
|
+
<param name="iColumn">One-based column index of the cell to set value.</param>
|
|
777
|
+
<param name="value">Text to set.</param>
|
|
778
|
+
"""
|
|
779
|
+
pass
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
@abc.abstractmethod
|
|
784
|
+
def SetFormula(self ,iRow:int,iColumn:int,value:str):
|
|
785
|
+
"""
|
|
786
|
+
<summary>
|
|
787
|
+
Sets formula in the specified cell.
|
|
788
|
+
</summary>
|
|
789
|
+
<param name="iRow">One-based row index of the cell to set value.</param>
|
|
790
|
+
<param name="iColumn">One-based column index of the cell to set value.</param>
|
|
791
|
+
<param name="value">Formula to set.</param>
|
|
792
|
+
"""
|
|
793
|
+
pass
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
@abc.abstractmethod
|
|
798
|
+
def SetError(self ,iRow:int,iColumn:int,value:str):
|
|
799
|
+
"""
|
|
800
|
+
<summary>
|
|
801
|
+
Sets error in the specified cell.
|
|
802
|
+
</summary>
|
|
803
|
+
<param name="iRow">One-based row index of the cell to set value.</param>
|
|
804
|
+
<param name="iColumn">One-based column index of the cell to set value.</param>
|
|
805
|
+
<param name="value">Error to set.</param>
|
|
806
|
+
"""
|
|
807
|
+
pass
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
@abc.abstractmethod
|
|
812
|
+
def SetBlank(self ,iRow:int,iColumn:int):
|
|
813
|
+
"""
|
|
814
|
+
<summary>
|
|
815
|
+
Sets blank in specified cell.
|
|
816
|
+
</summary>
|
|
817
|
+
<param name="iRow">One-based row index of the cell to set value.</param>
|
|
818
|
+
<param name="iColumn">One-based column index of the cell to set value.</param>
|
|
819
|
+
"""
|
|
820
|
+
pass
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
@abc.abstractmethod
|
|
825
|
+
def SetFormulaNumberValue(self ,iRow:int,iColumn:int,value:float):
|
|
826
|
+
"""
|
|
827
|
+
<summary>
|
|
828
|
+
Sets formula number value.
|
|
829
|
+
</summary>
|
|
830
|
+
<param name="iRow">One based row index.</param>
|
|
831
|
+
<param name="iColumn">One based column index.</param>
|
|
832
|
+
<param name="value">Represents formula number value for set.</param>
|
|
833
|
+
"""
|
|
834
|
+
pass
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
@abc.abstractmethod
|
|
839
|
+
def SetFormulaErrorValue(self ,iRow:int,iColumn:int,value:str):
|
|
840
|
+
"""
|
|
841
|
+
<summary>
|
|
842
|
+
Sets formula error value.
|
|
843
|
+
</summary>
|
|
844
|
+
<param name="iRow">One based row index.</param>
|
|
845
|
+
<param name="iColumn">One based column index.</param>
|
|
846
|
+
<param name="value">Represents formula error value for set.</param>
|
|
847
|
+
"""
|
|
848
|
+
pass
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
@abc.abstractmethod
|
|
853
|
+
def SetFormulaBoolValue(self ,iRow:int,iColumn:int,value:bool):
|
|
854
|
+
"""
|
|
855
|
+
<summary>
|
|
856
|
+
Sets formula bool value.
|
|
857
|
+
</summary>
|
|
858
|
+
<param name="iRow">One based row index.</param>
|
|
859
|
+
<param name="iColumn">One based column index.</param>
|
|
860
|
+
<param name="value">Represents formula bool value for set.</param>
|
|
861
|
+
"""
|
|
862
|
+
pass
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
@abc.abstractmethod
|
|
867
|
+
def SetFormulaStringValue(self ,iRow:int,iColumn:int,value:str):
|
|
868
|
+
"""
|
|
869
|
+
<summary>
|
|
870
|
+
Sets formula string value.
|
|
871
|
+
</summary>
|
|
872
|
+
<param name="iRow">One based row index.</param>
|
|
873
|
+
<param name="iColumn">One based column index.</param>
|
|
874
|
+
<param name="value">Represents formula string value for set.</param>
|
|
875
|
+
"""
|
|
876
|
+
pass
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
@abc.abstractmethod
|
|
881
|
+
def GetText(self ,row:int,column:int)->str:
|
|
882
|
+
"""
|
|
883
|
+
<summary>
|
|
884
|
+
Returns string value corresponding to the cell.
|
|
885
|
+
</summary>
|
|
886
|
+
<param name="row">One-based row index of the cell to get value from.</param>
|
|
887
|
+
<param name="column">One-based column index of the cell to get value from.</param>
|
|
888
|
+
<returns>String contained by the cell.</returns>
|
|
889
|
+
"""
|
|
890
|
+
pass
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
@abc.abstractmethod
|
|
895
|
+
def GetNumber(self ,row:int,column:int)->float:
|
|
896
|
+
"""
|
|
897
|
+
<summary>
|
|
898
|
+
Returns number value corresponding to the cell.
|
|
899
|
+
</summary>
|
|
900
|
+
<param name="row">One-based row index of the cell to get value from.</param>
|
|
901
|
+
<param name="column">One-based column index of the cell to get value from.</param>
|
|
902
|
+
<returns>Number contained by the cell.</returns>
|
|
903
|
+
"""
|
|
904
|
+
pass
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
@abc.abstractmethod
|
|
909
|
+
def GetFormula(self ,row:int,column:int,bR1C1:bool)->str:
|
|
910
|
+
"""
|
|
911
|
+
<summary>
|
|
912
|
+
Returns formula value corresponding to the cell.
|
|
913
|
+
</summary>
|
|
914
|
+
<param name="row">One-based row index of the cell to get value from.</param>
|
|
915
|
+
<param name="column">One-based column index of the cell to get value from.</param>
|
|
916
|
+
<param name="bR1C1">Indicates whether R1C1 notation should be used.</param>
|
|
917
|
+
<returns>Formula contained by the cell.</returns>
|
|
918
|
+
"""
|
|
919
|
+
pass
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
@abc.abstractmethod
|
|
924
|
+
def GetError(self ,row:int,column:int)->str:
|
|
925
|
+
"""
|
|
926
|
+
<summary>
|
|
927
|
+
Gets error value from cell.
|
|
928
|
+
</summary>
|
|
929
|
+
<param name="row">Row index.</param>
|
|
930
|
+
<param name="column">Column index.</param>
|
|
931
|
+
<returns>Returns error value or null.</returns>
|
|
932
|
+
"""
|
|
933
|
+
pass
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
@abc.abstractmethod
|
|
938
|
+
def GetBoolean(self ,row:int,column:int)->bool:
|
|
939
|
+
"""
|
|
940
|
+
<summary>
|
|
941
|
+
Gets bool value from cell.
|
|
942
|
+
</summary>
|
|
943
|
+
<param name="row">Represents row index.</param>
|
|
944
|
+
<param name="column">Represents column index.</param>
|
|
945
|
+
<returns>Returns found bool value. If cannot found returns false.</returns>
|
|
946
|
+
"""
|
|
947
|
+
pass
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
@abc.abstractmethod
|
|
952
|
+
def GetFormulaBoolValue(self ,row:int,column:int)->bool:
|
|
953
|
+
"""
|
|
954
|
+
<summary>
|
|
955
|
+
Gets formula bool value from cell.
|
|
956
|
+
</summary>
|
|
957
|
+
<param name="row">Represents row index.</param>
|
|
958
|
+
<param name="column">Represents column index.</param>
|
|
959
|
+
<returns>Returns found bool value. If cannot found returns false.</returns>
|
|
960
|
+
"""
|
|
961
|
+
pass
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
@abc.abstractmethod
|
|
966
|
+
def GetFormulaErrorValue(self ,row:int,column:int)->str:
|
|
967
|
+
"""
|
|
968
|
+
<summary>
|
|
969
|
+
Gets formula error value from cell.
|
|
970
|
+
</summary>
|
|
971
|
+
<param name="row">Row index.</param>
|
|
972
|
+
<param name="column">Column index.</param>
|
|
973
|
+
<returns>Returns error value or null.</returns>
|
|
974
|
+
"""
|
|
975
|
+
pass
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
@abc.abstractmethod
|
|
980
|
+
def GetFormulaNumberValue(self ,row:int,column:int)->float:
|
|
981
|
+
"""
|
|
982
|
+
<summary>
|
|
983
|
+
Returns formula number value corresponding to the cell.
|
|
984
|
+
</summary>
|
|
985
|
+
<param name="row">One-based row index of the cell to get value from.</param>
|
|
986
|
+
<param name="column">One-based column index of the cell to get value from.</param>
|
|
987
|
+
<returns>Number contained by the cell.</returns>
|
|
988
|
+
"""
|
|
989
|
+
pass
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
@abc.abstractmethod
|
|
994
|
+
def GetFormulaStringValue(self ,row:int,column:int)->str:
|
|
995
|
+
"""
|
|
996
|
+
<summary>
|
|
997
|
+
Returns formula string value corresponding to the cell.
|
|
998
|
+
</summary>
|
|
999
|
+
<param name="row">One-based row index of the cell to get value from.</param>
|
|
1000
|
+
<param name="column">One-based column index of the cell to get value from.</param>
|
|
1001
|
+
<returns>String contained by the cell.</returns>
|
|
1002
|
+
"""
|
|
1003
|
+
pass
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
@dispatch
|
|
1007
|
+
|
|
1008
|
+
@abc.abstractmethod
|
|
1009
|
+
def SaveToImage(self ,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int)->Stream:
|
|
1010
|
+
"""
|
|
1011
|
+
<summary>
|
|
1012
|
+
Converts range into image (Bitmap).
|
|
1013
|
+
</summary>
|
|
1014
|
+
<param name="firstRow">One-based index of the first row to convert.</param>
|
|
1015
|
+
<param name="firstColumn">One-based index of the first column to convert.</param>
|
|
1016
|
+
<param name="lastRow">One-based index of the last row to convert.</param>
|
|
1017
|
+
<param name="lastColumn">One-based index of the last column to convert.</param>
|
|
1018
|
+
<returns></returns>
|
|
1019
|
+
"""
|
|
1020
|
+
pass
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
@dispatch
|
|
1024
|
+
|
|
1025
|
+
@abc.abstractmethod
|
|
1026
|
+
def SaveToImage(self ,stream:Stream,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int,imageType:ImageType)->Stream:
|
|
1027
|
+
"""
|
|
1028
|
+
<summary>
|
|
1029
|
+
Converts range into image.
|
|
1030
|
+
<example>The following code illustrates how to convert the specified range into image with the specified type:
|
|
1031
|
+
<code>
|
|
1032
|
+
//Create worksheet
|
|
1033
|
+
Workbook workbook = new Workbook();
|
|
1034
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1035
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1036
|
+
//Creat stream
|
|
1037
|
+
Stream stream = new MemoryStream();
|
|
1038
|
+
//Save to image
|
|
1039
|
+
System.Drawing.Image image = worksheet.SaveToImage(stream,1, 1, 10, 20, Spire.Xls.ImageType.Bitmap);
|
|
1040
|
+
image.Save("Sample.png", System.Drawing.Imaging.ImageFormat.Png);
|
|
1041
|
+
</code>
|
|
1042
|
+
</example>
|
|
1043
|
+
</summary>
|
|
1044
|
+
<param name="firstRow">One-based index of the first row to convert.</param>
|
|
1045
|
+
<param name="firstColumn">One-based index of the first column to convert.</param>
|
|
1046
|
+
<param name="lastRow">One-based index of the last row to convert.</param>
|
|
1047
|
+
<param name="lastColumn">One-based index of the last column to convert.</param>
|
|
1048
|
+
<param name="imageType">Type of the image to create.</param>
|
|
1049
|
+
<param name="stream">Output stream. It is ignored if null.</param>
|
|
1050
|
+
<returns>Created image.</returns>
|
|
1051
|
+
"""
|
|
1052
|
+
pass
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
@dispatch
|
|
1056
|
+
|
|
1057
|
+
@abc.abstractmethod
|
|
1058
|
+
def SaveToHtml(self ,filename:str):
|
|
1059
|
+
"""
|
|
1060
|
+
<summary>
|
|
1061
|
+
Saves worksheet with specified filename.
|
|
1062
|
+
<example>The following code snippets illustrates how to save as html to the specified file name:
|
|
1063
|
+
<code>
|
|
1064
|
+
//Create worksheet
|
|
1065
|
+
Workbook workbook = new Workbook();
|
|
1066
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1067
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1068
|
+
//Save to HTML file
|
|
1069
|
+
worksheet.SaveToHtml("Output.html");
|
|
1070
|
+
</code>
|
|
1071
|
+
</example>
|
|
1072
|
+
</summary>
|
|
1073
|
+
<param name="filename">File to save.</param>
|
|
1074
|
+
"""
|
|
1075
|
+
pass
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
@dispatch
|
|
1079
|
+
|
|
1080
|
+
@abc.abstractmethod
|
|
1081
|
+
def SaveToHtml(self ,stream:Stream):
|
|
1082
|
+
"""
|
|
1083
|
+
<summary>
|
|
1084
|
+
Save to HTML stream.
|
|
1085
|
+
<example>The following code snippets illustrates how to save as html as stream:
|
|
1086
|
+
<code>
|
|
1087
|
+
//Create worksheet
|
|
1088
|
+
Workbook workbook = new Workbook();
|
|
1089
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1090
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1091
|
+
//Creat stream
|
|
1092
|
+
Stream stream = new MemoryStream();
|
|
1093
|
+
//Save to HTML stream
|
|
1094
|
+
worksheet.SaveToHtml(stream);
|
|
1095
|
+
</code>
|
|
1096
|
+
</example>
|
|
1097
|
+
</summary>
|
|
1098
|
+
<param name="stream">Stream object.</param>
|
|
1099
|
+
"""
|
|
1100
|
+
pass
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
@dispatch
|
|
1104
|
+
|
|
1105
|
+
@abc.abstractmethod
|
|
1106
|
+
def SaveToHtml(self ,filename:str,saveOptions:HTMLOptions):
|
|
1107
|
+
"""
|
|
1108
|
+
<summary>
|
|
1109
|
+
Saves as HTML.
|
|
1110
|
+
<example>The following code snippets illustrates how to save as html to the specified file name and save option:
|
|
1111
|
+
<code>
|
|
1112
|
+
//Create worksheet
|
|
1113
|
+
Workbook workbook = new Workbook();
|
|
1114
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1115
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1116
|
+
//Save to HTML file
|
|
1117
|
+
worksheet.SaveToHtml("Sample.html" , Spire.Xls.Core.Spreadsheet.HTMLOptions.Default);
|
|
1118
|
+
</code>
|
|
1119
|
+
</example>
|
|
1120
|
+
</summary>
|
|
1121
|
+
<param name="filename">The filename.</param>
|
|
1122
|
+
<param name="saveOptions">The option.</param>
|
|
1123
|
+
"""
|
|
1124
|
+
pass
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
@dispatch
|
|
1128
|
+
|
|
1129
|
+
@abc.abstractmethod
|
|
1130
|
+
def SaveToHtml(self ,stream:Stream,saveOptions:HTMLOptions):
|
|
1131
|
+
"""
|
|
1132
|
+
<summary>
|
|
1133
|
+
Saves work sheet to HTML.
|
|
1134
|
+
<example>The following code snippets illustrates how to save as html as stream with Save option:
|
|
1135
|
+
<code>
|
|
1136
|
+
//Create worksheet
|
|
1137
|
+
Workbook workbook = new Workbook();
|
|
1138
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1139
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1140
|
+
//Creat stream
|
|
1141
|
+
Stream stream = new MemoryStream();
|
|
1142
|
+
//Save to HTML stream
|
|
1143
|
+
worksheet.SaveToHtml(stream, Spire.Xls.Core.Spreadsheet.HTMLOptions.Default);
|
|
1144
|
+
</code>
|
|
1145
|
+
</example>
|
|
1146
|
+
</summary>
|
|
1147
|
+
<param name="stream">Stream to save.</param>
|
|
1148
|
+
<param name="saveOptions">Save Options.</param>
|
|
1149
|
+
"""
|
|
1150
|
+
pass
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
@dispatch
|
|
1154
|
+
|
|
1155
|
+
@abc.abstractmethod
|
|
1156
|
+
def SaveToImage(self ,outputStream:Stream,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int,emfType:EmfType)->Stream:
|
|
1157
|
+
"""
|
|
1158
|
+
<summary>
|
|
1159
|
+
Converts range into metafile image.
|
|
1160
|
+
</summary>
|
|
1161
|
+
<param name="firstRow">One-based index of the first row to convert.</param>
|
|
1162
|
+
<param name="firstColumn">One-based index of the first column to convert.</param>
|
|
1163
|
+
<param name="lastRow">One-based index of the last row to convert.</param>
|
|
1164
|
+
<param name="lastColumn">One-based index of the last column to convert.</param>
|
|
1165
|
+
<param name="emfType">Metafile EmfType.</param>
|
|
1166
|
+
<param name="outputStream">Output stream. It is ignored if null.</param>
|
|
1167
|
+
<returns>Created image.</returns>
|
|
1168
|
+
"""
|
|
1169
|
+
pass
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
@dispatch
|
|
1173
|
+
|
|
1174
|
+
@abc.abstractmethod
|
|
1175
|
+
def SaveToImage(self ,outputStream:Stream,firstRow:int,firstColumn:int,lastRow:int,lastColumn:int,imageType:ImageType,emfType:EmfType)->Stream:
|
|
1176
|
+
"""
|
|
1177
|
+
<summary>
|
|
1178
|
+
Converts range into image.
|
|
1179
|
+
</summary>
|
|
1180
|
+
<param name="firstRow">One-based index of the first row to convert.</param>
|
|
1181
|
+
<param name="firstColumn">One-based index of the first column to convert.</param>
|
|
1182
|
+
<param name="lastRow">One-based index of the last row to convert.</param>
|
|
1183
|
+
<param name="lastColumn">One-based index of the last column to convert.</param>
|
|
1184
|
+
<param name="imageType">Type of the image to create.</param>
|
|
1185
|
+
<param name="outputStream">Output stream. It is ignored if null.</param>
|
|
1186
|
+
<param name="emfType">Metafile EmfType.</param>
|
|
1187
|
+
<returns>Created image.</returns>
|
|
1188
|
+
"""
|
|
1189
|
+
pass
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
@abc.abstractmethod
|
|
1194
|
+
def add_CellValueChanged(self ,value:'CellValueChangedEventHandler'):
|
|
1195
|
+
"""
|
|
1196
|
+
|
|
1197
|
+
"""
|
|
1198
|
+
pass
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
@abc.abstractmethod
|
|
1203
|
+
def remove_CellValueChanged(self ,value:'CellValueChangedEventHandler'):
|
|
1204
|
+
"""
|
|
1205
|
+
|
|
1206
|
+
"""
|
|
1207
|
+
pass
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
@property
|
|
1211
|
+
|
|
1212
|
+
@abc.abstractmethod
|
|
1213
|
+
def AutoFilters(self)->'IAutoFilters':
|
|
1214
|
+
"""
|
|
1215
|
+
<summary>
|
|
1216
|
+
Returns collection of worksheet's autofilters. Read-only.
|
|
1217
|
+
</summary>
|
|
1218
|
+
"""
|
|
1219
|
+
pass
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
@property
|
|
1223
|
+
|
|
1224
|
+
@abc.abstractmethod
|
|
1225
|
+
def Cells(self)->'ListXlsRanges':
|
|
1226
|
+
"""
|
|
1227
|
+
<summary>
|
|
1228
|
+
Returns all used cells in the worksheet. Read-only.
|
|
1229
|
+
</summary>
|
|
1230
|
+
"""
|
|
1231
|
+
pass
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
@property
|
|
1236
|
+
@abc.abstractmethod
|
|
1237
|
+
def DisplayPageBreaks(self)->bool:
|
|
1238
|
+
"""
|
|
1239
|
+
<summary>
|
|
1240
|
+
True if page breaks (both automatic and manual) on the specified
|
|
1241
|
+
worksheet are displayed. Read / write Boolean.
|
|
1242
|
+
</summary>
|
|
1243
|
+
"""
|
|
1244
|
+
pass
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
@DisplayPageBreaks.setter
|
|
1248
|
+
@abc.abstractmethod
|
|
1249
|
+
def DisplayPageBreaks(self, value:bool):
|
|
1250
|
+
"""
|
|
1251
|
+
|
|
1252
|
+
"""
|
|
1253
|
+
pass
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
@property
|
|
1257
|
+
@abc.abstractmethod
|
|
1258
|
+
def Index(self)->int:
|
|
1259
|
+
"""
|
|
1260
|
+
<summary>
|
|
1261
|
+
Returns the index number of the object within the collection of
|
|
1262
|
+
similar objects. Read-only.
|
|
1263
|
+
</summary>
|
|
1264
|
+
"""
|
|
1265
|
+
pass
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
@property
|
|
1269
|
+
|
|
1270
|
+
@abc.abstractmethod
|
|
1271
|
+
def MergedCells(self)->'ListXlsRanges':
|
|
1272
|
+
"""
|
|
1273
|
+
<summary>
|
|
1274
|
+
Returns all merged ranges. Read-only.
|
|
1275
|
+
<example>The following code illustrates how to get the merged ranges:
|
|
1276
|
+
<code>
|
|
1277
|
+
//Create worksheet
|
|
1278
|
+
Workbook workbook = new Workbook();
|
|
1279
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1280
|
+
//Merge cells
|
|
1281
|
+
worksheet["C2:D2"].Merge();
|
|
1282
|
+
worksheet["F3:G3"].Merge();
|
|
1283
|
+
//Get merged ranges
|
|
1284
|
+
IXLSRange[] mergedRanges = worksheet.MergedCells;
|
|
1285
|
+
//Get merged range count . Output will be 2
|
|
1286
|
+
Console.Write(mergedRanges.Length);
|
|
1287
|
+
//Save to file
|
|
1288
|
+
workbook.SaveToFile("MergedCells.xlsx");
|
|
1289
|
+
</code>
|
|
1290
|
+
</example>
|
|
1291
|
+
</summary>
|
|
1292
|
+
"""
|
|
1293
|
+
pass
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
@property
|
|
1298
|
+
|
|
1299
|
+
@abc.abstractmethod
|
|
1300
|
+
def Names(self)->'INameRanges':
|
|
1301
|
+
"""
|
|
1302
|
+
<summary>
|
|
1303
|
+
For a Worksheet object, returns a Names collection that represents
|
|
1304
|
+
all the worksheet-specific names (names defined with the "WorksheetName!"
|
|
1305
|
+
prefix). Read-only Names object.
|
|
1306
|
+
</summary>
|
|
1307
|
+
"""
|
|
1308
|
+
pass
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
@property
|
|
1312
|
+
|
|
1313
|
+
@abc.abstractmethod
|
|
1314
|
+
def CodeName(self)->str:
|
|
1315
|
+
"""
|
|
1316
|
+
<summary>
|
|
1317
|
+
Name that is used by macros to access the workbook items.
|
|
1318
|
+
</summary>
|
|
1319
|
+
"""
|
|
1320
|
+
pass
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
@CodeName.setter
|
|
1324
|
+
@abc.abstractmethod
|
|
1325
|
+
def CodeName(self, value:str):
|
|
1326
|
+
"""
|
|
1327
|
+
|
|
1328
|
+
"""
|
|
1329
|
+
pass
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
@property
|
|
1333
|
+
|
|
1334
|
+
@abc.abstractmethod
|
|
1335
|
+
def PageSetup(self)->'IPageSetup':
|
|
1336
|
+
"""
|
|
1337
|
+
<summary>
|
|
1338
|
+
Returns a PageSetup object that contains all the page setup settings
|
|
1339
|
+
for the specified object. Read-only.
|
|
1340
|
+
</summary>
|
|
1341
|
+
"""
|
|
1342
|
+
pass
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
@property
|
|
1346
|
+
|
|
1347
|
+
@abc.abstractmethod
|
|
1348
|
+
def AllocatedRange(self)->'IXLSRange':
|
|
1349
|
+
"""
|
|
1350
|
+
<summary>
|
|
1351
|
+
Returns a Range object that represents a cell or a range of cells.
|
|
1352
|
+
</summary>
|
|
1353
|
+
"""
|
|
1354
|
+
pass
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
@property
|
|
1358
|
+
|
|
1359
|
+
@abc.abstractmethod
|
|
1360
|
+
def Rows(self)->'ListXlsRanges':
|
|
1361
|
+
"""
|
|
1362
|
+
<summary>
|
|
1363
|
+
For a Worksheet object, returns an array of Range objects that represents
|
|
1364
|
+
all the rows on the specified worksheet. Read-only Range object.
|
|
1365
|
+
</summary>
|
|
1366
|
+
"""
|
|
1367
|
+
pass
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
@property
|
|
1372
|
+
@abc.abstractmethod
|
|
1373
|
+
def Columns(self)->'ListXlsRanges':
|
|
1374
|
+
"""
|
|
1375
|
+
<summary>
|
|
1376
|
+
For a Worksheet object, returns an array of Range objects that represents
|
|
1377
|
+
all the columns on the specified worksheet. Read-only Range object.
|
|
1378
|
+
</summary>
|
|
1379
|
+
"""
|
|
1380
|
+
pass
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
@property
|
|
1385
|
+
@abc.abstractmethod
|
|
1386
|
+
def DefaultRowHeight(self)->float:
|
|
1387
|
+
"""
|
|
1388
|
+
<summary>
|
|
1389
|
+
Returns the standard (default) height of all the rows in the worksheet,
|
|
1390
|
+
in points. Read/write Double.
|
|
1391
|
+
<example>The following code illustrates how to get the default row height:
|
|
1392
|
+
<code>
|
|
1393
|
+
//Create worksheet
|
|
1394
|
+
Workbook workbook = new Workbook();
|
|
1395
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1396
|
+
//Get row height
|
|
1397
|
+
Console.Write(worksheet.DefaultRowHeight);
|
|
1398
|
+
//Set default height
|
|
1399
|
+
worksheet.DefaultRowHeight = 40;
|
|
1400
|
+
//Save to file
|
|
1401
|
+
workbook.SaveToFile("DefaultRowHeight.xlsx");
|
|
1402
|
+
</code>
|
|
1403
|
+
</example>
|
|
1404
|
+
</summary>
|
|
1405
|
+
"""
|
|
1406
|
+
pass
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
@DefaultRowHeight.setter
|
|
1410
|
+
@abc.abstractmethod
|
|
1411
|
+
def DefaultRowHeight(self, value:float):
|
|
1412
|
+
"""
|
|
1413
|
+
|
|
1414
|
+
"""
|
|
1415
|
+
pass
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
@property
|
|
1419
|
+
@abc.abstractmethod
|
|
1420
|
+
def DefaultColumnWidth(self)->float:
|
|
1421
|
+
"""
|
|
1422
|
+
<summary>
|
|
1423
|
+
Returns or sets the standard (default) width of all the columns in the
|
|
1424
|
+
worksheet. Read/write Double.
|
|
1425
|
+
<example>The following code illustrates how to get the default column width:
|
|
1426
|
+
<code>
|
|
1427
|
+
//Create worksheet
|
|
1428
|
+
Workbook workbook = new Workbook();
|
|
1429
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1430
|
+
//Get column width
|
|
1431
|
+
Console.Write(worksheet.DefaultColumnWidth);
|
|
1432
|
+
//Set default width
|
|
1433
|
+
worksheet.DefaultColumnWidth = 40;
|
|
1434
|
+
//Save to file
|
|
1435
|
+
workbook.SaveToFile("DefaultColumnWidth.xlsx");
|
|
1436
|
+
</code>
|
|
1437
|
+
</example>
|
|
1438
|
+
</summary>
|
|
1439
|
+
"""
|
|
1440
|
+
pass
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
@DefaultColumnWidth.setter
|
|
1444
|
+
@abc.abstractmethod
|
|
1445
|
+
def DefaultColumnWidth(self, value:float):
|
|
1446
|
+
"""
|
|
1447
|
+
|
|
1448
|
+
"""
|
|
1449
|
+
pass
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
@property
|
|
1453
|
+
|
|
1454
|
+
@abc.abstractmethod
|
|
1455
|
+
def Type(self)->'ExcelSheetType':
|
|
1456
|
+
"""
|
|
1457
|
+
<summary>
|
|
1458
|
+
Returns or sets the worksheet type. Read-only ExcelSheetType.
|
|
1459
|
+
</summary>
|
|
1460
|
+
"""
|
|
1461
|
+
pass
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
@property
|
|
1465
|
+
|
|
1466
|
+
@abc.abstractmethod
|
|
1467
|
+
def Range(self)->'XlsRange':
|
|
1468
|
+
"""
|
|
1469
|
+
<summary>
|
|
1470
|
+
Returns a Range object that represents the used range on the
|
|
1471
|
+
specified worksheet. Read-only.
|
|
1472
|
+
<example>The following code illustrates how to get used range on the specified worksheet:
|
|
1473
|
+
<code>
|
|
1474
|
+
//Create worksheet
|
|
1475
|
+
Workbook workbook = new Workbook();
|
|
1476
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1477
|
+
//Set text
|
|
1478
|
+
worksheet["B2"].Text = "Text";
|
|
1479
|
+
//Set Color
|
|
1480
|
+
worksheet["J3"].Style.Color = Color.Red;
|
|
1481
|
+
//Get used range . Output will be B2:J3
|
|
1482
|
+
Console.Write(worksheet.Range.RangeAddressLocal);
|
|
1483
|
+
//Save to file
|
|
1484
|
+
workbook.SaveToFile("UsedRange.xlsx");
|
|
1485
|
+
</code>
|
|
1486
|
+
</example>
|
|
1487
|
+
</summary>
|
|
1488
|
+
"""
|
|
1489
|
+
pass
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
@property
|
|
1493
|
+
@abc.abstractmethod
|
|
1494
|
+
def Zoom(self)->int:
|
|
1495
|
+
"""
|
|
1496
|
+
<summary>
|
|
1497
|
+
Zoom factor of document. Value must be in range from 10 till 400.
|
|
1498
|
+
<example>The following code illustrates how to set zoom level of the sheet:
|
|
1499
|
+
<code>
|
|
1500
|
+
//Create worksheet
|
|
1501
|
+
Workbook workbook = new Workbook();
|
|
1502
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1503
|
+
//Set zoom
|
|
1504
|
+
worksheet.Zoom = 200;
|
|
1505
|
+
//Save to file
|
|
1506
|
+
workbook.SaveToFile("Zoom.xlsx");
|
|
1507
|
+
</code>
|
|
1508
|
+
</example>
|
|
1509
|
+
</summary>
|
|
1510
|
+
"""
|
|
1511
|
+
pass
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
@Zoom.setter
|
|
1515
|
+
@abc.abstractmethod
|
|
1516
|
+
def Zoom(self, value:int):
|
|
1517
|
+
"""
|
|
1518
|
+
|
|
1519
|
+
"""
|
|
1520
|
+
pass
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
@property
|
|
1524
|
+
@abc.abstractmethod
|
|
1525
|
+
def VerticalSplit(self)->int:
|
|
1526
|
+
"""
|
|
1527
|
+
<summary>
|
|
1528
|
+
Gets or sets the position of vertical split in the worksheet.
|
|
1529
|
+
</summary>
|
|
1530
|
+
<remarks>
|
|
1531
|
+
Position of the vertical split (px, 0 = No vertical split):
|
|
1532
|
+
Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point)
|
|
1533
|
+
Frozen pane: Number of visible columns in left pane(s)
|
|
1534
|
+
</remarks>
|
|
1535
|
+
"""
|
|
1536
|
+
pass
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
@VerticalSplit.setter
|
|
1540
|
+
@abc.abstractmethod
|
|
1541
|
+
def VerticalSplit(self, value:int):
|
|
1542
|
+
"""
|
|
1543
|
+
|
|
1544
|
+
"""
|
|
1545
|
+
pass
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
@property
|
|
1549
|
+
@abc.abstractmethod
|
|
1550
|
+
def HorizontalSplit(self)->int:
|
|
1551
|
+
"""
|
|
1552
|
+
<summary>
|
|
1553
|
+
Gets or sets the position of horizontal split in the worksheet.
|
|
1554
|
+
</summary>
|
|
1555
|
+
<remarks>
|
|
1556
|
+
Position of the horizontal split (by, 0 = No horizontal split):
|
|
1557
|
+
Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point)
|
|
1558
|
+
Frozen pane: Number of visible rows in top pane(s)
|
|
1559
|
+
</remarks>
|
|
1560
|
+
"""
|
|
1561
|
+
pass
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
@HorizontalSplit.setter
|
|
1565
|
+
@abc.abstractmethod
|
|
1566
|
+
def HorizontalSplit(self, value:int):
|
|
1567
|
+
"""
|
|
1568
|
+
|
|
1569
|
+
"""
|
|
1570
|
+
pass
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
@property
|
|
1574
|
+
@abc.abstractmethod
|
|
1575
|
+
def FirstVisibleRow(self)->int:
|
|
1576
|
+
"""
|
|
1577
|
+
<summary>
|
|
1578
|
+
Index to first visible row in bottom pane(s).
|
|
1579
|
+
</summary>
|
|
1580
|
+
"""
|
|
1581
|
+
pass
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
@FirstVisibleRow.setter
|
|
1585
|
+
@abc.abstractmethod
|
|
1586
|
+
def FirstVisibleRow(self, value:int):
|
|
1587
|
+
"""
|
|
1588
|
+
|
|
1589
|
+
"""
|
|
1590
|
+
pass
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
@property
|
|
1594
|
+
@abc.abstractmethod
|
|
1595
|
+
def FirstVisibleColumn(self)->int:
|
|
1596
|
+
"""
|
|
1597
|
+
<summary>
|
|
1598
|
+
Index to first visible column in right pane(s).
|
|
1599
|
+
</summary>
|
|
1600
|
+
"""
|
|
1601
|
+
pass
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
@FirstVisibleColumn.setter
|
|
1605
|
+
@abc.abstractmethod
|
|
1606
|
+
def FirstVisibleColumn(self, value:int):
|
|
1607
|
+
"""
|
|
1608
|
+
|
|
1609
|
+
"""
|
|
1610
|
+
pass
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
@property
|
|
1614
|
+
@abc.abstractmethod
|
|
1615
|
+
def ActivePane(self)->int:
|
|
1616
|
+
"""
|
|
1617
|
+
<summary>
|
|
1618
|
+
Identifier of pane with active cell cursor.
|
|
1619
|
+
</summary>
|
|
1620
|
+
"""
|
|
1621
|
+
pass
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
@ActivePane.setter
|
|
1625
|
+
@abc.abstractmethod
|
|
1626
|
+
def ActivePane(self, value:int):
|
|
1627
|
+
"""
|
|
1628
|
+
|
|
1629
|
+
"""
|
|
1630
|
+
pass
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
@property
|
|
1634
|
+
@abc.abstractmethod
|
|
1635
|
+
def IsDisplayZeros(self)->bool:
|
|
1636
|
+
"""
|
|
1637
|
+
<summary>
|
|
1638
|
+
True if zero values to be displayed
|
|
1639
|
+
False otherwise.
|
|
1640
|
+
</summary>
|
|
1641
|
+
"""
|
|
1642
|
+
pass
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
@IsDisplayZeros.setter
|
|
1646
|
+
@abc.abstractmethod
|
|
1647
|
+
def IsDisplayZeros(self, value:bool):
|
|
1648
|
+
"""
|
|
1649
|
+
|
|
1650
|
+
"""
|
|
1651
|
+
pass
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
@property
|
|
1655
|
+
@abc.abstractmethod
|
|
1656
|
+
def GridLinesVisible(self)->bool:
|
|
1657
|
+
"""
|
|
1658
|
+
<summary>
|
|
1659
|
+
True if gridlines are visible;
|
|
1660
|
+
False otherwise.
|
|
1661
|
+
<example>The following code illustrates how to set visibility for grid lines:
|
|
1662
|
+
<code>
|
|
1663
|
+
//Create worksheet
|
|
1664
|
+
Workbook workbook = new Workbook();
|
|
1665
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1666
|
+
//Set grid line visibility
|
|
1667
|
+
worksheet.GridLinesVisible = false;
|
|
1668
|
+
//Save to file
|
|
1669
|
+
workbook.SaveToFile("GridLinesVisible.xlsx");
|
|
1670
|
+
</code>
|
|
1671
|
+
</example>
|
|
1672
|
+
</summary>
|
|
1673
|
+
"""
|
|
1674
|
+
pass
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
@GridLinesVisible.setter
|
|
1678
|
+
@abc.abstractmethod
|
|
1679
|
+
def GridLinesVisible(self, value:bool):
|
|
1680
|
+
"""
|
|
1681
|
+
|
|
1682
|
+
"""
|
|
1683
|
+
pass
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
@property
|
|
1687
|
+
|
|
1688
|
+
@abc.abstractmethod
|
|
1689
|
+
def GridLineColor(self)->'ExcelColors':
|
|
1690
|
+
"""
|
|
1691
|
+
<summary>
|
|
1692
|
+
Gets / sets Grid line color.
|
|
1693
|
+
<example>The following code illustrates how to set the grid line color:
|
|
1694
|
+
<code>
|
|
1695
|
+
//Create worksheet
|
|
1696
|
+
Workbook workbook = new Workbook();
|
|
1697
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1698
|
+
//Set grid lines color
|
|
1699
|
+
worksheet.GridLineColor = ExcelColors.Red;
|
|
1700
|
+
//Save to file
|
|
1701
|
+
workbook.SaveToFile("GridLineColor.xlsx");
|
|
1702
|
+
</code>
|
|
1703
|
+
</example>
|
|
1704
|
+
</summary>
|
|
1705
|
+
"""
|
|
1706
|
+
pass
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
@GridLineColor.setter
|
|
1710
|
+
@abc.abstractmethod
|
|
1711
|
+
def GridLineColor(self, value:'ExcelColors'):
|
|
1712
|
+
"""
|
|
1713
|
+
|
|
1714
|
+
"""
|
|
1715
|
+
pass
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
@property
|
|
1719
|
+
@abc.abstractmethod
|
|
1720
|
+
def RowColumnHeadersVisible(self)->bool:
|
|
1721
|
+
"""
|
|
1722
|
+
<summary>
|
|
1723
|
+
True if row and column headers are visible;
|
|
1724
|
+
False otherwise.
|
|
1725
|
+
</summary>
|
|
1726
|
+
"""
|
|
1727
|
+
pass
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
@RowColumnHeadersVisible.setter
|
|
1731
|
+
@abc.abstractmethod
|
|
1732
|
+
def RowColumnHeadersVisible(self, value:bool):
|
|
1733
|
+
"""
|
|
1734
|
+
|
|
1735
|
+
"""
|
|
1736
|
+
pass
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
@property
|
|
1740
|
+
@abc.abstractmethod
|
|
1741
|
+
def FormulasVisible(self)->bool:
|
|
1742
|
+
"""
|
|
1743
|
+
|
|
1744
|
+
"""
|
|
1745
|
+
pass
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
@FormulasVisible.setter
|
|
1749
|
+
@abc.abstractmethod
|
|
1750
|
+
def FormulasVisible(self, value:bool):
|
|
1751
|
+
"""
|
|
1752
|
+
|
|
1753
|
+
"""
|
|
1754
|
+
pass
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
@property
|
|
1758
|
+
|
|
1759
|
+
@abc.abstractmethod
|
|
1760
|
+
def VPageBreaks(self)->'IVPageBreaks':
|
|
1761
|
+
"""
|
|
1762
|
+
<summary>
|
|
1763
|
+
Returns a VPageBreaks collection that represents the vertical page
|
|
1764
|
+
breaks on the sheet. Read-only.
|
|
1765
|
+
</summary>
|
|
1766
|
+
"""
|
|
1767
|
+
pass
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
@property
|
|
1771
|
+
|
|
1772
|
+
@abc.abstractmethod
|
|
1773
|
+
def HPageBreaks(self)->'IHPageBreaks':
|
|
1774
|
+
"""
|
|
1775
|
+
<summary>
|
|
1776
|
+
Returns an HPageBreaks collection that represents the horizontal
|
|
1777
|
+
page breaks on the sheet. Read-only.
|
|
1778
|
+
</summary>
|
|
1779
|
+
"""
|
|
1780
|
+
pass
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
@property
|
|
1784
|
+
@abc.abstractmethod
|
|
1785
|
+
def IsStringsPreserved(self)->bool:
|
|
1786
|
+
"""
|
|
1787
|
+
<summary>
|
|
1788
|
+
Indicates if all values in the workbook are preserved as strings.
|
|
1789
|
+
</summary>
|
|
1790
|
+
"""
|
|
1791
|
+
pass
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
@IsStringsPreserved.setter
|
|
1795
|
+
@abc.abstractmethod
|
|
1796
|
+
def IsStringsPreserved(self, value:bool):
|
|
1797
|
+
"""
|
|
1798
|
+
|
|
1799
|
+
"""
|
|
1800
|
+
pass
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
@property
|
|
1804
|
+
|
|
1805
|
+
@abc.abstractmethod
|
|
1806
|
+
def Comments(self)->'IComments':
|
|
1807
|
+
"""
|
|
1808
|
+
<summary>
|
|
1809
|
+
Comments collection.
|
|
1810
|
+
<example>The following code illustrates how to access the comments collection in the worksheet:
|
|
1811
|
+
<code>
|
|
1812
|
+
//Create worksheet
|
|
1813
|
+
Workbook workbook = new Workbook();
|
|
1814
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1815
|
+
//Adding comments to a cell.
|
|
1816
|
+
ICommentShape comment1 = worksheet.Range["A1"].AddComment();
|
|
1817
|
+
ICommentShape comment2 = worksheet.Range["B1"].AddComment();
|
|
1818
|
+
//Set comment text
|
|
1819
|
+
comment1.Text = "Comment1";
|
|
1820
|
+
comment2.Text = "Comment2";
|
|
1821
|
+
//Check count
|
|
1822
|
+
Console.Write(worksheet.Comments.Count);
|
|
1823
|
+
//Save to file
|
|
1824
|
+
workbook.SaveToFile("Comments.xlsx");
|
|
1825
|
+
</code>
|
|
1826
|
+
</example>
|
|
1827
|
+
</summary>
|
|
1828
|
+
"""
|
|
1829
|
+
pass
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
@dispatch
|
|
1833
|
+
|
|
1834
|
+
@abc.abstractmethod
|
|
1835
|
+
def get_Item(self ,row:int,column:int)->IXLSRange:
|
|
1836
|
+
"""
|
|
1837
|
+
<summary>
|
|
1838
|
+
Gets / sets cell by row and index.
|
|
1839
|
+
</summary>
|
|
1840
|
+
"""
|
|
1841
|
+
pass
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
@dispatch
|
|
1845
|
+
|
|
1846
|
+
@abc.abstractmethod
|
|
1847
|
+
def get_Item(self ,row:int,column:int,lastRow:int,lastColumn:int)->IXLSRange:
|
|
1848
|
+
"""
|
|
1849
|
+
<summary>
|
|
1850
|
+
Get cells range.
|
|
1851
|
+
</summary>
|
|
1852
|
+
"""
|
|
1853
|
+
pass
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
@dispatch
|
|
1857
|
+
|
|
1858
|
+
@abc.abstractmethod
|
|
1859
|
+
def get_Item(self ,name:str)->IXLSRange:
|
|
1860
|
+
"""
|
|
1861
|
+
<summary>
|
|
1862
|
+
Get cell range.
|
|
1863
|
+
</summary>
|
|
1864
|
+
"""
|
|
1865
|
+
pass
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
@property
|
|
1869
|
+
|
|
1870
|
+
@abc.abstractmethod
|
|
1871
|
+
def HyperLinks(self)->'IHyperLinks':
|
|
1872
|
+
"""
|
|
1873
|
+
<summary>
|
|
1874
|
+
Collection of all worksheet's hyperlinks.
|
|
1875
|
+
</summary>
|
|
1876
|
+
"""
|
|
1877
|
+
pass
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
@property
|
|
1881
|
+
@abc.abstractmethod
|
|
1882
|
+
def UseRangesCache(self)->bool:
|
|
1883
|
+
"""
|
|
1884
|
+
<summary>
|
|
1885
|
+
Indicates whether all created range objects should be cached. Default value is false.
|
|
1886
|
+
</summary>
|
|
1887
|
+
"""
|
|
1888
|
+
pass
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
@UseRangesCache.setter
|
|
1892
|
+
@abc.abstractmethod
|
|
1893
|
+
def UseRangesCache(self, value:bool):
|
|
1894
|
+
"""
|
|
1895
|
+
|
|
1896
|
+
"""
|
|
1897
|
+
pass
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
@property
|
|
1901
|
+
@abc.abstractmethod
|
|
1902
|
+
def TopVisibleRow(self)->int:
|
|
1903
|
+
"""
|
|
1904
|
+
<summary>
|
|
1905
|
+
Gets/sets top visible row of the worksheet.
|
|
1906
|
+
<example>The following code illustrates how to set the top visible row:
|
|
1907
|
+
<code>
|
|
1908
|
+
//Create worksheet
|
|
1909
|
+
Workbook workbook = new Workbook();
|
|
1910
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1911
|
+
//Set top visible row
|
|
1912
|
+
worksheet.TopVisibleRow = 5;
|
|
1913
|
+
//Get top visible row
|
|
1914
|
+
Console.Write(worksheet.TopVisibleRow);
|
|
1915
|
+
//Save to file
|
|
1916
|
+
workbook.SaveToFile("TopVisibleRow.xlsx");
|
|
1917
|
+
</code>
|
|
1918
|
+
</example>
|
|
1919
|
+
</summary>
|
|
1920
|
+
"""
|
|
1921
|
+
pass
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
@TopVisibleRow.setter
|
|
1925
|
+
@abc.abstractmethod
|
|
1926
|
+
def TopVisibleRow(self, value:int):
|
|
1927
|
+
"""
|
|
1928
|
+
|
|
1929
|
+
"""
|
|
1930
|
+
pass
|
|
1931
|
+
|
|
1932
|
+
|
|
1933
|
+
@property
|
|
1934
|
+
@abc.abstractmethod
|
|
1935
|
+
def LeftVisibleColumn(self)->int:
|
|
1936
|
+
"""
|
|
1937
|
+
<summary>
|
|
1938
|
+
Gets/sets left visible column of the worksheet.
|
|
1939
|
+
<example>The following code illustrates how to set the left visible column:
|
|
1940
|
+
<code>
|
|
1941
|
+
//Create worksheet
|
|
1942
|
+
Workbook workbook = new Workbook();
|
|
1943
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1944
|
+
//Set left visible column
|
|
1945
|
+
worksheet.LeftVisibleColumn = 3;
|
|
1946
|
+
//Get left visible column
|
|
1947
|
+
Console.Write(worksheet.LeftVisibleColumn);
|
|
1948
|
+
//Save to file
|
|
1949
|
+
workbook.SaveToFile("LeftVisibleColumn.xlsx");
|
|
1950
|
+
</code>
|
|
1951
|
+
</example>
|
|
1952
|
+
</summary>
|
|
1953
|
+
"""
|
|
1954
|
+
pass
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
@LeftVisibleColumn.setter
|
|
1958
|
+
@abc.abstractmethod
|
|
1959
|
+
def LeftVisibleColumn(self, value:int):
|
|
1960
|
+
"""
|
|
1961
|
+
|
|
1962
|
+
"""
|
|
1963
|
+
pass
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
@property
|
|
1967
|
+
|
|
1968
|
+
@abc.abstractmethod
|
|
1969
|
+
def PivotTables(self)->'PivotTablesCollection':
|
|
1970
|
+
"""
|
|
1971
|
+
<summary>
|
|
1972
|
+
Returns pivot table collection containing all pivot tables in the worksheet. Read-only.
|
|
1973
|
+
</summary>
|
|
1974
|
+
"""
|
|
1975
|
+
pass
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
@property
|
|
1979
|
+
|
|
1980
|
+
@abc.abstractmethod
|
|
1981
|
+
def ListObjects(self)->'IListObjects':
|
|
1982
|
+
"""
|
|
1983
|
+
<summary>
|
|
1984
|
+
Gets collection of all list objects in the worksheet.
|
|
1985
|
+
</summary>
|
|
1986
|
+
"""
|
|
1987
|
+
pass
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
@property
|
|
1991
|
+
|
|
1992
|
+
@abc.abstractmethod
|
|
1993
|
+
def OleObjects(self)->'IOleObjects':
|
|
1994
|
+
"""
|
|
1995
|
+
<summary>
|
|
1996
|
+
Gets the OLE objects.
|
|
1997
|
+
<example>The following code illustrates how to access the IListObjects collection in the worksheet to add a new IOleObject:
|
|
1998
|
+
<code>
|
|
1999
|
+
//Create worksheet
|
|
2000
|
+
Workbook workbook = new Workbook();
|
|
2001
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2002
|
+
//Create image stream
|
|
2003
|
+
System.Drawing.Image image = System.Drawing.Image.FromFile("image.png");
|
|
2004
|
+
//Add ole object
|
|
2005
|
+
IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed);
|
|
2006
|
+
//Save to file
|
|
2007
|
+
workbook.SaveToFile("OLEObjects.xlsx");
|
|
2008
|
+
</code>
|
|
2009
|
+
</example>
|
|
2010
|
+
</summary>
|
|
2011
|
+
<value>The OLE objects.</value>
|
|
2012
|
+
"""
|
|
2013
|
+
pass
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
@property
|
|
2017
|
+
@abc.abstractmethod
|
|
2018
|
+
def HasOleObjects(self)->bool:
|
|
2019
|
+
"""
|
|
2020
|
+
<summary>
|
|
2021
|
+
Gets or sets a value indicating whether this instance is OLE object.
|
|
2022
|
+
<example>The following code illustrates how to access the IListObjects collection in the worksheet to add a new IOleObject and check Ole Object:
|
|
2023
|
+
<code>
|
|
2024
|
+
//Create worksheet
|
|
2025
|
+
Workbook workbook = new Workbook();
|
|
2026
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2027
|
+
//Create image stream
|
|
2028
|
+
System.Drawing.Image image = System.Drawing.Image.FromFile("image.png");
|
|
2029
|
+
//Add ole object
|
|
2030
|
+
IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed);
|
|
2031
|
+
//Check HasOleObject.Output will be true.</para>
|
|
2032
|
+
Console.Write(worksheet.HasOleObjects);
|
|
2033
|
+
|
|
2034
|
+
<para>//Save to file
|
|
2035
|
+
workbook.SaveToFile("HasOleObjects.xlsx");
|
|
2036
|
+
</code>
|
|
2037
|
+
</example>
|
|
2038
|
+
</summary>
|
|
2039
|
+
<value>
|
|
2040
|
+
<c>true</c> if this instance is OLE object; otherwise, <c>false</c>.
|
|
2041
|
+
</value>
|
|
2042
|
+
"""
|
|
2043
|
+
pass
|
|
2044
|
+
|
|
2045
|
+
|
|
2046
|
+
@abc.abstractmethod
|
|
2047
|
+
def CopyToClipboard(self):
|
|
2048
|
+
"""
|
|
2049
|
+
<summary>
|
|
2050
|
+
Copies worksheet into the clipboard.
|
|
2051
|
+
</summary>
|
|
2052
|
+
"""
|
|
2053
|
+
pass
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
@abc.abstractmethod
|
|
2057
|
+
def Clear(self):
|
|
2058
|
+
"""
|
|
2059
|
+
<summary>
|
|
2060
|
+
Clears worksheet data. Removes all formatting and merges.
|
|
2061
|
+
</summary>
|
|
2062
|
+
"""
|
|
2063
|
+
pass
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
@abc.abstractmethod
|
|
2067
|
+
def ClearData(self):
|
|
2068
|
+
"""
|
|
2069
|
+
<summary>
|
|
2070
|
+
Clears worksheet. Only the data is removed from each cell.
|
|
2071
|
+
</summary>
|
|
2072
|
+
"""
|
|
2073
|
+
pass
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
@abc.abstractmethod
|
|
2078
|
+
def CheckExistence(self ,iRow:int,iColumn:int)->bool:
|
|
2079
|
+
"""
|
|
2080
|
+
<summary>
|
|
2081
|
+
Indicates whether a cell was initialized or accessed by the user.
|
|
2082
|
+
<example>The following code illustrates if the cells was initialized or accessed by the user:
|
|
2083
|
+
<code>
|
|
2084
|
+
//Create worksheet
|
|
2085
|
+
Workbook workbook = new Workbook();
|
|
2086
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2087
|
+
//Set text
|
|
2088
|
+
worksheet.Range["A1"].Text = "Hello";
|
|
2089
|
+
//Check the cell.Output will be true.
|
|
2090
|
+
Console.Write(worksheet.CheckExistence(1, 1));
|
|
2091
|
+
//Save to file
|
|
2092
|
+
workbook.SaveToFile("CheckExistence.xlsx");
|
|
2093
|
+
</code>
|
|
2094
|
+
</example>
|
|
2095
|
+
</summary>
|
|
2096
|
+
<param name="iRow">One-based row index of the cell.</param>
|
|
2097
|
+
<param name="iColumn">One-based column index of the cell.</param>
|
|
2098
|
+
<returns>Value indicating whether the cell was initialized or accessed by the user.</returns>
|
|
2099
|
+
"""
|
|
2100
|
+
pass
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
@abc.abstractmethod
|
|
2105
|
+
def CreateNamedRanges(self ,namedRange:str,referRange:str,vertical:bool):
|
|
2106
|
+
"""
|
|
2107
|
+
|
|
2108
|
+
"""
|
|
2109
|
+
pass
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
@abc.abstractmethod
|
|
2114
|
+
def IsColumnVisible(self ,columnIndex:int)->bool:
|
|
2115
|
+
"""
|
|
2116
|
+
<summary>
|
|
2117
|
+
Method check is Column with specifed index visible to end user or not.
|
|
2118
|
+
</summary>
|
|
2119
|
+
<param name="columnIndex">Index of column.</param>
|
|
2120
|
+
<returns>True - column is visible; otherwise False.</returns>
|
|
2121
|
+
"""
|
|
2122
|
+
pass
|
|
2123
|
+
|
|
2124
|
+
|
|
2125
|
+
|
|
2126
|
+
@abc.abstractmethod
|
|
2127
|
+
def IsRowVisible(self ,rowIndex:int)->bool:
|
|
2128
|
+
"""
|
|
2129
|
+
<summary>
|
|
2130
|
+
Method check is Row with specifed index visible to user or not.
|
|
2131
|
+
</summary>
|
|
2132
|
+
<param name="rowIndex">Index of row visibility of each must be checked.</param>
|
|
2133
|
+
<returns>True - row is visible to user, otherwise False.</returns>
|
|
2134
|
+
"""
|
|
2135
|
+
pass
|
|
2136
|
+
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
@abc.abstractmethod
|
|
2140
|
+
def DeleteRow(self ,index:int):
|
|
2141
|
+
"""
|
|
2142
|
+
<summary>
|
|
2143
|
+
Removes specified row (with formulas update).
|
|
2144
|
+
</summary>
|
|
2145
|
+
<param name="index">One-based row index to remove.</param>
|
|
2146
|
+
"""
|
|
2147
|
+
pass
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
@abc.abstractmethod
|
|
2152
|
+
def DeleteColumn(self ,index:int):
|
|
2153
|
+
"""
|
|
2154
|
+
<summary>
|
|
2155
|
+
Removes specified column (with formulas update).
|
|
2156
|
+
</summary>
|
|
2157
|
+
<param name="index">One-based column index to remove.</param>
|
|
2158
|
+
"""
|
|
2159
|
+
pass
|
|
2160
|
+
|
|
2161
|
+
|
|
2162
|
+
@dispatch
|
|
2163
|
+
|
|
2164
|
+
@abc.abstractmethod
|
|
2165
|
+
def InsertArray(self ,arrObject:List[SpireObject],firstRow:int,firstColumn:int,isVertical:bool)->int:
|
|
2166
|
+
"""
|
|
2167
|
+
<summary>
|
|
2168
|
+
Imports an array of objects into a worksheet.
|
|
2169
|
+
<example>The following code illustrates how to Imports an array of Object into a worksheet with specified alignment:
|
|
2170
|
+
<code>
|
|
2171
|
+
//Create worksheet
|
|
2172
|
+
Workbook workbook = new Workbook();
|
|
2173
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2174
|
+
//Initialize the Object Array
|
|
2175
|
+
object[] array = new object[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" };
|
|
2176
|
+
//Insert the Object Array to Sheet
|
|
2177
|
+
worksheet.InsertArray(array, 1, 1, true);
|
|
2178
|
+
//Save to file
|
|
2179
|
+
workbook.SaveToFile(InsertArray.xlsx");
|
|
2180
|
+
</code>
|
|
2181
|
+
</example>
|
|
2182
|
+
</summary>
|
|
2183
|
+
<param name="arrObject">Array to import.</param>
|
|
2184
|
+
<param name="firstRow">Row of the first cell where array should be imported.</param>
|
|
2185
|
+
<param name="firstColumn">Column of the first cell where array should be imported.</param>
|
|
2186
|
+
<param name="isVertical">True if array should be imported vertically; False - horizontally.</param>
|
|
2187
|
+
<returns>Number of imported elements.</returns>
|
|
2188
|
+
"""
|
|
2189
|
+
pass
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
@dispatch
|
|
2193
|
+
|
|
2194
|
+
@abc.abstractmethod
|
|
2195
|
+
def InsertArray(self ,arrString:List[str],firstRow:int,firstColumn:int,isVertical:bool)->int:
|
|
2196
|
+
"""
|
|
2197
|
+
<summary>
|
|
2198
|
+
Imports an array of strings into a worksheet.
|
|
2199
|
+
<example>The following code illustrates how to Imports an array of String into a worksheet with specified row and column:
|
|
2200
|
+
<code>
|
|
2201
|
+
//Create worksheet
|
|
2202
|
+
Workbook workbook = new Workbook();
|
|
2203
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2204
|
+
//Initialize the string Array
|
|
2205
|
+
string[] arrayString = new string[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" };
|
|
2206
|
+
//Insert the string Array to Sheet
|
|
2207
|
+
worksheet.InsertArray(arrayString, 1, 1, true);
|
|
2208
|
+
//Save to file
|
|
2209
|
+
workbook.SaveToFile(InsertArray.xlsx");
|
|
2210
|
+
</code>
|
|
2211
|
+
</example>
|
|
2212
|
+
</summary>
|
|
2213
|
+
<param name="arrString">Array to import.</param>
|
|
2214
|
+
<param name="firstRow">Row of the first cell where array should be imported.</param>
|
|
2215
|
+
<param name="firstColumn">Column of the first cell where array should be imported.</param>
|
|
2216
|
+
<param name="isVertical">True if array should be imported vertically; False - horizontally.</param>
|
|
2217
|
+
<returns>Number of imported elements.</returns>
|
|
2218
|
+
"""
|
|
2219
|
+
pass
|
|
2220
|
+
|
|
2221
|
+
|
|
2222
|
+
@dispatch
|
|
2223
|
+
|
|
2224
|
+
@abc.abstractmethod
|
|
2225
|
+
def InsertArray(self ,arrInt:List[int],firstRow:int,firstColumn:int,isVertical:bool)->int:
|
|
2226
|
+
"""
|
|
2227
|
+
<summary>
|
|
2228
|
+
Imports an array of integers into a worksheet.
|
|
2229
|
+
<example>The following code illustrates how to Imports an array of integer values into a worksheet with the specified row and column:
|
|
2230
|
+
<code>
|
|
2231
|
+
//Create worksheet
|
|
2232
|
+
Workbook workbook = new Workbook();
|
|
2233
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2234
|
+
//Initialize the integer Array
|
|
2235
|
+
int[] arrayInt = new int[4] {1000, 2000, 3000, 4000};
|
|
2236
|
+
//Insert the integer Array to Sheet
|
|
2237
|
+
worksheet.InsertArray(arrayInt, 1, 1, true);
|
|
2238
|
+
//Save to file
|
|
2239
|
+
workbook.SaveToFile(InsertArray.xlsx");
|
|
2240
|
+
</code>
|
|
2241
|
+
</example>
|
|
2242
|
+
</summary>
|
|
2243
|
+
<param name="arrInt">Array to import.</param>
|
|
2244
|
+
<param name="firstRow">Row of the first cell where array should be imported.</param>
|
|
2245
|
+
<param name="firstColumn">Column of the first cell where array should be imported.</param>
|
|
2246
|
+
<param name="isVertical">True if array should be imported vertically; False - horizontally.</param>
|
|
2247
|
+
<returns>Number of imported elements.</returns>
|
|
2248
|
+
"""
|
|
2249
|
+
pass
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
@dispatch
|
|
2253
|
+
|
|
2254
|
+
@abc.abstractmethod
|
|
2255
|
+
def InsertArray(self ,arrDouble:List[float],firstRow:int,firstColumn:int,isVertical:bool)->int:
|
|
2256
|
+
"""
|
|
2257
|
+
<summary>
|
|
2258
|
+
Imports an array of doubles into a worksheet.
|
|
2259
|
+
<example>The following code illustrates how to Imports an array of Double values into a worksheet with the specified row and column:
|
|
2260
|
+
<code>
|
|
2261
|
+
//Create worksheet
|
|
2262
|
+
Workbook workbook = new Workbook();
|
|
2263
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2264
|
+
//Initialize the double Array
|
|
2265
|
+
double[] arrayDouble = new double[4] { 344.0045, 345.0045, 346.0045, 347.0045 };
|
|
2266
|
+
//Insert the double Array to Sheet
|
|
2267
|
+
worksheet.InsertArray(arrayDouble, 1, 1, true);
|
|
2268
|
+
//Save to file
|
|
2269
|
+
workbook.SaveToFile(InsertArray.xlsx");
|
|
2270
|
+
</code>
|
|
2271
|
+
</example>
|
|
2272
|
+
</summary>
|
|
2273
|
+
<param name="arrDouble">Array to import.</param>
|
|
2274
|
+
<param name="firstRow">Row of the first cell where array should be imported.</param>
|
|
2275
|
+
<param name="firstColumn">Column of the first cell where array should be imported.</param>
|
|
2276
|
+
<param name="isVertical">True if array should be imported vertically; False - horizontally.</param>
|
|
2277
|
+
<returns>Number of imported elements.</returns>
|
|
2278
|
+
"""
|
|
2279
|
+
pass
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
# @dispatch
|
|
2283
|
+
#
|
|
2284
|
+
# @abc.abstractmethod
|
|
2285
|
+
# def InsertArray(self ,arrDateTime:'DateTime[]',firstRow:int,firstColumn:int,isVertical:bool)->int:
|
|
2286
|
+
# """
|
|
2287
|
+
# <summary>
|
|
2288
|
+
# Imports an array of DateTimes into worksheet.
|
|
2289
|
+
# <example>The following code illustrates how to Imports an array of DateTime values into a worksheet with the specified row and colum:
|
|
2290
|
+
# <code>
|
|
2291
|
+
# //Create worksheet
|
|
2292
|
+
# Workbook workbook = new Workbook();
|
|
2293
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2294
|
+
# //Initialize the DateTime Array
|
|
2295
|
+
# DateTime[] arrayDate = new DateTime[4] { DateTime.Parse("06:45"), DateTime.Parse("08:30"), DateTime.Parse("09:40"), DateTime.Parse("10:30") };
|
|
2296
|
+
# //Insert the DateTime Array to Sheet
|
|
2297
|
+
# worksheet.InsertArray(arrayDate, 1, 1, true);
|
|
2298
|
+
# //Save to file
|
|
2299
|
+
# workbook.SaveToFile(InsertArray.xlsx");
|
|
2300
|
+
# </code>
|
|
2301
|
+
# </example>
|
|
2302
|
+
# </summary>
|
|
2303
|
+
# <param name="arrDateTime">Array to import.</param>
|
|
2304
|
+
# <param name="firstRow">Row of the first cell where array should be imported.</param>
|
|
2305
|
+
# <param name="firstColumn">Column of the first cell where array should be imported.</param>
|
|
2306
|
+
# <param name="isVertical">True if array should be imported vertically; False - horizontally.</param>
|
|
2307
|
+
# <returns>Number of imported elements.</returns>
|
|
2308
|
+
# """
|
|
2309
|
+
# pass
|
|
2310
|
+
#
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
# @dispatch
|
|
2314
|
+
#
|
|
2315
|
+
# @abc.abstractmethod
|
|
2316
|
+
# def InsertArray(self ,arrObject:'Object[,]',firstRow:int,firstColumn:int)->int:
|
|
2317
|
+
# """
|
|
2318
|
+
#
|
|
2319
|
+
# """
|
|
2320
|
+
# pass
|
|
2321
|
+
#
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
#
|
|
2325
|
+
# @abc.abstractmethod
|
|
2326
|
+
# def InsertDataColumn(self ,dataColumn:'DataColumn',isFieldNameShown:bool,firstRow:int,firstColumn:int)->int:
|
|
2327
|
+
# """
|
|
2328
|
+
# <summary>
|
|
2329
|
+
# Imports data from a DataColumn into worksheet.
|
|
2330
|
+
# <example>The following code illustrates how to Imports data from a DataColumn into a worksheet with the specified row and column:
|
|
2331
|
+
# <code>
|
|
2332
|
+
# //Create worksheet
|
|
2333
|
+
# Workbook workbook = new Workbook();
|
|
2334
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2335
|
+
# //Create a DataTable
|
|
2336
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2337
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2338
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2339
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2340
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2341
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2342
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2343
|
+
# //Insert the DataColumn to worksheet
|
|
2344
|
+
# System.Data.DataColumn column = table.Columns[2];
|
|
2345
|
+
# worksheet.InsertDataColumn(column, true, 1, 1);
|
|
2346
|
+
# //Save to file
|
|
2347
|
+
# workbook.SaveToFile(InsertDataColumn.xlsx");
|
|
2348
|
+
# </code>
|
|
2349
|
+
# </example>
|
|
2350
|
+
# </summary>
|
|
2351
|
+
# <param name="dataColumn">DataColumn with desired data.</param>
|
|
2352
|
+
# <param name="isFieldNameShown">True if column name must also be imported.</param>
|
|
2353
|
+
# <param name="firstRow">Row of the first cell where DataTable should be imported.</param>
|
|
2354
|
+
# <param name="firstColumn">Column of the first cell where DataTable should be imported.</param>
|
|
2355
|
+
# <returns>Number of imported rows.</returns>
|
|
2356
|
+
# """
|
|
2357
|
+
# pass
|
|
2358
|
+
#
|
|
2359
|
+
|
|
2360
|
+
|
|
2361
|
+
# @dispatch
|
|
2362
|
+
#
|
|
2363
|
+
# @abc.abstractmethod
|
|
2364
|
+
# def InsertDataTable(self ,dataTable:'DataTable',isFieldNameShown:bool,firstRow:int,firstColumn:int)->int:
|
|
2365
|
+
# """
|
|
2366
|
+
# <summary>
|
|
2367
|
+
# Imports data from a DataTable into worksheet.
|
|
2368
|
+
# <example>The following code illustrates how to Imports data from a DataTable into a worksheet with the specified row and column:
|
|
2369
|
+
# <code>
|
|
2370
|
+
# //Create worksheet
|
|
2371
|
+
# Workbook workbook = new Workbook();
|
|
2372
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2373
|
+
# //Create a DataTable
|
|
2374
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2375
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2376
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2377
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2378
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2379
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2380
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2381
|
+
# //Insert the DataTable to worksheet
|
|
2382
|
+
# worksheet.InsertDataTable(table, true, 1, 1);
|
|
2383
|
+
# //Save to file
|
|
2384
|
+
# workbook.SaveToFile(InsertDataTable.xlsx");
|
|
2385
|
+
# </code>
|
|
2386
|
+
# </example>
|
|
2387
|
+
# </summary>
|
|
2388
|
+
# <param name="dataTable">DataTable with desired data.</param>
|
|
2389
|
+
# <param name="isFieldNameShown">True if column names must also be imported.</param>
|
|
2390
|
+
# <param name="firstRow">Row of the first cell where DataTable should be imported.</param>
|
|
2391
|
+
# <param name="firstColumn">Column of the first cell where DataTable should be imported.</param>
|
|
2392
|
+
# <returns>Number of imported rows.</returns>
|
|
2393
|
+
# """
|
|
2394
|
+
# pass
|
|
2395
|
+
#
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
# @dispatch
|
|
2399
|
+
#
|
|
2400
|
+
# @abc.abstractmethod
|
|
2401
|
+
# def InsertDataTable(self ,dataTable:'DataTable',isFieldNameShown:bool,firstRow:int,firstColumn:int,preserveTypes:bool)->int:
|
|
2402
|
+
# """
|
|
2403
|
+
# <summary>
|
|
2404
|
+
# Imports data from a DataTable into worksheet.
|
|
2405
|
+
# <example>The following code illustrates how to Imports data from a DataTable into a worksheet with the specified row and column along with the preserve type:
|
|
2406
|
+
# <code>
|
|
2407
|
+
# //Create worksheet
|
|
2408
|
+
# Workbook workbook = new Workbook();
|
|
2409
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2410
|
+
# //Create a DataTable
|
|
2411
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2412
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2413
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2414
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2415
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2416
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2417
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2418
|
+
# //Insert the DataTable to worksheet
|
|
2419
|
+
# worksheet.InsertDataTable(table, true, 1, 1 , true);
|
|
2420
|
+
# //Save to file
|
|
2421
|
+
# workbook.SaveToFile(InsertDataTable.xlsx");
|
|
2422
|
+
# </code>
|
|
2423
|
+
# </example>
|
|
2424
|
+
# </summary>
|
|
2425
|
+
# <param name="dataTable">DataTable with desired data.</param>
|
|
2426
|
+
# <param name="isFieldNameShown">True if column names must also be imported.</param>
|
|
2427
|
+
# <param name="firstRow">Row of the first cell where DataTable should be imported.</param>
|
|
2428
|
+
# <param name="firstColumn">Column of the first cell where DataTable should be imported.</param>
|
|
2429
|
+
# <param name="preserveTypes">
|
|
2430
|
+
# Indicates whether XlsIO should try to preserve types in DataTable,
|
|
2431
|
+
# i.e. if it is set to False (default) and in DataTable we have in string column
|
|
2432
|
+
# value that contains only numbers, it would be converted to number.
|
|
2433
|
+
# </param>
|
|
2434
|
+
# <returns>Number of imported rows.</returns>
|
|
2435
|
+
# """
|
|
2436
|
+
# pass
|
|
2437
|
+
#
|
|
2438
|
+
|
|
2439
|
+
|
|
2440
|
+
# @dispatch
|
|
2441
|
+
#
|
|
2442
|
+
# @abc.abstractmethod
|
|
2443
|
+
# def InsertDataTable(self ,dataTable:'DataTable',isFieldNameShown:bool,firstRow:int,firstColumn:int,maxRows:int,maxColumns:int)->int:
|
|
2444
|
+
# """
|
|
2445
|
+
# <summary>
|
|
2446
|
+
# Imports data from a DataTable into worksheet.
|
|
2447
|
+
# <example>The following code illustrates how to Imports data from a DataTable into a worksheet with the specified range:
|
|
2448
|
+
# <code>
|
|
2449
|
+
# //Create worksheet
|
|
2450
|
+
# Workbook workbook = new Workbook();
|
|
2451
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2452
|
+
# //Create a DataTable
|
|
2453
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2454
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2455
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2456
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2457
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2458
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2459
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2460
|
+
# //Insert the DataTable to worksheet
|
|
2461
|
+
# worksheet.InsertDataTable(table, true, 1 , 1 , 2 , 2);
|
|
2462
|
+
# //Save to file
|
|
2463
|
+
# workbook.SaveToFile(InsertDataTable.xlsx");
|
|
2464
|
+
# </code>
|
|
2465
|
+
# </example>
|
|
2466
|
+
# </summary>
|
|
2467
|
+
# <param name="dataTable">DataTable with desired data.</param>
|
|
2468
|
+
# <param name="isFieldNameShown">True if column names must also be imported.</param>
|
|
2469
|
+
# <param name="firstRow">Row of the first cell where DataTable should be imported.</param>
|
|
2470
|
+
# <param name="firstColumn">Column of the first cell where DataTable should be imported.</param>
|
|
2471
|
+
# <param name="maxRows">Maximum number of rows to import.</param>
|
|
2472
|
+
# <param name="maxColumns">Maximum number of columns to import.</param>
|
|
2473
|
+
# <returns>Number of imported rows.</returns>
|
|
2474
|
+
# """
|
|
2475
|
+
# pass
|
|
2476
|
+
#
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
# @dispatch
|
|
2480
|
+
#
|
|
2481
|
+
# @abc.abstractmethod
|
|
2482
|
+
# def InsertDataTable(self ,dataTable:'DataTable',isFieldNameShown:bool,firstRow:int,firstColumn:int,maxRows:int,maxColumns:int,preserveTypes:bool)->int:
|
|
2483
|
+
# """
|
|
2484
|
+
# <summary>
|
|
2485
|
+
# Imports data from a DataTable into worksheet.
|
|
2486
|
+
# <example>The following code illustrates how to Imports data from a DataTable into a worksheet with specified range along with preserve type:
|
|
2487
|
+
# <code>
|
|
2488
|
+
# //Create worksheet
|
|
2489
|
+
# Workbook workbook = new Workbook();
|
|
2490
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2491
|
+
# //Create a DataTable
|
|
2492
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2493
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2494
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2495
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2496
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2497
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2498
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2499
|
+
# //Insert the DataTable to worksheet
|
|
2500
|
+
# worksheet.InsertDataTable(table, true, 1 , 1 , 2 , 2 , true);
|
|
2501
|
+
# //Save to file
|
|
2502
|
+
# workbook.SaveToFile(InsertDataTable.xlsx");
|
|
2503
|
+
# </code>
|
|
2504
|
+
# </example>
|
|
2505
|
+
# </summary>
|
|
2506
|
+
# <param name="dataTable">DataTable with desired data.</param>
|
|
2507
|
+
# <param name="isFieldNameShown">True if column names must also be imported.</param>
|
|
2508
|
+
# <param name="firstRow">Row of the first cell where DataTable should be imported.</param>
|
|
2509
|
+
# <param name="firstColumn">Column of the first cell where DataTable should be imported.</param>
|
|
2510
|
+
# <param name="maxRows">Maximum number of rows to import.</param>
|
|
2511
|
+
# <param name="maxColumns">Maximum number of columns to import.</param>
|
|
2512
|
+
# <param name="preserveTypes">
|
|
2513
|
+
# Indicates whether XlsIO should try to preserve types in DataTable,
|
|
2514
|
+
# i.e. if it is set to False (default) and in DataTable we have in string column
|
|
2515
|
+
# value that contains only numbers, it would be converted to number.
|
|
2516
|
+
# </param>
|
|
2517
|
+
# <returns>Number of imported rows.</returns>
|
|
2518
|
+
# """
|
|
2519
|
+
# pass
|
|
2520
|
+
#
|
|
2521
|
+
|
|
2522
|
+
|
|
2523
|
+
# @dispatch
|
|
2524
|
+
#
|
|
2525
|
+
# @abc.abstractmethod
|
|
2526
|
+
# def InsertDataView(self ,dataView:'DataView',isFieldNameShown:bool,firstRow:int,firstColumn:int)->int:
|
|
2527
|
+
# """
|
|
2528
|
+
# <summary>
|
|
2529
|
+
# Imports data from a DataView into worksheet.
|
|
2530
|
+
# <example>The following code illustrates how to Imports data from a DataView into a worksheet with the specified row and column:
|
|
2531
|
+
# <code>
|
|
2532
|
+
# //Create worksheet
|
|
2533
|
+
# Workbook workbook = new Workbook();
|
|
2534
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2535
|
+
# //Create a DataTable
|
|
2536
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2537
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2538
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2539
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2540
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2541
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2542
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2543
|
+
# //Initialize dataview of datatable
|
|
2544
|
+
# System.Data.DataView view = table.DefaultView;
|
|
2545
|
+
# //Import data from DataView
|
|
2546
|
+
# worksheet.InsertDataView(view, true, 1, 1);
|
|
2547
|
+
# //Save to file
|
|
2548
|
+
# workbook.SaveToFile(InsertDataView.xlsx");
|
|
2549
|
+
# </code>
|
|
2550
|
+
# </example>
|
|
2551
|
+
# </summary>
|
|
2552
|
+
# <param name="dataView">DataView with desired data.</param>
|
|
2553
|
+
# <param name="isFieldNameShown">TRUE if column names must also be imported.</param>
|
|
2554
|
+
# <param name="firstRow">Row of the first cell where DataView should be imported.</param>
|
|
2555
|
+
# <param name="firstColumn">Column of the first cell where DataView should be imported.</param>
|
|
2556
|
+
# <returns>Number of imported rows.</returns>
|
|
2557
|
+
# """
|
|
2558
|
+
# pass
|
|
2559
|
+
#
|
|
2560
|
+
|
|
2561
|
+
|
|
2562
|
+
# @dispatch
|
|
2563
|
+
#
|
|
2564
|
+
# @abc.abstractmethod
|
|
2565
|
+
# def InsertDataView(self ,dataView:'DataView',isFieldNameShown:bool,firstRow:int,firstColumn:int,bPreserveTypes:bool)->int:
|
|
2566
|
+
# """
|
|
2567
|
+
# <summary>
|
|
2568
|
+
# Imports data from a DataView into worksheet.
|
|
2569
|
+
# <example>The following code illustrates how to Imports data from a DataView into a worksheet with the specified specified row and column along with preserve type:
|
|
2570
|
+
# <code>
|
|
2571
|
+
# //Create worksheet
|
|
2572
|
+
# Workbook workbook = new Workbook();
|
|
2573
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2574
|
+
# //Create a DataTable
|
|
2575
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2576
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2577
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2578
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2579
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2580
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2581
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2582
|
+
# //Initialize dataview of datatable
|
|
2583
|
+
# System.Data.DataView view = table.DefaultView;
|
|
2584
|
+
# //Import data from DataView
|
|
2585
|
+
# worksheet.InsertDataView(view, true, 1, 1 , true);
|
|
2586
|
+
# //Save to file
|
|
2587
|
+
# workbook.SaveToFile(InsertDataView.xlsx");
|
|
2588
|
+
# </code>
|
|
2589
|
+
# </example>
|
|
2590
|
+
# </summary>
|
|
2591
|
+
# <param name="dataView">DataView with desired data.</param>
|
|
2592
|
+
# <param name="isFieldNameShown">TRUE if column names must also be imported.</param>
|
|
2593
|
+
# <param name="firstRow">Row of the first cell where DataView should be imported.</param>
|
|
2594
|
+
# <param name="firstColumn">Column of the first cell where DataView should be imported.</param>
|
|
2595
|
+
# <param name="bPreserveTypes">Indicates whether to preserve column types.</param>
|
|
2596
|
+
# <returns>Number of imported rows.</returns>
|
|
2597
|
+
# """
|
|
2598
|
+
# pass
|
|
2599
|
+
#
|
|
2600
|
+
|
|
2601
|
+
|
|
2602
|
+
# @dispatch
|
|
2603
|
+
#
|
|
2604
|
+
# @abc.abstractmethod
|
|
2605
|
+
# def InsertDataView(self ,dataView:'DataView',isFieldNameShown:bool,firstRow:int,firstColumn:int,maxRows:int,maxColumns:int)->int:
|
|
2606
|
+
# """
|
|
2607
|
+
# <summary>
|
|
2608
|
+
# Imports data from a DataView into worksheet.
|
|
2609
|
+
# <example>The following code illustrates how to Imports data from a DataView into a worksheet with the specified range:
|
|
2610
|
+
# <code>
|
|
2611
|
+
# //Create worksheet
|
|
2612
|
+
# Workbook workbook = new Workbook();
|
|
2613
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2614
|
+
# //Create a DataTable
|
|
2615
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2616
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2617
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2618
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2619
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2620
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2621
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2622
|
+
# //Initialize dataview of datatable
|
|
2623
|
+
# System.Data.DataView view = table.DefaultView;
|
|
2624
|
+
# //Import data from DataView
|
|
2625
|
+
# worksheet.InsertDataView(view, true, 1, 1 , 2 , 2);
|
|
2626
|
+
# //Save to file
|
|
2627
|
+
# workbook.SaveToFile(InsertDataView.xlsx");
|
|
2628
|
+
# </code>
|
|
2629
|
+
# </example>
|
|
2630
|
+
# </summary>
|
|
2631
|
+
# <param name="dataView">DataView with desired data.</param>
|
|
2632
|
+
# <param name="isFieldNameShown">TRUE if column names must also be imported.</param>
|
|
2633
|
+
# <param name="firstRow">Row of the first cell where DataView should be imported.</param>
|
|
2634
|
+
# <param name="firstColumn">Column of the first cell where DataView should be imported.</param>
|
|
2635
|
+
# <param name="maxRows">Maximum number of rows to import.</param>
|
|
2636
|
+
# <param name="maxColumns">Maximum number of columns to import.</param>
|
|
2637
|
+
# <returns>Number of imported rows.</returns>
|
|
2638
|
+
# """
|
|
2639
|
+
# pass
|
|
2640
|
+
#
|
|
2641
|
+
|
|
2642
|
+
|
|
2643
|
+
# @dispatch
|
|
2644
|
+
#
|
|
2645
|
+
# @abc.abstractmethod
|
|
2646
|
+
# def InsertDataView(self ,dataView:'DataView',isFieldNameShown:bool,firstRow:int,firstColumn:int,maxRows:int,maxColumns:int,bPreserveTypes:bool)->int:
|
|
2647
|
+
# """
|
|
2648
|
+
# <summary>
|
|
2649
|
+
# Imports data from a DataView into worksheet.
|
|
2650
|
+
# <example>The following code illustrates how to Imports data from a DataView into a worksheet with the specified range along with preserve type:
|
|
2651
|
+
# <code>
|
|
2652
|
+
# //Create worksheet
|
|
2653
|
+
# Workbook workbook = new Workbook();
|
|
2654
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
2655
|
+
# //Create a DataTable
|
|
2656
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
2657
|
+
# table.Columns.Add("ID", typeof(int));
|
|
2658
|
+
# table.Columns.Add("Item", typeof(string));
|
|
2659
|
+
# table.Columns.Add("Name", typeof(string));
|
|
2660
|
+
# table.Rows.Add(1, "Soap", "David");
|
|
2661
|
+
# table.Rows.Add(2, "Paste", "Sam");
|
|
2662
|
+
# table.Rows.Add(3, "Cream", "Christoff");
|
|
2663
|
+
# //Initialize dataview of datatable
|
|
2664
|
+
# System.Data.DataView view = table.DefaultView;
|
|
2665
|
+
# //Import data from DataView
|
|
2666
|
+
# worksheet.InsertDataView(view, true, 1, 1 , 2 , 2 , true);
|
|
2667
|
+
# //Save to file
|
|
2668
|
+
# workbook.SaveToFile(InsertDataView.xlsx");
|
|
2669
|
+
# </code>
|
|
2670
|
+
# </example>
|
|
2671
|
+
# </summary>
|
|
2672
|
+
# <param name="dataView">DataView with desired data.</param>
|
|
2673
|
+
# <param name="isFieldNameShown">TRUE if column names must also be imported.</param>
|
|
2674
|
+
# <param name="firstRow">Row of the first cell where DataView should be imported.</param>
|
|
2675
|
+
# <param name="firstColumn">Column of the first cell where DataView should be imported.</param>
|
|
2676
|
+
# <param name="maxRows">Maximum number of rows to import.</param>
|
|
2677
|
+
# <param name="maxColumns">Maximum number of columns to import.</param>
|
|
2678
|
+
# <param name="bPreserveTypes">Indicates whether to preserve column types.</param>
|
|
2679
|
+
# <returns>Number of imported rows</returns>
|
|
2680
|
+
# """
|
|
2681
|
+
# pass
|
|
2682
|
+
#
|
|
2683
|
+
|
|
2684
|
+
|
|
2685
|
+
@abc.abstractmethod
|
|
2686
|
+
def RemovePanes(self):
|
|
2687
|
+
"""
|
|
2688
|
+
<summary>
|
|
2689
|
+
Removes panes from a worksheet.
|
|
2690
|
+
</summary>
|
|
2691
|
+
"""
|
|
2692
|
+
pass
|
|
2693
|
+
|
|
2694
|
+
|