Skip to content

Commit 0bb51a6

Browse files
rabanti-githubrabanti-github
committed
Updated readme / migration guide
1 parent e1303fa commit 0bb51a6

File tree

2 files changed

+198
-3
lines changed

2 files changed

+198
-3
lines changed

‎MigrationGuide.md‎

Lines changed: 196 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,61 @@ The following guide lists all necessary changes, as well as changed behaviors of
6363
| `AUTO_ZOOM_FACTOR` | `AutoZoomFactor` |
6464
| `MIN_ZOOM_FACTOR` | `MinZoomFactor` |
6565
| `MAX_ZOOM_FACTOR` | `MaxZoomFactor` |
66-
66+
67+
- The enum values of `Worksheet.SheetProtectionValue` were renamed, according to the following overview:
68+
69+
| Old Enum Value | New Enum Value | Remarks |
70+
| ------------------------------------------- | ------------------------------- | ------- |
71+
| `SheetProtectionValue.objects` | `SheetProtectionValue.Objects` | |
72+
| `SheetProtectionValue.scenarios` | `SheetProtectionValue.Scenarios` | |
73+
| `SheetProtectionValue.formatCells` | `SheetProtectionValue.FormatCells` | |
74+
| `SheetProtectionValue.formatColumns` | `SheetProtectionValue.FormatColumns` | |
75+
| `SheetProtectionValue.formatRows` | `SheetProtectionValue.FormatRows` | |
76+
| `SheetProtectionValue.insertColumns` | `SheetProtectionValue.InsertColumns` | |
77+
| `SheetProtectionValue.insertRows` | `SheetProtectionValue.InsertRows` | |
78+
| `SheetProtectionValue.insertHyperlinks` | `SheetProtectionValue.InsertHyperlinks` | |
79+
| `SheetProtectionValue.deleteColumns` | `SheetProtectionValue.DeleteColumns` | |
80+
| `SheetProtectionValue.deleteRows` | `SheetProtectionValue.DeleteRows` | |
81+
| `SheetProtectionValue.selectLockedCells` | `SheetProtectionValue.SelectLockedCells` | |
82+
| `SheetProtectionValue.sort` | `SheetProtectionValue.Sort` | |
83+
| `SheetProtectionValue.autoFilter` | `SheetProtectionValue.AutoFilter` | |
84+
| `SheetProtectionValue.pivotTables` | `SheetProtectionValue.PivotTables` | |
85+
| `SheetProtectionValue.selectUnlockedCells` | `SheetProtectionValue.SelectUnlockedCells` | |
86+
87+
- The enum values of `Worksheet.WorksheetPane` were renamed, according to the following overview:
88+
89+
| Old Enum Value | New Enum Value | Remarks |
90+
| ----------------------------- | ------------------------------- | ------- |
91+
| `WorksheetPane.bottomRight` | `WorksheetPane.BottomRight` | |
92+
| `WorksheetPane.topRight` | `WorksheetPane.TopRight` | |
93+
| `WorksheetPane.bottomLeft` | `WorksheetPane.BottomLeft` | |
94+
| `WorksheetPane.topLeft` | `WorksheetPane.TopLeft` | |
95+
96+
- The enum values of `Worksheet.SheetViewType` were renamed, according to the following overview:
97+
98+
| Old Enum Value | New Enum Value | Remarks |
99+
| -------------------------------- | ------------------------------- | ------- |
100+
| `SheetViewType.normal` | `SheetViewType.Normal` | |
101+
| `SheetViewType.PageBreakPreview` | `SheetViewType.PageBreakPreview`| |
102+
| `SheetViewType.PageLayout` | `SheetViewType.PageLayout` | |
103+
104+
---
105+
106+
### Cell
107+
108+
- The enum values of `Cell.CellType` were renamed, according to the following overview:
109+
110+
| Old Enum Value | New Enum Value | Remarks |
111+
|---------------------|------------------------|----------|
112+
| `CellType.STRING` | `CellType.String` | |
113+
| `CellType.NUMBER` | `CellType.Number` | |
114+
| `CellType.DATE` | `CellType.Date` | |
115+
| `CellType.TIME` | `CellType.Time` | |
116+
| `CellType.BOOL` | `CellType.Bool` | |
117+
| `CellType.FORMULA` | `CellType.Formula` | |
118+
| `CellType.EMPTY` | `CellType.Empty` | |
119+
| `CellType.DEFAULT` | `CellType.Default` | |
120+
67121
---
68122

69123
### Address (struct)
@@ -105,6 +159,32 @@ Furthermore, a lot of constants were renamed to follow the C# naming conventions
105159
| `DEFAULT_FONT_FAMILY` | `DefaultFontSize` | The type was changed from `int` to the enum `Font.FontFamilyValue` |
106160
| `DEFAULT_VERTICAL_ALIGN` | `DefaultVerticalAlign` | The type was changed from enum `Font.VerticalAlignValue` to `Font.VerticalTextAlignValue` |
107161

162+
- The enum values of `Font.SchemeValue` were renamed, according to the following overview:
163+
164+
| Old Enum Value | New Enum Value | Remarks |
165+
| ----------------------------- | --------------------------- | ------- |
166+
| `SchemeValue.major` | `SchemeValue.Major` | |
167+
| `SchemeValue.minor` | `SchemeValue.Minor` | |
168+
| `SchemeValue.none` | `SchemeValue.None` | |
169+
170+
- The enum values of `Font.VerticalTextAlignValue` were renamed, according to the following overview:
171+
172+
| Old Enum Value | New Enum Value | Remarks |
173+
| ----------------------------------- | --------------------------- | ------- |
174+
| `VerticalTextAlignValue.subscript` | `VerticalTextAlignValue.Subscript` | |
175+
| `VerticalTextAlignValue.superscript`| `VerticalTextAlignValue.Superscript` | |
176+
| `VerticalTextAlignValue.none` | `VerticalTextAlignValue.None` | |
177+
178+
- The enum values of `Font.UnderlineValue` were renamed, according to the following overview:
179+
180+
| Old Enum Value | New Enum Value | Remarks |
181+
| ----------------------------------- | --------------------------- | ------- |
182+
| `UnderlineValue.u_single` | `UnderlineValue.Single` | |
183+
| `UnderlineValue.u_double_` | `UnderlineValue.Double` | |
184+
| `UnderlineValue.singleAccounting` | `UnderlineValue.SingleAccounting` | |
185+
| `UnderlineValue.doubleAccounting` | `UnderlineValue.DoubleAccounting` | |
186+
| `UnderlineValue.none` | `UnderlineValue.None` | |
187+
108188
- The property `Font.Family` was changed from type `string` to the enum `Font.FontFamilyValue`.The value has to be replaced by one of the following available values:
109189
```cs
110190
NotApplicable, Roman, Swiss, Modern, Script, Decorative, Reserved1, Reserved2, Reserved3, Reserved4, Reserved5, Reserved6, Reserved7, Reserved8, Reserved9
@@ -130,6 +210,24 @@ ApplicationDefined, ANSI, Default, Symbols, Mac, ShiftJIS, Hangul, Johab, GBK, B
130210
| `DEFAULT_BORDER_STYLE` | `DefaultBorderStyle` | |
131211
| `DEFAULT_COLOR` | `DefaultBorderColor` | |
132212

213+
- The enum values of `Border.StyleValue` were renamed, according to the following overview:
214+
215+
| Old Enum Value | New Enum Value | Remarks |
216+
| ----------------------------- | --------------------------- | ------- |
217+
| `StyleValue.hair` | `CellType.Hair` | |
218+
| `StyleValue.dotted` | `CellType.Dotted` | |
219+
| `StyleValue.dashDotDot` | `CellType.DashDotDot` | |
220+
| `StyleValue.dashDot` | `CellType.DashDot` | |
221+
| `StyleValue.dashed` | `CellType.Dashed` | |
222+
| `StyleValue.thin` | `CellType.Thin` | |
223+
| `StyleValue.mediumDashDotDot` | `CellType.MediumDashDotDot` | |
224+
| `StyleValue.slantDashDot` | `CellType.SlantDashDot` | |
225+
| `StyleValue.mediumDashDot` | `CellType.MediumDashDot` | |
226+
| `StyleValue.mediumDashed` | `CellType.MediumDashed` | |
227+
| `StyleValue.medium` | `CellType.Medium` | |
228+
| `StyleValue.thick` | `CellType.Thick` | |
229+
| `StyleValue.s_double` | `CellType.Double` | |
230+
133231
#### Fill
134232

135233
- The public constant values of the `Fill` class were renamed, according to the following overview:
@@ -140,6 +238,25 @@ ApplicationDefined, ANSI, Default, Symbols, Mac, ShiftJIS, Hangul, Johab, GBK, B
140238
| `DEFAULT_INDEXED_COLOR` | `DefaultIndexedColor` | |
141239
| `DEFAULT_PATTERN_FILL` | `DefaultPatternFill` | |
142240

241+
- The enum values of `Fill.FillType` were renamed, according to the following overview:
242+
243+
| Old Enum Value | New Enum Value | Remarks |
244+
| ----------------------- | --------------------------- | ------- |
245+
| `FillType.patternColor` | `FillType.PatternColor` | |
246+
| `FillType.fillColor` | `FillType.FillColor` | |
247+
248+
- The enum values of `Fill.PatternValue` were renamed, according to the following overview:
249+
250+
| Old Enum Value | New Enum Value | Remarks |
251+
| ------------------------ | -------------------------- | ------- |
252+
| `PatternValue.solid` | `PatternValue.Solid` | |
253+
| `PatternValue.darkGray` | `PatternValue.DarkGray` | |
254+
| `PatternValue.mediumGray`| `PatternValue.MediumGray` | |
255+
| `PatternValue.lightGray` | `PatternValue.LightGray` | |
256+
| `PatternValue.gray0625` | `PatternValue.Gray0625` | |
257+
| `PatternValue.gray125` | `PatternValue.Gray125` | |
258+
| `PatternValue.none` | `PatternValue.None` | |
259+
143260
- The static method `Fill.ValidateColr(string,bool, bool)` was moved to the utils class `Validators.ValidateColr(string,bool, bool)` in namespace `NanoXLSX.Utils`. The class has to be changed in the code, but the method signature remains unchanged.
144261

145262
#### CellXf
@@ -153,6 +270,46 @@ ApplicationDefined, ANSI, Default, Symbols, Mac, ShiftJIS, Hangul, Johab, GBK, B
153270
| `DEFAULT_TEXT_DIRECTION` | `DefaultTextDirection` | |
154271
| `DEFAULT_VERTICAL_ALIGNMENT` | `DefaultVerticalAlignment` | |
155272

273+
- The enum values of `CellXf.HorizontalAlignValue` were renamed, according to the following overview:
274+
275+
| Old Enum Value | New Enum Value | Remarks |
276+
| ------------------------------- | --------------------------- | ------- |
277+
| `HorizontalAlignValue.left` | `HorizontalAlignValue.Left` | |
278+
| `HorizontalAlignValue.center` | `HorizontalAlignValue.Center` | |
279+
| `HorizontalAlignValue.right` | `HorizontalAlignValue.Right` | |
280+
| `HorizontalAlignValue.fill` | `HorizontalAlignValue.Fill` | |
281+
| `HorizontalAlignValue.justify` | `HorizontalAlignValue.Justify` | |
282+
| `HorizontalAlignValue.general` | `HorizontalAlignValue.General` | |
283+
| `HorizontalAlignValue.centerContinuous` | `HorizontalAlignValue.CenterContinuous` | |
284+
| `HorizontalAlignValue.distributed` | `HorizontalAlignValue.Distributed` | |
285+
| `HorizontalAlignValue.none` | `HorizontalAlignValue.None` | |
286+
287+
- The enum values of `CellXf.TextBreakValue` were renamed, according to the following overview:
288+
289+
| Old Enum Value | New Enum Value | Remarks |
290+
| ----------------------------- | --------------------------- | ------- |
291+
| `TextBreakValue.wrapText` | `TextBreakValue.WrapText` | |
292+
| `TextBreakValue.shrinkToFit` | `TextBreakValue.ShrinkToFit`| |
293+
| `TextBreakValue.none` | `TextBreakValue.None` | |
294+
295+
- The enum values of `CellXf.TextDirectionValue` were renamed, according to the following overview:
296+
297+
| Old Enum Value | New Enum Value | Remarks |
298+
| ------------------------------- | --------------------------- | ------- |
299+
| `TextDirectionValue.horizontal` | `TextDirectionValue.Horizontal` | |
300+
| `TextDirectionValue.vertical` | `TextDirectionValue.Vertical` | |
301+
302+
- The enum values of `CellXf.VerticalAlignValue` were renamed, according to the following overview:
303+
304+
| Old Enum Value | New Enum Value | Remarks |
305+
| ------------------------------- | --------------------------- | ------- |
306+
| `VerticalAlignValue.bottom` | `VerticalAlignValue.Horizontal` | |
307+
| `VerticalAlignValue.top` | `VerticalAlignValue.Vertical` | |
308+
| `VerticalAlignValue.center` | `VerticalAlignValue.Horizontal` | |
309+
| `VerticalAlignValue.justify` | `VerticalAlignValue.Justify` | |
310+
| `VerticalAlignValue.distributed`| `VerticalAlignValue.Distributed`| |
311+
| `VerticalAlignValue.none` | `VerticalAlignValue.None` | |
312+
156313
#### NumberFormat
157314

158315
- The public constant values of the `NumberFormat` class were renamed, according to the following overview:
@@ -171,6 +328,44 @@ ApplicationDefined, ANSI, Default, Symbols, Mac, ShiftJIS, Hangul, Johab, GBK, B
171328
| `FormatRange.invalied` | `FormatRange.Inavlid` | |
172329
| `FormatRange.undefined` | `FormatRange.Undefined`| |
173330

331+
- The enum values of `NumberFormat.NumberFormat` were renamed, according to the following overview:
332+
333+
| Old Enum Value | New Enum Value | Remarks |
334+
| ------------------------ | ----------------------- | ------------------------- |
335+
| `NumberFormat.format_1` | `NumberFormat.Format1` | |
336+
| `NumberFormat.format_2` | `NumberFormat.Format2` | |
337+
| `NumberFormat.format_3` | `NumberFormat.Format3` | |
338+
| `NumberFormat.format_4` | `NumberFormat.Format4` | |
339+
| `NumberFormat.format_5` | `NumberFormat.Format5` | |
340+
| `NumberFormat.format_6` | `NumberFormat.Format6` | |
341+
| `NumberFormat.format_7` | `NumberFormat.Format7` | |
342+
| `NumberFormat.format_8` | `NumberFormat.Format8` | |
343+
| `NumberFormat.format_9` | `NumberFormat.Format9` | |
344+
| `NumberFormat.format_10` | `NumberFormat.Format10` | |
345+
| `NumberFormat.format_11` | `NumberFormat.Format11` | |
346+
| `NumberFormat.format_12` | `NumberFormat.Format12` | |
347+
| `NumberFormat.format_13` | `NumberFormat.Format13` | |
348+
| `NumberFormat.format_14` | `NumberFormat.Format14` | |
349+
| `NumberFormat.format_15` | `NumberFormat.Format15` | |
350+
| `NumberFormat.format_16` | `NumberFormat.Format16` | |
351+
| `NumberFormat.format_17` | `NumberFormat.Format17` | |
352+
| `NumberFormat.format_18` | `NumberFormat.Format18` | |
353+
| `NumberFormat.format_19` | `NumberFormat.Format19` | |
354+
| `NumberFormat.format_20` | `NumberFormat.Format20` | |
355+
| `NumberFormat.format_21` | `NumberFormat.Format21` | |
356+
| `NumberFormat.format_22` | `NumberFormat.Format22` | |
357+
| `NumberFormat.format_37` | `NumberFormat.Format37` | |
358+
| `NumberFormat.format_38` | `NumberFormat.Format38` | |
359+
| `NumberFormat.format_39` | `NumberFormat.Format39` | |
360+
| `NumberFormat.format_40` | `NumberFormat.Format40` | |
361+
| `NumberFormat.format_45` | `NumberFormat.Format45` | |
362+
| `NumberFormat.format_46` | `NumberFormat.Format46` | |
363+
| `NumberFormat.format_47` | `NumberFormat.Format47` | |
364+
| `NumberFormat.format_48` | `NumberFormat.Format48` | |
365+
| `NumberFormat.format_49` | `NumberFormat.Format49` | |
366+
| `NumberFormat.custom` | `NumberFormat.Custom` | Custom formats (ID ≥ 164) |
367+
| `NumberFormat.none` | `NumberFormat.None` | |
368+
174369
---
175370

176371
### Theme

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010
## Pre-Release v3.x
1111

12-
The pre-release of NanoXLSX is now available as [Nuget Package](https://www.nuget.org/packages/NanoXLSX/3.0.0-rc.1), version **3.0.0-rc.1**.
13-
Since there are breaking changes between NanoXLSX v2.x and v3.0.0-rc1, please see the **[Migration guide](MigrationGuide.md)**, to migrate applications from v2 to v3. Please feel free to open issues, in case of problems with the pre-release.
12+
The pre-release of NanoXLSX is now available as [Nuget Package](https://www.nuget.org/packages/NanoXLSX/3.0.0-rc.2), version **3.0.0-rc.2**.
13+
Since there are breaking changes between NanoXLSX v2.x and v3.0.0-rc2, please see the **[Migration guide](MigrationGuide.md)**, to migrate applications from v2 to v3. Please feel free to open issues, in case of problems with the pre-release.
1414

1515
There will be possibly further adaptions and additional pre-releases before the final release.
1616

0 commit comments

Comments
 (0)