.NET中开源文档操作组件DocX的介绍与使用
前言
相信大家应该都有所体会，在目前的软件项目中，都会较多的使用到对文档的操作，用于记录和统计相关业务信息。由于系统自身提供了对文档的相关操作，所以在一定程度上极大的简化了软件使用者的工作量。
在.NET项目中如果用户提出了相关文档操作的需求，开发者较多的会使用到微软自行提供的插件，在一定程度上简化了开发人员的工作量，但是同时也给用户带来了一些困扰，例如需要安装庞大的office，在用户体验性就会降低很多，并且在国内，很多人都还是使用wps，这就导致一部分只安装了wps的使用者很是为难，在对Excel的操作方面，有一个NPOI组件。那么可能会有人问有没有什么办法让这些困扰得到解决，答案是肯定的，那就是今天需要介绍的“DocX”组件，接下来我们就来了解一下这个组件的功能和用法。
一.DocX组件概述：
DocX是一个.NET库，允许开发人员以简单直观的方式处理Word2007/2010/2013文件。DocX是快速，轻量级，最好的是它不需要安装MicrosoftWord或Office。DocX组件不仅可以完成对文档的一般要求，例如创建文档，创建表格和文本，并且还可以创建图形报表。DocX使创建和操作文档成为一个简单的任务。
它不使用COM库，也不需要安装MicrosoftOffice。在使用DocX组件时，你需要安装为了使用DocX是.NET框架4.0和VisualStudio2010或更高版本。
DocX的主要特点：
(1).在文档中插入，删除或替换文本。所有标准文本格式都可用。字体{系列，大小，颜色}，粗体，斜体，下划线，删除线，脚本{子，超级}，突出显示。
(2).段落属性显示。方向LeftToRight或RightToLeft;缩进;比对。
(3).DocX也支持:图片，超链接，表，页眉和页脚，自定义属性。
有关DocX组件的相关信息就介绍到这里，如果需要更加深入的了解相关信息，可以进入：https://docx.codeplex.com/。
二.DocX相关类和方法解析：
本文将结合DocX的源码进行解析，使用.NETReflector对DLL文件进行反编译，以此查看源代码。将DLL文件加入.NETReflector中，点击打开文件。
1.DocX.Create()：创建文档。
publicstaticDocXCreate(Streamstream)
{
MemoryStreamstream2=newMemoryStream();
PostCreation(refPackage.Open(stream2,FileMode.Create,FileAccess.ReadWrite));
DocXcx=Load(stream2);
cx.stream=stream;
returncx;
}
2.Paragraph.Append：向段落添加信息。
publicParagraphAppend(stringtext)
{
List<XElement>content=HelperFunctions.FormatInput(text,null);
base.Xml.Add(content);
this.runs=base.Xml.Elements(XName.Get("r",DocX.w.NamespaceName)).Reverse<XElement>().Take<XElement>(content.Count<XElement>()).ToList<XElement>();
returnthis;
}
publicParagraphBold()
{
this.ApplyTextFormattingProperty(XName.Get("b",DocX.w.NamespaceName),string.Empty,null);
returnthis;
}
3.Table.InsertTableAfterSelf：将数据插入表格。
publicoverrideTableInsertTableAfterSelf(introwCount,intcoloumnCount)
{
returnbase.InsertTableAfterSelf(rowCount,coloumnCount);
}
publicvirtualTableInsertTableAfterSelf(introwCount,intcoloumnCount)
{
XElementcontent=HelperFunctions.CreateTable(rowCount,coloumnCount);
base.Xml.AddAfterSelf(content);
returnnewTable(base.Document,base.Xml.ElementsAfterSelf().First<XElement>());
}
4.CustomProperty：自定义属性。
publicclassCustomProperty
{
//Fields
privatestringname;
privatestringtype;
privateobjectvalue;
//Methods
publicCustomProperty(stringname,boolvalue);
publicCustomProperty(stringname,DateTimevalue);
publicCustomProperty(stringname,doublevalue);
publicCustomProperty(stringname,intvalue);
publicCustomProperty(stringname,stringvalue);
privateCustomProperty(stringname,stringtype,objectvalue);
internalCustomProperty(stringname,stringtype,stringvalue);
//Properties
publicstringName{get;}
internalstringType{get;}
publicobjectValue{get;}
}
5.BarChart：创建棒形图。
publicclassBarChart:Chart
{
//Methods
publicBarChart();
protectedoverrideXElementCreateChartXml();
//Properties
publicBarDirectionBarDirection{get;set;}
publicBarGroupingBarGrouping{get;set;}
publicintGapWidth{get;set;}
}
publicabstractclassChart
{
//Methods
publicChart();
publicvoidAddLegend();
publicvoidAddLegend(ChartLegendPositionposition,booloverlay);
publicvoidAddSeries(Seriesseries);
protectedabstractXElementCreateChartXml();
publicvoidRemoveLegend();
//Properties
publicCategoryAxisCategoryAxis{get;privateset;}
protectedXElementChartRootXml{get;privateset;}
protectedXElementChartXml{get;privateset;}
publicDisplayBlanksAsDisplayBlanksAs{get;set;}
publicvirtualboolIsAxisExist{get;}
publicChartLegendLegend{get;privateset;}
publicvirtualshortMaxSeriesCount{get;}
publicList<Series>Series{get;}
publicValueAxisValueAxis{get;privateset;}
publicboolView3D{get;set;}
publicXDocumentXml{get;privateset;}
}
6.Chart的AddLegend(),AddSeries(),RemoveLegend()方法解析：
publicvoidAddLegend(ChartLegendPositionposition,booloverlay)
{
if(this.Legend!=null)
{
this.RemoveLegend();
}
this.Legend=newChartLegend(position,overlay);
this.ChartRootXml.Add(this.Legend.Xml);
}
publicvoidAddSeries(Seriesseries)
{
if(this.ChartXml.Elements(XName.Get("ser",DocX.c.NamespaceName)).Count<XElement>()==this.MaxSeriesCount)
{
thrownewInvalidOperationException("Maximumseriesforthischartis"+this.MaxSeriesCount.ToString()+"andhaveexceeded!");
}
this.ChartXml.Add(series.Xml);
}
publicvoidRemoveLegend()
{
this.Legend.Xml.Remove();
this.Legend=null;
}
以上是对DocX组件的一些方法的一些简单解析，如果需要知道更多的方法实现代码，可自行进行下载查看。
三.DocX功能实现实例：
1.创建图表：
///<summary>
///创建棒形图
///</summary>
///<paramname="path">文档路径</param>
///<paramname="dicValue">绑定数据</param>
///<paramname="categoryName">类别名称</param>
///<paramname="valueName">值名称</param>
///<paramname="title">图标标题</param>
publicstaticboolBarChart(stringpath,Dictionary<string,ICollection>dicValue,stringcategoryName,stringvalueName,stringtitle)
{
if(string.IsNullOrEmpty(path))
{
thrownewArgumentNullException(path);
}
if(dicValue==null)
{
thrownewArgumentNullException("dicValue");
}
if(string.IsNullOrEmpty(categoryName))
{
thrownewArgumentNullException(categoryName);
}
if(string.IsNullOrEmpty(valueName))
{
thrownewArgumentNullException(valueName);
}
if(string.IsNullOrEmpty(title))
{
thrownewArgumentNullException(title);
}
try
{
using(vardocument=DocX.Create(path))
{
//BarChart图形属性设置，BarDirection图形方向枚举，BarGrouping图形分组枚举
varc=newBarChart
{
BarDirection=BarDirection.Column,
BarGrouping=BarGrouping.Standard,
GapWidth=400
};
//设置图表图例位置
c.AddLegend(ChartLegendPosition.Bottom,false);
//写入图标数据
foreach(varchartDataindicValue)
{
varseries=newSeries(chartData.Key);
series.Bind(chartData.Value,categoryName,valueName);
c.AddSeries(series);
}
//设置文档标题
document.InsertParagraph(title).FontSize(20);
document.InsertChart(c);
document.Save();
returntrue;
}
}
catch(Exceptionex)
{
thrownewException(ex.Message);
}
}
2.创建一个具有超链接、图像和表的文档。
///<summary>
///创建一个具有超链接、图像和表的文档。
///</summary>
///<paramname="path">文档保存路径</param>
///<paramname="imagePath">加载的图片路径</param>
///<paramname="url">url地址</param>
publicstaticvoidHyperlinksImagesTables(stringpath,stringimagePath,stringurl)
{
if(string.IsNullOrEmpty(path))
{
thrownewArgumentNullException(path);
}
if(string.IsNullOrEmpty(imagePath))
{
thrownewArgumentNullException(imagePath);
}
if(string.IsNullOrEmpty(url))
{
thrownewArgumentNullException(url);
}
try
{
using(vardocument=DocX.Create(path))
{
varlink=document.AddHyperlink("link",newUri(url));
vartable=document.AddTable(2,2);
table.Design=TableDesign.ColorfulGridAccent2;
table.Alignment=Alignment.center;
table.Rows[0].Cells[0].Paragraphs[0].Append("1");
table.Rows[0].Cells[1].Paragraphs[0].Append("2");
table.Rows[1].Cells[0].Paragraphs[0].Append("3");
table.Rows[1].Cells[1].Paragraphs[0].Append("4");
varnewRow=table.InsertRow(table.Rows[1]);
newRow.ReplaceText("4","5");
varimage=document.AddImage(imagePath);
varpicture=image.CreatePicture();
picture.Rotation=10;
picture.SetPictureShape(BasicShapes.cube);
vartitle=document.InsertParagraph().Append("Test").FontSize(20).Font(newFontFamily("ComicSansMS"));
title.Alignment=Alignment.center;
varp1=document.InsertParagraph();
p1.AppendLine("Thislinecontainsa").Append("bold").Bold().Append("word.");
p1.AppendLine("Hereisacool").AppendHyperlink(link).Append(".");
p1.AppendLine();
p1.AppendLine("Checkoutthispicture").AppendPicture(picture).Append("itsfunkydon'tyouthink?");
p1.AppendLine();
p1.AppendLine("CanyoucheckthisTableoffiguresforme?");
p1.AppendLine();
p1.InsertTableAfterSelf(table);
varp2=document.InsertParagraph();
p2.AppendLine("Isitcorrect?");
document.Save();
}
}
catch(Exceptionex)
{
thrownewException(ex.Message);
}
}
3.将指定内容写入文档：
///<summary>
///将指定内容写入文档
///</summary>
///<paramname="path">加载文件路径</param>
///<paramname="content">写入文件内容</param>
///<paramname="savePath">保存文件路径</param>
publicstaticvoidProgrammaticallyManipulateImbeddedImage(stringpath,stringcontent,stringsavePath)
{
if(string.IsNullOrEmpty(path))
{
thrownewArgumentNullException(path);
}
if(string.IsNullOrEmpty(content))
{
thrownewArgumentNullException(content);
}
if(string.IsNullOrEmpty(savePath))
{
thrownewArgumentNullException(savePath);
}
try
{
using(vardocument=DocX.Load(path))
{
//确保此文档至少有一个图像。
if(document.Images.Any())
{
varimg=document.Images[0];
//将内容写入图片.
varb=newBitmap(img.GetStream(FileMode.Open,FileAccess.ReadWrite));
//获取此位图的图形对象，图形对象提供绘图功能。
varg=Graphics.FromImage(b);
//画字符串内容
g.DrawString
(
content,
newFont("Tahoma",20),
Brushes.Blue,
newPointF(0,0)
);
//使用创建\写入流将该位图保存到文档中。
b.Save(img.GetStream(FileMode.Create,FileAccess.Write),ImageFormat.Png);
}
else
{
document.SaveAs(savePath);
}
}
}
catch(Exceptionex)
{
thrownewException(ex.Message);
}
}
总结
以上就是对DocX组件的API做了一个简单的解析，并且附上一些创建文档和创建图表的方法供开发者参考。希望本文的内容对大家的学习或者工作能带来一定的帮助，如果有疑问大家可以留言交流。