Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## application.workbooks.workbook.documents.document
Class PageNumbersAttribute

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

public class PageNumbersAttribute
extends java.lang.Object

该类定义了页码的属性。

Constructor Summary
`PageNumbersAttribute()`

Method Summary
`int` | `getAlignment()` 获取插入页码的水平位置（默认水平位置为居右）。
`int` | `getChapterPageSeparator()` 获得章节号与页码之间的分隔符类型（分隔符默认为连字号）。
`int` | `getHeadingLeverForCharpter()` 得到包含章节号的起始样式(章节号起始样式默认为标题1)。
`int` | `getPageNumberFormat()` 获取插入页码的数字样式。
`int` | `getPosition()` 获取插入页码的垂直位置（默认垂直位置为页脚）。
`int` | `getStartingNumber()` 得到所设置的起始页码。
`boolean` | `isContinuePreviousSection()` 判断页码编排选项，即得到页码起始位置从哪开始（页码编排选项默认为续前节）。
`boolean` | `isIncludeChapterNumber()` 判断插入的页码是否包含章节号（默认页码不包含章节号）。
`boolean` | `isShowFirstPageNumber()` 判断插入页码时首页是否显示页号（默认显示首页页号）。
`void` | `setAlignment(int alignment)` 设置插入页码的水平位置（默认水平位置为居右）。
`void` | `setChapterPageSeparator(int type)` 设置章节号与页码之间的分隔符类型（分隔符默认为连字号）。
`void` | `setContinuePreviousSection(boolean contionue)` 设置页码编排选项，即设置的页码起始位置从哪开始（页码编排选项默认为续前节）。
`void` | `setHeadingLeverForCharpter(int headingLever)` 设置包含章节号的起始样式(章节号起始样式默认为标题1)。
`void` | `setIncludeChapterNumber(boolean includeChapter)` 设置插入页码是否包含章节号（默认页码不包含章节号）。
`void` | `setPageNumberFormat(int formatType)` 设置插入页码的数字样式。
`void` | `setPosition(int position)` 设置插入页码的垂直位置（默认垂直位置为页脚）。
`void` | `setShowFirstPageNumber(boolean show)` 插入页码时设置首页是否显示页号（默认显示首页页号）。
`void` | `setStartingNumber(int pageStartNumber)` 设置起始页码。

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### PageNumbersAttribute

    public PageNumbersAttribute()

Method Detail

### getAlignment

    public int getAlignment()

  获取插入页码的水平位置（默认水平位置为居右）。

  Returns:
    插入页码的水平位置，只能取以下值之一：

              PageNumbersConstants.ALIGNMENT_LEFT
              PageNumbersConstants.ALIGNMENT_CENTER
              PageNumbersConstants.ALIGNMENT_RIGHT

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setPosition(PageNumbersConstants.POSITION_HEADER);
         pageNumber.setAlignment(PageNumbersConstants.ALIGNMENT_CENTER);
         baseText.insertPageNumbers(pageNumber);
         int alignment = pageNumber.getAlignment();
         System.out.println("插入页码的水平位置为：" + alignment);

  See Also:
    `setAlignment(int)`

### getChapterPageSeparator

    public int getChapterPageSeparator()

  获得章节号与页码之间的分隔符类型（分隔符默认为连字号）。

  Returns:
    分隔符类型，只能取以下值之一：

              PageNumbersConstants.SEPARATOE_HYPHEN    页码与章节号之间的分隔符为连字号
              PageNumbersConstants.SEPARATOE_PERIOD    页码与章节号之间的分隔符为句号
              PageNumbersConstants.SEPARATOE_COLON     页码与章节号之间的分隔符为冒号
              PageNumbersConstants.SEPARATOE_EM_DASH   页码与章节号之间的分隔符为长破折号
              PageNumbersConstants.SEPARATOE_EN_DASH   页码与章节号之间的分隔符为短破折号

    例子:

         //请在正文中输入几段文字，并对这几段文字格式化项目编号，选择多级编号中的带有标题的编号，使这些段落获得标题编号。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setIncludeChapterNumber(true);
         pageNumber.setHeadingLeverForCharpter(1);
         pageNumber.setChapterPageSeparator(PageNumbersConstants.SEPARATOE_COLON);
         baseText.insertPageNumbers(pageNumber);
         int separator = pageNumber.getChapterPageSeparator();
         System.out.println("章节号与页码之间的分隔符类型为：" + separator);

  See Also:
    `setChapterPageSeparator(int)`, `setHeadingLeverForCharpter(int)`, `setIncludeChapterNumber(boolean)`

### getHeadingLeverForCharpter

    public int getHeadingLeverForCharpter()

  得到包含章节号的起始样式(章节号起始样式默认为标题1)。 注：章节号的起始样式应与带有标题编号段落的样式相同才能正确显示页码章节号。

  Returns:
    包含章节号的起始样式，只能取0－8这9个整形值，分别表示标题1－标题9

    例子:

         //请在正文中输入几段文字，并对这几段文字格式化项目编号，选择多级编号中的带有标题的编号，使这些段落获得标题编号。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setIncludeChapterNumber(true);
         pageNumber.setHeadingLeverForCharpter(1);
         baseText.insertPageNumbers(pageNumber);
         int headingLevel = pageNumber.getHeadingLeverForCharpter();
         System.out.println("包含章节号的起始样式为：" + headingLevel);

  See Also:
    `setHeadingLeverForCharpter(int)`, `setIncludeChapterNumber(boolean)`

### getPageNumberFormat

    public int getPageNumberFormat()

  获取插入页码的数字样式。

  Returns:
    int 插入页码的数字样式，只能取以下值之一：

              FieldConstants.DEFAULT      使用默认数字样式
              FieldConstants.Arabic       数字样式为“1,2,3,...”
              FieldConstants.ALPHABETIC   数字样式为“A,B,C,...”
              FieldConstants.alphabetic   数字样式为“a,b,c,...”
              FieldConstants.ROMAN        数字样式为“I,II,III,...”
              FieldConstants.roman        数字样式为“i,ii,iii,...”
              FieldConstants.CHINESENUM3  数字样式为“1.,2.,3.,...”
              FieldConstants.ZODIAC1      数字样式为“(1),(2),(3),...”
              FieldConstants.CHINESENUM2  数字样式为“一,二,三,...”
              FieldConstants.GB1          数字样式为“壹,贰,叁,...”
              FieldConstants.GB2          数字样式为“甲,乙,丙,...”
              FieldConstants.GB3          数字样式为“子,丑,寅,...”
              FieldConstants.GB4          数字样式为“[一],[二],[三],...”

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setPageNumberFormat(FieldConstants.ZODIAC2);
         baseText.insertPageNumbers(pageNumber);
         int numberFormat = pageNumber.getPageNumberFormat();
         System.out.println("插入页码的数字样式为：" + numberFormat);

  See Also:
    `setPageNumberFormat(int)`

### getPosition

    public int getPosition()

  获取插入页码的垂直位置（默认垂直位置为页脚）。

  Returns:
    插入页码的垂直位置，只能取以下值之一：

              PageNumbersConstants.POSITION_HEADER
              PageNumbersConstants.POSITION_FOOTER

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setPosition(PageNumbersConstants.POSITION_HEADER);
         pageNumber.setAlignment(PageNumbersConstants.ALIGNMENT_CENTER);
         baseText.insertPageNumbers(pageNumber);
         int pos = pageNumber.getPosition();
         System.out.println("插入页码的垂直位置为：" + pos);

  See Also:
    `setPosition(int)`

### getStartingNumber

    public int getStartingNumber()

  得到所设置的起始页码。 注：只有当页码编排选项为设置起始页码时，此方法才有效。

  See Also:
    `setContinuePreviousSection(boolean)`, `setStartingNumber(int)`

### isContinuePreviousSection

    public boolean isContinuePreviousSection()

  判断页码编排选项，即得到页码起始位置从哪开始（页码编排选项默认为续前节）。

  Returns:
    布尔型值，页码编排是否为续前节。如果页码编排选项为续前节，即页码起始位置从1开始，且setStartingNumber(int)无效，则返回true；否则，返回false

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setContinuePreviousSection(false);
         pageNumber.setStartingNumber(2);
         baseText.insertPageNumbers(pageNumber);
         boolean isContinuePrevious = pageNumber.isContinuePreviousSection();
         System.out.println("页码编排选项是否为续前节：" + isContinuePrevious);

  See Also:
    `setContinuePreviousSection(boolean)`, `setStartingNumber(int)`

### isIncludeChapterNumber

    public boolean isIncludeChapterNumber()

  判断插入的页码是否包含章节号（默认页码不包含章节号）。

  Returns:
    布尔型值，插入页码是否包含章节号。如果包含章节号，则返回true；否则，返回false

    例子:

         //请在正文中输入几段文字，并对这几段文字格式化项目编号，选择多级编号中的带有标题的编号，使这些段落获得标题编号。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setIncludeChapterNumber(true);
         pageNumber.setHeadingLeverForCharpter(1);
         baseText.insertPageNumbers(pageNumber);
         boolean isIncludeChapterNumber = pageNumber.isIncludeChapterNumber();
         System.out.println("插入页码是否包含章节号：" + isIncludeChapterNumber);

  See Also:
    `setIncludeChapterNumber(boolean)`, `setHeadingLeverForCharpter(int)`, `setShowFirstPageNumber(boolean)`

### isShowFirstPageNumber

    public boolean isShowFirstPageNumber()

  判断插入页码时首页是否显示页号（默认显示首页页号）。 注：当首页不显示页号时,第二页的页号仍为2,即页码值仍是从首页开始计算的。

  Returns:
    布尔型值，首页是否显示页号。如果首页显示页号，则返回true；否则，返回false

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         baseText.insertPageNumbers(pageNumber);
         boolean isShowFirstPageNumber = pageNumber.isShowFirstPageNumber();
         System.out.println("插入页码时首页是否显示页号：" + isShowFirstPageNumber);

  See Also:
    `setShowFirstPageNumber(boolean)`

### setAlignment

    public void setAlignment(int alignment)

  设置插入页码的水平位置（默认水平位置为居右）。

  Parameters:
    `alignment` - 插入页码的水平位置，只能取以下值之一：

              PageNumbersConstants.ALIGNMENT_LEFT
              PageNumbersConstants.ALIGNMENT_CENTER
              PageNumbersConstants.ALIGNMENT_RIGHT

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setPosition(PageNumbersConstants.POSITION_HEADER);
         pageNumber.setAlignment(PageNumbersConstants.ALIGNMENT_CENTER);
         baseText.insertPageNumbers(pageNumber);

  See Also:
    `getAlignment()`, `setPosition(int)`

### setChapterPageSeparator

    public void setChapterPageSeparator(int type)

  设置章节号与页码之间的分隔符类型（分隔符默认为连字号）。 注：章节号的起始样式应与带有标题编号段落的样式相同才能正确显示页码章节号。

  Parameters:
    `type` - 分隔符类型，只能取以下值之一：

              PageNumbersConstants.SEPARATOE_HYPHEN    页码与章节号之间的分隔符为连字号
              PageNumbersConstants.SEPARATOE_PERIOD    页码与章节号之间的分隔符为句号
              PageNumbersConstants.SEPARATOE_COLON     页码与章节号之间的分隔符为冒号
              PageNumbersConstants.SEPARATOE_EM_DASH   页码与章节号之间的分隔符为长破折号
              PageNumbersConstants.SEPARATOE_EN_DASH   页码与章节号之间的分隔符为短破折号

    例子:

         //请在正文中输入几段文字，并对这几段文字格式化项目编号，选择多级编号中的带有标题的编号，使这些段落获得标题编号。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setIncludeChapterNumber(true);
         pageNumber.setHeadingLeverForCharpter(1);
         pageNumber.setChapterPageSeparator(PageNumbersConstants.SEPARATOE_COLON);
         baseText.insertPageNumbers(pageNumber);

  See Also:
    `getChapterPageSeparator()`, `setHeadingLeverForCharpter(int)`, `setIncludeChapterNumber(boolean)`

### setContinuePreviousSection

    public void setContinuePreviousSection(boolean contionue)

  设置页码编排选项，即设置的页码起始位置从哪开始（页码编排选项默认为续前节）。

  See Also:
    `isContinuePreviousSection()`, `setStartingNumber(int)`

### setHeadingLeverForCharpter

    public void setHeadingLeverForCharpter(int headingLever)

  设置包含章节号的起始样式(章节号起始样式默认为标题1)。 注：章节号的起始样式应与带有标题编号段落的样式相同才能正确显示页码章节号。

  Parameters:
    `headingLever` - 包含章节号的起始样式，只能取0－8这9个整形值，分别表示标题1－标题9

    例子:

         //请在正文中输入几段文字，并对这几段文字格式化项目编号，选择多级编号中的带有标题的编号，使这些段落获得标题编号。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setIncludeChapterNumber(true);
         pageNumber.setHeadingLeverForCharpter(1);
         baseText.insertPageNumbers(pageNumber);

  See Also:
    `getHeadingLeverForCharpter()`, `setIncludeChapterNumber(boolean)`, `setChapterPageSeparator(int)`

### setIncludeChapterNumber

    public void setIncludeChapterNumber(boolean includeChapter)

  设置插入页码是否包含章节号（默认页码不包含章节号）。 注：章节号的起始样式应与带有标题编号段落的样式相同才能正确显示页码章节号。

  Parameters:
    `includeChapter` - 插入页码是否包含章节号

    例子:

         //请在正文中输入几段文字，并对这几段文字格式化项目编号，选择多级编号中的带有标题的编号，使这些段落获得标题编号。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setIncludeChapterNumber(true);
         pageNumber.setHeadingLeverForCharpter(1);
         baseText.insertPageNumbers(pageNumber);

  See Also:
    `isIncludeChapterNumber()`, `setHeadingLeverForCharpter(int)`, `setShowFirstPageNumber(boolean)`, `setChapterPageSeparator(int)`

### setPageNumberFormat

    public void setPageNumberFormat(int formatType)

  设置插入页码的数字样式。

  Parameters:
    `formatType` - 插入页码的数字样式，只能取以下值之一：

              FieldConstants.DEFAULT      使用默认数字样式
              FieldConstants.Arabic       数字样式为“1,2,3,...”
              FieldConstants.ALPHABETIC   数字样式为“A,B,C,...”
              FieldConstants.alphabetic   数字样式为“a,b,c,...”
              FieldConstants.ROMAN        数字样式为“I,II,III,...”
              FieldConstants.roman        数字样式为“i,ii,iii,...”
              FieldConstants.CHINESENUM3  数字样式为“1.,2.,3.,...”
              FieldConstants.ZODIAC1      数字样式为“(1),(2),(3),...”
              FieldConstants.CHINESENUM2  数字样式为“一,二,三,...”
              FieldConstants.GB1          数字样式为“壹,贰,叁,...”
              FieldConstants.GB2          数字样式为“甲,乙,丙,...”
              FieldConstants.GB3          数字样式为“子,丑,寅,...”
              FieldConstants.GB4          数字样式为“[一],[二],[三],...”

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setPageNumberFormat(FieldConstants.ZODIAC2);
         baseText.insertPageNumbers(pageNumber);

  See Also:
    `getPageNumberFormat()`

### setPosition

    public void setPosition(int position)

  设置插入页码的垂直位置（默认垂直位置为页脚）。

  Parameters:
    `position` - 插入页码的垂直位置，只能取以下值之一：

              PageNumbersConstants.POSITION_HEADER
              PageNumbersConstants.POSITION_FOOTER

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setPosition(PageNumbersConstants.POSITION_HEADER);
         pageNumber.setAlignment(PageNumbersConstants.ALIGNMENT_CENTER);
         baseText.insertPageNumbers(pageNumber);

  See Also:
    `getPosition()`, `setAlignment(int)`

### setShowFirstPageNumber

    public void setShowFirstPageNumber(boolean show)

  插入页码时设置首页是否显示页号（默认显示首页页号）。 注：当首页不显示页号时,第二页的页号仍为2,即页码值仍是从首页开始计算的。

  Parameters:
    `show` - 布尔型值，首页是否显示页号。如果为true，首页显示页号；否则，首页不显示页号

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         baseText.insertPageNumbers(pageNumber);

  See Also:
    `isShowFirstPageNumber()`

### setStartingNumber

    public void setStartingNumber(int pageStartNumber)

  设置起始页码。 注：只有当页码编排选项为设置起始页码时，此方法才有效。

  Parameters:
    `pageStartNumber` - 起始页码

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         BaseText baseText = section.getBaseText();
         PageNumbersAttribute pageNumber = new PageNumbersAttribute();
         pageNumber.setShowFirstPageNumber(true);
         pageNumber.setContinuePreviousSection(false);
         pageNumber.setStartingNumber(2);
         baseText.insertPageNumbers(pageNumber);

  See Also:
    `setContinuePreviousSection(boolean)`, `getStartingNumber()`

Overview | Package | Class | Tree | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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