永中Office二次开发技术手册

永中Office二次开发技术手册前言一、宏和二次开发在实现办公自动化的今天，我们经常会碰到这样一个问题，在使用办公软件时总要重复流程一样的相同操作，这使工作变得繁琐而枯燥，能不能提供一种方法，使这些相同操作能够通过一个命令自动完成或者使用更为简单的途径得到呢？宏因此而产生了。宏是指用一个符号名称所代表的一段程序代码，将定义代码段按实际参数进行加工，形成实际代码直接插入程序的执行序列中。许多应用程序具有建立宏的功能，它们可以把操作人员为解决某项问题而执行的一些操作命令记下来，形成一个文件段，并且用一个符号表示。当同样的问题重复执行时，只要输入代表这一系列命令的宏命令即可。这些代码可以是由用户编写，也可以通过办公软件提供的宏录制功能记录下简单任务而生成。结合自己的需要，利用宏充分开发应用程序潜在的功能，可以获得使用上最大限度的满足，这也就是通常意义上的二次开发，即利用宏语言扩展宿主程序的功能、集成不同类型的数据以实现办公软件在具体事件中的解决方案。永中Office为您提供了非常丰富而全面的宏API（API表示应用程序接口），通过这些API您可以非常自如操作永中Office。并且使您在实现自定义的解决方案时更加得心应手，更灵活的发挥永中Office的集成优势。二、本手册结构第一部分为二次开发环境。永中Office的二次开发，我们推荐，一是利用永中Office自带的宏编辑器进行开发，二是可以在Eclipse上开发。第二部分为应用和API我们在第2章给出了二次开发结构，也即永中Office二次开发的类层次图。有了该类层次图，就可以了解永中Office二次开发中的层次和对象了。第3章为总控,这里有二次开发应用的总入口第4章为电子表格应用第5章为文字处理应用,自由表格也在这一章第6章为幻灯片演示第7章为公共组件，包含2个主要组件：自选图形和图表第三部分为其它语言调用与应用第8章为永中OfficeCOM组件开发第9章为嵌入浏览器样例第10章为嵌入Java应用程序样例附录附录一为永中Office二次开发技巧集,我们列举了一些二次开发技巧附录一为永中Office二次开发FAQ我们希望起到抛砖引玉的作用。详细的API说明可以参见永中Office的API文档。第一章二次开发环境1.1宏编辑器中进行二次开发1、从菜单“工具”—》“宏”—》“宏编辑器”，打开宏编辑器。2、在宏编辑器中，从菜单“插入”—》“模块”，新建一个模块。3、在模块中，可以添加宏，通过宏，就可以操作永中Office。4、示例：将下面的宏代码添加到模块中，宏的名字是“insertValue”。样例1.1.1//在当前的工作表中，往单元格（2，3）中设值“apple”。voidinsertValue(){Application.gotoProduct(GlobalConstants.SPREADSHEET);Workbookworkbook=Application.getWorkbooks().getActiveWorkbook();Worksheetsheet=workbook.getWorksheets().getActiveWorksheet();sheet.setCellValue(2,3,apple);}注意：永中Office的宏语言是JAVA。在模块中添加宏时，请不要添加方法的修饰符，如public，private，protected，static，final等。永中Office的宏只能在永中Office自己的文件格式（.eio）中使用，保存为微软格式文件时宏代码会丢失。1.2使用Eclipse进行二次开发1、下载并解压Eclipse包。2、在Eclipse目录下点击Eclipse可执行文件，启动Eclipse。3、在Eclipse中，新建一个项目：在菜单“File”—》“New”—》“Project...”弹出“NewProject”对话框，在列表中选中“JavaProject”选项，下一步，给定一个项目名，假设项目名为“example”，完成，这样就建立了一个名为“example”的项目。4、在Eclipse的“PackageExplorer”里，选中“example”节点，右键弹出菜单，点击“Properties”菜单项，在弹出的“Properties”对话框中选中左边的“JavaBuildPath”，选中对话框右边的第三项“Libraries”页面，点击“AddExternalJars...”按钮，将永中Office按装目录下的“Yozo_Office.jar”添加进编译环境。这样就可以应用永中Office的开发包对永中Office进行二次开发了。5、在Eclipse的“PackageExplorer”里，选中“example”节点，选择菜单“File”-“New”-“Class”弹出“NewJavaClass”对话框，填写类名称，假设为“MyTest”，点击完成按钮，这样就在项目“example”中建立了一个名为“MyTest”的新类。第二章二次开发对象层次结构API是ApplicationProgrammingInterface（应用程序编程接口）的缩写，即一个主应用程序的开发者提供给其他开发者使用的服务和功能。这意味着API允许一些外部程序访问提供API的程序，即另外的程序通过主应用程序的API而使用某一个子程序的功能。许多大的应用程序都提供了API供二次开发者使用，如各种程序开发语言、各种操作系统及办公软件等。API不仅仅可以被外部应用程序使用，许多大型应用程序也使用API以便于自身程序的一部分与另一部分联系。如果一套服务或帮助功能——一个大应用程序的内核已被建立，那么，一个做完了的API就可以使开发应用程序的剩余部分变得十分轻松；此外，将其中一部分常用而且稳定的API开放给用户，用户在此基础上可以根据自己的需要开发出更加强大和个性化的功能，产品功能在适用过程中得到扩展，与用户的交互性也因此而更强。基于跨平台操作的特性，永中Office充分考虑到用户对功能扩展的要求、不同需求对解决方案的要求及个性化等其它各方面的要求，在其内置的宏编辑器中提供了一整套实现内部功能的API供用户调用；此外，永中Office宏编辑器还支持导入JAVA的类库以使用JAVA语言强大而丰富的类。任何API都是基于对象的操作，在操作对象的基础上实现功能。永中Office二次开发的API即相当于JAVA语言中的方法，既可以是对某一对象单个属性或事件的控制和操作，也可以是对整个对象进行的操作，从而实现形式多样的功能。2.1单实例和多实例永中Office二次开发体系支持单实例和多实例两种方式。单实例方式通常在永中Office的宏编辑器中使用，多实例方式通常在外部调用永中Office时使用。单实例和多实例在代码中的差别体现在创建永中Office实例时，下面是示例代码：单实例示例：//创建永中Office桌面应用单实例示例Application.getApplicationInstance()多实例示例：样例2.1.1//创建永中Office桌面应用多实例//永中Office初始化参数AppParametersappParams=AppParameters.getInstance();//创建永中Office实例ApplicationFactory.createInstance(appParams);单实例和多实例除创建永中Office实例外，在具体功能性API调用方面没有差别。更多单实例和多实例的操作见C3.1。注意：本手册中为方便描述，除明确说明外，其它代码均以多实例方式描述。2.2二次开发对象层次结构永中OfficeAPI的对象体系是基于一种继承的结构，要访问一个对象，必须清楚该对象在整个对象体系中的位置，通过JAVA的对象运算符“.”从包含该对象的最外层开始，由外及内逐层找到其子对象，一直到所要访问的对象。如要访问文件名为“文件1.eio”的电子表格文档中“工作表1”的“A1”单元格，需按如下格式书写：Application.getWorkbooks().getWorkbook(C:/文件1.eio).getWorksheet(工作表1).getCell(A1);为了使代码简洁，可以使用访问对象的简化格式。如果某对象的父对象是当前对象，那么就可以直接对其子对象进行访问，例如以下是一个先打开一个文档然后对其子对象进行操作的代码示例：样例2.1.2//设置指定单元格内容//新建电子表格应用Workbookworkbook=app.getWorkbooks().addWorkbook(GlobalConstants.SPREADSHEET);//获得电子表格应用文件中的工作表1Worksheetworksheet=workbook.getWorksheets().getWorksheet(工作表1);//在当前工作表中选择单元格“A1”Cella1=worksheet.getCell(A1);//在A1单元格中设值a1.setValue(apple);//在当前工作表中选择单元格“A2”ActiveWorksheet.select(A2);//当前单元格设值ActiveCell.setValue(Lenny);在永中Office的宏中，把所有具有相同属性和方法的，在对象体系中位于同一层次的对象划归为一个对象类，例如，在电子表格中，工作表的每个单元格都是一个Cell对象，这些Cell对象共同构成了Cell对象类。永中Office宏编辑器提供的所有对象层次的顶部是Application，所有这些对象的访问都必须从Application开始。以下是永中Office宏编辑器常用对象的层次结构图。永中office二次开发对象层次图WindowsWindow窗体集合窗体Options应用设置CommandBarCommandBarsApplication永中Office单实例工具栏工具栏集合WorkbookWorkbooks集成文件集成文件集合PDFAttributePDF文件属性Versions版本管理ChartsChart图表图表集合WorksheetsWorksheet工作表电子表格工作表集合DocumentsDocumentWorkbook集成文件文字处理文档文字处理文档集合PresentationsPresentation简报简报制作文档集合TablesTable表格表格集合FileProperties文件属性ShapeShapes自选图形自选图形集合集合对象单个对象IApplicationApplicationFactiroy永中Office多实例永中Office多实例管理器永中Office实例电子表格对象层次图Characters字符属性FontAttributeCell字体属性单元格FillAttribute列操作集填充属性ColumnsFormatCellAttribute格式属性控件管理器ComponentManagerBorderAttribute边框属性Names名称管理器ConditionalFormating条件格式Print打印设置ConditionalFormationgDataRange条件格式设置Rows单元格区域WorksheetSortProperties排序设置工作表行操作集TextSplittingProperties文本分列设置ValidationPropertiesSsPageSetup数据校验设置页面设置ScenariosSsCommentsScenario方案集合方案Comment批注集合批注HyperlinkSsHyperlinks超链接超链接集合SsShape自选图形SsShapes自选图形集合集合对象单个对象文字处理二次开发对象层次图集合对象单个对象SectionDocumentParagraphParagrahpsBaseText文档节段落集合段落正文编辑区域FootNoteOptionsFootNote脚注属性（正文管理）脚注