开源 DocumentFormat.OpenXml.Flatten 库

Author: lindexi

Directory.Build.props

@@ -11,6 +11,6 @@
     <Description>A dotnet tool to assist in editing Office document files</Description>
 
     <RepositoryType>git</RepositoryType>
-    <Copyright>Copyright © 2020 dotnet campus, All Rights Reserved.</Copyright> 
+    <Copyright>Copyright © 2020-2021 dotnet campus, All Rights Reserved.</Copyright> 
   </PropertyGroup>
 </Project>

README.md

@@ -36,7 +36,8 @@ OfficeDocumentZipper
 |--|--|
 |dotnetCampus.OpenXMLUnitConverter|[![](https://img.shields.io/nuget/v/dotnetCampus.OpenXMLUnitConverter.svg)](https://www.nuget.org/packages/dotnetCampus.OpenXMLUnitConverter)|
 |dotnetCampus.OpenXMLUnitConverter.Source|[![](https://img.shields.io/nuget/v/dotnetCampus.OpenXMLUnitConverter.Source.svg)](https://www.nuget.org/packages/dotnetCampus.OpenXMLUnitConverter.Source)|
-
+|dotnetCampus.DocumentFormat.OpenXml.Flatten|[![](https://img.shields.io/nuget/v/dotnetCampus.DocumentFormat.OpenXml.Flatten.svg)](https://www.nuget.org/packages/dotnetCampus.DocumentFormat.OpenXml.Flatten)|
+|dotnetCampus.DocumentFormat.OpenXml.Flatten.Source|[![](https://img.shields.io/nuget/v/dotnetCampus.DocumentFormat.OpenXml.Flatten.Source.svg)](https://www.nuget.org/packages/dotnetCampus.DocumentFormat.OpenXml.Flatten.Source)|
 
 ## dotnetCampus.OpenXMLUnitConverter
 
@@ -47,13 +48,13 @@ Defining units for OpenXml properties and the unit conversion function.
 DLL Pakcage:
 
 ```xml
-<PackageReference Include="dotnetCampus.OpenXmlUnitConverter" Version="1.8.0" />
+<PackageReference Include="dotnetCampus.OpenXmlUnitConverter" Version="1.9.0" />
 ```
 
 [SouceYard](https://github.com/dotnet-campus/SourceYard) Package:
 
 ```xml
-<PackageReference Include="dotnetCampus.OpenXmlUnitConverter.Source" Version="1.8.0">
+<PackageReference Include="dotnetCampus.OpenXmlUnitConverter.Source" Version="1.9.0">
   <PrivateAssets>all</PrivateAssets>
   <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
 </PackageReference>
@@ -72,6 +73,30 @@ void Foo(DocumentFormat.OpenXml.Drawing.Point2DType point)
 }
 ```
 
+## DocumentFormat.OpenXml.Flatten
+
+### Install
+
+DLL Pakcage:
+
+```xml
+<PackageReference Include="dotnetCampus.DocumentFormat.OpenXml.Flatten" Version="2.0.0" />
+```
+
+[SouceYard](https://github.com/dotnet-campus/SourceYard) Package:
+
+```xml
+<PackageReference Include="dotnetCampus.DocumentFormat.OpenXml.Flatten.Source" Version="2.0.0">
+  <PrivateAssets>all</PrivateAssets>
+  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+</PackageReference>
+```
+
+### Usage
+
+See [DocumentFormat.OpenXml.Flatten README.md](src/DocumentFormat.OpenXml.Flatten/README.md)
+
+
 # Thanks
 
 - [OfficeDev/Open-XML-SDK: Open XML SDK by Microsoft](https://github.com/OfficeDev/Open-XML-SDK/ )

README.zh-cn.md

@@ -53,13 +53,13 @@ OfficeDocumentZipper
 DLL 包:
 
 ```xml
-<PackageReference Include="dotnetCampus.OpenXmlUnitConverter" Version="1.8.0" />
+<PackageReference Include="dotnetCampus.OpenXmlUnitConverter" Version="1.9.0" />
 ```
 
 [SouceYard](https://github.com/dotnet-campus/SourceYard) 源代码包:
 
 ```xml
-<PackageReference Include="dotnetCampus.OpenXmlUnitConverter.Source" Version="1.8.0">
+<PackageReference Include="dotnetCampus.OpenXmlUnitConverter.Source" Version="1.9.0">
   <PrivateAssets>all</PrivateAssets>
   <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
 </PackageReference>
@@ -80,6 +80,31 @@ void Foo(DocumentFormat.OpenXml.Drawing.Point2DType point)
 
 详细请看 [Office Open XML 的测量单位](https://blog.lindexi.com/post/Office-Open-XML-%E7%9A%84%E6%B5%8B%E9%87%8F%E5%8D%95%E4%BD%8D.html )
 
+## DocumentFormat.OpenXml.Flatten
+
+提供继承的属性拍平的功能的库，包含常用处理逻辑和计算逻辑
+
+### 安装方法
+
+DLL 包:
+
+```xml
+<PackageReference Include="dotnetCampus.DocumentFormat.OpenXml.Flatten" Version="2.0.0" />
+```
+
+[SouceYard](https://github.com/dotnet-campus/SourceYard) 源代码包:
+
+```xml
+<PackageReference Include="dotnetCampus.DocumentFormat.OpenXml.Flatten.Source" Version="2.0.0">
+  <PrivateAssets>all</PrivateAssets>
+  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+</PackageReference>
+```
+
+### 使用方法
+
+具体使用方法请参阅 [DocumentFormat.OpenXml.Flatten 使用文档](src/DocumentFormat.OpenXml.Flatten/README.md)
+
 # 感谢
 
 - [OfficeDev/Open-XML-SDK: Open XML SDK by Microsoft](https://github.com/OfficeDev/Open-XML-SDK/ )

dotnetCampus.OfficeDocumentZipper.sln

@@ -1,10 +1,8 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.30204.135
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.31903.59
 MinimumVisualStudioVersion = 15.0.26124.0
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{5D196596-756D-45C2-8A05-C8E4AB8A36E6}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "dotnetCampus.OfficeDocumentZipper", "src\dotnetCampus.OfficeDocumentZipper\dotnetCampus.OfficeDocumentZipper.csproj", "{EF60ACE4-91B3-4731-8530-F3CD922E922D}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{A80DBE61-A86F-4F1E-B638-999F15ED9EE3}"
@@ -14,15 +12,25 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		CHANGELOG.md = CHANGELOG.md
 		Directory.Build.props = Directory.Build.props
 		README.md = README.md
+		README.zh-cn.md = README.zh-cn.md
 		build\Version.props = build\Version.props
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "dotnetCampus.OpenXmlUnitConverter", "src\dotnetCampus.OpenXmlUnitConverter\dotnetCampus.OpenXmlUnitConverter.csproj", "{DFF5A479-FCEE-431D-85C6-8E0D03E64F46}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{66E18386-803A-464D-9006-2EFD364FE97C}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "dotnetCampus.OpenXMLUnitConverter.Tests", "tests\dotnetCampus.OpenXMLUnitConverter.Tests\dotnetCampus.OpenXMLUnitConverter.Tests.csproj", "{86010F5E-F7FD-40C9-96D7-491356A90139}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "DocumentFormat.OpenXml.Flatten", "DocumentFormat.OpenXml.Flatten", "{1DCDA9B1-ED7A-4825-BBA3-E3561006E4AF}"
+	ProjectSection(SolutionItems) = preProject
+		src\DocumentFormat.OpenXml.Flatten\README.md = src\DocumentFormat.OpenXml.Flatten\README.md
+	EndProjectSection
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "dotnetCampus.DocumentFormat.OpenXml.Flatten", "src\DocumentFormat.OpenXml.Flatten\DocumentFormat.OpenXml.Flatten\dotnetCampus.DocumentFormat.OpenXml.Flatten.csproj", "{6003FD01-7DC7-4F99-8878-7AE3ABF40BE6}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tool", "Tool", "{8A1ED232-9A93-4D88-AC6D-3E3D4EA98FAD}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "OpenXmlUnitConverter", "OpenXmlUnitConverter", "{D0552FF1-B2AE-4878-B6B7-F792C326371C}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -41,14 +49,19 @@ Global
 		{86010F5E-F7FD-40C9-96D7-491356A90139}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{86010F5E-F7FD-40C9-96D7-491356A90139}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{86010F5E-F7FD-40C9-96D7-491356A90139}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6003FD01-7DC7-4F99-8878-7AE3ABF40BE6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6003FD01-7DC7-4F99-8878-7AE3ABF40BE6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6003FD01-7DC7-4F99-8878-7AE3ABF40BE6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6003FD01-7DC7-4F99-8878-7AE3ABF40BE6}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
-		{EF60ACE4-91B3-4731-8530-F3CD922E922D} = {5D196596-756D-45C2-8A05-C8E4AB8A36E6}
-		{DFF5A479-FCEE-431D-85C6-8E0D03E64F46} = {5D196596-756D-45C2-8A05-C8E4AB8A36E6}
-		{86010F5E-F7FD-40C9-96D7-491356A90139} = {66E18386-803A-464D-9006-2EFD364FE97C}
+		{EF60ACE4-91B3-4731-8530-F3CD922E922D} = {8A1ED232-9A93-4D88-AC6D-3E3D4EA98FAD}
+		{DFF5A479-FCEE-431D-85C6-8E0D03E64F46} = {D0552FF1-B2AE-4878-B6B7-F792C326371C}
+		{86010F5E-F7FD-40C9-96D7-491356A90139} = {D0552FF1-B2AE-4878-B6B7-F792C326371C}
+		{6003FD01-7DC7-4F99-8878-7AE3ABF40BE6} = {1DCDA9B1-ED7A-4825-BBA3-E3561006E4AF}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {90F871FB-EAC2-449B-8601-3562C03CC566}

src/DocumentFormat.OpenXml.Flatten/DocumentFormat.OpenXml.Flatten/Contexts/EmuShapeTextRectangle.cs

@@ -0,0 +1,86 @@
+using DocumentFormat.OpenXml.Flatten.ElementConverters.CommonElement;
+
+using dotnetCampus.OpenXmlUnitConverter;
+
+namespace DocumentFormat.OpenXml.Flatten.Contexts
+{
+    /// <summary>
+    /// 使用 Emu 单位的形状里的文本范围,对应 OpenXml Shape 的 a:rect 标签
+    /// </summary>
+    public readonly struct EmuShapeTextRectangle
+    {
+        /// <summary>
+        /// 创建形状里的文本范围
+        /// </summary>
+        public EmuShapeTextRectangle(Emu left, Emu top, Emu right, Emu bottom)
+        {
+            var emuWidth = new Emu(right.Value - left.Value);
+            var emuHeight = new Emu(bottom.Value - top.Value);
+
+            OriginPoint = new EmuPoint(left, top);
+            Size = new EmuSize(emuWidth, emuHeight);
+        }
+
+        /// <summary>
+        /// 创建形状里的文本范围
+        /// </summary>
+        /// <param name="size">形状文本框的大小</param>
+        /// <param name="originPoint">形状文本框的原点坐标</param>
+        public EmuShapeTextRectangle(EmuSize size, EmuPoint originPoint)
+        {
+            Size = size;
+            OriginPoint = originPoint;
+        }
+
+        /// <summary>
+        /// 形状文本框的坐标原点
+        /// </summary>
+        public EmuPoint OriginPoint { get; }
+
+        /// <summary>
+        /// Rectangle的大小
+        /// </summary>
+        public EmuSize Size { get; }
+    }
+
+    /// <summary>
+    /// Emu单位的形状文本框的Margin
+    /// </summary>
+    public readonly struct EmuTextMargin
+    {
+        /// <summary>
+        /// 创建EmuTextMargin
+        /// </summary>
+        /// <param name="emuLeftInset">emu单位的LeftInset</param>
+        /// <param name="emuTopInset">emu单位的TopInset</param>
+        /// <param name="emuRightInset">emu单位的RightInset</param>
+        /// <param name="emuBottomInset">emu单位的BottomInset</param>
+        public EmuTextMargin(double emuLeftInset, double emuTopInset, double emuRightInset, double emuBottomInset)
+        {
+            LeftInset = new Emu(emuLeftInset);
+            TopInset = new Emu(emuTopInset);
+            RightInset = new Emu(emuRightInset);
+            BottomInset = new Emu(emuBottomInset);
+        }
+
+        /// <summary>
+        /// 对应 a:bodyPr lIns
+        /// </summary>
+        public Emu LeftInset { get; }
+
+        /// <summary>
+        /// 对应 a:bodyPr rIns
+        /// </summary>
+        public Emu RightInset { get; }
+
+        /// <summary>
+        /// 对应 a:bodyPr bIns
+        /// </summary>
+        public Emu BottomInset { get; }
+
+        /// <summary>
+        /// 对应 a:bodyPr tIns
+        /// </summary>
+        public Emu TopInset { get; }
+    }
+}

src/DocumentFormat.OpenXml.Flatten/DocumentFormat.OpenXml.Flatten/Contexts/GeometryPath.cs

@@ -0,0 +1,78 @@
+using DocumentFormat.OpenXml.Drawing;
+
+using dotnetCampus.OpenXmlUnitConverter;
+
+namespace DocumentFormat.OpenXml.Flatten.Contexts
+{
+    /// <summary>
+    /// 对应PPT的Shape Path
+    /// </summary>
+    public readonly struct ShapePath
+    {
+        /// <summary>
+        /// 创建PPT的Geometry Path
+        /// </summary>
+        /// <param name="path">OpenXml  Path字符串</param>
+        /// <param name="fillMode">OpenXml的Path Fill Mode  </param>
+        /// <param name="isStroke">是否有轮廓</param>
+        /// <param name="isExtrusionOk">指定使用 3D 拉伸可能在此路径</param>
+        /// <param name="emuWidth">指定的宽度或在路径坐标系统中应在使用的最大的 x 坐标</param>
+        /// <param name="emuHeight">指定框架的高度或在路径坐标系统中应在使用的最大的 y 坐标</param>
+        public ShapePath(string path, PathFillModeValues fillMode = PathFillModeValues.Norm, bool isStroke = true, bool isExtrusionOk = false, double emuWidth = 0, double emuHeight = 0)
+        {
+            Path = path;
+            IsStroke = isStroke;
+            FillMode = fillMode;
+            IsFilled = fillMode is not PathFillModeValues.None;
+            IsExtrusionOk = isExtrusionOk;
+            Width = new Emu(emuWidth);
+            Height = new Emu(emuHeight);
+        }
+
+        /// <summary>
+        /// 创建PPT的Geometry Path
+        /// </summary>
+        /// <param name="path">OpenXml  Path字符串</param>
+        /// <param name="eumWidth">指定的宽度或在路径坐标系统中应在使用的最大的 x 坐标</param>
+        /// <param name="eumHeight">指定框架的高度或在路径坐标系统中应在使用的最大的 y 坐标</param>
+        public ShapePath(string path, double eumWidth, double eumHeight) : this(path, PathFillModeValues.Norm, emuWidth: eumWidth, emuHeight: eumHeight)
+        {
+
+        }
+
+        /// <summary>
+        /// 是否填充
+        /// </summary>
+        public bool IsFilled { get; }
+
+        /// <summary>
+        /// OpenXml 的 Path Stroke, 默认true
+        /// </summary>
+        public bool IsStroke { get; }
+
+        /// <summary>
+        /// OpenXml的Path Fill Mode  
+        /// </summary>
+        public PathFillModeValues FillMode { get; }
+
+        /// <summary>
+        ///OpenXml  Path字符串
+        /// </summary>
+        public string Path { get; }
+
+        /// <summary>
+        /// 指定使用 3D 拉伸可能在此路径，默认false或0
+        /// </summary>
+        public bool IsExtrusionOk { get; }
+
+        /// <summary>
+        /// 指定的宽度或在路径坐标系统中应在使用的最大的 x 坐标。默认是 0 的值
+        /// </summary>
+        public Emu Width { get; }
+
+        /// <summary>
+        /// 指定框架的高度或在路径坐标系统中应在使用的最大的 y 坐标。默认是 0 的值
+        /// </summary>
+        public Emu Height { get; }
+    }
+}

src/DocumentFormat.OpenXml.Flatten/DocumentFormat.OpenXml.Flatten/Contexts/SlideEmuSize.cs

@@ -0,0 +1,30 @@
+using dotnetCampus.OpenXmlUnitConverter;
+
+namespace DocumentFormat.OpenXml.Flatten.Contexts
+{
+    /// <summary>
+    /// 页面的使用 EMU 单位表示的 Size 尺寸
+    /// </summary>
+    public readonly struct SlideEmuSize
+    {
+        /// <summary>
+        /// 创建使用 EMU 单位表示的 Size 尺寸
+        /// </summary>
+        /// <param name="width"></param>
+        /// <param name="height"></param>
+        public SlideEmuSize(Emu width, Emu height)
+        {
+            Width = width;
+            Height = height;
+        }
+
+        /// <summary>
+        /// 宽度
+        /// </summary>
+        public Emu Width { get; }
+        /// <summary>
+        /// 高度
+        /// </summary>
+        public Emu Height { get; }
+    }
+}