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

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

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

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

    public class FootNoteOptions

extends java.lang.Object

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

方法摘要
`int` | `getApplyType()` 得到脚注的应用更改。
`java.lang.String` | `getCustomFontName()` 得到脚注自定义标记的字体名。
`java.lang.String` | `getCustomSymbol()` 得到脚注的自定义标记。
`int` | `getNumberRule()` 得到脚注的编号方式。
`int` | `getNumberStyle()` 得到脚注的编号格式。
`int` | `getPosition()` 得到脚注的位置。
`int` | `getStartingNumber()` 得到脚注的起始编号。
`void` | `setApplyType(int applyType)` 设置脚注的应用更改。
`void` | `setCustomFontName(java.lang.String fontName)` 设置脚注自定义标记的字体名。
`void` | `setCustomSymbol(java.lang.String symbol)` 设置脚注的自定义标记。
`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`

方法详细信息

### getApplyType

    public int getApplyType()

  得到脚注的应用更改。

  返回：
    将更改应用于，只能取以下值之一：

         NoteConstants.APPLY_TO_WHOLE = 0;    将更改应用于整篇文档
         NoteConstants.APPLY_TO_SECTION = 1;  将更改应用于本节

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         System.out.println("将更改应用于："+footNoteOptions.getApplyType());

### getCustomFontName

    public java.lang.String getCustomFontName()

  得到脚注自定义标记的字体名。

  返回：
    自定义标记的字体名

    例子：

         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!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         footNoteOptions.setCustomSymbol("%");
         baseText.addFootNote(10, 2);
         System.out.println("返回脚注自定义标记的字体名："+footNoteOptions.getCustomFontName());

### getCustomSymbol

    public java.lang.String getCustomSymbol()

  得到脚注的自定义标记。

  返回：
    自定义标记

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         System.out.println("返回脚注的自定义标记："+footNoteOptions.getCustomSymbol());

### getNumberRule

    public int getNumberRule()

  得到脚注的编号方式。

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

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

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         System.out.println("返回脚注的编号方式："+footNoteOptions.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();
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         System.out.println("返回脚注的编号格式："+footNoteOptions.getNumberStyle());

### getPosition

    public int getPosition()

  得到脚注的位置。

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

         NoteConstants.BELLOW_PAGE = 0;   脚注在页面底端
         NoteConstants.BELLOW_WORD = 1;   脚注在文字下面

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         System.out.println("返回脚注的位置："+footNoteOptions.getPosition());

### getStartingNumber

    public int getStartingNumber()

  得到脚注的起始编号。

  返回：
    起始编号

    例子：

         Document doc = Application.getWorkbooks().getActiveWorkbook().getDocuments().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         System.out.println("返回脚注的起始编号："+footNoteOptions.getStartingNumber());

### setApplyType

    public void setApplyType(int applyType)

  设置脚注的应用更改。

  参数：
    `applyType` - 将更改应用于，只能取以下值之一：

         NoteConstants.APPLY_TO_WHOLE = 0;    将更改应用于整篇文档
         NoteConstants.APPLY_TO_SECTION = 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!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         footNoteOptions.setCustomSymbol(null);
         footNoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         footNoteOptions.setApplyType(NoteConstants.APPLY_TO_WHOLE);
         baseText.addFootNote(10, 2);

  抛出：
    `application.exceptions.MacroRunException` - 当脚注的应用更改的常量不存在
  另请参见：
    `NoteConstants`, `FootNote`

### setCustomFontName

    public void setCustomFontName(java.lang.String fontName)

  设置脚注自定义标记的字体名。

  参数：
    `fontName` - 自定义标记的字体名

    例子：

         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!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         footNoteOptions.setCustomFontName("永中楷体");
         footNoteOptions.setCustomSymbol("%");
         baseText.addFootNote(10, 2);

  抛出：
    `application.exceptions.MacroRunException` - 当自定义标记字体名为空
  另请参见：
    `FootNote`

### setCustomSymbol

    public void setCustomSymbol(java.lang.String symbol)

  设置脚注的自定义标记。

  参数：
    `symbol` - 自定义标记，为一字符值

    例子：

         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!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         footNoteOptions.setCustomSymbol("%");
         baseText.addFootNote(10, 2);

  抛出：
    `application.exceptions.MacroRunException` - 当脚注尾注的自定义标记不是一字符值
  另请参见：
    `FootNote`

### setNumberRule

    public void setNumberRule(int numberRule)

  设置脚注的编号方式。

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

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

    例子：

         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!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         footNoteOptions.setCustomSymbol(null);
         footNoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         baseText.addFootNote(10, 2);
         footNoteOptions.setNumberRule(NoteConstants.NUMBER_PAGE_START);
         doc.insertBreak(15,BreakConstants.BREAK_PAGE);
         long secondOffset = baseText.getTextLength()-1;
         baseText.insertText(secondOffset,"second page");
         baseText.addFootNote(secondOffset, 2);

  抛出：
    `application.exceptions.MacroRunException` - 当脚注的编号方式常量不存在
  另请参见：
    `FootNote`

### 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!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         footNoteOptions.setCustomSymbol(null);
         footNoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         baseText.addFootNote(10, 2);

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

### setPosition

    public void setPosition(int position)

  设置脚注的位置。

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

         NoteConstants.BELLOW_PAGE = 0;   脚注在页面底端
         NoteConstants.BELLOW_WORD = 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!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         footNoteOptions.setPosition(NoteConstants.BELLOW_WORD);
         baseText.addFootNote(10, 2);

  抛出：
    `application.exceptions.MacroRunException` - 当脚注的位置常量不存在
  另请参见：
    `FootNote`

### 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!");
         FootNoteOptions footNoteOptions = baseText.getFootNoteOptions();
         footNoteOptions.setCustomSymbol(null);
         footNoteOptions.setNumberStyle(NoteConstants.NUMBER_UPPER_ROMAN);
         footNoteOptions.setStartingNumber(5);
         baseText.addFootNote(10, 2);

  抛出：
    `application.exceptions.MacroRunException` - 当脚注的起始编号小于1
  另请参见：
    `FootNote`

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

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