Skip to content

Commit e1c2e0c

Browse files
author
JanKallman
committed
Version 3.0.0.2
Documentation added.
1 parent 9bd0fbf commit e1c2e0c

10 files changed

+81
-68
lines changed

‎EPPlus/ExcelPackage.cs

+1
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ namespace OfficeOpenXml
137137
///
138138
/// return newFile.FullName;
139139
/// </code>
140+
/// More samples can be found at <a href="http://epplus.codeplex.com/">http://epplus.codeplex.com/</a>
140141
/// </summary>
141142
public sealed class ExcelPackage : IDisposable
142143
{

‎EPPlus/Properties/AssemblyInfo.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,6 @@
6060
//
6161
// You can specify all the values or you can default the Revision and Build Numbers
6262
// by using the '*' as shown below:
63-
[assembly: AssemblyVersion("3.0.0.1")]
64-
[assembly: AssemblyFileVersion("3.0.0.1")]
63+
[assembly: AssemblyVersion("3.0.0.2")]
64+
[assembly: AssemblyFileVersion("3.0.0.2")]
6565
[assembly: AllowPartiallyTrustedCallers]

‎EPPlus/Table/ExcelTable.cs

+36-63
Original file line numberDiff line numberDiff line change
@@ -105,66 +105,6 @@ public enum TableStyles
105105
Dark9,
106106
Dark10,
107107
Dark11,
108-
//PivotStyleLight1,
109-
//PivotStyleLight2,
110-
//PivotStyleLight3,
111-
//PivotStyleLight4,
112-
//PivotStyleLight5,
113-
//PivotStyleLight6,
114-
//PivotStyleLight7,
115-
//PivotStyleLight8,
116-
//PivotStyleLight9,
117-
//PivotStyleLight10,
118-
//PivotStyleLight11,
119-
//PivotStyleLight12,
120-
//PivotStyleLight13,
121-
//PivotStyleLight14,
122-
//PivotStyleLight15,
123-
//PivotStyleLight16,
124-
//PivotStyleLight17,
125-
//PivotStyleLight18,
126-
//PivotStyleLight19,
127-
//PivotStyleLight20,
128-
//PivotStyleLight21,
129-
//PivotStyleMedium1,
130-
//PivotStyleMedium2,
131-
//PivotStyleMedium3,
132-
//PivotStyleMedium4,
133-
//PivotStyleMedium5,
134-
//PivotStyleMedium6,
135-
//PivotStyleMedium7,
136-
//PivotStyleMedium8,
137-
//PivotStyleMedium9,
138-
//PivotStyleMedium10,
139-
//PivotStyleMedium11,
140-
//PivotStyleMedium12,
141-
//PivotStyleMedium13,
142-
//PivotStyleMedium14,
143-
//PivotStyleMedium15,
144-
//PivotStyleMedium16,
145-
//PivotStyleMedium17,
146-
//PivotStyleMedium18,
147-
//PivotStyleMedium19,
148-
//PivotStyleMedium20,
149-
//PivotStyleMedium21,
150-
//PivotStyleMedium22,
151-
//PivotStyleMedium23,
152-
//PivotStyleMedium24,
153-
//PivotStyleMedium25,
154-
//PivotStyleMedium26,
155-
//PivotStyleMedium27,
156-
//PivotStyleMedium28
157-
//PivotStyleDark1,
158-
//PivotStyleDark2,
159-
//PivotStyleDark3,
160-
//PivotStyleDark4,
161-
//PivotStyleDark5,
162-
//PivotStyleDark6,
163-
//PivotStyleDark7,
164-
//PivotStyleDark8,
165-
//PivotStyleDark9,
166-
//PivotStyleDark10,
167-
//PivotStyleDark11
168108
}
169109
/// <summary>
170110
/// An Excel Table
@@ -286,7 +226,7 @@ internal int Id
286226
const string NAME_PATH = "@name";
287227
const string DISPLAY_NAME_PATH = "@displayName";
288228
/// <summary>
289-
/// Name of the table object in Excel
229+
/// The name of the table object in Excel
290230
/// </summary>
291231
public string Name
292232
{
@@ -328,6 +268,9 @@ public ExcelAddressBase Address
328268
internal set;
329269
}
330270
ExcelTableColumnCollection _cols = null;
271+
/// <summary>
272+
/// Collection of the columns in the table
273+
/// </summary>
331274
public ExcelTableColumnCollection Columns
332275
{
333276
get
@@ -341,7 +284,7 @@ public ExcelTableColumnCollection Columns
341284
}
342285
TableStyles _tableStyle = TableStyles.Medium6;
343286
/// <summary>
344-
/// The table style. If this property is cusom the style from the StyleName propery is used.
287+
/// The table style. If this property is cusom, the style from the StyleName propery is used.
345288
/// </summary>
346289
public TableStyles TableStyle
347290
{
@@ -360,6 +303,9 @@ public TableStyles TableStyle
360303
}
361304
const string HEADERROWCOUNT_PATH = "@headerRowCount";
362305
const string AUTOFILTER_PATH = "d:autoFilter/@ref";
306+
/// <summary>
307+
/// If the header row is visible or not
308+
/// </summary>
363309
public bool ShowHeader
364310
{
365311
get
@@ -418,7 +364,7 @@ private void WriteAutoFilter(bool showTotal)
418364
}
419365
}
420366
/// <summary>
421-
/// If the headerrow has an autofilter
367+
/// If the header row has an autofilter
422368
/// </summary>
423369
public bool ShowFilter
424370
{
@@ -447,6 +393,9 @@ public bool ShowFilter
447393
}
448394
const string TOTALSROWCOUNT_PATH = "@totalsRowCount";
449395
const string TOTALSROWSHOWN_PATH = "@totalsRowShown";
396+
/// <summary>
397+
/// If the total row is visible or not
398+
/// </summary>
450399
public bool ShowTotal
451400
{
452401
get
@@ -479,6 +428,9 @@ public bool ShowTotal
479428
}
480429
}
481430
const string STYLENAME_PATH = "d:tableStyleInfo/@name";
431+
/// <summary>
432+
/// The style name for custum styles
433+
/// </summary>
482434
public string StyleName
483435
{
484436
get
@@ -511,6 +463,9 @@ public string StyleName
511463
}
512464
}
513465
const string SHOWFIRSTCOLUMN_PATH = "d:tableStyleInfo/@showFirstColumn";
466+
/// <summary>
467+
/// Display special formatting for the first row
468+
/// </summary>
514469
public bool ShowFirstColumn
515470
{
516471
get
@@ -523,6 +478,9 @@ public bool ShowFirstColumn
523478
}
524479
}
525480
const string SHOWLASTCOLUMN_PATH = "d:tableStyleInfo/@showLastColumn";
481+
/// <summary>
482+
/// Display special formatting for the last row
483+
/// </summary>
526484
public bool ShowLastColumn
527485
{
528486
get
@@ -535,6 +493,9 @@ public bool ShowLastColumn
535493
}
536494
}
537495
const string SHOWROWSTRIPES_PATH = "d:tableStyleInfo/@showRowStripes";
496+
/// <summary>
497+
/// Display banded rows
498+
/// </summary>
538499
public bool ShowRowStripes
539500
{
540501
get
@@ -547,6 +508,9 @@ public bool ShowRowStripes
547508
}
548509
}
549510
const string SHOWCOLUMNSTRIPES_PATH = "d:tableStyleInfo/@showColumnStripes";
511+
/// <summary>
512+
/// Display banded columns
513+
/// </summary>
550514
public bool ShowColumnStripes
551515
{
552516
get
@@ -560,6 +524,9 @@ public bool ShowColumnStripes
560524
}
561525

562526
const string TOTALSROWCELLSTYLE_PATH = "@totalsRowCellStyle";
527+
/// <summary>
528+
/// Named style used for the total row
529+
/// </summary>
563530
public string TotalsRowCellStyle
564531
{
565532
get
@@ -581,6 +548,9 @@ public string TotalsRowCellStyle
581548
}
582549
}
583550
const string DATACELLSTYLE_PATH = "@dataCellStyle";
551+
/// <summary>
552+
/// Named style used for the data cells
553+
/// </summary>
584554
public string DataCellStyleName
585555
{
586556
get
@@ -605,6 +575,9 @@ public string DataCellStyleName
605575
}
606576
}
607577
const string HEADERROWCELLSTYLE_PATH = "@headerRowCellStyle";
578+
/// <summary>
579+
/// Named style used for the header row
580+
/// </summary>
608581
public string HeaderRowCellStyle
609582
{
610583
get

‎EPPlus/Table/ExcelTableCollection.cs

+8
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,9 @@ internal string GetNewTableName()
105105
}
106106
return name;
107107
}
108+
/// <summary>
109+
/// Number of items in the collection
110+
/// </summary>
108111
public int Count
109112
{
110113
get
@@ -144,6 +147,11 @@ public ExcelTable this[int Index]
144147
return _tables[Index];
145148
}
146149
}
150+
/// <summary>
151+
/// Indexer
152+
/// </summary>
153+
/// <param name="Name">The name of the table</param>
154+
/// <returns>The table. Null if the table name is not found in the collection</returns>
147155
public ExcelTable this[string Name]
148156
{
149157
get

‎EPPlus/Table/ExcelTableColumn.cs

+12-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ internal ExcelTableColumn(XmlNamespaceManager ns, XmlNode topNode, ExcelTable tb
6565
_tbl = tbl;
6666
Position = pos;
6767
}
68-
68+
/// <summary>
69+
/// The column id
70+
/// </summary>
6971
public int Id
7072
{
7173
get
@@ -77,11 +79,17 @@ public int Id
7779
SetXmlNodeString("@id", value.ToString());
7880
}
7981
}
82+
/// <summary>
83+
/// The position of the column
84+
/// </summary>
8085
public int Position
8186
{
8287
get;
8388
private set;
8489
}
90+
/// <summary>
91+
/// The name of the column
92+
/// </summary>
8593
public string Name
8694
{
8795
get
@@ -158,6 +166,9 @@ public string TotalsRowFormula
158166
}
159167
}
160168
const string DATACELLSTYLE_PATH = "@dataCellStyle";
169+
/// <summary>
170+
/// The named style for datacells in the column
171+
/// </summary>
161172
public string DataCellStyleName
162173
{
163174
get

‎EPPlus/Table/ExcelTableColumnCollection.cs

+11
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,17 @@ public ExcelTableColumnCollection(ExcelTable table)
5252
_colNames.Add(_cols[_cols.Count - 1].Name, _cols.Count - 1);
5353
}
5454
}
55+
/// <summary>
56+
/// A reference to the table object
57+
/// </summary>
5558
public ExcelTable Table
5659
{
5760
get;
5861
private set;
5962
}
63+
/// <summary>
64+
/// Number of items in the collection
65+
/// </summary>
6066
public int Count
6167
{
6268
get
@@ -80,6 +86,11 @@ public ExcelTableColumn this[int Index]
8086
return _cols[Index] as ExcelTableColumn;
8187
}
8288
}
89+
/// <summary>
90+
/// Indexer
91+
/// </summary>
92+
/// <param name="Name">The name of the table</param>
93+
/// <returns>The table column. Null if the table name is not found in the collection</returns>
8394
public ExcelTableColumn this[string Name]
8495
{
8596
get

‎EPPlus/Table/PivotTable/ExcelPivotTable.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ public ExcelWorksheet WorkSheet
310310
set;
311311
}
312312
/// <summary>
313-
/// The location of the pivott table
313+
/// The location of the pivot table
314314
/// </summary>
315315
public ExcelAddressBase Address
316316
{

‎EPPlus/Table/PivotTable/ExcelPivotTableDataField.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
namespace OfficeOpenXml.Table.PivotTable
3939
{
4040
/// <summary>
41-
///
41+
/// A pivo table data field
4242
/// </summary>
4343
public class ExcelPivotTableDataField : XmlHelper
4444
{

‎EPPlus/Table/PivotTable/ExcelPivotTableField.cs

+3
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,9 @@ public enum eSortType
126126
Ascending,
127127
Descending
128128
}
129+
/// <summary>
130+
/// A pivot table field.
131+
/// </summary>
129132
public class ExcelPivotTableField : XmlHelper
130133
{
131134
internal ExcelPivotTable _table;

‎EPPlus/Table/PivotTable/ExcelPivotTableFieldGroup.cs

+6
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@
3838

3939
namespace OfficeOpenXml.Table.PivotTable
4040
{
41+
/// <summary>
42+
/// Base class for pivot table field groups
43+
/// </summary>
4144
public class ExcelPivotTableFieldGroup : XmlHelper
4245
{
4346
internal ExcelPivotTableFieldGroup(XmlNamespaceManager ns, XmlNode topNode) :
@@ -99,6 +102,9 @@ public bool AutoEnd
99102
}
100103
}
101104
}
105+
/// <summary>
106+
/// A pivot table field numeric grouping
107+
/// </summary>
102108
public class ExcelPivotTableFieldNumericGroup : ExcelPivotTableFieldGroup
103109
{
104110
internal ExcelPivotTableFieldNumericGroup(XmlNamespaceManager ns, XmlNode topNode) :

0 commit comments

Comments
 (0)