IPdfFileStamp

public interface IPdfFileStamp

用于向 PDF 文件添加图章(水印或背景)的界面。

领域

场地描述
POS_BOTTOM_LEFT左下位置。
POS_BOTTOM_MIDDLE底部中间位置。
POS_BOTTOM_RIGHT右下位置。
POS_SIDES_LEFT左侧位置。
POS_SIDES_RIGHT正确的位置。
POS_UPPER_LEFT上让位置。
POS_UPPER_MIDDLE中上位置。
POS_UPPER_RIGHT右上位置。

方法

方法描述
addFooter(FormattedText formattedText, float bottomMargin)将页脚添加到文档的页面。
addFooter(FormattedText formattedText, float bottomMargin, float leftMargin, float rightMargin)将页脚添加到文档的页面。
addFooter(InputStream imageStream, float bottomMargin)添加图像作为页面的页脚。
addFooter(InputStream imageStream, float bottomMargin, float leftMargin, float rightMargin)添加图像作为页面的页脚。
addFooter(String imageFile, float bottomMargin)将图像作为页脚添加到文档的页面。
addFooter(String imageFile, float bottomMargin, float leftMargin, float rightMargin)添加图像作为页面的页脚。
addHeader(FormattedText formattedText, float topMargin)向页面添加页眉。
addHeader(FormattedText formattedText, float topMargin, float leftMargin, float rightMargin)将页眉添加到文件页面。
addHeader(InputStream imageStream, float topMargin)在页面上添加图像作为标题。
addHeader(InputStream inputStream, float topMargin, float leftMargin, float rightMargin)在页面顶部添加图像。
addHeader(String imageFile, float topMargin)将图像作为页眉添加到文件的页面。
addHeader(String imageFile, float topMargin, float leftMargin, float rightMargin)在页面上添加图像作为标题。
addPageNumber(FormattedText formattedText)向页面添加页码。
addPageNumber(FormattedText formattedText, float x, float y)在页面的指定位置添加页码。
addPageNumber(FormattedText formattedText, int position)向页面添加页码。
addPageNumber(FormattedText formattedText, int position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)将页码添加到文档的页面。
addPageNumber(String formatString)将页码添加到文件。
addPageNumber(String formatString, float x, float y)在页面的指定位置添加页码。
addPageNumber(String formatString, int position)向页面添加页码。
addPageNumber(String formatString, int position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)将页码添加到文档的页面。
addStamp(Stamp stamp)向文件添加戳记。
close()关闭打开的文件并保存更改。
dispose()关闭打开的文件并保存更改。
getAttachmentName()当操作结果作为附件存储到 HttpResponse 对象时获取附件名称。
getContentDisposition()获取当操作结果存储到 HttpResponse 对象时将如何存储内容。
getDocument()获取 PdfFileStamp 正在处理的文档。
getInputFile()获取输入文件的名称和路径。
getInputStream()获取输入流。
getKeepSecurity()如果为真,则保持安全。
getOutputFile()获取输出文件的名称和路径。
getOutputStream()获取输出流。
getPageHeight()获取源文件中第一页的高度。
getPageNumberRotation()获取页码的旋转。
getPageWidth()获取输入文件中第一页的宽度。
getSaveOptions()当结果存储为 HttpResponse 时获取保存选项。
getStartingNumber()获取或设置输入文件中第一页的起始编号。
setAttachmentName(String value)当操作结果作为附件存储到 HttpResponse 对象时,设置附件名称。
setContentDisposition(int value)设置当操作结果存储到 HttpResponse 对象时将如何存储内容。
setConvertTo(PdfFormat value)设置 PDF 文件格式。
setInputFile(String value)设置输入文件的名称和路径。
setInputStream(InputStream value)设置输入流。
setKeepSecurity(boolean value)设置保持安全
setOutputFile(String value)设置输出文件的名称和路径。
setOutputStream(OutputStream value)设置或设置输出流。
setPageNumberRotation(float value)设置页码的旋转。
setSaveOptions(SaveOptions value)当结果存储为 HttpResponse 时设置保存选项。
setStartingNumber(int value)设置输入文件第一页的起始编号。

POS_BOTTOM_LEFT

public static final int POS_BOTTOM_LEFT

左下位置。

POS_BOTTOM_MIDDLE

public static final int POS_BOTTOM_MIDDLE

底部中间位置。

POS_BOTTOM_RIGHT

public static final int POS_BOTTOM_RIGHT

右下位置。

POS_SIDES_LEFT

public static final int POS_SIDES_LEFT

左侧位置。

POS_SIDES_RIGHT

public static final int POS_SIDES_RIGHT

正确的位置。

POS_UPPER_LEFT

public static final int POS_UPPER_LEFT

上让位置。

POS_UPPER_MIDDLE

public static final int POS_UPPER_MIDDLE

中上位置。

POS_UPPER_RIGHT

public static final int POS_UPPER_RIGHT

右上位置。

addFooter(FormattedText formattedText, float bottomMargin)

public abstract void addFooter(FormattedText formattedText, float bottomMargin)

将页脚添加到文档的页面。


PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 stamp.addFooter(new FormattedText("Foot of the page"), 10);

参数:

范围类型描述
formattedTextFormattedText包含页脚文本和文本属性的 FormattedText 对象。
bottomMarginfloat页面顶部的边距。

addFooter(FormattedText formattedText, float bottomMargin, float leftMargin, float rightMargin)

public abstract void addFooter(FormattedText formattedText, float bottomMargin, float leftMargin, float rightMargin)

将页脚添加到文档的页面。


PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 stamp.addFooter(new FormattedText("Foot of the page"), 10, 50, 50);

参数:

范围类型描述
formattedTextFormattedText包含页脚文本和文本属性的 FormattedText 对象。
bottomMarginfloat页面底部的边距。
leftMarginfloat页面左侧的边距。
rightMarginfloat页面右侧的边距。

addFooter(InputStream imageStream, float bottomMargin)

public abstract void addFooter(InputStream imageStream, float bottomMargin)

添加图像作为页面的页脚。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addFooter(new FileInputStream("image.jpg"), 50);
 fileStamp.close();

参数:

范围类型描述
imageStreamjava.io.InputStream流包含图像数据。
bottomMarginfloat页面底部的边距。

addFooter(InputStream imageStream, float bottomMargin, float leftMargin, float rightMargin)

public abstract void addFooter(InputStream imageStream, float bottomMargin, float leftMargin, float rightMargin)

添加图像作为页面的页脚。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addFooter(new FileInputStream("image.jpg"), 50, 50, 50);
 fileStamp.close();

参数:

范围类型描述
imageStreamjava.io.InputStream流包含图像数据。
bottomMarginfloat页面底部的边距。
leftMarginfloat页面左侧的边距。
rightMarginfloat页面右侧的边距。

addFooter(String imageFile, float bottomMargin)

public abstract void addFooter(String imageFile, float bottomMargin)

将图像作为页脚添加到文档的页面。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addFooter("image.jpg", 50);
 fileStamp.close();

参数:

范围类型描述
imageFilejava.lang.String图像文件名和路径。
bottomMarginfloat页面底部的边距。

addFooter(String imageFile, float bottomMargin, float leftMargin, float rightMargin)

public abstract void addFooter(String imageFile, float bottomMargin, float leftMargin, float rightMargin)

添加图像作为页面的页脚。

参数:

范围类型描述
imageFilejava.lang.String图片文件名和路径。
bottomMarginfloat页面底部的边距。
leftMarginfloat页面左侧的边距。
rightMarginfloat页面右侧的边距。

addHeader(FormattedText formattedText, float topMargin)

public abstract void addHeader(FormattedText formattedText, float topMargin)

向页面添加页眉。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addHeader(new FormattedText("Head of the page"), 50);
 fileStamp.close();

参数:

范围类型描述
formattedTextFormattedText标题文本和文本属性。
topMarginfloat页面顶部的边距。

addHeader(FormattedText formattedText, float topMargin, float leftMargin, float rightMargin)

public abstract void addHeader(FormattedText formattedText, float topMargin, float leftMargin, float rightMargin)

将页眉添加到文件页面。


PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 stamp.addHeader(new FormattedText("Head of the page"), 10, 50, 50);

参数:

范围类型描述
formattedTextFormattedText包含页面文本及其属性的格式化文本对象。
topMarginfloat页面顶部的边距。
leftMarginfloat页面左侧的边距。
rightMarginfloat页面右侧的边距。

addHeader(InputStream imageStream, float topMargin)

public abstract void addHeader(InputStream imageStream, float topMargin)

在页面上添加图像作为标题。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addHeader(new FileInputStream("image.jpg"), 50);
 fileStamp.close();

参数:

范围类型描述
imageStreamjava.io.InputStream图像流。
topMarginfloat页面顶部的边距。

addHeader(InputStream inputStream, float topMargin, float leftMargin, float rightMargin)

public abstract void addHeader(InputStream inputStream, float topMargin, float leftMargin, float rightMargin)

在页面顶部添加图像。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addHeader(new FileInputStream("image.jpg"), 50, 100, 100);
 fileStamp.close();

参数:

范围类型描述
inputStreamjava.io.InputStream包含图像数据的流。
topMarginfloat页面顶部的边距。
leftMarginfloat页面左侧的边距。
rightMarginfloat页面右侧的边距。

addHeader(String imageFile, float topMargin)

public abstract void addHeader(String imageFile, float topMargin)

将图像作为页眉添加到文件的页面。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addHeader("image.jpg", 50);
 fileStamp.close();

参数:

范围类型描述
imageFilejava.lang.String图像文件的路径。
topMarginfloat页面顶部的边距。

addHeader(String imageFile, float topMargin, float leftMargin, float rightMargin)

public abstract void addHeader(String imageFile, float topMargin, float leftMargin, float rightMargin)

在页面上添加图像作为标题。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", output.pdf");
 fileStamp.addHeader("image.jpg", 50, 100, 100);
 fileStamp.close();

参数:

范围类型描述
imageFilejava.lang.String图像文件的路径。
topMarginfloat页面顶部的边距。
leftMarginfloat页面左侧的边距。
rightMarginfloat页面右侧的边距。

addPageNumber(FormattedText formattedText)

public abstract void addPageNumber(FormattedText formattedText)

向页面添加页码。页码可能包含\将被页码替换的符号。页码位于页面底部,水平居中。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber(new FormattedText("Page #"));
 fileStamp.close();

参数:

范围类型描述
formattedTextFormattedText页码的格式字符串表示为 FormattedText。

addPageNumber(FormattedText formattedText, float x, float y)

public abstract void addPageNumber(FormattedText formattedText, float x, float y)

在页面的指定位置添加页码。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber(new FormattedText("Page  #"), 123, 357);
 fileStamp.close();

参数:

范围类型描述
formattedTextFormattedText表示页码格式和文本属性的格式化文本。格式字符串可以包含\将被页码替换的符号。
xfloat页码的 X 坐标。
yfloat页码的 Y 坐标。

addPageNumber(FormattedText formattedText, int position)

public abstract void addPageNumber(FormattedText formattedText, int position)

向页面添加页码。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber("Page #", PdfFileStamp.PosUpperRight);
 fileStamp.close();

参数:

范围类型描述
formattedTextFormattedText包含页码格式和文本属性的 FormattedText 对象。这段文字可能包含\将替换为页码。
positionint页码将放置在页面上的位置。 0-中下,1-右下,2-右上,3-右侧,4-中上,5-左下,6-左侧,7-左上。您可以使用以下常量:PosBottomMiddle = 0、PosBottomRight = 1、PosUpperRight = 2、PosSidesRight = 3、PosUpperMiddle、PosBottomLeft = 5、PosSidesLeft、PosUpperLeft

addPageNumber(FormattedText formattedText, int position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)

public abstract void addPageNumber(FormattedText formattedText, int position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)

将页码添加到文档的页面。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber(new FormattedText("Page #"), PdfFileStamp.PosBottomLeft, 100, 100, 200, 200);
 fileStamp.close();

参数:

范围类型描述
formattedTextFormattedText表示页码格式和文本属性的 FormattedText 对象。
positionint页码将放置在页面上的位置。 0-中下,1-右下,2-右上,3-右侧,4-中上,5-左下,6-左侧,7-左上。您可以使用以下常量:PosBottomMiddle = 0、PosBottomRight = 1、PosUpperRight = 2、PosSidesRight = 3、PosUpperMiddle、PosBottomLeft = 5、PosSidesLeft、PosUpperLeft
leftMarginfloat页面左边缘的边距。
rightMarginfloat页面右边缘的边距。
topMarginfloat页面上边缘的边距。
bottomMarginfloat页面底部边缘的边距。

addPageNumber(String formatString)

public abstract void addPageNumber(String formatString)

将页码添加到文件。页码文本可能包含\将替换为页码的符号。页码位于页面底部,水平居中。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber("Page #");
 fileStamp.close();

参数:

范围类型描述
formatStringjava.lang.String页码文字

addPageNumber(String formatString, float x, float y)

public abstract void addPageNumber(String formatString, float x, float y)

在页面的指定位置添加页码。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber(new FormattedText("Page  #"), 123, 357);
 fileStamp.close();

参数:

范围类型描述
formatStringjava.lang.String格式化字符串。格式字符串可以包含\将被页码替换的符号。
xfloat页码的 X 坐标。
yfloat页码的 Y 坐标。

addPageNumber(String formatString, int position)

public abstract void addPageNumber(String formatString, int position)

向页面添加页码。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber("Page #", PdfFileStamp.PosUpperRight);
 fileStamp.close();

参数:

范围类型描述
formatStringjava.lang.String页码的格式。这段文字可能包含\将替换为页码。
positionint页码将放置在页面上的位置。 0-中下,1-右下,2-右上,3-右侧,4-中上,5-左下,6-左侧,7-左上。您可以使用以下常量:PosBottomMiddle = 0、PosBottomRight = 1、PosUpperRight = 2、PosSidesRight = 3、PosUpperMiddle、PosBottomLeft = 5、PosSidesLeft、PosUpperLeft

addPageNumber(String formatString, int position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)

public abstract void addPageNumber(String formatString, int position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)

将页码添加到文档的页面。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.addPageNumber("Page #", PdfFileStamp.PosBottomLeft, 100, 100, 200, 200);
 fileStamp.close();

参数:

范围类型描述
formatStringjava.lang.String页码的格式字符串。
positionint页码将放置在页面上的位置。 0-中下,1-右下,2-右上,3-右侧,4-中上,5-左下,6-左侧,7-左上。您可以使用以下常量:PosBottomMiddle = 0、PosBottomRight = 1、PosUpperRight = 2、PosSidesRight = 3、PosUpperMiddle、PosBottomLeft = 5、PosSidesLeft、PosUpperLeft
leftMarginfloat页面左边缘的边距。
rightMarginfloat页面右边缘的边距。
topMarginfloat页面上边缘的边距。
bottomMarginfloat页面底部边缘的边距。

addStamp(Stamp stamp)

public abstract void addStamp(Stamp stamp)

向文件添加戳记。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 Stamp stamp = new com.aspose.pdf.facades.Stamp();
 stamp.setOrigin(140, 400);
 stamp.setImageSize(50, 50);
 stamp.setOpacity(0.8f);
 stamp.isBackground(true);
 stamp.bindImage("image.jpg");
 fileStamp.addStamp(stamp);
 fileStamp.close();

参数:

范围类型描述
stampStamp邮票对象。

close()

public abstract void close()

关闭打开的文件并保存更改。警告。如果指定了输入或输出流,则它们不会被 Close() 方法关闭。


PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 //做一些工作...
 stamp.close();

dispose()

public abstract void dispose()

关闭打开的文件并保存更改。警告。如果指定了输入或输出流,则它们不会被 Close() 方法关闭。


PdfFileStamp stamp = new PdfFileStamp("input.pdf", "output.pdf");
 //做一些工作...
 stamp.dispose();

此方法已过时,请改用 close() 。

getAttachmentName()

public abstract String getAttachmentName()

当操作结果作为附件存储到 HttpResponse 对象时获取附件名称。

退货: java.lang.String - 字符串值

getContentDisposition()

public abstract int getContentDisposition()

获取当操作结果存储到 HttpResponse 对象时将如何存储内容。可能的值:内联/附件。默认值:内联。

退货: int - ContentDisposition 元素

getDocument()

public abstract IDocument getDocument()

获取 PdfFileStamp 正在处理的文档。

退货: IDocument IDocument 对象

getInputFile()

public abstract String getInputFile()

获取输入文件的名称和路径。

退货: java.lang.String - 字符串对象

getInputStream()

public abstract InputStream getInputStream()

获取输入流。

退货: java.io.InputStream - InputStream 对象

getKeepSecurity()

public abstract boolean getKeepSecurity()

如果为真,则保持安全。 (此功能将在下一版本中实现)。

退货: boolean - 布尔值

getOutputFile()

public abstract String getOutputFile()

获取输出文件的名称和路径。

退货: java.lang.String - 字符串对象

getOutputStream()

public abstract OutputStream getOutputStream()

获取输出流。

退货: java.io.OutputStream - OutputStream 对象

getPageHeight()

public abstract float getPageHeight()

获取源文件中第一页的高度。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 System.out.println("Height = " + fileStamp.getPageHeight());
 fileStamp.close();

退货: float - 浮点值

getPageNumberRotation()

public abstract float getPageNumberRotation()

获取页码的旋转。旋转以度为单位。默认为 0。

退货: float - 浮点值

getPageWidth()

public abstract float getPageWidth()

获取输入文件中第一页的宽度。


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 System.out.println("Width = " + fileStamp.getPageWidth());
 fileStamp.close();

退货: float - 浮点值

getSaveOptions()

public abstract SaveOptions getSaveOptions()

当结果存储为 HttpResponse 时获取保存选项。默认值:PdfSaveOptions。

退货: SaveOptions - 保存选项对象

getStartingNumber()

public abstract int getStartingNumber()

获取或设置输入文件中第一页的起始编号。下一页将从该值开始编号。

退货: int - 整数值

setAttachmentName(String value)

public abstract void setAttachmentName(String value)

当操作结果作为附件存储到 HttpResponse 对象时,设置附件名称。

参数:

范围类型描述
valuejava.lang.String字符串值

setContentDisposition(int value)

public abstract void setContentDisposition(int value)

设置当操作结果存储到 HttpResponse 对象时将如何存储内容。可能的值:内联/附件。默认值:内联。

参数:

范围类型描述
valueintContentDisposition 元素

setConvertTo(PdfFormat value)

public abstract void setConvertTo(PdfFormat value)

设置 PDF 文件格式。结果文件将以指定的文件格式保存。如果未指定此属性,则文件将以默认 PDF 格式保存而不进行转换。

参数:

范围类型描述
valuePdfFormatPdfFormat 元素

setInputFile(String value)

public abstract void setInputFile(String value)

设置输入文件的名称和路径。

参数:

范围类型描述
valuejava.lang.String字符串值

setInputStream(InputStream value)

public abstract void setInputStream(InputStream value)

设置输入流。

参数:

范围类型描述
valuejava.io.InputStream输入流对象

setKeepSecurity(boolean value)

public abstract void setKeepSecurity(boolean value)

设置保持安全

参数:

范围类型描述
valueboolean布尔值

setOutputFile(String value)

public abstract void setOutputFile(String value)

设置输出文件的名称和路径。

参数:

范围类型描述
valuejava.lang.String字符串对象

setOutputStream(OutputStream value)

public abstract void setOutputStream(OutputStream value)

设置或设置输出流。

参数:

范围类型描述
valuejava.io.OutputStream输出流对象

setPageNumberRotation(float value)

public abstract void setPageNumberRotation(float value)

设置页码的旋转。旋转以度为单位。默认为 0。

参数:

范围类型描述
valuefloat浮点值

setSaveOptions(SaveOptions value)

public abstract void setSaveOptions(SaveOptions value)

当结果存储为 HttpResponse 时设置保存选项。默认值:PdfSaveOptions。

参数:

范围类型描述
valueSaveOptions保存选项值

setStartingNumber(int value)

public abstract void setStartingNumber(int value)

设置输入文件第一页的起始编号。下一页将从该值开始编号。例如,如果 StartingNumber 设置为 100,则文档页面的编号将是 100、101、102…


PdfFileStamp fileStamp = new PdfFileStamp("input.pdf", "output.pdf");
 fileStamp.setStartingNumber(100);
 fileStamp.addPageNumber("Page #");
 fileStamp.close();

参数:

范围类型描述
valueint整数值