Skip to content

Commit 9bd0fbf

Browse files
author
JanKallman
committed
Added UnderLineType to ExcelFont.
Documentation
1 parent 8773e4e commit 9bd0fbf

25 files changed

+325
-94
lines changed

‎EPPlus/Drawing/Chart/ExcelChartLegend.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@
3737

3838
namespace OfficeOpenXml.Drawing.Chart
3939
{
40+
/// <summary>
41+
/// Position of the legend
42+
/// </summary>
4043
public enum eLegendPosition
4144
{
4245
Top,
@@ -58,6 +61,9 @@ internal ExcelChartLegend(XmlNamespaceManager ns, XmlNode node, ExcelChart chart
5861
SchemaNodeOrder = new string[] { "legendPos", "layout","overlay", "txPr", "bodyPr", "lstStyle", "spPr" };
5962
}
6063
const string POSITION_PATH = "c:legendPos/@val";
64+
/// <summary>
65+
/// Position of the Legend
66+
/// </summary>
6167
public eLegendPosition Position
6268
{
6369
get
@@ -100,6 +106,9 @@ public eLegendPosition Position
100106
}
101107
}
102108
const string OVERLAY_PATH = "c:overlay/@val";
109+
/// <summary>
110+
/// If the legend overlays other objects
111+
/// </summary>
103112
public bool Overlay
104113
{
105114
get
@@ -113,6 +122,9 @@ public bool Overlay
113122
}
114123
}
115124
ExcelDrawingFill _fill = null;
125+
/// <summary>
126+
/// Fill style
127+
/// </summary>
116128
public ExcelDrawingFill Fill
117129
{
118130
get
@@ -125,6 +137,9 @@ public ExcelDrawingFill Fill
125137
}
126138
}
127139
ExcelDrawingBorder _border = null;
140+
/// <summary>
141+
/// Border style
142+
/// </summary>
128143
public ExcelDrawingBorder Border
129144
{
130145
get
@@ -137,6 +152,9 @@ public ExcelDrawingBorder Border
137152
}
138153
}
139154
ExcelTextFont _font = null;
155+
/// <summary>
156+
/// Font properties
157+
/// </summary>
140158
public ExcelTextFont Font
141159
{
142160
get
@@ -153,12 +171,18 @@ public ExcelTextFont Font
153171
return _font;
154172
}
155173
}
174+
/// <summary>
175+
/// Remove the legend
176+
/// </summary>
156177
public void Remove()
157178
{
158179
if (TopNode == null) return;
159180
TopNode.ParentNode.RemoveChild(TopNode);
160181
TopNode = null;
161182
}
183+
/// <summary>
184+
/// Add a legend to the chart
185+
/// </summary>
162186
public void Add()
163187
{
164188
if(TopNode!=null) return;

‎EPPlus/Drawing/Chart/ExcelChartSerieDataLabel.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@
3737

3838
namespace OfficeOpenXml.Drawing.Chart
3939
{
40+
/// <summary>
41+
/// Datalabel properties
42+
/// </summary>
4043
public sealed class ExcelChartSerieDataLabel : ExcelChartDataLabel
4144
{
4245
internal ExcelChartSerieDataLabel(XmlNamespaceManager ns, XmlNode node)

‎EPPlus/Drawing/Chart/ExcelChartTrendline.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ internal ExcelChartTrendlineCollection(ExcelChartSerie serie)
5757
/// Add a new trendline
5858
/// </summary>
5959
/// <param name="Type"></param>
60-
/// <returns></returns>
60+
/// <returns>The trendline</returns>
6161
public ExcelChartTrendline Add(eTrendLine Type)
6262
{
6363
if (_serie._chartSeries._chart.IsType3D() ||
@@ -102,6 +102,9 @@ System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator()
102102
return _list.GetEnumerator();
103103
}
104104
}
105+
/// <summary>
106+
/// A trendline object
107+
/// </summary>
105108
public class ExcelChartTrendline : XmlHelper
106109
{
107110
internal ExcelChartTrendline(XmlNamespaceManager namespaceManager, XmlNode topNode) :

‎EPPlus/Drawing/Chart/ExcelLineChart.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@
3939
namespace OfficeOpenXml.Drawing.Chart
4040
{
4141
/// <summary>
42-
/// A line chart
42+
/// Provides access to line chart specific properties
4343
/// </summary>
44-
public class ExcelLineChart : ExcelChart
44+
public class ExcelLineChart : ExcelChart
4545
{
4646
#region "Constructors"
4747
internal ExcelLineChart(ExcelDrawings drawings, XmlNode node, Uri uriChart, PackagePart part, XmlDocument chartXml, XmlNode chartNode) :

‎EPPlus/Drawing/Chart/ExcelOfPieChart.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
namespace OfficeOpenXml.Drawing.Chart
4040
{
4141
/// <summary>
42-
/// Provides access to pie chart specific properties
42+
/// Provides access to ofpie-chart specific properties
4343
/// </summary>
4444
public class ExcelOfPieChart : ExcelPieChart
4545
{

‎EPPlus/Drawing/Chart/ExcelPieChart.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@
3838

3939
namespace OfficeOpenXml.Drawing.Chart
4040
{
41-
41+
/// <summary>
42+
/// Provides access to pie chart specific properties
43+
/// </summary>
4244
public class ExcelPieChart : ExcelChart
4345
{
4446
internal ExcelPieChart(ExcelDrawings drawings, XmlNode node, eChartType type, bool isPivot) :

‎EPPlus/Drawing/ExcelView3D.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ public sealed class ExcelView3D : XmlHelper
4545
internal ExcelView3D(XmlNamespaceManager ns, XmlNode node)
4646
: base(ns,node)
4747
{
48-
//SchemaNodeOrder = new string[] { "rotX", "rotY", "perspective" };
4948
SchemaNodeOrder = new string[] { "rotX", "hPercent", "rotY", "depthPercent","rAngAx", "perspective"};
5049
}
5150
const string perspectivePath = "c:perspective/@val";

‎EPPlus/ExcelPrinterSettings.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,13 @@ namespace OfficeOpenXml
4343
/// </summary>
4444
public enum eOrientation
4545
{
46+
/// <summary>
47+
/// Portrait orientation
48+
/// </summary>
4649
Portrait,
50+
/// <summary>
51+
/// Landscape orientation
52+
/// </summary>
4753
Landscape
4854
}
4955
/// <summary>

‎EPPlus/ExcelSheetProtection.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,9 @@ public bool AllowSort
273273
}
274274

275275
private const string _allowAutoFilterPath = "d:sheetProtection/@autoFilter";
276+
/// <summary>
277+
/// Allow users to use autofilters
278+
/// </summary>
276279
public bool AllowAutoFilter
277280
{
278281
get
@@ -285,6 +288,9 @@ public bool AllowAutoFilter
285288
}
286289
}
287290
private const string _allowPivotTablesPath = "d:sheetProtection/@pivotTables";
291+
/// <summary>
292+
/// Allow users to use pivottables
293+
/// </summary>
288294
public bool AllowPivotTables
289295
{
290296
get

‎EPPlus/ExcelTextFormat.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
namespace OfficeOpenXml
3838
{
3939
/// <summary>
40-
/// Discribes a column
40+
/// Discribes a column when reading a text using the ExcelRangeBase.LoadFromText method
4141
/// </summary>
4242
public enum eDataTypes
4343
{
@@ -58,7 +58,8 @@ public enum eDataTypes
5858
/// </summary>
5959
DateTime,
6060
/// <summary>
61-
/// Try to convert it to a number and divide with 100. Removes any tailing percent sign (%). If it fails then add it as a string.
61+
/// Try to convert it to a number and divide with 100.
62+
/// Removes any tailing percent sign (%). If it fails then add it as a string.
6263
/// </summary>
6364
Percent
6465
}
@@ -111,7 +112,7 @@ public ExcelTextFormat()
111112
/// </summary>
112113
public eDataTypes[] DataTypes { get; set; }
113114
/// <summary>
114-
/// Culture used when parsing.Default CultureInfo.InvariantCulture
115+
/// Culture used when parsing. Default CultureInfo.InvariantCulture
115116
/// </summary>
116117
public CultureInfo Culture {get; set; }
117118
/// <summary>

0 commit comments

Comments
 (0)