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/IXLSRange.py
ADDED
|
@@ -0,0 +1,2479 @@
|
|
|
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 IXLSRange ( IExcelApplication) :
|
|
10
|
+
"""
|
|
11
|
+
<summary>
|
|
12
|
+
Represents a cell, row, column, selection of cells
|
|
13
|
+
containing one or more contiguous blocks of cells,
|
|
14
|
+
or a 3-D range.
|
|
15
|
+
</summary>
|
|
16
|
+
"""
|
|
17
|
+
#@property
|
|
18
|
+
|
|
19
|
+
#@abc.abstractmethod
|
|
20
|
+
#def Value2(self)->'SpireObject':
|
|
21
|
+
# """
|
|
22
|
+
#<summary>
|
|
23
|
+
# Returns or sets the cell value. Read/write Variant.
|
|
24
|
+
# The only difference between this property and the Value property is
|
|
25
|
+
# that the Value2 property doesn't use the Currency and Date data types.
|
|
26
|
+
# <example>The following code illustrates how to access Value2 property of the Range:
|
|
27
|
+
# <code>
|
|
28
|
+
# //Create worksheet
|
|
29
|
+
# Workbook workbook = new Workbook();
|
|
30
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
31
|
+
# //Assigning Value2 property of the Range
|
|
32
|
+
# worksheet["A1"].Value2 = DateTime.Now;
|
|
33
|
+
# worksheet["A3"].Value2 = false;
|
|
34
|
+
# //Checking Range types
|
|
35
|
+
# Console.WriteLine(worksheet["A1"].HasDateTime);
|
|
36
|
+
# Console.WriteLine(worksheet["A3"].HasBoolean);
|
|
37
|
+
# </code>
|
|
38
|
+
# </example>
|
|
39
|
+
#</summary>
|
|
40
|
+
# """
|
|
41
|
+
# pass
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
#@Value2.setter
|
|
45
|
+
#@abc.abstractmethod
|
|
46
|
+
#def Value2(self, value:'SpireObject'):
|
|
47
|
+
# """
|
|
48
|
+
|
|
49
|
+
# """
|
|
50
|
+
# pass
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
@property
|
|
54
|
+
|
|
55
|
+
@abc.abstractmethod
|
|
56
|
+
def VerticalAlignment(self)->'VerticalAlignType':
|
|
57
|
+
"""
|
|
58
|
+
<summary>
|
|
59
|
+
Returns or sets the vertical alignment of the specified object.
|
|
60
|
+
Read/write VerticalAlignType.
|
|
61
|
+
<example>The following code illustrates how to set vertical alignment type:
|
|
62
|
+
<code>
|
|
63
|
+
//Create worksheet
|
|
64
|
+
Workbook workbook = new Workbook();
|
|
65
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
66
|
+
//Set text
|
|
67
|
+
worksheet["A1"].Text = "Test";
|
|
68
|
+
//Set alignment
|
|
69
|
+
worksheet["A1"].VerticalAlignment = VerticalAlignType.Top;
|
|
70
|
+
//Save to file
|
|
71
|
+
workbook.SaveToFile("VerticalAlignment.xlsx");
|
|
72
|
+
</code>
|
|
73
|
+
</example>
|
|
74
|
+
</summary>
|
|
75
|
+
"""
|
|
76
|
+
pass
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
@VerticalAlignment.setter
|
|
80
|
+
@abc.abstractmethod
|
|
81
|
+
def VerticalAlignment(self, value:'VerticalAlignType'):
|
|
82
|
+
"""
|
|
83
|
+
|
|
84
|
+
"""
|
|
85
|
+
pass
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
@property
|
|
89
|
+
|
|
90
|
+
@abc.abstractmethod
|
|
91
|
+
def Worksheet(self)->'IWorksheet':
|
|
92
|
+
"""
|
|
93
|
+
<summary>
|
|
94
|
+
Returns a Worksheet object that represents the worksheet
|
|
95
|
+
containing the specified range. Read-only.
|
|
96
|
+
</summary>
|
|
97
|
+
"""
|
|
98
|
+
pass
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
@dispatch
|
|
102
|
+
|
|
103
|
+
@abc.abstractmethod
|
|
104
|
+
def get_Item(self ,row:int,column:int)->'IXLSRange':
|
|
105
|
+
"""
|
|
106
|
+
<summary>
|
|
107
|
+
Gets / sets cell by row and column index. Row and column indexes are one-based.
|
|
108
|
+
</summary>
|
|
109
|
+
"""
|
|
110
|
+
pass
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
@abc.abstractmethod
|
|
115
|
+
def set_Item(self ,row:int,column:int,value:'IXLSRange'):
|
|
116
|
+
"""
|
|
117
|
+
|
|
118
|
+
"""
|
|
119
|
+
pass
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
@dispatch
|
|
123
|
+
|
|
124
|
+
@abc.abstractmethod
|
|
125
|
+
def get_Item(self ,row:int,column:int,lastRow:int,lastColumn:int)->'IXLSRange':
|
|
126
|
+
"""
|
|
127
|
+
<summary>
|
|
128
|
+
Get cell range. Row and column indexes are one-based. Read-only.
|
|
129
|
+
</summary>
|
|
130
|
+
"""
|
|
131
|
+
pass
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
@dispatch
|
|
135
|
+
|
|
136
|
+
@abc.abstractmethod
|
|
137
|
+
def get_Item(self ,name:str)->'IXLSRange':
|
|
138
|
+
"""
|
|
139
|
+
<summary>
|
|
140
|
+
Get cell range. Read-only.
|
|
141
|
+
</summary>
|
|
142
|
+
"""
|
|
143
|
+
pass
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
@dispatch
|
|
147
|
+
|
|
148
|
+
@abc.abstractmethod
|
|
149
|
+
def get_Item(self ,name:str,IsR1C1Notation:bool)->'IXLSRange':
|
|
150
|
+
"""
|
|
151
|
+
<summary>
|
|
152
|
+
Gets cell range. Read-only.
|
|
153
|
+
</summary>
|
|
154
|
+
"""
|
|
155
|
+
pass
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
@property
|
|
159
|
+
|
|
160
|
+
@abc.abstractmethod
|
|
161
|
+
def ConditionalFormats(self)->'ConditionalFormats':
|
|
162
|
+
"""
|
|
163
|
+
<summary>
|
|
164
|
+
Collection of conditional formats.
|
|
165
|
+
</summary>
|
|
166
|
+
"""
|
|
167
|
+
pass
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
@property
|
|
171
|
+
|
|
172
|
+
@abc.abstractmethod
|
|
173
|
+
def DataValidation(self)->'Validation':
|
|
174
|
+
"""
|
|
175
|
+
<summary>
|
|
176
|
+
Data validation for the range.
|
|
177
|
+
<example>The following code illustrates how to access DataValidation property of the Range:
|
|
178
|
+
<code>
|
|
179
|
+
//Create worksheet
|
|
180
|
+
Workbook workbook = new Workbook();
|
|
181
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
182
|
+
//Data validation for number
|
|
183
|
+
IDataValidation validation = worksheet.Range["A3"].DataValidation;
|
|
184
|
+
validation.AllowType = CellDataType.Integer;
|
|
185
|
+
//Value between 0 to 10
|
|
186
|
+
validation.CompareOperator = ValidationComparisonOperator.Between;
|
|
187
|
+
validation.Formula1 = "0";
|
|
188
|
+
validation.Formula2 = "10";
|
|
189
|
+
//Save to file
|
|
190
|
+
workbook.SaveToFile("DataValidation.xlsx");
|
|
191
|
+
</code>
|
|
192
|
+
</example>
|
|
193
|
+
</summary>
|
|
194
|
+
"""
|
|
195
|
+
pass
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
@property
|
|
199
|
+
|
|
200
|
+
@abc.abstractmethod
|
|
201
|
+
def FormulaStringValue(self)->str:
|
|
202
|
+
"""
|
|
203
|
+
<summary>
|
|
204
|
+
Gets / sets string value evaluated by formula.
|
|
205
|
+
</summary>
|
|
206
|
+
"""
|
|
207
|
+
pass
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
@FormulaStringValue.setter
|
|
211
|
+
@abc.abstractmethod
|
|
212
|
+
def FormulaStringValue(self, value:str):
|
|
213
|
+
"""
|
|
214
|
+
|
|
215
|
+
"""
|
|
216
|
+
pass
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
@property
|
|
220
|
+
@abc.abstractmethod
|
|
221
|
+
def FormulaNumberValue(self)->float:
|
|
222
|
+
"""
|
|
223
|
+
<summary>
|
|
224
|
+
Gets / sets number value evaluated by formula.
|
|
225
|
+
</summary>
|
|
226
|
+
"""
|
|
227
|
+
pass
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
@FormulaNumberValue.setter
|
|
231
|
+
@abc.abstractmethod
|
|
232
|
+
def FormulaNumberValue(self, value:float):
|
|
233
|
+
"""
|
|
234
|
+
|
|
235
|
+
"""
|
|
236
|
+
pass
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
@property
|
|
240
|
+
@abc.abstractmethod
|
|
241
|
+
def HasFormulaBoolValue(self)->bool:
|
|
242
|
+
"""
|
|
243
|
+
<summary>
|
|
244
|
+
Indicates if current range has formula bool value. Read only.
|
|
245
|
+
</summary>
|
|
246
|
+
"""
|
|
247
|
+
pass
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
@property
|
|
251
|
+
@abc.abstractmethod
|
|
252
|
+
def HasFormulaErrorValue(self)->bool:
|
|
253
|
+
"""
|
|
254
|
+
<summary>
|
|
255
|
+
Indicates if current range has formula error value. Read only.
|
|
256
|
+
</summary>
|
|
257
|
+
"""
|
|
258
|
+
pass
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
@property
|
|
262
|
+
|
|
263
|
+
@abc.abstractmethod
|
|
264
|
+
def Comment(self)->'ICommentShape':
|
|
265
|
+
"""
|
|
266
|
+
<summary>
|
|
267
|
+
Comment assigned to the range. Read-only.
|
|
268
|
+
<example>The following code illustrates how to access Comments property of the Range:
|
|
269
|
+
<code>
|
|
270
|
+
//Create worksheet
|
|
271
|
+
Workbook workbook = new Workbook();
|
|
272
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
273
|
+
//Adding comments to a cell
|
|
274
|
+
worksheet.Range["A1"].AddComment().Text = "Comments";
|
|
275
|
+
//Add Rich Text Comments
|
|
276
|
+
CellRange range = worksheet.Range["A6"];
|
|
277
|
+
range.AddComment().RichText.Text = "RichText";
|
|
278
|
+
IRichTextString rtf = range.Comment.RichText;
|
|
279
|
+
//Formatting first 4 characters
|
|
280
|
+
IFont redFont = workbook.CreateFont();
|
|
281
|
+
redFont.IsBold = true;
|
|
282
|
+
redFont.Color = Color.Red;
|
|
283
|
+
rtf.SetFont(0, 3, redFont);
|
|
284
|
+
//Save to file
|
|
285
|
+
workbook.SaveToFile("DataValidation.xlsx");
|
|
286
|
+
</code>
|
|
287
|
+
</example>
|
|
288
|
+
</summary>
|
|
289
|
+
"""
|
|
290
|
+
pass
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
@property
|
|
294
|
+
|
|
295
|
+
@abc.abstractmethod
|
|
296
|
+
def RichText(self)->'IRichTextString':
|
|
297
|
+
"""
|
|
298
|
+
<summary>
|
|
299
|
+
String with rich text formatting. Read-only.
|
|
300
|
+
<example>The following code illustrates how to set rich text formatting in the range:
|
|
301
|
+
<code>
|
|
302
|
+
//Create worksheet
|
|
303
|
+
Workbook workbook = new Workbook();
|
|
304
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
305
|
+
//Create style
|
|
306
|
+
IStyle style = workbook.Styles.Add("CustomStyle");
|
|
307
|
+
//Set rich text
|
|
308
|
+
IRichTextString richText = worksheet["C2"].RichText;
|
|
309
|
+
richText.Text = "Sample text";
|
|
310
|
+
//Set rich text font
|
|
311
|
+
IFont font = style.Font;
|
|
312
|
+
font.IsBold = true;
|
|
313
|
+
richText.SetFont(0, 5, font);
|
|
314
|
+
//Save to file
|
|
315
|
+
workbook.SaveToFile("RichText.xlsx");
|
|
316
|
+
</code>
|
|
317
|
+
</example>
|
|
318
|
+
</summary>
|
|
319
|
+
"""
|
|
320
|
+
pass
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
@property
|
|
324
|
+
|
|
325
|
+
@abc.abstractmethod
|
|
326
|
+
def HtmlString(self)->str:
|
|
327
|
+
"""
|
|
328
|
+
<summary>
|
|
329
|
+
Gets and sets the html string which contains data and some formattings in this cell.
|
|
330
|
+
</summary>
|
|
331
|
+
"""
|
|
332
|
+
pass
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
@HtmlString.setter
|
|
336
|
+
@abc.abstractmethod
|
|
337
|
+
def HtmlString(self, value:str):
|
|
338
|
+
"""
|
|
339
|
+
|
|
340
|
+
"""
|
|
341
|
+
pass
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
@property
|
|
345
|
+
@abc.abstractmethod
|
|
346
|
+
def HasMerged(self)->bool:
|
|
347
|
+
"""
|
|
348
|
+
<summary>
|
|
349
|
+
Indicates whether this range is part of merged range. Read-only.
|
|
350
|
+
<example>The following code illustrates how to access HasMerged property:
|
|
351
|
+
<code>
|
|
352
|
+
//Create worksheet
|
|
353
|
+
Workbook workbook = new Workbook();
|
|
354
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
355
|
+
//Set text
|
|
356
|
+
worksheet["A1"].Text = "Sample text in cell";
|
|
357
|
+
//Set merge
|
|
358
|
+
worksheet["A1:B1"].Merge();
|
|
359
|
+
//Check merge
|
|
360
|
+
Console.Write(worksheet["A1:B1"].HasMerged);
|
|
361
|
+
</code>
|
|
362
|
+
</example>
|
|
363
|
+
</summary>
|
|
364
|
+
"""
|
|
365
|
+
pass
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
@property
|
|
369
|
+
|
|
370
|
+
@abc.abstractmethod
|
|
371
|
+
def MergeArea(self)->'IXLSRange':
|
|
372
|
+
"""
|
|
373
|
+
<summary>
|
|
374
|
+
Returns a Range object that represents the merged range containing
|
|
375
|
+
the specified cell. If the specified cell is not in a merged range,
|
|
376
|
+
this property returns NULL. Read-only.
|
|
377
|
+
<example>The following code illustrates how to access MergeArea property:
|
|
378
|
+
<code>
|
|
379
|
+
//Create worksheet
|
|
380
|
+
Workbook workbook = new Workbook();
|
|
381
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
382
|
+
//Set text
|
|
383
|
+
worksheet["C2"].Text = "Sample text in cell";
|
|
384
|
+
//Set merge
|
|
385
|
+
worksheet["C2:D3"].Merge();
|
|
386
|
+
//Check merge area
|
|
387
|
+
Console.Write(worksheet["C2"].MergeArea.AddressLocal);
|
|
388
|
+
</code>
|
|
389
|
+
</example>
|
|
390
|
+
</summary>
|
|
391
|
+
"""
|
|
392
|
+
pass
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
@property
|
|
396
|
+
@abc.abstractmethod
|
|
397
|
+
def IsWrapText(self)->bool:
|
|
398
|
+
"""
|
|
399
|
+
<summary>
|
|
400
|
+
True if Microsoft Excel wraps the text in the object.
|
|
401
|
+
Read/write Boolean.
|
|
402
|
+
<example>The following code illustrates how to access WrapText property:
|
|
403
|
+
<code>
|
|
404
|
+
//Create worksheet
|
|
405
|
+
Workbook workbook = new Workbook();
|
|
406
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
407
|
+
//Set text
|
|
408
|
+
worksheet["A1"].Text = "This cell contains sample text";
|
|
409
|
+
//Set wrap text
|
|
410
|
+
worksheet["A1"].IsWrapText = true;
|
|
411
|
+
//Save to file
|
|
412
|
+
workbook.SaveToFile("IsWrapText.xlsx");
|
|
413
|
+
</code>
|
|
414
|
+
</example>
|
|
415
|
+
</summary>
|
|
416
|
+
"""
|
|
417
|
+
pass
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
@IsWrapText.setter
|
|
421
|
+
@abc.abstractmethod
|
|
422
|
+
def IsWrapText(self, value:bool):
|
|
423
|
+
"""
|
|
424
|
+
|
|
425
|
+
"""
|
|
426
|
+
pass
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
@property
|
|
430
|
+
@abc.abstractmethod
|
|
431
|
+
def HasExternalFormula(self)->bool:
|
|
432
|
+
"""
|
|
433
|
+
<summary>
|
|
434
|
+
Indicates is current range has external formula. Read-only.
|
|
435
|
+
</summary>
|
|
436
|
+
"""
|
|
437
|
+
pass
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
@property
|
|
441
|
+
|
|
442
|
+
@abc.abstractmethod
|
|
443
|
+
def IgnoreErrorOptions(self)->'IgnoreErrorType':
|
|
444
|
+
"""
|
|
445
|
+
<summary>
|
|
446
|
+
Represents ignore error options.
|
|
447
|
+
</summary>
|
|
448
|
+
"""
|
|
449
|
+
pass
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
@IgnoreErrorOptions.setter
|
|
453
|
+
@abc.abstractmethod
|
|
454
|
+
def IgnoreErrorOptions(self, value:'IgnoreErrorType'):
|
|
455
|
+
"""
|
|
456
|
+
|
|
457
|
+
"""
|
|
458
|
+
pass
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
@property
|
|
462
|
+
|
|
463
|
+
@abc.abstractmethod
|
|
464
|
+
def IsStringsPreserved(self)->bool:
|
|
465
|
+
"""
|
|
466
|
+
<summary>
|
|
467
|
+
Indicates whether all values in the range are preserved as strings.
|
|
468
|
+
</summary>
|
|
469
|
+
"""
|
|
470
|
+
pass
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
@IsStringsPreserved.setter
|
|
475
|
+
@abc.abstractmethod
|
|
476
|
+
def IsStringsPreserved(self, value:bool):
|
|
477
|
+
"""
|
|
478
|
+
|
|
479
|
+
"""
|
|
480
|
+
pass
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
@property
|
|
485
|
+
|
|
486
|
+
@abc.abstractmethod
|
|
487
|
+
def BuiltInStyle(self)->BuiltInStyles:
|
|
488
|
+
"""
|
|
489
|
+
<summary>
|
|
490
|
+
Gets/sets built in style.
|
|
491
|
+
<example>The following code illustrates how to access BuiltInStyle property:
|
|
492
|
+
<code>
|
|
493
|
+
//Create worksheet
|
|
494
|
+
Workbook workbook = new Workbook();
|
|
495
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
496
|
+
//Set text
|
|
497
|
+
worksheet["C2"].Text = "Sample";
|
|
498
|
+
//Set built in style
|
|
499
|
+
worksheet["C2"].BuiltInStyle = BuiltInStyles.Accent3;
|
|
500
|
+
//Save to file
|
|
501
|
+
workbook.SaveToFile("BuiltInStyle.xlsx");
|
|
502
|
+
</code>
|
|
503
|
+
</example>
|
|
504
|
+
</summary>
|
|
505
|
+
"""
|
|
506
|
+
pass
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
@BuiltInStyle.setter
|
|
511
|
+
@abc.abstractmethod
|
|
512
|
+
def BuiltInStyle(self, value:BuiltInStyles):
|
|
513
|
+
"""
|
|
514
|
+
|
|
515
|
+
"""
|
|
516
|
+
pass
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
@property
|
|
521
|
+
|
|
522
|
+
@abc.abstractmethod
|
|
523
|
+
def Hyperlinks(self)->'IHyperLinks':
|
|
524
|
+
"""
|
|
525
|
+
<summary>
|
|
526
|
+
Returns hyperlinks for this range.
|
|
527
|
+
</summary>
|
|
528
|
+
"""
|
|
529
|
+
pass
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
@abc.abstractmethod
|
|
534
|
+
def Activate(self ,scroll:bool)->'IXLSRange':
|
|
535
|
+
"""
|
|
536
|
+
<summary>
|
|
537
|
+
Activates a single cell, scroll to it and activates the corresponding sheet.
|
|
538
|
+
To select a range of cells, use the Select method.
|
|
539
|
+
<example>The following code illustrates how to activate a Range with scroll flag:
|
|
540
|
+
<code>
|
|
541
|
+
//Create worksheet
|
|
542
|
+
Workbook workbook = new Workbook();
|
|
543
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
544
|
+
//Activates 'F1' cell.
|
|
545
|
+
worksheet.Range["F1"].Activate(true);
|
|
546
|
+
//Save to file
|
|
547
|
+
workbook.SaveToFile("Activate.xlsx");
|
|
548
|
+
</code>
|
|
549
|
+
</example>
|
|
550
|
+
</summary>
|
|
551
|
+
<param name="scroll">True to scroll to the cell</param>
|
|
552
|
+
<returns>Returns the active cell.</returns>
|
|
553
|
+
"""
|
|
554
|
+
pass
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
@dispatch
|
|
558
|
+
@abc.abstractmethod
|
|
559
|
+
def Merge(self):
|
|
560
|
+
"""
|
|
561
|
+
<summary>
|
|
562
|
+
Creates a merged cell from the specified Range object.
|
|
563
|
+
<example>The following code illustrates how to merge the Range:
|
|
564
|
+
<code>
|
|
565
|
+
//Create worksheet
|
|
566
|
+
Workbook workbook = new Workbook();
|
|
567
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
568
|
+
//Set text
|
|
569
|
+
worksheet["A1"].Text = "Merged cell";
|
|
570
|
+
//Merge cells
|
|
571
|
+
worksheet["A1:B1"].Merge();
|
|
572
|
+
//Save to file
|
|
573
|
+
workbook.SaveToFile("Merge.xlsx");
|
|
574
|
+
</code>
|
|
575
|
+
</example>
|
|
576
|
+
</summary>
|
|
577
|
+
"""
|
|
578
|
+
pass
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
@dispatch
|
|
582
|
+
|
|
583
|
+
@abc.abstractmethod
|
|
584
|
+
def Merge(self ,clearCells:bool):
|
|
585
|
+
"""
|
|
586
|
+
<summary>
|
|
587
|
+
Creates a merged cell from the specified Range object.
|
|
588
|
+
<example>The following code illustrates how to merge the Range with clear option:
|
|
589
|
+
<code>
|
|
590
|
+
//Create worksheet
|
|
591
|
+
Workbook workbook = new Workbook();
|
|
592
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
593
|
+
//Set text
|
|
594
|
+
worksheet["A1"].Text = "Merged cell";
|
|
595
|
+
worksheet["B1"].Text = "sample";
|
|
596
|
+
//Merge cells
|
|
597
|
+
worksheet["A1:B1"].Merge(true);
|
|
598
|
+
//Save to file
|
|
599
|
+
workbook.SaveToFile("Merge.xlsx");
|
|
600
|
+
</code>
|
|
601
|
+
</example>
|
|
602
|
+
</summary>
|
|
603
|
+
<param name="clearCells">Indicates whether to clear unnecessary cells.</param>
|
|
604
|
+
"""
|
|
605
|
+
pass
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
@abc.abstractmethod
|
|
609
|
+
def UnMerge(self):
|
|
610
|
+
"""
|
|
611
|
+
<summary>
|
|
612
|
+
Separates a merged area into individual cells.
|
|
613
|
+
<example>The following code illustrates how to UnMerge the merged cells:
|
|
614
|
+
<code>
|
|
615
|
+
//Create worksheet
|
|
616
|
+
Workbook workbook = new Workbook();
|
|
617
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
618
|
+
//Set text
|
|
619
|
+
worksheet["A1"].Text = "Merged cell";
|
|
620
|
+
//Merge cells
|
|
621
|
+
worksheet["A1:B1"].Merge(true);
|
|
622
|
+
//Unmerge cells
|
|
623
|
+
worksheet["A1:B1"].UnMerge();
|
|
624
|
+
//Save to file
|
|
625
|
+
workbook.SaveToFile("UnMerge.xlsx");
|
|
626
|
+
</code>
|
|
627
|
+
</example>
|
|
628
|
+
</summary>
|
|
629
|
+
"""
|
|
630
|
+
pass
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
@abc.abstractmethod
|
|
634
|
+
def FreezePanes(self):
|
|
635
|
+
"""
|
|
636
|
+
<summary>
|
|
637
|
+
Freezes pane at the current range.
|
|
638
|
+
<example>The following code illustrates how to freeze a pane in the Range:
|
|
639
|
+
<code>
|
|
640
|
+
//Create worksheet
|
|
641
|
+
Workbook workbook = new Workbook();
|
|
642
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
643
|
+
//Applying Freeze Pane to the sheet by specifying a cell
|
|
644
|
+
worksheet.Range["B2"].FreezePanes();
|
|
645
|
+
//Save to file
|
|
646
|
+
workbook.SaveToFile("FreezePanes.xlsx");
|
|
647
|
+
</code>
|
|
648
|
+
</example>
|
|
649
|
+
</summary>
|
|
650
|
+
"""
|
|
651
|
+
pass
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
@abc.abstractmethod
|
|
655
|
+
def ClearContents(self):
|
|
656
|
+
"""
|
|
657
|
+
<summary>
|
|
658
|
+
Clear the contents of the Range.
|
|
659
|
+
<example>The following code illustrates how to clear the Range:
|
|
660
|
+
<code>
|
|
661
|
+
//Create worksheet
|
|
662
|
+
Workbook workbook = new Workbook();
|
|
663
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
664
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
665
|
+
//Clears the Range C2
|
|
666
|
+
worksheet.Range["C2"].ClearContents();
|
|
667
|
+
//Save to file
|
|
668
|
+
workbook.SaveToFile("ClearContents.xlsx");
|
|
669
|
+
</code>
|
|
670
|
+
</example>
|
|
671
|
+
</summary>
|
|
672
|
+
"""
|
|
673
|
+
pass
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
@abc.abstractmethod
|
|
678
|
+
def Clear(self ,option:'ExcelClearOptions'):
|
|
679
|
+
"""
|
|
680
|
+
<summary>
|
|
681
|
+
Clears the cell content, formats, comments based on clear option.
|
|
682
|
+
<example>The following code illustrates how to clear the Range with clear options:
|
|
683
|
+
<code>
|
|
684
|
+
//Create worksheet
|
|
685
|
+
Workbook workbook = new Workbook();
|
|
686
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
687
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
688
|
+
//Clears the Range C2 with its clear options
|
|
689
|
+
worksheet.Range["C2"].Clear(ExcelClearOptions.ClearAll);
|
|
690
|
+
//Save to file
|
|
691
|
+
workbook.SaveToFile("ClearContents.xlsx");
|
|
692
|
+
</code>
|
|
693
|
+
</example>
|
|
694
|
+
</summary>
|
|
695
|
+
<param name="option">Represents the clear options.</param>
|
|
696
|
+
"""
|
|
697
|
+
pass
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
@abc.abstractmethod
|
|
702
|
+
def Intersect(self ,range:'IXLSRange')->'IXLSRange':
|
|
703
|
+
"""
|
|
704
|
+
<summary>
|
|
705
|
+
Returns intersection of this range with the specified one.
|
|
706
|
+
<example>The following code illustrates how to perform intersectwith in the Range:
|
|
707
|
+
<code>
|
|
708
|
+
//Create worksheet
|
|
709
|
+
Workbook workbook = new Workbook();
|
|
710
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
711
|
+
//Get intersect range
|
|
712
|
+
IXLSRange range = worksheet.Range["A16:C16"];
|
|
713
|
+
IXLSRange commonRange = worksheet.Range["B16:D16"].Intersect(range);
|
|
714
|
+
//Save to file
|
|
715
|
+
workbook.SaveToFile("Intersect.xlsx");
|
|
716
|
+
</code>
|
|
717
|
+
</example>
|
|
718
|
+
</summary>
|
|
719
|
+
<param name="range">The Range with which to intersect.</param>
|
|
720
|
+
<returns>Range intersection; if there is no intersection, NULL is returned.</returns>
|
|
721
|
+
"""
|
|
722
|
+
pass
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
@dispatch
|
|
726
|
+
|
|
727
|
+
@abc.abstractmethod
|
|
728
|
+
def Merge(self ,range:'IXLSRange')->'IXLSRange':
|
|
729
|
+
"""
|
|
730
|
+
<summary>
|
|
731
|
+
Returns merge of this range with the specified one.
|
|
732
|
+
<example>The following code illustrates how to check whether two ranges are mergable or not:
|
|
733
|
+
<code>
|
|
734
|
+
//Create worksheet
|
|
735
|
+
Workbook workbook = new Workbook();
|
|
736
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
737
|
+
//Merge range
|
|
738
|
+
worksheet["A2:B2"].Merge();
|
|
739
|
+
//Get mergable range
|
|
740
|
+
IXLSRange mergableRange = worksheet["A2"].MergeArea.Merge(worksheet["C2"]);
|
|
741
|
+
//Check mergable Area
|
|
742
|
+
Console.Write(mergableRange.RangeAddressLocal);
|
|
743
|
+
//Save to file
|
|
744
|
+
workbook.SaveToFile("Intersect.xlsx");
|
|
745
|
+
</code>
|
|
746
|
+
</example>
|
|
747
|
+
</summary>
|
|
748
|
+
<param name="range">The Range to merge with.</param>
|
|
749
|
+
<returns>Merged ranges or NULL if wasn't able to merge ranges.</returns>
|
|
750
|
+
"""
|
|
751
|
+
pass
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
@abc.abstractmethod
|
|
755
|
+
def AutoFitRows(self):
|
|
756
|
+
"""
|
|
757
|
+
<summary>
|
|
758
|
+
Autofits all rows in the range.
|
|
759
|
+
<example>The following code illustrates how to auto-size row height to its cell content:
|
|
760
|
+
<code>
|
|
761
|
+
//Create worksheet
|
|
762
|
+
Workbook workbook = new Workbook();
|
|
763
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
764
|
+
//Auto-fit rows
|
|
765
|
+
worksheet.Range["A2"].Text = "Fit the content to row";
|
|
766
|
+
worksheet.Range["A2"].IsWrapText = true;
|
|
767
|
+
worksheet.Range["A2"].AutoFitRows();
|
|
768
|
+
//Save to file
|
|
769
|
+
workbook.SaveToFile("AutoFitRows.xlsx");
|
|
770
|
+
</code>
|
|
771
|
+
</example>
|
|
772
|
+
</summary>
|
|
773
|
+
"""
|
|
774
|
+
pass
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
@abc.abstractmethod
|
|
778
|
+
def AutoFitColumns(self):
|
|
779
|
+
"""
|
|
780
|
+
<summary>
|
|
781
|
+
Autofits all columns in the range.
|
|
782
|
+
<example>The following code illustrates how to auto-size column width to its cell content:
|
|
783
|
+
<code>
|
|
784
|
+
//Create worksheet
|
|
785
|
+
Workbook workbook = new Workbook();
|
|
786
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
787
|
+
//Auto-fit columns
|
|
788
|
+
worksheet.Range["B4"].Text = "Fit the content to column";
|
|
789
|
+
worksheet.Range["B4"].AutoFitColumns();
|
|
790
|
+
//Save to file
|
|
791
|
+
workbook.SaveToFile("AutoFitRows.xlsx");
|
|
792
|
+
</code>
|
|
793
|
+
</example>
|
|
794
|
+
</summary>
|
|
795
|
+
"""
|
|
796
|
+
pass
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
@abc.abstractmethod
|
|
801
|
+
def AddComment(self)->'ICommentShape':
|
|
802
|
+
"""
|
|
803
|
+
<summary>
|
|
804
|
+
Adds comment to the range.
|
|
805
|
+
<example>The following code illustrates how to insert Comments in the Range:
|
|
806
|
+
<code>
|
|
807
|
+
//Create worksheet
|
|
808
|
+
Workbook workbook = new Workbook();
|
|
809
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
810
|
+
//Adding comments to a cell
|
|
811
|
+
ICommentShape comment = worksheet.Range["A1"].AddComment();
|
|
812
|
+
comment.Text= "Comments";
|
|
813
|
+
//Save to file
|
|
814
|
+
workbook.SaveToFile("AddComment.xlsx");
|
|
815
|
+
</code>
|
|
816
|
+
</example>
|
|
817
|
+
</summary>
|
|
818
|
+
<returns>Range's comment.</returns>
|
|
819
|
+
"""
|
|
820
|
+
pass
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
@dispatch
|
|
824
|
+
@abc.abstractmethod
|
|
825
|
+
def BorderAround(self):
|
|
826
|
+
"""
|
|
827
|
+
<summary>
|
|
828
|
+
Sets around border for current range.
|
|
829
|
+
<example>The following code illustrates how to apply border around the Range:
|
|
830
|
+
<code>
|
|
831
|
+
//Create worksheet
|
|
832
|
+
Workbook workbook = new Workbook();
|
|
833
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
834
|
+
//Set text
|
|
835
|
+
worksheet["C2"].Text = "Sample";
|
|
836
|
+
worksheet["D2"].Text = "text";
|
|
837
|
+
worksheet["C3"].Text = "in";
|
|
838
|
+
worksheet["D3"].Text = "cell";
|
|
839
|
+
//Set border
|
|
840
|
+
worksheet["C2:D3"].BorderAround();
|
|
841
|
+
//Save to file
|
|
842
|
+
workbook.SaveToFile("BorderAround.xlsx");
|
|
843
|
+
</code>
|
|
844
|
+
</example>
|
|
845
|
+
</summary>
|
|
846
|
+
"""
|
|
847
|
+
pass
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
@dispatch
|
|
851
|
+
|
|
852
|
+
@abc.abstractmethod
|
|
853
|
+
def BorderAround(self ,borderLine:LineStyleType):
|
|
854
|
+
"""
|
|
855
|
+
<summary>
|
|
856
|
+
Sets around border for current range.
|
|
857
|
+
<example>The following code illustrates how to apply border around the Range:
|
|
858
|
+
<code>
|
|
859
|
+
//Create worksheet
|
|
860
|
+
Workbook workbook = new Workbook();
|
|
861
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
862
|
+
//Set text
|
|
863
|
+
worksheet["C2"].Text = "Sample";
|
|
864
|
+
worksheet["D2"].Text = "text";
|
|
865
|
+
worksheet["C3"].Text = "in";
|
|
866
|
+
worksheet["D3"].Text = "cell";
|
|
867
|
+
//Set border
|
|
868
|
+
worksheet["C2:D3"].BorderAround(LineStyleType.Thick);
|
|
869
|
+
//Save to file
|
|
870
|
+
workbook.SaveToFile("BorderAround.xlsx");
|
|
871
|
+
</code>
|
|
872
|
+
</example>
|
|
873
|
+
</summary>
|
|
874
|
+
<param name="borderLine">Represents border line.</param>
|
|
875
|
+
"""
|
|
876
|
+
pass
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
@dispatch
|
|
880
|
+
|
|
881
|
+
@abc.abstractmethod
|
|
882
|
+
def BorderAround(self ,borderLine:LineStyleType,borderColor:Color):
|
|
883
|
+
"""
|
|
884
|
+
<summary>
|
|
885
|
+
Sets around border for current range.
|
|
886
|
+
<example>The following code illustrates how to apply border around the Range with color from System.Drawing.Color structure:
|
|
887
|
+
<code>
|
|
888
|
+
//Create worksheet
|
|
889
|
+
Workbook workbook = new Workbook();
|
|
890
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
891
|
+
//Set text
|
|
892
|
+
worksheet["C2"].Text = "Sample";
|
|
893
|
+
worksheet["D2"].Text = "text";
|
|
894
|
+
worksheet["C3"].Text = "in";
|
|
895
|
+
worksheet["D3"].Text = "cell";
|
|
896
|
+
//Set border
|
|
897
|
+
worksheet["C2:D3"].BorderAround(LineStyleType.Thick , Color.Red);
|
|
898
|
+
//Save to file
|
|
899
|
+
workbook.SaveToFile("BorderAround.xlsx");
|
|
900
|
+
</code>
|
|
901
|
+
</example>
|
|
902
|
+
</summary>
|
|
903
|
+
<param name="borderLine">Represents border line.</param>
|
|
904
|
+
<param name="borderColor">Represents border color.</param>
|
|
905
|
+
"""
|
|
906
|
+
pass
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
@dispatch
|
|
910
|
+
|
|
911
|
+
@abc.abstractmethod
|
|
912
|
+
def BorderAround(self ,borderLine:LineStyleType,borderColor:ExcelColors):
|
|
913
|
+
"""
|
|
914
|
+
<summary>
|
|
915
|
+
Sets around border for current range.
|
|
916
|
+
<example>The following code illustrates how to apply border around the Range with color from Spire.Xls.ExcelColors structure:
|
|
917
|
+
<code>
|
|
918
|
+
//Create worksheet
|
|
919
|
+
Workbook workbook = new Workbook();
|
|
920
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
921
|
+
//Set text
|
|
922
|
+
worksheet["C2"].Text = "Sample";
|
|
923
|
+
worksheet["D2"].Text = "text";
|
|
924
|
+
worksheet["C3"].Text = "in";
|
|
925
|
+
worksheet["D3"].Text = "cell";
|
|
926
|
+
//Set border
|
|
927
|
+
worksheet["C2:D3"].BorderAround(LineStyleType.Thick , ExcelColors.Red);
|
|
928
|
+
//Save to file
|
|
929
|
+
workbook.SaveToFile("BorderAround.xlsx");
|
|
930
|
+
</code>
|
|
931
|
+
</example>
|
|
932
|
+
</summary>
|
|
933
|
+
<param name="borderLine">Represents border line.</param>
|
|
934
|
+
<param name="borderColor">Represents border color as ExcelColors.</param>
|
|
935
|
+
"""
|
|
936
|
+
pass
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
@dispatch
|
|
940
|
+
@abc.abstractmethod
|
|
941
|
+
def BorderInside(self):
|
|
942
|
+
"""
|
|
943
|
+
<summary>
|
|
944
|
+
Sets inside border for current range.
|
|
945
|
+
<example>The following code illustrates how to apply border inside the Range:
|
|
946
|
+
<code>
|
|
947
|
+
//Create worksheet
|
|
948
|
+
Workbook workbook = new Workbook();
|
|
949
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
950
|
+
//Set text
|
|
951
|
+
worksheet["C2"].Text = "Sample";
|
|
952
|
+
worksheet["D2"].Text = "text";
|
|
953
|
+
worksheet["C3"].Text = "in";
|
|
954
|
+
worksheet["D3"].Text = "cell";
|
|
955
|
+
//Set border
|
|
956
|
+
worksheet["C2:D3"].BorderInside();
|
|
957
|
+
//Save to file
|
|
958
|
+
workbook.SaveToFile("BorderInside.xlsx");
|
|
959
|
+
</code>
|
|
960
|
+
</example>
|
|
961
|
+
</summary>
|
|
962
|
+
"""
|
|
963
|
+
pass
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
@dispatch
|
|
967
|
+
|
|
968
|
+
@abc.abstractmethod
|
|
969
|
+
def BorderInside(self ,borderLine:LineStyleType):
|
|
970
|
+
"""
|
|
971
|
+
<summary>
|
|
972
|
+
Sets inside border for current range.
|
|
973
|
+
<example>The following code illustrates how to apply border inside the Range:
|
|
974
|
+
<code>
|
|
975
|
+
//Create worksheet
|
|
976
|
+
Workbook workbook = new Workbook();
|
|
977
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
978
|
+
//Set text
|
|
979
|
+
worksheet["C2"].Text = "Sample";
|
|
980
|
+
worksheet["D2"].Text = "text";
|
|
981
|
+
worksheet["C3"].Text = "in";
|
|
982
|
+
worksheet["D3"].Text = "cell";
|
|
983
|
+
//Set border
|
|
984
|
+
worksheet["C2:D3"].BorderInside(LineStyleType.Thick);
|
|
985
|
+
//Save to file
|
|
986
|
+
workbook.SaveToFile("BorderInside.xlsx");
|
|
987
|
+
</code>
|
|
988
|
+
</example>
|
|
989
|
+
</summary>
|
|
990
|
+
<param name="borderLine">Represents border line.</param>
|
|
991
|
+
"""
|
|
992
|
+
pass
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
@dispatch
|
|
996
|
+
|
|
997
|
+
@abc.abstractmethod
|
|
998
|
+
def BorderInside(self ,borderLine:LineStyleType,borderColor:Color):
|
|
999
|
+
"""
|
|
1000
|
+
<summary>
|
|
1001
|
+
Sets inside border for current range.
|
|
1002
|
+
<example>The following code illustrates how to apply border inside the Range with color from System.Drawing.Color structure:
|
|
1003
|
+
<code>
|
|
1004
|
+
//Create worksheet
|
|
1005
|
+
Workbook workbook = new Workbook();
|
|
1006
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1007
|
+
//Set text
|
|
1008
|
+
worksheet["C2"].Text = "Sample";
|
|
1009
|
+
worksheet["D2"].Text = "text";
|
|
1010
|
+
worksheet["C3"].Text = "in";
|
|
1011
|
+
worksheet["D3"].Text = "cell";
|
|
1012
|
+
//Set border
|
|
1013
|
+
worksheet["C2:D3"].BorderInside(LineStyleType.Thick , Color.Red);
|
|
1014
|
+
//Save to file
|
|
1015
|
+
workbook.SaveToFile("BorderInside.xlsx");
|
|
1016
|
+
</code>
|
|
1017
|
+
</example>
|
|
1018
|
+
</summary>
|
|
1019
|
+
<param name="borderLine">Represents border line.</param>
|
|
1020
|
+
<param name="borderColor">Represents border color.</param>
|
|
1021
|
+
"""
|
|
1022
|
+
pass
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
@dispatch
|
|
1026
|
+
|
|
1027
|
+
@abc.abstractmethod
|
|
1028
|
+
def BorderInside(self ,borderLine:LineStyleType,borderColor:ExcelColors):
|
|
1029
|
+
"""
|
|
1030
|
+
<summary>
|
|
1031
|
+
Sets inside border for current range.
|
|
1032
|
+
<example>The following code illustrates how to apply border inside the Range with color from Spire.Xls.ExcelColors structure:
|
|
1033
|
+
<code>
|
|
1034
|
+
//Create worksheet
|
|
1035
|
+
Workbook workbook = new Workbook();
|
|
1036
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1037
|
+
//Set text
|
|
1038
|
+
worksheet["C2"].Text = "Sample";
|
|
1039
|
+
worksheet["D2"].Text = "text";
|
|
1040
|
+
worksheet["C3"].Text = "in";
|
|
1041
|
+
worksheet["D3"].Text = "cell";
|
|
1042
|
+
//Set border
|
|
1043
|
+
worksheet["C2:D3"].BorderInside(LineStyleType.Thick , ExcelColors.Red);
|
|
1044
|
+
//Save to file
|
|
1045
|
+
workbook.SaveToFile("BorderInside.xlsx");
|
|
1046
|
+
</code>
|
|
1047
|
+
</example>
|
|
1048
|
+
</summary>
|
|
1049
|
+
<param name="borderLine">Represents border line.</param>
|
|
1050
|
+
<param name="borderColor">Represents border color as ExcelColors.</param>
|
|
1051
|
+
"""
|
|
1052
|
+
pass
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
@abc.abstractmethod
|
|
1056
|
+
def BorderNone(self):
|
|
1057
|
+
"""
|
|
1058
|
+
<summary>
|
|
1059
|
+
Sets none border for current range.
|
|
1060
|
+
<example>The following code illustrates how to remove borders in the Range:
|
|
1061
|
+
<code>
|
|
1062
|
+
//Create worksheet
|
|
1063
|
+
Workbook workbook = new Workbook();
|
|
1064
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1065
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1066
|
+
//Remove borders
|
|
1067
|
+
worksheet["C2"].BorderNone();
|
|
1068
|
+
//Save to file
|
|
1069
|
+
workbook.SaveToFile("BorderNone.xlsx");
|
|
1070
|
+
</code>
|
|
1071
|
+
</example>
|
|
1072
|
+
</summary>
|
|
1073
|
+
"""
|
|
1074
|
+
pass
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
@abc.abstractmethod
|
|
1079
|
+
def CollapseGroup(self ,groupBy:'GroupByType'):
|
|
1080
|
+
"""
|
|
1081
|
+
<summary>
|
|
1082
|
+
Collapses current group.
|
|
1083
|
+
<example>The following code illustrates how to remove borders in the Range:
|
|
1084
|
+
<code>
|
|
1085
|
+
//Create worksheet
|
|
1086
|
+
Workbook workbook = new Workbook();
|
|
1087
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1088
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1089
|
+
//Collapse group
|
|
1090
|
+
worksheet.Range["A5:A15"].CollapseGroup(GroupByType.ByRows);
|
|
1091
|
+
//Save to file
|
|
1092
|
+
workbook.SaveToFile("CollapseGroup.xlsx");
|
|
1093
|
+
</code>
|
|
1094
|
+
</example>
|
|
1095
|
+
</summary>
|
|
1096
|
+
<param name="groupBy">
|
|
1097
|
+
This parameter specifies whether the grouping should be performed by rows or by columns.
|
|
1098
|
+
</param>
|
|
1099
|
+
"""
|
|
1100
|
+
pass
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
@dispatch
|
|
1104
|
+
|
|
1105
|
+
@abc.abstractmethod
|
|
1106
|
+
def ExpandGroup(self ,groupBy:GroupByType):
|
|
1107
|
+
"""
|
|
1108
|
+
<summary>
|
|
1109
|
+
Expands current group.
|
|
1110
|
+
<example>The following code illustrates how to expand the group in the Range:
|
|
1111
|
+
<code>
|
|
1112
|
+
//Create worksheet
|
|
1113
|
+
Workbook workbook = new Workbook();
|
|
1114
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1115
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1116
|
+
//Expand group with flag set to expand parent
|
|
1117
|
+
worksheet.Range["A5:A15"].ExpandGroup(GroupByType.ByRows);
|
|
1118
|
+
//Save to file
|
|
1119
|
+
workbook.SaveToFile("ExpandGroup.xlsx");
|
|
1120
|
+
</code>
|
|
1121
|
+
</example>
|
|
1122
|
+
</summary>
|
|
1123
|
+
<param name="groupBy">
|
|
1124
|
+
This parameter specifies whether the grouping should be performed by rows or by columns.
|
|
1125
|
+
</param>
|
|
1126
|
+
"""
|
|
1127
|
+
pass
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
@dispatch
|
|
1131
|
+
|
|
1132
|
+
@abc.abstractmethod
|
|
1133
|
+
def ExpandGroup(self ,groupBy:GroupByType,flags:ExpandCollapseFlags):
|
|
1134
|
+
"""
|
|
1135
|
+
<summary>
|
|
1136
|
+
Expands current group.
|
|
1137
|
+
<example>The following code illustrates how to perform ExpandGroup in the Range with collapse option:
|
|
1138
|
+
<code>
|
|
1139
|
+
//Create worksheet
|
|
1140
|
+
Workbook workbook = new Workbook();
|
|
1141
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
1142
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1143
|
+
//Expand group with flag set to expand parent
|
|
1144
|
+
worksheet.Range["A5:A15"].ExpandGroup(GroupByType.ByRows, ExpandCollapseFlags.ExpandParent);
|
|
1145
|
+
//Save to file
|
|
1146
|
+
workbook.SaveToFile("ExpandGroup.xlsx");
|
|
1147
|
+
</code>
|
|
1148
|
+
</example>
|
|
1149
|
+
</summary>
|
|
1150
|
+
<param name="groupBy">
|
|
1151
|
+
This parameter specifies whether the grouping should be performed by rows or by columns.
|
|
1152
|
+
</param>
|
|
1153
|
+
<param name="flags">Additional option flags.</param>
|
|
1154
|
+
"""
|
|
1155
|
+
pass
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
#
|
|
1159
|
+
# @abc.abstractmethod
|
|
1160
|
+
# def ExportDataTable(self ,options:'ExportTableOptions')->'DataTable':
|
|
1161
|
+
# """
|
|
1162
|
+
#
|
|
1163
|
+
# """
|
|
1164
|
+
# pass
|
|
1165
|
+
#
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
@property
|
|
1169
|
+
|
|
1170
|
+
@abc.abstractmethod
|
|
1171
|
+
def RangeAddress(self)->str:
|
|
1172
|
+
"""
|
|
1173
|
+
<summary>
|
|
1174
|
+
Returns the range reference in the language of the macro.
|
|
1175
|
+
Read-only String.
|
|
1176
|
+
<example>The following code illustrates how to access Address property of the Range:
|
|
1177
|
+
<code>
|
|
1178
|
+
//Create worksheet
|
|
1179
|
+
Workbook workbook = new Workbook();
|
|
1180
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1181
|
+
//Get RangeAddress
|
|
1182
|
+
string address = worksheet.Range[3, 4].RangeAddress;
|
|
1183
|
+
</code>
|
|
1184
|
+
</example>
|
|
1185
|
+
</summary>
|
|
1186
|
+
"""
|
|
1187
|
+
pass
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
@property
|
|
1191
|
+
|
|
1192
|
+
@abc.abstractmethod
|
|
1193
|
+
def RangeAddressLocal(self)->str:
|
|
1194
|
+
"""
|
|
1195
|
+
<summary>
|
|
1196
|
+
Returns the range reference for the specified range in the language
|
|
1197
|
+
of the user. Read-only String.
|
|
1198
|
+
<example>The following code illustrates how to access AddressLocal property of the Range:
|
|
1199
|
+
<code>
|
|
1200
|
+
//Create worksheet
|
|
1201
|
+
Workbook workbook = new Workbook();
|
|
1202
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1203
|
+
//Get RangeAddressLocal
|
|
1204
|
+
string address = worksheet.Range[3, 4].RangeAddressLocal;
|
|
1205
|
+
</code>
|
|
1206
|
+
</example>
|
|
1207
|
+
</summary>
|
|
1208
|
+
"""
|
|
1209
|
+
pass
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
@property
|
|
1213
|
+
|
|
1214
|
+
@abc.abstractmethod
|
|
1215
|
+
def RangeGlobalAddress(self)->str:
|
|
1216
|
+
"""
|
|
1217
|
+
<summary>
|
|
1218
|
+
Returns range Address in format "'Sheet1'!$A$1".
|
|
1219
|
+
<example>The following code illustrates how to access AddressGlobal property of the Range:
|
|
1220
|
+
<code>
|
|
1221
|
+
//Create worksheet
|
|
1222
|
+
Workbook workbook = new Workbook();
|
|
1223
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1224
|
+
//Get RangeAddress
|
|
1225
|
+
string address = worksheet.Range[3, 4].RangeGlobalAddress;
|
|
1226
|
+
</code>
|
|
1227
|
+
</example>
|
|
1228
|
+
</summary>
|
|
1229
|
+
"""
|
|
1230
|
+
pass
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
@property
|
|
1234
|
+
|
|
1235
|
+
@abc.abstractmethod
|
|
1236
|
+
def RangeR1C1Address(self)->str:
|
|
1237
|
+
"""
|
|
1238
|
+
<summary>
|
|
1239
|
+
Returns the range reference using R1C1 notation.
|
|
1240
|
+
Read-only String.
|
|
1241
|
+
<example>The following code illustrates how to access AddressR1C1 property of the Range:
|
|
1242
|
+
<code>
|
|
1243
|
+
//Create worksheet
|
|
1244
|
+
Workbook workbook = new Workbook();
|
|
1245
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1246
|
+
//Get RangeR1C1Address
|
|
1247
|
+
string address = worksheet.Range[3, 4].RangeR1C1Address;
|
|
1248
|
+
</code>
|
|
1249
|
+
</example>
|
|
1250
|
+
</summary>
|
|
1251
|
+
"""
|
|
1252
|
+
pass
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
@property
|
|
1256
|
+
|
|
1257
|
+
@abc.abstractmethod
|
|
1258
|
+
def RangeR1C1AddressLocal(self)->str:
|
|
1259
|
+
"""
|
|
1260
|
+
<summary>
|
|
1261
|
+
Returns the range reference using R1C1 notation.
|
|
1262
|
+
Read-only String.
|
|
1263
|
+
<example>The following code illustrates how to access AddressR1C1Local property of the Range:
|
|
1264
|
+
<code>
|
|
1265
|
+
//Create worksheet
|
|
1266
|
+
Workbook workbook = new Workbook();
|
|
1267
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1268
|
+
//Get RangeR1C1AddressLocal
|
|
1269
|
+
string address = worksheet.Range[3, 4].RangeR1C1Address;
|
|
1270
|
+
</code>
|
|
1271
|
+
</example>
|
|
1272
|
+
</summary>
|
|
1273
|
+
"""
|
|
1274
|
+
pass
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
@property
|
|
1278
|
+
@abc.abstractmethod
|
|
1279
|
+
def BooleanValue(self)->bool:
|
|
1280
|
+
"""
|
|
1281
|
+
<summary>
|
|
1282
|
+
Gets / sets boolean value that is contained by this range.
|
|
1283
|
+
<example>The following code illustrates how to access Boolean property of the Range:
|
|
1284
|
+
<code>
|
|
1285
|
+
//Create worksheet
|
|
1286
|
+
Workbook workbook = new Workbook();
|
|
1287
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1288
|
+
//Set and get BooleanValue
|
|
1289
|
+
worksheet.Range[2, 4].BooleanValue = true;
|
|
1290
|
+
bool boolean = worksheet.Range[2, 4].BooleanValue;
|
|
1291
|
+
</code>
|
|
1292
|
+
</example>
|
|
1293
|
+
</summary>
|
|
1294
|
+
"""
|
|
1295
|
+
pass
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
@BooleanValue.setter
|
|
1299
|
+
@abc.abstractmethod
|
|
1300
|
+
def BooleanValue(self, value:bool):
|
|
1301
|
+
"""
|
|
1302
|
+
|
|
1303
|
+
"""
|
|
1304
|
+
pass
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
@property
|
|
1308
|
+
|
|
1309
|
+
@abc.abstractmethod
|
|
1310
|
+
def Borders(self)->'IBorders':
|
|
1311
|
+
"""
|
|
1312
|
+
<summary>
|
|
1313
|
+
Returns a Borders collection that represents the borders of a style
|
|
1314
|
+
or a range of cells (including a range defined as part of a
|
|
1315
|
+
conditional format).
|
|
1316
|
+
<example>The following code illustrates how to access Borders property of the Range:
|
|
1317
|
+
<code>
|
|
1318
|
+
//Create worksheet
|
|
1319
|
+
Workbook workbook = new Workbook();
|
|
1320
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1321
|
+
//Set text
|
|
1322
|
+
worksheet["C2"].Text = "Sample";
|
|
1323
|
+
//Set borders
|
|
1324
|
+
IBorders borders = worksheet["C2"].Borders;
|
|
1325
|
+
//Set line style
|
|
1326
|
+
borders[BordersLineType.EdgeTop].LineStyle = LineStyleType.Thin;
|
|
1327
|
+
borders[BordersLineType.EdgeBottom].LineStyle = LineStyleType.Thin;
|
|
1328
|
+
//Set border color
|
|
1329
|
+
borders[BordersLineType.EdgeTop].Color = Color.Red;
|
|
1330
|
+
borders[BordersLineType.EdgeBottom].Color = Color.Red;
|
|
1331
|
+
//Save to file
|
|
1332
|
+
workbook.SaveToFile("CellFormats.xlsx");
|
|
1333
|
+
</code>
|
|
1334
|
+
</example>
|
|
1335
|
+
</summary>
|
|
1336
|
+
"""
|
|
1337
|
+
pass
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
# @property
|
|
1341
|
+
#
|
|
1342
|
+
# @abc.abstractmethod
|
|
1343
|
+
# def Cells(self)->'ListCellRanges':
|
|
1344
|
+
# """
|
|
1345
|
+
# <summary>
|
|
1346
|
+
# Returns a Range object that represents the cells in the specified range.
|
|
1347
|
+
# Read-only.
|
|
1348
|
+
# </summary>
|
|
1349
|
+
# """
|
|
1350
|
+
# pass
|
|
1351
|
+
#
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
# @property
|
|
1355
|
+
#
|
|
1356
|
+
# @abc.abstractmethod
|
|
1357
|
+
# def CellList(self)->'List1':
|
|
1358
|
+
# """
|
|
1359
|
+
# <summary>
|
|
1360
|
+
# Returns a Range object that represents the cells in the specified range.
|
|
1361
|
+
# Read-only.
|
|
1362
|
+
# <example>The following code illustrates how to access CellList property of the Range:
|
|
1363
|
+
# <code>
|
|
1364
|
+
# //Create worksheet
|
|
1365
|
+
# Workbook workbook = new Workbook();
|
|
1366
|
+
# Worksheet worksheet = workbook.Worksheets[0];
|
|
1367
|
+
# //Set text. The content contained by ![CDATA] will be expressed as plain text
|
|
1368
|
+
# ListCellRange cells = worksheet["A1:E8"].CellList;
|
|
1369
|
+
# //Do some manipulations
|
|
1370
|
+
# foreach (CellRange Range in cells)
|
|
1371
|
+
# Range.Text = Range.RangeAddressLocal;
|
|
1372
|
+
# //Save to file
|
|
1373
|
+
# workbook.SaveToFile("CellList.xlsx");
|
|
1374
|
+
# </code>
|
|
1375
|
+
# </example>
|
|
1376
|
+
# </summary>
|
|
1377
|
+
# """
|
|
1378
|
+
# pass
|
|
1379
|
+
#
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
@property
|
|
1383
|
+
@abc.abstractmethod
|
|
1384
|
+
def Column(self)->int:
|
|
1385
|
+
"""
|
|
1386
|
+
<summary>
|
|
1387
|
+
Returns the number of the first column in the first area in the specified
|
|
1388
|
+
range. Read-only.
|
|
1389
|
+
<example>The following code illustrates how to access Column property of the Range:
|
|
1390
|
+
<code>
|
|
1391
|
+
//Create worksheet
|
|
1392
|
+
Workbook workbook = new Workbook();
|
|
1393
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1394
|
+
//Get specific column
|
|
1395
|
+
int firstColumn = worksheet["E1:R3"].Column;
|
|
1396
|
+
</code>
|
|
1397
|
+
</example>
|
|
1398
|
+
</summary>
|
|
1399
|
+
"""
|
|
1400
|
+
pass
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
@property
|
|
1404
|
+
@abc.abstractmethod
|
|
1405
|
+
def ColumnGroupLevel(self)->int:
|
|
1406
|
+
"""
|
|
1407
|
+
<summary>
|
|
1408
|
+
Column group level. Read-only.
|
|
1409
|
+
-1 - Not all columns in the range have same group level.
|
|
1410
|
+
0 - No grouping,
|
|
1411
|
+
1 - 7 - Group level.
|
|
1412
|
+
</summary>
|
|
1413
|
+
"""
|
|
1414
|
+
pass
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
@property
|
|
1418
|
+
@abc.abstractmethod
|
|
1419
|
+
def ColumnWidth(self)->float:
|
|
1420
|
+
"""
|
|
1421
|
+
<summary>
|
|
1422
|
+
Returns or sets the width of all columns in the specified range.
|
|
1423
|
+
Read/write Double.
|
|
1424
|
+
<example>The following code illustrates how to set the width of all columns in the specified range:
|
|
1425
|
+
<code>
|
|
1426
|
+
//Create worksheet
|
|
1427
|
+
Workbook workbook = new Workbook();
|
|
1428
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1429
|
+
//Set the ColumnWidth
|
|
1430
|
+
worksheet["A1"].Text = "This cell contains sample text";
|
|
1431
|
+
worksheet["A1"].ColumnWidth = 25;
|
|
1432
|
+
//Save to file
|
|
1433
|
+
workbook.SaveToFile("ColumnWidth.xlsx");
|
|
1434
|
+
</code>
|
|
1435
|
+
</example>
|
|
1436
|
+
</summary>
|
|
1437
|
+
"""
|
|
1438
|
+
pass
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
@ColumnWidth.setter
|
|
1442
|
+
@abc.abstractmethod
|
|
1443
|
+
def ColumnWidth(self, value:float):
|
|
1444
|
+
"""
|
|
1445
|
+
|
|
1446
|
+
"""
|
|
1447
|
+
pass
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
@property
|
|
1451
|
+
@abc.abstractmethod
|
|
1452
|
+
def Count(self)->int:
|
|
1453
|
+
"""
|
|
1454
|
+
<summary>
|
|
1455
|
+
Returns the number of objects in the collection. Read-only.
|
|
1456
|
+
</summary>
|
|
1457
|
+
"""
|
|
1458
|
+
pass
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
@property
|
|
1462
|
+
|
|
1463
|
+
@abc.abstractmethod
|
|
1464
|
+
def DateTimeValue(self)->'DateTime':
|
|
1465
|
+
"""
|
|
1466
|
+
<summary>
|
|
1467
|
+
Gets / sets DateTime contained by this cell. Read-write DateTime.
|
|
1468
|
+
<example>The following code illustrates how to set and access DateTimeValue property of the Range:
|
|
1469
|
+
<code>
|
|
1470
|
+
//Create worksheet
|
|
1471
|
+
Workbook workbook = new Workbook();
|
|
1472
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1473
|
+
//Set and get the DateTimeValue of specified range
|
|
1474
|
+
worksheet.Range[2, 4].DateTimeValue = DateTime.Now;
|
|
1475
|
+
DateTime dateTime = worksheet.Range[2, 4].DateTimeValue;
|
|
1476
|
+
//Save to file
|
|
1477
|
+
workbook.SaveToFile("DateTimeValue.xlsx");
|
|
1478
|
+
</code>
|
|
1479
|
+
</example>
|
|
1480
|
+
</summary>
|
|
1481
|
+
"""
|
|
1482
|
+
pass
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
@DateTimeValue.setter
|
|
1486
|
+
@abc.abstractmethod
|
|
1487
|
+
def DateTimeValue(self, value:'DateTime'):
|
|
1488
|
+
"""
|
|
1489
|
+
|
|
1490
|
+
"""
|
|
1491
|
+
pass
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
@property
|
|
1495
|
+
|
|
1496
|
+
@abc.abstractmethod
|
|
1497
|
+
def NumberText(self)->str:
|
|
1498
|
+
"""
|
|
1499
|
+
<summary>
|
|
1500
|
+
Returns cell value after number format application. Read-only.
|
|
1501
|
+
<example>The following code illustrates how to access NumberText property of the Range:
|
|
1502
|
+
<code>
|
|
1503
|
+
//Create worksheet
|
|
1504
|
+
Workbook workbook = new Workbook();
|
|
1505
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1506
|
+
//Gets cell value with its number format
|
|
1507
|
+
CellRange range= worksheet.Range[3, 1];
|
|
1508
|
+
range.Value = "1/1/2015";
|
|
1509
|
+
range.NumberFormat = "dd-MMM-yyyy";
|
|
1510
|
+
string numberText = range.NumberText;
|
|
1511
|
+
//Save to file
|
|
1512
|
+
workbook.SaveToFile("NumberText.xlsx");
|
|
1513
|
+
</code>
|
|
1514
|
+
</example>
|
|
1515
|
+
</summary>
|
|
1516
|
+
"""
|
|
1517
|
+
pass
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
@property
|
|
1521
|
+
|
|
1522
|
+
@abc.abstractmethod
|
|
1523
|
+
def EndCell(self)->'IXLSRange':
|
|
1524
|
+
"""
|
|
1525
|
+
<summary>
|
|
1526
|
+
Returns a Range object that represents the cell at the end of the
|
|
1527
|
+
region that contains the source range.
|
|
1528
|
+
</summary>
|
|
1529
|
+
"""
|
|
1530
|
+
pass
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
@property
|
|
1534
|
+
|
|
1535
|
+
@abc.abstractmethod
|
|
1536
|
+
def EntireColumn(self)->'IXLSRange':
|
|
1537
|
+
"""
|
|
1538
|
+
<summary>
|
|
1539
|
+
Returns a Range object that represents the entire column (or
|
|
1540
|
+
columns) that contains the specified range. Read-only.
|
|
1541
|
+
</summary>
|
|
1542
|
+
"""
|
|
1543
|
+
pass
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
@property
|
|
1547
|
+
|
|
1548
|
+
@abc.abstractmethod
|
|
1549
|
+
def EntireRow(self)->'IXLSRange':
|
|
1550
|
+
"""
|
|
1551
|
+
<summary>
|
|
1552
|
+
Returns a Range object that represents the entire row (or
|
|
1553
|
+
rows) that contains the specified range. Read-only.
|
|
1554
|
+
</summary>
|
|
1555
|
+
"""
|
|
1556
|
+
pass
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
@property
|
|
1560
|
+
|
|
1561
|
+
@abc.abstractmethod
|
|
1562
|
+
def ErrorValue(self)->str:
|
|
1563
|
+
"""
|
|
1564
|
+
<summary>
|
|
1565
|
+
Gets / sets error value that is contained by this range.
|
|
1566
|
+
</summary>
|
|
1567
|
+
"""
|
|
1568
|
+
pass
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
@ErrorValue.setter
|
|
1572
|
+
@abc.abstractmethod
|
|
1573
|
+
def ErrorValue(self, value:str):
|
|
1574
|
+
"""
|
|
1575
|
+
|
|
1576
|
+
"""
|
|
1577
|
+
pass
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
@property
|
|
1581
|
+
|
|
1582
|
+
@abc.abstractmethod
|
|
1583
|
+
def Formula(self)->str:
|
|
1584
|
+
"""
|
|
1585
|
+
<summary>
|
|
1586
|
+
Returns or sets the object's formula in A1-style notation and in
|
|
1587
|
+
the language of the macro. Read/write Variant.
|
|
1588
|
+
</summary>
|
|
1589
|
+
"""
|
|
1590
|
+
pass
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
@Formula.setter
|
|
1594
|
+
@abc.abstractmethod
|
|
1595
|
+
def Formula(self, value:str):
|
|
1596
|
+
"""
|
|
1597
|
+
|
|
1598
|
+
"""
|
|
1599
|
+
pass
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
@property
|
|
1603
|
+
|
|
1604
|
+
@abc.abstractmethod
|
|
1605
|
+
def FormulaArray(self)->str:
|
|
1606
|
+
"""
|
|
1607
|
+
<summary>
|
|
1608
|
+
Represents array-entered formula.
|
|
1609
|
+
Visit http://www.cpearson.com/excel/array.htm for more information.
|
|
1610
|
+
<example>The following code illustrates how to set and access FormulaArray property of the range:
|
|
1611
|
+
<code>
|
|
1612
|
+
//Create worksheet
|
|
1613
|
+
Workbook workbook = new Workbook();
|
|
1614
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1615
|
+
//Assign array formula
|
|
1616
|
+
worksheet.Range["A1:D1"].FormulaArray = "{1,2,3,4}";
|
|
1617
|
+
//Adding a named range for the range A1 to D1
|
|
1618
|
+
worksheet.Names.Add("ArrayRange", worksheet.Range["A1:D1"]);
|
|
1619
|
+
//Assign formula array with named range
|
|
1620
|
+
worksheet.Range["A2:D2"].FormulaArray = "ArrayRange+100";
|
|
1621
|
+
//Save to file
|
|
1622
|
+
workbook.SaveToFile("FormulaArray.xlsx");
|
|
1623
|
+
</code>
|
|
1624
|
+
</example>
|
|
1625
|
+
</summary>
|
|
1626
|
+
"""
|
|
1627
|
+
pass
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
@FormulaArray.setter
|
|
1631
|
+
@abc.abstractmethod
|
|
1632
|
+
def FormulaArray(self, value:str):
|
|
1633
|
+
"""
|
|
1634
|
+
|
|
1635
|
+
"""
|
|
1636
|
+
pass
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
@property
|
|
1640
|
+
|
|
1641
|
+
@abc.abstractmethod
|
|
1642
|
+
def FormulaArrayR1C1(self)->str:
|
|
1643
|
+
"""
|
|
1644
|
+
<summary>
|
|
1645
|
+
Returns or sets the formula array for the range, using R1C1-style notation.
|
|
1646
|
+
</summary>
|
|
1647
|
+
"""
|
|
1648
|
+
pass
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
@FormulaArrayR1C1.setter
|
|
1652
|
+
@abc.abstractmethod
|
|
1653
|
+
def FormulaArrayR1C1(self, value:str):
|
|
1654
|
+
"""
|
|
1655
|
+
|
|
1656
|
+
"""
|
|
1657
|
+
pass
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
@property
|
|
1661
|
+
@abc.abstractmethod
|
|
1662
|
+
def IsFormulaHidden(self)->bool:
|
|
1663
|
+
"""
|
|
1664
|
+
<summary>
|
|
1665
|
+
True if the formula will be hidden when the worksheet is protected.
|
|
1666
|
+
False if at least part of formula in the range is not hidden.
|
|
1667
|
+
</summary>
|
|
1668
|
+
"""
|
|
1669
|
+
pass
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
@IsFormulaHidden.setter
|
|
1673
|
+
@abc.abstractmethod
|
|
1674
|
+
def IsFormulaHidden(self, value:bool):
|
|
1675
|
+
"""
|
|
1676
|
+
|
|
1677
|
+
"""
|
|
1678
|
+
pass
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
@property
|
|
1682
|
+
|
|
1683
|
+
@abc.abstractmethod
|
|
1684
|
+
def FormulaDateTime(self)->'DateTime':
|
|
1685
|
+
"""
|
|
1686
|
+
<summary>
|
|
1687
|
+
Get / set formula DateTime value contained by this cell.
|
|
1688
|
+
DateTime.MinValue if not all cells of the range have same DateTime value.
|
|
1689
|
+
</summary>
|
|
1690
|
+
"""
|
|
1691
|
+
pass
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
@FormulaDateTime.setter
|
|
1695
|
+
@abc.abstractmethod
|
|
1696
|
+
def FormulaDateTime(self, value:'DateTime'):
|
|
1697
|
+
"""
|
|
1698
|
+
|
|
1699
|
+
"""
|
|
1700
|
+
pass
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
@property
|
|
1704
|
+
|
|
1705
|
+
@abc.abstractmethod
|
|
1706
|
+
def FormulaR1C1(self)->str:
|
|
1707
|
+
"""
|
|
1708
|
+
<summary>
|
|
1709
|
+
Returns or sets the formula for the range, using R1C1-style notation.
|
|
1710
|
+
</summary>
|
|
1711
|
+
"""
|
|
1712
|
+
pass
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
@FormulaR1C1.setter
|
|
1716
|
+
@abc.abstractmethod
|
|
1717
|
+
def FormulaR1C1(self, value:str):
|
|
1718
|
+
"""
|
|
1719
|
+
|
|
1720
|
+
"""
|
|
1721
|
+
pass
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
@property
|
|
1725
|
+
@abc.abstractmethod
|
|
1726
|
+
def FormulaBoolValue(self)->bool:
|
|
1727
|
+
"""
|
|
1728
|
+
<summary>
|
|
1729
|
+
Returns the calculated value of the formula as a boolean.
|
|
1730
|
+
</summary>
|
|
1731
|
+
"""
|
|
1732
|
+
pass
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
@FormulaBoolValue.setter
|
|
1736
|
+
@abc.abstractmethod
|
|
1737
|
+
def FormulaBoolValue(self, value:bool):
|
|
1738
|
+
"""
|
|
1739
|
+
|
|
1740
|
+
"""
|
|
1741
|
+
pass
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
@property
|
|
1745
|
+
|
|
1746
|
+
@abc.abstractmethod
|
|
1747
|
+
def FormulaErrorValue(self)->str:
|
|
1748
|
+
"""
|
|
1749
|
+
<summary>
|
|
1750
|
+
Returns the calculated value of the formula as a string.
|
|
1751
|
+
</summary>
|
|
1752
|
+
"""
|
|
1753
|
+
pass
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
@FormulaErrorValue.setter
|
|
1757
|
+
@abc.abstractmethod
|
|
1758
|
+
def FormulaErrorValue(self, value:str):
|
|
1759
|
+
"""
|
|
1760
|
+
|
|
1761
|
+
"""
|
|
1762
|
+
pass
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
@property
|
|
1766
|
+
@abc.abstractmethod
|
|
1767
|
+
def HasDataValidation(self)->bool:
|
|
1768
|
+
"""
|
|
1769
|
+
<summary>
|
|
1770
|
+
Indicates whether specified range object has data validation.
|
|
1771
|
+
If Range is not single cell, then returns true only if all cells have data validation. Read-only.
|
|
1772
|
+
</summary>
|
|
1773
|
+
"""
|
|
1774
|
+
pass
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
@property
|
|
1778
|
+
@abc.abstractmethod
|
|
1779
|
+
def HasBoolean(self)->bool:
|
|
1780
|
+
"""
|
|
1781
|
+
<summary>
|
|
1782
|
+
Indicates whether range contains bool value. Read-only.
|
|
1783
|
+
<example>The following code illustrates how to set and access HasBoolean property of the Range:
|
|
1784
|
+
<code>
|
|
1785
|
+
//Create worksheet
|
|
1786
|
+
Workbook workbook = new Workbook();
|
|
1787
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1788
|
+
//Assigning Value2 property of the Range
|
|
1789
|
+
worksheet["A3"].Value2 = false;
|
|
1790
|
+
//Checking Range types
|
|
1791
|
+
bool isboolean = worksheet["A3"].HasBoolean;
|
|
1792
|
+
//Save to file
|
|
1793
|
+
workbook.SaveToFile("HasBoolean.xlsx");
|
|
1794
|
+
</code>
|
|
1795
|
+
</example>
|
|
1796
|
+
</summary>
|
|
1797
|
+
"""
|
|
1798
|
+
pass
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
@property
|
|
1802
|
+
@abc.abstractmethod
|
|
1803
|
+
def HasDateTime(self)->bool:
|
|
1804
|
+
"""
|
|
1805
|
+
<summary>
|
|
1806
|
+
Indicates whether range contains DateTime value. Read-only.
|
|
1807
|
+
<example>The following code illustrates how to set and access HasDateTime property of the Range:
|
|
1808
|
+
<code>
|
|
1809
|
+
//Create worksheet
|
|
1810
|
+
Workbook workbook = new Workbook();
|
|
1811
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1812
|
+
//Assigning Value2 property of the Range
|
|
1813
|
+
worksheet["A1"].Value2 = DateTime.Now;
|
|
1814
|
+
//Checking Range types
|
|
1815
|
+
bool isDateTime = worksheet["A1"].HasDateTime;
|
|
1816
|
+
//Save to file
|
|
1817
|
+
workbook.SaveToFile("HasDateTime.xlsx");
|
|
1818
|
+
</code>
|
|
1819
|
+
</example>
|
|
1820
|
+
</summary>
|
|
1821
|
+
"""
|
|
1822
|
+
pass
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
@property
|
|
1826
|
+
@abc.abstractmethod
|
|
1827
|
+
def HasFormula(self)->bool:
|
|
1828
|
+
"""
|
|
1829
|
+
<summary>
|
|
1830
|
+
True if all cells in the range contain formulas; False if
|
|
1831
|
+
at least one of the cells in the range doesn't contain a formula.
|
|
1832
|
+
Read-only Boolean.
|
|
1833
|
+
</summary>
|
|
1834
|
+
"""
|
|
1835
|
+
pass
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
@property
|
|
1839
|
+
@abc.abstractmethod
|
|
1840
|
+
def HasFormulaArray(self)->bool:
|
|
1841
|
+
"""
|
|
1842
|
+
<summary>
|
|
1843
|
+
Indicates whether range contains array-entered formula. Read-only.
|
|
1844
|
+
</summary>
|
|
1845
|
+
"""
|
|
1846
|
+
pass
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
@property
|
|
1850
|
+
@abc.abstractmethod
|
|
1851
|
+
def HasFormulaDateTime(self)->bool:
|
|
1852
|
+
"""
|
|
1853
|
+
<summary>
|
|
1854
|
+
Indicates if current range has formula value formatted as DateTime. Read-only.
|
|
1855
|
+
</summary>
|
|
1856
|
+
"""
|
|
1857
|
+
pass
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
@property
|
|
1861
|
+
@abc.abstractmethod
|
|
1862
|
+
def HasFormulaNumberValue(self)->bool:
|
|
1863
|
+
"""
|
|
1864
|
+
<summary>
|
|
1865
|
+
Indicates if the current range has formula number value. Read-only.
|
|
1866
|
+
</summary>
|
|
1867
|
+
"""
|
|
1868
|
+
pass
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
@property
|
|
1872
|
+
@abc.abstractmethod
|
|
1873
|
+
def HasFormulaStringValue(self)->bool:
|
|
1874
|
+
"""
|
|
1875
|
+
<summary>
|
|
1876
|
+
Indicates if the current range has formula string value. Read-only.
|
|
1877
|
+
</summary>
|
|
1878
|
+
"""
|
|
1879
|
+
pass
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
@property
|
|
1883
|
+
@abc.abstractmethod
|
|
1884
|
+
def HasNumber(self)->bool:
|
|
1885
|
+
"""
|
|
1886
|
+
<summary>
|
|
1887
|
+
Indicates whether the range contains number. Read-only.
|
|
1888
|
+
<example>The following code illustrates how to set and access Value2 property of the Range:
|
|
1889
|
+
<code>
|
|
1890
|
+
//Create worksheet
|
|
1891
|
+
Workbook workbook = new Workbook();
|
|
1892
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1893
|
+
//Assigning Value2 property of the Range
|
|
1894
|
+
worksheet["A2"].Value2 = 45;
|
|
1895
|
+
//Checking Range types
|
|
1896
|
+
bool isNumber = worksheet["A2"].HasNumber;
|
|
1897
|
+
//Save to file
|
|
1898
|
+
workbook.SaveToFile("HasNumber.xlsx");
|
|
1899
|
+
</code>
|
|
1900
|
+
</example>
|
|
1901
|
+
</summary>
|
|
1902
|
+
"""
|
|
1903
|
+
pass
|
|
1904
|
+
|
|
1905
|
+
|
|
1906
|
+
@property
|
|
1907
|
+
@abc.abstractmethod
|
|
1908
|
+
def HasRichText(self)->bool:
|
|
1909
|
+
"""
|
|
1910
|
+
<summary>
|
|
1911
|
+
Indicates whether cell contains formatted rich text string.
|
|
1912
|
+
<example>The following code illustrates how to access HasRichText property:
|
|
1913
|
+
<code>
|
|
1914
|
+
//Create worksheet
|
|
1915
|
+
Workbook workbook = new Workbook();
|
|
1916
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1917
|
+
//Create style
|
|
1918
|
+
IStyle style = workbook.Styles.Add("CustomStyle");
|
|
1919
|
+
//Set rich text
|
|
1920
|
+
IRichTextString richText = worksheet["C2"].RichText;
|
|
1921
|
+
richText.Text = "Sample";
|
|
1922
|
+
IFont font = style.Font;
|
|
1923
|
+
font.Color = Color.Red;
|
|
1924
|
+
richText.SetFont(0, 5, font);
|
|
1925
|
+
//Check HasRichText
|
|
1926
|
+
Console.Write(worksheet["C2"].HasRichText);
|
|
1927
|
+
//Save to file
|
|
1928
|
+
workbook.SaveToFile("HasRichText.xlsx");
|
|
1929
|
+
</code>
|
|
1930
|
+
</example>
|
|
1931
|
+
</summary>
|
|
1932
|
+
"""
|
|
1933
|
+
pass
|
|
1934
|
+
|
|
1935
|
+
|
|
1936
|
+
@property
|
|
1937
|
+
@abc.abstractmethod
|
|
1938
|
+
def HasString(self)->bool:
|
|
1939
|
+
"""
|
|
1940
|
+
<summary>
|
|
1941
|
+
Indicates whether the range contains String. Read-only.
|
|
1942
|
+
</summary>
|
|
1943
|
+
"""
|
|
1944
|
+
pass
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
@property
|
|
1948
|
+
@abc.abstractmethod
|
|
1949
|
+
def HasStyle(self)->bool:
|
|
1950
|
+
"""
|
|
1951
|
+
<summary>
|
|
1952
|
+
Indicates whether range has default style. False means default style.
|
|
1953
|
+
Read-only.
|
|
1954
|
+
<example>The following code illustrates how to access HasStyle property:
|
|
1955
|
+
<code>
|
|
1956
|
+
//Create worksheet
|
|
1957
|
+
Workbook workbook = new Workbook();
|
|
1958
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1959
|
+
//Add style
|
|
1960
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
1961
|
+
//Set color and style
|
|
1962
|
+
style.Color = Color.Red;
|
|
1963
|
+
worksheet["C2"].Style = style;
|
|
1964
|
+
//Check HasStyle
|
|
1965
|
+
Console.Write(worksheet["C2"].HasStyle);
|
|
1966
|
+
//Save to file
|
|
1967
|
+
workbook.SaveToFile("HasStyle.xlsx");
|
|
1968
|
+
</code>
|
|
1969
|
+
</example>
|
|
1970
|
+
</summary>
|
|
1971
|
+
"""
|
|
1972
|
+
pass
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
@property
|
|
1976
|
+
|
|
1977
|
+
@abc.abstractmethod
|
|
1978
|
+
def HorizontalAlignment(self)->'HorizontalAlignType':
|
|
1979
|
+
"""
|
|
1980
|
+
<summary>
|
|
1981
|
+
Returns or sets the horizontal alignment for the specified object.
|
|
1982
|
+
Read/write HorizontalAlignType.
|
|
1983
|
+
<example>The following code illustrates how to set alignment type:
|
|
1984
|
+
<code>
|
|
1985
|
+
//Create worksheet
|
|
1986
|
+
Workbook workbook = new Workbook();
|
|
1987
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
1988
|
+
//Set text
|
|
1989
|
+
worksheet["A1"].Text = "Test";
|
|
1990
|
+
//Set alignment
|
|
1991
|
+
worksheet["A1"].HorizontalAlignment = HorizontalAlignType.Right;
|
|
1992
|
+
//Save to file
|
|
1993
|
+
workbook.SaveToFile("HorizontalAlignment.xlsx");
|
|
1994
|
+
</code>
|
|
1995
|
+
</example>
|
|
1996
|
+
</summary>
|
|
1997
|
+
"""
|
|
1998
|
+
pass
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
@HorizontalAlignment.setter
|
|
2002
|
+
@abc.abstractmethod
|
|
2003
|
+
def HorizontalAlignment(self, value:'HorizontalAlignType'):
|
|
2004
|
+
"""
|
|
2005
|
+
|
|
2006
|
+
"""
|
|
2007
|
+
pass
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
@property
|
|
2011
|
+
@abc.abstractmethod
|
|
2012
|
+
def IndentLevel(self)->int:
|
|
2013
|
+
"""
|
|
2014
|
+
<summary>
|
|
2015
|
+
Returns or sets the indent level for the cell or range. Can be an
|
|
2016
|
+
integer from 0 to 15. Read/write Integer.
|
|
2017
|
+
<example>The following code illustrates how to set indent level for a cell:
|
|
2018
|
+
<code>
|
|
2019
|
+
//Create worksheet
|
|
2020
|
+
Workbook workbook = new Workbook();
|
|
2021
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2022
|
+
//Set text
|
|
2023
|
+
worksheet["C2"].Text = "Sample";
|
|
2024
|
+
//Set indent level
|
|
2025
|
+
worksheet["C2"].IndentLevel = 2;
|
|
2026
|
+
//Save to file
|
|
2027
|
+
workbook.SaveToFile("IndentLevel.xlsx");
|
|
2028
|
+
</code>
|
|
2029
|
+
</example>
|
|
2030
|
+
</summary>
|
|
2031
|
+
"""
|
|
2032
|
+
pass
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
@IndentLevel.setter
|
|
2036
|
+
@abc.abstractmethod
|
|
2037
|
+
def IndentLevel(self, value:int):
|
|
2038
|
+
"""
|
|
2039
|
+
|
|
2040
|
+
"""
|
|
2041
|
+
pass
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
@property
|
|
2045
|
+
@abc.abstractmethod
|
|
2046
|
+
def IsBlank(self)->bool:
|
|
2047
|
+
"""
|
|
2048
|
+
<summary>
|
|
2049
|
+
Indicates whether the range is blank. Read-only.
|
|
2050
|
+
</summary>
|
|
2051
|
+
"""
|
|
2052
|
+
pass
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
@property
|
|
2056
|
+
@abc.abstractmethod
|
|
2057
|
+
def HasError(self)->bool:
|
|
2058
|
+
"""
|
|
2059
|
+
<summary>
|
|
2060
|
+
Indicates whether range contains error value.
|
|
2061
|
+
</summary>
|
|
2062
|
+
"""
|
|
2063
|
+
pass
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
@property
|
|
2067
|
+
@abc.abstractmethod
|
|
2068
|
+
def IsGroupedByColumn(self)->bool:
|
|
2069
|
+
"""
|
|
2070
|
+
<summary>
|
|
2071
|
+
Indicates whether this range is grouped by column. Read-only.
|
|
2072
|
+
</summary>
|
|
2073
|
+
"""
|
|
2074
|
+
pass
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
@property
|
|
2078
|
+
@abc.abstractmethod
|
|
2079
|
+
def IsGroupedByRow(self)->bool:
|
|
2080
|
+
"""
|
|
2081
|
+
<summary>
|
|
2082
|
+
Indicates whether this range is grouped by row. Read-only.
|
|
2083
|
+
</summary>
|
|
2084
|
+
"""
|
|
2085
|
+
pass
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
@property
|
|
2089
|
+
@abc.abstractmethod
|
|
2090
|
+
def IsInitialized(self)->bool:
|
|
2091
|
+
"""
|
|
2092
|
+
<summary>
|
|
2093
|
+
Indicates whether cell is initialized. Read-only.
|
|
2094
|
+
</summary>
|
|
2095
|
+
"""
|
|
2096
|
+
pass
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
@property
|
|
2100
|
+
@abc.abstractmethod
|
|
2101
|
+
def LastColumn(self)->int:
|
|
2102
|
+
"""
|
|
2103
|
+
<summary>
|
|
2104
|
+
Returns last column of the range. Read-only.
|
|
2105
|
+
</summary>
|
|
2106
|
+
"""
|
|
2107
|
+
pass
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
@LastColumn.setter
|
|
2111
|
+
@abc.abstractmethod
|
|
2112
|
+
def LastColumn(self, value:int):
|
|
2113
|
+
"""
|
|
2114
|
+
|
|
2115
|
+
"""
|
|
2116
|
+
pass
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
@property
|
|
2120
|
+
@abc.abstractmethod
|
|
2121
|
+
def LastRow(self)->int:
|
|
2122
|
+
"""
|
|
2123
|
+
<summary>
|
|
2124
|
+
Returns last row of the range. Read-only.
|
|
2125
|
+
</summary>
|
|
2126
|
+
"""
|
|
2127
|
+
pass
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
@LastRow.setter
|
|
2131
|
+
@abc.abstractmethod
|
|
2132
|
+
def LastRow(self, value:int):
|
|
2133
|
+
"""
|
|
2134
|
+
|
|
2135
|
+
"""
|
|
2136
|
+
pass
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
@property
|
|
2140
|
+
@abc.abstractmethod
|
|
2141
|
+
def NumberValue(self)->float:
|
|
2142
|
+
"""
|
|
2143
|
+
<summary>
|
|
2144
|
+
Gets / sets double value of the range.
|
|
2145
|
+
</summary>
|
|
2146
|
+
"""
|
|
2147
|
+
pass
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
@NumberValue.setter
|
|
2151
|
+
@abc.abstractmethod
|
|
2152
|
+
def NumberValue(self, value:float):
|
|
2153
|
+
"""
|
|
2154
|
+
|
|
2155
|
+
"""
|
|
2156
|
+
pass
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
@property
|
|
2160
|
+
|
|
2161
|
+
@abc.abstractmethod
|
|
2162
|
+
def NumberFormat(self)->str:
|
|
2163
|
+
"""
|
|
2164
|
+
<summary>
|
|
2165
|
+
Format of current cell. Analog of Style.NumberFormat property.
|
|
2166
|
+
<example>The following code illustrates how to set NumberFormat property:
|
|
2167
|
+
<code>
|
|
2168
|
+
//Create worksheet
|
|
2169
|
+
Workbook workbook = new Workbook();
|
|
2170
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2171
|
+
//Set data
|
|
2172
|
+
worksheet["C2"].Value = "3100.23";
|
|
2173
|
+
//Set number format
|
|
2174
|
+
worksheet["C2"].NumberFormat = "#,##1.##";
|
|
2175
|
+
//Save to file
|
|
2176
|
+
workbook.SaveToFile("NumberFormat.xlsx");
|
|
2177
|
+
</code>
|
|
2178
|
+
</example>
|
|
2179
|
+
</summary>
|
|
2180
|
+
"""
|
|
2181
|
+
pass
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
@NumberFormat.setter
|
|
2185
|
+
@abc.abstractmethod
|
|
2186
|
+
def NumberFormat(self, value:str):
|
|
2187
|
+
"""
|
|
2188
|
+
|
|
2189
|
+
"""
|
|
2190
|
+
pass
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
@property
|
|
2194
|
+
@abc.abstractmethod
|
|
2195
|
+
def Row(self)->int:
|
|
2196
|
+
"""
|
|
2197
|
+
<summary>
|
|
2198
|
+
Returns the number of the first row of the first area in
|
|
2199
|
+
the range. Read-only Long.
|
|
2200
|
+
</summary>
|
|
2201
|
+
"""
|
|
2202
|
+
pass
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
@property
|
|
2206
|
+
@abc.abstractmethod
|
|
2207
|
+
def RowGroupLevel(self)->int:
|
|
2208
|
+
"""
|
|
2209
|
+
<summary>
|
|
2210
|
+
Row group level. Read-only.
|
|
2211
|
+
-1 - Not all rows in the range have same group level.
|
|
2212
|
+
0 - No grouping,
|
|
2213
|
+
1 - 7 - Group level.
|
|
2214
|
+
</summary>
|
|
2215
|
+
"""
|
|
2216
|
+
pass
|
|
2217
|
+
|
|
2218
|
+
|
|
2219
|
+
@property
|
|
2220
|
+
@abc.abstractmethod
|
|
2221
|
+
def RowHeight(self)->float:
|
|
2222
|
+
"""
|
|
2223
|
+
<summary>
|
|
2224
|
+
Returns the height of all the rows in the range specified,
|
|
2225
|
+
measured in points. Returns Double.MinValue if the rows in the specified range
|
|
2226
|
+
aren't all the same height. Read / write Double.
|
|
2227
|
+
<example>The following code illustrates how to set row height:
|
|
2228
|
+
<code>
|
|
2229
|
+
//Create worksheet
|
|
2230
|
+
Workbook workbook = new Workbook();
|
|
2231
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2232
|
+
//Set text
|
|
2233
|
+
worksheet["A1"].Text = "Test";
|
|
2234
|
+
//Set row height
|
|
2235
|
+
worksheet["A1"].RowHeight = 30;
|
|
2236
|
+
//Save to file
|
|
2237
|
+
workbook.SaveToFile("RowHeight.xlsx");
|
|
2238
|
+
</code>
|
|
2239
|
+
</example>
|
|
2240
|
+
</summary>
|
|
2241
|
+
"""
|
|
2242
|
+
pass
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
@RowHeight.setter
|
|
2246
|
+
@abc.abstractmethod
|
|
2247
|
+
def RowHeight(self, value:float):
|
|
2248
|
+
"""
|
|
2249
|
+
|
|
2250
|
+
"""
|
|
2251
|
+
pass
|
|
2252
|
+
|
|
2253
|
+
|
|
2254
|
+
@property
|
|
2255
|
+
|
|
2256
|
+
@abc.abstractmethod
|
|
2257
|
+
def Rows(self)->'ListXlsRanges':
|
|
2258
|
+
"""
|
|
2259
|
+
<summary>
|
|
2260
|
+
For a Range object, returns an array of Range objects that represent the
|
|
2261
|
+
rows in the specified range.
|
|
2262
|
+
<example>The following code illustrates how to access rows:
|
|
2263
|
+
<code>
|
|
2264
|
+
//Create worksheet
|
|
2265
|
+
Workbook workbook = new Workbook();
|
|
2266
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2267
|
+
//Set rows
|
|
2268
|
+
IXLSRange[] rows = worksheet["A1:E8"].Rows;
|
|
2269
|
+
//Do some manipulations
|
|
2270
|
+
foreach (IXLSRange row in rows)
|
|
2271
|
+
row.Text = row.RangeAddressLocal;
|
|
2272
|
+
//Save to file
|
|
2273
|
+
workbook.SaveToFile("Rows.xlsx");
|
|
2274
|
+
</code>
|
|
2275
|
+
</example>
|
|
2276
|
+
</summary>
|
|
2277
|
+
"""
|
|
2278
|
+
pass
|
|
2279
|
+
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
@property
|
|
2283
|
+
|
|
2284
|
+
@abc.abstractmethod
|
|
2285
|
+
def Columns(self)->'ListXlsRanges':
|
|
2286
|
+
"""
|
|
2287
|
+
<summary>
|
|
2288
|
+
For a Range object, returns an array of Range objects that represent the
|
|
2289
|
+
columns in the specified range.
|
|
2290
|
+
<example>The following code illustrates how to access columns:
|
|
2291
|
+
<code>
|
|
2292
|
+
//Create worksheet
|
|
2293
|
+
Workbook workbook = new Workbook();
|
|
2294
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2295
|
+
//Set columns
|
|
2296
|
+
IXLSRange[] columns = worksheet["A1:E8"].Columns;
|
|
2297
|
+
//Do some manipulations
|
|
2298
|
+
foreach (IXLSRange column in columns)
|
|
2299
|
+
column.Text = column.RangeAddressLocal;
|
|
2300
|
+
//Save to file
|
|
2301
|
+
workbook.SaveToFile("Columns.xlsx");
|
|
2302
|
+
</code>
|
|
2303
|
+
</example>
|
|
2304
|
+
</summary>
|
|
2305
|
+
"""
|
|
2306
|
+
pass
|
|
2307
|
+
|
|
2308
|
+
|
|
2309
|
+
|
|
2310
|
+
@property
|
|
2311
|
+
|
|
2312
|
+
@abc.abstractmethod
|
|
2313
|
+
def Style(self)->'IStyle':
|
|
2314
|
+
"""
|
|
2315
|
+
<summary>
|
|
2316
|
+
Returns a Style object that represents the style of the specified
|
|
2317
|
+
range. Read/write IStyle.
|
|
2318
|
+
<example>The following code illustrates how to the style of the specified range:
|
|
2319
|
+
<code>
|
|
2320
|
+
//Create worksheet
|
|
2321
|
+
Workbook workbook = new Workbook();
|
|
2322
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2323
|
+
//Set text
|
|
2324
|
+
worksheet["C2"].Text = "Sample";
|
|
2325
|
+
//Add and set style
|
|
2326
|
+
CellStyle style = workbook.Styles.Add("BorderStyle");
|
|
2327
|
+
style.Color = Color.Red;
|
|
2328
|
+
worksheet["C2"].Style = style;
|
|
2329
|
+
//Save to file
|
|
2330
|
+
workbook.SaveToFile("Style.xlsx");
|
|
2331
|
+
</code>
|
|
2332
|
+
</example>
|
|
2333
|
+
</summary>
|
|
2334
|
+
"""
|
|
2335
|
+
pass
|
|
2336
|
+
|
|
2337
|
+
|
|
2338
|
+
@Style.setter
|
|
2339
|
+
@abc.abstractmethod
|
|
2340
|
+
def Style(self, value:'IStyle'):
|
|
2341
|
+
"""
|
|
2342
|
+
|
|
2343
|
+
"""
|
|
2344
|
+
pass
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
@property
|
|
2348
|
+
|
|
2349
|
+
@abc.abstractmethod
|
|
2350
|
+
def CellStyleName(self)->str:
|
|
2351
|
+
"""
|
|
2352
|
+
<summary>
|
|
2353
|
+
Returns name of the Style object that represents the style of the specified
|
|
2354
|
+
range. Read/write String.
|
|
2355
|
+
<example>The following code illustrates how to access CellStyleName of the specified range:
|
|
2356
|
+
<code>
|
|
2357
|
+
//Create worksheet
|
|
2358
|
+
Workbook workbook = new Workbook();
|
|
2359
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2360
|
+
//Add and set style
|
|
2361
|
+
CellStyle style = workbook.Styles.Add("CustomStyle");
|
|
2362
|
+
worksheet["C2"].Style = style;
|
|
2363
|
+
//Check Style name
|
|
2364
|
+
Console.Write(worksheet["C2"].CellStyleName);
|
|
2365
|
+
</code>
|
|
2366
|
+
</example>
|
|
2367
|
+
</summary>
|
|
2368
|
+
"""
|
|
2369
|
+
pass
|
|
2370
|
+
|
|
2371
|
+
|
|
2372
|
+
@CellStyleName.setter
|
|
2373
|
+
@abc.abstractmethod
|
|
2374
|
+
def CellStyleName(self, value:str):
|
|
2375
|
+
"""
|
|
2376
|
+
|
|
2377
|
+
"""
|
|
2378
|
+
pass
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
@property
|
|
2382
|
+
|
|
2383
|
+
@abc.abstractmethod
|
|
2384
|
+
def Text(self)->str:
|
|
2385
|
+
"""
|
|
2386
|
+
<summary>
|
|
2387
|
+
Gets / sets string value of the range.
|
|
2388
|
+
</summary>
|
|
2389
|
+
"""
|
|
2390
|
+
pass
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
@Text.setter
|
|
2394
|
+
@abc.abstractmethod
|
|
2395
|
+
def Text(self, value:str):
|
|
2396
|
+
"""
|
|
2397
|
+
|
|
2398
|
+
"""
|
|
2399
|
+
pass
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
@property
|
|
2403
|
+
|
|
2404
|
+
@abc.abstractmethod
|
|
2405
|
+
def TimeSpanValue(self)->'TimeSpan':
|
|
2406
|
+
"""
|
|
2407
|
+
<summary>
|
|
2408
|
+
Gets / sets time value of the range.
|
|
2409
|
+
</summary>
|
|
2410
|
+
"""
|
|
2411
|
+
pass
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
@TimeSpanValue.setter
|
|
2415
|
+
@abc.abstractmethod
|
|
2416
|
+
def TimeSpanValue(self, value:'TimeSpan'):
|
|
2417
|
+
"""
|
|
2418
|
+
|
|
2419
|
+
"""
|
|
2420
|
+
pass
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
@property
|
|
2424
|
+
|
|
2425
|
+
@abc.abstractmethod
|
|
2426
|
+
def Value(self)->str:
|
|
2427
|
+
"""
|
|
2428
|
+
<summary>
|
|
2429
|
+
Returns or sets the value of the specified range.
|
|
2430
|
+
Read/write Variant.
|
|
2431
|
+
<example>The following code illustrates how to set Value of the specified range:
|
|
2432
|
+
<code>
|
|
2433
|
+
//Create worksheet
|
|
2434
|
+
Workbook workbook = new Workbook();
|
|
2435
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2436
|
+
//Set value of the range
|
|
2437
|
+
CellRange range= worksheet.Range[3, 1];
|
|
2438
|
+
range.Value = "1/1/2015";
|
|
2439
|
+
//Save to file
|
|
2440
|
+
workbook.SaveToFile("Value.xlsx");
|
|
2441
|
+
</code>
|
|
2442
|
+
</example>
|
|
2443
|
+
</summary>
|
|
2444
|
+
"""
|
|
2445
|
+
pass
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
@Value.setter
|
|
2449
|
+
@abc.abstractmethod
|
|
2450
|
+
def Value(self, value:str):
|
|
2451
|
+
"""
|
|
2452
|
+
|
|
2453
|
+
"""
|
|
2454
|
+
pass
|
|
2455
|
+
|
|
2456
|
+
|
|
2457
|
+
@property
|
|
2458
|
+
|
|
2459
|
+
@abc.abstractmethod
|
|
2460
|
+
def EnvalutedValue(self)->str:
|
|
2461
|
+
"""
|
|
2462
|
+
<summary>
|
|
2463
|
+
Returns the calculated value of a formula using the most current inputs.
|
|
2464
|
+
<example>The following code illustrates how to access a calculated value:
|
|
2465
|
+
<code>
|
|
2466
|
+
//Create worksheet
|
|
2467
|
+
Workbook workbook = new Workbook();
|
|
2468
|
+
workbook.LoadFromFile("Sample.xlsx");
|
|
2469
|
+
Worksheet worksheet = workbook.Worksheets[0];
|
|
2470
|
+
//Returns the calculated value of a formula using the most current inputs
|
|
2471
|
+
string calculatedValue = worksheet["C1"].EnvalutedValue;
|
|
2472
|
+
Console.WriteLine(calculatedValue);
|
|
2473
|
+
</code>
|
|
2474
|
+
</example>
|
|
2475
|
+
</summary>
|
|
2476
|
+
"""
|
|
2477
|
+
pass
|
|
2478
|
+
|
|
2479
|
+
|