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

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

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

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

    public class EndNoteOptions

extends java.lang.Object

该类定义了尾注的属性管理器。

方法摘要
`int` | `getNumberRule()` 得到尾注的编号方式。
`int` | `getNumberStyle()` 得到尾注的编号格式。
`int` | `getPosition()` 得到尾注的位置。
`int` | `getStartingNumber()` 得到尾注的起始编号。
`void` | `setNumberRule(int numberRule)` 设置尾注的编号方式。
`void` | `setNumberStyle(int index)` 设置尾注的编号格式。
`void` | `setPosition(int position)` 设置尾注的位置。
`void` | `setStartingNumber(int startingNumber)` 设置尾注的起始编号。

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

方法详细信息

### getNumberRule

    public int getNumberRule()

  得到尾注的编号方式。

  返回：
    编号方式，只能取以下值之一：

         NoteConstants.NUMBER_CONTINUE = 0;       编号方式为连续编号
         NoteConstants.NUMBER_SECTION_START = 1;  编号方式为每节重新编号

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndNoteOptions(10);
         System.out.println("返回尾注的编号方式："+endNoteOptions.getNumberRule());

### getNumberStyle

    public int getNumberStyle()

  得到尾注的编号格式。

  返回：
    编号格式的索引，只能取以下值之一：

         NoteConstants.NUMBER_DECIMAL                编号格式为“1,2,3,...”
         NoteConstants.NUMBER_SBC_CASE               编号格式为“全角”
         NoteConstants.NUMBER_UPPER_ALPHA            编号格式为“A,B,C,...”
         NoteConstants.NUMBER_LOWER_ALPHA            编号格式为“a,b,c,...”
         NoteConstants.NUMBER_LOWER_ROMAN            编号格式为“i,ii,iii,...”
         NoteConstants.NUMBER_UPPER_ROMAN            编号格式为“I,II,III,...”
         NoteConstants.NUMBER_UPPER_CHINA            编号格式为“壹,贰,叁,...”
         NoteConstants.NUMBER_TRADITION_LOWER_CHINA  编号格式为“一,二,三,...（繁）”
         NoteConstants.NUMBER_SIMPLE_LOWER_CHINA     编号格式为“一,二,三,...（简）”
         NoteConstants.NUMBER_UPPER_CHINA1           编号格式为"壹,貳,參 …"
         NoteConstants.NUMBER_EAVEN                  编号格式为“甲,乙,丙,...”
         NoteConstants.NUMBER_EATH                   编号格式为“子,丑,寅,...”
         NoteConstants.NUMBER_CIRCLE                 编号格式为“圈内数字”
         NoteConstants.NUMBER_BRACKET                编号格式为“括号数字”

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndNoteOptions(10);
         System.out.println("返回尾注的编号格式："+endNoteOptions.getNumberStyle());

### getPosition

    public int getPosition()

  得到尾注的位置。

  返回：
    尾注的位置，只能取以下值之一：

         NoteConstants.SECTION_END = 0;   尾注在节的结尾
         NoteConstants.DOCUMENT_END = 1;  尾注在文档结尾

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndNoteOptions(10);
         System.out.println("返回尾注的位置："+endNoteOptions.getPosition());

### getStartingNumber

    public int getStartingNumber()

  得到尾注的起始编号。

  返回：
    起始编号

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndNoteOptions(10);
         System.out.println("返回尾注的起始编号："+endNoteOptions.getStartingNumber());

### setNumberRule

    public void setNumberRule(int numberRule)

  设置尾注的编号方式。

  参数：
    `numberRule` - 编号方式，只能取以下值之一：

         NoteConstants.NUMBER_CONTINUE = 0;       编号方式为连续编号
         NoteConstants.NUMBER_SECTION_START = 1;  编号方式为每节重新编号

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndNoteOptions(10);
         endNoteOptions.setCustomSymbol(null);
         endNoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         baseText.addEndNote(10, 2);
         endNoteOptions.setNumberRule(NoteConstants.NUMBER_PAGE_START);
         doc.insertBreak(15,BreakConstants.BREAK_PAGE);
         long secondOffset = baseText.getTextLength()-1;
         baseText.insertText(secondOffset,"second page");
         baseText.addEndNote(secondOffset, 2);

  抛出：
    `MacroRunException` - 当尾注的编号方式常量不存在
  另请参见：
    `EndNote`

### setNumberStyle

    public void setNumberStyle(int index)

  设置尾注的编号格式。

  参数：
    `index` - 编号格式的索引，只能取以下值之一：

         NoteConstants.NUMBER_DECIMAL                编号格式为“1,2,3,...”
         NoteConstants.NUMBER_SBC_CASE               编号格式为“全角”
         NoteConstants.NUMBER_UPPER_ALPHA            编号格式为“A,B,C,...”
         NoteConstants.NUMBER_LOWER_ALPHA            编号格式为“a,b,c,...”
         NoteConstants.NUMBER_LOWER_ROMAN            编号格式为“i,ii,iii,...”
         NoteConstants.NUMBER_UPPER_ROMAN            编号格式为“I,II,III,...”
         NoteConstants.NUMBER_UPPER_CHINA            编号格式为“壹,贰,叁,...”
         NoteConstants.NUMBER_TRADITION_LOWER_CHINA  编号格式为“一,二,三,...（繁）”
         NoteConstants.NUMBER_SIMPLE_LOWER_CHINA     编号格式为“一,二,三,...（简）”
         NoteConstants.NUMBER_UPPER_CHINA1           编号格式为"壹,貳,參 …"
         NoteConstants.NUMBER_EAVEN                  编号格式为“甲,乙,丙,...”
         NoteConstants.NUMBER_EATH                   编号格式为“子,丑,寅,...”
         NoteConstants.NUMBER_CIRCLE                 编号格式为“圈内数字”
         NoteConstants.NUMBER_BRACKET                编号格式为“括号数字”

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndtNoteOptions(10);
         endNoteOptions.setCustomSymbol(null);
         endNoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         baseText.addEndNote(10, 2);

  抛出：
    `MacroRunException` - 当设置脚注尾注的编号格式前其自定义标记不为空
    `MacroRunException` - 当编号格式的索引常量不存在
  另请参见：
    `NoteConstants`, `EndNote`

### setPosition

    public void setPosition(int position)

  设置尾注的位置。

  参数：
    `position` - 尾注的位置，只能取以下值之一：

         NoteConstants.SECTION_END = 0;   尾注在节的结尾
         NoteConstants.DOCUMENT_END = 1;  尾注在文档结尾

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndNoteOptions(10);
         endNoteOptions.setPosition(NoteConstants.DOCUMENT_END);
         baseText.addEndNote(10, 2);

  抛出：
    `MacroRunException` - 当尾注的位置常量不存在
  另请参见：
    `EndNote`

### setStartingNumber

    public void setStartingNumber(int startingNumber)

  设置尾注的起始编号。

  参数：
    `startingNumber` - 起始编号

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         baseText.insertText(0,"this is a test!\n this is a test!\n this is a test!");
         EndNoteOptions endNoteOptions = baseText.getEndNoteOptions(10);
         endNoteOptions.setCustomSymbol(null);
         endNoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         endNoteOptions.setStartingNumber(5);
         baseText.addEndNote(10, 2);

  抛出：
    `MacroRunException` - 当尾注的起始编号小于1
  另请参见：
    `EndNote`

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

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

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