Reresents textual stamp. More...

Inherited by Aspose::Pdf::PageNumberStamp.

Public Member Functions
bool	get_Draw () const
	This property determines how stamp is drawn on page. If Draw = true stamp is drawn as graphic operators and if draw = false then stamp is drawn as text. More...

void	set_Draw (bool value)
	This property determines how stamp is drawn on page. If Draw = true stamp is drawn as graphic operators and if draw = false then stamp is drawn as text. More...

bool	get_TreatYIndentAsBaseLine () const
	Defines coordinate origin for placing text. If TreatYIndentAsBaseLine = true (default when Draw = true) YIndent value will be treated as text base line. If TreatYIndentAsBaseLine = false (default when Draw = false) YIndent value will be treated as bottom (descent line) of text. More...

void	set_TreatYIndentAsBaseLine (bool value)
	Defines coordinate origin for placing text. If TreatYIndentAsBaseLine = true (default when Draw = true) YIndent value will be treated as text base line. If TreatYIndentAsBaseLine = false (default when Draw = false) YIndent value will be treated as bottom (descent line) of text. More...

bool	get_WordWrap () const
	Defines word wrap. If this property set to true and Width value specified, text will be broken in the several lines to fit into specified width. Default value: false. More...

void	set_WordWrap (bool value)
	Defines word wrap. If this property set to true and Width value specified, text will be broken in the several lines to fit into specified width. Default value: false. More...

bool	get_Justify ()
	Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false. More...

void	set_Justify (bool value)
	Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false. More...

bool	get_Scale () const
	Defines scaling of the text. If this property is set to true and Width value specified, text will be scaled in order to fit to specified width. More...

void	set_Scale (bool value)
	Defines scaling of the text. If this property is set to true and Width value specified, text will be scaled in order to fit to specified width. More...

System::String	get_Value ()
	Gets string value which is used as stamp on the page. More...

void	set_Value (System::String value)
	Sets string value which is used as stamp on the page. More...

System::SharedPtr< Aspose::Pdf::Text::TextState >	get_TextState () const
	Gets text properties of the stamp. See TextState for details. More...

Aspose::Pdf::HorizontalAlignment	get_TextAlignment () const
	Alignment of the text inside the stamp. More...

void	set_TextAlignment (Aspose::Pdf::HorizontalAlignment value)
	Alignment of the text inside the stamp. More...

virtual double	get_Width ()
	Desired width of the stamp on the page. More...

virtual void	set_Width (double value)
	Desired width of the stamp on the page. More...

virtual double	get_Height ()
	Desired height of the stamp on the page. More...

virtual void	set_Height (double value)
	Desired height of the stamp on the page. More...

double	get_MaxRowWidth () const
	Max row height for WordWrap option. More...

void	set_MaxRowWidth (double value)
	Max row height for WordWrap option. More...

	TextStamp (System::String value)
	Initializes a new instance of the TextStamp class. More...

	TextStamp (System::String value, System::SharedPtr< Aspose::Pdf::Text::TextState > textState)
	Initializes a new instance of the TextStamp class. More...

virtual void	Put (System::SharedPtr< Page > page)
	Adds textual stamp on the page. More...

	TextStamp (System::SharedPtr< Facades::FormattedText > formattedText)
	Initializes a new instance of the TextStamp class with formattedText object More...

Public Member Functions inherited from Aspose::Pdf::Stamp
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...

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

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

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

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

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

double	get_OutlineWidth () const
	Gets a value of the stamp outline width. By default the value is 1.0. More...

void	set_OutlineWidth (double value)
	Sets a value of the stamp outline width. By default the value is 1.0. More...

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

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

double	get_XIndent () const
	Horizontal stamp coordinate, starting from the left. More...

void	set_XIndent (double value)
	Horizontal stamp coordinate, starting from the left. More...

double	get_YIndent () const
	Vertical stamp coordinate, starting from the bottom. More...

void	set_YIndent (double value)
	Vertical stamp coordinate, starting from the bottom. More...

Aspose::Pdf::HorizontalAlignment	get_HorizontalAlignment () const
	Gets Horizontal alignment of stamp on the page. More...

void	set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
	Sets Horizontal alignment of stamp on the page. More...

Aspose::Pdf::VerticalAlignment	get_VerticalAlignment () const
	Gets vertical alignment of stamp on page. More...

void	set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
	Sets vertical alignment of stamp on page. More...

double	get_LeftMargin () const
	Gets left margin of stamp. More...

void	set_LeftMargin (double value)
	Sets left margin of stamp. More...

double	get_RightMargin () const
	Gets right margin of stamp. More...

void	set_RightMargin (double value)
	Sets right margin of stamp. More...

double	get_BottomMargin () const
	Gets bottom margin of stamp. More...

void	set_BottomMargin (double value)
	Sets bottom margin of stamp. More...

double	get_TopMargin () const
	Gets top margin of stamp. More...

void	set_TopMargin (double value)
	Sets top margin of stamp. More...

double	get_ZoomX () const
	Horizontal zooming factor of the stamp. Allows to scale stamp horizontally. More...

void	set_ZoomX (double value)
	Horizontal zooming factor of the stamp. Allows to scale stamp horizontally. More...

double	get_ZoomY () const
	Vertical zooming factor of the stamp. Allows to scale stamp vertically. More...

void	set_ZoomY (double value)
	Vertical zooming factor of the stamp. Allows to scale stamp vertically. More...

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

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

double	get_RotateAngle ()
	Gets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. More...

void	set_RotateAngle (double value)
	Sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. More...

void	setStampId (int32_t value)
	Sets stamp Id. More...

int32_t	getStampId ()
	Returns stamp ID. More...

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

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
virtual void	ClearCache ()

virtual System::SharedPtr< Rectangle >	getRect ()
	Returns position and size of text stamp. More...

virtual System::SharedPtr< XForm >	createXForm (System::SharedPtr< Page > page)
	Creates XForm which contains operators for text output. More...

Protected Member Functions inherited from Aspose::Pdf::Stamp
System::SharedPtr< Point >	getPoint (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)

System::String	addExtGState (System::SharedPtr< Page > page)
	Add G state on the page for stamp. More...

virtual System::SharedPtr< Matrix >	getMatrix (System::SharedPtr< Page > page)
	Calculates matrix of the stamp More...

virtual System::SharedPtr< Matrix >	getStampRotationMatrix ()
	Retuns matrix which used for rotation the stamp; More...

virtual System::SharedPtr< Matrix >	getPageRotationMatrix (System::SharedPtr< Page > page)
	Returns transformation matrix for page. More...

virtual System::SharedPtr< Matrix >	getScaleMatrix ()
	Returns scaling matrix of the stamp. More...

virtual System::SharedPtr< Matrix >	getSizeMatrix ()
	This matrix used in CM operator; it's must be different for Image Stamp More...

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

Static Protected Member Functions
static System::SharedPtr< Aspose::Pdf::Text::Font >	get_DefaultFont ()

Protected Attributes
Aspose::Pdf::HorizontalAlignment	_textAlignemnt
	Alignment of the text. 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...

Static Protected Attributes
static float	DefaultFontSize

Additional Inherited Members
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...

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

Reresents textual stamp.

Constructor & Destructor Documentation

◆ TextStamp() [1/3]

Aspose::Pdf::TextStamp::TextStamp ( System::String value )

Initializes a new instance of the TextStamp class.

Parameters

value Stamp value.

◆ TextStamp() [2/3]

Aspose::Pdf::TextStamp::TextStamp	(	System::String	value,
		System::SharedPtr< Aspose::Pdf::Text::TextState >	textState
	)

Initializes a new instance of the TextStamp class.

Parameters

value	Stamp value.
textState	Stamp text state.

◆ TextStamp() [3/3]

Aspose::Pdf::TextStamp::TextStamp ( System::SharedPtr< Facades::FormattedText > formattedText )

Initializes a new instance of the TextStamp class with formattedText object

Parameters

formattedText FormattedText object which contains text of the stamp.

Member Function Documentation

◆ ClearCache()

virtual void Aspose::Pdf::TextStamp::ClearCache ( )

protectedvirtual

Reimplemented from Aspose::Pdf::Stamp.

◆ createXForm()

virtual System::SharedPtr<XForm> Aspose::Pdf::TextStamp::createXForm ( System::SharedPtr< Page > page )

protectedvirtual

Creates XForm which contains operators for text output.

Parameters

page	Page where stamp should be placed.

Returns: Created XForm.

◆ get_DefaultFont()

static System::SharedPtr<Aspose::Pdf::Text::Font> Aspose::Pdf::TextStamp::get_DefaultFont ( )

staticprotected

◆ get_Draw()

bool Aspose::Pdf::TextStamp::get_Draw ( ) const

This property determines how stamp is drawn on page. If Draw = true stamp is drawn as graphic operators and if draw = false then stamp is drawn as text.

◆ get_Height()

virtual double Aspose::Pdf::TextStamp::get_Height ( )

virtual

Desired height of the stamp on the page.

Reimplemented from Aspose::Pdf::Stamp.

◆ get_Justify()

bool Aspose::Pdf::TextStamp::get_Justify ( )

Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false.

◆ get_MaxRowWidth()

double Aspose::Pdf::TextStamp::get_MaxRowWidth ( ) const

Max row height for WordWrap option.

◆ get_Scale()

bool Aspose::Pdf::TextStamp::get_Scale ( ) const

Defines scaling of the text. If this property is set to true and Width value specified, text will be scaled in order to fit to specified width.

◆ get_TextAlignment()

Aspose::Pdf::HorizontalAlignment Aspose::Pdf::TextStamp::get_TextAlignment ( ) const

Alignment of the text inside the stamp.

◆ get_TextState()

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

Gets text properties of the stamp. See TextState for details.

◆ get_TreatYIndentAsBaseLine()

bool Aspose::Pdf::TextStamp::get_TreatYIndentAsBaseLine ( ) const

Defines coordinate origin for placing text. If TreatYIndentAsBaseLine = true (default when Draw = true) YIndent value will be treated as text base line. If TreatYIndentAsBaseLine = false (default when Draw = false) YIndent value will be treated as bottom (descent line) of text.

◆ get_Value()

System::String Aspose::Pdf::TextStamp::get_Value ( )

Gets string value which is used as stamp on the page.

◆ get_Width()

virtual double Aspose::Pdf::TextStamp::get_Width ( )

virtual

Desired width of the stamp on the page.

Reimplemented from Aspose::Pdf::Stamp.

◆ get_WordWrap()

bool Aspose::Pdf::TextStamp::get_WordWrap ( ) const

Defines word wrap. If this property set to true and Width value specified, text will be broken in the several lines to fit into specified width. Default value: false.

◆ getRect()

virtual System::SharedPtr<Rectangle> Aspose::Pdf::TextStamp::getRect ( )

protectedvirtual

Returns position and size of text stamp.

Returns: Rectangle of the stamp.

Implements Aspose::Pdf::Stamp.

◆ Put()

virtual void Aspose::Pdf::TextStamp::Put ( System::SharedPtr< Page > page )

virtual

Adds textual stamp on the page.

Parameters

page	Page for stamping.

Implements Aspose::Pdf::Stamp.

Reimplemented in Aspose::Pdf::PageNumberStamp.

◆ set_Draw()

void Aspose::Pdf::TextStamp::set_Draw ( bool value )

This property determines how stamp is drawn on page. If Draw = true stamp is drawn as graphic operators and if draw = false then stamp is drawn as text.

◆ set_Height()

virtual void Aspose::Pdf::TextStamp::set_Height ( double value )

virtual

Desired height of the stamp on the page.

Reimplemented from Aspose::Pdf::Stamp.

◆ set_Justify()

void Aspose::Pdf::TextStamp::set_Justify ( bool value )

Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false.

◆ set_MaxRowWidth()

void Aspose::Pdf::TextStamp::set_MaxRowWidth ( double value )

Max row height for WordWrap option.

◆ set_Scale()

void Aspose::Pdf::TextStamp::set_Scale ( bool value )

Defines scaling of the text. If this property is set to true and Width value specified, text will be scaled in order to fit to specified width.

◆ set_TextAlignment()

void Aspose::Pdf::TextStamp::set_TextAlignment ( Aspose::Pdf::HorizontalAlignment value )

Alignment of the text inside the stamp.

◆ set_TreatYIndentAsBaseLine()

void Aspose::Pdf::TextStamp::set_TreatYIndentAsBaseLine ( bool value )

Defines coordinate origin for placing text. If TreatYIndentAsBaseLine = true (default when Draw = true) YIndent value will be treated as text base line. If TreatYIndentAsBaseLine = false (default when Draw = false) YIndent value will be treated as bottom (descent line) of text.

◆ set_Value()

void Aspose::Pdf::TextStamp::set_Value ( System::String value )

Sets string value which is used as stamp on the page.

◆ set_Width()

virtual void Aspose::Pdf::TextStamp::set_Width ( double value )

virtual

Desired width of the stamp on the page.

Reimplemented from Aspose::Pdf::Stamp.

◆ set_WordWrap()

void Aspose::Pdf::TextStamp::set_WordWrap ( bool value )

Defines word wrap. If this property set to true and Width value specified, text will be broken in the several lines to fit into specified width. Default value: false.

Member Data Documentation

◆ _textAlignemnt

Aspose::Pdf::HorizontalAlignment Aspose::Pdf::TextStamp::_textAlignemnt

protected

Alignment of the text.

◆ DefaultFontSize

float Aspose::Pdf::TextStamp::DefaultFontSize

staticprotected

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextStamp() [1/3]

◆ TextStamp() [2/3]

◆ TextStamp() [3/3]

Member Function Documentation

◆ ClearCache()

◆ createXForm()

◆ get_DefaultFont()

◆ get_Draw()

◆ get_Height()

◆ get_Justify()

◆ get_MaxRowWidth()

◆ get_Scale()

◆ get_TextAlignment()

◆ get_TextState()

◆ get_TreatYIndentAsBaseLine()

◆ get_Value()

◆ get_Width()

◆ get_WordWrap()

◆ getRect()

◆ Put()

◆ set_Draw()

◆ set_Height()

◆ set_Justify()

◆ set_MaxRowWidth()

◆ set_Scale()

◆ set_TextAlignment()

◆ set_TreatYIndentAsBaseLine()

◆ set_Value()

◆ set_Width()

◆ set_WordWrap()

Member Data Documentation

◆ _textAlignemnt

◆ DefaultFontSize