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

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

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

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

    public class IndexEntry

extends java.lang.Object

该类定义了设置索引项的方法。

方法摘要
`java.lang.String` | `getBookmarkName()` 得到书签名称
`java.lang.String` | `getCrossRef()` 得到索引项引用文本
`java.lang.String` | `getMainEntry()` 得到主索引项
`int` | `getOptionType()` 得到索引项的选项
`java.lang.String` | `getSubEntry()` 得到次索引项
`boolean` | `isBold()` 得到页码格式是否加粗
`boolean` | `isItalic()` 得到页码格式是否倾斜
`void` | `setBold(boolean bold)` 设置页码格式是否加粗
`void` | `setBookmarkName(java.lang.String name)` 设置书签名称
`void` | `setCrossRef(java.lang.String text)` 设置索引项引用文本
`void` | `setItalic(boolean italic)` 设置页码格式是否倾斜
`void` | `setMainEntry(java.lang.String mainEntry)` 设置主索引项。
`void` | `setOptionType(int index)` 设置索引项的选项
`void` | `setSubEntry(java.lang.String subEntry)` 设置次索引项。

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

方法详细信息

### getBookmarkName

    public java.lang.String getBookmarkName()

  得到书签名称

  返回：
    书签名称

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         BookMarks bookmarks = doc.getBookmarks();
         bookmarks.add(0,2,baseText,"书签1");
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         entry.setBookmarkName("书签1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);
         System.out.println("当前索引项的书签名为："+entry.getBookmarkName());

### getCrossRef

    public java.lang.String getCrossRef()

  得到索引项引用文本

  返回：
    引用文本

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         baseText.insertIndex(0,index);
         System.out.println("当前索引的选项类型为："+entry.getOptionType());

### getMainEntry

    public java.lang.String getMainEntry()

  得到主索引项

  返回：
    主索引项

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         baseText.insertIndex(0,index);
         System.out.println("当前索引的主索引项名为："+entry.getMainEntry());

### getOptionType

    public int getOptionType()

  得到索引项的选项

  返回：
    选项索引值　　0:交叉引用;　１:当前页; 2:页面范围

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);
         System.out.println("当前索引的选项类型为："+entry.getOptionType());

### getSubEntry

    public java.lang.String getSubEntry()

  得到次索引项

  返回：
    次索引项

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         entry.setSubEntry("次索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         baseText.insertIndex(0,index);
         System.out.println("当前索引的次索引项名为："+entry.getSubEntry());

### isBold

    public boolean isBold()

  得到页码格式是否加粗

  返回：
    布尔型值，是否加粗。如果加粗，则返回true；否则，返回false

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);
         System.out.println("当前索引项是否设置页码格式加粗："+entry.isBold());

### isItalic

    public boolean isItalic()

  得到页码格式是否倾斜

  返回：
    布尔型值，是否倾斜。如果倾斜，则返回true；否则，返回false

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);
         System.out.println("当前索引项是否设置页码格式倾斜："+entry.isItalic());

### setBold

    public void setBold(boolean bold)

  设置页码格式是否加粗

  参数：
    `bold` - 布尔型值，是否加粗。如果为true，表示加粗；如果为false，表示不加粗

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         entry.setBold(true);
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

### setBookmarkName

    public void setBookmarkName(java.lang.String name)

  设置书签名称

  参数：
    `name` - 书签名称

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         BookMarks bookmarks = doc.getBookmarks();
         bookmarks.add(0,2,baseText,"书签1");
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         entry.setBookmarkName("书签1");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

  抛出：
    `application.exceptions.MacroRunException` - 当参数为空

### setCrossRef

    public void setCrossRef(java.lang.String text)

  设置索引项引用文本

  参数：
    `text` - 引用文本

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         entry.setOptionType(IndexAndTableConstants.CROSS_REFERENCE);
         entry.setCrossRef("");
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

  抛出：
    `application.exceptions.MacroRunException` - 当参数为空

### setItalic

    public void setItalic(boolean italic)

  设置页码格式是否倾斜

  参数：
    `italic` - 布尔型值，是否倾斜。如果为true，表示倾斜；如果为false

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         entry.setItalic(true);
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

### setMainEntry

    public void setMainEntry(java.lang.String mainEntry)

  设置主索引项。

  参数：
    `mainEntry` - 主索引项

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry1 = baseText.getIndexEntry(2,4);
         entry1.setMainEntry("索引项1");
         IndexEntry entry2 = baseText.getIndexEntry(2,4);
         entry2.setMainEntry("索引项2");
         baseText.markIndexEntry(entry1);
         baseText.markIndexEntry(entry2);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

  抛出：
    `application.exceptions.MacroRunException` - 当参数为空

### setOptionType

    public void setOptionType(int index)

  设置索引项的选项

  参数：
    `index` - 选项索引值　范围: 0 ~ 2; 0:交叉引用;　１:当前页; 2:页面范围

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry = baseText.getIndexEntry(2,4);
         entry.setMainEntry("索引项1");
         entry.setOptionType(IndexAndTableConstants.PAGE_RANGE);
         baseText.markIndexEntry(entry);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

  抛出：
    `application.exceptions.MacroRunException` - 当常量不存在

### setSubEntry

    public void setSubEntry(java.lang.String subEntry)

  设置次索引项。

  参数：
    `subEntry` - 次索引项

    例子：

         //请在文档中输入一些文字
         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         IndexEntry entry1 = baseText.getIndexEntry(2,4);
         entry1.setMainEntry("索引项1");
         entry1.setSubEntry("次索引项1");
         IndexEntry entry2 = baseText.getIndexEntry(2,4);
         entry2.setMainEntry("索引项2");
         entry1.setSubEntry("次索引项2");
         baseText.markIndexEntry(entry1);
         baseText.markIndexEntry(entry2);
         Index index = baseText.getIndex(2,4);
         index.setRight(true);
         baseText.insertIndex(0,index);

  抛出：
    `application.exceptions.MacroRunException` - 当参数为空

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

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