PdfFileStamp Class - Aspose.PDF for .NET

PdfFileStamp Class

Class for adding stamps (watermark or background) to PDF files.

Inheritance Hierarchy

SystemObject
  Aspose.Pdf.FacadesFacade
    Aspose.Pdf.FacadesSaveableFacade
      Aspose.Pdf.FacadesPdfFileStamp

Namespace: Aspose.Pdf.Facades
Assembly: Aspose.PDF (in Aspose.PDF.dll) Version: 20.3

Syntax

C++

public sealed class PdfFileStamp : SaveableFacade

Public NotInheritable Class PdfFileStamp
	Inherits SaveableFacade

public ref class PdfFileStamp sealed : public SaveableFacade

[<SealedAttribute>]
type PdfFileStamp =  
    class
        inherit SaveableFacade
    end

The PdfFileStamp type exposes the following members.

Constructors

	Name	Description
	PdfFileStamp	Constructor of the PdfFileStamp. Input file and output file may be specified via corresponding properties. Examples C# PdfFileStamp fileStamp = new PdfFileStamp(); fileStamp.InputFile = "input.pdf"; fileStamp.OutputFile = "output.pdf";
	PdfFileStamp(Document)	Initializes new PdfFileStamp object on base of the document.
	PdfFileStamp(Stream, Stream)	Obsolete. Constructor for PdfFileStamp.
	PdfFileStamp(Stream, HttpResponse)	Obsolete. Creates PdfFileStamp which will save result into HttpResponse object.
	PdfFileStamp(String, String)	Obsolete. Constructor for PdfFileStamp.
	PdfFileStamp(String, HttpResponse)	Obsolete. Creates PdfFileStamp which will save result into HttpResponse object.
	PdfFileStamp(Document, Stream)	Obsolete. Initializes new PdfFileStamp object on base of the document.
	PdfFileStamp(Document, String)	Obsolete. Initializes new PdfFileStamp object on base of the document.
	PdfFileStamp(Stream, Stream, Boolean)	Obsolete. Constructor of PdfFileStamp.
	PdfFileStamp(String, String, Boolean)	Obsolete. Constructor for PdfFileStamp.

Properties

	Name	Description
	AttachmentName	Gets or sets name of attachment when result of operation is stored into HttpResponse objects as attachment.
	ContentDisposition	Gets or sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline.
	ConvertTo	Sets PDF file format. Result file will be saved in specified file format. If this property is not specified then file will be save in default PDF format without conversion.
	Document	Gets the document facade is working on. (Inherited from Facade.)
	InputFile	Obsolete. Gets or sets name and path of input file.
	InputStream	Obsolete. Gets or sets input stream.
	KeepSecurity	Keeps security if true. (This feature will be implemented in next versions).
	NumberingStyle	Gets or sets pabge numbering style. Possible values: NumeralsArabic, NumeralsRomanUppercase, NumeralsRomanLowercase, LettersAppercase, LettersLowercase
	OptimizeSize	Gets or sets optimization flag. Equal resource streams in resultant file are merged into one PDF object if this flag set. This allows to decrease resultant file size but may cause slower execution and larger memory requirements. Default value: false.
	OutputFile	Obsolete. Gets or sets name and path of output file.
	OutputStream	Obsolete. Gets or sets output stream.
	PageHeight	Gets height of first page in souorce file.
	PageNumberRotation	Gets or sets rotation of page number. Rotation is in degrees. Default is 0.
	PageWidth	Gets width of first page in input file.
	Response	Gets or sets Response object where result of operation will be stored.
	SaveOptions	Gets or sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.
	StampId	Stamp ID of next added stamp (incluiding page headers/hooters/page numbers).
	StartingNumber	Gets or sets starting number for first page in input file. Next pages will be numbered starting from this value. For example if StartingNumber is set to 100, document pages will have numbers 100, 101, 102...

Methods

	Name	Description
	AddFooter(Stream, Single)	Adds image as footer of the page.
	AddFooter(String, Single)	Adds image as footer to the pages of the document.
	AddFooter(FormattedText, Single)	Adds footer to the pages of the document.
	AddFooter(Stream, Single, Single, Single)	Adds image as footer of the page.
	AddFooter(String, Single, Single, Single)	Adds image as footer of the pages.
	AddFooter(FormattedText, Single, Single, Single)	Adds footer to the pages of the document.
	AddHeader(Stream, Single)	Adds image as header on the pages.
	AddHeader(String, Single)	Adds image as header to the pages of the file.
	AddHeader(FormattedText, Single)	Adds header to the page.
	AddHeader(Stream, Single, Single, Single)	Adds image at the top of the page.
	AddHeader(String, Single, Single, Single)	Adds image as header on the pages.
	AddHeader(FormattedText, Single, Single, Single)	Adds header to the pages of file.
	AddPageNumber(String)	Add page number to file. Page number text may contain # sign which will be replaced with number of the page. Page number is placed in the bottom of the page centered horizontally.
	AddPageNumber(FormattedText)	Adds page number to the page. Page number may contain # sign which will be replaced with page number. Page number is placed in the bottom of the page centered horizontally.
	AddPageNumber(String, Int32)	Adds page number to the pages.
	AddPageNumber(FormattedText, Int32)	Adds page number to the pages.
	AddPageNumber(String, Single, Single)	Adds page number at the specified position on the page.
	AddPageNumber(FormattedText, Single, Single)	Adds page number at the specified position on the page.
	AddPageNumber(String, Int32, Single, Single, Single, Single)	Adds page number to the pages of document.
	AddPageNumber(FormattedText, Int32, Single, Single, Single, Single)	Adds page number to the pages of document.
	AddStamp	Adds stamp to the file.
	BindPdf(Stream)	Initializes the facade. (Inherited from Facade.)
	BindPdf(String)	Initializes the facade. (Inherited from Facade.)
	BindPdf(Document)	Initializes the facade. (Inherited from Facade.)
	Close	Closes opened files and saves changes. Warning. If input or output streams are specified they are not closed by Close() method. (Overrides FacadeClose.)
	Dispose	Disposes the facade. (Inherited from Facade.)
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Save(Stream)	Saves document into specified stream. (Overrides SaveableFacadeSave(Stream).)
	Save(String)	Saves result into specified file. (Overrides SaveableFacadeSave(String).)
	ToString	(Inherited from Object.)

Fields

	Name	Description
	PosBottomLeft	Bottom left position.
	PosBottomMiddle	Bottom middle position.
	PosBottomRight	Bottom right position.
	PosSidesLeft	Left position.
	PosSidesRight	Right position.
	PosUpperLeft	Upper let position.
	PosUpperMiddle	Upper middle position.
	PosUpperRight	Right upper position.

Reference

Aspose.Pdf.Facades Namespace