workbooks.html

永中OFFICE二次开发帮助文档

</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>从类 java.lang.Object 继承的方法</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>构造方法详细信息</B></FONT></TH>
</TR>
</TABLE>

<A NAME="Workbooks()"><!-- --></A><H3>
Workbooks</H3>
<PRE>
public <B>Workbooks</B>()</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>方法详细信息</B></FONT></TH>
</TR>
</TABLE>

<A NAME="addWorkbook(int)"><!-- --></A><H3>
addWorkbook</H3>
<PRE>
public <A HREF="../application/workbooks/Workbook.html" title="application.workbooks 中的类">Workbook</A> <B>addWorkbook</B>(int&nbsp;type)</PRE>
<DL>
<DD>新建一个集成文件。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>type</CODE> - 应用类型，只能取以下四值之一：
 <pre>
          GlobalConstants.NO_PRODUCT    =空的集成文件;
          GlobalConstants.SPREADSHEET   =电子表格集成文件；
          GlobalConstants.WORDPROCESSOR =文字处理集成文件；
          GlobalConstants.PRESENTATION  =简报制作集成文件；
 </pre>
<DT><B>返回：</B><DD>创建的Workbook,当新建不成功时返回null。
 <p>
 <b>例子：</b>
 <pre>
 //新建一简报制作集成文件。
 Workbooks workbooks = Application.getWorkbooks();
 workbooks.addWorkbook(GlobalConstants.PRESENTATION);
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 应用类型不在上述四个中。<DT><B>另请参见：</B><DD><A HREF="../application/Workbooks.html#addWorkbook(java.lang.String, int)"><CODE>addWorkbook(String, int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addWorkbook(java.lang.String, int)"><!-- --></A><H3>
addWorkbook</H3>
<PRE>
public <A HREF="../application/workbooks/Workbook.html" title="application.workbooks 中的类">Workbook</A> <B>addWorkbook</B>(java.lang.String&nbsp;bookName,
                            int&nbsp;type)</PRE>
<DL>
<DD>新建一个自定义名字的集成文件。
 <p>
 因为在当前Workbooks下面集成文件的名称具有唯一性，所以添加的文件名称必须与已有的不重复。
 <p>
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>bookName</CODE> - 是一个文件名，默认将其新建在缺省保存路径里。<DD><CODE>type</CODE> - 应用类型，只能取以下四值之一：
 <pre>
          GlobalConstants.NO_PRODUCT    =空的集成文件;
          GlobalConstants.SPREADSHEET   =电子表格集成文件；
          GlobalConstants.WORDPROCESSOR =文字处理集成文件；
          GlobalConstants.PRESENTATION  =简报制作集成文件；
 </pre>
<DT><B>返回：</B><DD>新建的Workbook，当新建不成功时返回null。
 <p>
 <b>例子：</b>
 <pre>
 //新建一名字为test.eio的文字处理集成文件。
 Application.getWorkbooks().addWorkbook("test.eio",GlobalConstants.WORDPROCESSOR);
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 文件名称不合法。<DT><B>另请参见：</B><DD><A HREF="../application/Workbooks.html#addWorkbook(int)"><CODE>addWorkbook(int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="addWorkbookByTemplate(java.lang.String)"><!-- --></A><H3>
addWorkbookByTemplate</H3>
<PRE>
public <A HREF="../application/workbooks/Workbook.html" title="application.workbooks 中的类">Workbook</A> <B>addWorkbookByTemplate</B>(java.lang.String&nbsp;templateName)</PRE>
<DL>
<DD>新建一个带模板样式的集成文件。
 <p>
 新建的集成文件名称为默认名称如"集成文件3.eio"而不是模版样式的名称。
 <p>
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>templateName</CODE> - 模板文件名（绝对路径）
<DT><B>返回：</B><DD>新建的集成文件，当新建不成功时返回null。
 <p>
 <b>例子：</b>
 <pre>
 //新建一模版样式为调查问卷的集成文件。
 Application.getWorkbooks().addWorkbookByTemplate("C:/Program Files/Evermore/EIOffice/Templates/Wordprocessor/通用文书/调查问卷.eit");
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 模板文件名名称不合法。<DT><B>另请参见：</B><DD><A HREF="../application/Workbooks.html#addWorkbook(int)"><CODE>addWorkbook(int)</CODE></A>, 
<A HREF="../application/Workbooks.html#addWorkbook(java.lang.String, int)"><CODE>addWorkbook(String, int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="clearClipboard()"><!-- --></A><H3>
clearClipboard</H3>
<PRE>
public void <B>clearClipboard</B>()</PRE>
<DL>
<DD>清除剪贴板的内容。
 <p>
 <b>例子：</b>
 <pre>
 //清除剪贴板内容
 Workbooks workbooks = Application.getWorkbooks();
 workbooks.clearClipboard() ;
 </pre>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="clearDifference()"><!-- --></A><H3>
clearDifference</H3>
<PRE>
public void <B>clearDifference</B>()</PRE>
<DL>
<DD>清除文档比对高亮显示。
 <p>
 <b>例子: </b> 
 <pre>
 //清除文档比对高亮显示。
 Application.getWorkbooks().clearDifference();
 </pre>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="closeAll()"><!-- --></A><H3>
closeAll</H3>
<PRE>
public void <B>closeAll</B>()</PRE>
<DL>
<DD>关闭永中集成Office中的所有集成文件。
 <p>
 <b>例子：</b>
 <pre>
 //关闭所有集成文件。
 Application.getWorkbooks().closeAll();
 </pre>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createWorkbookFromByteArray(byte[], java.lang.String)"><!-- --></A><H3>
createWorkbookFromByteArray</H3>
<PRE>
public <A HREF="../application/workbooks/Workbook.html" title="application.workbooks 中的类">Workbook</A> <B>createWorkbookFromByteArray</B>(byte[]&nbsp;data,
                                            java.lang.String&nbsp;bookName)
                                     throws java.io.IOException</PRE>
<DL>
<DD>从一个byte数组创建一个永中Office文件。
 <p>
 当data数组为null，或者不是通过getWorkbookAsByteArray方法得到的数组
 或者bookName为null或为空，或者创建不成功,则返回null。
 <p>
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>data</CODE> - 以byte数组表示的数据源，此数组是通过getWorkbookAsByteArray()方法创建的。<DD><CODE>bookName</CODE> - 要创建的集成文件名称。
<DT><B>返回：</B><DD>返回新建的Workbook。
 <p>
 <b>例子：</b>
 <pre>
 //把当前集成文件复制成byte数组，再关闭当前集成文件，然后利用这byte数组新建一名为test12.eio的集成文件。
 try
 {
    Workbook book1 = Application.getWorkbooks().getActiveWorkbook();
    byte[] bytes = Application.getWorkbooks().getWorkbookAsByteArray(book);
    book1.close();
    Workbook book2 = Application.getWorkbooks().createWorkbookFromByteArray(bytes,"test12.eio");
 }
 catch(IOException e)
 {
 }
 </pre>
<DT><B>抛出：</B>
<DD><CODE>java.io.IOException</CODE> - 从byte数组创建Workbook失败时抛出异常。<DT><B>另请参见：</B><DD><A HREF="../application/Workbooks.html#getWorkbookAsByteArray(application.workbooks.Workbook)"><CODE>getWorkbookAsByteArray(Workbook)</CODE></A>, 
<A HREF="../application/Workbooks.html#getWorkbookAsByteArray(application.workbooks.Workbook, int)"><CODE>getWorkbookAsByteArray(Workbook, int)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getActiveWorkbook()"><!-- --></A><H3>
getActiveWorkbook</H3>
<PRE>
public <A HREF="../application/workbooks/Workbook.html" title="application.workbooks 中的类">Workbook</A> <B>getActiveWorkbook</B>()</PRE>
<DL>
<DD>获取当前活动集成文件。
<P>
<DD><DL>

<DT><B>返回：</B><DD>当前活动集成文件
 <p>
 <b>例子：</b>
 <pre>
 //获取当前活动集成文件并保存它。
 Workbook workbook = Application.getWorkbooks().getActiveWorkbook(); 
 workbook.save();
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getAllWorkbooks()"><!-- --></A><H3>
getAllWorkbooks</H3>
<PRE>
public <A HREF="../application/workbooks/Workbook.html" title="application.workbooks 中的类">Workbook</A>[] <B>getAllWorkbooks</B>()</PRE>
<DL>
<DD>获得当前的所有集成文件对象的数组。
<P>
<DD><DL>

<DT><B>返回：</B><DD>集成文件对象数组。
 <p>
 <b>例子：</b>
 <pre>
 //获得当前的所有集成文件对象，并在其数组第0个添加一同心圆。
 Workbook[] books = Application.getWorkbooks().getAllWorkbooks();
 books[0].getActiveShapes().addShape(18,80,100,290,280);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getWorkbook(java.lang.String)"><!-- --></A><H3>
getWorkbook</H3>
<PRE>
public <A HREF="../application/workbooks/Workbook.html" title="application.workbooks 中的类">Workbook</A> <B>getWorkbook</B>(java.lang.String&nbsp;bookName)</PRE>
<DL>
<DD>根据集成文件名称获取集成文件对象。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>bookName</CODE> - 集成文件名
<DT><B>返回：</B><DD>集成文件对象
 <p>
 <b>例子：</b>
 <pre>
 //获取名为"集成文件1.eio"的集成文件并保存它。
 Workbook workbook = Application.getWorkbooks().getWorkbook("集成文件1.eio");
 workbook.save() ;
 </pre></DL>
</DD>
</DL>
<HR>