Enumeration of possible artifacts subtype. More...

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

typedef System::Details::SharedMembersType	shared_members_type
	structure to keep list of shared pointers contained in object. More...

Public Member Functions
System::String	get_CustomType ()
	Gets name of artifact type. May be used if artifact type is non standard. More...

void	set_CustomType (System::String value)
	Gets name of artifact type. May be used if artifact type is non standard. More...

System::String	get_CustomSubtype ()
	Gets name of artifact subtype. May be used if artifact subtype is not standard subtype. More...

void	set_CustomSubtype (System::String value)
	Gets name of artifact subtype. May be used if artifact subtype is not standard subtype. More...

Artifact::ArtifactType	get_Type ()
	Gets artifact type. More...

void	set_Type (Artifact::ArtifactType value)
	Gets artifact type. More...

Artifact::ArtifactSubtype	get_Subtype ()
	Gets artifact subtype. If artifact has non-standard subtype, name of the subtype may be read via CustomSubtype. More...

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

System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > >	get_Contents ()
	Gets collection of artifact internal operators. More...

System::SharedPtr< XForm >	get_Form ()
	Gets XForm of the artifact (if XForm is used). More...

System::SharedPtr< Aspose::Pdf::Rectangle >	get_Rectangle ()
	Gets rectangle of the artifact. More...

System::SharedPtr< Point >	get_Position () const
	Gets artifact position. If this property is specified, then margins and alignments are ignored. More...

void	set_Position (System::SharedPtr< Point > value)
	Sets artifact position. If this property is specified, then margins and alignments are ignored. More...

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

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

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

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

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

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

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

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

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

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

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

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

double	get_Rotation ()
	Gets articat rotatin angle. More...

void	set_Rotation (double value)
	Sets articat rotatin angle. More...

System::String	get_Text ()
	Gets text of the artifact. More...

void	set_Text (System::String value)
	Gets text of the artifact. More...

System::SharedPtr< XImage >	get_Image ()
	Gets image of the artifact (if presents). More...

double	get_Opacity () const
	Gets opacity of the artifact. Possible values are in range 0..1. More...

void	set_Opacity (double value)
	Sets opacity of the artifact. Possible values are in range 0..1. More...

bool	get_IsBackground () const
	If true Artifact is placed behind page contents. More...

void	set_IsBackground (bool value)
	If true Artifact is placed behind page contents. More...

	Artifact (System::String type, System::String subType)
	Constructor of artifact with specified type and subtype More...

	Artifact (Artifact::ArtifactType type, Artifact::ArtifactSubtype subType)
	Constructor of artifact with specified type and subtype More...

void	SetText (System::SharedPtr< Facades::FormattedText > formattedText)
	Sets text of the artifact. More...

void	SetTextAndState (System::String text, System::SharedPtr< Text::TextState > textState)
	Set text and text properties of the artifact. More...

void	SetLinesAndState (System::ArrayPtr< System::String > text, System::SharedPtr< Text::TextState > textState)
	Set text and text properties of the artifact. Allows to specify multiple lines. More...

void	SetImage (System::SharedPtr< System::IO::Stream > imageStream)
	Sets image of the artifact. More...

void	SetImage (System::String imageName)
	Sets image of the artifact. More...

void	SetPdfPage (System::SharedPtr< Page > page)
	Sets PDF page which is placed on the document page as artifact. More...

void	Dispose ()
	Dispose the artifact. More...

System::String	GetValue (System::String name)
	Gets custom value of artifact. More...

void	SetValue (System::String name, System::String value)
	Sets custom value of artifact. More...

void	RemoveValue (System::String name)
	Remove custom value from the artifact. More...

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

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 refernce 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 int	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 (unsigned int argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

template<>
bool	Equals (float const &objA, float const &objB)

template<>
bool	Equals (double const &objA, double const &objB)

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)

template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Protected Member Functions
System::SharedPtr< Aspose::Pdf::Matrix >	get_Matrix ()

System::String	get_Tag () const

System::String	get_Name ()

System::SharedPtr< ArtifactCollection >	get_Owner () const

void	set_Owner (System::SharedPtr< ArtifactCollection > value)

System::SharedPtr< Aspose::Pdf::Resources >	get_Resources ()

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

System::SharedPtr< Engine::Data::IPdfDictionary >	get_EngineDict ()

System::SharedPtr< System::IO::Stream >	get_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...

System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > >	GetContents ()
	Generates operators of artifact contents. More...

virtual System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator > > >	GetOperators ()
	Gets operators inside the artifact. More...

virtual void	WriteSpecialInfo (System::SharedPtr< XForm > form)

virtual void	ModifyContents (System::SharedPtr< OperatorCollection > contents)

virtual System::SharedPtr< Artifact >	CreateInstance ()

System::SharedPtr< Artifact >	LowLevelClone ()
	Clones artifact on "low level" i.e. only set of operators without analysis More...

virtual System::SharedPtr< Artifact >	Clone ()

virtual	~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< ArtifactCollection >	owner
	artifacts collection to which artifact does belongs More...

System::SharedPtr< System::Collections::Generic::List< System::String > >	text

System::SharedPtr< Text::TextState >	textState

System::SharedPtr< System::IO::Stream >	imageStream

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 TypeInfo &	Type ()
	Impleemnts C# typeof(System.Object) construct. More...

Detailed Description

Enumeration of possible artifacts subtype.

Member Enumeration Documentation

◆ ArtifactSubtype

enum Aspose::Pdf::Artifact::ArtifactSubtype

strong

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

enum Aspose::Pdf::Artifact::ArtifactType

strong

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::Artifact::Artifact	(	System::String	type,
		System::String	subType
	)

Constructor of artifact with specified type and subtype

Parameters

type	Name of artifact type.
subType	NAme of artifact subtype.

◆ Artifact() [2/3]

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

Constructor of artifact with specified type and subtype

Parameters

type	Artifact type.
subType	Artifact 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::Artifact::~Artifact ( )

protectedvirtual

Member Function Documentation

◆ BeginUpdates()

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.

Artifact art = doc.Pages[1].Artifacts[1];
art.BeginUpdates();
art.Opacity = 0.3f;
art.Position = new Point(10,10);
art.Rotation = 30;
art.SaveUpdates();

◆ Clone()

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

protectedvirtual

Reimplemented in Aspose::Pdf::BackgroundArtifact, and Aspose::Pdf::WatermarkArtifact.

◆ CreateInstance()

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

protectedvirtual

Reimplemented in Aspose::Pdf::BackgroundArtifact, Aspose::Pdf::WatermarkArtifact, Aspose::Pdf::FooterArtifact, and Aspose::Pdf::HeaderArtifact.

◆ Dispose()

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

virtual

Dispose the artifact.

Reimplemented from System::IDisposable.

◆ get_ArtifactHorizontalAlignment()

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()

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()

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()

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

Gets collection of artifact internal operators.

◆ get_CustomSubtype()

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

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

◆ get_CustomType()

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()

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

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

◆ get_Image()

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()

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

If true Artifact is placed behind page contents.

◆ get_LeftMargin()

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

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

◆ 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()

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()

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()

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 ( )

protected

◆ get_RightMargin()

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()

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

Gets articat rotatin angle.

◆ get_Subtype()

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()

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

Gets text of the artifact.

◆ get_TopMargin()

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()

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 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()

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

Gets custom value of artifact.

Parameters

name	Name 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

◆ ModifyContents()

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

protectedvirtual

Reimplemented in Aspose::Pdf::BackgroundArtifact.

◆ RemoveValue()

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

Remove custom value from the artifact.

Parameters

name	Name of custom value to be removed.

◆ SaveUpdates()

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

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

◆ set_ArtifactHorizontalAlignment()

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()

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()

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()

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()

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()

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

If true Artifact is placed behind page contents.

◆ set_LeftMargin()

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()

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()

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()

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()

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

Sets articat rotatin angle.

◆ set_Subtype()

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()

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

Gets text of the artifact.

◆ set_TopMargin()

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()

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

Gets artifact type.

◆ SetImage() [1/2]

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

Sets image of the artifact.

Parameters

imageStream Stream which contains image data.

◆ SetImage() [2/2]

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

Sets image of the artifact.

Parameters

imageName Name of image file.

◆ SetLinesAndState()

void Aspose::Pdf::Artifact::SetLinesAndState	(	System::ArrayPtr< System::String >	text,
		System::SharedPtr< Text::TextState >	textState
	)

Set text and text properties of the artifact. Allows to specify multiple lines.

Parameters

text	Array of text string.
textState	Text properties.

◆ SetPdfPage()

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

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

Parameters

page	Page which is placed as Artifcact.

◆ SetText()

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

Sets text of the artifact.

Parameters

formattedText FormattedText object which contains artifact text.

◆ SetTextAndState()

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

Set text and text properties of the artifact.

Parameters

Text	Text string.
textState	Text properties (color,

◆ SetValue()

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

Sets custom value of artifact.

Parameters

name	Name of custom value.
value	Custom value in the artifact.

◆ WriteSpecialInfo()

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ArtifactSubtype

◆ ArtifactType

Constructor & Destructor Documentation

◆ Artifact() [1/3]

◆ Artifact() [2/3]

◆ Artifact() [3/3]

◆ ~Artifact()

Member Function Documentation

◆ BeginUpdates()

◆ Clone()

◆ CreateInstance()

◆ Dispose()

◆ get_ArtifactHorizontalAlignment()

◆ get_ArtifactVerticalAlignment()

◆ get_BottomMargin()

◆ get_Contents()

◆ get_CustomSubtype()

◆ get_CustomType()

◆ get_EngineDict()

◆ get_Form()

◆ get_Image()

◆ get_ImageStream()

◆ get_IsBackground()

◆ get_LeftMargin()

◆ get_Matrix()

◆ get_Name()

◆ get_Opacity()

◆ get_Owner()

◆ get_Position()

◆ get_Rectangle()

◆ get_Resources()

◆ get_RightMargin()

◆ get_Rotation()

◆ get_Subtype()

◆ get_Tag()

◆ get_Text()

◆ get_TopMargin()

◆ get_Type()

◆ GetContents()

◆ GetOperators()

◆ GetValue()

◆ LowLevelClone()

◆ ModifyContents()

◆ RemoveValue()

◆ SaveUpdates()

◆ set_ArtifactHorizontalAlignment()

◆ set_ArtifactVerticalAlignment()

◆ set_BottomMargin()

◆ set_CustomSubtype()

◆ set_CustomType()

◆ set_IsBackground()

◆ set_LeftMargin()

◆ set_Opacity()

◆ set_Owner()

◆ set_Position()

◆ set_Resources()

◆ set_RightMargin()

◆ set_Rotation()

◆ set_Subtype()

◆ set_Text()

◆ set_TopMargin()

◆ set_Type()

◆ SetImage() [1/2]

◆ SetImage() [2/2]

◆ SetLinesAndState()

◆ SetPdfPage()

◆ SetText()

◆ SetTextAndState()

◆ SetValue()

◆ WriteSpecialInfo()

Member Data Documentation