bookmarks.html

永中OFFICE二次开发帮助文档

getAllBookmarks</H3>
<PRE>
public <A HREF="../../../../../application/workbooks/workbook/documents/document/bookmarks/BookMark.html" title="application.workbooks.workbook.documents.document.bookmarks 中的类">BookMark</A>[] <B>getAllBookmarks</B>()</PRE>
<DL>
<DD>返回当前文档内所有书签名的一个字符串集合。
 如果设置显示隐藏的书签，则数组中包含隐藏书签，否则不包含隐藏书签。
<P>
<DD><DL>

<DT><B>返回：</B><DD>当前文档内所有书签的集合，为数组形式
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 baseText.insertText(0,"this is a test!,this is a test!");
 BookMarks bookmarks = doc.getBookmarks();
 bookmarks.add(10,5,baseText,"书签1");
 bookmarks.add(20,5,baseText,"书签2");
 BookMark[] marks = bookmarks.getAllBookmarks();
 for(int i = 0; i < marks.length; i++)
 {
    System.out.println("书签" + i + "为：" + marks[i]);
 }
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getBookmarkNames()"><!-- --></A><H3>
getBookmarkNames</H3>
<PRE>
public java.lang.String[] <B>getBookmarkNames</B>()</PRE>
<DL>
<DD>返回当前文档内所有书签名的一个字符串集合。
<P>
<DD><DL>

<DT><B>返回：</B><DD>当前文档内所有书签名的一个字符串集合，为数组形式
 <p>
 <b>例子：</b>
 <pre> 
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 baseText.insertText(0,"this is a test!this is a test!");
 BookMarks bookmarks = doc.getBookmarks();
 bookmarks.add(10,5,baseText,"书签1");
 bookmarks.add(20,5,baseText,"书签2");
 String[] bookNames = bookmarks.getBookmarkNames();
 for(int i = 0; i < bookNames.length; i++)
 {
    System.out.println("书签" + i + "的书签名为：" + bookNames[i]);
 }
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="getSortType()"><!-- --></A><H3>
getSortType</H3>
<PRE>
public static int <B>getSortType</B>()</PRE>
<DL>
<DD>返回书签名称排列的方式。
<P>
<DD><DL>

<DT><B>返回：</B><DD>书签名称排列的方式
 <pre>
 0 : 按名称排列
 1 : 按位置排列
 </pre>
 <p>
 <b>例子：</b>
 <pre>
 System.out.println("书签排列方式为："+BookMarks.getSortType());
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="isShowHide()"><!-- --></A><H3>
isShowHide</H3>
<PRE>
public static boolean <B>isShowHide</B>()</PRE>
<DL>
<DD>返回是否显示隐藏书签
<P>
<DD><DL>

<DT><B>返回：</B><DD>是否显示隐藏书签
 <p>
 <b>例子：</b>
 <pre>
 System.out.println("是否显示隐藏书签："+BookMarks.isShowHide());
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="locateBookmark(java.lang.String)"><!-- --></A><H3>
locateBookmark</H3>
<PRE>
public void <B>locateBookmark</B>(java.lang.String&nbsp;bookmarkName)</PRE>
<DL>
<DD>将光标定位到指定的书签。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>bookmarkName</CODE> - 指定要定位的书签的名字
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 baseText.insertText(0,"this is a test!");
 BookMarks bookmarks = doc.getBookmarks();
 bookmarks.add(0,2,baseText,"书签1");
 bookmarks.add(5,5,baseText,"书签2");
 bookmarks.locateBookmark("书签1");
 </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/workbook/documents/document/BookMarks.html#add(long, long, application.workbooks.workbook.documents.document.section.AbstractText, java.lang.String)"><CODE>add(long,long,AbstractText,String)</CODE></A>, 
<A HREF="../../../../../application/workbooks/workbook/documents/document/BookMarks.html#remove(java.lang.String)"><CODE>remove(String)</CODE></A>, 
<A HREF="../../../../../application/workbooks/workbook/documents/document/BookMarks.html#removeAll()"><CODE></pre></CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="remove(java.lang.String)"><!-- --></A><H3>
remove</H3>
<PRE>
public void <B>remove</B>(java.lang.String&nbsp;bookmarkName)</PRE>
<DL>
<DD>在当前文档中删除指定的书签。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>bookmarkName</CODE> - 指定要删除的书签的名字
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 baseText.insertText(0,"this is a test!this is a test!");
 BookMarks bookmarks = doc.getBookmarks();
 bookmarks.add(10,5,baseText,"书签1");
 bookmarks.add(20,5,baseText,"书签2");
 bookmarks.remove("书签1");
 </pre><DT><B>另请参见：</B><DD><A HREF="../../../../../application/workbooks/workbook/documents/document/BookMarks.html#add(long, long, application.workbooks.workbook.documents.document.section.AbstractText, java.lang.String)"><CODE>add(long,long,AbstractText,String)</CODE></A>, 
<A HREF="../../../../../application/workbooks/workbook/documents/document/BookMarks.html#locateBookmark(java.lang.String)"><CODE>locateBookmark(String)</CODE></A>, 
<A HREF="../../../../../application/workbooks/workbook/documents/document/BookMarks.html#removeAll()"><CODE>removeAll()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="removeAll()"><!-- --></A><H3>
removeAll</H3>
<PRE>
public void <B>removeAll</B>()</PRE>
<DL>
<DD>在当前文档中删除所有的书签。
 如果设置显示隐藏的书签，则包含隐藏书签，否则不包含隐藏书签。
 <p>
 <b>例子：</b>
 <pre>
 Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
 Section section = doc.getSection(0);
 BaseText baseText = section.getBaseText();
 baseText.insertText(0,"this is a test!this is a test!");
 BookMarks bookmarks = doc.getBookmarks();
 bookmarks.add(10,5,baseText,"书签1");
 bookmarks.add(20,5,baseText,"书签2");;     
 bookmarks.removeAll();
 </pre>
<P>
<DD><DL>
<DT><B>另请参见：</B><DD><A HREF="../../../../../application/workbooks/workbook/documents/document/BookMarks.html#add(long, long, application.workbooks.workbook.documents.document.section.AbstractText, java.lang.String)"><CODE>add(long,long,AbstractText,String)</CODE></A>, 
<A HREF="../../../../../application/workbooks/workbook/documents/document/BookMarks.html#locateBookmark(java.lang.String)"><CODE>locateBookmark(String)</CODE></A>, 
<A HREF="../../../../../application/workbooks/workbook/documents/document/BookMarks.html#remove(java.lang.String)"><CODE>remove(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setShowHide(boolean)"><!-- --></A><H3>
setShowHide</H3>
<PRE>
public static void <B>setShowHide</B>(boolean&nbsp;hide)</PRE>
<DL>
<DD>设置是否显示隐藏书签。如果为true，则使用getAllBookmark、getBookmarkNames、removeAll方法时,将包含隐藏的书签。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>hide</CODE> - 是否显示隐藏书签
 <p>
 <b>例子：</b>
 <pre>
 BookMarks.setShowHide(true);
 </pre></DL>
</DD>
</DL>
<HR>

<A NAME="setSortType(int)"><!-- --></A><H3>
setSortType</H3>
<PRE>
public static void <B>setSortType</B>(int&nbsp;type)</PRE>
<DL>
<DD>设置书签名称排列的方式。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>type</CODE> - 书签名称排列的方式。 
 <pre>
 0 : 按名称排列
 1 : 按位置排列
 </pre>
 <p>
 <b>例子：</b>
 <pre>
 BookMarks.setSortType(0);
 </pre></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/AutoCaptions.html" title="application.workbooks.workbook.documents.document 中的类"><B>上一个类</B></A>&nbsp;
&nbsp;<A HREF="../../../../../application/workbooks/workbook/documents/document/CaptionLabel.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/BookMarks.html" target="_top"><B>框架</B></A>  &nbsp;
&nbsp;<A HREF="BookMarks.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;构造方法&nbsp;|&nbsp;<A HREF="#method_summary">方法</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
详细信息：&nbsp;字段&nbsp;|&nbsp;构造方法&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>