[]
首页
开发者学堂
文档
活字格 SpreadJS GcExcel Wyn
论坛
市场
生态机会
招聘求职 项目合作
活动
论坛活动与公告 线下活动 GCDG开发者社区活动
产品首页 在线Demo 产品文档 API 参考 技术社区
V9.2
立即试用
(Showing Draft Content)

IPageSetup

Interface IPageSetup

public interface IPageSetup
表示页面设置说明。

提供对工作表打印和分页设置的访问，包括纸张大小、方向、边距、页眉和页脚、打印区域、重复的标题行和标题列、页面顺序，以及打印或导出工作表时使用的缩放选项。

使用 IWorksheet.getPageSetup() 可获取工作表的页面设置并配置其打印行为。


 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setOrientation(PageOrientation.Landscape);
 pageSetup.setPrintTitleRows("$1:$1");
 pageSetup.setFitToPagesWide(1);
 pageSetup.setFitToPagesTall(0);

  • Method Details

    • getPrintQuality

      PrintQuality getPrintQuality()
      获取表示此页面当前打印质量的 PrintQuality 值。

      使用此属性可以确定打印工作表时将应用的当前页面打印分辨率。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintQuality(PrintQuality.Dpi144);
 PrintQuality printQuality = pageSetup.getPrintQuality();
      Returns:
      此页面当前的 PrintQuality 值。

    • setPrintQuality

      void setPrintQuality(PrintQuality value)
      设置表示此页面打印质量的 PrintQuality 值。

      默认值为 600 dpi。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintQuality(PrintQuality.Dpi144);
      Parameters:
      value - 表示此页面打印质量的 PrintQuality 值。

    • getBlackAndWhite

      boolean getBlackAndWhite()
      获取文档元素是否将以黑白方式打印。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBlackAndWhite(true);
 boolean blackAndWhite = pageSetup.getBlackAndWhite();
      Returns:
      如果文档元素将以黑白方式打印，则为 true；否则为 false。

    • setBlackAndWhite

      void setBlackAndWhite(boolean value)
      设置文档元素是否以黑白方式打印。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBlackAndWhite(true);
      Parameters:
      value - 如果文档元素将以黑白方式打印，则为 true；否则为 false。

    • getLeftMargin

      double getLeftMargin()
      获取左边距的大小，以点为单位。

      此值指定用于打印的左侧页面边距，并可通过 setLeftMargin(double) 配置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setLeftMargin(36);
 double leftMargin = pageSetup.getLeftMargin();
      Returns:
      左边距的大小，以点为单位。

    • setLeftMargin

      void setLeftMargin(double value)
      设置左边距的大小，以点为单位。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setLeftMargin(36);
      Parameters:
      value - 左边距的大小，以点为单位。

    • getRightMargin

      double getRightMargin()
      获取右边距的大小，以点为单位。

      此值指定打印时使用的右页边距，并可通过 setRightMargin(double) 配置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setRightMargin(36);
 double rightMargin = pageSetup.getRightMargin();
      Returns:
      右边距的大小，以点为单位。

    • setRightMargin

      void setRightMargin(double value)
      设置右边距的大小，以点为单位。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setRightMargin(36);
      Parameters:
      value - 右边距的大小，以点为单位。

    • getTopMargin

      double getTopMargin()
      获取顶部边距的大小，以点为单位。

      此值指定用于打印的顶部页面边距，并可通过 setTopMargin(double) 配置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setTopMargin(36);
 double topMargin = pageSetup.getTopMargin();
      Returns:
      顶部边距的大小，以点为单位。

    • setTopMargin

      void setTopMargin(double value)
      设置顶部边距的大小，以点为单位。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setTopMargin(36);
      Parameters:
      value - 顶部边距的大小，以点为单位。

    • getBottomMargin

      double getBottomMargin()
      获取底边距的大小，以点为单位。

      此值指定打印时使用的底部页边距，并可通过 setBottomMargin(double) 配置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBottomMargin(36);
 double bottomMargin = pageSetup.getBottomMargin();
      Returns:
      底边距的大小，以点为单位。

    • setBottomMargin

      void setBottomMargin(double value)
      设置底边距的大小，以点为单位。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBottomMargin(36);
      Parameters:
      value - 底边距的大小，以点为单位。

    • getHeaderMargin

      double getHeaderMargin()
      获取页眉边距的大小，以点为单位。

      使用此方法可获取页面设置中为打印配置的当前页眉边距。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setHeaderMargin(18);
 double headerMargin = pageSetup.getHeaderMargin();
      Returns:
      页眉边距的大小，以点为单位。

    • setHeaderMargin

      void setHeaderMargin(double value)
      设置页眉边距的大小，以点为单位。

      使用此方法可设置页面设置中为打印配置的页眉边距。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setHeaderMargin(18);
      Parameters:
      value - 页眉边距的大小，以点为单位。

    • getFooterMargin

      double getFooterMargin()
      获取页脚边距的大小，以点为单位。

      使用此方法可获取页面设置中为页脚边距配置的当前距离。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setFooterMargin(93.6);
 double footerMargin = pageSetup.getFooterMargin();
      Returns:
      页脚边距的大小，以点为单位。

    • setFooterMargin

      void setFooterMargin(double value)
      设置页脚边距的大小，以点为单位。

      使用此方法可设置页面设置中为页脚边距配置的距离。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setFooterMargin(93.6);
      Parameters:
      value - 页脚边距的大小，以点为单位。

    • getCenterFooter

      String getCenterFooter()
      获取 IPageSetup 对象的中间页脚部分中的文本。

      返回的字符串指定页脚中间部分打印的内容。它可以包含页眉和页脚代码，例如页码占位符。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setCenterFooter("Page &P of &N");
 String centerFooter = pageSetup.getCenterFooter();
      Returns:
      中间页脚部分中的文本。如果未设置中间页脚文本，则返回空字符串。

    • setCenterFooter

      void setCenterFooter(String value)
      设置 PageSetup 对象中的居中页脚文本。

      该字符串指定页脚居中区域中打印的内容。它可以包含页码占位符等页眉和页脚代码，这些代码受页面设置页脚文本支持。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setCenterFooter("Page &P of &N");
      Parameters:
      value - 居中页脚文本。如果未设置居中页脚文本，则设置为空字符串。

    • getCenterHeader

      String getCenterHeader()
      获取 IPageSetup 对象的中间页眉部分中的文本。

      使用此属性可获取工作表页面设置的居中页眉内容。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setCenterHeader("Quarterly Report");
 String centerHeader = pageSetup.getCenterHeader();
      Returns:
      中间页眉部分中的文本。如果未设置中间页眉文本，则返回空字符串。

    • setCenterHeader

      void setCenterHeader(String value)
      设置 IPageSetup 对象的中间页眉部分中的文本。

      使用此属性可设置工作表页面设置的居中页眉内容。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setCenterHeader("Quarterly Report");
      Parameters:
      value - 中间页眉部分中的文本。如果未设置中间页眉文本，则设置为空字符串。

    • getLeftFooter

      String getLeftFooter()
      获取 IPageSetup 对象的左页脚部分中的文本。

      返回的字符串表示页面设置中配置的当前左页脚内容。它可以包含页眉和页脚格式代码。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setLeftFooter("&\"Arial,Italic\"Confidential");
 String leftFooter = pageSetup.getLeftFooter();
      Returns:
      左页脚部分中的文本。如果未设置左页脚文本，则返回空字符串。

    • setLeftFooter

      void setLeftFooter(String value)
      设置 IPageSetup 对象的左侧页脚部分中的文本。

      使用此方法可以配置工作表页面设置的左侧页脚内容。该值可以包含页眉和页脚格式代码，例如页码占位符或格式设置指令。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setLeftFooter("&\"Arial,Italic\"Confidential");
      Parameters:
      value - 要在左侧页脚部分中设置的文本。如果不需要左侧页脚文本，则设置为空字符串。

    • getLeftHeader

      String getLeftHeader()
      获取 IPageSetup 对象左侧页眉区域中的文本。

      返回的字符串表示页面设置中当前配置的左侧页眉内容。它可以包含页眉文本以及为打印设置的任何页眉代码。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setLeftHeader("&\"Arial,Italic\"Sales Report");
 String leftHeader = pageSetup.getLeftHeader();
      Returns:
      左侧页眉区域中的文本。如果未设置左侧页眉文本，则返回空字符串。

    • setLeftHeader

      void setLeftHeader(String value)
      设置工作簿或节的左页眉上的文本对齐方式。

      设置工作表打印时为左页眉配置的字符串。返回的值可包含页眉文本以及为打印设置的任何页眉代码。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setLeftHeader("&\"Arial,Italic\"Sales Report");
      Parameters:
      value - 页面设置的左页眉字符串。

    • getRightFooter

      String getRightFooter()
      获取 IPageSetup 对象的右侧页脚部分中的文本。

      返回的字符串表示为页面页脚右侧部分配置的页脚内容，包括任何受支持的页眉或页脚格式代码。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setRightFooter("&D");
 String rightFooter = pageSetup.getRightFooter();
      Returns:
      右侧页脚部分中的文本。如果未设置右侧页脚文本，则返回空字符串。

    • setRightFooter

      void setRightFooter(String value)
      设置 IPageSetup 对象的右页脚部分中的文本。

      使用此方法可配置工作表页面设置的右页脚内容。该值可以包含页眉和页脚格式代码，例如页码占位符或格式说明。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setRightFooter("&D");
      Parameters:
      value - 要在右页脚部分设置的文本。如果不需要右页脚文本，请设置为空字符串。

    • getRightHeader

      String getRightHeader()
      获取 IPageSetup 对象的右页眉部分中的文本。

      使用此方法可获取页面页眉右侧部分中显示的文本。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setRightHeader("Page &[Page]");
 String rightHeader = pageSetup.getRightHeader();
      Returns:
      右页眉部分中的文本。如果未设置右页眉文本，则返回空字符串。

    • setRightHeader

      void setRightHeader(String value)
      设置页眉的右侧部分。

      设置页面页眉右侧部分中显示的文本。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setRightHeader("Page &[Page]");
      Parameters:
      value - 页面页眉右侧部分中的文本。如果未设置右侧页眉，则设置为空字符串。

    • getCenterHorizontally

      boolean getCenterHorizontally()
      获取打印时工作表是否在页面上水平居中。

      此属性指示打印时工作表内容是否在可打印页面区域内水平居中。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setCenterHorizontally(true);
 boolean centerHorizontally = pageSetup.getCenterHorizontally();
      Returns:
      如果打印时工作表在页面上水平居中，则为 true；否则为 false。

    • setCenterHorizontally

      void setCenterHorizontally(boolean value)
      设置打印时工作表是否在页面上水平居中。

      此属性指示打印期间工作表内容是否在可打印页面区域内水平居中。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setCenterHorizontally(true);
      Parameters:
      value - 如果打印时工作表在页面上水平居中，则为 true；否则为 false。

    • getCenterVertically

      boolean getCenterVertically()
      获取打印时工作表是否在页面上垂直居中。

      此属性指示打印期间工作表内容是否在可打印页面区域内垂直居中。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setCenterVertically(true);
 boolean centerVertically = pageSetup.getCenterVertically();
      Returns:
      如果工作表在打印页面上垂直居中，则为 true；否则为 false。

    • setCenterVertically

      void setCenterVertically(boolean value)
      设置打印时工作表是否在页面上垂直居中。

      此属性指示打印时工作表内容是否在可打印页面区域内垂直居中。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setCenterVertically(true);
      Parameters:
      value - 如果工作表在打印页面上垂直居中，则为 true；否则为 false。

    • getOddAndEvenPagesHeaderFooter

      boolean getOddAndEvenPagesHeaderFooter()
      获取指定的 PageSetup 对象是否为奇数页和偶数页使用不同的页眉和页脚。

      当此属性为 true 时，工作表可以为偶数页使用单独的页眉和页脚设置，例如通过 getEvenPage() 公开的设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setOddAndEvenPagesHeaderFooter(true);
 boolean oddAndEvenPagesHeaderFooter = pageSetup.getOddAndEvenPagesHeaderFooter();
      Returns:
      如果奇数页和偶数页使用不同的页眉和页脚，则为 true；否则为 false。

    • setOddAndEvenPagesHeaderFooter

      void setOddAndEvenPagesHeaderFooter(boolean value)
      设置指定的 PageSetup 对象是否为奇数页和偶数页使用不同的页眉和页脚。

      当此属性为 true 时，工作表可以为偶数页使用单独的页眉和页脚设置，例如通过 getEvenPage() 公开的设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setOddAndEvenPagesHeaderFooter(true);
      Parameters:
      value - 如果奇数页和偶数页使用不同的页眉和页脚，则为 true；否则为 false。

    • getDifferentFirstPageHeaderFooter

      boolean getDifferentFirstPageHeaderFooter()
      获取第一页是否使用不同的页眉或页脚。

      当此属性为 true 时，第一页可以使用自己的页眉和页脚设置，而不是默认页面页眉和页脚。使用 setDifferentFirstPageHeaderFooter(boolean) 启用此行为，然后再通过 getFirstPage() 配置第一页。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setDifferentFirstPageHeaderFooter(true);
 pageSetup.getFirstPage().getCenterHeader().setText("Cover Page");
 boolean differentFirstPageHeaderFooter = pageSetup.getDifferentFirstPageHeaderFooter();
      Returns:
      如果第一页使用不同的页眉或页脚，则为 true；否则为 false。

    • setDifferentFirstPageHeaderFooter

      void setDifferentFirstPageHeaderFooter(boolean value)
      设置首页是否使用不同的页眉或页脚。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setDifferentFirstPageHeaderFooter(true);
 pageSetup.getFirstPage().getCenterHeader().setText("Cover Page");
      Parameters:
      value - 如果首页使用不同的页眉或页脚，则为 true；否则为 false。

    • getScaleWithDocHeaderFooter

      boolean getScaleWithDocHeaderFooter()
      获取当文档大小发生变化时，页眉和页脚是否随文档一起缩放。

      此设置会影响打印时页眉和页脚内容是否跟随应用于文档的缩放。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setScaleWithDocHeaderFooter(true);
 boolean scaleWithDocHeaderFooter = pageSetup.getScaleWithDocHeaderFooter();
      Returns:
      如果当文档大小发生变化时页眉和页脚随文档一起缩放，则为 true；否则为 false。

    • setScaleWithDocHeaderFooter

      void setScaleWithDocHeaderFooter(boolean value)
      设置当文档大小发生变化时，页眉和页脚是否随文档一起缩放。

      此设置会影响打印时页眉和页脚内容是否跟随应用于文档的缩放。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setScaleWithDocHeaderFooter(true);
      Parameters:
      value - 如果当文档大小发生变化时页眉和页脚随文档一起缩放，则为 true；否则为 false。

    • getAlignMarginsHeaderFooter

      boolean getAlignMarginsHeaderFooter()
      获取页眉和页脚是否与页面设置选项中设置的边距对齐。

      当此属性为 true 时，工作表打印时，页眉和页脚使用当前 IPageSetup 设置中定义的页边距进行对齐。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setAlignMarginsHeaderFooter(true);
 boolean alignMarginsHeaderFooter = pageSetup.getAlignMarginsHeaderFooter();
      Returns:
      如果页眉和页脚与页面设置选项中设置的边距对齐，则为 true；否则为 false。

    • setAlignMarginsHeaderFooter

      void setAlignMarginsHeaderFooter(boolean value)
      设置页眉和页脚是否与页面设置选项中设置的边距对齐。

      当此属性为 true 时，打印工作表时页眉和页脚会使用当前 IPageSetup 设置中定义的页面边距进行对齐。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setAlignMarginsHeaderFooter(true);
      Parameters:
      value - 如果页眉和页脚与页面设置选项中设置的边距对齐，则为 true；否则为 false。

    • getDraft

      boolean getDraft()
      获取是否不带图形打印工作表。

      当此属性返回 true 时，工作表以草稿模式打印。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setDraft(true);
 boolean draft = pageSetup.getDraft();
      Returns:
      如果不带图形打印工作表，则为 true；否则为 false。

    • setDraft

      void setDraft(boolean value)
      设置打印工作表时是否不打印图形。

      当此属性设置为 true 时，工作表将以草稿模式打印。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setDraft(true);
      Parameters:
      value - 如果打印工作表时不打印图形，则为 true；否则为 false。

    • getFirstPageNumber

      int getFirstPageNumber()
      获取打印此工作表时将使用的第一个页码。

      如果为 Automatic，Document Solutions for Excel 会选择第一个页码。默认值为 Automatic。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsAutoFirstPageNumber(false);
 pageSetup.setFirstPageNumber(3);
 int firstPageNumber = pageSetup.getFirstPageNumber();
      Returns:
      打印此工作表时要使用的第一个页码。如果启用了自动页码编号，Document Solutions for Excel 会选择第一个页码。

    • setFirstPageNumber

      void setFirstPageNumber(int value)
      设置打印此工作表时将使用的第一页码。

      如果为自动，Document Solutions for Excel 会选择第一页码。默认值为自动。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsAutoFirstPageNumber(false);
 pageSetup.setFirstPageNumber(3);
      Parameters:
      value - 打印此工作表时要使用的第一页码。如果启用了自动页码，Document Solutions for Excel 会选择第一页码。

    • getIsAutoFirstPageNumber

      boolean getIsAutoFirstPageNumber()
      获取是否自动分配第一个页码。

      默认值为 true。指定第一个页码后，此方法返回 false。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setFirstPageNumber(3);
 boolean isAutoFirstPageNumber = pageSetup.getIsAutoFirstPageNumber();
      Returns:
      如果自动分配第一个页码，则为 true；如果已指定特定的第一个页码，则为 false。

    • setIsAutoFirstPageNumber

      void setIsAutoFirstPageNumber(boolean value)
      设置是否自动分配第一页码。

      默认值为 true。指定第一页码后，此方法设置 false。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setFirstPageNumber(3);
 pageSetup.setIsAutoFirstPageNumber(true);
      Parameters:
      value - 如果自动分配第一页码，则为 true；如果已指定特定第一页码，则为 false。

    • getFitToPagesTall

      int getFitToPagesTall()
      获取工作表在打印时将缩放到的纵向页数。仅适用于工作表。

      当工作表缩放由 setIsPercentScale(boolean) 而不是缩放百分比控制时，将使用此设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsPercentScale(false);
 pageSetup.setFitToPagesTall(2);
 int pagesTall = pageSetup.getFitToPagesTall();
      Returns:
      工作表在打印时将缩放到的纵向页数。

    • setFitToPagesTall

      void setFitToPagesTall(int value)
      设置打印时工作表要缩放到的高度页数。仅适用于工作表。

      当工作表缩放由 setIsPercentScale(boolean) 而不是缩放百分比控制时，将使用此设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsPercentScale(false);
 pageSetup.setFitToPagesTall(2);
      Parameters:
      value - 打印时工作表要缩放到的高度页数。

    • getFitToPagesWide

      int getFitToPagesWide()
      获取工作表在打印时将缩放到的横向页数。仅适用于工作表。

      此值指定水平分页的最大页数。当 getIsPercentScale() 返回 false 时，工作表使用 getFitToPagesWide() 与 getFitToPagesTall() 一起控制适合页面缩放。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsPercentScale(false);
 pageSetup.setFitToPagesWide(3);
 int pagesWide = pageSetup.getFitToPagesWide();
      Returns:
      工作表在打印时将缩放到的横向页数。

    • setFitToPagesWide

      void setFitToPagesWide(int value)
      设置打印时工作表要缩放到的宽度页数。仅适用于工作表。

      此值指定水平分页的最大页数。当 getIsPercentScale() 设置为 false 时，工作表会将 getFitToPagesWide() 与 getFitToPagesTall() 一起用于控制适合页面的缩放。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsPercentScale(false);
 pageSetup.setFitToPagesWide(3);
      Parameters:
      value - 打印时工作表要缩放到的宽度页数。

    • getIsPercentScale

      boolean getIsPercentScale()
      获取工作表是否按百分比缩放。

      如果此属性为 true，则工作表使用基于百分比的缩放。如果此属性为 false，则 getFitToPagesWide() 和 getFitToPagesTall() 设置控制工作表的缩放方式。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsPercentScale(true);
 boolean isPercentScale = pageSetup.getIsPercentScale();
      Returns:
      如果工作表按百分比缩放，则为 true；如果由 getFitToPagesWide() 和 getFitToPagesTall() 控制工作表的缩放方式，则为 false。

    • setIsPercentScale

      void setIsPercentScale(boolean value)
      设置工作表是否按百分比缩放。

      如果此属性为 true，则工作表使用基于百分比的缩放。如果此属性为 false，则 getFitToPagesWide() 和 getFitToPagesTall() 设置控制工作表的缩放方式。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsPercentScale(true);
      Parameters:
      value - 如果此属性为 true，则工作表按百分比缩放；getFitToPagesWide() 和 getFitToPagesTall() 控制工作表的缩放方式。

    • getOrder

      Order getOrder()
      获取一个 Order 值，该值表示打印大型工作表时用于对页面编号的顺序。

      此属性确定页面是先沿行向下编号再跨列编号，还是先跨列编号再沿行向下编号。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setOrder(Order.OverThenDown);
 Order order = pageSetup.getOrder();
      Returns:
      打印大型工作表时的页面编号顺序。如果未显式设置页面顺序，则返回 Order.DownThenOver。

    • setOrder

      void setOrder(Order value)
      设置一个 Order 值，该值表示打印大型工作表时用于对页面编号的顺序。

      当工作表跨多个打印页面时，使用此方法可控制页面是先沿行向下编号还是先跨列编号。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setOrder(Order.OverThenDown);
      Parameters:
      value - 打印大型工作表时要使用的页面编号顺序。

    • getOrientation

      PageOrientation getOrientation()
      获取表示纵向或横向打印模式的 PageOrientation 值。

      使用此方法可以检索为工作表页面设置配置的当前页面方向。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setOrientation(PageOrientation.Landscape);
 PageOrientation orientation = pageSetup.getOrientation();
      Returns:
      表示纵向或横向打印模式的 PageOrientation 值。

    • setOrientation

      void setOrientation(PageOrientation value)
      设置表示纵向或横向打印模式的 PageOrientation 值。

      使用此方法可以控制工作表页面在打印或导出为分页格式时的方向。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setOrientation(PageOrientation.Landscape);
      Parameters:
      value - 要应用的页面方向。

    • getPaperSize

      PaperSize getPaperSize()
      获取纸张大小。

      使用此方法可获取工作表打印时用于页面设置的当前 PaperSize 设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPaperSize(PaperSize.A4);
 PaperSize paperSize = pageSetup.getPaperSize();
      Returns:
      当前纸张大小设置。

    • setPaperSize

      void setPaperSize(PaperSize value)
      设置纸张大小。

      使用此方法可选择内置的 PaperSize 用于打印或页面布局。要以英寸为单位定义自定义大小，请改用 customPaperSize(double,double)。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPaperSize(PaperSize.A4);
      Parameters:
      value - 要使用的内置纸张大小。

    • customPaperSize

      void customPaperSize(double width, double height)
      设置自定义纸张大小，以英寸为单位。

      此方法为页面设置应用用户定义的纸张大小。调用此方法后，getPaperWidth() 和 getPaperHeight() 将返回指定的自定义尺寸。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.customPaperSize(8.5, 13);
 double paperWidth = pageSetup.getPaperWidth();
 double paperHeight = pageSetup.getPaperHeight();
      Parameters:
      width - 纸张宽度，以英寸为单位。必须大于 0。
      height - 纸张高度，以英寸为单位。必须大于 0。
      Throws:
      RuntimeException - 如果 width 或 height 小于或等于 0。

    • getPaperWidth

      double getPaperWidth()
      获取纸张的宽度（英寸），并考虑页面方向。

      如果通过 customPaperSize(double,double) 设置了自定义纸张大小，则此方法返回配置的纸张宽度。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.customPaperSize(8.5, 13);
 double paperWidth = pageSetup.getPaperWidth();
      Returns:
      基于当前页面方向的纸张宽度，以英寸为单位。

    • getPaperHeight

      double getPaperHeight()
      获取纸张高度（英寸），并考虑页面方向。

      如果通过 customPaperSize(double,double) 设置了自定义纸张大小，则此方法返回配置的纸张高度。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.customPaperSize(8.5, 13);
 double paperHeight = pageSetup.getPaperHeight();
      Returns:
      纸张高度，以英寸为单位，并考虑当前页面方向。

    • getPrintGridlines

      boolean getPrintGridlines()
      获取是否在页面上打印单元格网格线。仅适用于工作表。

      使用此方法可确定打印输出中是否包含工作表网格线。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintGridlines(true);
 boolean printGridlines = pageSetup.getPrintGridlines();
      Returns:
      如果在页面上打印单元格网格线，则为 true；否则为 false。

    • setPrintGridlines

      void setPrintGridlines(boolean value)
      设置是否在页面上打印单元格网格线。仅适用于工作表。

      使用此方法可设置打印输出中是否包含工作表网格线。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintGridlines(true);
      Parameters:
      value - 如果在页面上打印单元格网格线，则为 true；否则为 false。

    • getPrintHeadings

      boolean getPrintHeadings()
      获取是否随此页面一起打印行标题和列标题。

      仅适用于工作表。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintHeadings(true);
 boolean printHeadings = pageSetup.getPrintHeadings();
      Returns:
      如果随页面一起打印行标题和列标题，则为 true；否则为 false。

    • setPrintHeadings

      void setPrintHeadings(boolean value)
      设置是否随此页面打印行标题和列标题。

      仅适用于工作表。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintHeadings(true);
      Parameters:
      value - 如果随页面打印行标题和列标题，则为 true；否则为 false。

    • getPrintNotes

      boolean getPrintNotes()
      获取单元格注释是否随工作表一起作为尾注打印。仅适用于工作表。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintNotes(true);
 boolean printNotes = pageSetup.getPrintNotes();
      Returns:
      如果单元格注释随工作表一起作为尾注打印，则为 true；否则为 false。

    • setPrintNotes

      void setPrintNotes(boolean value)
      设置是否将单元格备注作为工作表的尾注打印。仅适用于工作表。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintNotes(true);
      Parameters:
      value - 如果单元格备注作为工作表的尾注打印，则为 true；否则为 false。

    • getPrintArea

      String getPrintArea()
      获取要打印的区域，以宏语言中的 A1 样式引用字符串表示。

      如果未指定打印区域，则默认打印工作表的已用区域。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintArea("$A$1:$C$10");
 String printArea = pageSetup.getPrintArea();
      Returns:
      打印区域，以宏语言中的 A1 样式引用字符串表示。

    • setPrintArea

      void setPrintArea(String value)
      设置要打印的区域，该区域以宏语言中的 A1 样式引用字符串表示。

      如果未指定打印区域，则默认打印工作表的已用区域。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintArea("$A$1:$C$10");
      Parameters:
      value - 打印区域，以宏语言中的 A1 样式引用字符串表示。

    • getPrintTitleColumns

      String getPrintTitleColumns()
      获取包含要在每页左侧重复的单元格的列，该设置以宏语言中的 A1 样式表示法字符串表示。

      使用 setPrintTitleColumns(String) 可以定义打印页面的重复列。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintTitleColumns("$A:$B");
 String printTitleColumns = pageSetup.getPrintTitleColumns();
      Returns:
      一个 A1 样式表示法字符串，用于指定打印标题列。

    • setPrintTitleColumns

      void setPrintTitleColumns(String value)
      设置包含要在每页左侧重复的单元格的列，以宏语言中的 A1 样式表示法字符串表示。 
      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintTitleColumns("$A:$B");
      Parameters:
      value - 一个 A1 样式表示法字符串，用于指定打印标题列。

    • getPrintTitleRows

      String getPrintTitleRows()
      获取包含要在每页顶部重复的单元格的行，以宏语言中的 A1 样式表示法字符串表示。

      使用此方法可获取工作表页面设置的当前重复行设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintTitleRows("$1:$2");
 String printTitleRows = pageSetup.getPrintTitleRows();
      Returns:
      要在每页顶部重复的行，以宏语言中的 A1 样式行引用字符串表示。

    • setPrintTitleRows

      void setPrintTitleRows(String value)
      设置包含要在每页顶部重复的单元格的行，该设置以宏语言中的 A1 样式表示法字符串表示。

      使用此方法可设置工作表页面设置的重复行设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintTitleRows("$1:$2");
      Parameters:
      value - 要在每页顶部重复的行，以宏语言中的 A1 样式行引用字符串表示。

    • getPrintTailColumns

      String getPrintTailColumns()
      获取包含要在每页右侧重复的单元格的列，以宏语言中的 A1 样式表示法字符串表示。

      使用此属性可读取工作表页面设置的当前右侧重复列设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintTailColumns("$I:$J");
 String printTailColumns = pageSetup.getPrintTailColumns();
      Returns:
      一个字符串，指定要在每页右侧重复的列，以 A1 样式表示法表示。

    • setPrintTailColumns

      void setPrintTailColumns(String value)
      设置包含要在每页右侧重复的单元格的列，该设置以宏语言中的 A1 样式表示法字符串表示。

      使用此属性可设置工作表页面设置的右侧重复列设置。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintTailColumns("$I:$J");
      Parameters:
      value - 一个字符串，用于以 A1 样式表示法指定要在每页右侧重复的列。

    • getPrintTailRows

      String getPrintTailRows()
      获取包含要在每页底部重复的单元格的行，以宏语言中的 A1 样式表示法字符串表示。

      使用此方法可获取为工作表页面设置配置的底部重复行。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintTailRows("$50:$50");
 String printTailRows = pageSetup.getPrintTailRows();
      Returns:
      一个字符串，指定底部重复行，以宏语言中的 A1 样式表示法表示。

    • setPrintTailRows

      void setPrintTailRows(String value)
      设置包含每页底部重复单元格的行，字符串采用宏语言中的 A1 样式表示法。

      使用此方法可设置为工作表页面设置配置的底部重复行。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintTailRows("$50:$50");
      Parameters:
      value - 指定底部重复行的字符串，采用宏语言中的 A1 样式表示法。

    • getPrintCopies

      int getPrintCopies()
      获取要打印的份数。

      返回工作表页面设置的打印份数设置。如果尚未创建页面设置，此方法返回 1。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintCopies(3);
 int printCopies = pageSetup.getPrintCopies();
      Returns:
      要打印的份数。如果尚未创建页面设置，则返回 1。

    • setPrintCopies

      void setPrintCopies(int value)
      设置要打印的份数。

      设置工作表页面设置的打印份数设置。如果尚未创建页面设置，此方法设置 1。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintCopies(3);
      Parameters:
      value - 要打印的份数。如果尚未创建页面设置，则设置 1。

    • getPrintPageRange

      String getPrintPageRange()
      获取要打印的页面范围，其中页码或页面范围用逗号分隔，并从文档开头开始计数。

      使用此属性可获取控制打印操作中包含哪些页面的页面范围字符串。例如，"1,3,5-12" 会打印第 1 页、第 3 页以及第 5 到 12 页。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintPageRange("1,3-5");
 String printPageRange = pageSetup.getPrintPageRange();
      Returns:
      打印页面范围字符串。

    • setPrintPageRange

      void setPrintPageRange(String value)
      设置要打印的页面范围，其中页码或页面范围用逗号分隔，并从文档开头开始计数。

      使用此属性可设置控制打印操作中包含哪些页面的页面范围字符串。例如，"1,3,5-12" 会打印第 1 页、第 3 页以及第 5 到 12 页。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintPageRange("1,3-5");
      Parameters:
      value - 打印页面范围字符串。

    • getZoom

      int getZoom()
      获取一个 Variant 值，表示 Document Solutions for Excel 打印工作表时所使用的缩放百分比（介于 10% 到 400% 之间）。

      当工作表按百分比缩放时使用此属性。如果 getIsPercentScale() 返回 false，则缩放改由 getFitToPagesWide() 和 getFitToPagesTall() 控制。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsPercentScale(true);
 pageSetup.setZoom(125);
 int zoom = pageSetup.getZoom();
      Returns:
      打印缩放百分比，范围为 10 到 400。

    • setZoom

      void setZoom(int value)
      设置一个 Variant 值，表示 Document Solutions for Excel 打印工作表时所使用的缩放百分比（介于 10% 到 400% 之间）。

      当工作表按百分比缩放时使用此属性。如果 getIsPercentScale() 设置为 false，则缩放改由 getFitToPagesWide() 和 getFitToPagesTall() 控制。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setIsPercentScale(true);
 pageSetup.setZoom(125);
      Parameters:
      value - 打印缩放百分比，范围为 10 到 400。

    • getPrintComments

      PrintLocation getPrintComments()
      获取注释随工作表一起打印的方式。

      使用此属性可确定注释是不打印、作为尾注打印，还是在工作表上的原位置打印。如果页面设置尚未初始化，此方法返回 PrintLocation.NoComments。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintComments(PrintLocation.SheetEnd);
 PrintLocation printComments = pageSetup.getPrintComments();
      Returns:
      一个 PrintLocation 值，指示注释如何随工作表一起打印。

    • setPrintComments

      void setPrintComments(PrintLocation value)
      设置随工作表一起打印注释的方式。

      使用此方法可以控制打印工作表时，是就地打印工作表注释、将其作为尾注打印，还是省略注释。

      
 IRange cell = worksheet.getRange("A1");
 cell.addComment("Check the total before printing.");
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintComments(PrintLocation.SheetEnd);
      Parameters:
      value - 打印时应用于工作表注释的打印位置。必须是有效的 PrintLocation 值；不支持 null。

    • getPrintErrors

      PrintErrors getPrintErrors()
      获取一个 PrintErrors 常量，指定打印工作表时单元格错误值的显示方式。

      此设置可用于在打印时抑制错误值的显示，例如显示空白、短横线或 #N/A 来代替原始错误值。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintErrors(PrintErrors.Dash);
 PrintErrors printErrors = pageSetup.getPrintErrors();
      Returns:
      指定打印错误显示方式的 PrintErrors 值。如果尚未创建显式页面设置，则返回 PrintErrors.Displayed。

    • setPrintErrors

      void setPrintErrors(PrintErrors value)
      设置一个 PrintErrors 常量，用于指定打印错误的显示方式。

      此功能允许用户在打印工作表时禁止显示错误值。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setPrintErrors(PrintErrors.Dash);
      Parameters:
      value - 打印错误显示模式。

    • getCenterHeaderPicture

      IGraphic getCenterHeaderPicture()
      获取表示页眉中间部分图片的 IGraphic 对象。用于设置图片的属性。

      使用返回的 IGraphic 对象可以设置图片属性，例如图像源或大小。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 IGraphic picture = pageSetup.getCenterHeaderPicture();
 picture.setFilename(java.nio.file.Paths.get("Users", "DefaultApps", "Documents", "logo.png").toString());
 picture.setWidth(36);
      Returns:
      表示页眉中间部分图片的 IGraphic 对象。

    • getCenterFooterPicture

      IGraphic getCenterFooterPicture()
      获取表示页脚中间部分图片的 IGraphic 对象。用于设置图片的属性。

      使用返回的 IGraphic 对象可以设置图片属性，例如图像源或大小。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 IGraphic picture = pageSetup.getCenterFooterPicture();
 picture.setFilename(java.nio.file.Paths.get("Users", "DefaultApps", "Documents", "logo.png").toString());
 picture.setWidth(36);
      Returns:
      表示页脚中间部分图片的 IGraphic 对象。

    • getLeftHeaderPicture

      IGraphic getLeftHeaderPicture()
      获取表示页眉左侧部分图片的 IGraphic 对象。用于设置图片的属性。

      使用返回的 IGraphic 对象可设置图片的属性，例如图像源或大小。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 IGraphic picture = pageSetup.getLeftHeaderPicture();
 picture.setFilename(java.nio.file.Paths.get("Users", "DefaultApps", "Documents", "logo.png").toString());
 picture.setWidth(36);
      Returns:
      表示页眉左侧部分图片的 IGraphic 对象。

    • getLeftFooterPicture

      IGraphic getLeftFooterPicture()
      获取表示页脚左侧部分图片的 IGraphic 对象。用于设置图片的属性。

      使用返回的 IGraphic 对象可设置图片的属性，例如图像源或大小。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 IGraphic picture = pageSetup.getLeftFooterPicture();
 picture.setFilename(java.nio.file.Paths.get("Users", "DefaultApps", "Documents", "logo.png").toString());
 picture.setWidth(36);
      Returns:
      表示页脚左侧部分图片的 IGraphic 对象。

    • getRightHeaderPicture

      IGraphic getRightHeaderPicture()
      获取表示页眉右侧部分图片的 IGraphic 对象。用于设置图片的属性。

      使用返回的 IGraphic 对象可设置图片的属性，例如图像源或大小。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 IGraphic picture = pageSetup.getRightHeaderPicture();
 picture.setFilename(java.nio.file.Paths.get("Users", "DefaultApps", "Documents", "logo.png").toString());
 picture.setWidth(36);
      Returns:
      表示页眉右侧部分图片的 IGraphic 对象。

    • getRightFooterPicture

      IGraphic getRightFooterPicture()
      获取表示页脚右侧部分图片的 IGraphic 对象。

      使用返回的 IGraphic 对象可设置图片的属性，例如图像源或大小。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 IGraphic picture = pageSetup.getRightFooterPicture();
 picture.setFilename(java.nio.file.Paths.get("Users", "DefaultApps", "Documents", "logo.png").toString());
 picture.setWidth(36);
      Returns:
      表示页脚右侧部分图片的 IGraphic 对象。

    • getEvenPage

      IPage getEvenPage()
      获取工作簿或节的偶数 IPage 上文本的对齐方式。

      当启用奇偶页页眉和页脚时，使用返回的 IPage 对象可配置偶数页的页眉和页脚。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setOddAndEvenPagesHeaderFooter(true);
 IPage evenPage = pageSetup.getEvenPage();
 evenPage.getCenterHeader().setText("Even Page");
      Returns:
      表示偶数页页眉和页脚设置的 IPage 对象。

    • getFirstPage

      IPage getFirstPage()
      获取工作簿或节中第一个 IPage 上文本的对齐方式。

      启用不同的首页页眉和页脚时，使用返回的 IPage 对象可以配置首页的页眉和页脚。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setDifferentFirstPageHeaderFooter(true);
 IPage firstPage = pageSetup.getFirstPage();
 firstPage.getCenterHeader().setText("Cover Page");
      Returns:
      表示首页页眉和页脚设置的 IPage 对象。

    • getBestFitColumns

      boolean getBestFitColumns()
      获取打印时是否调整列宽以适应最长文本宽度。

      当此属性为 true 时，工作表在打印时使用最佳适应的列宽。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBestFitColumns(true);
 boolean bestFitColumns = pageSetup.getBestFitColumns();
      Returns:
      如果打印时调整列宽以适应最长文本宽度，则为 true；否则为 false。

    • setBestFitColumns

      void setBestFitColumns(boolean value)
      设置打印时是否调整列宽以适应最长文本宽度。

      当此属性为 true 时，工作表在打印期间使用最适合的列宽。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBestFitColumns(true);
      Parameters:
      value - 如果调整列宽以适应打印时的最长文本宽度，则为 true；否则为 false。

    • getBestFitRows

      boolean getBestFitRows()
      获取打印时是否调整行高以适应最高的文本高度。

      当此属性为 true 时，打印工作表时页面设置会自动调整行高以容纳最高的文本。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBestFitRows(true);
 boolean bestFitRows = pageSetup.getBestFitRows();
      Returns:
      如果打印时调整行高以适应最高的文本高度，则为 true；否则为 false。

    • setBestFitRows

      void setBestFitRows(boolean value)
      设置打印时是否调整行高以适应最高的文本高度。

      当此属性为 true 时，页面设置会在打印工作表时自动调整行高，以容纳最高的文本。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBestFitRows(true);
      Parameters:
      value - 如果打印时调整行高以适应最高的文本高度，则为 true；否则为 false。

    • fromJson

      void fromJson(String json)
      从指定的 JSON 字符串生成页面设置。

      使用此方法可从序列化的 JSON 数据应用页面设置，例如由 toJson() 生成的 JSON。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 String json = "{\"bestFitRows\":true,\"bestFitColumns\":true,"
     + "\"margin\":{\"top\":36,\"bottom\":36,\"left\":30,\"right\":30}}";
 pageSetup.fromJson(json);
      Parameters:
      json - 表示页面设置的 JSON 字符串。

    • toJson

      String toJson()
      从页面设置生成 JSON 字符串。

      使用此方法可将当前页面设置序列化为 JSON，以便存储，或稍后使用 fromJson(String) 应用。

      
 IPageSetup pageSetup = worksheet.getPageSetup();
 pageSetup.setBlackAndWhite(true);
 pageSetup.setLeftHeader("Quarterly Report");
 String json = pageSetup.toJson();
      Returns:
      表示页面设置的 JSON 字符串。