概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

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

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

    public class BookMarks

extends java.lang.Object

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

方法摘要
`BookMark` | `add(TextRange range, java.lang.String name)` 在文档中添加一个书签。
`BookMark` | `get(java.lang.String bookmarkName)` 返回指定的书签。
`BookMark[]` | `getAllBookmarks()` 返回当前文档内所有书签名的一个字符串集合。
`java.lang.String[]` | `getBookmarkNames()` 返回当前文档内所有书签名的一个字符串集合。
`static int` | `getSortType()` 返回书签名称排列的方式。
`static boolean` | `isShowHide()` 返回是否显示隐藏书签
`void` | `locateBookmark(java.lang.String bookmarkName)` 将光标定位到指定的书签。
`void` | `remove(java.lang.String bookmarkName)` 在当前文档中删除指定的书签。
`void` | `removeAll()` 在当前文档中删除所有的书签。
`static void` | `setShowHide(boolean hide)` 设置是否显示隐藏书签。
`static void` | `setSortType(int type)` 设置书签名称排列的方式。

从类 java.lang.Object 继承的方法
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

方法详细信息

### add

    public BookMark add(TextRange range,
                        java.lang.String name)

  在文档中添加一个书签。

  参数：
    `range` - 添加书签的文本区域
    `name` - 新书签的名字
  返回：
    返回一个新书签

    例子：

         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(5,5,baseText,"书签1");

  抛出：
    `MacroRunException` - 当书签名name为空或者空格.
  另请参见：
    `locateBookmark(String)`, `remove(String)`, ``

### get

    public BookMark get(java.lang.String bookmarkName)

  返回指定的书签。

  参数：
    `bookmarkName` - 指定书签的名字
  返回：
    返回书签，当指定书签不存在则返回null。

    例子：

         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");
         BookMark bookmark = bookmarks.get("书签1");
         System.out.println("name is " + bookmark.getName());

### getAllBookmarks

    public BookMark[] getAllBookmarks()

  返回当前文档内所有书签名的一个字符串集合。 如果设置显示隐藏的书签，则数组中包含隐藏书签，否则不包含隐藏书签。

  返回：
    当前文档内所有书签的集合，为数组形式

    例子：

         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]);
         }

### getBookmarkNames

    public java.lang.String[] getBookmarkNames()

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

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

    例子：

         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]);
         }

### getSortType

    public static int getSortType()

  返回书签名称排列的方式。

  返回：
    书签名称排列的方式

         0 : 按名称排列
         1 : 按位置排列

    例子：

         System.out.println("书签排列方式为："+BookMarks.getSortType());

### isShowHide

    public static boolean isShowHide()

  返回是否显示隐藏书签

  返回：
    是否显示隐藏书签

    例子：

         System.out.println("是否显示隐藏书签："+BookMarks.isShowHide());

### locateBookmark

    public void locateBookmark(java.lang.String bookmarkName)

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

  参数：
    `bookmarkName` - 指定要定位的书签的名字

    例子：

         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");

  抛出：
    `MacroRunException` - 当书签名为空时.
  另请参见：
    `add(long,long,AbstractText,String)`, `remove(String)`, ``

### remove

    public void remove(java.lang.String bookmarkName)

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

  参数：
    `bookmarkName` - 指定要删除的书签的名字

    例子：

         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");

  另请参见：
    `add(long,long,AbstractText,String)`, `locateBookmark(String)`, `removeAll()`

### removeAll

    public void removeAll()

  在当前文档中删除所有的书签。 如果设置显示隐藏的书签，则包含隐藏书签，否则不包含隐藏书签。

  例子：

       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();

  另请参见：
    `add(long,long,AbstractText,String)`, `locateBookmark(String)`, `remove(String)`

### setShowHide

    public static void setShowHide(boolean hide)

  设置是否显示隐藏书签。如果为true，则使用getAllBookmark、getBookmarkNames、removeAll方法时,将包含隐藏的书签。

  参数：
    `hide` - 是否显示隐藏书签

    例子：

         BookMarks.setShowHide(true);

### setSortType

    public static void setSortType(int type)

  设置书签名称排列的方式。

  参数：
    `type` - 书签名称排列的方式。

         0 : 按名称排列
         1 : 按位置排列

    例子：

         BookMarks.setSortType(0);

概述 | 软件包 | 类 | 树 | 索引 | 帮助

上一个类 下一个类 | 框架 无框架
摘要： 嵌套 | 字段 | 构造函数 | 方法 | 详细信息： 字段 | 构造函数 | 方法

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