Aspose::Pdf::PdfPageStamp Class Referencefinal

Class represents stamp which uses PDF page as stamp. More...

Inherits Aspose::Pdf::Stamp.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Pageget_PdfPage () const
 Gets page which will be used as stamp. More...
 
ASPOSE_PDF_SHARED_API void set_PdfPage (System::SharedPtr< Page > value)
 Sets page which will be used as stamp. More...
 
ASPOSE_PDF_SHARED_API PdfPageStamp (System::SharedPtr< Page > pdfPage)
 Constructor of PdfPageStamp. More...
 
ASPOSE_PDF_SHARED_API void Put (System::SharedPtr< Page > page) override
 Put stamp on the specified page. More...
 
ASPOSE_PDF_SHARED_API PdfPageStamp (System::String fileName, int32_t pageIndex)
 Creates Pdf page stamp from specifed page of the document in specified file. More...
 
ASPOSE_PDF_SHARED_API PdfPageStamp (System::SharedPtr< System::IO::Stream > stream, int32_t pageIndex)
 Creates Pdf page stamp from specifed page in the document from the stream. More...
 
- Public Member Functions inherited from Aspose::Pdf::Stamp
ASPOSE_PDF_SHARED_API bool get_Background () const
 Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. More...
 
ASPOSE_PDF_SHARED_API void set_Background (bool value)
 Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top. More...
 
ASPOSE_PDF_SHARED_API double get_Opacity () const
 Gets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. More...
 
ASPOSE_PDF_SHARED_API void set_Opacity (double value)
 Sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. More...
 
ASPOSE_PDF_SHARED_API double get_OutlineOpacity () const
 Gets a value to indicate the stamp outline opacity. The value is from 0.0 to 1.0. By default the value is 1.0. More...
 
ASPOSE_PDF_SHARED_API void set_OutlineOpacity (double value)
 Sets a value to indicate the stamp outline opacity. The value is from 0.0 to 1.0. By default the value is 1.0. More...
 
ASPOSE_PDF_SHARED_API double get_OutlineWidth () const
 Gets a value of the stamp outline width. By default the value is 1.0. More...
 
ASPOSE_PDF_SHARED_API void set_OutlineWidth (double value)
 Sets a value of the stamp outline width. By default the value is 1.0. More...
 
ASPOSE_PDF_SHARED_API Rotation get_Rotate ()
 Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. More...
 
ASPOSE_PDF_SHARED_API void set_Rotate (Rotation value)
 Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None. More...
 
ASPOSE_PDF_SHARED_API double get_XIndent () const
 Horizontal stamp coordinate, starting from the left. More...
 
ASPOSE_PDF_SHARED_API void set_XIndent (double value)
 Horizontal stamp coordinate, starting from the left. More...
 
ASPOSE_PDF_SHARED_API double get_YIndent () const
 Vertical stamp coordinate, starting from the bottom. More...
 
ASPOSE_PDF_SHARED_API void set_YIndent (double value)
 Vertical stamp coordinate, starting from the bottom. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment get_HorizontalAlignment () const
 Gets Horizontal alignment of stamp on the page. More...
 
ASPOSE_PDF_SHARED_API void set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets Horizontal alignment of stamp on the page. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::VerticalAlignment get_VerticalAlignment () const
 Gets vertical alignment of stamp on page. More...
 
ASPOSE_PDF_SHARED_API void set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
 Sets vertical alignment of stamp on page. More...
 
ASPOSE_PDF_SHARED_API double get_LeftMargin () const
 Gets left margin of stamp. More...
 
ASPOSE_PDF_SHARED_API void set_LeftMargin (double value)
 Sets left margin of stamp. More...
 
ASPOSE_PDF_SHARED_API double get_RightMargin () const
 Gets right margin of stamp. More...
 
ASPOSE_PDF_SHARED_API void set_RightMargin (double value)
 Sets right margin of stamp. More...
 
ASPOSE_PDF_SHARED_API double get_BottomMargin () const
 Gets bottom margin of stamp. More...
 
ASPOSE_PDF_SHARED_API void set_BottomMargin (double value)
 Sets bottom margin of stamp. More...
 
ASPOSE_PDF_SHARED_API double get_TopMargin () const
 Gets top margin of stamp. More...
 
ASPOSE_PDF_SHARED_API void set_TopMargin (double value)
 Sets top margin of stamp. More...
 
ASPOSE_PDF_SHARED_API double get_ZoomX () const
 Horizontal zooming factor of the stamp. Allows to scale stamp horizontally. More...
 
ASPOSE_PDF_SHARED_API void set_ZoomX (double value)
 Horizontal zooming factor of the stamp. Allows to scale stamp horizontally. More...
 
virtual ASPOSE_PDF_SHARED_API double get_Width ()
 Desired width of the stamp on the page. More...
 
virtual ASPOSE_PDF_SHARED_API void set_Width (double value)
 Desired width of the stamp on the page. More...
 
virtual ASPOSE_PDF_SHARED_API double get_Height ()
 Desired height of the stamp on the page. More...
 
virtual ASPOSE_PDF_SHARED_API void set_Height (double value)
 Desired height of the stamp on the page. More...
 
ASPOSE_PDF_SHARED_API double get_ZoomY () const
 Vertical zooming factor of the stamp. Allows to scale stamp vertically. More...
 
ASPOSE_PDF_SHARED_API void set_ZoomY (double value)
 Vertical zooming factor of the stamp. Allows to scale stamp vertically. More...
 
ASPOSE_PDF_SHARED_API double get_Zoom () const
 Zooming factor of the stamp. Allows to scale stamp. Please note that pair of properties ZoomX and ZoomY allows to set zoom factor for every axe separately. Setting of this property changes both ZoomX and ZoomY properties. If ZoomX and ZoomY are different then Zoom property returns ZoomX value. More...
 
ASPOSE_PDF_SHARED_API void set_Zoom (double value)
 Zooming factor of the stamp. Allows to scale stamp. Please note that pair of properties ZoomX and ZoomY allows to set zoom factor for every axe separately. Setting of this property changes both ZoomX and ZoomY properties. If ZoomX and ZoomY are different then Zoom property returns ZoomX value. More...
 
ASPOSE_PDF_SHARED_API double get_RotateAngle ()
 Gets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. More...
 
ASPOSE_PDF_SHARED_API void set_RotateAngle (double value)
 Sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. More...
 
ASPOSE_PDF_SHARED_API void setStampId (int32_t value)
 Sets stamp Id. More...
 
ASPOSE_PDF_SHARED_API int32_t getStampId ()
 Returns stamp ID. More...
 
ASPOSE_PDF_SHARED_API Stamp ()
 
- 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...
 

Protected Member Functions

ASPOSE_PDF_SHARED_API void ClearCache () override
 
ASPOSE_PDF_SHARED_API System::SharedPtr< RectanglegetRect () override
 Returns rectangle of stamp. More...
 
- Protected Member Functions inherited from Aspose::Pdf::Stamp
ASPOSE_PDF_SHARED_API System::SharedPtr< PointgetPoint (System::SharedPtr< Page > page)
 Returns point if the stamp on the page. More...
 
void UpdateCache (System::SharedPtr< Document > doc)
 This method checks document to which stamp is applied. If the document was changed then cached objects (for example Form XObject, Image, graphic state etc) Are cleared. This is made to avoid document damage (see for example 36049) More...
 
System::SharedPtr< Engine::Data::IPdfDictionary > GetParentResources (System::SharedPtr< Engine::Data::IPdfDictionary > dict)
 
System::SharedPtr< Engine::Data::IPdfDictionary > GetResources (System::SharedPtr< Page > page)
 
ASPOSE_PDF_SHARED_API System::String addExtGState (System::SharedPtr< Page > page)
 Add G state on the page for stamp. More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< MatrixgetMatrix (System::SharedPtr< Page > page)
 Calculates matrix of the stamp More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< MatrixgetStampRotationMatrix ()
 Retuns matrix which used for rotation the stamp; More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< MatrixgetPageRotationMatrix (System::SharedPtr< Page > page)
 Returns transformation matrix for page. More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< MatrixgetScaleMatrix ()
 Returns scaling matrix of the stamp. More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< MatrixgetSizeMatrix ()
 This matrix used in CM operator; it's must be different for Image Stamp More...
 
virtual ASPOSE_PDF_SHARED_API void drawStampOnPage (System::SharedPtr< Page > page, System::String name)
 Write operators for showing stamp to the page contents. More...
 
void updateStampId (System::SharedPtr< Engine::Data::IPdfPrimitive > instance)
 

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...
 
- Protected Attributes inherited from Aspose::Pdf::Stamp
Aspose::Pdf::HorizontalAlignment _horizontalAlignment
 Horizontal alignment of the stamp. More...
 
Aspose::Pdf::VerticalAlignment _verticalAlignment
 Vertical alignemtn of the stamp. More...
 

Detailed Description

Class represents stamp which uses PDF page as stamp.

Constructor & Destructor Documentation

◆ PdfPageStamp() [1/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::PdfPageStamp::PdfPageStamp ( System::SharedPtr< Page pdfPage)

Constructor of PdfPageStamp.

Parameters
pdfPagePage which is used for stamping.

◆ PdfPageStamp() [2/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::PdfPageStamp::PdfPageStamp ( System::String  fileName,
int32_t  pageIndex 
)

Creates Pdf page stamp from specifed page of the document in specified file.

Parameters
fileNameName and page of PDF file.
pageIndexIndex of the page.

◆ PdfPageStamp() [3/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::PdfPageStamp::PdfPageStamp ( System::SharedPtr< System::IO::Stream stream,
int32_t  pageIndex 
)

Creates Pdf page stamp from specifed page in the document from the stream.

Parameters
streamStream which contains PDF
pageIndexIndex of the page.

Member Function Documentation

◆ ClearCache()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PdfPageStamp::ClearCache ( )
overrideprotectedvirtual

Reimplemented from Aspose::Pdf::Stamp.

◆ get_PdfPage()

ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Aspose::Pdf::PdfPageStamp::get_PdfPage ( ) const

Gets page which will be used as stamp.

◆ getRect()

ASPOSE_PDF_SHARED_API System::SharedPtr<Rectangle> Aspose::Pdf::PdfPageStamp::getRect ( )
overrideprotectedvirtual

Returns rectangle of stamp.

Returns
Rectangle of PDF page stamp.

Implements Aspose::Pdf::Stamp.

◆ Put()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PdfPageStamp::Put ( System::SharedPtr< Page page)
overridevirtual

Put stamp on the specified page.

Parameters
pagePage where stamp will be placed.

Implements Aspose::Pdf::Stamp.

◆ set_PdfPage()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PdfPageStamp::set_PdfPage ( System::SharedPtr< Page value)

Sets page which will be used as stamp.