PageSetup
遗产: java.lang.Object
public class PageSetup
表示部分的页面设置属性。
要了解更多信息,请访问Working with Sections文档文章。
PageSetup对象包含一个部分的所有页面设置属性(左边距、底部边距、纸张大小等)作为属性。
方法
clearFormatting()
public void clearFormatting()
将页面设置重置为默认纸张大小、边距和方向。
equals(Object arg0)
public boolean equals(Object arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | java.lang.Object |
退货: 布尔值
fetchInheritedBorderAttr(int key)
public Object fetchInheritedBorderAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
退货: java.lang.Object
getBidi()
public boolean getBidi()
指定此部分包含双向(复杂脚本)文本。
如果为 true,则此部分中的列从右到左排列。
退货: boolean - 相应的布尔值。
getBorderAlwaysInFront()
public boolean getBorderAlwaysInFront()
指定页面边框相对于相交文本和对象的位置。
退货: boolean - 相应的布尔值。
getBorderAppliesTo()
public int getBorderAppliesTo()
指定在哪些页面上打印页面边框。
退货: int - 相应的 int 值。返回值是其中之一PageBorderAppliesTo常数。
getBorderDistanceFrom()
public int getBorderDistanceFrom()
获取一个值,该值指示指定的页面边框是从页面边缘还是从其周围的文本测量的。
退货: int - 一个值,指示指定的页面边框是从页面边缘还是从它周围的文本开始测量的。返回值是其中之一PageBorderDistanceFrom常数。
getBorderSurroundsFooter()
public boolean getBorderSurroundsFooter()
指定页面边框是包含还是不包含页脚。请注意,更改此属性会影响文档中的所有部分。
退货: boolean - 相应的布尔值。
getBorderSurroundsHeader()
public boolean getBorderSurroundsHeader()
指定页面边框是包含还是不包含页眉。请注意,更改此属性会影响文档中的所有部分。
退货: boolean - 相应的布尔值。
getBorders()
public BorderCollection getBorders()
获取页面边框的集合。
退货: BorderCollection - 页面边框的集合。
getBottomMargin()
public double getBottomMargin()
获取页面底部边缘和正文底部边界之间的距离(以磅为单位)。
退货: double - 页面底部边缘与正文底部边界之间的距离(以磅为单位)。
getChapterPageSeparator()
public int getChapterPageSeparator()
获取出现在章节号和页码之间的分隔符。
在您可以创建包含章节编号的页码之前,文档标题必须应用编号大纲格式。
退货: int - 出现在章节号和页码之间的分隔符。返回值是其中之一ChapterPageSeparator常数。
getCharactersPerLine()
public int getCharactersPerLine()
获取文档网格中每行的字符数。
该属性的最小值为 1。最大值取决于 Normal 样式的页面宽度和字体大小。最小字符间距为字体大小的 90%。例如,页边距为 1 英寸的 Letter 页面每行最大字符数为 43。
默认情况下,该属性有一个值,其字符间距等于 Normal 样式的字体大小。
退货: int - 文档网格中每行的字符数。
getClass()
public final native Class<?> getClass()
退货: java.lang.Class
getDifferentFirstPageHeaderFooter()
public boolean getDifferentFirstPageHeaderFooter()
True如果在第一页上使用了不同的页眉或页脚。
退货: boolean - 相应的布尔值。
getDirectBorderAttr(int key)
public Object getDirectBorderAttr(int key)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int |
退货: java.lang.Object
getEndnoteOptions()
public EndnoteOptions getEndnoteOptions()
提供控制本节中尾注编号和定位的选项。
退货: EndnoteOptions - 相应的EndnoteOptions价值。
getFirstPageTray()
public int getFirstPageTray()
获取用于节的第一页的纸盘(bin)。该值是特定于实现(打印机)的。
退货: int - 用于节的第一页的纸盘(bin)。
getFooterDistance()
public double getFooterDistance()
获取页脚和页面底部之间的距离(以磅为单位)。
退货: double - 页脚和页面底部之间的距离(以磅为单位)。
getFootnoteOptions()
public FootnoteOptions getFootnoteOptions()
提供控制本节中脚注编号和位置的选项。
退货: FootnoteOptions - 相应的FootnoteOptions价值。
getGutter()
public double getGutter()
获取添加到文档装订边距的额外空间量。
退货: double - 添加到文档装订边距的额外空间量。
getHeaderDistance()
public double getHeaderDistance()
获取页眉和页面顶部之间的距离(以磅为单位)。
退货: double - 页眉和页面顶部之间的距离(以磅为单位)。
getHeadingLevelForChapter()
public int getHeadingLevelForChapter()
获取应用于文档中章节标题的标题级别样式。
可以是从 0 到 9 的数字。如果应用于页码,则 0 表示没有章节编号。
在您可以创建包含章节编号的页码之前,文档标题必须应用编号大纲格式。
退货: int - 应用于文档中章节标题的标题级别样式。
getLayoutMode()
public int getLayoutMode()
获取本节的布局方式。
退货: int - 此部分的布局模式。返回值是其中之一SectionLayoutMode常数。
getLeftMargin()
public double getLeftMargin()
获取页面左边缘与正文左边界之间的距离(以磅为单位)。
退货: double - 页面左边缘与正文左边界之间的距离(以磅为单位)。
getLineNumberCountBy()
public int getLineNumberCountBy()
获取行号的数字增量。
退货: int - 行号的数字增量。
getLineNumberDistanceFromText()
public double getLineNumberDistanceFromText()
获取行号右边缘与文档左边缘之间的距离。将此属性设置为零以自动在文档的行号和文本之间保持距离。
退货: double - 行号右边缘与文档左边缘之间的距离。
getLineNumberRestartMode()
public int getLineNumberRestartMode()
获取行号运行的方式,即它是在新页面或部分的开头重新开始还是连续运行。
退货: int - 行号的运行方式,即它是在新页面或部分的开头重新开始还是连续运行。返回值是其中之一LineNumberRestartMode常数。
getLineStartingNumber()
public int getLineStartingNumber()
获取起始行号。
退货: int - 起始行号。
getLinesPerPage()
public int getLinesPerPage()
获取文档网格中每页的行数。
该属性的最小值为 1。最大值取决于 Normal 样式的页面高度和字体大小。最小行距是字体大小的 136%。例如,每页边距为 1 英寸的 Letter 页面的最大行数为 39。
默认情况下,该属性有一个值,在该值上,行距是 Normal 样式字体大小的 1.5 倍。
退货: int - 文档网格中每页的行数。
getMultiplePages()
public int getMultiplePages()
对于多页文档,获取或设置文档的打印或呈现方式,以便将其装订成小册子。
退货: int - 相应的 int 值。返回值是其中之一MultiplePagesType常数。
getOddAndEvenPagesHeaderFooter()
public boolean getOddAndEvenPagesHeaderFooter()
True如果文档的奇数页和偶数页有不同的页眉和页脚。请注意,更改此属性会影响文档中的所有部分。
退货: boolean - 相应的布尔值。
getOrientation()
public int getOrientation()
获取页面的方向。
改变Orientation掉期getPageWidth() / setPageWidth(double)和getPageHeight() / setPageHeight(double).
退货: int - 页面的方向。返回值是其中之一Orientation常数。
getOtherPagesTray()
public int getOtherPagesTray()
获取除第一页以外的所有页面使用的纸盘(bin)。该值是特定于实现(打印机)的。
退货: int - 用于除第一页以外的所有部分的纸盒(纸盒)。
getPageHeight()
public double getPageHeight()
获取页面的高度(以磅为单位)。
退货: double - 以磅为单位的页面高度。
getPageNumberStyle()
public int getPageNumberStyle()
获取页码格式。
退货: int - 页码格式。返回值是其中之一NumberStyle常数。
getPageStartingNumber()
public int getPageStartingNumber()
获取节的起始页码。这getRestartPageNumbering() / setRestartPageNumbering(boolean)属性,如果设置为false 将覆盖PageStartingNumber属性,以便页码可以从上一节继续。
退货: int - 节的起始页码。
getPageWidth()
public double getPageWidth()
获取页面的宽度(以磅为单位)。
退货: double - 以磅为单位的页面宽度。
getPaperSize()
public int getPaperSize()
获取纸张大小。
设置此属性更新getPageWidth() / setPageWidth(double)和getPageHeight() / setPageHeight(double)价值观。将此值设置为PaperSize.CUSTOM不会更改现有值。
退货: int - 纸张大小。返回值是其中之一PaperSize常数。
getRestartPageNumbering()
public boolean getRestartPageNumbering()
True如果页码在该部分的开头重新开始。如果设置为false, 这RestartPageNumbering属性将覆盖getPageStartingNumber() / setPageStartingNumber(int)属性,以便页码可以从上一节继续。
退货: boolean - 相应的布尔值。
getRightMargin()
public double getRightMargin()
获取页面右边缘与正文右边界之间的距离(以磅为单位)。
退货: double - 页面右边缘与正文右边界之间的距离(以磅为单位)。
getRtlGutter()
public boolean getRtlGutter()
获取 Microsoft Word 是根据从右到左的语言还是从左到右的语言为节使用装订线。
退货: boolean - Microsoft Word 是否基于从右到左的语言或从左到右的语言为部分使用装订线。
getSectionStart()
public int getSectionStart()
获取指定对象的分节符类型。
退货: int - 指定对象的分节符类型。返回值是其中之一SectionStart常数。
getSheetsPerBooklet()
public int getSheetsPerBooklet()
获取每本小册子中要包含的页数。
退货: int - 每本小册子要包含的页数。
getSuppressEndnotes()
public boolean getSuppressEndnotes()
True如果在不抑制尾注的下一节末尾打印尾注。隐藏的尾注打印在该部分的尾注之前。
退货: boolean - 相应的布尔值。
getTextColumns()
public TextColumnCollection getTextColumns()
返回表示文本列集的集合。
退货: TextColumnCollection - 表示一组文本列的集合。
getTextOrientation()
public int getTextOrientation()
允许指定getTextOrientation() / setTextOrientation(int)对于整个页面。默认值为TextOrientation.HORIZONTAL此属性仅支持 MS Word 本机格式 DOCX、WML、RTF 和 DOC。
退货: int - 相应的 int 值。返回值是其中之一TextOrientation常数。
getTopMargin()
public double getTopMargin()
获取页面上边缘与正文上边界之间的距离(以磅为单位)。
退货: double - 页面上边缘与正文上边界之间的距离(以磅为单位)。
getVerticalAlignment()
public int getVerticalAlignment()
获取文档或节中每一页上文本的垂直对齐方式。
退货: int - 文档或章节中每一页文本的垂直对齐方式。返回值是其中之一PageVerticalAlignment常数。
hashCode()
public native int hashCode()
退货: 整数
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setBidi(boolean value)
public void setBidi(boolean value)
指定此部分包含双向(复杂脚本)文本。
如果为 true,则此部分中的列从右到左排列。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setBorderAlwaysInFront(boolean value)
public void setBorderAlwaysInFront(boolean value)
指定页面边框相对于相交文本和对象的位置。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setBorderAppliesTo(int value)
public void setBorderAppliesTo(int value)
指定在哪些页面上打印页面边框。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。该值必须是其中之一PageBorderAppliesTo常数。 |
setBorderAttr(int key, Object value)
public void setBorderAttr(int key, Object value)
参数:
范围 | 类型 | 描述 |
---|---|---|
key | int | |
value | java.lang.Object |
setBorderDistanceFrom(int value)
public void setBorderDistanceFrom(int value)
设置一个值,该值指示指定的页面边框是从页面边缘还是从它周围的文本开始测量的。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 一个值,指示指定的页面边框是从页面边缘还是从它周围的文本开始测量的。该值必须是其中之一PageBorderDistanceFrom常数。 |
setBorderSurroundsFooter(boolean value)
public void setBorderSurroundsFooter(boolean value)
指定页面边框是包含还是不包含页脚。请注意,更改此属性会影响文档中的所有部分。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setBorderSurroundsHeader(boolean value)
public void setBorderSurroundsHeader(boolean value)
指定页面边框是包含还是不包含页眉。请注意,更改此属性会影响文档中的所有部分。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setBottomMargin(double value)
public void setBottomMargin(double value)
设置页面底部边缘与正文底部边界之间的距离(以磅为单位)。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 页面底部边缘与正文底部边界之间的距离(以磅为单位)。 |
setChapterPageSeparator(int value)
public void setChapterPageSeparator(int value)
设置出现在章节号和页码之间的分隔符。
在您可以创建包含章节编号的页码之前,文档标题必须应用编号大纲格式。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 出现在章节号和页码之间的分隔符。该值必须是其中之一ChapterPageSeparator常数。 |
setCharactersPerLine(int value)
public void setCharactersPerLine(int value)
设置文档网格中每行的字符数。
该属性的最小值为 1。最大值取决于 Normal 样式的页面宽度和字体大小。最小字符间距为字体大小的 90%。例如,页边距为 1 英寸的 Letter 页面每行最大字符数为 43。
默认情况下,该属性有一个值,其字符间距等于 Normal 样式的字体大小。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 文档网格中每行的字符数。 |
setDifferentFirstPageHeaderFooter(boolean value)
public void setDifferentFirstPageHeaderFooter(boolean value)
True如果在第一页上使用了不同的页眉或页脚。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setFirstPageTray(int value)
public void setFirstPageTray(int value)
设置纸盒(纸盒)以用于某个部分的第一页。该值是特定于实现(打印机)的。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 用于章节第一页的纸盘(纸槽)。 |
setFooterDistance(double value)
public void setFooterDistance(double value)
设置页脚和页面底部之间的距离(以磅为单位)。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 页脚和页面底部之间的距离(以磅为单位)。 |
setGutter(double value)
public void setGutter(double value)
设置添加到文档装订边距的额外空间量。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 添加到文档装订边距的额外空间量。 |
setHeaderDistance(double value)
public void setHeaderDistance(double value)
设置页眉和页面顶部之间的距离(以磅为单位)。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 页眉和页面顶部之间的距离(以磅为单位)。 |
setHeadingLevelForChapter(int value)
public void setHeadingLevelForChapter(int value)
设置应用于文档中章节标题的标题级别样式。
可以是从 0 到 9 的数字。如果应用于页码,则 0 表示没有章节编号。
在您可以创建包含章节编号的页码之前,文档标题必须应用编号大纲格式。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 应用于文档中章节标题的标题级别样式。 |
setLayoutMode(int value)
public void setLayoutMode(int value)
设置此部分的布局模式。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 本节的布局方式。该值必须是其中之一SectionLayoutMode常数。 |
setLeftMargin(double value)
public void setLeftMargin(double value)
设置页面左边缘和正文左边界之间的距离(以磅为单位)。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 页面左边缘与正文左边界之间的距离(以磅为单位)。 |
setLineNumberCountBy(int value)
public void setLineNumberCountBy(int value)
设置行号的数字增量。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 行号的数字增量。 |
setLineNumberDistanceFromText(double value)
public void setLineNumberDistanceFromText(double value)
设置行号右边缘与文档左边缘之间的距离。将此属性设置为零以自动在文档的行号和文本之间保持距离。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 行号右边缘与文档左边缘之间的距离。 |
setLineNumberRestartMode(int value)
public void setLineNumberRestartMode(int value)
设置行编号的运行方式,即是在新页面或部分的开头重新开始还是连续运行。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 行编号的运行方式是,它是从新页面或新节的开头重新开始,还是连续运行。该值必须是其中之一LineNumberRestartMode常数。 |
setLineStartingNumber(int value)
public void setLineStartingNumber(int value)
设置起始行号。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 起始行号。 |
setLinesPerPage(int value)
public void setLinesPerPage(int value)
设置文档网格中每页的行数。
该属性的最小值为 1。最大值取决于 Normal 样式的页面高度和字体大小。最小行距是字体大小的 136%。例如,每页边距为 1 英寸的 Letter 页面的最大行数为 39。
默认情况下,该属性有一个值,在该值上,行距是 Normal 样式字体大小的 1.5 倍。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 文档网格中每页的行数。 |
setMultiplePages(int value)
public void setMultiplePages(int value)
对于多页文档,获取或设置文档的打印或呈现方式,以便将其装订成小册子。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。该值必须是其中之一MultiplePagesType常数。 |
setOddAndEvenPagesHeaderFooter(boolean value)
public void setOddAndEvenPagesHeaderFooter(boolean value)
True如果文档的奇数页和偶数页有不同的页眉和页脚。请注意,更改此属性会影响文档中的所有部分。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setOrientation(int value)
public void setOrientation(int value)
设置页面的方向。
改变Orientation掉期getPageWidth() / setPageWidth(double)和getPageHeight() / setPageHeight(double).
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 页面的方向。该值必须是其中之一Orientation常数。 |
setOtherPagesTray(int value)
public void setOtherPagesTray(int value)
设置要用于除第一页以外的所有部分的纸盘(纸盒)。该值是特定于实现(打印机)的。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 用于除第一页以外的所有部分的纸盘(纸盒)。 |
setPageHeight(double value)
public void setPageHeight(double value)
以磅为单位设置页面的高度。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 页面的高度(以磅为单位)。 |
setPageNumberStyle(int value)
public void setPageNumberStyle(int value)
设置页码格式。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 页码格式。该值必须是其中之一NumberStyle常数。 |
setPageStartingNumber(int value)
public void setPageStartingNumber(int value)
设置节的起始页码。这getRestartPageNumbering() / setRestartPageNumbering(boolean)属性,如果设置为false 将覆盖PageStartingNumber属性,以便页码可以从上一节继续。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 节的起始页码。 |
setPageWidth(double value)
public void setPageWidth(double value)
以磅为单位设置页面的宽度。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 页面的宽度(以磅为单位)。 |
setPaperSize(int value)
public void setPaperSize(int value)
设置纸张尺寸。
设置此属性更新getPageWidth() / setPageWidth(double)和getPageHeight() / setPageHeight(double)价值观。将此值设置为PaperSize.CUSTOM不会更改现有值。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 纸张尺寸。该值必须是其中之一PaperSize常数。 |
setRestartPageNumbering(boolean value)
public void setRestartPageNumbering(boolean value)
True如果页码在该部分的开头重新开始。如果设置为false, 这RestartPageNumbering属性将覆盖getPageStartingNumber() / setPageStartingNumber(int)属性,以便页码可以从上一节继续。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setRightMargin(double value)
public void setRightMargin(double value)
设置页面右边缘与正文右边界之间的距离(以磅为单位)。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 页面右边缘与正文右边界之间的距离(以磅为单位)。 |
setRtlGutter(boolean value)
public void setRtlGutter(boolean value)
设置 Microsoft Word 是根据从右到左的语言还是从左到右的语言为节使用装订线。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | Microsoft Word 是根据从右到左的语言还是从左到右的语言为节使用间距。 |
setSectionStart(int value)
public void setSectionStart(int value)
设置指定对象的分节符类型。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 指定对象的分节符类型。该值必须是其中之一SectionStart常数。 |
setSheetsPerBooklet(int value)
public void setSheetsPerBooklet(int value)
设置每本小册子中包含的页数。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 每本小册子中包含的页数。 |
setSuppressEndnotes(boolean value)
public void setSuppressEndnotes(boolean value)
True如果在不抑制尾注的下一节末尾打印尾注。隐藏的尾注打印在该部分的尾注之前。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setTextOrientation(int value)
public void setTextOrientation(int value)
允许指定getTextOrientation() / setTextOrientation(int)对于整个页面。默认值为TextOrientation.HORIZONTAL此属性仅支持 MS Word 本机格式 DOCX、WML、RTF 和 DOC。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。该值必须是其中之一TextOrientation常数。 |
setTopMargin(double value)
public void setTopMargin(double value)
设置页面上边缘与正文上边界之间的距离(以磅为单位)。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | double | 页面上边缘与正文上边界之间的距离(以磅为单位)。 |
setVerticalAlignment(int value)
public void setVerticalAlignment(int value)
设置文档或节中每个页面上文本的垂直对齐方式。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 文档或部分中每一页上文本的垂直对齐方式。该值必须是其中之一PageVerticalAlignment常数。 |
toString()
public String toString()
退货: java.lang.字符串
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | long | |
arg1 | int |