一款开源免费的.NET文档操作组件DocX(.NET组件介绍之一)
在目前的软件项目中,都会较多的使用到对文档的操作,用于记录和统计相关业务信息。由于系统自身提供了对文档的相关操作,所以在一定程度上极大的简化了软件使用者的工作量。
在.NET项目中如果用户提出了相关文档操作的需求,开发者较多的会使用到微软自行提供的插件,在一定程度上简化了开发人员的工作量,但是同时也给用户带来了一些困扰,例如需要安装庞大的office,在用户体验性就会降低很多,并且在国内,很多人都还是使用wps,这就导致一部分只安装了wps的使用者很是为难,在对Excel的操作方面,有一个NPOI组件。那么可能会有人问有没有什么办法让这些困扰得到解决,答案是肯定的,那就是今天需要介绍的“DocX”组件,接下来我们就来了解一下这个组件的功能和用法。
一.DocX组件概述:
DocX是一个.NET库,允许开发人员以简单直观的方式处理Word 2007/2010/2013文件。 DocX是快速,轻量级,最好的是它不需要安装Microsoft Word或Office。DocX组件不仅可以完成对文档的一般要求,例如创建文档,创建表格和文本,并且还可以创建图形报表。DocX使创建和操作文档成为一个简单的任务。
它不使用COM库,也不需要安装Microsoft Office。在使用DocX组件时,你需要安装为了使用DocX是.NET框架4.0和Visual Studio 2010或更高版本。
DocX的主要特点:
(1).在文档中插入,删除或替换文本。所有标准文本格式都可用。 字体{系列,大小,颜色},粗体,斜体,下划线,删除线,脚本{子,超级},突出显示。
(2).段落属性显示。方向LeftToRight或RightToLeft;缩进;比对。
(3).DocX也支持:图片,超链接,表,页眉和页脚,自定义属性。
有关DocX组件的相关信息就介绍到这里,如果需要更加深入的了解相关信息,可以进入:https://docx.codeplex.com/。
二.DocX相关类和方法解析:
本文将结合DocX的源码进行解析,使用.NET Reflector对DLL文件进行反编译,以此查看源代码。将DLL文件加入.NET Reflector中,点击打开文件。
1.DocX.Create():创建文档。
- public static DocX Create(Stream stream)
- {
- MemoryStream stream2 = new MemoryStream();
- PostCreation(ref Package.Open(stream2, FileMode.Create, FileAccess.ReadWrite));
- DocX cx = Load(stream2);
- cx.stream = stream;
- return cx;
- }
2.Paragraph.Append:向段落添加信息。
- public Paragraph Append(string text)
- {
- 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>();
- return this;
- }
- public Paragraph Bold()
- {
- this.ApplyTextFormattingProperty(XName.Get("b", DocX.w.NamespaceName), string.Empty, null);
- return this;
- }
3.Table.InsertTableAfterSelf:将数据插入表格。
- public override Table InsertTableAfterSelf(int rowCount, int coloumnCount)
- {
- return base.InsertTableAfterSelf(rowCount, coloumnCount);
- }
- public virtual Table InsertTableAfterSelf(int rowCount, int coloumnCount)
- {
- XElement content = HelperFunctions.CreateTable(rowCount, coloumnCount);
- base.Xml.AddAfterSelf(content);
- return new Table(base.Document, base.Xml.ElementsAfterSelf().First<XElement>());
- }
4.CustomProperty:自定义属性。
- public class CustomProperty
- {
- // Fields
- private string name;
- private string type;
- private object value;
- // Methods
- public CustomProperty(string name, bool value);
- public CustomProperty(string name, DateTime value);
- public CustomProperty(string name, double value);
- public CustomProperty(string name, int value);
- public CustomProperty(string name, string value);
- private CustomProperty(string name, string type, object value);
- internal CustomProperty(string name, string type, string value);
- // Properties
- public string Name { get; }
- internal string Type { get; }
- public object Value { get; }
- }
5.BarChart:创建棒形图。
- public class BarChart : Chart
- {
- // Methods
- public BarChart();
- protected override XElement CreateChartXml();
- // Properties
- public BarDirection BarDirection { get; set; }
- public BarGrouping BarGrouping { get; set; }
- public int GapWidth { get; set; }
- }
- public abstract class Chart
- {
- // Methods
- public Chart();
- public void AddLegend();
- public void AddLegend(ChartLegendPosition position, bool overlay);
- public void AddSeries(Series series);
- protected abstract XElement CreateChartXml();
- public void RemoveLegend();
- // Properties
- public CategoryAxis CategoryAxis { get; private set; }
- protected XElement ChartRootXml { get; private set; }
- protected XElement ChartXml { get; private set; }
- public DisplayBlanksAs DisplayBlanksAs { get; set; }
- public virtual bool IsAxisExist { get; }
- public ChartLegend Legend { get; private set; }
- public virtual short MaxSeriesCount { get; }
- public List<Series> Series { get; }
- public ValueAxis ValueAxis { get; private set; }
- public bool View3D { get; set; }
- public XDocument Xml { get; private set; }
- }
6.Chart的AddLegend(),AddSeries(),RemoveLegend()方法解析:
- public void AddLegend(ChartLegendPosition position, bool overlay)
- {
- if (this.Legend != null)
- {
- this.RemoveLegend();
- }
- this.Legend = new ChartLegend(position, overlay);
- this.ChartRootXml.Add(this.Legend.Xml);
- }
- public void AddSeries(Series series)
- {
- if (this.ChartXml.Elements(XName.Get("ser", DocX.c.NamespaceName)).Count<XElement>() == this.MaxSeriesCount)
- {
- throw new InvalidOperationException("Maximum series for this chart is" + this.MaxSeriesCount.ToString() + "and have exceeded!");
- }
- this.ChartXml.Add(series.Xml);
- }
- public void RemoveLegend()
- {
- this.Legend.Xml.Remove();
- this.Legend = null;
- }
以上是对DocX组件的一些方法的一些简单解析,如果需要知道更多的方法实现代码,可自行进行下载查看。
三.DocX功能实现实例:
1.创建图表:
- /// <summary>
- /// 创建棒形图
- /// </summary>
- /// <param name="path">文档路径</param>
- /// <param name="dicValue">绑定数据</param>
- /// <param name="categoryName">类别名称</param>
- /// <param name="valueName">值名称</param>
- /// <param name="title">图标标题</param>
- public static bool BarChart(string path,Dictionary<string, ICollection> dicValue,string categoryName,string valueName,string title)
- {
- if (string.IsNullOrEmpty(path))
- {
- throw new ArgumentNullException(path);
- }
- if (dicValue == null)
- {
- throw new ArgumentNullException("dicValue");
- }
- if (string.IsNullOrEmpty(categoryName))
- {
- throw new ArgumentNullException(categoryName);
- }
- if (string.IsNullOrEmpty(valueName))
- {
- throw new ArgumentNullException(valueName);
- }
- if (string.IsNullOrEmpty(title))
- {
- throw new ArgumentNullException(title);
- }
- try
- {
- using (var document = DocX.Create(path))
- {
- //BarChart图形属性设置,BarDirection图形方向枚举,BarGrouping图形分组枚举
- var c = new BarChart
- {
- BarDirection = BarDirection.Column,
- BarGrouping = BarGrouping.Standard,
- GapWidth = 400
- };
- //设置图表图例位置
- c.AddLegend(ChartLegendPosition.Bottom, false);
- //写入图标数据
- foreach (var chartData in dicValue)
- {
- var series = new Series(chartData.Key);
- series.Bind(chartData.Value, categoryName, valueName);
- c.AddSeries(series);
- }
- // 设置文档标题
- document.InsertParagraph(title).FontSize(20);
- document.InsertChart(c);
- document.Save();
- return true;
- }
- }
- catch (Exception ex)
- {
- throw new Exception(ex.Message);
- }
- }
2.创建一个具有超链接、图像和表的文档。
- /// <summary>
- /// 创建一个具有超链接、图像和表的文档。
- /// </summary>
- /// <param name="path">文档保存路径</param>
- /// <param name="imagePath">加载的图片路径</param>
- /// <param name="url">url地址</param>
- public static void HyperlinksImagesTables(string path,string imagePath,string url)
- {
- if (string.IsNullOrEmpty(path))
- {
- throw new ArgumentNullException(path);
- }
- if (string.IsNullOrEmpty(imagePath))
- {
- throw new ArgumentNullException(imagePath);
- }
- if (string.IsNullOrEmpty(url))
- {
- throw new ArgumentNullException(url);
- }
- try
- {
- using (var document = DocX.Create(path))
- {
- var link = document.AddHyperlink("link", new Uri(url));
- var table = 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");
- var newRow = table.InsertRow(table.Rows[1]);
- newRow.ReplaceText("4", "5");
- var image = document.AddImage(imagePath);
- var picture = image.CreatePicture();
- picture.Rotation = 10;
- picture.SetPictureShape(BasicShapes.cube);
- var title = document.InsertParagraph().Append("Test").FontSize(20).Font(new FontFamily("Comic Sans MS"));
- title.Alignment = Alignment.center;
- var p1 = document.InsertParagraph();
- p1.AppendLine("This line contains a ").Append("bold").Bold().Append(" word.");
- p1.AppendLine("Here is a cool ").AppendHyperlink(link).Append(".");
- p1.AppendLine();
- p1.AppendLine("Check out this picture ").AppendPicture(picture).Append(" its funky don't you think?");
- p1.AppendLine();
- p1.AppendLine("Can you check this Table of figures for me?");
- p1.AppendLine();
- p1.InsertTableAfterSelf(table);
- var p2 = document.InsertParagraph();
- p2.AppendLine("Is it correct?");
- document.Save();
- }
- }
- catch (Exception ex)
- {
- throw new Exception(ex.Message);
- }
- }
3.将指定内容写入文档:
- /// <summary>
- /// 将指定内容写入文档
- /// </summary>
- /// <param name="path">加载文件路径</param>
- /// <param name="content">写入文件内容</param>
- /// <param name="savePath">保存文件路径</param>
- public static void ProgrammaticallyManipulateImbeddedImage(string path, string content, string savePath)
- {
- if (string.IsNullOrEmpty(path))
- {
- throw new ArgumentNullException(path);
- }
- if (string.IsNullOrEmpty(content))
- {
- throw new ArgumentNullException(content);
- }
- if (string.IsNullOrEmpty(savePath))
- {
- throw new ArgumentNullException(savePath);
- }
- try
- {
- using (var document = DocX.Load(path))
- {
- // 确保此文档至少有一个图像。
- if (document.Images.Any())
- {
- var img = document.Images[0];
- // 将内容写入图片.
- var b = new Bitmap(img.GetStream(FileMode.Open, FileAccess.ReadWrite));
- //获取此位图的图形对象,图形对象提供绘图功能。
- var g = Graphics.FromImage(b);
- // 画字符串内容
- g.DrawString
- (
- content,
- new Font("Tahoma", 20),
- Brushes.Blue,
- new PointF(0, 0)
- );
- // 使用创建\写入流将该位图保存到文档中。
- b.Save(img.GetStream(FileMode.Create, FileAccess.Write), ImageFormat.Png);
- }
- else
- {
- document.SaveAs(savePath);
- }
- }
- }
- catch (Exception ex)
- {
- throw new Exception(ex.Message);
- }
- }
四.总结:
以上是对DocX组件的API做了一个简单的解析,并且附上一些创建文档和创建图表的方法供开发者参考。
.NET组件介绍系列:
一款开源免费的.NET文档操作组件DocX(.NET组件介绍之一)http://www.cnblogs.com/pengze0902/p/6122311.html
高效而稳定的企业级.NET Office 组件Spire(.NET组件介绍之二)http://www.cnblogs.com/pengze0902/p/6125570.html
最好的.NET开源免费ZIP库DotNetZip(.NET组件介绍之三)http://www.cnblogs.com/pengze0902/p/6124659.html
免费开源的DotNet二维码操作组件ThoughtWorks.QRCode(.NET组件介绍之四)http://www.cnblogs.com/pengze0902/p/6134506.html
免费开源的DotNet任务调度组件Quartz.NET(.NET组件介绍之五)http://www.cnblogs.com/pengze0902/p/6128558.html
免费高效实用的Excel操作组件NPOI(.NET组件介绍之六)http://www.cnblogs.com/pengze0902/p/6150070.html
一款开源免费的.NET文档操作组件DocX(.NET组件介绍之一)的更多相关文章
- Mergely – 免费的在线文档对比和合并工具
任何类型的文件(无论是否代码),我们可能要比较不同的版本,看发生了什么变化. 有些编辑器都有这个内置功能,其中一些则没有. Mergely 是一个免费使用的 Web 应用程序,帮你你迅速作出文档的差异 ...
- linkedin开源的kafka-monitor安装文档
linkedin开源的kafka-monitor安装文档 linkedin 开源的kafka-monitor的安装使用可以参考官方的readme:流程介绍的已经比较清楚,但是还是有一些地方需要修正.让 ...
- Uncode-Schedule首页、文档和下载 - 分布式任务调度组件 - 开源中国社区
Uncode-Schedule首页.文档和下载 - 分布式任务调度组件 - 开源中国社区 分布式任务调度组件 Uncode-Schedule
- 安利一个免费下载VIP文档神器
今天安利给大伙一个非非非常好用的可以免费下载VIP文档的下载神器------冰点文库下载器,用过的人都说好.操作简单,小巧轻便,完全免费.支持百度.豆丁.畅享.mbalib.hp009.max.boo ...
- jQuery 核心 - noConflict() 方法,jQuery 文档操作 - detach() 方法
原文地址:http://www.w3school.com.cn/jquery/manipulation_detach.asp 实例 使用 noConflict() 方法为 jQuery 变量规定新 ...
- XML文档操作之JAXP下实现
JAXP是java API for xml PRocessing的缩写. 其API可以在javax.xml.parsers 这个包中找到.这个包向用户提供了两个最重要的工厂类,SAXParserFac ...
- jQuery文档操作
jQuery文档操作 1.jq文档结构 var $sup = $('.sup'); $sup.children(); // sup所有的子级们 $sup.parent(); // sup的父级(一个, ...
- 06-jQuery的文档操作
之前js中咱们学习了js的DOM操作,也就是所谓的增删改查DOM操作.通过js的DOM的操作,大家也能发现,大量的繁琐代码实现我们想要的效果.那么jQuery的文档操作的API提供了便利的方法供我们操 ...
- 06-jQuery的文档操作(重点)
之前js中咱们学习了js的DOM操作,也就是所谓的增删改查DOM操作.通过js的DOM的操作,大家也能发现,大量的繁琐代码实现我们想要的效果.那么jQuery的文档操作的API提供了便利的方法供我们操 ...
随机推荐
- JavaScript权威指南 - 函数
函数本身就是一段JavaScript代码,定义一次但可能被调用任意次.如果函数挂载在一个对象上,作为对象的一个属性,通常这种函数被称作对象的方法.用于初始化一个新创建的对象的函数被称作构造函数. 相对 ...
- 前端框架 EasyUI (0) 重新温习(序言)
几年前,参与过一个项目.那算是一个小型的信息管理系统,BS 结构的,前端用的是基于 jQuery 的 EasyUI 框架. 我进 Team 的时候,项目已经进入开发阶段半个多月了.听说整个项目的框架是 ...
- Convert BSpline Curve to Arc Spline in OpenCASCADE
Convert BSpline Curve to Arc Spline in OpenCASCADE eryar@163.com Abstract. The paper based on OpenCA ...
- 计算机程序的思维逻辑 (54) - 剖析Collections - 设计模式
上节我们提到,类Collections中大概有两类功能,第一类是对容器接口对象进行操作,第二类是返回一个容器接口对象,上节我们介绍了第一类,本节我们介绍第二类. 第二类方法大概可以分为两组: 接受其他 ...
- 走进缓存的世界(三) - Memcache
系列文章 走进缓存的世界(一) - 开篇 走进缓存的世界(二) - 缓存设计 走进缓存的世界(三) - Memcache 简介 Memcache是一个高性能的分布式内存对象缓存系统,用于动态Web应用 ...
- 设计模式C#合集--抽象工厂模式
抽象工厂,名字就告诉你是抽象的了.上代码. public interface BMW { public void Drive(); } public class BMW730 : BMW { publ ...
- 【干货分享】流程DEMO-合同会审表
流程名: 合同会审表 业务描述: 合同的审批及签订 流程相关文件: 流程包.xml 事务呈批表业务服务.xml 事务呈批表主数据.xml 流程说明: 1.此流程必须先进行事务呈批表流程的配置才可 ...
- 一个软件开发者的BPM之路
我是小林,一名普通的软件工程师,从事BPM(业务流程管理)软件开发工作.我没有几十年的技术底蕴,无法像大牛们一样高谈阔论,品评BPM开发之道:也不是资深的流程管理专家,能与大家分析流程管理的时弊.我只 ...
- 学习C的笔记
[unsigned] 16位系统中一个int能存储的数据的范围为-32768~32767,而unsigned能存储的数据范围则是0~65535.由于在计算机中,整数是以补码形式存放的.根据最高位的不同 ...
- 项目持续集成环境(jenkins + SVN + maven + tomcat)
整体流程 每次SVN上代码有变动,触发自动构建动作,并部署到服务器的tomcat上,具体流程: 1.SVN上提交代码修改 2.maven执行Goals 3.将web工程打成war包 4.关闭服务器的t ...