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

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

## application.workbooks.workbook.documents.document.bookmarks
类 BookMark

    java.lang.Object
      application.workbooks.workbook.documents.document.bookmarks.BookMark

    public class BookMark

extends java.lang.Object

该类定义了在文档的书签的一系列操作

方法摘要
`long` | `getEndPosition()` 返回书签的结束位置。
`java.lang.String` | `getName()` 返回书签的名字。
`long` | `getStartPosition()` 返回书签的开始位置。
`java.lang.String` | `getValue()` 得到当前书签所包含的内容。
`void` | `setEndPosition(long offset)` 设置书签的结束位置。
`void` | `setStartPosition(long offset)` 设置书签的开始位置。
`void` | `setValue(java.lang.String value)` 修改当前书签的内容.
`void` | `setValue(java.lang.String value, FontAttribute fontAttribute)` 以指定字体修改当前书签的内容.

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

方法详细信息

### getEndPosition

    public long getEndPosition()

  返回书签的结束位置。

  返回：
    书签的结束位置

    例子：

         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(10,5,baseText,"书签1");
         BookMark bookmark = bookmarks.get("书签1");
         System.out.println("终止位置是 ："+bookmark.getEndPosition());

### getName

    public java.lang.String getName()

  返回书签的名字。

  返回：
    书签名字

    例子：

         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(10,5,baseText,"书签1");
         BookMark bookmark = bookmarks.get("书签1");
         System.out.println("书签名称 ："+bookmark.getName());

### getStartPosition

    public long getStartPosition()

  返回书签的开始位置。

  返回：
    书签的开始位置

    例子：

         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(10,5,baseText,"书签1");
         BookMark bookmark = bookmarks.get("书签1");
         System.out.println("起始位置是 ："+bookmark.getStartPosition());

### getValue

    public java.lang.String getValue()

  得到当前书签所包含的内容。

  返回：
    书签指定的内容

    例子：

         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");
         BookMark bookmark = bookmarks.get("书签1");
         System.out.println("书签内容 ："+bookmark.getValue());

### setEndPosition

    public void setEndPosition(long offset)

  设置书签的结束位置。

  参数：
    `offset` - 书签的结束位置

    例子：

         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");
         BookMark bookmark = bookmarks.get("书签1");
         System.out.println("终止位置是 ："+bookmark.getEndPosition());
         bookmark.setEndPosition(19);
         System.out.println("终止位置是 ："+bookmark.getEndPosition());

  抛出：
    `application.exceptions.MacroRunException` - 当结束位置小于0或当结束位置小于开始位置

### setStartPosition

    public void setStartPosition(long offset)

  设置书签的开始位置。

  参数：
    `offset` - 书签的开始位置

    例子：

         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(10,5,baseText,"书签1");
         BookMark bookmark = bookmarks.get("书签1");
         System.out.println("起始位置是 ："+bookmark.getStartPosition());
         bookmark.setStartPosition(1);
         System.out.println("起始位置是 ："+bookmark.getStartPosition());

  抛出：
    `application.exceptions.MacroRunException` - 当开始位置小于0或开始位置大于结束位置

### setValue

    public void setValue(java.lang.String value)

  修改当前书签的内容.

  参数：
    `value` - 要修改的内容

    例子：

         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");
         BookMark bookmark = bookmarks.get("书签1");
         bookmark.setValue("书签新名字");

### setValue

    public void setValue(java.lang.String value,
                         FontAttribute fontAttribute)

  以指定字体修改当前书签的内容.

  参数：
    `value` - 要修改的内容
    `fontAttribute` - 指定修改内容的字体

    例子：

         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");
         FontAttribute fontAttribute = new FontAttribute();
         fontAttribute.setFontSize(24.0);
         fontAttribute.setBold(true);
         fontAttribute.setForeground(Color.red);
         BookMark bookmark = bookmarks.get("书签1");
         bookmark.setValue("书签新名字", fontAttribute);

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

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