Package com.grapecity.documents.excel
Interface IPageSetup
public interface IPageSetup
代表页面设置描述。
-
Method Summary
Modifier and TypeMethodDescriptionvoidcustomPaperSize(double width, double height) 设置自定义纸张大小,单位为英寸。void生成来自json的页面设置。boolean获取页眉和页脚是否与页面设置选项中设置的边距对齐。boolean获取是否在打印时调整列宽以适应最长文本宽度的设置。boolean获取是否将行高调整为以适应打印中最高文本高度的设置。boolean获取文档元素在打印时是否以黑白方式打印。double获取底边距的大小,以点为单位。获取是否将页脚信息居中对齐。获取一个代表页脚中心区域的IGraphic对象。用于设置图片的属性。获取页面设置对象中页眉信息是否居中对齐。获取一个代表页眉中心部分图片的IGraphic对象。用于设置图片的属性。boolean获取工作表在打印时是否水平居中于页面。boolean获取工作表在打印时是否垂直居中于页面。boolean获取是否在第一页使用不同的页眉或页脚。booleangetDraft()获取工作表是否在打印时不包含图形。获取工作簿或章节偶数IPage上文本的对齐方式。获取工作簿或章节中第一个IPage上文本的对齐方式。int获取当此表单打印时将使用的第一个页码。如果是自动的,Excel的文档解决方案将选择第一个页码。默认为自动。int获取工作表在打印时将被缩放到的页高。仅适用于工作表。int获取工作表打印时将被缩放到的页宽数量。仅适用于工作表。double获取页脚边距的大小,以点为单位。double获取页眉边距的大小,以点为单位。boolean获取是否自动分配第一页码。默认为true。当指定第一页码时,它返回false。boolean获取工作表是否按百分比进行缩放。获取工作簿或章节左页脚文本的对齐方式。获取一个代表页脚左侧部分图片的IGraphic对象。用于设置图片的属性。获取工作簿或章节左侧页眉中文本的对齐方式。获取一个代表页眉左侧部分图片的IGraphic对象。用于设置图片的属性。double获取左侧边距的大小,以点为单位。boolean获取是否在奇数页和偶数页上具有不同的页眉和页脚。getOrder()获取一个Order值,该值表示在打印大型工作表时用于对页面进行编号的顺序。获取一个代表纵向或横向打印模式的PageOrientation值。double表示纸张的高度(英寸),考虑到页面方向。获取纸张的大小。double表示纸张的宽度(英寸),考虑到页面方向。获取要打印的范围,使用宏语言的A1样式引用作为字符串。获取工作表中注释的打印方式。int获取打印的副本数量。获取一个PrintErrors常量,指定显示的打印错误类型。此功能允许用户在打印工作表时抑制错误值的显示。boolean获取在页面上是否打印单元格网格线的设置。仅适用于工作表。boolean获取是否打印行和列标题在此页面上。仅适用于工作表。boolean获取单元格注释是否作为工作表的尾注打印。仅适用于工作表。获取要打印的页面范围,数字或页面范围从文档开始处以逗号分隔。例如,输入"1,3,5-12"。获取一个PrintQuality值,该值表示此页面的打印质量。默认为600 dpi。获取包含每个页面右侧要重复的单元格的列,以宏语言中的A1样式表示法作为字符串。获取包含要在每页底部重复的单元格的行,以宏语言中的A1样式表示法作为字符串。获取每页左侧要重复的单元格所在的列,以宏语言中的A1样式表示法作为字符串。获取包含要在每页顶部重复的单元格的行,以宏语言中的A1样式表示法作为字符串。获取页面右侧边缘与页脚右侧边界之间的距离(以点为单位)。获取一个代表页脚右侧部分的图片的IGraphic对象。用于设置图片的属性。获取头部右侧部分。获取一个代表页眉右侧部分图片的IGraphic对象。用于设置图片的属性。double获取右侧边距的大小,以点为单位。boolean获取当文档大小发生变化时,页眉和页脚是否应与文档一同缩放的设置。double获取顶部边距的大小,以点为单位。intgetZoom()获取一个Variant值,该值表示Document Solutions for Excel打印工作表时缩放的百分比(介于10%到400%之间)。voidsetAlignMarginsHeaderFooter(boolean value) 设置页眉和页脚是否与页面设置选项中设置的边距对齐。voidsetBestFitColumns(boolean value) 设置是否调整列宽以适应打印时的最长文本宽度。如果文件包含大量数据,可能会导致一些效率问题。voidsetBestFitRows(boolean value) 设置是否调整行高以适应打印时的最大文本高度。如果文件包含大量数据,可能会导致一些效率问题。voidsetBlackAndWhite(boolean value) 设置文档元素在打印时是否以黑白方式打印。voidsetBottomMargin(double value) 设置底部边距的大小,以点为单位。voidsetCenterFooter(String value) 设置是否将页脚信息居中对齐。voidsetCenterHeader(String value) 设置页面设置对象中页眉信息是否居中对齐。voidsetCenterHorizontally(boolean value) 设置工作表在打印时是否水平居中于页面。voidsetCenterVertically(boolean value) 设置工作表在打印时是否垂直居中于页面。voidsetDifferentFirstPageHeaderFooter(boolean value) 设置是否在第一页使用不同的页眉或页脚。voidsetDraft(boolean value) 设置工作表是否在打印时不包含图形。voidsetFirstPageNumber(int value) 设置打印此表时将使用的第一页码。如果选择“自动”,Excel文档解决方案将选择第一页码。默认为“自动”。voidsetFitToPagesTall(int value) 设置工作表在打印时将被缩放到的高度页数。仅适用于工作表。voidsetFitToPagesWide(int value) 设置工作表在打印时将被缩放到多少页宽。仅适用于工作表。voidsetFooterMargin(double value) 设置页脚边距的大小,以点为单位。voidsetHeaderMargin(double value) 设置页眉边距的大小,以点为单位。voidsetIsAutoFirstPageNumber(boolean value) 设置是否自动分配第一页码。默认值为true。voidsetIsPercentScale(boolean value) 设置工作表是否按百分比进行缩放。voidsetLeftFooter(String value) 设置工作簿或章节左页脚中文本的对齐方式。voidsetLeftHeader(String value) 设置工作簿或章节左侧标题的文本对齐方式。voidsetLeftMargin(double value) 设置左侧边距的大小,以点为单位。voidsetOddAndEvenPagesHeaderFooter(boolean value) 设置是否在奇数页和偶数页上具有不同的页眉和页脚。void设置一个Order值,该值表示在打印大型工作表时用于编号页面的顺序。voidsetOrientation(PageOrientation value) 设置一个代表纵向或横向打印模式的PageOrientation值。voidsetPaperSize(PaperSize value) 设置纸张的大小。voidsetPrintArea(String value) 设置要打印的范围,使用宏语言中的A1样式引用作为字符串。voidsetPrintComments(PrintLocation value) 设置打印工作表时注释的方式。voidsetPrintCopies(int value) 设置打印的副本数量。voidsetPrintErrors(PrintErrors value) 设置一个PrintErrors常量,指定显示的打印错误类型。此功能允许用户在打印工作表时抑制错误值的显示。voidsetPrintGridlines(boolean value) 设置在页面上是否打印单元格网格线的设置。仅适用于工作表。voidsetPrintHeadings(boolean value) 设置是否打印行和列标题在此页面上。仅适用于工作表。voidsetPrintNotes(boolean value) 设置单元格注释是否作为工作表的尾注打印。仅适用于工作表。voidsetPrintPageRange(String value) 设置要打印的页面范围,数字或页码范围从文档开头开始计数,并用逗号分隔。例如,输入"1,3,5-12"。voidsetPrintQuality(PrintQuality value) 设置一个代表此页面打印质量的PrintQuality值。默认为600 dpi。voidsetPrintTailColumns(String value) 设置要在每页右侧重复的单元格所在的列,以宏语言中的A1样式表示法的字符串形式。voidsetPrintTailRows(String value) 设置包含要在每页底部重复的单元格的行,以宏语言中的A1样式表示法作为字符串。voidsetPrintTitleColumns(String value) 设置每页左侧要重复的单元格所在的列,以宏语言中的A1样式表示法作为字符串。voidsetPrintTitleRows(String value) 设置包含要在每页顶部重复的单元格的行,以宏语言中的A1样式表示法作为字符串。voidsetRightFooter(String value) 设置页面右边缘与页脚右边界之间的距离(以点为单位)。voidsetRightHeader(String value) 设置头的右侧部分。voidsetRightMargin(double value) 设置右侧边距的大小,以点为单位。voidsetScaleWithDocHeaderFooter(boolean value) 设置当文档大小发生变化时,是否应与文档一同缩放页眉和页脚。voidsetTopMargin(double value) 设置顶部边距的大小,以点为单位。voidsetZoom(int value) 设置一个表示Document Solutions for Excel打印时将工作表缩放的比例(介于10%到400%之间的百分比)的Variant值。toJson()生成页设置中的JSON。
-
Method Details
-
getPrintQuality
PrintQuality getPrintQuality()获取一个PrintQuality值,该值表示此页面的打印质量。默认为600 dpi。 -
setPrintQuality
设置一个代表此页面打印质量的PrintQuality值。默认为600 dpi。 -
getBlackAndWhite
boolean getBlackAndWhite()获取文档元素在打印时是否以黑白方式打印。 -
setBlackAndWhite
void setBlackAndWhite(boolean value) 设置文档元素在打印时是否以黑白方式打印。 -
getLeftMargin
double getLeftMargin()获取左侧边距的大小,以点为单位。 -
setLeftMargin
void setLeftMargin(double value) 设置左侧边距的大小,以点为单位。 -
getRightMargin
double getRightMargin()获取右侧边距的大小,以点为单位。 -
setRightMargin
void setRightMargin(double value) 设置右侧边距的大小,以点为单位。 -
getTopMargin
double getTopMargin()获取顶部边距的大小,以点为单位。 -
setTopMargin
void setTopMargin(double value) 设置顶部边距的大小,以点为单位。 -
getBottomMargin
double getBottomMargin()获取底边距的大小,以点为单位。 -
setBottomMargin
void setBottomMargin(double value) 设置底部边距的大小,以点为单位。 -
getHeaderMargin
double getHeaderMargin()获取页眉边距的大小,以点为单位。 -
setHeaderMargin
void setHeaderMargin(double value) 设置页眉边距的大小,以点为单位。 -
getCenterHeader
String getCenterHeader()获取页面设置对象中页眉信息是否居中对齐。 -
setCenterHeader
设置页面设置对象中页眉信息是否居中对齐。 -
getLeftHeader
String getLeftHeader()获取工作簿或章节左侧页眉中文本的对齐方式。 -
setLeftHeader
设置工作簿或章节左侧标题的文本对齐方式。 -
getRightHeader
String getRightHeader()获取头部右侧部分。 -
setRightHeader
设置头的右侧部分。 -
getCenterHorizontally
boolean getCenterHorizontally()获取工作表在打印时是否水平居中于页面。 -
setCenterHorizontally
void setCenterHorizontally(boolean value) 设置工作表在打印时是否水平居中于页面。 -
getCenterVertically
boolean getCenterVertically()获取工作表在打印时是否垂直居中于页面。 -
setCenterVertically
void setCenterVertically(boolean value) 设置工作表在打印时是否垂直居中于页面。 -
getDraft
boolean getDraft()获取工作表是否在打印时不包含图形。 -
setDraft
void setDraft(boolean value) 设置工作表是否在打印时不包含图形。 -
getFirstPageNumber
int getFirstPageNumber()获取当此表单打印时将使用的第一个页码。如果是自动的,Excel的文档解决方案将选择第一个页码。默认为自动。 -
setFirstPageNumber
void setFirstPageNumber(int value) 设置打印此表时将使用的第一页码。如果选择“自动”,Excel文档解决方案将选择第一页码。默认为“自动”。 -
getIsAutoFirstPageNumber
boolean getIsAutoFirstPageNumber()获取是否自动分配第一页码。默认为true。当指定第一页码时,它返回false。 -
setIsAutoFirstPageNumber
void setIsAutoFirstPageNumber(boolean value) 设置是否自动分配第一页码。默认值为true。 -
getFitToPagesTall
int getFitToPagesTall()获取工作表在打印时将被缩放到的页高。仅适用于工作表。 -
setFitToPagesTall
void setFitToPagesTall(int value) 设置工作表在打印时将被缩放到的高度页数。仅适用于工作表。 -
getFitToPagesWide
int getFitToPagesWide()获取工作表打印时将被缩放到的页宽数量。仅适用于工作表。 -
setFitToPagesWide
void setFitToPagesWide(int value) 设置工作表在打印时将被缩放到多少页宽。仅适用于工作表。 -
getIsPercentScale
boolean getIsPercentScale()获取工作表是否按百分比进行缩放。- Returns:
- 如果工作表按百分比进行缩放,则为true;如果FitToPagesWide和FitToPagesTall属性控制工作表的缩放方式,则为false。
-
setIsPercentScale
void setIsPercentScale(boolean value) 设置工作表是否按百分比进行缩放。- Parameters:
value- 如果此属性为true,则工作表按百分比进行缩放; 如果此属性为False,FitToPagesWide和FitToPagesTall属性将控制工作表的缩放方式。
-
getOrder
Order getOrder()获取一个Order值,该值表示在打印大型工作表时用于对页面进行编号的顺序。 -
setOrder
设置一个Order值,该值表示在打印大型工作表时用于编号页面的顺序。 -
getOrientation
PageOrientation getOrientation()获取一个代表纵向或横向打印模式的PageOrientation值。 -
setOrientation
设置一个代表纵向或横向打印模式的PageOrientation值。 -
getPaperSize
PaperSize getPaperSize()获取纸张的大小。 -
setPaperSize
设置纸张的大小。 -
customPaperSize
void customPaperSize(double width, double height) 设置自定义纸张大小,单位为英寸。 -
getPaperWidth
double getPaperWidth()表示纸张的宽度(英寸),考虑到页面方向。 -
getPaperHeight
double getPaperHeight()表示纸张的高度(英寸),考虑到页面方向。 -
getPrintGridlines
boolean getPrintGridlines()获取在页面上是否打印单元格网格线的设置。仅适用于工作表。 -
setPrintGridlines
void setPrintGridlines(boolean value) 设置在页面上是否打印单元格网格线的设置。仅适用于工作表。 -
getPrintHeadings
boolean getPrintHeadings()获取是否打印行和列标题在此页面上。仅适用于工作表。 -
setPrintHeadings
void setPrintHeadings(boolean value) 设置是否打印行和列标题在此页面上。仅适用于工作表。 -
getPrintNotes
boolean getPrintNotes()获取单元格注释是否作为工作表的尾注打印。仅适用于工作表。 -
setPrintNotes
void setPrintNotes(boolean value) 设置单元格注释是否作为工作表的尾注打印。仅适用于工作表。 -
getPrintArea
String getPrintArea()获取要打印的范围,使用宏语言的A1样式引用作为字符串。 -
setPrintArea
设置要打印的范围,使用宏语言中的A1样式引用作为字符串。 -
getPrintTitleColumns
String getPrintTitleColumns()获取每页左侧要重复的单元格所在的列,以宏语言中的A1样式表示法作为字符串。 -
setPrintTitleColumns
设置每页左侧要重复的单元格所在的列,以宏语言中的A1样式表示法作为字符串。 -
getPrintTitleRows
String getPrintTitleRows()获取包含要在每页顶部重复的单元格的行,以宏语言中的A1样式表示法作为字符串。 -
setPrintTitleRows
设置包含要在每页顶部重复的单元格的行,以宏语言中的A1样式表示法作为字符串。 -
getPrintTailColumns
String getPrintTailColumns()获取包含每个页面右侧要重复的单元格的列,以宏语言中的A1样式表示法作为字符串。 -
setPrintTailColumns
设置要在每页右侧重复的单元格所在的列,以宏语言中的A1样式表示法的字符串形式。 -
getPrintTailRows
String getPrintTailRows()获取包含要在每页底部重复的单元格的行,以宏语言中的A1样式表示法作为字符串。 -
setPrintTailRows
设置包含要在每页底部重复的单元格的行,以宏语言中的A1样式表示法作为字符串。 -
getPrintCopies
int getPrintCopies()获取打印的副本数量。 -
setPrintCopies
void setPrintCopies(int value) 设置打印的副本数量。 -
getPrintPageRange
String getPrintPageRange()获取要打印的页面范围,数字或页面范围从文档开始处以逗号分隔。例如,输入"1,3,5-12"。 -
setPrintPageRange
设置要打印的页面范围,数字或页码范围从文档开头开始计数,并用逗号分隔。例如,输入"1,3,5-12"。 -
getZoom
int getZoom()获取一个Variant值,该值表示Document Solutions for Excel打印工作表时缩放的百分比(介于10%到400%之间)。 -
setZoom
void setZoom(int value) 设置一个表示Document Solutions for Excel打印时将工作表缩放的比例(介于10%到400%之间的百分比)的Variant值。 -
getPrintComments
PrintLocation getPrintComments()获取工作表中注释的打印方式。 -
setPrintComments
设置打印工作表时注释的方式。 -
getPrintErrors
PrintErrors getPrintErrors()获取一个PrintErrors常量,指定显示的打印错误类型。此功能允许用户在打印工作表时抑制错误值的显示。 -
setPrintErrors
设置一个PrintErrors常量,指定显示的打印错误类型。此功能允许用户在打印工作表时抑制错误值的显示。 -
getCenterHeaderPicture
IGraphic getCenterHeaderPicture()获取一个代表页眉中心部分图片的IGraphic对象。用于设置图片的属性。 -
getLeftHeaderPicture
IGraphic getLeftHeaderPicture()获取一个代表页眉左侧部分图片的IGraphic对象。用于设置图片的属性。 -
getRightHeaderPicture
IGraphic getRightHeaderPicture()获取一个代表页眉右侧部分图片的IGraphic对象。用于设置图片的属性。 -
getEvenPage
IPage getEvenPage()获取工作簿或章节偶数IPage上文本的对齐方式。 -
getFirstPage
IPage getFirstPage()获取工作簿或章节中第一个IPage上文本的对齐方式。 -
getBestFitColumns
boolean getBestFitColumns()获取是否在打印时调整列宽以适应最长文本宽度的设置。 -
setBestFitColumns
void setBestFitColumns(boolean value) 设置是否调整列宽以适应打印时的最长文本宽度。如果文件包含大量数据,可能会导致一些效率问题。 -
getBestFitRows
boolean getBestFitRows()获取是否将行高调整为以适应打印中最高文本高度的设置。 -
setBestFitRows
void setBestFitRows(boolean value) 设置是否调整行高以适应打印时的最大文本高度。如果文件包含大量数据,可能会导致一些效率问题。 -
fromJson
生成来自json的页面设置。- Parameters:
json- 表示页面设置的JSON字符串。
-
toJson
String toJson()生成页设置中的JSON。- Returns:
- 表示页面设置的JSON字符串。
-