Skip to content

Commit b208693

Browse files
author
JanKallman
committed
Added fix for 14728. Added Delete methods to Drawings collection.
Fixed problem with address changes. XML documentation.
1 parent 8dd43f0 commit b208693

40 files changed

+469
-145
lines changed

Doc/EPPlusDoc.shfbproj

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
<FrameworkVersion>.NET 3.5</FrameworkVersion>
2121
<DocumentationSources>
2222
<DocumentationSource sourceFile="..\EPPlus\bin\Release\EPPlus.dll" />
23-
<DocumentationSource sourceFile="..\EPPlus\bin\Release\EPPlus.XML" /></DocumentationSources>
23+
<DocumentationSource sourceFile="..\EPPlus\bin\Release\EPPlus.XML" />
24+
</DocumentationSources>
2425
<ProjectSummary>EPPlus is a .net library that reads and writes Excel files using the Open Office Xml format.
2526
EPPlus supports ranges, cell styling, charts, picture, shapes, named ranges, comments,tables and a lot of other stuff.
2627
EPPlus started with the source from the ExcelPackage project hosted on CodePlex.</ProjectSummary>
@@ -30,14 +31,17 @@ EPPlus started with the source from the ExcelPackage project hosted on CodePlex.
3031
<NamespaceSummaryItem name="OfficeOpenXml.Drawing.Chart" isDocumented="True">Contains chart classes</NamespaceSummaryItem>
3132
<NamespaceSummaryItem name="OfficeOpenXml.Style" isDocumented="True">Contains classes for cell styling and named styles</NamespaceSummaryItem>
3233
<NamespaceSummaryItem name="OfficeOpenXml.Style.XmlAccess" isDocumented="True">Contains the classes that write the style xml</NamespaceSummaryItem>
33-
<NamespaceSummaryItem name="OfficeOpenXml.Drawing.Vml" isDocumented="True">Contains classes used for Vml drawings. Vml drawings are used for comments</NamespaceSummaryItem>
34+
<NamespaceSummaryItem name="OfficeOpenXml.Drawing.Vml" isDocumented="True">Contains classes used for Vml drawings. Vml drawings are used for comments and background images</NamespaceSummaryItem>
3435
<NamespaceSummaryItem name="OfficeOpenXml.Table" isDocumented="True">Contains the classes used for Excel tables</NamespaceSummaryItem>
3536
<NamespaceSummaryItem name="OfficeOpenXml.DataValidation" isDocumented="True">Contains classes for Datavalidation</NamespaceSummaryItem>
3637
<NamespaceSummaryItem name="OfficeOpenXml.Table.PivotTable" isDocumented="True">Contains classes for Excel Pivottables</NamespaceSummaryItem>
3738
<NamespaceSummaryItem name="OfficeOpenXml.Utils" isDocumented="True">Internal utility classes</NamespaceSummaryItem>
3839
<NamespaceSummaryItem name="OfficeOpenXml.ConditionalFormatting" isDocumented="True">Contains classes for Conditional Formatting</NamespaceSummaryItem>
3940
<NamespaceSummaryItem name="OfficeOpenXml.Style.Dxf" isDocumented="True">Contains classes for differential styling. EPPlus only support dxf styling in conditional formatting at this point</NamespaceSummaryItem>
40-
<NamespaceSummaryItem name="OfficeOpenXml.VBA" isDocumented="True">Contains classes for Excel VBA support</NamespaceSummaryItem></NamespaceSummaries>
41+
<NamespaceSummaryItem name="OfficeOpenXml.VBA" isDocumented="True">Contains classes for Excel VBA support</NamespaceSummaryItem>
42+
<NamespaceSummaryItem name="OfficeOpenXml.ConditionalFormatting.Contracts" isDocumented="True">Contains interfaces for Conditional formatting</NamespaceSummaryItem>
43+
<NamespaceSummaryItem name="OfficeOpenXml.DataValidation.Contracts" isDocumented="True">Contains interfaces for data validation</NamespaceSummaryItem>
44+
<NamespaceSummaryItem name="OfficeOpenXml.DataValidation.Formulas.Contracts" isDocumented="True">Contains interfaces for data validation formulas</NamespaceSummaryItem></NamespaceSummaries>
4145
<HelpTitle>EPPlus 3.1</HelpTitle>
4246
<VisibleItems>InheritedMembers, InheritedFrameworkMembers</VisibleItems>
4347
<BuildLogFile />

EPPlus/ConditionalFormatting/Contracts/IRangeConditionalFormatting.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,13 +286,13 @@ public interface IRangeConditionalFormatting
286286
IExcelConditionalFormattingTwoColorScale AddTwoColorScale();
287287

288288
/// <summary>
289-
/// Adds a <see cref="IExcelConditionalFormattingThreeIconSet"/> to the range
289+
/// Adds a <see cref="IExcelConditionalFormattingThreeIconSet<eExcelconditionalFormatting3IconsSetType>"/> to the range
290290
/// </summary>
291291
/// <param name="IconSet"></param>
292292
/// <returns></returns>
293293
IExcelConditionalFormattingThreeIconSet<eExcelconditionalFormatting3IconsSetType> AddThreeIconSet(eExcelconditionalFormatting3IconsSetType IconSet);
294294
/// <summary>
295-
/// Adds a <see cref="IExcelConditionalFormattingFourIconSet"/> to the range
295+
/// Adds a <see cref="IExcelConditionalFormattingFourIconSet<eExcelconditionalFormatting4IconsSetType>"/> to the range
296296
/// </summary>
297297
/// <param name="IconSet"></param>
298298
/// <returns></returns>

EPPlus/ConditionalFormatting/ExcelConditionalFormattingValueObjectType.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,6 @@ public static int GetOrderByPosition(
7777
/// Get the CFVO type by its @type attribute
7878
/// </summary>
7979
/// <param name="attribute"></param>
80-
/// <param name="topNode"></param>
81-
/// <param name="nameSpaceManager"></param>
8280
/// <returns></returns>
8381
public static eExcelConditionalFormattingValueObjectType GetTypeByAttrbiute(
8482
string attribute)

EPPlus/ConditionalFormatting/RangeConditionalFormatting.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ public IExcelConditionalFormattingFiveIconSet AddFiveIconSet(eExcelconditionalFo
516516
/// <summary>
517517
/// Adds a Databar rule
518518
/// </summary>
519-
/// <param name="IconSet"></param>
519+
/// <param name="Color">The color of the databar</param>
520520
/// <returns></returns>
521521
public IExcelConditionalFormattingDataBarGroup AddDatabar(System.Drawing.Color Color)
522522
{

EPPlus/ConditionalFormatting/Rules/ExcelConditionalFormattingUniqueValues.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,8 @@ public class ExcelConditionalFormattingUniqueValues
5151
/// <summary>
5252
///
5353
/// </summary>
54-
/// <param name="type"></param>
55-
/// <param name="priority"></param>
5654
/// <param name="address"></param>
55+
/// <param name="priority"></param>
5756
/// <param name="worksheet"></param>
5857
/// <param name="itemElementNode"></param>
5958
/// <param name="namespaceManager"></param>

EPPlus/Drawing/Chart/ExcelChart.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,9 @@ public enum eChartStyle
262262
Style47,
263263
Style48
264264
}
265+
/// <summary>
266+
/// Type of Trendline for a chart
267+
/// </summary>
265268
public enum eTrendLine
266269
{
267270
/// <summary>
@@ -1781,5 +1784,21 @@ internal void SetPivotSource(ExcelPivotTable pivotTableSource)
17811784

17821785
Series.AddPivotSerie(pivotTableSource);
17831786
}
1787+
internal override void DeleteMe()
1788+
{
1789+
try
1790+
{
1791+
foreach (var rel in Part.GetRelationships())
1792+
{
1793+
Part.DeleteRelationship(rel.Id);
1794+
}
1795+
Part.Package.DeletePart(UriChart);
1796+
}
1797+
catch (Exception ex)
1798+
{
1799+
throw (new InvalidDataException("EPPlus internal error when deleteing chart.", ex));
1800+
}
1801+
base.DeleteMe();
1802+
}
17841803
}
17851804
}

EPPlus/Drawing/Chart/ExcelChartAxis.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,35 @@
3737
using System.Globalization;
3838
namespace OfficeOpenXml.Drawing.Chart
3939
{
40+
/// <summary>
41+
/// Position of the axis.
42+
/// </summary>
4043
public enum eAxisPosition
4144
{
4245
Left = 0,
4346
Bottom = 1,
4447
Right = 2,
4548
Top = 3
4649
}
50+
/// <summary>
51+
/// Position of the Y-Axis
52+
/// </summary>
4753
public enum eYAxisPosition
4854
{
4955
Left = 0,
5056
Right = 2,
5157
}
58+
/// <summary>
59+
/// Position of the X-Axis
60+
/// </summary>
5261
public enum eXAxisPosition
5362
{
5463
Bottom = 1,
5564
Top = 3
5665
}
66+
/// <summary>
67+
/// Axis orientaion
68+
/// </summary>
5769
public enum eAxisOrientation
5870
{
5971
MaxMin,
@@ -405,6 +417,9 @@ public eTickLabelPosition TickLabelPosition
405417
}
406418
}
407419
ExcelChartTitle _title = null;
420+
/// <summary>
421+
/// Chart axis title
422+
/// </summary>
408423
public ExcelChartTitle Title
409424
{
410425
get

EPPlus/Drawing/Chart/ExcelChartSeries.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@
3838
using OfficeOpenXml.Table.PivotTable;
3939
namespace OfficeOpenXml.Drawing.Chart
4040
{
41-
public sealed class ExcelChartSeries : XmlHelper, IEnumerable
41+
/// <summary>
42+
/// Collection class for chart series
43+
/// </summary>
44+
public sealed class ExcelChartSeries : XmlHelper, IEnumerable
4245
{
4346
List<ExcelChartSerie> _list=new List<ExcelChartSerie>();
4447
internal ExcelChart _chart;

EPPlus/Drawing/ExcelDrawingBase.cs

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@
3737
using OfficeOpenXml.Drawing.Chart;
3838
namespace OfficeOpenXml.Drawing
3939
{
40+
/// <summary>
41+
/// Text anchoring
42+
/// </summary>
4043
public enum eTextAnchoringType
4144
{
4245
Bottom,
@@ -45,6 +48,9 @@ public enum eTextAnchoringType
4548
Justify,
4649
Top
4750
}
51+
/// <summary>
52+
/// Vertical text type
53+
/// </summary>
4854
public enum eTextVerticalType
4955
{
5056
EastAsianVertical,
@@ -56,6 +62,9 @@ public enum eTextVerticalType
5662
WordArtVerticalRightToLeft
5763

5864
}
65+
/// <summary>
66+
/// How the drawing will be resized.
67+
/// </summary>
5968
public enum eEditAs
6069
{
6170
/// <summary>
@@ -86,7 +95,6 @@ public class ExcelDrawing : XmlHelper
8695
{
8796
/// <summary>
8897
/// Position of the a drawing.
89-
///
9098
/// </summary>
9199
public class ExcelPosition : XmlHelper
92100
{
@@ -634,5 +642,9 @@ internal static eTextVerticalType GetTextVerticalEnum(string text)
634642
return eTextVerticalType.Horizontal;
635643
}
636644
}
645+
internal virtual void DeleteMe()
646+
{
647+
TopNode.ParentNode.RemoveChild(TopNode);
648+
}
637649
}
638650
}

EPPlus/Drawing/ExcelDrawingBorder.cs

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

3838
namespace OfficeOpenXml.Drawing
3939
{
40+
/// <summary>
41+
/// Type of Line cap
42+
/// </summary>
4043
public enum eLineCap
4144
{
4245
Flat, //flat
4346
Round, //rnd
4447
Square //Sq
4548
}
49+
/// <summary>
50+
/// Line style.
51+
/// </summary>
4652
public enum eLineStyle
4753
{
4854
Dash,

0 commit comments

Comments
 (0)