Class represents PDF Artifact object. More...

#include "Artifact.h"

Inherits System::IDisposable.

Inherited by Aspose::Pdf::BackgroundArtifact, Aspose::Pdf::FooterArtifact, Aspose::Pdf::HeaderArtifact, and Aspose::Pdf::WatermarkArtifact.

Classes

class  ArtifactContext
 This class describes state of page (Matrix, selected font etc.) More...
 
class  TextAttributes
 Contains text attributes in original artifact More...
 

Public Types

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< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

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< XFormget_Form ()
 Gets XForm of the artifact (if XForm is used). More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangleget_Rectangle ()
 Gets rectangle of the artifact. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Pointget_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< XImageget_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::TextStateget_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...
 
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

System::SharedPtr< Aspose::Pdf::Matrixget_Matrix ()
 
System::String get_Tag () const
 
System::String get_Name ()
 
System::SharedPtr< ArtifactCollectionget_Owner () const
 
void set_Owner (System::SharedPtr< ArtifactCollection > value)
 
System::SharedPtr< Aspose::Pdf::Resourcesget_Resources () const
 
void set_Resources (System::SharedPtr< Aspose::Pdf::Resources > value)
 
System::SharedPtr< Engine::Data::IPdfDictionary > get_EngineDict ()
 
System::SharedPtr< System::IO::Streamget_ImageStream ()
 
 Artifact (System::SharedPtr< ArtifactCollection > owner, System::SharedPtr< Artifact::ArtifactContext > context, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> _contents, System::SharedPtr< Engine::Data::IPdfDictionary > _properties)
 This constructor is used when artifact is read from the page. ARtifactCollection passes page resources, initial matrix, operators of the artifact ("contents") and properties dictionary. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Artifact, CODEPORTING_ARGS(System::SharedPtr< ArtifactCollection > owner, System::SharedPtr< Artifact::ArtifactContext > context, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> _contents, System::SharedPtr< Engine::Data::IPdfDictionary > _properties))
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > GetContents ()
 Generates operators of artifact contents. More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > > GetOperators ()
 Gets operators inside the artifact. More...
 
virtual ASPOSE_PDF_SHARED_API void WriteSpecialInfo (System::SharedPtr< XForm > form)
 
virtual ASPOSE_PDF_SHARED_API void ModifyContents (System::SharedPtr< OperatorCollection > contents)
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< ArtifactCreateInstance ()
 
System::SharedPtr< ArtifactLowLevelClone ()
 Clones artifact on "low level" i.e. only set of operators without analysis More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< ArtifactClone ()
 
virtual ASPOSE_PDF_SHARED_API ~Artifact ()
 

Protected Attributes

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< ArtifactCollectionowner
 artifacts collection to which artifact does belongs More...
 
System::SharedPtr< System::Collections::Generic::List< System::String > > text
 
System::SharedPtr< Aspose::Pdf::Text::TextStatetextState
 
System::SharedPtr< System::IO::StreamimageStream
 
double opacity
 

Static Protected Attributes

static System::String AsposeTag
 

Additional Inherited Members

- 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 represents PDF Artifact object.

Member Enumeration Documentation

◆ ArtifactSubtype

Enumeration of possible artifacts subtype.

Enumerator
Header 

Header artifact.

Footer 

Footer artifact.

Watermark 

Watermark artifact.

Background 

Background artifact.

Undefined 

Artifact subtype is not defined or unknown.

◆ ArtifactType

Enumeration of possuble artifact types.

Enumerator
Pagination 

Pagination artifacts. Ancillary page features such as running heads and folios (page numbers).

Layout 

Layout artifacts. Purely cosmetic typographical or design elements such as footnote rules or background screens.

Page 

Page artifacts. Production aids extraneous to the document itself, such as cut marks and colour bars.

Background 

Background artifacts. Images, patterns or coloured blocks.

Undefined 

Artifact type is not defined or unknown.

Constructor & Destructor Documentation

◆ Artifact() [1/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Artifact::Artifact ( System::String  type,
System::String  subType 
)

Constructor of artifact with specified type and subtype

Parameters
typeName of artifact type.
subTypeNAme of artifact subtype.

◆ Artifact() [2/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Artifact::Artifact ( Artifact::ArtifactType  type,
Artifact::ArtifactSubtype  subType 
)

Constructor of artifact with specified type and subtype

Parameters
typeArtifact type.
subTypeArtifact subtype.

◆ Artifact() [3/3]

Aspose::Pdf::Artifact::Artifact ( System::SharedPtr< ArtifactCollection owner,
System::SharedPtr< Artifact::ArtifactContext context,
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>>  _contents,
System::SharedPtr< Engine::Data::IPdfDictionary >  _properties 
)
protected

This constructor is used when artifact is read from the page. ARtifactCollection passes page resources, initial matrix, operators of the artifact ("contents") and properties dictionary.

Parameters
owner
resources
matrix
_contents
_properties

◆ ~Artifact()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::Artifact::~Artifact ( )
protectedvirtual

Member Function Documentation

◆ BeginUpdates()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::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.

◆ Clone()

virtual ASPOSE_PDF_SHARED_API System::SharedPtr<Artifact> Aspose::Pdf::Artifact::Clone ( )
protectedvirtual

◆ CreateInstance()

virtual ASPOSE_PDF_SHARED_API System::SharedPtr<Artifact> Aspose::Pdf::Artifact::CreateInstance ( )
protectedvirtual

◆ Dispose()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::Dispose ( )
overridevirtual

Dispose the artifact.

Reimplemented from System::IDisposable.

◆ get_ArtifactHorizontalAlignment()

ASPOSE_PDF_SHARED_API HorizontalAlignment Aspose::Pdf::Artifact::get_ArtifactHorizontalAlignment ( ) const

Horizontal alignment of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ get_ArtifactVerticalAlignment()

ASPOSE_PDF_SHARED_API VerticalAlignment Aspose::Pdf::Artifact::get_ArtifactVerticalAlignment ( ) const

Vertical alignment of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ get_BottomMargin()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Artifact::get_BottomMargin ( ) const

Bottom margin of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ get_Contents()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Artifact::get_Contents ( )

Gets collection of artifact internal operators.

◆ get_CustomSubtype()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Artifact::get_CustomSubtype ( )

Gets name of artifact subtype. May be used if artifact subtype is not standard subtype.

◆ get_CustomType()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Artifact::get_CustomType ( )

Gets name of artifact type. May be used if artifact type is non standard.

◆ get_EngineDict()

System::SharedPtr<Engine::Data::IPdfDictionary> Aspose::Pdf::Artifact::get_EngineDict ( )
protected

◆ get_Form()

ASPOSE_PDF_SHARED_API System::SharedPtr<XForm> Aspose::Pdf::Artifact::get_Form ( )

Gets XForm of the artifact (if XForm is used).

◆ get_Image()

ASPOSE_PDF_SHARED_API System::SharedPtr<XImage> Aspose::Pdf::Artifact::get_Image ( )

Gets image of the artifact (if presents).

◆ get_ImageStream()

System::SharedPtr<System::IO::Stream> Aspose::Pdf::Artifact::get_ImageStream ( )
protected

◆ get_IsBackground()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Artifact::get_IsBackground ( ) const

If true Artifact is placed behind page contents.

◆ get_LeftMargin()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Artifact::get_LeftMargin ( ) const

Left margin of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ get_Lines()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::String> > Aspose::Pdf::Artifact::get_Lines ( )

Lines of multiline text artifact.

◆ get_Matrix()

System::SharedPtr<Aspose::Pdf::Matrix> Aspose::Pdf::Artifact::get_Matrix ( )
protected

◆ get_Name()

System::String Aspose::Pdf::Artifact::get_Name ( )
protected

◆ get_Opacity()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Artifact::get_Opacity ( ) const

Gets opacity of the artifact. Possible values are in range 0..1.

◆ get_Owner()

System::SharedPtr<ArtifactCollection> Aspose::Pdf::Artifact::get_Owner ( ) const
protected

◆ get_Position()

ASPOSE_PDF_SHARED_API System::SharedPtr<Point> Aspose::Pdf::Artifact::get_Position ( ) const

Gets artifact position. If this property is specified, then margins and alignments are ignored.

◆ get_Rectangle()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Artifact::get_Rectangle ( )

Gets rectangle of the artifact.

◆ get_Resources()

System::SharedPtr<Aspose::Pdf::Resources> Aspose::Pdf::Artifact::get_Resources ( ) const
protected

◆ get_RightMargin()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Artifact::get_RightMargin ( ) const

Right margin of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ get_Rotation()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Artifact::get_Rotation ( )

Gets artifact rotation angle.

◆ get_Subtype()

ASPOSE_PDF_SHARED_API Artifact::ArtifactSubtype Aspose::Pdf::Artifact::get_Subtype ( )

Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype.

◆ get_Tag()

System::String Aspose::Pdf::Artifact::get_Tag ( ) const
protected

◆ get_Text()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Artifact::get_Text ( )

Gets text of the artifact.

◆ get_TextState()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Text::TextState> Aspose::Pdf::Artifact::get_TextState ( ) const

Text state for artifact text.

◆ get_TopMargin()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Artifact::get_TopMargin ( ) const

Top margin of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ get_Type()

ASPOSE_PDF_SHARED_API Artifact::ArtifactType Aspose::Pdf::Artifact::get_Type ( )

Gets artifact type.

◆ GetContents()

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Artifact::GetContents ( )
protected

Generates operators of artifact contents.

Returns
List of artifact operators.

◆ GetOperators()

virtual ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Operator> > > Aspose::Pdf::Artifact::GetOperators ( )
protectedvirtual

Gets operators inside the artifact.

Returns
List of operators in the artifact.

Reimplemented in Aspose::Pdf::BackgroundArtifact.

◆ GetValue()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Artifact::GetValue ( System::String  name)

Gets custom value of artifact.

Parameters
nameName of value.
Returns
Value, or null if value does not exists.

◆ LowLevelClone()

System::SharedPtr<Artifact> Aspose::Pdf::Artifact::LowLevelClone ( )
protected

Clones artifact on "low level" i.e. only set of operators without analysis

Returns

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Artifact::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( Artifact  ,
CODEPORTING_ARGS(System::SharedPtr< ArtifactCollection > owner, System::SharedPtr< Artifact::ArtifactContext > context, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> _contents, System::SharedPtr< Engine::Data::IPdfDictionary > _properties)   
)
protected

◆ ModifyContents()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::ModifyContents ( System::SharedPtr< OperatorCollection contents)
protectedvirtual

◆ RemoveValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::RemoveValue ( System::String  name)

Remove custom value from the artifact.

Parameters
nameName of custom value to be removed.

◆ SaveUpdates()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::SaveUpdates ( )

Saves all updates in artifact which were made after BeginUpdates() call.

◆ set_ArtifactHorizontalAlignment()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_ArtifactHorizontalAlignment ( HorizontalAlignment  value)

Horizontal alignment of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ set_ArtifactVerticalAlignment()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_ArtifactVerticalAlignment ( VerticalAlignment  value)

Vertical alignment of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ set_BottomMargin()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_BottomMargin ( double  value)

Bottom margin of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ set_CustomSubtype()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_CustomSubtype ( System::String  value)

Gets name of artifact subtype. May be used if artifact subtype is not standard subtype.

◆ set_CustomType()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_CustomType ( System::String  value)

Gets name of artifact type. May be used if artifact type is non standard.

◆ set_IsBackground()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_IsBackground ( bool  value)

If true Artifact is placed behind page contents.

◆ set_LeftMargin()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_LeftMargin ( double  value)

Left margin of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ set_Opacity()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_Opacity ( double  value)

Sets opacity of the artifact. Possible values are in range 0..1.

◆ set_Owner()

void Aspose::Pdf::Artifact::set_Owner ( System::SharedPtr< ArtifactCollection value)
protected

◆ set_Position()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_Position ( System::SharedPtr< Point value)

Sets artifact position. If this property is specified, then margins and alignments are ignored.

◆ set_Resources()

void Aspose::Pdf::Artifact::set_Resources ( System::SharedPtr< Aspose::Pdf::Resources value)
protected

◆ set_RightMargin()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_RightMargin ( double  value)

Right margin of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ set_Rotation()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_Rotation ( double  value)

Sets artifact rotation angle.

◆ set_Subtype()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_Subtype ( Artifact::ArtifactSubtype  value)

Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype.

◆ set_Text()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_Text ( System::String  value)

Gets text of the artifact.

◆ set_TextState()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_TextState ( System::SharedPtr< Aspose::Pdf::Text::TextState value)

Text state for artifact text.

◆ set_TopMargin()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_TopMargin ( double  value)

Top margin of artifact. If position is specified explicitly (in Position property) this value is ignored.

◆ set_Type()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::set_Type ( Artifact::ArtifactType  value)

Gets artifact type.

◆ SetImage() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::SetImage ( System::SharedPtr< System::IO::Stream imageStream)

Sets image of the artifact.

Parameters
imageStreamStream which contains image data.

◆ SetImage() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::SetImage ( System::String  imageName)

Sets image of the artifact.

Parameters
imageNameName of image file.

◆ SetLinesAndState()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::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.

Parameters
textArray of text string.
textStateText properties.

◆ SetPdfPage()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::SetPdfPage ( System::SharedPtr< Page page)

Sets PDF page which is placed on the document page as artifact.

Parameters
pagePage which is placed as Artifcact.

◆ SetText()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::SetText ( System::SharedPtr< Facades::FormattedText formattedText)

Sets text of the artifact.

Parameters
formattedTextFormattedText object which contains artifact text.

◆ SetTextAndState()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::SetTextAndState ( System::String  text,
System::SharedPtr< Aspose::Pdf::Text::TextState textState 
)

Set text and text properties of the artifact.

Parameters
textText string.
textStateText state.

◆ SetValue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::SetValue ( System::String  name,
System::String  value 
)

Sets custom value of artifact.

Parameters
nameName of custom value.
valueCustom value in the artifact.

◆ WriteSpecialInfo()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Artifact::WriteSpecialInfo ( System::SharedPtr< XForm form)
protectedvirtual

Reimplemented in Aspose::Pdf::WatermarkArtifact.

Member Data Documentation

◆ AsposeTag

System::String Aspose::Pdf::Artifact::AsposeTag
staticprotected

◆ bottomMargin

double Aspose::Pdf::Artifact::bottomMargin
protected

Bottom margin of artifact.

◆ engineDict

System::SharedPtr<Engine::Data::IPdfDictionary> Aspose::Pdf::Artifact::engineDict
protected

◆ horizontalAlignment

HorizontalAlignment Aspose::Pdf::Artifact::horizontalAlignment
protected

Horizontal alginemt of artifact.

◆ imageStream

System::SharedPtr<System::IO::Stream> Aspose::Pdf::Artifact::imageStream
protected

◆ leftMargin

double Aspose::Pdf::Artifact::leftMargin
protected

Left margin of artifact.

◆ opacity

double Aspose::Pdf::Artifact::opacity
protected

◆ owner

System::WeakPtr<ArtifactCollection> Aspose::Pdf::Artifact::owner
protected

artifacts collection to which artifact does belongs

◆ rightMargin

double Aspose::Pdf::Artifact::rightMargin
protected

Right margin of artifact.

◆ text

System::SharedPtr<System::Collections::Generic::List<System::String> > Aspose::Pdf::Artifact::text
protected

◆ textState

System::SharedPtr<Aspose::Pdf::Text::TextState> Aspose::Pdf::Artifact::textState
protected

◆ topMargin

double Aspose::Pdf::Artifact::topMargin
protected

Top margin of artifact.

◆ verticalAlignment

VerticalAlignment Aspose::Pdf::Artifact::verticalAlignment
protected

Vertical alignment of artifact.