Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Methods deprecated in OfficeWriter v8

A number of minor changes were made to ExcelWriter properties, methods, and enumerations in the shift from J# source code to pure C#.methods were deprecated in OfficeWriter v8.  As of the v9 release, these methods are no longer listed in our API. 

ExcelTemplate

The following is a list of ExcelTemplate methods that have been changed to properties in SoftArtisans ExcelWriter v7. If you use any of these methods in your application, you will need to replace them with the appropriate property call.

ExcelWriter v6 Method

ExcelWriter v7 Property

ChartType.getCategory()

ChartType.Category

ChartType.getName()

ChartType.Name

ChartType.is3D()

ChartType.Is3D

Worksheet.IsSelected()

Worksheet.IsSelected

The following is a list of enumerations for which the getValue method has been replaced with a Value property in ExcelWriter v7. If you used the getValue method of any of these enumerations in your application, you will need to replace them with the appropriate property call.

ExcelWriter v6 Method

ExcelWriter v7 Property

Axis.TickLabelPos.getValue()

Axis.TickLabelPos.Value

Axis.TickType.getValue()

Axis.TickType.Value

AxisLabel.LabelPosition.getValue()

AxisLabel.LabelPosition.Value

Axis.Type.getValue()

Axis.Type.Value

Border.LineStyle.getValue()

Border.LineStyle.Value

Border.Part.getValue()

Border.Part.Value

CategoryAxis.AxisDisplayType.getValue()

CategoryAxis.AxisDisplayType.Value

CategoryAxis.AxisTimeUnit.getValue()

CategoryAxis.AxisTimeUnit.Value

Cell.CellValueType.getValue()

Cell.CellValueType.Value

Chart.ChartLocation.getValue()

Chart.ChartLocation.Value

ChartLine.LineStyle.getValue()

ChartLine.LineStyle.Value

ChartLine.LineWeight.getValue()

ChartLine.LineWeight.Value

ChartPageSetup.PrintedChartSize.getValue()

ChartPageSetup.PrintedChartSize.Value

ChartRegion.HorizontalAlignment.getValue()

ChartRegion.HorizontalAlignment.Value

ChartRegion.VerticalAlignment.getValue()

ChartRegion.VerticalAlignment.Value

ChartType.ChartCategory.getValue()

ChartType.ChartCategory.Value

Condition.Comparison.getValue()

Condition.Comparison.Value

CopyPasteProperties.CopyPasteType.getValue()

CopyPasteProperties.CopyPasteType.Value

DataPointMarker.ShapeType.getValue()

DataPointMarker.ShapeType.Value

DataValidation.ComparisonType.getValue()

DataValidation.ComparisonType.Value

DataValidation
.ErrorAlertStyleType.getValue()

DataValidation
.ErrorAlertStyleType.Value

DataValidation.ValidationType.getValue()

DataValidation.ValidationType.Value

DocumentProperties.BuiltIn.getValue()

DocumentProperties.BuiltIn.Value

ErrorBar.BarDirection.getValue()

ErrorBar.BarDirection.Value

ErrorBar.ErrorValueType.getValue()

ErrorBar.ErrorValueType.Value

Font.UnderlineStyle.getValue()

Font.UnderlineStyle.Value

Font.VerticalPosition.getValue()

Font.VerticalPosition.Value

Legend.LegendLocation.getValue()

Legend.LegendLocation.Value

NamedObject.BuiltInName.getValue()

NamedObject.BuiltInName.Value

NamedObject.ReturnType.getValue()

NamedObject.ReturnType.Value

NamedObject.Scope.getValue()

NamedObject.Scope.Value

NumberFormat.Color.getValue()

NumberFormat.Color.Value

ObjectPositioning.getValue()

ObjectPositioning.Value

PageSetup.CellErrorsAs.getValue()

PageSetup.CellErrorsAs.Value

PageSetup.PageOrientation.getValue()

PageSetup.PageOrientation.Value

PageSetup.PagePaperSize.getValue()

PageSetup.PagePaperSize.Value

PageSetup.PagePrintOrder.getValue()

PageSetup.PagePrintOrder.Value

Pattern.getValue()

Pattern.Value

SettingsBarColumn.ShapeType.getValue()

SettingsBarColumn.ShapeType.Value

Style.ColumnInsertBehavior.getValue()

Style.ColumnInsertBehavior.Value

Style.HAlign.getValue()

Style.HAlign.Value

Style.RowInsertBehavior.getValue()

Style.RowInsertBehavior.Value

Style.TextDir.getValue()

Style.TextDir.Value

Style.VAlign.getValue()

Style.VAlign.Value

Trendline.Regression.getValue()

Trendline.Regression.Value

Worksheet.SheetViewState.getValue()

Worksheet.SheetViewState.Value

Worksheet.SheetVisibility.getValue()

Worksheet.SheetVisibility.Value

Worksheet.SummaryColumnsLocation.getValue()

Worksheet.SummaryColumnsLocation.Value

Worksheet.SummaryRowsLocation.getValue()

Worksheet.SummaryRowsLocation.Value

The following properties were renamed because of changes in the source code:

ExcelWriter v6 Property

ExcelWriter v7 Equivalent Property

ChartType.Custom.Custom

ChartType.Custom.Combo

ChartType.Scatter.Scatter

ChartType.Scatter.StandardScatter

Additionally, there are a small number of methods which are no longer supported in ExcelWriter v7 and have not been replaced with an alternative method or property:

ChartType.Area.getValue()

ChartType.Bar.getValue()

ChartType.Bubble.getValue()

ChartType.Column.getValue()

ChartType.Custom.getValue()

ChartType.Doughnut.getValue()

ChartType.Line.getValue()

ChartType.Pie.getValue()

ChartType.Radar.getValue()

ChartType.Scatter.getValue()

ChartType.Surface.getValue()

SettingsPieDoughnut.BopPopSplit.getValue()

are now deprecated.  Also listed are the methods that should be used in v9 to replace the deprecated methods.

ExcelTemplate v8 Method

ExcelTemplate v9 Method

ExcelTemplate.SetCellDataSource

ExcelTemplate.BindCellData

ExcelTemplate.SetColumnDataSource

ExcelTemplate.BindColumnData

ExcelTemplate.SetRowDataSource

ExcelTemplate.BindRowData

ExcelTemplate.SetDataSource

ExcelTemplate.BindData

ExcelApplication

The following is a list of ExcelApplication methods that are now deprecated.  Also listed are the methods that should be used in v9 to replace the deprecated methods.


WordApplication

The following WordApplication method is now deprecated.  The listed methods should be used in v9 to replace the deprecated method.

WordApplication v8 MethodWordApplication v9 Method
Table.PreferredWidth

Table.SetPreferredWidth(Double, Units)

Table.GetPreferredWidth(out Units)