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 WpPageSetup

    java.lang.Object
      application.workbooks.workbook.print.PageSetup
          application.workbooks.workbook.documents.document.WpPageSetup

public class WpPageSetup
extends PageSetup

这个类封装了章节的页面设置属性，每个章节都可以设置不同的页面设置属性。

Method Summary
`void` | `apply()` 应用文档的页面设置。
`float` | `getFooterPosition()` 获取本章节页脚下端与页面底部之间的距离(以磅为单位)。
`int` | `getGutterPosition()` 获取本章节的装订线的位置：放在页面的左端还是顶端。
`float` | `getGutterValue()` 获取本章节的装订线与页面最左或最顶端之间的距离(以磅为单位）。
`float` | `getHeaderPosition()` 获取本章节页眉上端与页面顶部之间的距离(以磅为单位)。
`int` | `getOrientation()` 返回本章节的页面方向为竖排方式还是横排方式（页面方向默认为竖排方式）。
`float` | `getPageBottomMargin()` 获取本章节的正文最下端与页面底边的距离 (以磅为单位)。
`float` | `getPageHeight()` 返回本章节的页面高度（以磅为单位）。
`float` | `getPageLeftMargin()` 获取章节的正文最左端与页面左边的距离 (以磅为单位)。
`float` | `getPageRightMargin()` 获取本章节的正文最右端与页面右边的距离 (以磅为单位)。
`float` | `getPageTopMargin()` 获取本章节的正文最上端与页面顶边的距离 (以磅为单位)。
`float` | `getPageWidth()` 获取本章节的页面宽度（以磅为单位）。
`int` | `getSectionStart()` 获取节的起始点类型。
`boolean` | `isFirstPageDifferent()` 判断本章节的页眉页脚是否可以首页不同。
`boolean` | `isHidden()` 判断在页面中是否显示带有隐藏文字字体属性的字符串的布尔值。
`boolean` | `isMirror()` 判断本章节的装订线是否为对称页边距。
`boolean` | `isOddAndEven()` 判断本章节的页眉页脚是否奇偶页可以不同。
`void` | `setBand(int index)` 设置每页版数的索引号；
`void` | `setDisplayLine(int printLineNumber, int firstLineNumber, double spaceFromText, int lineNumberSpacing, int lineNumberStyle)` 设置页面的行号
`void` | `setFirstPageDifferent(boolean isDifferent)` 设置本章节的页眉页脚是否可以首页不同。
`void` | `setFooterPosition(float footerPosition)` 设置本章节页脚下端与页面底部之间的距离（以磅为单位）。
`void` | `setFooterPosition(float footerPosition, int unit)` 设置本章节页脚下端与页面底部之间的距离（默认磅以为单位，也可以以其他度量为单位）。
`void` | `setGutter(float gutterValue, int position, boolean mirror)` 设置本章节的装订线与页面最左或最顶端之间的距离(以磅为单位）。
`void` | `setGutter(float gutterValue, int unit, int position, boolean mirror)` 设置本章节的装订线与页面最左或最顶端之间的距离(默认以磅为单位）。
`void` | `setHeaderPosition(float headerPosition)` 设置本章节页眉上端与页面顶部之间的距离（以磅为单位）。
`void` | `setHeaderPosition(float headerPosition, int unit)` 设置本章节页眉上端与页面顶部之间的距离（默认磅以为单位，也可以以其他度量为单位）。
`void` | `setHidden(boolean hidden)` 设置在页面中是否显示带有隐藏文字字体属性的字符串。
`void` | `setOddAndEven(boolean isDifferent)` 设置本章节的页眉页脚是否奇偶页可以不同。
`void` | `setOrientation(int oritation)` 设置本章节的页面方向为竖排方式还是横排方式（页面方向默认为竖排方式）。
`void` | `setPageBottomMargin(float pageBottomMargin)` 设置本章节的正文最下端与页面底边的距离 (以磅为单位)。
`void` | `setPageBottomMargin(float pageBottomMargin, int unit)` 设置本章节的正文最下端与页面底边的距离 (默认以磅为单位)。
`void` | `setPageHeight(float pageHeight)` 设置本章节的页面高度（以磅为单位）。
`void` | `setPageHeight(float pageHeight, int unit)` 设置本章节的页面高度（默认以磅为单位）。
`void` | `setPageLeftMargin(float pageLeftMargin)` 设置本章节的正文最左端与页面左边的距离 (以磅为单位)。
`void` | `setPageLeftMargin(float pageLeftMargin, int unit)` 设置本章节的正文最左端与页面左边的距离 (默认以磅为单位)。
`void` | `setPageRightMargin(float pageRightMargin)` 设置本章节的正文最右端与页面右边的距离 (以磅为单位)。
`void` | `setPageRightMargin(float pageRightMargin, int unit)` 设置本章节的正文最右端与页面右边的距离 (默认以磅为单位)。
`void` | `setPageTopMargin(float pageTopMargin)` 设置本章节的正文最上端与页面顶边的距离 (以磅为单位)。
`void` | `setPageTopMargin(float pageTopMargin, int unit)` 设置本章节的正文最上端与页面顶边的距离 (默认以磅为单位)。
`void` | `setPageWidth(float pageWidth)` 设置本章节的页面宽度（以磅为单位）。
`void` | `setPageWidth(float pageWidth, int unit)` 设置本章节的页面宽度（默认以磅为单位）。
`void` | `setSci(int type)` 设置缩放的纸型;
`void` | `setSectionStart(int selectStartType)` 设置节的起始点类型。

Methods inherited from class application.workbooks.workbook.print.PageSetup
`getBand, getHorizontal, getPaper, getPrintCommentStyle, getPrintErrorStyle, getPrintOrder, getPrintPagesHeight, getPrintPagesWidth, getSci, getVertical, getZoom, getZoomStyle, isBack, isBackgroundPrinting, isGridLines, isHeadings, isProperty, isReverse, isUpdate, setBackgroud, setBackgroundPrinting, setFixedSize, setFooterPosition, setFooterPosition, setGridlines, setGutter, setGutter, setHeaderPosition, setHeaderPosition, setHeadings, setHiddenSlide, setHorizontal, setPageBottomMargin, setPageBottomMargin, setPageHeight, setPageHeight, setPageLeftMargin, setPageLeftMargin, setPageRightMargin, setPageRightMargin, setPageTopMargin, setPageTopMargin, setPageWidth, setPageWidth, setPaper, setPresentationFrame, setPrintArea, setPrintColorStyle, setPrintCommentStyle, setPrintContent, setPrintErrorStyle, setPrintOrder, setPrintPage, setPrintPagesHeight, setPrintPagesWidth, setPrintTitleColumns, setPrintTitleRows, setProperty, setReverse, setUpdate, setVertical, setZoom, setZoomStyle`

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

Method Detail

### apply

    public void apply()

  应用文档的页面设置。 (注：页面设置中的各方法都要经过此方法的调用才有效。)

  例子:

       //首先在正文中输入一些文字。
       Document doc = Application.getWorkbooks().getActiveDocument();
       Section section = doc.getSection(0);
       WpPageSetup pageSetup = section.getPageSetup();
       pageSetup.setOrientation(SectionConstants.LANDSCAPE);
       pageSetup.apply();

  See Also:
    `Section`

### getFooterPosition

    public float getFooterPosition()

  获取本章节页脚下端与页面底部之间的距离(以磅为单位)。 (注：此距离一定要小于正文下端与页面底部之间的距离，否则会弹出异常。)

  See Also:
    `setFooterPosition(float)`, `setFooterPosition(float,int)`, `apply()`, `Utilities`

### getGutterPosition

    public int getGutterPosition()

  获取本章节的装订线的位置：放在页面的左端还是顶端。

  Returns:
    装订线在页面上的位置

              SectionConstants.LEFT = 0（装订线在页面左边）
              SectionConstants.TOP = 1（装订线在页面上边）

    例子:

         //首先在文本中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setGutter(50.0f,SectionConstants.LEFT,true);
         pageSetup.apply();
         int gutterPosition = pageSetup.getGutterPosition();
         System.out.println("本章节的装订线放在页面的哪一端：" + gutterPosition);

  See Also:
    `setGutter(float,int,int,boolean)`, `setGutter(float,int,boolean)`, `getGutterValue()`, `isMirror()`, `apply()`, `Utilities`

### getGutterValue

    public float getGutterValue()

  获取本章节的装订线与页面最左或最顶端之间的距离(以磅为单位）。

  Returns:
    装订线与页面最左端或最顶端之间的距离，最左或最右视position变量而定

    例子:

         //首先在文本中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setGutter(50.0f,SectionConstants.LEFT,true);
         pageSetup.apply();
         float gutterValue = pageSetup.getGutterValue();
         System.out.println("本章节的装订线与页面最左或最顶端之间的距离为：" + gutterValue);

  See Also:
    `setGutter(float,int,int,boolean)`, `setGutter(float,int,boolean)`, `getGutterPosition()`, `isMirror()`, `apply()`, `Utilities`

### getHeaderPosition

    public float getHeaderPosition()

  获取本章节页眉上端与页面顶部之间的距离(以磅为单位)。 （注：此距离一定要小于正文上端与页面顶部之间的距离，否则会弹出异常。）

  See Also:
    `setHeaderPosition(float)`, `setHeaderPosition(float,int)`, `apply()`, `Utilities`

### getOrientation

    public int getOrientation()

  返回本章节的页面方向为竖排方式还是横排方式（页面方向默认为竖排方式）。
  注：页面方向为竖排还是横排与页面的宽度高度有关， 竖排方式下的页面高度等于横排方式下的页面宽度，反之亦然。

  Overrides:
    `getOrientation` in class `PageSetup`
  Returns:
    本章节的页面方向，其常量和相应的值如下：

              SectionConstants.PORTRAIT = 0（竖排方式）；
              SectionConstants.LANDSCAPE = 1（横排方式）

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOrientation(SectionConstants.LANDSCAPE);
         pageSetup.apply();
         int orientation = pageSetup.getOrientation();
         System.out.println("本章节的页面方向为哪一种排列方式：" + orientation);

  See Also:
    `setOrientation(int)`, `setPageHeight(float)`, `setPageWidth(float)`, `apply()`

### getPageBottomMargin

    public float getPageBottomMargin()

  获取本章节的正文最下端与页面底边的距离 (以磅为单位)。
  注：正文最下端与页面底边的距离一定要大于页脚底部与页面底边的距离，否则会弹出异常。

  Returns:
    正文最下端与页面底边的距离(以磅为单位)，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageBottomMargin(60.0f);
         pageSetup.apply();
         float bottomMargin = pageSetup.getPageBottomMargin();
         System.out.println("正文最下端与页面底边的距离为：" + bottomMargin);

  See Also:
    `setPageBottomMargin(float)`, `setPageBottomMargin(float,int)`, `setFooterPosition(float)`, `apply()`, `Utilities`

### getPageHeight

    public float getPageHeight()

  返回本章节的页面高度（以磅为单位）。
  注：页面方向为竖排还是横排与页面的宽度高度有关， 竖排方式下的页面高度等于横排方式下的页面宽度，反之亦然。

  Returns:
    页面高度，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOrientation(SectionConstants.LANDSCAPE);
         pageSetup.setPageHeight(300.0f);
         pageSetup.apply();
         float pageHeight = pageSetup.getPageHeight();
         System.out.println("本章节的页面高度为：" + pageHeight);

  See Also:
    `setPageHeight(float)`, `setPageHeight(float,int)`, `setOrientation(int)`, `apply()`, `Utilities`

### getPageLeftMargin

    public float getPageLeftMargin()

  获取章节的正文最左端与页面左边的距离 (以磅为单位)。

  Returns:
    正文最左端与页面左边的距离(以磅为单位)，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageLeftMargin(60.0f);
         pageSetup.apply();
         float leftMargin = pageSetup.getPageLeftMargin();
         System.out.println("正文最左端与页面左边的距离为：" + leftMargin);

  See Also:
    `setPageLeftMargin(float)`, `setPageLeftMargin(float,int)`, `apply()`, `Utilities`

### getPageRightMargin

    public float getPageRightMargin()

  获取本章节的正文最右端与页面右边的距离 (以磅为单位)。

  Returns:
    正文最右端与页面右边的距离(以磅为单位)，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageRightMargin(60.0f);
         pageSetup.apply();
         float rightMargin = pageSetup.getPageRightMargin();
         System.out.println("正文最右端与页面右边的距离为：" + rightMargin);

  See Also:
    `setPageRightMargin(float)`, `setPageRightMargin(float,int)`, `apply()`, `Utilities`

### getPageTopMargin

    public float getPageTopMargin()

  获取本章节的正文最上端与页面顶边的距离 (以磅为单位)。
  注：正文最上端与页面顶边的距离一定要大于页眉顶部与页面顶边的距离，否则会弹出异常。

  Returns:
    正文最上端与页面顶边的距离(以磅为单位)，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageTopMargin(60.0f);
         pageSetup.apply();
         float topMargin = pageSetup.getPageTopMargin();
         System.out.println("正文最上端与页面顶边的距离为：" + topMargin);

  See Also:
    `setPageTopMargin(float)`, `setPageTopMargin(float,int)`, `setHeaderPosition(float)`, `apply()`, `Utilities`

### getPageWidth

    public float getPageWidth()

  获取本章节的页面宽度（以磅为单位）。
  注：页面方向为竖排还是横排与页面的宽度高度有关， 竖排方式下的页面宽度等于横排方式下的页面高度，反之亦然。

  Returns:
    页面宽度，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOrientation(SectionConstants.LANDSCAPE);
         pageSetup.getPageWidth(300.0f);
         pageSetup.apply();
         float pageWidth = pageSetup.getPageWidth();
         System.out.println("本章节的页面宽度为：" + pageWidth);

  See Also:
    `setPageWidth(float)`, `setPageWidth(float,int)`, `setOrientation(int)`, `apply()`, `Utilities`

### getSectionStart

    public int getSectionStart()

  获取节的起始点类型。

  Overrides:
    `getSectionStart` in class `PageSetup`
  Returns:
    节的起始点类型，为整型数值

              SectionConstants.NEXTPAGE = 0（下一页）；
              SectionConstants.ODDPAGE = 1（奇数页）；
              SectionConstants.EVENPAGE = 2（偶数页）

    //首先在页眉页脚中输入一些文字，并且插入多个节。 Document doc = Application.getWorkbooks().getActiveDocument(); Section section = doc.getSection(0); WpPageSetup pageSetup = section.getPageSetup(); pageSetup.setSectionStart(SectionConstants.NEXTPAGE); pageSetup.apply(); int sectionStart = pageSetup.getSectionStart(); System.out.println("节的起始点类型为：" + sectionStart);
  See Also:
    `setSectionStart(int)`, `apply()`

### isFirstPageDifferent

    public boolean isFirstPageDifferent()

  判断本章节的页眉页脚是否可以首页不同。

  Overrides:
    `isFirstPageDifferent` in class `PageSetup`
  Returns:
    布尔型值，如果页眉页脚首页与其他页不同，返回true；否则，返回false

    例子:

         //首先在页眉页脚中输入一些文字，并且插入多页。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setFirstPageDifferent(true);
         pageSetup.apply();
         boolean isFirstPageDifferent = pageSetup.isFirstPageDifferent();
         System.out.println("页眉页脚是否可以首页不同：" + isFirstPageDifferent);

  See Also:
    `setFirstPageDifferent(boolean)`, `setOddAndEven(boolean)`, `apply()`

### isHidden

    public boolean isHidden()

  判断在页面中是否显示带有隐藏文字字体属性的字符串的布尔值。 注：此方法是应用于整个文档的而不是应用于某一个章节，对某章节设置了属性，则其它章节也会有效。

  Overrides:
    `isHidden` in class `PageSetup`
  Returns:
    布尔型值，如显示带有隐藏文字字体属性的字符串，则返回true；否则，返回false

    例子:

         //首先在文本中输入一些文字，然后对其部分设置隐藏字体属性。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setHidden(true);
         pageSetup.apply();
         boolean isHidden = pageSetup.isHidden();
         System.out.println("在页面中是否显示带有隐藏文字字体属性的字符串：" + isHidden);

  See Also:
    `isHidden()`, `apply()`

### isMirror

    public boolean isMirror()

  判断本章节的装订线是否为对称页边距。 （注：setGutter()方法中的参数mirror只有在装订线在页面左边时设置才有效。）

  Returns:
    布尔型值，如果装订线对称页边距，即奇数页装订线在页面一边，偶数页装订线在页面另一边，返回true；否则，返回flase

    例子:

         //首先在文本中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setGutter(50.0f,SectionConstants.LEFT,true);
         pageSetup.apply();
         boolean isMirror = pageSetup.isMirror();
         System.out.println("装订线是否为对称页边距：" + isMirror);

  See Also:
    `setGutter(float,int,int,boolean)`, `setGutter(float,int,boolean)`, `getGutterValue()`, `getGutterPosition()`, `apply()`, `Utilities`

### isOddAndEven

    public boolean isOddAndEven()

  判断本章节的页眉页脚是否奇偶页可以不同。

  Overrides:
    `isOddAndEven` in class `PageSetup`
  Returns:
    布尔型值，如果页眉页脚奇偶页不同，返回true；否则，返回false

    例子:

         //首先在页眉页脚中输入一些文字，并且插入多页。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOddAndEven(true);
         pageSetup.apply();
         boolean isOddAndEven = pageSetup.isOddAndEven();
         System.out.println("页眉页脚是否奇偶页可以不同：" + isOddAndEven);

  See Also:
    `setOddAndEven(boolean)`, `setFirstPageDifferent(boolean)`, `apply()`

### setBand

    public void setBand(int index)

  设置每页版数的索引号；

  Overrides:
    `setBand` in class `PageSetup`
  Parameters:
    `index` - 每页版数的索引号 (共6种 具体见PrintConstants)

    例子：

         PageSetup page = Application.getWorkbooks().getActiveWorkbook()
                                     .getWorksheets().getPageSetup("默认");
         page.setBand(1);

### setDisplayLine

    public void setDisplayLine(int printLineNumber,
                               int firstLineNumber,
                               double spaceFromText,
                               int lineNumberSpacing,
                               int lineNumberStyle)

  设置页面的行号

  Parameters:
    `printLineNumber` - 0 不添加行号 1添加行号
    `firstLineNumber` - 起始编号 有效值 1-32767
    `spaceFromText` - 距正文 0 自动
    `lineNumberSpacing` - 行号间距 有效值 1-100
    `lineNumberStyle` - 编号样式 0 每页重新编号 1 每节重新编号 2 每落段重新编号 3 连续编号

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setDisplayLine(1,5,0,6,2);
         pageSetup.apply();

### setFirstPageDifferent

    public void setFirstPageDifferent(boolean isDifferent)

  设置本章节的页眉页脚是否可以首页不同。
  注：只有调用了apply()方法，此方法才起作用。
  注：页眉页脚可以同时设置奇偶页不同和首页不同。

  Overrides:
    `setFirstPageDifferent` in class `PageSetup`
  Parameters:
    `isDifferent` - 布尔型值，如为true，设置页眉页脚首页与其他页不同；否则，设置页眉页脚首页与其他页相同

    例子:

         //首先在页眉页脚中输入一些文字，并且插入多页。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setFirstPageDifferent(true);
         pageSetup.apply();

  See Also:
    `isFirstPageDifferent()`, `setOddAndEven(boolean)`, `apply()`

### setFooterPosition

    public void setFooterPosition(float footerPosition)

  设置本章节页脚下端与页面底部之间的距离（以磅为单位）。
  注：只有调用了apply()方法，此方法才起作用。
  注：此距离一定要小于正文下端与页面底部之间的距离，否则会弹出异常。

  Parameters:
    `footerPosition` - 页脚下端与页面底部之间的距离，此值越小，则页脚越高

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setFooterPosition(80.0f);
         pageSetup.apply();

  See Also:
    `setFooterPosition(float,int)`, `getFooterPosition()`, `apply()`

### setFooterPosition

    public void setFooterPosition(float footerPosition,
                                  int unit)

  设置本章节页脚下端与页面底部之间的距离（默认磅以为单位，也可以以其他度量为单位）。
  注：只有调用了apply()方法，此方法才起作用。
  注：此距离一定要小于正文下端与页面底部之间的距离，否则会弹出异常。

  Parameters:
    `footerPosition` - 页脚下端与页面底部之间的距离，此值越小，则页脚越高
    `unit` - 度量单位，其决定了页脚大小的真正值，常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setFooterPosition(1.20f,UnitConstants.CENTIMETER);
         pageSetup.apply();

  See Also:
    `setFooterPosition(float)`, `getFooterPosition()`, `apply()`, `Utilities`

### setGutter

    public void setGutter(float gutterValue,
                          int position,
                          boolean mirror)

  设置本章节的装订线与页面最左或最顶端之间的距离(以磅为单位）。 （注：只有调用了apply()方法，此方法才起作用。）

  Parameters:
    `gutterValue` - 装订线与页面最左端或最顶端之间的距离(以磅为单位）
    `position` - 装订线在页面上的位置，其常量和相应的值如下：

              SectionConstants.LEFT = 0（装订线在页面左边）
              SectionConstants.TOP = 1（装订线在页面上边）

    `mirror` - 布尔型值，如为true，设置装订线对称页边距，即奇数页装订线在页面一边，偶数页装订线在页面另一边；否则，设置装订线不对称页边距，即所有页装订线在页面的同一边 （注：此参数只有在装订线在页面左边时设置才有效。）

    例子:

         //首先在文本中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setGutter(50.0f,SectionConstants.LEFT,true);
         pageSetup.apply();

  See Also:
    `setGutter(float,int,int,boolean)`, `getGutterValue()`, `getGutterPosition()`, `isMirror()`, `apply()`, `Utilities`

### setGutter

    public void setGutter(float gutterValue,
                          int unit,
                          int position,
                          boolean mirror)

  设置本章节的装订线与页面最左或最顶端之间的距离(默认以磅为单位）。 （注：只有调用了apply()方法，此方法才起作用。）

  Parameters:
    `gutterValue` - 装订线与页面最左端或最顶端之间的距离
    `unit` - 度量单位，其决定了装订线与页面最左端或最顶端之间距离的真正值，其常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    `position` - 装订线在页面上的位置，其常量和相应的值如下：

              SectionConstants.LEFT = 0（装订线在页面左边）
              SectionConstants.TOP ＝1（装订线在页面上边)

    `mirror` - 布尔型值， 如为true，设置装订线对称页边距，即奇数页装订线在页面一边，偶数页装订线在页面另一边；否则，设置装订线不对称页边距，即所有页装订线在页面的同一边 注：此参数只有在装订线在页面左边时设置才有效。

    例子:

         //首先在文本中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setGutter(3.0f,UnitConstants.CENTIMETER,SectionConstants.LEFT,true);
         pageSetup.apply();

  See Also:
    `setGutter(float,int,boolean)`, `getGutterValue()`, `getGutterPosition()`, `isMirror()`, `apply()`, `Utilities`

### setHeaderPosition

    public void setHeaderPosition(float headerPosition)

  设置本章节页眉上端与页面顶部之间的距离（以磅为单位）。
  注：只有调用了apply()方法，此方法才起作用。
  注：此距离一定要小于正文上端与页面顶部之间的距离，否则会弹出异常。

  See Also:
    `setHeaderPosition(float,int)`, `getHeaderPosition()`, `apply()`

### setHeaderPosition

    public void setHeaderPosition(float headerPosition,
                                  int unit)

  设置本章节页眉上端与页面顶部之间的距离（默认磅以为单位，也可以以其他度量为单位）。
  注：只有调用了apply()方法，此方法才起作用。
  注：此距离一定要小于正文上端与页面顶部之间的距离，否则会弹出异常。

  Parameters:
    `headerPosition` - 页眉上端与页面顶部之间的距离，此值越小，则页眉越高
    `unit` - 度量单位，其决定了页眉大小的真正值，其常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    例子:

         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setHeaderPosition(1.20f,UnitConstants.CENTIMETER);
         pageSetup.apply();

  See Also:
    `setHeaderPosition(float)`, `getHeaderPosition()`, `apply()`, `Utilities`

### setHidden

    public void setHidden(boolean hidden)

  设置在页面中是否显示带有隐藏文字字体属性的字符串。
  注：只有调用了apply()方法，此方法才起作用。
  注：此方法是应用于整个文档的而不是应用于某一个章节，对某章节设置了属性，则其它章节也会有效。

  Overrides:
    `setHidden` in class `PageSetup`
  Parameters:
    `hidden` - 布尔型值，如为true，表示显示带有隐藏文字字体属性的字符串；否则，不显示带有隐藏文字字体属性的字符串

    例子:

         //首先在文本中输入一些文字，然后对其部分设置隐藏字体属性。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setHidden(true);
         pageSetup.apply();

  See Also:
    `isHidden()`, `apply()`

### setOddAndEven

    public void setOddAndEven(boolean isDifferent)

  设置本章节的页眉页脚是否奇偶页可以不同。
  注：只有调用了apply()方法，此方法才起作用。
  注：页眉页脚可以同时设置奇偶页不同和首页不同。

  Overrides:
    `setOddAndEven` in class `PageSetup`
  Parameters:
    `isDifferent` - 布尔型值，如为true，设置页眉页脚奇偶页不同；否则，设置页眉页脚奇偶页相同

    例子:

         //首先在页眉页脚中输入一些文字，并且插入多页。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOddAndEven(true);
         pageSetup.apply();

  See Also:
    `isOddAndEven()`, `setFirstPageDifferent(boolean)`, `apply()`

### setOrientation

    public void setOrientation(int oritation)

  设置本章节的页面方向为竖排方式还是横排方式（页面方向默认为竖排方式）。
  注：只有调用了apply()方法，此方法才起作用。
  注：页面方向为竖排还是横排与页面的宽度高度有关， 竖排方式下的页面高度等于横排方式下的页面宽度，反之亦然。

  Overrides:
    `setOrientation` in class `PageSetup`
  Parameters:
    `oritation` - 本章节的页面方向，其常量和相应的值如下：

              SectionConstants.PORTRAIT = 0（竖排方式）；
              SectionConstants.LANDSCAPE = 1（横排方式）

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOrientation(SectionConstants.LANDSCAPE);
         pageSetup.apply();

  See Also:
    `getOrientation()`, `setPageHeight(float)`, `setPageWidth(float)`, `apply()`

### setPageBottomMargin

    public void setPageBottomMargin(float pageBottomMargin)

  设置本章节的正文最下端与页面底边的距离 (以磅为单位)。
  注：只有调用了apply()方法，此方法才起作用。
  注：正文最下端与页面底边的距离一定要大于页脚底部与页面底边的距离，否则会弹出异常。

  Parameters:
    `pageBottomMargin` - 正文最下端与页面底边的距离(以磅为单位)，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageBottomMargin(60.0f);
         pageSetup.apply();

  See Also:
    `setPageBottomMargin(float,int)`, `getPageBottomMargin()`, `setPageRightMargin(float)`, `setPageLeftMargin(float)`, `setPageTopMargin(float)`, `setFooterPosition(float)`, `apply()`

### setPageBottomMargin

    public void setPageBottomMargin(float pageBottomMargin,
                                    int unit)

  设置本章节的正文最下端与页面底边的距离 (默认以磅为单位)。
  注：只有调用了apply()方法，此方法才起作用。
  注：正文最下端与页面底边的距离一定要大于页脚底部与页面底边的距离，否则会弹出异常。

  Parameters:
    `pageBottomMargin` - 正文最下端与页面底边的距离(默认以磅为单位)
    `unit` - 度量单位，其决定了下边距的真正值，其常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageBottomMargin(2.0f,UnitConstants.CENTIMETER);
         pageSetup.apply();

  See Also:
    `setPageBottomMargin(float)`, `getPageBottomMargin()`, `setPageRightMargin(float)`, `setPageLeftMargin(float)`, `setPageTopMargin(float)`, `setFooterPosition(float)`, `apply()`, `Utilities`

### setPageHeight

    public void setPageHeight(float pageHeight)

  设置本章节的页面高度（以磅为单位）。
  注：只有调用了apply()方法，此方法才起作用。
  注：页面方向为竖排还是横排与页面的宽度高度有关， 竖排方式下的页面高度等于横排方式下的页面宽度，反之亦然。

  Parameters:
    `pageHeight` - 页面高度

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOrientation(SectionConstants.LANDSCAPE);
         pageSetup.setPageHeight(300.0f);
         pageSetup.apply();

  See Also:
    `setPageHeight(float,int)`, `getPageHeight()`, `setOrientation(int)`, `setPageWidth(float)`, `apply()`

### setPageHeight

    public void setPageHeight(float pageHeight,
                              int unit)

  设置本章节的页面高度（默认以磅为单位）。
  注：只有调用了apply()方法，此方法才起作用。
  注：页面方向为竖排还是横排与页面的宽度高度有关， 竖排方式下的页面高度等于横排方式下的页面宽度，反之亦然。

  Parameters:
    `pageHeight` - 页面高度（默认以磅为单位）
    `unit` - 度量单位，其决定了页面高度的真正值，其常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOrientation(SectionConstants.LANDSCAPE);
         pageSetup.setPageHeight(18.0f,UnitConstants.CENTIMETER);
         pageSetup.apply();

  See Also:
    `setPageHeight(float)`, `getPageHeight()`, `setOrientation(int)`, `setPageWidth(float)`, `apply()`, `Utilities`

### setPageLeftMargin

    public void setPageLeftMargin(float pageLeftMargin)

  设置本章节的正文最左端与页面左边的距离 (以磅为单位)。 (注：只有调用了apply()方法，此方法才起作用。)

  Parameters:
    `pageLeftMargin` - 正文最左端与页面左边的距离(以磅为单位)，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageLeftMargin(60.0f);
         pageSetup.apply();

  See Also:
    `setPageLeftMargin(float,int)`, `getPageLeftMargin()`, `setPageRightMargin(float)`, `setPageBottomMargin(float)`, `setPageTopMargin(float)`, `apply()`

### setPageLeftMargin

    public void setPageLeftMargin(float pageLeftMargin,
                                  int unit)

  设置本章节的正文最左端与页面左边的距离 (默认以磅为单位)。 （注：只有调用了apply()方法，此方法才起作用。）

  Parameters:
    `pageLeftMargin` - 正文最左端与页面左边的距离(默认以磅为单位)
    `unit` - 度量单位，其决定了左边距的真正值，其常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageLeftMargin(2.0f,UnitConstants.CENTIMETER);
         pageSetup.apply();

  See Also:
    `setPageLeftMargin(float)`, `getPageLeftMargin()`, `setPageRightMargin(float)`, `setPageBottomMargin(float)`, `setPageTopMargin(float)`, `apply()`, `Utilities`

### setPageRightMargin

    public void setPageRightMargin(float pageRightMargin)

  设置本章节的正文最右端与页面右边的距离 (以磅为单位)。 (注：只有调用了apply()方法，此方法才起作用。)

  Parameters:
    `pageRightMargin` - 正文最右端与页面右边的距离(以磅为单位)，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageRightMargin(60.0f);
         pageSetup.apply();

  See Also:
    `setPageRightMargin(float,int)`, `getPageRightMargin()`, `setPageLeftMargin(float)`, `setPageBottomMargin(float)`, `setPageTopMargin(float)`, `apply()`

### setPageRightMargin

    public void setPageRightMargin(float pageRightMargin,
                                   int unit)

  设置本章节的正文最右端与页面右边的距离 (默认以磅为单位)。 （注：只有调用了apply()方法，此方法才起作用。）

  Parameters:
    `pageRightMargin` - 正文最右端与页面右边的距离（默认以磅为单位）
    `unit` - 度量单位，其决定了右边距的真正值，其常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageRightMargin(2.0f,UnitConstants.CENTIMETER);
         pageSetup.apply();

  See Also:
    `setPageRightMargin(float)`, `getPageRightMargin()`, `setPageLeftMargin(float)`, `setPageBottomMargin(float)`, `setPageTopMargin(float)`, `apply()`, `Utilities`

### setPageTopMargin

    public void setPageTopMargin(float pageTopMargin)

  设置本章节的正文最上端与页面顶边的距离 (以磅为单位)。
  注：只有调用了apply()方法，此方法才起作用。
  注：正文最上端与页面顶边的距离一定要大于页眉顶部与页面顶边的距离，否则会弹出异常。

  Parameters:
    `pageTopMargin` - 正文最上端与页面顶边的距离(以磅为单位)，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageTopMargin(60.0f);
         pageSetup.apply();

  See Also:
    `setPageTopMargin(float,int)`, `getPageTopMargin()`, `setPageRightMargin(float)`, `setPageLeftMargin(float)`, `setPageBottomMargin(float)`, `setHeaderPosition(float)`, `apply()`

### setPageTopMargin

    public void setPageTopMargin(float pageTopMargin,
                                 int unit)

  设置本章节的正文最上端与页面顶边的距离 (默认以磅为单位)。
  注：只有调用了apply()方法，此方法才起作用。
  注：正文最上端与页面顶边的距离一定要大于页眉顶部与页面顶边的距离，否则会弹出异常。

  Parameters:
    `pageTopMargin` - 正文最上端与页面顶边的距离(默认以磅为单位)
    `unit` - 度量单位，其决定了上边距的真正值，其常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setPageTopMargin(2.0f,UnitConstants.CENTIMETER);
         pageSetup.apply();

  See Also:
    `setPageTopMargin(float)`, `getPageTopMargin()`, `setPageRightMargin(float)`, `setPageLeftMargin(float)`, `setPageBottomMargin(float)`, `setHeaderPosition(float)`, `apply()`, `Utilities`

### setPageWidth

    public void setPageWidth(float pageWidth)

  设置本章节的页面宽度（以磅为单位）。
  注：只有调用了apply()方法，此方法才起作用。
  注：页面方向为竖排还是横排与页面的宽度高度有关， 竖排方式下的页面宽度等于横排方式下的页面高度，反之亦然。

  Parameters:
    `pageWidth` - 页面宽度，为float型

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOrientation(SectionConstants.LANDSCAPE);
         pageSetup.setPageWidth(200.0f);
         pageSetup.apply();

  See Also:
    `setPageWidth(float,int)`, `getPageWidth()`, `setOrientation(int)`, `setPageHeight(float)`, `apply()`

### setPageWidth

    public void setPageWidth(float pageWidth,
                             int unit)

  设置本章节的页面宽度（默认以磅为单位）。
  注：只有调用了apply()方法，此方法才起作用。
  注：页面方向为竖排还是横排与页面的宽度高度有关， 竖排方式下的页面宽度等于横排方式下的页面高度，反之亦然。

  Parameters:
    `pageWidth` - 页面宽度（默认以磅为单位），为float型
    `unit` - 度量单位，其决定了页面宽度的真正值，其常量和相应的值如下：

              UnitConstants.INCH = 0（度量单位为英寸）；
              UnitConstants.CENTIMETER = 1（度量单位为厘米）；
              UnitConstants.MILLIMETER = 2（度量单位为毫米）；
              UnitConstants.POINT = 3（表示度量单位为磅）；
              UnitConstants.PICA = 4（度量单位为十二点活字）

    例子:

         //首先在正文中输入一些文字。
         Document doc = Application.getWorkbooks().getActiveDocument();
         Section section = doc.getSection(0);
         WpPageSetup pageSetup = section.getPageSetup();
         pageSetup.setOrientation(SectionConstants.LANDSCAPE);
         pageSetup.setPageWidth(16.0f,UnitConstants.CENTIMETER);
         pageSetup.apply();

  See Also:
    `setPageWidth(float)`, `getPageWidth()`, `setOrientation(int)`, `setPageHeight(float)`, `apply()`, `Utilities`

### setSci

    public void setSci(int type)

  设置缩放的纸型;

  Overrides:
    `setSci` in class `PageSetup`
  Parameters:
    `type` - 缩放的纸型

    例子：

         PageSetup page = Application.getWorkbooks().getActiveWorkbook()
                                     .getWorksheets().getPageSetup("默认");
         page.setSci(1);

### setSectionStart

    public void setSectionStart(int selectStartType)

  设置节的起始点类型。

  Overrides:
    `setSectionStart` in class `PageSetup`
  Parameters:
    `selectStartType` - 节的起始点类型，其常量和相应的值如下：

              SectionConstants.NEXTPAGE = 0 （下一页）
              SectionConstants.ODDPAGE = 1（奇数页）
              SectionConstants.EVENPAGE = 2（偶数页）

    //首先在页眉页脚中输入一些文字，并且插入多个节。 Document doc = Application.getWorkbooks().getActiveDocument(); Section section = doc.getSection(0); WpPageSetup pageSetup = section.getPageSetup(); pageSetup.setSectionStart(SectionConstants.NEXTPAGE); pageSetup.apply();
  See Also:
    `getSectionStart()`, `apply()`

Overview | Package | Class | Tree | Index | Help

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

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