Class representing characteristics of annotation border. More...

#include "Border.h"

Public Member Functions
ASPOSE_PDF_SHARED_API double	get_HCornerRadius ()
	Gets horizontal corner radius. More...

ASPOSE_PDF_SHARED_API void	set_HCornerRadius (double value)
	Sets horizontal corner radius. More...

ASPOSE_PDF_SHARED_API double	get_VCornerRadius ()
	Gets vertical corner radius. More...

ASPOSE_PDF_SHARED_API void	set_VCornerRadius (double value)
	Sets vertical corner radius. More...

ASPOSE_PDF_SHARED_API int32_t	get_Width ()
	Gets border width. More...

ASPOSE_PDF_SHARED_API void	set_Width (int32_t value)
	Sets border width. More...

ASPOSE_PDF_SHARED_API int32_t	get_EffectIntensity () const
	Gets effect intencity. Valid range of value is [0..2]. More...

ASPOSE_PDF_SHARED_API void	set_EffectIntensity (int32_t value)
	Sets effect intencity. Valid range of value is [0..2]. More...

ASPOSE_PDF_SHARED_API BorderStyle	get_Style ()
	Gets border style. More...

ASPOSE_PDF_SHARED_API void	set_Style (BorderStyle value)
	Sets border style. More...

ASPOSE_PDF_SHARED_API BorderEffect	get_Effect () const
	Gets border effect. More...

ASPOSE_PDF_SHARED_API void	set_Effect (BorderEffect value)
	Sets border effect. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Annotations::Dash >	get_Dash () const
	Gets dash pattern. More...

ASPOSE_PDF_SHARED_API void	set_Dash (System::SharedPtr< Aspose::Pdf::Annotations::Dash > value)
	Sets dash pattern. More...

ASPOSE_PDF_SHARED_API	Border (System::SharedPtr< Annotation > parent)
	Constructor for border object. 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...

Protected Member Functions
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray >	get_BorderArray () const

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

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >	get_EngineDictBE () const

void	WriteXfdfAttributes (System::SharedPtr< System::Xml::XmlWriter > writer)

void	WriteXfdfEffectAttributes (System::SharedPtr< System::Xml::XmlWriter > writer)
	Writes attributes of effect property. Intensity value is being written only for cloudy type of effect. More...

void	ReadXfdfAttributes (System::SharedPtr< System::Xml::XmlReader > reader)

	Border (System::SharedPtr< Annotation > owner, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation)
	constructor of Border class. More...

	MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Border, CODEPORTING_ARGS(System::SharedPtr< Annotation > owner, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation))

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >	createBorder (System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > page)
	Creates PDF object which describes the Border. More...

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >	GetEngineDict ()

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >	GetEngineDictBE ()

Protected Attributes
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >	_enginePrim

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

Detailed Description

Class representing characteristics of annotation border.

Constructor & Destructor Documentation

◆ Border() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::Border::Border ( System::SharedPtr< Annotation > parent )

Constructor for border object.

Parameters

parent Parent annotation.

◆ Border() [2/2]

Aspose::Pdf::Annotations::Border::Border	(	System::SharedPtr< Annotation >	owner,
		System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >	annotation
	)

protected

constructor of Border class.

Parameters

annotation PDf object which describes annotation.

Member Function Documentation

◆ createBorder()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::Border::createBorder ( System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > page )

protected

Creates PDF object which describes the Border.

Parameters

page	Page where annotation which used this border is placed.

Returns: PDF dictionary which contains border property.

◆ get_BorderArray()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfArray> Aspose::Pdf::Annotations::Border::get_BorderArray ( ) const

protected

◆ get_Dash()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Annotations::Dash> Aspose::Pdf::Annotations::Border::get_Dash ( ) const

Gets dash pattern.

◆ get_Effect()

ASPOSE_PDF_SHARED_API BorderEffect Aspose::Pdf::Annotations::Border::get_Effect ( ) const

Gets border effect.

BorderEffect

◆ get_EffectIntensity()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::Border::get_EffectIntensity ( ) const

Gets effect intencity. Valid range of value is [0..2].

◆ get_EngineDict()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::Border::get_EngineDict ( )

protected

◆ get_EngineDictBE()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::Border::get_EngineDictBE ( ) const

protected

◆ get_HCornerRadius()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::Border::get_HCornerRadius ( )

Gets horizontal corner radius.

◆ get_Style()

ASPOSE_PDF_SHARED_API BorderStyle Aspose::Pdf::Annotations::Border::get_Style ( )

Gets border style.

BorderStyle

◆ get_VCornerRadius()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::Border::get_VCornerRadius ( )

Gets vertical corner radius.

◆ get_Width()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::Border::get_Width ( )

Gets border width.

◆ GetEngineDict()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::Border::GetEngineDict ( )

protected

◆ GetEngineDictBE()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::Border::GetEngineDictBE ( )

protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Annotations::Border::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION	(	Border	,
		CODEPORTING_ARGS(System::SharedPtr< Annotation > owner, System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > annotation)
	)

protected

◆ ReadXfdfAttributes()

void Aspose::Pdf::Annotations::Border::ReadXfdfAttributes ( System::SharedPtr< System::Xml::XmlReader > reader )

protected

◆ set_Dash()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Border::set_Dash ( System::SharedPtr< Aspose::Pdf::Annotations::Dash > value )

Sets dash pattern.

◆ set_Effect()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Border::set_Effect ( BorderEffect value )

Sets border effect.

BorderEffect

◆ set_EffectIntensity()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Border::set_EffectIntensity ( int32_t value )

Sets effect intencity. Valid range of value is [0..2].

◆ set_HCornerRadius()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Border::set_HCornerRadius ( double value )

Sets horizontal corner radius.

◆ set_Style()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Border::set_Style ( BorderStyle value )

Sets border style.

BorderStyle

◆ set_VCornerRadius()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Border::set_VCornerRadius ( double value )

Sets vertical corner radius.

◆ set_Width()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Border::set_Width ( int32_t value )

Sets border width.

◆ WriteXfdfAttributes()

void Aspose::Pdf::Annotations::Border::WriteXfdfAttributes ( System::SharedPtr< System::Xml::XmlWriter > writer )

protected

◆ WriteXfdfEffectAttributes()

void Aspose::Pdf::Annotations::Border::WriteXfdfEffectAttributes ( System::SharedPtr< System::Xml::XmlWriter > writer )

protected

Writes attributes of effect property. Intensity value is being written only for cloudy type of effect.

Parameters

writer Xml writer.

Member Data Documentation

◆ _enginePrim

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::Border::_enginePrim

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Border() [1/2]

◆ Border() [2/2]

Member Function Documentation

◆ createBorder()

◆ get_BorderArray()

◆ get_Dash()

◆ get_Effect()

◆ get_EffectIntensity()

◆ get_EngineDict()

◆ get_EngineDictBE()

◆ get_HCornerRadius()

◆ get_Style()

◆ get_VCornerRadius()

◆ get_Width()

◆ GetEngineDict()

◆ GetEngineDictBE()

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

◆ ReadXfdfAttributes()

◆ set_Dash()

◆ set_Effect()

◆ set_EffectIntensity()

◆ set_HCornerRadius()

◆ set_Style()

◆ set_VCornerRadius()

◆ set_Width()

◆ WriteXfdfAttributes()

◆ WriteXfdfEffectAttributes()

Member Data Documentation

◆ _enginePrim