tableofcontent.html

永中OFFICE二次开发帮助文档

<HR>

<A NAME="isBuildFromOutlineLevel()"><!-- --></A><H3>
isBuildFromOutlineLevel</H3>
<PRE>
public boolean <B>isBuildFromOutlineLevel</B>()</PRE>
<DL>
<DD>判断目录是否建自大纲级别
<P>
<DD><DL>

<DT><B>返回：</B><DD>布尔型值，如果目录建自大纲级别，返回true；否则，返回false
  <p>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 baseText.insertTableOfContent(0,toc);
 toc = baseText.getTableOfContent(0,4);
 System.out.println("当前目录是否建自大纲级别："+toc.isBuildFromOutlineLevel());
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="isBuildFromStyles()"><!-- --></A><H3>
isBuildFromStyles</H3>
<PRE>
public boolean <B>isBuildFromStyles</B>()</PRE>
<DL>
<DD>判断目录是否建自样式
<P>
<DD><DL>

<DT><B>返回：</B><DD>布尔型值，如果目录建自样式，返回true；否则，返回false
  <p>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 baseText.insertTableOfContent(0,toc);
 toc = baseText.getTableOfContent(0,4);
 System.out.println("当前目录是否建自样式："+toc.isBuildFromStyles());
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="isPageVisible()"><!-- --></A><H3>
isPageVisible</H3>
<PRE>
public boolean <B>isPageVisible</B>()</PRE>
<DL>
<DD>判断是否显示各目录项的页码。
<P>
<DD><DL>

<DT><B>返回：</B><DD>布尔型值，如为true，显示各目录项的页码；否则，不显示各目录项的页码
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 baseText.insertTableOfContent(0,toc);
 toc = baseText.getTableOfContent(0,4);
 System.out.println("当前目录是否显示各目录项的页码："+toc.isPageVisible());
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="isRight()"><!-- --></A><H3>
isRight</H3>
<PRE>
public boolean <B>isRight</B>()</PRE>
<DL>
<DD>判断页码是否右对齐。
<P>
<DD><DL>

<DT><B>返回：</B><DD>布尔型值，如果页码设置了右对齐，返回true；否则，返回false
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 baseText.insertTableOfContent(0,toc);
 toc = baseText.getTableOfContent(0,4);
 System.out.println("当前目录是否页码右对齐："+toc.isRight());
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setBuildFromOutlineLevel(boolean)"><!-- --></A><H3>
setBuildFromOutlineLevel</H3>
<PRE>
public void <B>setBuildFromOutlineLevel</B>(boolean&nbsp;flag)</PRE>
<DL>
<DD>设置目录是否建自大纲级别
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>flag</CODE> - 布尔型值，如为true，目录建自大纲级别；否则目录不建自大纲级别
  <p>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 toc.setBuildFromOutlineLevel(true);
 baseText.insertTableOfContent(0,toc);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setBuildFromStyles(boolean)"><!-- --></A><H3>
setBuildFromStyles</H3>
<PRE>
public void <B>setBuildFromStyles</B>(boolean&nbsp;flag)</PRE>
<DL>
<DD>设置目录是否建自样式
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>flag</CODE> - 布尔型值，如为true，目录建自样式；否则目录不建自样式
  <p>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 toc.setBuildFromStyles(true);
 baseText.insertTableOfContent(0,toc);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setFormat(int)"><!-- --></A><H3>
setFormat</H3>
<PRE>
public void <B>setFormat</B>(int&nbsp;format)</PRE>
<DL>
<DD>设置目录或索引的格式。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>format</CODE> - 目录的格式索引号，其常量和相应的值如下：
 <pre>
 IndexAndTableConstants.FORMAT_TEMPLATE = 0（来自模板）；
 IndexAndTableConstants.FORMAT_CLASSIC = 1（古典）；
 IndexAndTableConstants.FORMAT_DISTINCTIVE = 2（独特）；
 IndexAndTableConstants.FORMAT_FANCY  = 3（流行）；
 IndexAndTableConstants.FORMAT_MORDERN = 4（现代）；
 IndexAndTableConstants.FORMAT_FORMAL = 5（正式）；
 IndexAndTableConstants.FORMAT_SIMPLE = 6（简单）
 </pre>
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 toc.setFormat(IndexAndTableConstants.FORMAT_FANCY);
 baseText.insertTableOfContent(0,toc);
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 当参数小于0或者大于6时<DT><B>另请参见：</B><DD><A HREF="../../../../../application/constants/IndexAndTableConstants.html" title="application.constants 中的接口"><CODE>IndexAndTableConstants</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setOutlineLevelVisible(int)"><!-- --></A><H3>
setOutlineLevelVisible</H3>
<PRE>
public void <B>setOutlineLevelVisible</B>(int&nbsp;level)</PRE>
<DL>
<DD>设置需显示于目录中的标题级别数。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>level</CODE> - 标题级别数(1:标题1,2:标题2,3:标题3,...)     
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 toc.setOutlineLevelVisible(3);
 baseText.insertTableOfContent(0,toc);
 </pre>
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 当参数小于1或者大于9时</DL>
</DD>
</DL>
<HR>

<A NAME="setPageVisible(boolean)"><!-- --></A><H3>
setPageVisible</H3>
<PRE>
public void <B>setPageVisible</B>(boolean&nbsp;visible)</PRE>
<DL>
<DD>设置是否显示各目录项的页码。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>show</CODE> - 布尔型值，如为true，显示各目录项的页码；否则，不显示各目录项的页码
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 toc.setPageVisible(true);
 baseText.insertTableOfContent(0,toc);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setRight(boolean)"><!-- --></A><H3>
setRight</H3>
<PRE>
public void <B>setRight</B>(boolean&nbsp;right)</PRE>
<DL>
<DD>设置页码右对齐（即页码与右边距对齐）。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>right</CODE> - 布尔型值，如为true，设置页码右对齐；否则不设置页码右对齐
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 toc.setPageVisible(true);
 toc.setRight(true);
 baseText.insertTableOfContent(0,toc);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setStylesAndLevel(java.util.HashMap)"><!-- --></A><H3>
setStylesAndLevel</H3>
<PRE>
public void <B>setStylesAndLevel</B>(java.util.HashMap&nbsp;styles)</PRE>
<DL>
<DD>设置所有有效样式以及其各自对应的目录级别
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>styles</CODE> - 是一个容器，存放样式以及对应的级别，注：存放的都是字符串，按以下方式存放{有效样式名称,目录级别,有效样式名称,目录级别,有效样式名称,目录级别……｝
  <p>
 <b>例子:</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 toc.setBuildFromStyles(true);
 java.util.HashMap hash = new java.util.HashMap();
 hash.put("标题　1","1");
 hash.put("标题　2","2");
 hash.put("标题　3","3");
 hash.put("标题　3","4");
 toc.setStylesAndLevel(hash);
 baseText.insertTableOfContent(0,toc);
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../../../../application/exceptions/MacroRunException.html" title="application.exceptions 中的类">MacroRunException</A></CODE> - 当参数为空时
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setTabLeader(int)"><!-- --></A><H3>
setTabLeader</H3>
<PRE>
public void <B>setTabLeader</B>(int&nbsp;type)</PRE>
<DL>
<DD>设置制表位的前导符。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>type</CODE> - 制表位的前导符的类型，其常量和相应的值如下：
 <pre>
 IndexAndTableConstants.SPACES = 0 （无前导符）；
 IndexAndTableConstants.DOTS = 1（前导符为点划线）；
 IndexAndTableConstants.DASHES = 2（前导符为虚线）；
 IndexAndTableConstants.LINES = 3（前导符为实线）；
 IndexAndTableConstants.MIDDLEDOTS = 4（前导符为项目符号（点居中））
 </pre>
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 TableOfContent toc = baseText.getTableOfContent(2,4);
 toc.setTabLeader(IndexAndTableConstants.DOTS);
 baseText.insertTableOfContent(0,toc);
 </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/constants/IndexAndTableConstants.html" title="application.constants 中的接口"><CODE>IndexAndTableConstants</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="跳过导航链接"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>概述</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>软件包</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>类</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>树</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>索引</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>帮助</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../application/workbooks/workbook/documents/document/Styles.html" title="application.workbooks.workbook.documents.document 中的类"><B>上一个类</B></A>&nbsp;
&nbsp;<A HREF="../../../../../application/workbooks/workbook/documents/document/TabStops.html" title="application.workbooks.workbook.documents.document 中的类"><B>下一个类</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?application/workbooks/workbook/documents/document/TableOfContent.html" target="_top"><B>框架</B></A>  &nbsp;
&nbsp;<A HREF="TableOfContent.html" target="_top"><B>无框架</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>所有类</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>所有类</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  摘要：&nbsp;嵌套&nbsp;|&nbsp;字段&nbsp;|&nbsp;<A HREF="#constructor_summary">构造方法</A>&nbsp;|&nbsp;<A HREF="#method_summary">方法</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
详细信息：&nbsp;字段&nbsp;|&nbsp;<A HREF="#constructor_detail">构造方法</A>&nbsp;|&nbsp;<A HREF="#method_detail">方法</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
版权所有 2001-2006 无锡永中科技有限公司
</BODY>
</HTML>