Aspose::Pdf::WatermarkArtifact Class Reference
Class describes watermark artifact. This may be used to More...
#include "WatermarkArtifact.h"
Inherits Aspose::Pdf::Artifact.
Public Member Functions | |
| ASPOSE_PDF_SHARED_API | WatermarkArtifact () |
| Creates instance of Watermark artifact. More... | |
 Public Member Functions inherited from Aspose::Pdf::Artifact | |
| ASPOSE_PDF_SHARED_API System::String | get_CustomType () |
| Gets name of artifact type. May be used if artifact type is non standard. More... | |
| ASPOSE_PDF_SHARED_API void | set_CustomType (System::String value) |
| Gets name of artifact type. May be used if artifact type is non standard. More... | |
| ASPOSE_PDF_SHARED_API System::String | get_CustomSubtype () |
| Gets name of artifact subtype. May be used if artifact subtype is not standard subtype. More... | |
| ASPOSE_PDF_SHARED_API void | set_CustomSubtype (System::String value) |
| Gets name of artifact subtype. May be used if artifact subtype is not standard subtype. More... | |
| ASPOSE_PDF_SHARED_API Artifact::ArtifactType | get_Type () |
| Gets artifact type. More... | |
| ASPOSE_PDF_SHARED_API void | set_Type (Artifact::ArtifactType value) |
| Gets artifact type. More... | |
| ASPOSE_PDF_SHARED_API Artifact::ArtifactSubtype | get_Subtype () |
| Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype. More... | |
| ASPOSE_PDF_SHARED_API void | set_Subtype (Artifact::ArtifactSubtype value) |
| Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > | get_Contents () |
| Gets collection of artifact internal operators. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< XForm > | get_Form () |
| Gets XForm of the artifact (if XForm is used). More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangle > | get_Rectangle () |
| Gets rectangle of the artifact. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< Point > | get_Position () const |
| Gets artifact position. If this property is specified, then margins and alignments are ignored. More... | |
| ASPOSE_PDF_SHARED_API void | set_Position (System::SharedPtr< Point > value) |
| Sets artifact position. If this property is specified, then margins and alignments are ignored. More... | |
| ASPOSE_PDF_SHARED_API double | get_RightMargin () const |
| Right margin of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API void | set_RightMargin (double value) |
| Right margin of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API double | get_LeftMargin () const |
| Left margin of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API void | set_LeftMargin (double value) |
| Left margin of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API double | get_TopMargin () const |
| Top margin of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API void | set_TopMargin (double value) |
| Top margin of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API double | get_BottomMargin () const |
| Bottom margin of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API void | set_BottomMargin (double value) |
| Bottom margin of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API HorizontalAlignment | get_ArtifactHorizontalAlignment () const |
| Horizontal alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API void | set_ArtifactHorizontalAlignment (HorizontalAlignment value) |
| Horizontal alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API VerticalAlignment | get_ArtifactVerticalAlignment () const |
| Vertical alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API void | set_ArtifactVerticalAlignment (VerticalAlignment value) |
| Vertical alignment of artifact. If position is specified explicitly (in Position property) this value is ignored. More... | |
| ASPOSE_PDF_SHARED_API double | get_Rotation () |
| Gets artifact rotation angle. More... | |
| ASPOSE_PDF_SHARED_API void | set_Rotation (double value) |
| Sets artifact rotation angle. More... | |
| ASPOSE_PDF_SHARED_API System::String | get_Text () |
| Gets text of the artifact. More... | |
| ASPOSE_PDF_SHARED_API void | set_Text (System::String value) |
| Gets text of the artifact. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< XImage > | get_Image () |
| Gets image of the artifact (if presents). More... | |
| ASPOSE_PDF_SHARED_API double | get_Opacity () const |
| Gets opacity of the artifact. Possible values are in range 0..1. More... | |
| ASPOSE_PDF_SHARED_API void | set_Opacity (double value) |
| Sets opacity of the artifact. Possible values are in range 0..1. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::String > > | get_Lines () |
| Lines of multiline text artifact. More... | |
| ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Text::TextState > | get_TextState () const |
| Text state for artifact text. More... | |
| ASPOSE_PDF_SHARED_API void | set_TextState (System::SharedPtr< Aspose::Pdf::Text::TextState > value) |
| Text state for artifact text. More... | |
| ASPOSE_PDF_SHARED_API bool | get_IsBackground () const |
| If true Artifact is placed behind page contents. More... | |
| ASPOSE_PDF_SHARED_API void | set_IsBackground (bool value) |
| If true Artifact is placed behind page contents. More... | |
| ASPOSE_PDF_SHARED_API | Artifact (System::String type, System::String subType) |
| Constructor of artifact with specified type and subtype More... | |
| ASPOSE_PDF_SHARED_API | Artifact (Artifact::ArtifactType type, Artifact::ArtifactSubtype subType) |
| Constructor of artifact with specified type and subtype More... | |
| ASPOSE_PDF_SHARED_API void | SetText (System::SharedPtr< Facades::FormattedText > formattedText) |
| Sets text of the artifact. More... | |
| ASPOSE_PDF_SHARED_API void | SetTextAndState (System::String text, System::SharedPtr< Aspose::Pdf::Text::TextState > textState) |
| Set text and text properties of the artifact. More... | |
| ASPOSE_PDF_SHARED_API void | SetLinesAndState (System::ArrayPtr< System::String > text, System::SharedPtr< Aspose::Pdf::Text::TextState > textState) |
| Set text and text properties of the artifact. Allows to specify multiple lines. More... | |
| ASPOSE_PDF_SHARED_API void | SetImage (System::SharedPtr< System::IO::Stream > imageStream) |
| Sets image of the artifact. More... | |
| ASPOSE_PDF_SHARED_API void | SetImage (System::String imageName) |
| Sets image of the artifact. More... | |
| ASPOSE_PDF_SHARED_API void | SetPdfPage (System::SharedPtr< Page > page) |
| Sets PDF page which is placed on the document page as artifact. More... | |
| ASPOSE_PDF_SHARED_API void | Dispose () override |
| Dispose the artifact. More... | |
| ASPOSE_PDF_SHARED_API System::String | GetValue (System::String name) |
| Gets custom value of artifact. More... | |
| ASPOSE_PDF_SHARED_API void | SetValue (System::String name, System::String value) |
| Sets custom value of artifact. More... | |
| ASPOSE_PDF_SHARED_API void | RemoveValue (System::String name) |
| Remove custom value from the artifact. More... | |
| ASPOSE_PDF_SHARED_API void | BeginUpdates () |
| Start delated updates. Use this feature if you need make several changes to the same artifact to improve performance. Usually artifact operators are changed anytime when artifact property was changed. This causes changing of page contents everytime when artifact was changed. To avoid this effect put all artifact updates between StartUpdates/SaveUpdates calls. This allows to change page contents only once. More... | |
| ASPOSE_PDF_SHARED_API void | SaveUpdates () |
| Saves all updates in artifact which were made after BeginUpdates() call. 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... | |
| Object & | operator= (Object const &x) |
| Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More... | |
| Object * | SharedRefAdded () |
| 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 TypeInfo & | GetType () 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... | |
Additional Inherited Members | |
| Public Types inherited from Aspose::Pdf::Artifact | |
| enum | ArtifactType { ArtifactType::Pagination, ArtifactType::Layout, ArtifactType::Page, ArtifactType::Background, ArtifactType::Undefined } |
| Enumeration of possuble artifact types. More... | |
| enum | ArtifactSubtype { ArtifactSubtype::Header, ArtifactSubtype::Footer, ArtifactSubtype::Watermark, ArtifactSubtype::Background, ArtifactSubtype::Undefined } |
| Enumeration of possible artifacts subtype. More... | |
| Public Types inherited from System::Object | |
| typedef SmartPtr< Object > | ptr |
| 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 TypeInfo & | Type () |
| Implements C# typeof(System.Object) construct. More... | |
| Protected Attributes inherited from Aspose::Pdf::Artifact | |
| double | topMargin |
| Top margin of artifact. More... | |
| double | bottomMargin |
| Bottom margin of artifact. More... | |
| double | leftMargin |
| Left margin of artifact. More... | |
| double | rightMargin |
| Right margin of artifact. More... | |
| HorizontalAlignment | horizontalAlignment |
| Horizontal alginemt of artifact. More... | |
| VerticalAlignment | verticalAlignment |
| Vertical alignment of artifact. More... | |
| System::SharedPtr< Engine::Data::IPdfDictionary > | engineDict |
| System::WeakPtr< ArtifactCollection > | owner |
| artifacts collection to which artifact does belongs More... | |
| System::SharedPtr< System::Collections::Generic::List< System::String > > | text |
| System::SharedPtr< Aspose::Pdf::Text::TextState > | textState |
| System::SharedPtr< System::IO::Stream > | imageStream |
| double | opacity |
| Static Protected Attributes inherited from Aspose::Pdf::Artifact | |
| static System::String | AsposeTag |
Detailed Description
Class describes watermark artifact. This may be used to
Constructor & Destructor Documentation
◆ WatermarkArtifact() [1/2]
| ASPOSE_PDF_SHARED_API Aspose::Pdf::WatermarkArtifact::WatermarkArtifact | ( | ) |
Creates instance of Watermark artifact.
◆ WatermarkArtifact() [2/2]
|
protected |
Member Function Documentation
◆ Clone()
|
overrideprotectedvirtual |
Reimplemented from Aspose::Pdf::Artifact.
◆ CreateInstance()
|
overrideprotectedvirtual |
Reimplemented from Aspose::Pdf::Artifact.
◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()
|
protected |
◆ WriteSpecialInfo()
|
overrideprotectedvirtual |
Reimplemented from Aspose::Pdf::Artifact.