Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## application.workbooks.workbook.documents.document
Class BookMarks

    java.lang.Object
      application.workbooks.workbook.documents.document.BookMarks

public class BookMarks
extends java.lang.Object

该类定义了在文档的当前章节中插入书签，定位和删除当前文档中书签的方法。

Method Summary
`void` | `addBookMark(long offset, long length, AbstractText absText, java.lang.String bookMarkName)` 在当前节中添加书签。
`BookMark` | `getBookMark(java.lang.String bookMarkName)` 返回指定的书签。
`java.lang.String[]` | `getBookMarkNames()` 返回当前文档内所有书签名的一个字符串集合。
`void` | `locateBookMark(java.lang.String bookMarkName)` 将光标定位到指定的书签。
`void` | `removeAllBookMark()` 在当前文档中删除所有的书签。
`void` | `removeBookMark(java.lang.String bookMarkName)` 在当前文档中删除指定的书签。

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### addBookMark

    public void addBookMark(long offset,
                            long length,
                            AbstractText absText,
                            java.lang.String bookMarkName)

  在当前节中添加书签。

  Parameters:
    `offset` - 在文本中插入书签的位置（当前章节的相应位置）
    `length` - 插入书签的长度
    `bookMarkName` - 为插入的书签起一个名字

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         BookMarks bookMarks = doc.getBookMarks();
         bookMarks.addBookMark(20,5,baseText,"书签1");

  See Also:
    `locateBookMark(String)`, `removeBookMark(String)`, `removeAllBookMark()`

### getBookMark

    public BookMark getBookMark(java.lang.String bookMarkName)

  返回指定的书签。

  Parameters:
    `bookMarkName` - 指定书签的名字
  Returns:
    返回书签，当指定书签不存在则返回null。

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         BookMarks bookMarks = doc.getBookMarks();
         BookMark bookMark = bookMarks.getBookMark("书签1");

### getBookMarkNames

    public java.lang.String[] getBookMarkNames()

  返回当前文档内所有书签名的一个字符串集合。

  Returns:
    当前文档内所有书签名的一个字符串集合，为数组形式

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         BookMarks bookMarks = doc.getBookMarks();
         bookMarks.addBookMark(20,5,baseText,"书签1");
         bookMarks.addBookMark(50,5,baseText,"书签2");
         String[] bookNames = bookMarks.getBookMarkNames();
         for(int i = 0; i < bookNames.length; i++)
         {
            System.out.println("书签" + i + "的书签名为：" + bookNames[i]);
         }

### locateBookMark

    public void locateBookMark(java.lang.String bookMarkName)

  将光标定位到指定的书签。

  Parameters:
    `bookMarkName` - 指定要定位的书签的名字

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         BookMarks bookMarks = doc.getBookMarks();
         bookMarks.addBookMark(20,5,baseText,"书签1");
         bookMarks.addBookMark(50,5,baseText,"书签2");
         bookMarks.locateBookMark("书签1");

  See Also:
    `#addBookMark(long,long,BaseText,String)`, `removeBookMark(String)`, `removeAllBookMark()`

### removeAllBookMark

    public void removeAllBookMark()

  在当前文档中删除所有的书签。

  例子:

       //请输入一些文字
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       BaseText baseText = section.getBaseText();
       BookMarks bookMarks = doc.getBookMarks();
       bookMarks.addBookMark(20,5,baseText,"书签1");
       bookMarks.addBookMark(50,5,baseText,"书签2");
       bookMarks.removeAllBookMark();

  See Also:
    `#addBookMark(long,long,BaseText,String)`, `locateBookMark(String)`, `removeBookMark(String)`

### removeBookMark

    public void removeBookMark(java.lang.String bookMarkName)

  在当前文档中删除指定的书签。

  Parameters:
    `bookMarkName` - 指定要删除的书签的名字

    例子:

         //请输入一些文字
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         BookMarks bookMarks = doc.getBookMarks();
         bookMarks.addBookMark(20,5,baseText,"书签1");
         bookMarks.addBookMark(50,5,baseText,"书签2");
         bookMarks.removeBookMark("书签1");

  See Also:
    `#addBookMark(long,long,BaseText,String)`, `locateBookMark(String)`, `removeAllBookMark()`

Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

版权所有 2001-2004 无锡永中科技有限公司