做了一个多月的C#生成Word文档的工作,我从一开始的对这个一窍不通,到现在的顺利完成了这个功能模块,其中还是有点心得的。想想自己说不定以后还会用到,于是想吧这些心得写下来,以供自己以后的学习。同时也希望对那些正在或正要编程实现自动生成Word的朋友有些小小的帮助。
对于用C#来自动生成Word文档来说,最大的问题是微软提供的所有文档的源代码一般都是VBA编程的,没有C#的现成文档,最多也只是一些How To文档。显然,VBA编程和C#是有一定区别的,VBA编程的风格和C#是完全不同的,它有着VB编程快捷的特性,可以省略参数,可以对Style对象赋值等的功能是C#所没有的。其次,在这个任务通过Word录制宏查看到的宏代码也是由VB代码显示的,我们必须要把这些宏代码转换到C#代码。所以,做这个任务的人必须先有一点VB的经验(最起码知道那些代码是在干什么)。下面是我自学C#生成Word文档的过程(首先必须安装好Word2003和.NET2003):
一、下载Word的VBA编程参考手册和网上的在线资料
微软大概觉得VB用的人太少了,想大力发展之,搞得Office编程的参考手册都是VBA编程,害的我不懂VB的人也不得不学。不过没办法,要做这个工作,微软的参考手册是不能少的,可以从http://msdn.microsoft.com/office/downloads/vba/default.aspx这个页面中下到相应的的Office(本人使用的是Word2003,但好像只用WordXP的参考手册)的VBA Language References(当然这个文档是全英文的,看她简直是我的噩梦)。没有必要看完这个参考手册,只要搜索需要的函数,然后看看就可以了。
有了这个参考手册是远远不够的,我们需要去网上搜集大量的现成代码来看看才能快速的上手。下面是一个微软老大提供的关于C#生成Word的中文How To文档,感觉很好,分享一下http://support.microsoft.com/search/default.aspx?query=Word&catalog=LCID%3D2052&spid=1108&qryWt=&mode=r&cus=False。当然,微软提供的文档都是最基础的,我们只能在需要用到这个功能的时候才只得看看一看看,很全面,但没有一个包含所有东西的程序。所以,我们还得再在网上淘资料。终于我在http://www.codeproject.com/aspnet/wordapplication.asp(建议:请看完Michela写的这篇文章后再看下面的我的心得,他那里介绍了怎么建立一个项目,如添加引用等,我就不再累赘了,有空的话都想把他的文章翻译过来 )。这个页面里找到了我所需要的:一个封装Word操作的类(他的Word版本好像是XP),虽然这个类的功能很少,但我们可以按照原则自己写代码,扩充类库。基本的原则是:把底层的Word操作封装在这个类中,外层通过调用此封装类实现对Word的操作。
二、编程实现:通过查看Word宏代码完善自定义类库
有了这样一个大致的框架以后,我们就可以开始用C#开始实现各种Word操作的功能。总的来说,这项工作不难,但很繁琐(要看你对Word操作的熟悉程度)。
一般情况下,自动生成的Word文档会有一个模板Word文件(以.dot结尾,当然模板本身也可以是.doc的Word文档)。在这个模板中,我们先设计好要导出文档的总体框架,在那些需要插入文字的地方先做好书签。在这个工作中,我们最常用到的就是书签,使用书签的好处是方便快捷,Word文档中的差不多所有的定位都是通过书签来完成的。为了了解一个Word操作的具体编程实现,我们可以通过Word自带的宏编程:在进行想要了解的操作之前,先录制宏,操作完后再查看刚才录制的宏代码,这样我们就得到了进行这个操作的VB编码。如:我们需要查看Word生成一个Table表的动作是怎样的,我们可以先在进行插入Table前录制宏,然后在Word中进行一个插入Table的操作,再停止宏,这样我们就可以看到一个插入Table的宏代码了。下面就是一个插入最简单的Table的宏代码:
Sub Macro8()
'
' Macro8 Macro
' by 林辉(sharemeteor)
' 宏在 2005-8-19 由 MC SYSTEM 录制
'
ActiveDocument.Tables.Add Range:=Selection.Range, NumRows:=2, NumColumns:= _
4, DefaultTableBehavior:=wdWord9TableBehavior, AutoFitBehavior:= _
wdAutoFitFixed
With Selection.Tables(1)
If .Style <> "网格型" Then
.Style = "网格型"
End If
.ApplyStyleHeadingRows = True
.ApplyStyleLastRow = True
.ApplyStyleFirstColumn = True
.ApplyStyleLastColumn = True
End With
End Sub
'
' Macro8 Macro
' by 林辉(sharemeteor)
' 宏在 2005-8-19 由 MC SYSTEM 录制
'
ActiveDocument.Tables.Add Range:=Selection.Range, NumRows:=2, NumColumns:= _
4, DefaultTableBehavior:=wdWord9TableBehavior, AutoFitBehavior:= _
wdAutoFitFixed
With Selection.Tables(1)
If .Style <> "网格型" Then
.Style = "网格型"
End If
.ApplyStyleHeadingRows = True
.ApplyStyleLastRow = True
.ApplyStyleFirstColumn = True
.ApplyStyleLastColumn = True
End With
End Sub
了解这些后,我们就需要学会从VBA编程到C#实现之间的转变(这是我碰到的最大难题)。总结下来,两者间的函数名一般是相同的,但由于VB可以缺省参数而C#不行,所以我们必须同时了解那些缺省参数,并进行合理的填充。那些在VB代码中出现的参数也要进行适当的改变才能应用于C#中。比如打开一个Word文档的操作吧,Word的宏代码如下:
它只有11个参数,但在C#里需要16个参数值(Word2003中是16个参数,WordXP为15个)。在C#中,Word.ApplicationClass下的Documents属性和VB宏代码中的Documents对等,不过你需要获得Word.ApplicationClass的实例后才能用。
Sub Macro9()
' Macro9 Macro
' by 林辉(sharemeteor)
' 宏在 2005-8-19 由 MC SYSTEM 录制
'
Documents.Open FileName:="test.doc", ConfirmConversions:=False, ReadOnly:= _
False, AddToRecentFiles:=False, PasswordDocument:="", PasswordTemplate:= _
"", Revert:=False, WritePasswordDocument:="", WritePasswordTemplate:="", _
Format:=wdOpenFormatAuto, XMLTransform:=""
End Sub
' Macro9 Macro
' by 林辉(sharemeteor)
' 宏在 2005-8-19 由 MC SYSTEM 录制
'
Documents.Open FileName:="test.doc", ConfirmConversions:=False, ReadOnly:= _
False, AddToRecentFiles:=False, PasswordDocument:="", PasswordTemplate:= _
"", Revert:=False, WritePasswordDocument:="", WritePasswordTemplate:="", _
Format:=wdOpenFormatAuto, XMLTransform:=""
End Sub
// Open a file (the file must exists) and activate it
public void Open( string strFileName)
{
object fileName = strFileName;
object readOnly = false;
object isVisible = true;
object missing = System.Reflection.Missing.Value;
oDoc = oWordApplic.Documents.Open(ref fileName, ref missing,ref readOnly,
ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
ref missing, ref missing, ref isVisible,ref missing,ref missing,ref missing,ref missing);
oDoc.Activate();
}
public void Open( string strFileName)
{
object fileName = strFileName;
object readOnly = false;
object isVisible = true;
object missing = System.Reflection.Missing.Value;
oDoc = oWordApplic.Documents.Open(ref fileName, ref missing,ref readOnly,
ref missing, ref missing, ref missing, ref missing, ref missing, ref missing,
ref missing, ref missing, ref isVisible,ref missing,ref missing,ref missing,ref missing);
oDoc.Activate();
}
缺省参数一般可以通过赋System.Reflection.Missing.Value值就可以了。而那些VB代码中出现了的参数,我们必须先通过查找VBA Language References参考手册了解其具体的值(实际上这些参数都是枚举变量,其值大多数都是Object型的整数),然后再在C#中赋予相同的Object型的整数值。需要注意的是,C#中的参数一般都是引用型的,要加ref。
这里有些方便的小技巧,在参考手册的Reference/Enumerations下可以找到那些参数的名称和其值,我们可以通过直接赋整数值实现,但在C#的Word类库中,Word.Wd***这个枚举量下都会有一个值和VB中的这个参数对应,所以建议用这些枚举值进行赋值。如VB有个参数叫wdAlignParagraphCenter,我们通过查参考手册知道它是WdParagraphAlignment下的枚举值,那么它在C#中的值为Word.WdParagraphAlignment.wdAlignParagraphCenter。
三、编程中遇到的问题及解决
在这个工作中,碰到点问题是难免的,只要你用心,相信只是的问题,肯定可以解决的。下面是我碰到的一些问题和我的解决办法,希望对大家有用。
1. Style等对象不能赋值的问题
感觉微软对Office的类库的设计可能存在问题,很多在VB中可以赋值的对象如Style,但在C#就是不能赋值。这引来了很多问题,如前面的产生Table的宏中就有“.Style = "网格型"”的语句,这在C#中是不可能用一条等价的语句来实现的。
这里有两种解决办法,一种是干脆不用Style,另一种是间接实现Style的赋值。
有些地方的Style是可以被替换的,如产生table的宏中的Style,它的Style只不过是是定义边框的样式,我们可以手工定义样式来替代Style,用下列函数实现产生一个Table:
这里有些方便的小技巧,在参考手册的Reference/Enumerations下可以找到那些参数的名称和其值,我们可以通过直接赋整数值实现,但在C#的Word类库中,Word.Wd***这个枚举量下都会有一个值和VB中的这个参数对应,所以建议用这些枚举值进行赋值。如VB有个参数叫wdAlignParagraphCenter,我们通过查参考手册知道它是WdParagraphAlignment下的枚举值,那么它在C#中的值为Word.WdParagraphAlignment.wdAlignParagraphCenter。
三、编程中遇到的问题及解决
在这个工作中,碰到点问题是难免的,只要你用心,相信只是的问题,肯定可以解决的。下面是我碰到的一些问题和我的解决办法,希望对大家有用。
1. Style等对象不能赋值的问题
感觉微软对Office的类库的设计可能存在问题,很多在VB中可以赋值的对象如Style,但在C#就是不能赋值。这引来了很多问题,如前面的产生Table的宏中就有“.Style = "网格型"”的语句,这在C#中是不可能用一条等价的语句来实现的。
这里有两种解决办法,一种是干脆不用Style,另一种是间接实现Style的赋值。
有些地方的Style是可以被替换的,如产生table的宏中的Style,它的Style只不过是是定义边框的样式,我们可以手工定义样式来替代Style,用下列函数实现产生一个Table:
public void RunMacroForTable(int rows,int columns)
{
object _DefaultTableBehavior = Word.WdDefaultTableBehavior.wdWord9TableBehavior;
object _AutoFitBehavior = Word.WdAutoFitBehavior.wdAutoFitFixed;
oWordApplic.ActiveDocument.Tables.Add(oWordApplic.Selection.Range,rows,columns,
ref _DefaultTableBehavior,ref _AutoFitBehavior);
Word.Table table = oWordApplic.Selection.Tables[1];
// oWordApplic.Selection.Rows.HeightRule = Word.WdRowHeightRule.wdRowHeightAtLeast;
oWordApplic.Selection.Rows.Height = oWordApplic.CentimetersToPoints((float)0.75);
// if(table.Style != "网格型")
// table.Style = "网格型";
对边框进行定义
oWordApplic.Options.DefaultBorderLineStyle = Word.WdLineStyle.wdLineStyleSingle;
oWordApplic.Options.DefaultBorderLineWidth = Word.WdLineWidth.wdLineWidth150pt;
oWordApplic.Options.DefaultBorderColor = Word.WdColor.wdColorAutomatic;
oWordApplic.Selection.Rows.HeadingFormat = (int)Word.WdConstants.wdToggle;
table.Rows.Alignment = Word.WdRowAlignment.wdAlignRowCenter;
}
{
object _DefaultTableBehavior = Word.WdDefaultTableBehavior.wdWord9TableBehavior;
object _AutoFitBehavior = Word.WdAutoFitBehavior.wdAutoFitFixed;
oWordApplic.ActiveDocument.Tables.Add(oWordApplic.Selection.Range,rows,columns,
ref _DefaultTableBehavior,ref _AutoFitBehavior);
Word.Table table = oWordApplic.Selection.Tables[1];
// oWordApplic.Selection.Rows.HeightRule = Word.WdRowHeightRule.wdRowHeightAtLeast;
oWordApplic.Selection.Rows.Height = oWordApplic.CentimetersToPoints((float)0.75);
// if(table.Style != "网格型")
// table.Style = "网格型";
对边框进行定义
oWordApplic.Options.DefaultBorderLineStyle = Word.WdLineStyle.wdLineStyleSingle;
oWordApplic.Options.DefaultBorderLineWidth = Word.WdLineWidth.wdLineWidth150pt;
oWordApplic.Options.DefaultBorderColor = Word.WdColor.wdColorAutomatic;
oWordApplic.Selection.Rows.HeadingFormat = (int)Word.WdConstants.wdToggle;
table.Rows.Alignment = Word.WdRowAlignment.wdAlignRowCenter;
}
但有些地方的Sytle就替换不了了,有一种方法可以间接实现对Style等不能在C#中赋值对象的赋值,那就是通过调用VB.NET的dll。不得不佩服微软的.NET框架,各个语言间可以随意的调用,用起来相当之方便。
我们可以在VB.NET下面建个函数来调用那个语句,然后生成dll,C#项目只要引用这个dll,然后调用这个dll中的函数就可以了。下面是VB.NET下对Style赋值的函数(简单吧!C#里就是死活也不行)
我们可以在VB.NET下面建个函数来调用那个语句,然后生成dll,C#项目只要引用这个dll,然后调用这个dll中的函数就可以了。下面是VB.NET下对Style赋值的函数(简单吧!C#里就是死活也不行)
Public Sub SetStyle(ByVal header As String, ByVal oWordApplic As Word.ApplicationClass)
oWordApplic.Selection.Style = oWordApplic.ActiveDocument.Styles(header)
End Sub
oWordApplic.Selection.Style = oWordApplic.ActiveDocument.Styles(header)
End Sub
其他那些不能在C#里赋值的对象都可以通过这种方法实现赋值。
2.书签过多,一个一个定位麻烦的问题
如果你的Word模板够庞大,可能会出现有50多个书签,而这些书签的位置只是填充一些简单数据的情况。如果我们编程时一个个的定位,然后一个个的填充数据肯定时非常麻烦的。这种情况下,我的解决办法是设置XML配置文档。
我们可以设置一个XML文件,其中存放需要填充数据的书签(这些书签处只是做简单的插入文本)的名称。如下面是我的XML文件的详细内容:
我们可以把需要填充的数据都存放到一个Hashtable中,key为它们所对应的书签名,这样在C#中读取这个XML文件后,把同一Name下的所有Bookmark存放在一个ArrayList中,我们就可以统一地进行填充了,使用的函数的形式如:
这样,对于那些不需要做特殊化处理的书签,我们就统一的在default中进行了填充数据。
3.页眉页脚中添文字的问题
对于页眉页脚,需要注意的就是不要用书签去定位,因为页眉页脚和主文档的页面视图不一样,所以不能在普通的视图下直接定位到页眉页脚所在书签处。但只要你切换一下视图,一切就OK了。
这里,我先是通过书签定位到页眉所在页,这样比较方便,不用在页眉视图中再翻页定位。
4.项目符号及多级项目符号的Style问题
这个问题我的解决中有点问题,要和模板一起设置才能用,感觉不好,就不拿出来给大家看了,以免误导大家了
5.添加特殊字符的问题
当你要在文档中添加特殊文字的时候(如你想添加一个þ),不能直接通过简单的复制粘贴来实现(你根本没办法在.NET的IDE下看到þ)。这时,我们可以通过查找这个特殊字符的字体名称和代表的16进制编码来插入。我们可以查到þ所在的字符集是Wingdings,它的16进制编码是\u00fe,这时,我们就能对这个þ进行插入,具体代码如:
其中,test是一个被封装的Word操作类的实例。
如果大家反映强烈,我可以贴出我的代码,Web的和WinForm的都有。
听说那个Michela的demo文件下载不下来,现贴上我以前下载的他的文件/Files/sharemeteor/WordApplication.rar
2.书签过多,一个一个定位麻烦的问题
如果你的Word模板够庞大,可能会出现有50多个书签,而这些书签的位置只是填充一些简单数据的情况。如果我们编程时一个个的定位,然后一个个的填充数据肯定时非常麻烦的。这种情况下,我的解决办法是设置XML配置文档。
我们可以设置一个XML文件,其中存放需要填充数据的书签(这些书签处只是做简单的插入文本)的名称。如下面是我的XML文件的详细内容:
<?xml version="1.0" encoding="utf-8" ?>
<Forms>
<Form>
<Name>data</Name>
<Bookmarks>
<Bookmark>date1</Bookmark>
<Bookmark>date2</Bookmark>
<Bookmark>project</Bookmark>
<Bookmark>company</Bookmark>
</Bookmarks>
</Form>
<Form>
<Name>company</Name>
<Bookmarks>
<Bookmark>recordnumber</Bookmark>
<Bookmark>customer</Bookmark>
<Bookmark>address</Bookmark>
<Bookmark>postcode</Bookmark>
<Bookmark>linkman</Bookmark>
<Bookmark>telephone</Bookmark>
<Bookmark>email</Bookmark>
<Bookmark>faxnumber</Bookmark>
</Bookmarks>
</Form>
</Forms>
<Forms>
<Form>
<Name>data</Name>
<Bookmarks>
<Bookmark>date1</Bookmark>
<Bookmark>date2</Bookmark>
<Bookmark>project</Bookmark>
<Bookmark>company</Bookmark>
</Bookmarks>
</Form>
<Form>
<Name>company</Name>
<Bookmarks>
<Bookmark>recordnumber</Bookmark>
<Bookmark>customer</Bookmark>
<Bookmark>address</Bookmark>
<Bookmark>postcode</Bookmark>
<Bookmark>linkman</Bookmark>
<Bookmark>telephone</Bookmark>
<Bookmark>email</Bookmark>
<Bookmark>faxnumber</Bookmark>
</Bookmarks>
</Form>
</Forms>
foreach(string bookmark in bookmarks)
{
switch(bookmark)
{
case "company":
test.GotoBookMark(bookmark);
test.SetFontColor(Word.WdColor.wdColorDarkBlue);
test.SetFontName("Times New Roman");
test.InsertText(hash[bookmark].ToString());
break;
case "catalog":
break;
case "modules":
break;
default:
test.GotoBookMark(bookmark);
test.InsertText(hash[bookmark].ToString());
break;
}
}
{
switch(bookmark)
{
case "company":
test.GotoBookMark(bookmark);
test.SetFontColor(Word.WdColor.wdColorDarkBlue);
test.SetFontName("Times New Roman");
test.InsertText(hash[bookmark].ToString());
break;
case "catalog":
break;
case "modules":
break;
default:
test.GotoBookMark(bookmark);
test.InsertText(hash[bookmark].ToString());
break;
}
}
3.页眉页脚中添文字的问题
对于页眉页脚,需要注意的就是不要用书签去定位,因为页眉页脚和主文档的页面视图不一样,所以不能在普通的视图下直接定位到页眉页脚所在书签处。但只要你切换一下视图,一切就OK了。
/// <summary>
/// 设置页眉
/// </summary>
/// <param name="strBookmarkName">要设置页面中的一个书签</param>
/// <param name="text">页眉的文字</param>
public void SetHeader(string strBookmarkName,string text)
{
this.GotoBookMark(strBookmarkName);
// If ActiveWindow.View.SplitSpecial <> wdPaneNone Then
// ActiveWindow.Panes(2).Close
// End If
if(oWordApplic.ActiveWindow.View.SplitSpecial != Word.WdSpecialPane.wdPaneNone)
oWordApplic.ActiveWindow.Panes[2].Close();
// If ActiveWindow.ActivePane.View.Type = wdNormalView Or ActiveWindow. _
// ActivePane.View.Type = wdOutlineView Then
// ActiveWindow.ActivePane.View.Type = wdPrintView
// End If
if(oWordApplic.ActiveWindow.View.Type == Word.WdViewType.wdNormalView
|| oWordApplic.ActiveWindow.View.Type == Word.WdViewType.wdOutlineView)
oWordApplic.ActiveWindow.ActivePane.View.Type = Word.WdViewType.wdPrintView;
// ActiveWindow.ActivePane.View.SeekView = wdSeekCurrentPageHeader
oWordApplic.ActiveWindow.ActivePane.View.SeekView = Word.WdSeekView.wdSeekCurrentPageHeader;
this.GoToTheEnd();
// this.GotoBookMark(strBookmarkName);
this.SetFontColor(Word.WdColor.wdColorDarkBlue);
this.InsertText(text);
// ActiveWindow.ActivePane.View.SeekView = wdSeekMainDocument
oWordApplic.ActiveWindow.ActivePane.View.SeekView = Word.WdSeekView.wdSeekMainDocument;
}
/// 设置页眉
/// </summary>
/// <param name="strBookmarkName">要设置页面中的一个书签</param>
/// <param name="text">页眉的文字</param>
public void SetHeader(string strBookmarkName,string text)
{
this.GotoBookMark(strBookmarkName);
// If ActiveWindow.View.SplitSpecial <> wdPaneNone Then
// ActiveWindow.Panes(2).Close
// End If
if(oWordApplic.ActiveWindow.View.SplitSpecial != Word.WdSpecialPane.wdPaneNone)
oWordApplic.ActiveWindow.Panes[2].Close();
// If ActiveWindow.ActivePane.View.Type = wdNormalView Or ActiveWindow. _
// ActivePane.View.Type = wdOutlineView Then
// ActiveWindow.ActivePane.View.Type = wdPrintView
// End If
if(oWordApplic.ActiveWindow.View.Type == Word.WdViewType.wdNormalView
|| oWordApplic.ActiveWindow.View.Type == Word.WdViewType.wdOutlineView)
oWordApplic.ActiveWindow.ActivePane.View.Type = Word.WdViewType.wdPrintView;
// ActiveWindow.ActivePane.View.SeekView = wdSeekCurrentPageHeader
oWordApplic.ActiveWindow.ActivePane.View.SeekView = Word.WdSeekView.wdSeekCurrentPageHeader;
this.GoToTheEnd();
// this.GotoBookMark(strBookmarkName);
this.SetFontColor(Word.WdColor.wdColorDarkBlue);
this.InsertText(text);
// ActiveWindow.ActivePane.View.SeekView = wdSeekMainDocument
oWordApplic.ActiveWindow.ActivePane.View.SeekView = Word.WdSeekView.wdSeekMainDocument;
}
4.项目符号及多级项目符号的Style问题
这个问题我的解决中有点问题,要和模板一起设置才能用,感觉不好,就不拿出来给大家看了,以免误导大家了
5.添加特殊字符的问题
当你要在文档中添加特殊文字的时候(如你想添加一个þ),不能直接通过简单的复制粘贴来实现(你根本没办法在.NET的IDE下看到þ)。这时,我们可以通过查找这个特殊字符的字体名称和代表的16进制编码来插入。我们可以查到þ所在的字符集是Wingdings,它的16进制编码是\u00fe,这时,我们就能对这个þ进行插入,具体代码如:
test.SetFontName("Wingdings");
test.SetFontColor(Word.WdColor.wdColorDarkBlue);
test.InsertText("\u00fe");
test.SetFontColor(Word.WdColor.wdColorDarkBlue);
test.InsertText("\u00fe");
如果大家反映强烈,我可以贴出我的代码,Web的和WinForm的都有。
听说那个Michela的demo文件下载不下来,现贴上我以前下载的他的文件/Files/sharemeteor/WordApplication.rar