spire-xls 15.5.0__py3-none-macosx_10_7_universal.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.dylib +0 -0
- spire/xls/lib/__init__.py +0 -0
- spire/xls/lib/libSkiaSharp.dylib +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/IWorkbook.py
ADDED
|
@@ -0,0 +1,1806 @@
|
|
|
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 IWorkbook ( IExcelApplication) :
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
"""
|
|
13
|
+
@dispatch
|
|
14
|
+
|
|
15
|
+
@abc.abstractmethod
|
|
16
|
+
def Replace(self ,oldValue:str,newValue:str):
|
|
17
|
+
"""
|
|
18
|
+
<summary>
|
|
19
|
+
Replaces specified string by specified value.
|
|
20
|
+
<example>The following code snippet illustrates how to replace the string with another string:
|
|
21
|
+
<code>
|
|
22
|
+
//Create workbook
|
|
23
|
+
Workbook workbook = new Workbook();
|
|
24
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
25
|
+
//Replace the oldValue by newValue
|
|
26
|
+
string oldValue = "Find";
|
|
27
|
+
string newValue = "NewValue";
|
|
28
|
+
workbook.Replace(oldValue, newValue);
|
|
29
|
+
//Save to file
|
|
30
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
31
|
+
</code>
|
|
32
|
+
</example>
|
|
33
|
+
</summary>
|
|
34
|
+
<param name="oldValue">String value to replace.</param>
|
|
35
|
+
<param name="newValue">New value for the range with specified string.</param>
|
|
36
|
+
"""
|
|
37
|
+
pass
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
@dispatch
|
|
41
|
+
|
|
42
|
+
@abc.abstractmethod
|
|
43
|
+
def Replace(self ,oldValue:str,newValue:float):
|
|
44
|
+
"""
|
|
45
|
+
<summary>
|
|
46
|
+
Replaces specified string by specified value.
|
|
47
|
+
<example>The following code snippet illustrates how to replace the string with double:
|
|
48
|
+
<code>
|
|
49
|
+
//Create workbook
|
|
50
|
+
Workbook workbook = new Workbook();
|
|
51
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
52
|
+
//Replace the oldValue by double
|
|
53
|
+
string oldValue = "Ten";
|
|
54
|
+
workbook.Replace(oldValue, 10.0);
|
|
55
|
+
//Save to file
|
|
56
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
57
|
+
</code>
|
|
58
|
+
</example>
|
|
59
|
+
</summary>
|
|
60
|
+
<param name="oldValue">String value to replace.</param>
|
|
61
|
+
<param name="newValue">New value for the range with specified string.</param>
|
|
62
|
+
"""
|
|
63
|
+
pass
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
@dispatch
|
|
67
|
+
|
|
68
|
+
@abc.abstractmethod
|
|
69
|
+
def Replace(self ,oldValue:str,newValue:DateTime):
|
|
70
|
+
"""
|
|
71
|
+
<summary>
|
|
72
|
+
Replaces specified string by specified value.
|
|
73
|
+
<example>The following code illustrates how to replace the string value with datetime:
|
|
74
|
+
<code>
|
|
75
|
+
//Create workbook
|
|
76
|
+
Workbook workbook = new Workbook();
|
|
77
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
78
|
+
//Replace the oldValue by dateTime
|
|
79
|
+
string oldValue = "Find";
|
|
80
|
+
DateTime dateTime = DateTime.Now;
|
|
81
|
+
workbook.Replace(oldValue, dateTime);
|
|
82
|
+
//Save to file
|
|
83
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
84
|
+
</code>
|
|
85
|
+
</example>
|
|
86
|
+
</summary>
|
|
87
|
+
<param name="oldValue">String value to replace.</param>
|
|
88
|
+
<param name="newValue">New value for the range with specified string.</param>
|
|
89
|
+
"""
|
|
90
|
+
pass
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
@dispatch
|
|
94
|
+
|
|
95
|
+
@abc.abstractmethod
|
|
96
|
+
def Replace(self ,oldValue:str,newValues:List[str],isVertical:bool):
|
|
97
|
+
"""
|
|
98
|
+
<summary>
|
|
99
|
+
Replaces specified string by data from array.
|
|
100
|
+
<example>The following code snippet illustrates how to replace the string with array of string values:
|
|
101
|
+
<code>
|
|
102
|
+
//Create workbook
|
|
103
|
+
Workbook workbook = new Workbook();
|
|
104
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
105
|
+
//Replace the oldValue by array of string values
|
|
106
|
+
string oldValue = "Find";
|
|
107
|
+
string[] newValues = { "X values", "Y values" };
|
|
108
|
+
workbook.Replace(oldValue, newValues , true);
|
|
109
|
+
//Save to file
|
|
110
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
111
|
+
</code>
|
|
112
|
+
</example>
|
|
113
|
+
</summary>
|
|
114
|
+
<param name="oldValue">String value to replace.</param>
|
|
115
|
+
<param name="newValues">Array of new values.</param>
|
|
116
|
+
<param name="isVertical">Indicates whether array should be inserted vertically.</param>
|
|
117
|
+
"""
|
|
118
|
+
pass
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
@dispatch
|
|
122
|
+
|
|
123
|
+
@abc.abstractmethod
|
|
124
|
+
def Replace(self ,oldValue:str,newValues:List[int],isVertical:bool):
|
|
125
|
+
"""
|
|
126
|
+
<summary>
|
|
127
|
+
Replaces specified string by data from array.
|
|
128
|
+
<example>The following code snippet illustrates how to replace the string with array of int values:
|
|
129
|
+
<code>
|
|
130
|
+
//Create workbook
|
|
131
|
+
Workbook workbook = new Workbook();
|
|
132
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
133
|
+
//Replace the oldValue by array of int values
|
|
134
|
+
string oldValue = "Find";
|
|
135
|
+
int[] newValues = { 1, 2 };
|
|
136
|
+
workbook.Replace(oldValue, newValues, true);
|
|
137
|
+
//Save to file
|
|
138
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
139
|
+
</code>
|
|
140
|
+
</example>
|
|
141
|
+
</summary>
|
|
142
|
+
<param name="oldValue">String value to replace.</param>
|
|
143
|
+
<param name="newValues">Array of new values.</param>
|
|
144
|
+
<param name="isVertical">Indicates whether array should be inserted vertically.</param>
|
|
145
|
+
"""
|
|
146
|
+
pass
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
@dispatch
|
|
150
|
+
|
|
151
|
+
@abc.abstractmethod
|
|
152
|
+
def Replace(self ,oldValue:str,newValues:List[float],isVertical:bool):
|
|
153
|
+
"""
|
|
154
|
+
<summary>
|
|
155
|
+
Replaces specified string by data from array.
|
|
156
|
+
<example>The following code snippet illustrates how to replace the string with array of double values:
|
|
157
|
+
<code>
|
|
158
|
+
//Create workbook
|
|
159
|
+
Workbook workbook = new Workbook();
|
|
160
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
161
|
+
//Replace the oldValue by array of double values
|
|
162
|
+
string oldValue = "Find";
|
|
163
|
+
double[] newValues = { 1.0, 2.0 };
|
|
164
|
+
workbook.Replace(oldValue, newValues, true);
|
|
165
|
+
//Save to file
|
|
166
|
+
workbook.SaveToFile("Replace.xlsx");
|
|
167
|
+
</code>
|
|
168
|
+
</example>
|
|
169
|
+
</summary>
|
|
170
|
+
<param name="oldValue">String value to replace.</param>
|
|
171
|
+
<param name="newValues">Array of new values.</param>
|
|
172
|
+
<param name="isVertical">Indicates whether array should be inserted vertically.</param>
|
|
173
|
+
"""
|
|
174
|
+
pass
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
# @dispatch
|
|
178
|
+
#
|
|
179
|
+
# @abc.abstractmethod
|
|
180
|
+
# def Replace(self ,oldValue:str,newValues:'DataTable',isFieldNamesShown:bool):
|
|
181
|
+
# """
|
|
182
|
+
# <summary>
|
|
183
|
+
# Replaces specified string by data table values.
|
|
184
|
+
# <example>The following code snippet illustrates how to replace the string value with data table:
|
|
185
|
+
# <code>
|
|
186
|
+
# //Create workbook
|
|
187
|
+
# Workbook workbook = new Workbook();
|
|
188
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
189
|
+
# //Replace the oldValue by data table
|
|
190
|
+
# string oldValue = "Find";
|
|
191
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
192
|
+
# table.Columns.Add("Dosage", typeof(int));
|
|
193
|
+
# table.Rows.Add(1);
|
|
194
|
+
# workbook.Replace(oldValue, table, true);
|
|
195
|
+
# //Save to file
|
|
196
|
+
# workbook.SaveToFile("Replace.xlsx");
|
|
197
|
+
# </code>
|
|
198
|
+
# </example>
|
|
199
|
+
# </summary>
|
|
200
|
+
# <param name="oldValue">String value to replace.</param>
|
|
201
|
+
# <param name="newValues">Data table with new data.</param>
|
|
202
|
+
# <param name="isFieldNamesShown">Indicates whether field name must be shown.</param>
|
|
203
|
+
# """
|
|
204
|
+
# pass
|
|
205
|
+
#
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
# @dispatch
|
|
209
|
+
#
|
|
210
|
+
# @abc.abstractmethod
|
|
211
|
+
# def Replace(self ,oldValue:str,newValues:'DataColumn',isFieldNamesShown:bool):
|
|
212
|
+
# """
|
|
213
|
+
# <summary>
|
|
214
|
+
# Replaces specified string by data column values.
|
|
215
|
+
# <example>The following code snippet illustrates how to replace the string value with data column:
|
|
216
|
+
# <code>
|
|
217
|
+
# //Create workbook
|
|
218
|
+
# Workbook workbook = new Workbook();
|
|
219
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
220
|
+
# //Replace the oldValue by data column
|
|
221
|
+
# string oldValue = "Find";
|
|
222
|
+
# System.Data.DataTable table = new System.Data.DataTable();
|
|
223
|
+
# table.Columns.Add("Dosage", typeof(int));
|
|
224
|
+
# table.Rows.Add(1);
|
|
225
|
+
# System.Data.DataColumn dataColumn = table.Columns[0];
|
|
226
|
+
# workbook.Replace(oldValue, dataColumn, true);
|
|
227
|
+
# //Save to file
|
|
228
|
+
# workbook.SaveToFile("Replace.xlsx");
|
|
229
|
+
# </code>
|
|
230
|
+
# </example>
|
|
231
|
+
# </summary>
|
|
232
|
+
# <param name="oldValue">String value to replace.</param>
|
|
233
|
+
# <param name="newValues">Data table with new data.</param>
|
|
234
|
+
# <param name="isFieldNamesShown">Indicates whether field name must be shown.</param>
|
|
235
|
+
# """
|
|
236
|
+
# pass
|
|
237
|
+
#
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
@dispatch
|
|
241
|
+
|
|
242
|
+
@abc.abstractmethod
|
|
243
|
+
def FindOne(self ,findValue:str,flags:FindType)->IXLSRange:
|
|
244
|
+
"""
|
|
245
|
+
<summary>
|
|
246
|
+
This method seraches for the first cell with specified string value.
|
|
247
|
+
<example>This sample shows how to find the first cell with specified string value:
|
|
248
|
+
<code>
|
|
249
|
+
//Create workbook
|
|
250
|
+
Workbook workbook = new Workbook();
|
|
251
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
252
|
+
//Find cell with specified string value
|
|
253
|
+
string value = "value";
|
|
254
|
+
IXLSRange result = workbook.FindString(value, false, false);
|
|
255
|
+
</code>
|
|
256
|
+
</example>
|
|
257
|
+
</summary>
|
|
258
|
+
<param name="findValue">Value to search.</param>
|
|
259
|
+
<param name="flags">Type of value to search.</param>
|
|
260
|
+
<returns>First found cell, or Null if value was not found.</returns>
|
|
261
|
+
"""
|
|
262
|
+
pass
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
@dispatch
|
|
266
|
+
|
|
267
|
+
@abc.abstractmethod
|
|
268
|
+
def FindOne(self ,findValue:float,flags:FindType)->IXLSRange:
|
|
269
|
+
"""
|
|
270
|
+
<summary>
|
|
271
|
+
This method seraches for the first cell with specified double value.
|
|
272
|
+
<example>This sample shows how to find the first cell with specified double value:
|
|
273
|
+
<code>
|
|
274
|
+
//Create workbook
|
|
275
|
+
Workbook workbook = new Workbook();
|
|
276
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
277
|
+
//Find cell with specified double value
|
|
278
|
+
double value = 9.00;
|
|
279
|
+
IXLSRange result = workbook.FindNumber(value, false);
|
|
280
|
+
</code>
|
|
281
|
+
</example>
|
|
282
|
+
</summary>
|
|
283
|
+
<param name="findValue">Value to search.</param>
|
|
284
|
+
<param name="flags">Type of value to search.</param>
|
|
285
|
+
<returns>First found cell, or Null if value was not found.</returns>
|
|
286
|
+
"""
|
|
287
|
+
pass
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
@dispatch
|
|
291
|
+
|
|
292
|
+
@abc.abstractmethod
|
|
293
|
+
def FindOne(self ,findValue:bool)->IXLSRange:
|
|
294
|
+
"""
|
|
295
|
+
<summary>
|
|
296
|
+
This method seraches for the first cell with specified bool value.
|
|
297
|
+
<example>This sample shows how to find the first cell with specified bool value:
|
|
298
|
+
<code>
|
|
299
|
+
//Create workbook
|
|
300
|
+
Workbook workbook = new Workbook();
|
|
301
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
302
|
+
//Find cell with specified bool value
|
|
303
|
+
IXLSRange result = workbook.FindBool(true);
|
|
304
|
+
</code>
|
|
305
|
+
</example>
|
|
306
|
+
</summary>
|
|
307
|
+
<param name="findValue">Value to search.</param>
|
|
308
|
+
<returns>First found cell, or Null if value was not found.</returns>
|
|
309
|
+
"""
|
|
310
|
+
pass
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
@dispatch
|
|
314
|
+
|
|
315
|
+
@abc.abstractmethod
|
|
316
|
+
def FindOne(self ,findValue:DateTime)->IXLSRange:
|
|
317
|
+
"""
|
|
318
|
+
<summary>
|
|
319
|
+
This method seraches for the first cell with specified DateTime value.
|
|
320
|
+
<example>This sample shows how to find the first cell with specified DateTime value:
|
|
321
|
+
<code>
|
|
322
|
+
//Create workbook
|
|
323
|
+
Workbook workbook = new Workbook();
|
|
324
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
325
|
+
//Find cell with specified DateTime value
|
|
326
|
+
DateTime dateTime = DateTime.Now;
|
|
327
|
+
IXLSRange result = workbook.FindDateTime(dateTime);
|
|
328
|
+
</code>
|
|
329
|
+
</example>
|
|
330
|
+
</summary>
|
|
331
|
+
<param name="findValue">Value to search.</param>
|
|
332
|
+
<returns>First found cell, or Null if value was not found.</returns>
|
|
333
|
+
"""
|
|
334
|
+
pass
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
@dispatch
|
|
338
|
+
|
|
339
|
+
@abc.abstractmethod
|
|
340
|
+
def FindOne(self ,findValue:TimeSpan)->IXLSRange:
|
|
341
|
+
"""
|
|
342
|
+
<summary>
|
|
343
|
+
This method seraches for the first cell with specified TimeSpan value.
|
|
344
|
+
<example>This sample shows how to find the first cell with specified TimeSpan value:
|
|
345
|
+
<code>
|
|
346
|
+
//Create workbook
|
|
347
|
+
Workbook workbook = new Workbook();
|
|
348
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
349
|
+
//Find cell with specified TimeSpan value
|
|
350
|
+
TimeSpan timeSpan = new TimeSpan(2, 30, 30);
|
|
351
|
+
IXLSRange result = workbook.FindTimeSpan(timeSpan);
|
|
352
|
+
</code>
|
|
353
|
+
</example>
|
|
354
|
+
</summary>
|
|
355
|
+
<param name="findValue">Value to search.</param>
|
|
356
|
+
<returns>First found cell, or Null if value was not found.</returns>
|
|
357
|
+
"""
|
|
358
|
+
pass
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
# @dispatch
|
|
362
|
+
#
|
|
363
|
+
# @abc.abstractmethod
|
|
364
|
+
# def FindAll(self ,findValue:str,flags:FindType)->ListCellRanges:
|
|
365
|
+
# """
|
|
366
|
+
# <summary>
|
|
367
|
+
# This method seraches for the all cells with specified string value.
|
|
368
|
+
# <example>This sample shows how to find all cells with specified string value:
|
|
369
|
+
# <code>
|
|
370
|
+
# //Create workbook
|
|
371
|
+
# Workbook workbook = new Workbook();
|
|
372
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
373
|
+
# //Find cells with specified string value
|
|
374
|
+
# string value = "value";
|
|
375
|
+
# CellRange[] result = workbook.FindAllString(value , false , false);
|
|
376
|
+
# </code>
|
|
377
|
+
# </example>
|
|
378
|
+
# </summary>
|
|
379
|
+
# <param name="findValue">Value to search.</param>
|
|
380
|
+
# <param name="flags">Type of value to search.</param>
|
|
381
|
+
# <returns>All found cells, or Null if value was not found.</returns>
|
|
382
|
+
# """
|
|
383
|
+
# pass
|
|
384
|
+
#
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
# @dispatch
|
|
388
|
+
#
|
|
389
|
+
# @abc.abstractmethod
|
|
390
|
+
# def FindAll(self ,findValue:float,flags:FindType)->ListCellRanges:
|
|
391
|
+
# """
|
|
392
|
+
# <summary>
|
|
393
|
+
# This method seraches for the all cells with specified double value.
|
|
394
|
+
# <example>This sample shows how to find all cells with specified doulbe value:
|
|
395
|
+
# <code>
|
|
396
|
+
# //Create workbook
|
|
397
|
+
# Workbook workbook = new Workbook();
|
|
398
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
399
|
+
# //Find cells with specified double value
|
|
400
|
+
# CellRange[] result = workbook.FindAllNumber(100.32 , false);
|
|
401
|
+
# </code>
|
|
402
|
+
# </example>
|
|
403
|
+
# </summary>
|
|
404
|
+
# <param name="findValue">Value to search.</param>
|
|
405
|
+
# <param name="flags">Type of value to search.</param>
|
|
406
|
+
# <returns>All found cells, or Null if value was not found.</returns>
|
|
407
|
+
# """
|
|
408
|
+
# pass
|
|
409
|
+
#
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
# @dispatch
|
|
413
|
+
#
|
|
414
|
+
# @abc.abstractmethod
|
|
415
|
+
# def FindAll(self ,findValue:bool)->ListCellRanges:
|
|
416
|
+
# """
|
|
417
|
+
# <summary>
|
|
418
|
+
# This method seraches for the all cells with specified bool value.
|
|
419
|
+
# <example>This sample shows how to find all cells with specified bool value:
|
|
420
|
+
# <code>
|
|
421
|
+
# //Create workbook
|
|
422
|
+
# Workbook workbook = new Workbook();
|
|
423
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
424
|
+
# //Find cells with specified bool value
|
|
425
|
+
# CellRange[] result = workbook.FindAllBool(true);
|
|
426
|
+
# </code>
|
|
427
|
+
# </example>
|
|
428
|
+
# </summary>
|
|
429
|
+
# <param name="findValue">Value to search.</param>
|
|
430
|
+
# <returns>All found cells, or Null if value was not found</returns>
|
|
431
|
+
# """
|
|
432
|
+
# pass
|
|
433
|
+
#
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
# @dispatch
|
|
437
|
+
#
|
|
438
|
+
# @abc.abstractmethod
|
|
439
|
+
# def FindAll(self ,findValue:DateTime)->ListCellRanges:
|
|
440
|
+
# """
|
|
441
|
+
# <summary>
|
|
442
|
+
# This method seraches for the all cells with specified DateTime value.
|
|
443
|
+
# <example>This sample shows how to find all cells with specified DateTime value:
|
|
444
|
+
# <code>
|
|
445
|
+
# //Create workbook
|
|
446
|
+
# Workbook workbook = new Workbook();
|
|
447
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
448
|
+
# //Find cells with specified DateTime value
|
|
449
|
+
# CellRange[] result = workbook.FindAllDateTime(DateTime.Now);
|
|
450
|
+
# </code>
|
|
451
|
+
# </example>
|
|
452
|
+
# </summary>
|
|
453
|
+
# <param name="findValue">Value to search.</param>
|
|
454
|
+
# <returns>All found cells, or Null if value was not found.</returns>
|
|
455
|
+
# """
|
|
456
|
+
# pass
|
|
457
|
+
#
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
# @dispatch
|
|
461
|
+
#
|
|
462
|
+
# @abc.abstractmethod
|
|
463
|
+
# def FindAll(self ,findValue:TimeSpan)->ListCellRanges:
|
|
464
|
+
# """
|
|
465
|
+
# <summary>
|
|
466
|
+
# This method seraches for the all cells with specified TimeSpan value.
|
|
467
|
+
# <example>This sample shows how to find all cells with specified TimeSpan value:
|
|
468
|
+
# <code>
|
|
469
|
+
# //Create workbook
|
|
470
|
+
# Workbook workbook = new Workbook();
|
|
471
|
+
# workbook.LoadFromFile("Sample.xlsx");
|
|
472
|
+
# //Find cells with specified TimeSpan value
|
|
473
|
+
# TimeSpan value = new TimeSpan(2, 30, 30);
|
|
474
|
+
# CellRange[] result = workbook.FindAllTimeSpan(value);
|
|
475
|
+
# </code>
|
|
476
|
+
# </example>
|
|
477
|
+
# </summary>
|
|
478
|
+
# <param name="findValue">Value to search.</param>
|
|
479
|
+
# <returns>All found cells, or Null if value was not found.</returns>
|
|
480
|
+
# """
|
|
481
|
+
# pass
|
|
482
|
+
#
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
@dispatch
|
|
486
|
+
|
|
487
|
+
@abc.abstractmethod
|
|
488
|
+
def SaveAs(self ,fileName:str,separator:str):
|
|
489
|
+
"""
|
|
490
|
+
<summary>
|
|
491
|
+
Save active WorkSheet using separator.
|
|
492
|
+
<example>The following code illustrates how to save the active worksheet in a different file with separator:
|
|
493
|
+
<code>
|
|
494
|
+
//Create workbook
|
|
495
|
+
Workbook workbook = new Workbook();
|
|
496
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
497
|
+
//Save to file
|
|
498
|
+
workbook.SaveToFile("Result.csv" , ",");
|
|
499
|
+
</code>
|
|
500
|
+
</example>
|
|
501
|
+
</summary>
|
|
502
|
+
<param name="fileName">Path to save.</param>
|
|
503
|
+
<param name="separator">Current separator.</param>
|
|
504
|
+
"""
|
|
505
|
+
pass
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
@dispatch
|
|
509
|
+
|
|
510
|
+
@abc.abstractmethod
|
|
511
|
+
def SaveAs(self ,stream:Stream,separator:str):
|
|
512
|
+
"""
|
|
513
|
+
<summary>
|
|
514
|
+
Save active WorkSheet using separator.
|
|
515
|
+
<example>The following code illustrates how to saves the active worksheet as stream with separator:
|
|
516
|
+
<code>
|
|
517
|
+
//Create workbook
|
|
518
|
+
Workbook workbook = new Workbook();
|
|
519
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
520
|
+
//Save to stream
|
|
521
|
+
Stream stream = new MemoryStream();
|
|
522
|
+
workbook.SaveToFile(stream , ",");
|
|
523
|
+
</code>
|
|
524
|
+
</example>
|
|
525
|
+
</summary>
|
|
526
|
+
<param name="stream">Stream to save.</param>
|
|
527
|
+
<param name="separator">Current separator.</param>
|
|
528
|
+
"""
|
|
529
|
+
pass
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
@abc.abstractmethod
|
|
534
|
+
def SetSeparators(self ,argumentsSeparator:int,arrayRowsSeparator:int):
|
|
535
|
+
"""
|
|
536
|
+
<summary>
|
|
537
|
+
Sets separators for formula parsing.
|
|
538
|
+
</summary>
|
|
539
|
+
<param name="argumentsSeparator">Arguments separator to set.</param>
|
|
540
|
+
<param name="arrayRowsSeparator">Array rows separator to set.</param>
|
|
541
|
+
"""
|
|
542
|
+
pass
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
@abc.abstractmethod
|
|
547
|
+
def Protect(self ,bIsProtectWindow:bool,bIsProtectContent:bool):
|
|
548
|
+
"""
|
|
549
|
+
<summary>
|
|
550
|
+
Sets protection for workbook.
|
|
551
|
+
</summary>
|
|
552
|
+
<param name="bIsProtectWindow">Indicates if protect workbook window.</param>
|
|
553
|
+
<param name="bIsProtectContent">Indicates if protect workbook content.</param>
|
|
554
|
+
"""
|
|
555
|
+
pass
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
@abc.abstractmethod
|
|
559
|
+
def Unprotect(self):
|
|
560
|
+
"""
|
|
561
|
+
<summary>
|
|
562
|
+
Unprotects workbook.
|
|
563
|
+
</summary>
|
|
564
|
+
"""
|
|
565
|
+
pass
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
@abc.abstractmethod
|
|
570
|
+
def Clone(self)->'IWorkbook':
|
|
571
|
+
"""
|
|
572
|
+
<summary>
|
|
573
|
+
Creates copy of the current instance.
|
|
574
|
+
</summary>
|
|
575
|
+
<returns>Copy of the current instance.</returns>
|
|
576
|
+
"""
|
|
577
|
+
pass
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
@abc.abstractmethod
|
|
582
|
+
def SetWriteProtectionPassword(self ,password:str):
|
|
583
|
+
"""
|
|
584
|
+
<summary>
|
|
585
|
+
This method sets write protection password.
|
|
586
|
+
</summary>
|
|
587
|
+
<param name="password">Password to set.</param>
|
|
588
|
+
"""
|
|
589
|
+
pass
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
@property
|
|
593
|
+
|
|
594
|
+
@abc.abstractmethod
|
|
595
|
+
def ActiveSheet(self)->'IWorksheet':
|
|
596
|
+
"""
|
|
597
|
+
<summary>
|
|
598
|
+
Returns an object that represents the active sheet (the sheet on top)
|
|
599
|
+
in the active workbook or in the specified window or workbook. Returns
|
|
600
|
+
Nothing if no sheet is active. Read-only.
|
|
601
|
+
</summary>
|
|
602
|
+
"""
|
|
603
|
+
pass
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
@property
|
|
607
|
+
@abc.abstractmethod
|
|
608
|
+
def ActiveSheetIndex(self)->int:
|
|
609
|
+
"""
|
|
610
|
+
<summary>
|
|
611
|
+
Gets / sets index of the active sheet.
|
|
612
|
+
</summary>
|
|
613
|
+
"""
|
|
614
|
+
pass
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
@ActiveSheetIndex.setter
|
|
618
|
+
@abc.abstractmethod
|
|
619
|
+
def ActiveSheetIndex(self, value:int):
|
|
620
|
+
"""
|
|
621
|
+
|
|
622
|
+
"""
|
|
623
|
+
pass
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
@property
|
|
627
|
+
|
|
628
|
+
@abc.abstractmethod
|
|
629
|
+
def AddInFunctions(self)->'IAddInFunctions':
|
|
630
|
+
"""
|
|
631
|
+
<summary>
|
|
632
|
+
Returns collection of all workbook's add-in functions. Read-only.
|
|
633
|
+
</summary>
|
|
634
|
+
"""
|
|
635
|
+
pass
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
@property
|
|
639
|
+
|
|
640
|
+
@abc.abstractmethod
|
|
641
|
+
def Author(self)->str:
|
|
642
|
+
"""
|
|
643
|
+
<summary>
|
|
644
|
+
Returns or sets the author of the comment. Read-only String.
|
|
645
|
+
</summary>
|
|
646
|
+
"""
|
|
647
|
+
pass
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
@Author.setter
|
|
651
|
+
@abc.abstractmethod
|
|
652
|
+
def Author(self, value:str):
|
|
653
|
+
"""
|
|
654
|
+
|
|
655
|
+
"""
|
|
656
|
+
pass
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
@property
|
|
660
|
+
@abc.abstractmethod
|
|
661
|
+
def IsHScrollBarVisible(self)->bool:
|
|
662
|
+
"""
|
|
663
|
+
<summary>
|
|
664
|
+
Gets or sets a value indicating whether to display horizontal scroll bar.
|
|
665
|
+
<example>This sample shows how to hide horizontal scroll bar:
|
|
666
|
+
<code>
|
|
667
|
+
//Create workbook
|
|
668
|
+
Workbook workbook = new Workbook();
|
|
669
|
+
//Hide horizontal scroll bar
|
|
670
|
+
workbook.IsHScrollBarVisible = false;
|
|
671
|
+
//Save to file
|
|
672
|
+
workbook.SaveToFile("IsHScrollBarVisible.xlsx");
|
|
673
|
+
</code>
|
|
674
|
+
</example>
|
|
675
|
+
</summary>
|
|
676
|
+
"""
|
|
677
|
+
pass
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
@IsHScrollBarVisible.setter
|
|
681
|
+
@abc.abstractmethod
|
|
682
|
+
def IsHScrollBarVisible(self, value:bool):
|
|
683
|
+
"""
|
|
684
|
+
|
|
685
|
+
"""
|
|
686
|
+
pass
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
@property
|
|
690
|
+
@abc.abstractmethod
|
|
691
|
+
def IsVScrollBarVisible(self)->bool:
|
|
692
|
+
"""
|
|
693
|
+
<summary>
|
|
694
|
+
Gets or sets a value indicating whether to display vertical scroll bar.
|
|
695
|
+
<example>This sample shows how to hide vertical scroll bar:
|
|
696
|
+
<code>
|
|
697
|
+
//Create workbook
|
|
698
|
+
Workbook workbook = new Workbook();
|
|
699
|
+
//Hide vertical scroll bar
|
|
700
|
+
workbook.IsVScrollBarVisible = false;
|
|
701
|
+
//Save to file
|
|
702
|
+
workbook.SaveToFile("IsVScrollBarVisible.xlsx");
|
|
703
|
+
</code>
|
|
704
|
+
</example>
|
|
705
|
+
</summary>
|
|
706
|
+
"""
|
|
707
|
+
pass
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
@IsVScrollBarVisible.setter
|
|
711
|
+
@abc.abstractmethod
|
|
712
|
+
def IsVScrollBarVisible(self, value:bool):
|
|
713
|
+
"""
|
|
714
|
+
|
|
715
|
+
"""
|
|
716
|
+
pass
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
@property
|
|
720
|
+
|
|
721
|
+
@abc.abstractmethod
|
|
722
|
+
def BuiltInDocumentProperties(self)->'IBuiltInDocumentProperties':
|
|
723
|
+
"""
|
|
724
|
+
<summary>
|
|
725
|
+
Returns collection that represents all the built-in document properties
|
|
726
|
+
for the specified workbook. Read-only.
|
|
727
|
+
<example>The following code snippet illustrates how to get the built in document properties:
|
|
728
|
+
<code>
|
|
729
|
+
//Create workbook
|
|
730
|
+
Workbook workbook = new Workbook();
|
|
731
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
732
|
+
//Get the built in document properties
|
|
733
|
+
IBuiltInDocumentProperties builtInDocumentProperties = workbook.DocumentProperties;
|
|
734
|
+
</code>
|
|
735
|
+
</example>
|
|
736
|
+
</summary>
|
|
737
|
+
"""
|
|
738
|
+
pass
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
@property
|
|
742
|
+
|
|
743
|
+
@abc.abstractmethod
|
|
744
|
+
def CodeName(self)->str:
|
|
745
|
+
"""
|
|
746
|
+
<summary>
|
|
747
|
+
Name which is used by macros to access the workbook items.
|
|
748
|
+
</summary>
|
|
749
|
+
"""
|
|
750
|
+
pass
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
@CodeName.setter
|
|
754
|
+
@abc.abstractmethod
|
|
755
|
+
def CodeName(self, value:str):
|
|
756
|
+
"""
|
|
757
|
+
|
|
758
|
+
"""
|
|
759
|
+
pass
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
@property
|
|
763
|
+
|
|
764
|
+
@abc.abstractmethod
|
|
765
|
+
def CustomDocumentProperties(self)->'ICustomDocumentProperties':
|
|
766
|
+
"""
|
|
767
|
+
<summary>
|
|
768
|
+
Returns collection that represents all the custom document properties
|
|
769
|
+
for the specified workbook. Read-only.
|
|
770
|
+
<example>The following code snippet illustrates how to get the custom document properties:
|
|
771
|
+
<code>
|
|
772
|
+
//Create workbook
|
|
773
|
+
Workbook workbook = new Workbook();
|
|
774
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
775
|
+
//Get the document properties
|
|
776
|
+
ICustomDocumentProperties documentProperties = workbook.CustomDocumentProperties;
|
|
777
|
+
</code>
|
|
778
|
+
</example>
|
|
779
|
+
</summary>
|
|
780
|
+
"""
|
|
781
|
+
pass
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
@property
|
|
785
|
+
@abc.abstractmethod
|
|
786
|
+
def Date1904(self)->bool:
|
|
787
|
+
"""
|
|
788
|
+
<summary>
|
|
789
|
+
True if the workbook uses the 1904 date system. Read / write Boolean.
|
|
790
|
+
</summary>
|
|
791
|
+
"""
|
|
792
|
+
pass
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
@Date1904.setter
|
|
796
|
+
@abc.abstractmethod
|
|
797
|
+
def Date1904(self, value:bool):
|
|
798
|
+
"""
|
|
799
|
+
|
|
800
|
+
"""
|
|
801
|
+
pass
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
@property
|
|
805
|
+
@abc.abstractmethod
|
|
806
|
+
def IsDisplayPrecision(self)->bool:
|
|
807
|
+
"""
|
|
808
|
+
<summary>
|
|
809
|
+
True if cell is protected.
|
|
810
|
+
</summary>
|
|
811
|
+
"""
|
|
812
|
+
pass
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
@IsDisplayPrecision.setter
|
|
816
|
+
@abc.abstractmethod
|
|
817
|
+
def IsDisplayPrecision(self, value:bool):
|
|
818
|
+
"""
|
|
819
|
+
|
|
820
|
+
"""
|
|
821
|
+
pass
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
@property
|
|
825
|
+
@abc.abstractmethod
|
|
826
|
+
def IsCellProtection(self)->bool:
|
|
827
|
+
"""
|
|
828
|
+
<summary>
|
|
829
|
+
True if cell is protected.
|
|
830
|
+
</summary>
|
|
831
|
+
"""
|
|
832
|
+
pass
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
@property
|
|
836
|
+
@abc.abstractmethod
|
|
837
|
+
def IsWindowProtection(self)->bool:
|
|
838
|
+
"""
|
|
839
|
+
<summary>
|
|
840
|
+
True if window is protected.
|
|
841
|
+
</summary>
|
|
842
|
+
"""
|
|
843
|
+
pass
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
@property
|
|
847
|
+
|
|
848
|
+
@abc.abstractmethod
|
|
849
|
+
def Names(self)->'INameRanges':
|
|
850
|
+
"""
|
|
851
|
+
<summary>
|
|
852
|
+
For an ReservedHandle object, returns a Names collection that represents
|
|
853
|
+
all the names in the active workbook. For a Workbook object, returns
|
|
854
|
+
a Names collection that represents all the names in the specified
|
|
855
|
+
workbook (including all worksheet-specific names).
|
|
856
|
+
<example>The following code snippet illustrates how to get names:
|
|
857
|
+
<code>
|
|
858
|
+
//Create workbook
|
|
859
|
+
Workbook workbook = new Workbook();
|
|
860
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
861
|
+
//Get names
|
|
862
|
+
INameRanges names = workbook.NameRanges;
|
|
863
|
+
</code>
|
|
864
|
+
</example>
|
|
865
|
+
</summary>
|
|
866
|
+
"""
|
|
867
|
+
pass
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
@property
|
|
871
|
+
@abc.abstractmethod
|
|
872
|
+
def ReadOnly(self)->bool:
|
|
873
|
+
"""
|
|
874
|
+
<summary>
|
|
875
|
+
True if the workbook has been opened as Read-only. Read-only Boolean.
|
|
876
|
+
</summary>
|
|
877
|
+
"""
|
|
878
|
+
pass
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
@property
|
|
882
|
+
@abc.abstractmethod
|
|
883
|
+
def Saved(self)->bool:
|
|
884
|
+
"""
|
|
885
|
+
<summary>
|
|
886
|
+
True if no changes have been made to the specified workbook since
|
|
887
|
+
it was last saved. Read/write Boolean.
|
|
888
|
+
</summary>
|
|
889
|
+
"""
|
|
890
|
+
pass
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
@Saved.setter
|
|
894
|
+
@abc.abstractmethod
|
|
895
|
+
def Saved(self, value:bool):
|
|
896
|
+
"""
|
|
897
|
+
|
|
898
|
+
"""
|
|
899
|
+
pass
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
@property
|
|
903
|
+
|
|
904
|
+
@abc.abstractmethod
|
|
905
|
+
def Styles(self)->'IStyles':
|
|
906
|
+
"""
|
|
907
|
+
<summary>
|
|
908
|
+
Returns a Styles collection that represents all the styles
|
|
909
|
+
in the specified workbook. Read-only.
|
|
910
|
+
<example>The following code snippet illustrates how to get the Styles:
|
|
911
|
+
<code>
|
|
912
|
+
//Create worksheet
|
|
913
|
+
Workbook workbook = new Workbook();
|
|
914
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
915
|
+
//Set styles
|
|
916
|
+
IStyles styles = workbook.Styles;
|
|
917
|
+
</code>
|
|
918
|
+
</example>
|
|
919
|
+
</summary>
|
|
920
|
+
"""
|
|
921
|
+
pass
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
@property
|
|
925
|
+
|
|
926
|
+
@abc.abstractmethod
|
|
927
|
+
def Worksheets(self)->'IWorksheets':
|
|
928
|
+
"""
|
|
929
|
+
<summary>
|
|
930
|
+
Returns a Sheets collection that represents all the worksheets
|
|
931
|
+
in the specified workbook. Read-only Sheets object.
|
|
932
|
+
</summary>
|
|
933
|
+
"""
|
|
934
|
+
pass
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
@property
|
|
938
|
+
@abc.abstractmethod
|
|
939
|
+
def HasMacros(self)->bool:
|
|
940
|
+
"""
|
|
941
|
+
<summary>
|
|
942
|
+
True indicate that opened workbook contains VBA macros.
|
|
943
|
+
</summary>
|
|
944
|
+
"""
|
|
945
|
+
pass
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
@property
|
|
949
|
+
|
|
950
|
+
@abc.abstractmethod
|
|
951
|
+
def Palette(self)->List['Color']:
|
|
952
|
+
"""
|
|
953
|
+
<summary>
|
|
954
|
+
Get Palette of colors which an Excel document can have.
|
|
955
|
+
Here is a table of color indexes to places in the color tool box
|
|
956
|
+
provided by Excel application:
|
|
957
|
+
--------------------------------------------
|
|
958
|
+
| | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 |
|
|
959
|
+
---+----------------------------------------
|
|
960
|
+
|1 | 00 | 51 | 50 | 49 | 47 | 10 | 53 | 54 |
|
|
961
|
+
|2 | 08 | 45 | 11 | 09 | 13 | 04 | 46 | 15 |
|
|
962
|
+
|3 | 02 | 44 | 42 | 48 | 41 | 40 | 12 | 55 |
|
|
963
|
+
|4 | 06 | 43 | 05 | 03 | 07 | 32 | 52 | 14 |
|
|
964
|
+
|5 | 37 | 39 | 35 | 34 | 33 | 36 | 38 | 01 |
|
|
965
|
+
---+----------------------------------------
|
|
966
|
+
|6 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 |
|
|
967
|
+
|7 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 |
|
|
968
|
+
--------------------------------------------
|
|
969
|
+
<example>The following code illustrates how to access the default colors of excel color palette:
|
|
970
|
+
<code>
|
|
971
|
+
//Create worksheet
|
|
972
|
+
Workbook workbook = new Workbook();
|
|
973
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
974
|
+
//Get colors
|
|
975
|
+
System.Drawing.Color[] colors = workbook.Colors;
|
|
976
|
+
//Get color
|
|
977
|
+
System.Drawing.Color color = colors[2];
|
|
978
|
+
//Set color
|
|
979
|
+
worksheet["B2"].Style.Color = color;
|
|
980
|
+
//Save to file
|
|
981
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
982
|
+
</code>
|
|
983
|
+
</example>
|
|
984
|
+
</summary>
|
|
985
|
+
"""
|
|
986
|
+
pass
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
@property
|
|
991
|
+
@abc.abstractmethod
|
|
992
|
+
def DisplayedTab(self)->int:
|
|
993
|
+
"""
|
|
994
|
+
<summary>
|
|
995
|
+
Index of tab which will be displayed on document open.
|
|
996
|
+
</summary>
|
|
997
|
+
"""
|
|
998
|
+
pass
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
@DisplayedTab.setter
|
|
1002
|
+
@abc.abstractmethod
|
|
1003
|
+
def DisplayedTab(self, value:int):
|
|
1004
|
+
"""
|
|
1005
|
+
|
|
1006
|
+
"""
|
|
1007
|
+
pass
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
@property
|
|
1011
|
+
|
|
1012
|
+
@abc.abstractmethod
|
|
1013
|
+
def Charts(self)->'ICharts':
|
|
1014
|
+
"""
|
|
1015
|
+
<summary>
|
|
1016
|
+
Collection of the chart objects.
|
|
1017
|
+
</summary>
|
|
1018
|
+
"""
|
|
1019
|
+
pass
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
@property
|
|
1023
|
+
@abc.abstractmethod
|
|
1024
|
+
def ThrowOnUnknownNames(self)->bool:
|
|
1025
|
+
"""
|
|
1026
|
+
<summary>
|
|
1027
|
+
Indicates whether exception should be thrown when unknown
|
|
1028
|
+
name was found in a formula.
|
|
1029
|
+
</summary>
|
|
1030
|
+
"""
|
|
1031
|
+
pass
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
@ThrowOnUnknownNames.setter
|
|
1035
|
+
@abc.abstractmethod
|
|
1036
|
+
def ThrowOnUnknownNames(self, value:bool):
|
|
1037
|
+
"""
|
|
1038
|
+
|
|
1039
|
+
"""
|
|
1040
|
+
pass
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
@property
|
|
1044
|
+
@abc.abstractmethod
|
|
1045
|
+
def DisableMacrosStart(self)->bool:
|
|
1046
|
+
"""
|
|
1047
|
+
<summary>
|
|
1048
|
+
This Property allows users to disable load of macros from
|
|
1049
|
+
document. Excel on file open will simply skip macros and will
|
|
1050
|
+
work as if document does not contain them. This options works
|
|
1051
|
+
only when file contains macros (HasMacros property is True).
|
|
1052
|
+
</summary>
|
|
1053
|
+
"""
|
|
1054
|
+
pass
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
@DisableMacrosStart.setter
|
|
1058
|
+
@abc.abstractmethod
|
|
1059
|
+
def DisableMacrosStart(self, value:bool):
|
|
1060
|
+
"""
|
|
1061
|
+
|
|
1062
|
+
"""
|
|
1063
|
+
pass
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
@property
|
|
1067
|
+
@abc.abstractmethod
|
|
1068
|
+
def StandardFontSize(self)->float:
|
|
1069
|
+
"""
|
|
1070
|
+
<summary>
|
|
1071
|
+
Returns or sets the standard font size, in points. Read/write.
|
|
1072
|
+
<example>The following code illustrates how to set the standard font size for the workbook:
|
|
1073
|
+
<code>
|
|
1074
|
+
//Create worksheet
|
|
1075
|
+
Workbook workbook = new Workbook();
|
|
1076
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1077
|
+
//Set text
|
|
1078
|
+
worksheet["B2"].Text = "Text";
|
|
1079
|
+
//Set standard font
|
|
1080
|
+
workbook.DefaultFontName = "Arial";
|
|
1081
|
+
//Set standard font size
|
|
1082
|
+
workbook.DefaultFontSize = 18;
|
|
1083
|
+
//Save to file
|
|
1084
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1085
|
+
</code>
|
|
1086
|
+
</example>
|
|
1087
|
+
</summary>
|
|
1088
|
+
"""
|
|
1089
|
+
pass
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
@StandardFontSize.setter
|
|
1093
|
+
@abc.abstractmethod
|
|
1094
|
+
def StandardFontSize(self, value:float):
|
|
1095
|
+
"""
|
|
1096
|
+
|
|
1097
|
+
"""
|
|
1098
|
+
pass
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
@property
|
|
1102
|
+
|
|
1103
|
+
@abc.abstractmethod
|
|
1104
|
+
def StandardFont(self)->str:
|
|
1105
|
+
"""
|
|
1106
|
+
<summary>
|
|
1107
|
+
Returns or sets the name of the standard font. Read/write String.
|
|
1108
|
+
<example>The following code illustrates how to set the standard font for the workbook:
|
|
1109
|
+
<code>
|
|
1110
|
+
//Create worksheet
|
|
1111
|
+
Workbook workbook = new Workbook();
|
|
1112
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1113
|
+
//Set text
|
|
1114
|
+
worksheet["B2"].Text = "Text";
|
|
1115
|
+
//Set standard font
|
|
1116
|
+
workbook.DefaultFontName = "Arial";
|
|
1117
|
+
//Set standard font size
|
|
1118
|
+
workbook.DefaultFontSize = 18;
|
|
1119
|
+
//Save to file
|
|
1120
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1121
|
+
</code>
|
|
1122
|
+
</example>
|
|
1123
|
+
</summary>
|
|
1124
|
+
"""
|
|
1125
|
+
pass
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
@StandardFont.setter
|
|
1129
|
+
@abc.abstractmethod
|
|
1130
|
+
def StandardFont(self, value:str):
|
|
1131
|
+
"""
|
|
1132
|
+
|
|
1133
|
+
"""
|
|
1134
|
+
pass
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
@property
|
|
1138
|
+
@abc.abstractmethod
|
|
1139
|
+
def Allow3DRangesInDataValidation(self)->bool:
|
|
1140
|
+
"""
|
|
1141
|
+
<summary>
|
|
1142
|
+
Indicates whether to allow usage of 3D ranges in DataValidation
|
|
1143
|
+
list property (MS Excel doesn't allow).
|
|
1144
|
+
</summary>
|
|
1145
|
+
"""
|
|
1146
|
+
pass
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
@Allow3DRangesInDataValidation.setter
|
|
1150
|
+
@abc.abstractmethod
|
|
1151
|
+
def Allow3DRangesInDataValidation(self, value:bool):
|
|
1152
|
+
"""
|
|
1153
|
+
|
|
1154
|
+
"""
|
|
1155
|
+
pass
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
@property
|
|
1159
|
+
|
|
1160
|
+
@abc.abstractmethod
|
|
1161
|
+
def RowSeparator(self)->str:
|
|
1162
|
+
"""
|
|
1163
|
+
<summary>
|
|
1164
|
+
Gets / sets row separator for array parsing.
|
|
1165
|
+
</summary>
|
|
1166
|
+
"""
|
|
1167
|
+
pass
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
@property
|
|
1171
|
+
|
|
1172
|
+
@abc.abstractmethod
|
|
1173
|
+
def ArgumentsSeparator(self)->str:
|
|
1174
|
+
"""
|
|
1175
|
+
<summary>
|
|
1176
|
+
Formula arguments separator.
|
|
1177
|
+
</summary>
|
|
1178
|
+
"""
|
|
1179
|
+
pass
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
@property
|
|
1183
|
+
@abc.abstractmethod
|
|
1184
|
+
def IsRightToLeft(self)->bool:
|
|
1185
|
+
"""
|
|
1186
|
+
<summary>
|
|
1187
|
+
Indicates whether worksheet is displayed right to left.
|
|
1188
|
+
</summary>
|
|
1189
|
+
"""
|
|
1190
|
+
pass
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
@IsRightToLeft.setter
|
|
1194
|
+
@abc.abstractmethod
|
|
1195
|
+
def IsRightToLeft(self, value:bool):
|
|
1196
|
+
"""
|
|
1197
|
+
|
|
1198
|
+
"""
|
|
1199
|
+
pass
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
@property
|
|
1203
|
+
@abc.abstractmethod
|
|
1204
|
+
def DisplayWorkbookTabs(self)->bool:
|
|
1205
|
+
"""
|
|
1206
|
+
<summary>
|
|
1207
|
+
Indicates whether tabs are visible.
|
|
1208
|
+
</summary>
|
|
1209
|
+
"""
|
|
1210
|
+
pass
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
@DisplayWorkbookTabs.setter
|
|
1214
|
+
@abc.abstractmethod
|
|
1215
|
+
def DisplayWorkbookTabs(self, value:bool):
|
|
1216
|
+
"""
|
|
1217
|
+
|
|
1218
|
+
"""
|
|
1219
|
+
pass
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
@property
|
|
1223
|
+
|
|
1224
|
+
@abc.abstractmethod
|
|
1225
|
+
def TabSheets(self)->'ITabSheets':
|
|
1226
|
+
"""
|
|
1227
|
+
<summary>
|
|
1228
|
+
Returns collection of tab sheets. Read-only.
|
|
1229
|
+
</summary>
|
|
1230
|
+
"""
|
|
1231
|
+
pass
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
@property
|
|
1235
|
+
@abc.abstractmethod
|
|
1236
|
+
def DetectDateTimeInValue(self)->bool:
|
|
1237
|
+
"""
|
|
1238
|
+
<summary>
|
|
1239
|
+
Indicates whether library should try to detect string value passed to Value (and Value2)
|
|
1240
|
+
property as DateTime. Setting this property to false can increase performance greatly for
|
|
1241
|
+
such operations especially on Framework 1.0 and 1.1. Default value is true.
|
|
1242
|
+
</summary>
|
|
1243
|
+
"""
|
|
1244
|
+
pass
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
@DetectDateTimeInValue.setter
|
|
1248
|
+
@abc.abstractmethod
|
|
1249
|
+
def DetectDateTimeInValue(self, value:bool):
|
|
1250
|
+
"""
|
|
1251
|
+
|
|
1252
|
+
"""
|
|
1253
|
+
pass
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
@property
|
|
1257
|
+
@abc.abstractmethod
|
|
1258
|
+
def ReadOnlyRecommended(self)->bool:
|
|
1259
|
+
"""
|
|
1260
|
+
<summary>
|
|
1261
|
+
True to display a message when the file is opened, recommending that the file be opened as read-only.
|
|
1262
|
+
</summary>
|
|
1263
|
+
"""
|
|
1264
|
+
pass
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
@ReadOnlyRecommended.setter
|
|
1268
|
+
@abc.abstractmethod
|
|
1269
|
+
def ReadOnlyRecommended(self, value:bool):
|
|
1270
|
+
"""
|
|
1271
|
+
|
|
1272
|
+
"""
|
|
1273
|
+
pass
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
@property
|
|
1277
|
+
|
|
1278
|
+
@abc.abstractmethod
|
|
1279
|
+
def PasswordToOpen(self)->str:
|
|
1280
|
+
"""
|
|
1281
|
+
<summary>
|
|
1282
|
+
Gets / sets password to encrypt document.
|
|
1283
|
+
</summary>
|
|
1284
|
+
"""
|
|
1285
|
+
pass
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
@PasswordToOpen.setter
|
|
1289
|
+
@abc.abstractmethod
|
|
1290
|
+
def PasswordToOpen(self, value:str):
|
|
1291
|
+
"""
|
|
1292
|
+
|
|
1293
|
+
"""
|
|
1294
|
+
pass
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
@property
|
|
1298
|
+
@abc.abstractmethod
|
|
1299
|
+
def MaxRowCount(self)->int:
|
|
1300
|
+
"""
|
|
1301
|
+
<summary>
|
|
1302
|
+
Returns maximum row count for each worksheet in this workbook. Read-only.
|
|
1303
|
+
</summary>
|
|
1304
|
+
"""
|
|
1305
|
+
pass
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
@property
|
|
1309
|
+
@abc.abstractmethod
|
|
1310
|
+
def MaxColumnCount(self)->int:
|
|
1311
|
+
"""
|
|
1312
|
+
<summary>
|
|
1313
|
+
Returns maximum column count for each worksheet in this workbook. Read-only.
|
|
1314
|
+
</summary>
|
|
1315
|
+
"""
|
|
1316
|
+
pass
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
@property
|
|
1320
|
+
|
|
1321
|
+
@abc.abstractmethod
|
|
1322
|
+
def Version(self)->'ExcelVersion':
|
|
1323
|
+
"""
|
|
1324
|
+
<summary>
|
|
1325
|
+
Gets / sets excel version.
|
|
1326
|
+
</summary>
|
|
1327
|
+
"""
|
|
1328
|
+
pass
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
@Version.setter
|
|
1332
|
+
@abc.abstractmethod
|
|
1333
|
+
def Version(self, value:'ExcelVersion'):
|
|
1334
|
+
"""
|
|
1335
|
+
|
|
1336
|
+
"""
|
|
1337
|
+
pass
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
@property
|
|
1341
|
+
|
|
1342
|
+
@abc.abstractmethod
|
|
1343
|
+
def PivotCaches(self)->'XlsPivotCachesCollection':
|
|
1344
|
+
"""
|
|
1345
|
+
<summary>
|
|
1346
|
+
Returns pivot caches collection. Read-only.
|
|
1347
|
+
<example>The following code snippet illustrates how to get pivot caches:
|
|
1348
|
+
<code>
|
|
1349
|
+
//Load workbook
|
|
1350
|
+
Workbook workbook = new Workbook();
|
|
1351
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1352
|
+
//Gets pivot caches collection
|
|
1353
|
+
IPivotCaches pivotCaches = workbook.PivotCaches;
|
|
1354
|
+
</code>
|
|
1355
|
+
</example>
|
|
1356
|
+
</summary>
|
|
1357
|
+
"""
|
|
1358
|
+
pass
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
@abc.abstractmethod
|
|
1362
|
+
def Activate(self):
|
|
1363
|
+
"""
|
|
1364
|
+
<summary>
|
|
1365
|
+
Activates the first window associated with the workbook.
|
|
1366
|
+
</summary>
|
|
1367
|
+
"""
|
|
1368
|
+
pass
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
@abc.abstractmethod
|
|
1373
|
+
def AddFont(self ,fontToAdd:'IFont')->'IFont':
|
|
1374
|
+
"""
|
|
1375
|
+
<summary>
|
|
1376
|
+
Adds font to the inner fonts collection and makes this font read-only.
|
|
1377
|
+
</summary>
|
|
1378
|
+
<param name="fontToAdd">Font to add.</param>
|
|
1379
|
+
<returns>Added font.</returns>
|
|
1380
|
+
"""
|
|
1381
|
+
pass
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
@dispatch
|
|
1385
|
+
|
|
1386
|
+
@abc.abstractmethod
|
|
1387
|
+
def Close(self ,SaveChanges:bool,Filename:str):
|
|
1388
|
+
"""
|
|
1389
|
+
<summary>
|
|
1390
|
+
Closes the object.
|
|
1391
|
+
</summary>
|
|
1392
|
+
<param name="SaveChanges">If True, all changes will be saved.</param>
|
|
1393
|
+
<param name="Filename">Name of the file.</param>
|
|
1394
|
+
"""
|
|
1395
|
+
pass
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
@dispatch
|
|
1399
|
+
|
|
1400
|
+
@abc.abstractmethod
|
|
1401
|
+
def Close(self ,saveChanges:bool):
|
|
1402
|
+
"""
|
|
1403
|
+
<summary>
|
|
1404
|
+
Closes the object.
|
|
1405
|
+
</summary>
|
|
1406
|
+
<param name="saveChanges">If True, all changes will be saved.</param>
|
|
1407
|
+
"""
|
|
1408
|
+
pass
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
@dispatch
|
|
1412
|
+
@abc.abstractmethod
|
|
1413
|
+
def Close(self):
|
|
1414
|
+
"""
|
|
1415
|
+
<summary>
|
|
1416
|
+
Closes the object without saving.
|
|
1417
|
+
</summary>
|
|
1418
|
+
"""
|
|
1419
|
+
pass
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
@dispatch
|
|
1423
|
+
|
|
1424
|
+
@abc.abstractmethod
|
|
1425
|
+
def Close(self ,Filename:str):
|
|
1426
|
+
"""
|
|
1427
|
+
<summary>
|
|
1428
|
+
Closes the object and saves changes into specified file.
|
|
1429
|
+
</summary>
|
|
1430
|
+
<param name="Filename">
|
|
1431
|
+
File name in which workbook will be saved if SaveChanges is true.
|
|
1432
|
+
</param>
|
|
1433
|
+
"""
|
|
1434
|
+
pass
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
@abc.abstractmethod
|
|
1438
|
+
def CopyToClipboard(self):
|
|
1439
|
+
"""
|
|
1440
|
+
<summary>
|
|
1441
|
+
Copies workbook to the clipboard.
|
|
1442
|
+
</summary>
|
|
1443
|
+
"""
|
|
1444
|
+
pass
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
@abc.abstractmethod
|
|
1449
|
+
def CreateTemplateMarkersProcessor(self)->'IMarkersDesigner':
|
|
1450
|
+
"""
|
|
1451
|
+
<summary>
|
|
1452
|
+
Creates object that can be used for template markers processing.
|
|
1453
|
+
</summary>
|
|
1454
|
+
<returns>Object that can be used for template markers processing.</returns>
|
|
1455
|
+
"""
|
|
1456
|
+
pass
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
@abc.abstractmethod
|
|
1460
|
+
def Save(self):
|
|
1461
|
+
"""
|
|
1462
|
+
<summary>
|
|
1463
|
+
Saves changes to the specified workbook.
|
|
1464
|
+
<example>This sample shows how to save changes to the specified workbook:
|
|
1465
|
+
<code>
|
|
1466
|
+
//Load workbook
|
|
1467
|
+
Workbook workbook = new Workbook();
|
|
1468
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1469
|
+
//Save to file
|
|
1470
|
+
workbook.Save();
|
|
1471
|
+
</code>
|
|
1472
|
+
</example>
|
|
1473
|
+
</summary>
|
|
1474
|
+
"""
|
|
1475
|
+
pass
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
@dispatch
|
|
1479
|
+
|
|
1480
|
+
@abc.abstractmethod
|
|
1481
|
+
def SaveAs(self ,Filename:str):
|
|
1482
|
+
"""
|
|
1483
|
+
<summary>
|
|
1484
|
+
Short variant of SaveAs method.
|
|
1485
|
+
</summary>
|
|
1486
|
+
<param name="Filename"></param>
|
|
1487
|
+
"""
|
|
1488
|
+
pass
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
@dispatch
|
|
1492
|
+
|
|
1493
|
+
@abc.abstractmethod
|
|
1494
|
+
def SaveAs(self ,Filename:str,saveType:ExcelSaveType):
|
|
1495
|
+
"""
|
|
1496
|
+
<summary>
|
|
1497
|
+
Short variant of SaveAs method.
|
|
1498
|
+
</summary>
|
|
1499
|
+
<param name="Filename">Name of the file.</param>
|
|
1500
|
+
<param name="saveType">Excel save type.</param>
|
|
1501
|
+
"""
|
|
1502
|
+
pass
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
@abc.abstractmethod
|
|
1507
|
+
def SaveAsHtml(self ,filename:str,saveOptions:'HTMLOptions'):
|
|
1508
|
+
"""
|
|
1509
|
+
<summary>
|
|
1510
|
+
Saves changes to the specified stream.
|
|
1511
|
+
</summary>
|
|
1512
|
+
<param name="filename">Name of the file.</param>
|
|
1513
|
+
<param name="saveOptions">Save options in html.</param>
|
|
1514
|
+
"""
|
|
1515
|
+
pass
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
@dispatch
|
|
1519
|
+
|
|
1520
|
+
@abc.abstractmethod
|
|
1521
|
+
def SaveAs(self ,stream:Stream):
|
|
1522
|
+
"""
|
|
1523
|
+
<summary>
|
|
1524
|
+
Saves changes to the specified stream.
|
|
1525
|
+
</summary>
|
|
1526
|
+
<param name="stream">Stream that will receive workbook data.</param>
|
|
1527
|
+
"""
|
|
1528
|
+
pass
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
@dispatch
|
|
1532
|
+
|
|
1533
|
+
@abc.abstractmethod
|
|
1534
|
+
def SaveAs(self ,stream:Stream,saveType:ExcelSaveType):
|
|
1535
|
+
"""
|
|
1536
|
+
<summary>
|
|
1537
|
+
Saves changes to the specified stream.
|
|
1538
|
+
</summary>
|
|
1539
|
+
<param name="stream">Stream that will receive workbook data.</param>
|
|
1540
|
+
<param name="saveType">Type of the Excel file.</param>
|
|
1541
|
+
"""
|
|
1542
|
+
pass
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
# @dispatch
|
|
1546
|
+
#
|
|
1547
|
+
# @abc.abstractmethod
|
|
1548
|
+
# def SaveAs(self ,fileName:str,saveType:ExcelSaveType,response:'HttpResponse'):
|
|
1549
|
+
# """
|
|
1550
|
+
# <summary>
|
|
1551
|
+
# Saves changes to the specified HttpResponse.
|
|
1552
|
+
# </summary>
|
|
1553
|
+
# <param name="fileName">Name of the file in HttpResponse.</param>
|
|
1554
|
+
# <param name="saveType">Type of the Excel file.</param>
|
|
1555
|
+
# <param name="response">HttpResponse that will receive workbook's data.</param>
|
|
1556
|
+
# """
|
|
1557
|
+
# pass
|
|
1558
|
+
#
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
# @dispatch
|
|
1562
|
+
#
|
|
1563
|
+
# @abc.abstractmethod
|
|
1564
|
+
# def SaveAs(self ,fileName:str,response:'HttpResponse'):
|
|
1565
|
+
# """
|
|
1566
|
+
# <summary>
|
|
1567
|
+
# Saves changes to the specified HttpResponse.
|
|
1568
|
+
# </summary>
|
|
1569
|
+
# <param name="fileName">Name of the file in HttpResponse.</param>
|
|
1570
|
+
# <param name="response">HttpResponse to save in.</param>
|
|
1571
|
+
# """
|
|
1572
|
+
# pass
|
|
1573
|
+
#
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
@abc.abstractmethod
|
|
1578
|
+
def SetPaletteColor(self ,index:int,color:'Color'):
|
|
1579
|
+
"""
|
|
1580
|
+
<summary>
|
|
1581
|
+
Set user color for specified element in Color table.
|
|
1582
|
+
<example>The following code snippet illustrates how to set palette color:
|
|
1583
|
+
<code>
|
|
1584
|
+
//Create worksheet
|
|
1585
|
+
Workbook workbook = new Workbook();
|
|
1586
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1587
|
+
//Set palette color
|
|
1588
|
+
workbook.ChangePaletteColor(System.Drawing.Color.Red , 10);
|
|
1589
|
+
//Set color
|
|
1590
|
+
worksheet["B2"].Style.Color = workbook.Colors[10];
|
|
1591
|
+
//Save to file
|
|
1592
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1593
|
+
</code>
|
|
1594
|
+
</example>
|
|
1595
|
+
</summary>
|
|
1596
|
+
<param name="index">Index of Color in array.</param>
|
|
1597
|
+
<param name="color">New color which must be set.</param>
|
|
1598
|
+
"""
|
|
1599
|
+
pass
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
@abc.abstractmethod
|
|
1603
|
+
def ResetPalette(self):
|
|
1604
|
+
"""
|
|
1605
|
+
<summary>
|
|
1606
|
+
Recover palette to default values.
|
|
1607
|
+
<example>The following code snippets illustrates how to reset the palette:
|
|
1608
|
+
<code>
|
|
1609
|
+
//Create worksheet
|
|
1610
|
+
Workbook workbook = new Workbook();
|
|
1611
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1612
|
+
//Get colors
|
|
1613
|
+
System.Drawing.Color[] colors = workbook.Colors;
|
|
1614
|
+
//Check color
|
|
1615
|
+
Console.WriteLine(colors[2].Name);
|
|
1616
|
+
//Set color
|
|
1617
|
+
colors[2] = System.Drawing.Color.Yellow;
|
|
1618
|
+
//Reset palette
|
|
1619
|
+
workbook.ResetPalette();
|
|
1620
|
+
//Check color
|
|
1621
|
+
Console.WriteLine(workbook.Colors[2].Name);
|
|
1622
|
+
//Save to file
|
|
1623
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1624
|
+
</code>
|
|
1625
|
+
</example>
|
|
1626
|
+
</summary>
|
|
1627
|
+
"""
|
|
1628
|
+
pass
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
@abc.abstractmethod
|
|
1633
|
+
def GetPaletteColor(self ,color:'ExcelColors')->'Color':
|
|
1634
|
+
"""
|
|
1635
|
+
<summary>
|
|
1636
|
+
Method return Color object from workbook palette by its index.
|
|
1637
|
+
<example>The following code illustrates how to get the RGB color value for the specified color from ExcelColors enumeration:
|
|
1638
|
+
<code>
|
|
1639
|
+
//Create worksheet
|
|
1640
|
+
Workbook workbook = new Workbook();
|
|
1641
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1642
|
+
//Get color
|
|
1643
|
+
System.Drawing.Color color = workbook.GetPaletteColor(ExcelColors.Red);
|
|
1644
|
+
//Set color
|
|
1645
|
+
worksheet["B2"].Style.Color = workbook.Colors[10];
|
|
1646
|
+
//Save to file
|
|
1647
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1648
|
+
</code>
|
|
1649
|
+
</example>
|
|
1650
|
+
</summary>
|
|
1651
|
+
<param name="color">Index from palette array.</param>
|
|
1652
|
+
<returns>RGB Color.</returns>
|
|
1653
|
+
"""
|
|
1654
|
+
pass
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
@dispatch
|
|
1658
|
+
|
|
1659
|
+
@abc.abstractmethod
|
|
1660
|
+
def GetNearestColor(self ,color:Color)->ExcelColors:
|
|
1661
|
+
"""
|
|
1662
|
+
<summary>
|
|
1663
|
+
Gets the nearest color to the specified Color structure
|
|
1664
|
+
from Workbook palette.
|
|
1665
|
+
<example>The following code illustrates how to get the indexed color from ExcelColors for the given color from Color structure:
|
|
1666
|
+
<code>
|
|
1667
|
+
//Create worksheet
|
|
1668
|
+
Workbook workbook = new Workbook();
|
|
1669
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1670
|
+
//Get color
|
|
1671
|
+
ExcelColors color = workbook.GetMatchingColor(System.Drawing.Color.Red);
|
|
1672
|
+
//Set color
|
|
1673
|
+
worksheet["B2"].Style.KnownColor = color;
|
|
1674
|
+
//Save to file
|
|
1675
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1676
|
+
</code>
|
|
1677
|
+
</example>
|
|
1678
|
+
</summary>
|
|
1679
|
+
<param name="color">System color.</param>
|
|
1680
|
+
<returns>Color index from workbook palette.</returns>
|
|
1681
|
+
"""
|
|
1682
|
+
pass
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
@dispatch
|
|
1686
|
+
|
|
1687
|
+
@abc.abstractmethod
|
|
1688
|
+
def GetNearestColor(self ,r:int,g:int,b:int)->ExcelColors:
|
|
1689
|
+
"""
|
|
1690
|
+
<summary>
|
|
1691
|
+
Gets the nearest color to the specified by red, green, and blue
|
|
1692
|
+
values color from Workbook palette.
|
|
1693
|
+
<example>The following code illustrates how to get the indexed color from ExcelColors for the given color from Color structure:
|
|
1694
|
+
<code>
|
|
1695
|
+
//Create worksheet
|
|
1696
|
+
Workbook workbook = new Workbook();
|
|
1697
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1698
|
+
//Get color
|
|
1699
|
+
ExcelColors color = workbook.GetMatchingColor(255, 0, 0);
|
|
1700
|
+
//Set color
|
|
1701
|
+
worksheet["B2"].Style.KnownColor = color;
|
|
1702
|
+
//Save to file
|
|
1703
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1704
|
+
</code>
|
|
1705
|
+
</example>
|
|
1706
|
+
</summary>
|
|
1707
|
+
<param name="r">Red component of the color.</param>
|
|
1708
|
+
<param name="g">Green component of the color.</param>
|
|
1709
|
+
<param name="b">Blue component of the color.</param>
|
|
1710
|
+
<returns>Color index from workbook palette.</returns>
|
|
1711
|
+
"""
|
|
1712
|
+
pass
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
@dispatch
|
|
1716
|
+
|
|
1717
|
+
@abc.abstractmethod
|
|
1718
|
+
def SetColorOrGetNearest(self ,color:Color)->ExcelColors:
|
|
1719
|
+
"""
|
|
1720
|
+
<summary>
|
|
1721
|
+
If there is at least one free color, define a new color;
|
|
1722
|
+
if not, search for the closest one.
|
|
1723
|
+
</summary>
|
|
1724
|
+
<param name="color"></param>
|
|
1725
|
+
<returns>Color index from workbook palette.</returns>
|
|
1726
|
+
"""
|
|
1727
|
+
pass
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
@dispatch
|
|
1731
|
+
|
|
1732
|
+
@abc.abstractmethod
|
|
1733
|
+
def SetColorOrGetNearest(self ,r:int,g:int,b:int)->ExcelColors:
|
|
1734
|
+
"""
|
|
1735
|
+
<summary>
|
|
1736
|
+
If there is at least one free color, define a new color;
|
|
1737
|
+
if not, search for the closest one.
|
|
1738
|
+
</summary>
|
|
1739
|
+
<param name="r">Red component of the color.</param>
|
|
1740
|
+
<param name="g">Green component of the color.</param>
|
|
1741
|
+
<param name="b">Blue component of the color.</param>
|
|
1742
|
+
<returns>Color index from workbook palette.</returns>
|
|
1743
|
+
"""
|
|
1744
|
+
pass
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
@dispatch
|
|
1748
|
+
|
|
1749
|
+
@abc.abstractmethod
|
|
1750
|
+
def CreateFont(self)->IFont:
|
|
1751
|
+
"""
|
|
1752
|
+
<summary>
|
|
1753
|
+
Method to create a font object and register it in the workbook.
|
|
1754
|
+
<example>The following code illustrates how to create IFont object:
|
|
1755
|
+
<code>
|
|
1756
|
+
//Create worksheet
|
|
1757
|
+
Workbook workbook = new Workbook();
|
|
1758
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1759
|
+
//Set text
|
|
1760
|
+
IRichTextString richText = worksheet["B2"].RichText;
|
|
1761
|
+
//Create font
|
|
1762
|
+
IFont font = workbook.CreateFont();
|
|
1763
|
+
//Set color
|
|
1764
|
+
font.Color = Color.Red;
|
|
1765
|
+
//Set text
|
|
1766
|
+
richText.Text = "Sample";
|
|
1767
|
+
//Set font
|
|
1768
|
+
richText.SetFont(0, 5, font);
|
|
1769
|
+
//Save to file
|
|
1770
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1771
|
+
</code>
|
|
1772
|
+
</example>
|
|
1773
|
+
</summary>
|
|
1774
|
+
<returns>Newly created font.</returns>
|
|
1775
|
+
"""
|
|
1776
|
+
pass
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
@dispatch
|
|
1780
|
+
|
|
1781
|
+
@abc.abstractmethod
|
|
1782
|
+
def CreateFont(self ,baseFont:IFont)->IFont:
|
|
1783
|
+
"""
|
|
1784
|
+
<summary>
|
|
1785
|
+
Method that creates font object based on another font object
|
|
1786
|
+
and registers it in the workbook.
|
|
1787
|
+
</summary>
|
|
1788
|
+
<param name="baseFont">Base font for the new one.</param>
|
|
1789
|
+
<returns>Newly created font.</returns>
|
|
1790
|
+
"""
|
|
1791
|
+
pass
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
@dispatch
|
|
1795
|
+
|
|
1796
|
+
@abc.abstractmethod
|
|
1797
|
+
def CreateFont(self ,nativeFont:Font)->IFont:
|
|
1798
|
+
"""
|
|
1799
|
+
<summary>
|
|
1800
|
+
Method creates a font object based on native font and register it in the workbook.
|
|
1801
|
+
</summary>]
|
|
1802
|
+
<param name="nativeFont">Native font to get settings from.</param> <returns>Newly created font.</returns>
|
|
1803
|
+
"""
|
|
1804
|
+
pass
|
|
1805
|
+
|
|
1806
|
+
|