Skip to content

Wiki suggestion - porting guide #1819

Open
@dmccarty-incomm

Description

@dmccarty-incomm

The wiki says "If you’re looking for something but can’t find it, let us know on our issuetracker." Hopefully this is the format that you want. This is a suggestion for a new section to be added to the Wiki. Not sure if the authors feel the section is appropriate or not and so this may just be a discussion of whether or not to add.

I used EPPlus for years before they switched to a pay model. I am now porting that old code to ClosedXML. A "Porting Guide" section on the Wiki could be very helpful for other users like me. The goal is NOT to have the guide completely list all equivalent functions for both libraries but rather, just the highlights of the most common things and a few "gotcha" items. Something like the following:

EPPlus

//COMMON FUNCTIONS
var pk = new ExcelPackage();                  <=>  var pk = new XLWorkbook();
var ws = pk.Workbook.Worksheets.Add("sheet")  <=>  var ws = pk.Worksheets.Add("sheet");
ws.Cells[1, 1].Value = "my text";             <=>  ws.Cell(1, 1).Value = "my text";
var rg = ws.Cells["A1:B2"];                   <=>  var rg = ws.Cells("A1:B2");
rg.Style.Fill.PatternType = ExcelFillStyle.Solid;        <=> rg.Style.Fill.PatternType = XLFillPatternValues.Solid;
rg.Style.Fill.BackgroundColor.SetColor(Color.LightGray); <=> rg.Style.Fill.BackgroundColor = XLColor.LightGray;
ws.Cells[ws.Dimension.Address].AutoFitColumns();         <=> ws.ColumnsUsed().AdjustToContents()

//GOTCHA'S
ws.View.FreezePanes(2, 8);  <=>  ws.SheetView.Freeze(1,7); //note the ClosedXML version uses the original values -1

I'm sure there are other libraries that one could port from as well. They could also be added in this section (either now or at a later time)

Read and complete the full issue template

Do not randomly delete sections. They are here for a reason.

Do you want to request a feature or report a bug?

  • Bug
  • Feature
  • Question

Did you test against the latest CI build?

  • Yes
  • No
  • N/A

If you answered No, please test with the latest development build first.

Version of ClosedXML

e.g. 0.95.3

What is the current behavior?

Missing documentaion

What is the expected behavior or new feature?

Make it easier for users to port to ClosedXML from other libraries

Regressions get higher priority. Test against the latest build of the previous minor version. For example, if you experience a problem on v0.95.3, check whether it the problem occurred in v0.94.2 too.

Reproducibility

This is an important section. Read it carefully. Failure to do so will cause a 'RTFM' comment.

Without a code sample, it is unlikely that your issue will get attention. Don't be lazy. Do the effort and assist the developers to reproduce your problem. Code samples should be minimal complete and verifiable. Sample spreadsheets should be attached whenever applicable. Remove sensitive information.

Code to reproduce problem:
N/A


- [ ] I attached a sample spreadsheet.  (You can drag files on to this issue)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions