Aspose::Pdf::Facades::PdfFileStamp Class Referencefinal

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

#include "PdfFileStamp.h"

Inherits Aspose::Pdf::Facades::SaveableFacade.

Public Member Functions

ASPOSE_PDF_SHARED_API bool get_OptimizeSize () const
 Gets 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. More...
 
ASPOSE_PDF_SHARED_API void set_OptimizeSize (bool value)
 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. More...
 
ASPOSE_PDF_SHARED_API bool get_KeepSecurity () const
 Keeps security if true. (This feature will be implemented in next versions). More...
 
ASPOSE_PDF_SHARED_API void set_KeepSecurity (bool value)
 Keeps security if true. (This feature will be implemented in next versions). More...
 
ASPOSE_PDF_SHARED_API System::String get_InputFile () const
 Gets name and path of input file. More...
 
ASPOSE_PDF_SHARED_API void set_InputFile (System::String value)
 Sets name and path of input file. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Streamget_InputStream () const
 Gets input stream. More...
 
ASPOSE_PDF_SHARED_API void set_InputStream (System::SharedPtr< System::IO::Stream > value)
 Sets input stream. More...
 
ASPOSE_PDF_SHARED_API System::String get_OutputFile () const
 Gets name and path of output file. More...
 
ASPOSE_PDF_SHARED_API void set_OutputFile (System::String value)
 Sets name and path of output file. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Streamget_OutputStream () const
 Gets output stream. More...
 
ASPOSE_PDF_SHARED_API void set_OutputStream (System::SharedPtr< System::IO::Stream > value)
 Sets output stream. More...
 
ASPOSE_PDF_SHARED_API float get_PageNumberRotation ()
 Gets rotation of page number. Rotation is in degrees. Default is 0. More...
 
ASPOSE_PDF_SHARED_API void set_PageNumberRotation (float value)
 Sets rotation of page number. Rotation is in degrees. Default is 0. More...
 
ASPOSE_PDF_SHARED_API void set_ConvertTo (PdfFormat value)
 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. More...
 
ASPOSE_PDF_SHARED_API float get_PageHeight ()
 Gets height of first page in souorce file. More...
 
ASPOSE_PDF_SHARED_API float get_PageWidth ()
 Gets width of first page in input file. More...
 
ASPOSE_PDF_SHARED_API int32_t get_StartingNumber () const
 Gets 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... More...
 
ASPOSE_PDF_SHARED_API void set_StartingNumber (int32_t value)
 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... More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::NumberingStyle get_NumberingStyle () const
 Gets pabge numbering style. Possible values: NumeralsArabic, NumeralsRomanUppercase, NumeralsRomanLowercase, LettersAppercase, LettersLowercase More...
 
ASPOSE_PDF_SHARED_API void set_NumberingStyle (Aspose::Pdf::NumberingStyle value)
 Sets pabge numbering style. Possible values: NumeralsArabic, NumeralsRomanUppercase, NumeralsRomanLowercase, LettersAppercase, LettersLowercase More...
 
ASPOSE_PDF_SHARED_API int32_t get_StampId () const
 Stamp ID of next added stamp (incluiding page headers/hooters/page numbers). More...
 
ASPOSE_PDF_SHARED_API void set_StampId (int32_t value)
 Stamp ID of next added stamp (incluiding page headers/hooters/page numbers). More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::ContentDisposition get_ContentDisposition () const
 Gets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline. More...
 
ASPOSE_PDF_SHARED_API void set_ContentDisposition (Aspose::Pdf::ContentDisposition value)
 Sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Web::HttpResponseget_Response () const
 Gets Response object where result of operation will be stored. More...
 
ASPOSE_PDF_SHARED_API void set_Response (System::SharedPtr< System::Web::HttpResponse > value)
 Sets Response object where result of operation will be stored. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::SaveOptionsget_SaveOptions () const
 Gets save options when result is stored as HttpResponse. Default value: PdfSaveOptions. More...
 
ASPOSE_PDF_SHARED_API void set_SaveOptions (System::SharedPtr< Aspose::Pdf::SaveOptions > value)
 Sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions. More...
 
ASPOSE_PDF_SHARED_API System::String get_AttachmentName () const
 Gets name of attachment when result of operation is stored into HttpResponse objects as attachment. More...
 
ASPOSE_PDF_SHARED_API void set_AttachmentName (System::String value)
 Sets name of attachment when result of operation is stored into HttpResponse objects as attachment. More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::String inputFile, System::String outputFile)
 Constructor for PdfFileStamp. More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::SharedPtr< System::IO::Stream > inputStream, System::SharedPtr< System::IO::Stream > outputStream)
 Constructor for PdfFileStamp. More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::String inputFile, System::String outputFile, bool keepSecurity)
 Constructor for PdfFileStamp. More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::SharedPtr< System::IO::Stream > inputStream, System::SharedPtr< System::IO::Stream > outputStream, bool keepSecurity)
 Constructor of PdfFileStamp. More...
 
ASPOSE_PDF_SHARED_API void Close () override
 Closes opened files and saves changes. Warning. If input or output streams are specified they are not closed by Close() method. More...
 
ASPOSE_PDF_SHARED_API void Save (System::String destFile) override
 Saves result into specified file. More...
 
ASPOSE_PDF_SHARED_API void Save (System::SharedPtr< System::IO::Stream > destStream) override
 Saves document into specified stream. More...
 
ASPOSE_PDF_SHARED_API void AddStamp (System::SharedPtr< Stamp > stamp)
 Adds stamp to the file. More...
 
ASPOSE_PDF_SHARED_API void AddPageNumber (System::String formatString)
 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. More...
 
ASPOSE_PDF_SHARED_API void AddPageNumber (System::SharedPtr< FormattedText > 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. More...
 
ASPOSE_PDF_SHARED_API void AddPageNumber (System::String formatString, int32_t position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)
 Adds page number to the pages of document. More...
 
ASPOSE_PDF_SHARED_API void AddPageNumber (System::String formatString, float x, float y)
 Adds page number at the specified position on the page. More...
 
ASPOSE_PDF_SHARED_API void AddPageNumber (System::SharedPtr< FormattedText > formattedText, int32_t position, float leftMargin, float rightMargin, float topMargin, float bottomMargin)
 Adds page number to the pages of document. More...
 
ASPOSE_PDF_SHARED_API void AddPageNumber (System::SharedPtr< FormattedText > formattedText, float x, float y)
 Adds page number at the specified position on the page. More...
 
ASPOSE_PDF_SHARED_API void AddHeader (System::SharedPtr< FormattedText > formattedText, float topMargin)
 Adds header to the page. More...
 
ASPOSE_PDF_SHARED_API void AddHeader (System::SharedPtr< FormattedText > formattedText, float topMargin, float leftMargin, float rightMargin)
 Adds header to the pages of file. More...
 
ASPOSE_PDF_SHARED_API void AddHeader (System::String imageFile, float topMargin)
 Adds image as header to the pages of the file. More...
 
ASPOSE_PDF_SHARED_API void AddHeader (System::String imageFile, float topMargin, float leftMargin, float rightMargin)
 Adds image as header on the pages. More...
 
ASPOSE_PDF_SHARED_API void AddHeader (System::SharedPtr< System::IO::Stream > imageStream, float topMargin)
 Adds image as header on the pages. More...
 
ASPOSE_PDF_SHARED_API void AddHeader (System::SharedPtr< System::IO::Stream > inputStream, float topMargin, float leftMargin, float rightMargin)
 Adds image at the top of the page. More...
 
ASPOSE_PDF_SHARED_API void AddFooter (System::SharedPtr< FormattedText > formattedText, float bottomMargin)
 Adds footer to the pages of the document. More...
 
ASPOSE_PDF_SHARED_API void AddFooter (System::SharedPtr< FormattedText > formattedText, float bottomMargin, float leftMargin, float rightMargin)
 Adds footer to the pages of the document. More...
 
ASPOSE_PDF_SHARED_API void AddFooter (System::String imageFile, float bottomMargin)
 Adds image as footer to the pages of the document. More...
 
ASPOSE_PDF_SHARED_API void AddFooter (System::String imageFile, float bottomMargin, float leftMargin, float rightMargin)
 Adds image as footer of the pages. More...
 
ASPOSE_PDF_SHARED_API void AddFooter (System::SharedPtr< System::IO::Stream > imageStream, float bottomMargin)
 Adds image as footer of the page. More...
 
ASPOSE_PDF_SHARED_API void AddFooter (System::SharedPtr< System::IO::Stream > imageStream, float bottomMargin, float leftMargin, float rightMargin)
 Adds image as footer of the page. More...
 
ASPOSE_PDF_SHARED_API void AddPageNumber (System::String formatString, int32_t position)
 Adds page number to the pages. More...
 
ASPOSE_PDF_SHARED_API void AddPageNumber (System::SharedPtr< FormattedText > formattedText, int32_t position)
 Adds page number to the pages. More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp ()
 Constructor of the PdfFileStamp. Input file and output file may be specified via corresponding properties. More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::SharedPtr< Aspose::Pdf::Document > document)
 Initializes new PdfFileStamp object on base of the document . More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::SharedPtr< Aspose::Pdf::Document > document, System::String outputFile)
 Initializes new PdfFileStamp object on base of the document . More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::SharedPtr< Aspose::Pdf::Document > document, System::SharedPtr< System::IO::Stream > outputStream)
 Initializes new PdfFileStamp object on base of the document . More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::SharedPtr< System::IO::Stream > inputStream, System::SharedPtr< System::Web::HttpResponse > response)
 Creates PdfFileStamp which will save result into HttpResponse object. More...
 
ASPOSE_PDF_SHARED_API PdfFileStamp (System::String inputFile, System::SharedPtr< System::Web::HttpResponse > response)
 Creates PdfFileStamp which will save result into HttpResponse object. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::Facade
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Documentget_Document () const
 Gets the document facade is working on. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::String srcFile) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void Dispose () override
 Disposes the facade. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::IFacade
virtual void BindPdf (System::SharedPtr< Document > srcDoc)=0
 Binds PDF document for editing. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Static Public Attributes

static const ASPOSE_PDF_SHARED_API int32_t PosBottomMiddle
 Bottom middle position. More...
 
static const ASPOSE_PDF_SHARED_API int32_t PosBottomRight
 Bottom right position. More...
 
static const ASPOSE_PDF_SHARED_API int32_t PosUpperRight
 Right upper position. More...
 
static const ASPOSE_PDF_SHARED_API int32_t PosSidesRight
 Right position. More...
 
static const ASPOSE_PDF_SHARED_API int32_t PosUpperMiddle
 Upper middle position. More...
 
static const ASPOSE_PDF_SHARED_API int32_t PosBottomLeft
 Bottom left position. More...
 
static const ASPOSE_PDF_SHARED_API int32_t PosSidesLeft
 Left position. More...
 
static const ASPOSE_PDF_SHARED_API int32_t PosUpperLeft
 Upper let position. More...
 

Protected Member Functions

void ApplyStamp (System::SharedPtr< Stamp > stamp)
 
- Protected Member Functions inherited from Aspose::Pdf::Facades::SaveableFacade
ASPOSE_PDF_SHARED_API SaveableFacade ()
 The constructor. More...
 
ASPOSE_PDF_SHARED_API SaveableFacade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
- Protected Member Functions inherited from Aspose::Pdf::Facades::Facade
bool get__IsObjectLicensed ()
 Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...
 
ASPOSE_PDF_SHARED_API Facade ()
 The constructor. More...
 
ASPOSE_PDF_SHARED_API Facade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
virtual ASPOSE_PDF_SHARED_API void BindPdf (System::String srcFile, System::String password)
 Initializes the facade. More...
 
virtual ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream, System::String password)
 Initializes the facade. More...
 
virtual ASPOSE_PDF_SHARED_API void AssertDocument () const
 Asserts if the facade is initialized. More...
 
virtual ASPOSE_PDF_SHARED_API ~Facade ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PdfFileStamp() [1/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::String  inputFile,
System::String  outputFile 
)

Constructor for PdfFileStamp.

Deprecated:
Use constructor without destination.
Parameters
inputFileInput file name and path.
outputFileOutput file name and path.

◆ PdfFileStamp() [2/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::SharedPtr< System::IO::Stream inputStream,
System::SharedPtr< System::IO::Stream outputStream 
)

Constructor for PdfFileStamp.

Deprecated:
Use constructor without destination.
Parameters
inputStreamInput stream.
outputStreamOutput stream.

◆ PdfFileStamp() [3/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::String  inputFile,
System::String  outputFile,
bool  keepSecurity 
)

Constructor for PdfFileStamp.

Deprecated:
Use constructor without destination.
Parameters
inputFileInput file name and path.
outputFileOutput file name and path.
keepSecurityKeep security if true.

◆ PdfFileStamp() [4/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::SharedPtr< System::IO::Stream inputStream,
System::SharedPtr< System::IO::Stream outputStream,
bool  keepSecurity 
)

Constructor of PdfFileStamp.

Deprecated:
Use constructor without destination.
Parameters
inputStreamInput stream.
outputStreamOutput stream.
keepSecurityKeep security if true.

◆ PdfFileStamp() [5/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( )

Constructor of the PdfFileStamp. Input file and output file may be specified via corresponding properties.

◆ PdfFileStamp() [6/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::SharedPtr< Aspose::Pdf::Document document)

Initializes new PdfFileStamp object on base of the document .

Parameters
documentPdf document.

◆ PdfFileStamp() [7/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::SharedPtr< Aspose::Pdf::Document document,
System::String  outputFile 
)

Initializes new PdfFileStamp object on base of the document .

Deprecated:
Use constructor without destination.
Parameters
documentPdf document.
outputFileOutput file name and path.

◆ PdfFileStamp() [8/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::SharedPtr< Aspose::Pdf::Document document,
System::SharedPtr< System::IO::Stream outputStream 
)

Initializes new PdfFileStamp object on base of the document .

Deprecated:
Use constructor without destination.
Parameters
documentPdf document.
outputStreamOutput stream.

◆ PdfFileStamp() [9/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::SharedPtr< System::IO::Stream inputStream,
System::SharedPtr< System::Web::HttpResponse response 
)

Creates PdfFileStamp which will save result into HttpResponse object.

Deprecated:
Use constructor without destination.
Parameters
inputStreamStream with input document.
responseHttpResponse object where result will be saved.

◆ PdfFileStamp() [10/10]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileStamp::PdfFileStamp ( System::String  inputFile,
System::SharedPtr< System::Web::HttpResponse response 
)

Creates PdfFileStamp which will save result into HttpResponse object.

Deprecated:
Use constructor without destination.
Parameters
inputFileSource file name.
responseHttpResponse object where result will be saved.

Member Function Documentation

◆ AddFooter() [1/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddFooter ( System::SharedPtr< FormattedText formattedText,
float  bottomMargin 
)

Adds footer to the pages of the document.

Parameters
formattedTextFormattedText object which contains text of the footer and text properties.
bottomMarginMargin at the top of page.

◆ AddFooter() [2/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddFooter ( System::SharedPtr< FormattedText formattedText,
float  bottomMargin,
float  leftMargin,
float  rightMargin 
)

Adds footer to the pages of the document.

Parameters
formattedTextFormattedText object which contains footer text and text properties.
bottomMarginMargin at the bottom of the page.
leftMarginMargin at the left side of the page.
rightMarginMargin at the right side of the page.

◆ AddFooter() [3/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddFooter ( System::String  imageFile,
float  bottomMargin 
)

Adds image as footer to the pages of the document.

Parameters
imageFileImage file name and path.
bottomMarginMargin at the bottom of the page.

◆ AddFooter() [4/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddFooter ( System::String  imageFile,
float  bottomMargin,
float  leftMargin,
float  rightMargin 
)

Adds image as footer of the pages.

Parameters
imageFileIamge file name and path.
bottomMarginMargin at the bottom of the page.
leftMarginMargin at the left side of the page.
rightMarginMargin at the right side of the page.

///

◆ AddFooter() [5/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddFooter ( System::SharedPtr< System::IO::Stream imageStream,
float  bottomMargin 
)

Adds image as footer of the page.

Parameters
imageStreamStream contains image data.
bottomMarginMargin at the bottom of the page.

◆ AddFooter() [6/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddFooter ( System::SharedPtr< System::IO::Stream imageStream,
float  bottomMargin,
float  leftMargin,
float  rightMargin 
)

Adds image as footer of the page.

Parameters
imageStreamStream contains image data.
bottomMarginMargin at the bottom of the page.
leftMarginMargin at the left side of the page.
rightMarginMargin at the right side of the page.

◆ AddHeader() [1/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddHeader ( System::SharedPtr< FormattedText formattedText,
float  topMargin 
)

Adds header to the page.

Parameters
formattedTextText for header and properties of the text.
topMarginMargin on the top of page.

◆ AddHeader() [2/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddHeader ( System::SharedPtr< FormattedText formattedText,
float  topMargin,
float  leftMargin,
float  rightMargin 
)

Adds header to the pages of file.

Parameters
formattedTextFormatted text object which contains page text and its properties.
topMarginMargin on the top of the page.
leftMarginMargin on the left of the page.
rightMarginMargin on the right of the page.

◆ AddHeader() [3/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddHeader ( System::String  imageFile,
float  topMargin 
)

Adds image as header to the pages of the file.

Parameters
imageFilePath to the image file.
topMarginMargin at top of the page.

◆ AddHeader() [4/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddHeader ( System::String  imageFile,
float  topMargin,
float  leftMargin,
float  rightMargin 
)

Adds image as header on the pages.

Parameters
imageFilePath to the image file.
topMarginMargin at top of the page.
leftMarginMargin at left side of the page.
rightMarginMargin at right side of the page.

◆ AddHeader() [5/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddHeader ( System::SharedPtr< System::IO::Stream imageStream,
float  topMargin 
)

Adds image as header on the pages.

Parameters
imageStreamStream of the image.
topMarginMargin at top of the page.

◆ AddHeader() [6/6]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddHeader ( System::SharedPtr< System::IO::Stream inputStream,
float  topMargin,
float  leftMargin,
float  rightMargin 
)

Adds image at the top of the page.

Parameters
inputStreamStream which contains image data.
topMarginMargin at top of the page.
leftMarginMargin at left side of the page.
rightMarginMargin at right side of the page.

◆ AddPageNumber() [1/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddPageNumber ( System::String  formatString)

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.

Parameters
formatStringText of page number

◆ AddPageNumber() [2/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddPageNumber ( System::SharedPtr< FormattedText 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.

Parameters
formattedTextFormat string for page number representes as FormattedText.

◆ AddPageNumber() [3/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddPageNumber ( System::String  formatString,
int32_t  position,
float  leftMargin,
float  rightMargin,
float  topMargin,
float  bottomMargin 
)

Adds page number to the pages of document.

Parameters
formatStringFormat string for page number.
positionPosition where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft
leftMarginMargin on the left edge of the page.
rightMarginMargin on the right edge of the page.
topMarginMargin on the top edge of the page.
bottomMarginMargin on the bottom edge of the page.

◆ AddPageNumber() [4/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddPageNumber ( System::String  formatString,
float  x,
float  y 
)

Adds page number at the specified position on the page.

Parameters
formatStringFormat string. Format string can contain # sign which will be replaced with page number.
xX coordinate of page number.
yY coordinate of page number.

◆ AddPageNumber() [5/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddPageNumber ( System::SharedPtr< FormattedText formattedText,
int32_t  position,
float  leftMargin,
float  rightMargin,
float  topMargin,
float  bottomMargin 
)

Adds page number to the pages of document.

Parameters
formattedTextFormattedText object which represents page number format and properties iof the text.
positionPosition where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft
leftMarginMargin on the left edge of the page.
rightMarginMargin on the right edge of the page.
topMarginMargin on the top edge of the page.
bottomMarginMargin on the bottom edge of the page.

◆ AddPageNumber() [6/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddPageNumber ( System::SharedPtr< FormattedText formattedText,
float  x,
float  y 
)

Adds page number at the specified position on the page.

Parameters
formattedTextFormatted text which represents page number format and properties of the text. Format string can contain # sign which will be replaced with page number.
xX coordinate of page number.
yY coordinate of page number.

◆ AddPageNumber() [7/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddPageNumber ( System::String  formatString,
int32_t  position 
)

Adds page number to the pages.

Parameters
formatStringFormat of the page number. This text may contain # which will be replaced with page number.
positionPosition where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft

◆ AddPageNumber() [8/8]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddPageNumber ( System::SharedPtr< FormattedText formattedText,
int32_t  position 
)

Adds page number to the pages.

Parameters
formattedTextFormattedText object which contains format of the page number and text properties. This text may contain # which will be replaced with page number.
positionPosition where page number will be placed on the page. 0-bottom middle, 1-bottom right, 2-upper right, 3 - sides right, 4 - upper middle,5 - bottom left,6 - sides left,7 - upper left. You can use the following constants: PosBottomMiddle = 0, PosBottomRight = 1, PosUpperRight = 2, PosSidesRight = 3, PosUpperMiddle, PosBottomLeft = 5, PosSidesLeft, PosUpperLeft

◆ AddStamp()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::AddStamp ( System::SharedPtr< Stamp stamp)

Adds stamp to the file.

Parameters
stampStamp object which.

◆ ApplyStamp()

void Aspose::Pdf::Facades::PdfFileStamp::ApplyStamp ( System::SharedPtr< Stamp stamp)
protected

◆ Close()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::Close ( )
overridevirtual

Closes opened files and saves changes. Warning. If input or output streams are specified they are not closed by Close() method.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ get_AttachmentName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfFileStamp::get_AttachmentName ( ) const

Gets name of attachment when result of operation is stored into HttpResponse objects as attachment.

◆ get_ContentDisposition()

ASPOSE_PDF_SHARED_API Aspose::Pdf::ContentDisposition Aspose::Pdf::Facades::PdfFileStamp::get_ContentDisposition ( ) const

Gets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline.

◆ get_InputFile()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfFileStamp::get_InputFile ( ) const

Gets name and path of input file.

Deprecated:
Use BindPdf(inputFile) method for facade initialization.

◆ get_InputStream()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Facades::PdfFileStamp::get_InputStream ( ) const

Gets input stream.

Deprecated:
Use BindPdf(inputStream) method for facade initialization.

◆ get_KeepSecurity()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileStamp::get_KeepSecurity ( ) const

Keeps security if true. (This feature will be implemented in next versions).

◆ get_NumberingStyle()

ASPOSE_PDF_SHARED_API Aspose::Pdf::NumberingStyle Aspose::Pdf::Facades::PdfFileStamp::get_NumberingStyle ( ) const

Gets pabge numbering style. Possible values: NumeralsArabic, NumeralsRomanUppercase, NumeralsRomanLowercase, LettersAppercase, LettersLowercase

◆ get_OptimizeSize()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileStamp::get_OptimizeSize ( ) const

Gets 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.

◆ get_OutputFile()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Facades::PdfFileStamp::get_OutputFile ( ) const

Gets name and path of output file.

Deprecated:
Use Save(outputFile) method for getting facade results.

◆ get_OutputStream()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Facades::PdfFileStamp::get_OutputStream ( ) const

Gets output stream.

Deprecated:
Use Save(outputStream) method for getting facade results.

◆ get_PageHeight()

ASPOSE_PDF_SHARED_API float Aspose::Pdf::Facades::PdfFileStamp::get_PageHeight ( )

Gets height of first page in souorce file.

◆ get_PageNumberRotation()

ASPOSE_PDF_SHARED_API float Aspose::Pdf::Facades::PdfFileStamp::get_PageNumberRotation ( )

Gets rotation of page number. Rotation is in degrees. Default is 0.

◆ get_PageWidth()

ASPOSE_PDF_SHARED_API float Aspose::Pdf::Facades::PdfFileStamp::get_PageWidth ( )

Gets width of first page in input file.

◆ get_Response()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Web::HttpResponse> Aspose::Pdf::Facades::PdfFileStamp::get_Response ( ) const

Gets Response object where result of operation will be stored.

◆ get_SaveOptions()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::SaveOptions> Aspose::Pdf::Facades::PdfFileStamp::get_SaveOptions ( ) const

Gets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.

◆ get_StampId()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::get_StampId ( ) const

Stamp ID of next added stamp (incluiding page headers/hooters/page numbers).

◆ get_StartingNumber()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::get_StartingNumber ( ) const

Gets 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...

◆ Save() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::Save ( System::String  destFile)
overridevirtual

Saves result into specified file.

Parameters
destFilePath to file where document will be saved.

Reimplemented from Aspose::Pdf::Facades::SaveableFacade.

◆ Save() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::Save ( System::SharedPtr< System::IO::Stream destStream)
overridevirtual

Saves document into specified stream.

Parameters
destStreamStream where document will be saved.

Reimplemented from Aspose::Pdf::Facades::SaveableFacade.

◆ set_AttachmentName()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_AttachmentName ( System::String  value)

Sets name of attachment when result of operation is stored into HttpResponse objects as attachment.

◆ set_ContentDisposition()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_ContentDisposition ( Aspose::Pdf::ContentDisposition  value)

Sets how content will be stored when result of operation is stored into HttpResponse object. Possible value: inline / attachment. Default: inline.

◆ set_ConvertTo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_ConvertTo ( PdfFormat  value)

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.

◆ set_InputFile()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_InputFile ( System::String  value)

Sets name and path of input file.

Deprecated:
Use BindPdf(inputFile) method for facade initialization.

◆ set_InputStream()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_InputStream ( System::SharedPtr< System::IO::Stream value)

Sets input stream.

Deprecated:
Use BindPdf(inputStream) method for facade initialization.

◆ set_KeepSecurity()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_KeepSecurity ( bool  value)

Keeps security if true. (This feature will be implemented in next versions).

◆ set_NumberingStyle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_NumberingStyle ( Aspose::Pdf::NumberingStyle  value)

Sets pabge numbering style. Possible values: NumeralsArabic, NumeralsRomanUppercase, NumeralsRomanLowercase, LettersAppercase, LettersLowercase

◆ set_OptimizeSize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_OptimizeSize ( bool  value)

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.

◆ set_OutputFile()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_OutputFile ( System::String  value)

Sets name and path of output file.

Deprecated:
Use Save(outputFile) method for getting facade results.

◆ set_OutputStream()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_OutputStream ( System::SharedPtr< System::IO::Stream value)

Sets output stream.

Deprecated:
Use Save(outputStream) method for getting facade results.

◆ set_PageNumberRotation()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_PageNumberRotation ( float  value)

Sets rotation of page number. Rotation is in degrees. Default is 0.

◆ set_Response()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_Response ( System::SharedPtr< System::Web::HttpResponse value)

Sets Response object where result of operation will be stored.

◆ set_SaveOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_SaveOptions ( System::SharedPtr< Aspose::Pdf::SaveOptions value)

Sets save options when result is stored as HttpResponse. Default value: PdfSaveOptions.

◆ set_StampId()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_StampId ( int32_t  value)

Stamp ID of next added stamp (incluiding page headers/hooters/page numbers).

◆ set_StartingNumber()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileStamp::set_StartingNumber ( int32_t  value)

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...

Member Data Documentation

◆ PosBottomLeft

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::PosBottomLeft
static

Bottom left position.

◆ PosBottomMiddle

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::PosBottomMiddle
static

Bottom middle position.

◆ PosBottomRight

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::PosBottomRight
static

Bottom right position.

◆ PosSidesLeft

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::PosSidesLeft
static

Left position.

◆ PosSidesRight

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::PosSidesRight
static

Right position.

◆ PosUpperLeft

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::PosUpperLeft
static

Upper let position.

◆ PosUpperMiddle

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::PosUpperMiddle
static

Upper middle position.

◆ PosUpperRight

const ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Facades::PdfFileStamp::PosUpperRight
static

Right upper position.