.NET中開來源文件操作組件DocX的介紹與使用_基礎應用

前言

相信大家應該都有所體會，在目前的軟體項目中，都會較多的使用到對文檔的操作，用於記錄和統計相關商務資訊。由於系統自身提供了對文檔的相關操作，所以在一定程度上極大的簡化了軟體使用者的工作量。

在.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做了一個簡單的解析，並且附上一些建立文檔和建立圖表的方法供開發人員參考。希望本文的內容對大家的學習或者工作能帶來一定的協助，如果有疑問大家可以留言交流。