Represents a FloatingBox in a Pdf document. FloatingBox is custom positioned. More...

Inherits Aspose::Pdf::BaseParagraph.

Public Member Functions
System::SharedPtr< Aspose::Pdf::ColumnInfo >	get_ColumnInfo () const
	Gets a column info More...

void	set_ColumnInfo (System::SharedPtr< Aspose::Pdf::ColumnInfo > value)
	Sets a column info More...

double	get_Width () const
	Gets a float value that indicates the width of the floating box. More...

void	set_Width (double value)
	Sets a float value that indicates the width of the floating box. More...

double	get_Height () const
	Gets a float value that indicates the height of the floating box. More...

void	set_Height (double value)
	Sets a float value that indicates the height of the floating box. More...

bool	get_IsNeedRepeating () const
	Gets a bool value that indicates whether the paragraph need to be repeated on next page. Default value is false.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows. More...

void	set_IsNeedRepeating (bool value)
	Sets a bool value that indicates whether the paragraph need to be repeated on next page. Default value is false.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows. More...

System::SharedPtr< Aspose::Pdf::Paragraphs >	get_Paragraphs () const
	Gets a Paragraphs collection that indicates all paragraphs in the cell. More...

void	set_Paragraphs (System::SharedPtr< Aspose::Pdf::Paragraphs > value)
	Sets a Paragraphs collection that indicates all paragraphs in the cell. More...

System::SharedPtr< BorderInfo >	get_Border () const
	Gets a BorderInfo object that indicates the border info of the floating box. More...

void	set_Border (System::SharedPtr< BorderInfo > value)
	Sets a BorderInfo object that indicates the border info of the floating box. More...

System::SharedPtr< Color >	get_BackgroundColor () const
	Gets a Aspose::Pdf::Color object that indicates the background color of the floating box. More...

void	set_BackgroundColor (System::SharedPtr< Color > value)
	Sets a Aspose::Pdf::Color object that indicates the background color of the floating box. More...

System::SharedPtr< Image >	get_BackgroundImage () const
	Gets background image for page (for generator only). More...

void	set_BackgroundImage (System::SharedPtr< Image > value)
	Sets background image for page (for generator only). More...

System::SharedPtr< MarginInfo >	get_Padding () const
	Gets a MarginInfo object that indicates the padding of the floating box. More...

void	set_Padding (System::SharedPtr< MarginInfo > value)
	Sets a MarginInfo object that indicates the padding of the floating box. More...

double	get_Left () const
	Gets the table left coordinate. More...

void	set_Left (double value)
	Sets the table left coordinate. More...

double	get_Top () const
	Gets the table top coordinate. More...

void	set_Top (double value)
	Sets the table top coordinate. More...

	FloatingBox (float width, float height)
	Initializes a new instance of the FloatingBox class with specified width and height. More...

	FloatingBox ()
	Initializes a new instance of the FloatingBox class. More...

virtual System::SharedPtr< System::Object >	Clone ()
	Clones a new FloatingBox object. Paragraphs in the floating box are not cloned. More...

Public Member Functions inherited from Aspose::Pdf::BaseParagraph
virtual Aspose::Pdf::VerticalAlignment	get_VerticalAlignment ()
	Gets a vertical alignment of paragraph More...

virtual void	set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
	Sets a vertical alignment of paragraph More...

virtual Aspose::Pdf::HorizontalAlignment	get_HorizontalAlignment ()
	Gets a horizontal alignment of paragraph More...

virtual void	set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
	Sets a horizontal alignment of paragraph More...

System::SharedPtr< MarginInfo >	get_Margin ()
	Gets a outer margin for paragraph (for pdf generation) More...

void	set_Margin (System::SharedPtr< MarginInfo > value)
	Sets a outer margin for paragraph (for pdf generation) More...

bool	get_IsFirstParagraphInColumn () const
	Gets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...

void	set_IsFirstParagraphInColumn (bool value)
	Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation) More...

bool	get_IsKeptWithNext () const
	Gets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...

void	set_IsKeptWithNext (bool value)
	Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation) More...

bool	get_IsInNewPage () const
	Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...

void	set_IsInNewPage (bool value)
	Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...

bool	get_IsInLineParagraph () const
	Gets a paragraph is inline. Default is false.(for pdf generation) More...

void	set_IsInLineParagraph (bool value)
	Sets a paragraph is inline. Default is false.(for pdf generation) More...

virtual System::SharedPtr< Aspose::Pdf::Hyperlink >	get_Hyperlink ()
	Gets the fragment hyperlink(for pdf generator). More...

virtual void	set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
	Sets the fragment hyperlink(for pdf generator). More...

int32_t	get_ZIndex () const
	Gets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. More...

void	set_ZIndex (int32_t value)
	Sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page. More...

	BaseParagraph ()

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
bool	Process (double &curX, double &curY, double pageHeight, double pageWidth, System::SharedPtr< MarginInfo > pageMargin, System::SharedPtr< Page > page, double bottomY, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> operators, bool isHeaderFooter)

virtual void	Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer)

virtual void	Deserialize (System::SharedPtr< System::Xml::XmlReader > reader)

Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
System::String	get_Id () const
	Gets a paragraph id. More...

void	set_Id (System::String value)
	Sets a paragraph id. More...

System::SharedPtr< Annotations::LinkAnnotation >	get_ReferencedFrom () const
	Gets the fragment hyperlink(for pdf generator internal use). More...

void	set_ReferencedFrom (System::SharedPtr< Annotations::LinkAnnotation > value)
	Sets the fragment hyperlink(for pdf generator internal use). More...

void	ChangePosition (double &curX, double &curY, double newX, double newY, bool isNextParagraphInline)

void	ProcessHyperlink (System::SharedPtr< Page > page, System::SharedPtr< Rectangle > rect)

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

Static Protected Member Functions inherited from Aspose::Pdf::BaseParagraph
static bool	get_IsZIndexSet ()
	Gets the fragment hyperlink(for pdf generator performance internal use). More...

static void	set_IsZIndexSet (bool value)
	Sets the fragment hyperlink(for pdf generator performance internal use). More...

Detailed Description

Represents a FloatingBox in a Pdf document. FloatingBox is custom positioned.

Constructor & Destructor Documentation

◆ FloatingBox() [1/2]

Aspose::Pdf::FloatingBox::FloatingBox	(	float	width,
		float	height
	)

Initializes a new instance of the FloatingBox class with specified width and height.

Parameters

width	The width of the box.
height	The height of the box.

◆ FloatingBox() [2/2]

Aspose::Pdf::FloatingBox::FloatingBox ( )

Initializes a new instance of the FloatingBox class.

Member Function Documentation

◆ Clone()

virtual System::SharedPtr<System::Object> Aspose::Pdf::FloatingBox::Clone ( )

virtual

Clones a new FloatingBox object. Paragraphs in the floating box are not cloned.

Returns: The new FloatingBox object.

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ Deserialize()

virtual void Aspose::Pdf::FloatingBox::Deserialize ( System::SharedPtr< System::Xml::XmlReader > reader )

protectedvirtual

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ get_BackgroundColor()

System::SharedPtr<Color> Aspose::Pdf::FloatingBox::get_BackgroundColor ( ) const

Gets a Aspose::Pdf::Color object that indicates the background color of the floating box.

◆ get_BackgroundImage()

System::SharedPtr<Image> Aspose::Pdf::FloatingBox::get_BackgroundImage ( ) const

Gets background image for page (for generator only).

◆ get_Border()

System::SharedPtr<BorderInfo> Aspose::Pdf::FloatingBox::get_Border ( ) const

Gets a BorderInfo object that indicates the border info of the floating box.

◆ get_ColumnInfo()

System::SharedPtr<Aspose::Pdf::ColumnInfo> Aspose::Pdf::FloatingBox::get_ColumnInfo ( ) const

Gets a column info

◆ get_Height()

double Aspose::Pdf::FloatingBox::get_Height ( ) const

Gets a float value that indicates the height of the floating box.

◆ get_IsNeedRepeating()

bool Aspose::Pdf::FloatingBox::get_IsNeedRepeating ( ) const

Gets a bool value that indicates whether the paragraph need to be repeated on next page. Default value is false.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows.

◆ get_Left()

double Aspose::Pdf::FloatingBox::get_Left ( ) const

Gets the table left coordinate.

◆ get_Padding()

System::SharedPtr<MarginInfo> Aspose::Pdf::FloatingBox::get_Padding ( ) const

Gets a MarginInfo object that indicates the padding of the floating box.

◆ get_Paragraphs()

System::SharedPtr<Aspose::Pdf::Paragraphs> Aspose::Pdf::FloatingBox::get_Paragraphs ( ) const

Gets a Paragraphs collection that indicates all paragraphs in the cell.

◆ get_Top()

double Aspose::Pdf::FloatingBox::get_Top ( ) const

Gets the table top coordinate.

◆ get_Width()

double Aspose::Pdf::FloatingBox::get_Width ( ) const

Gets a float value that indicates the width of the floating box.

◆ Process()

bool Aspose::Pdf::FloatingBox::Process	(	double &	curX,
		double &	curY,
		double	pageHeight,
		double	pageWidth,
		System::SharedPtr< MarginInfo >	pageMargin,
		System::SharedPtr< Page >	page,
		double	bottomY,
		System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>>	operators,
		bool	isHeaderFooter
	)

protected

◆ Serialize()

virtual void Aspose::Pdf::FloatingBox::Serialize ( System::SharedPtr< System::Xml::XmlTextWriter > writer )

protectedvirtual

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ set_BackgroundColor()

void Aspose::Pdf::FloatingBox::set_BackgroundColor ( System::SharedPtr< Color > value )

Sets a Aspose::Pdf::Color object that indicates the background color of the floating box.

◆ set_BackgroundImage()

void Aspose::Pdf::FloatingBox::set_BackgroundImage ( System::SharedPtr< Image > value )

Sets background image for page (for generator only).

◆ set_Border()

void Aspose::Pdf::FloatingBox::set_Border ( System::SharedPtr< BorderInfo > value )

Sets a BorderInfo object that indicates the border info of the floating box.

◆ set_ColumnInfo()

void Aspose::Pdf::FloatingBox::set_ColumnInfo ( System::SharedPtr< Aspose::Pdf::ColumnInfo > value )

Sets a column info

◆ set_Height()

void Aspose::Pdf::FloatingBox::set_Height ( double value )

Sets a float value that indicates the height of the floating box.

◆ set_IsNeedRepeating()

void Aspose::Pdf::FloatingBox::set_IsNeedRepeating ( bool value )

Sets a bool value that indicates whether the paragraph need to be repeated on next page. Default value is false.The attribute is only valid when the paragraph itself and the object its ReferenceParagraphID referred to both are included in RepeatingRows.

◆ set_Left()

void Aspose::Pdf::FloatingBox::set_Left ( double value )

Sets the table left coordinate.

◆ set_Padding()

void Aspose::Pdf::FloatingBox::set_Padding ( System::SharedPtr< MarginInfo > value )

Sets a MarginInfo object that indicates the padding of the floating box.

◆ set_Paragraphs()

void Aspose::Pdf::FloatingBox::set_Paragraphs ( System::SharedPtr< Aspose::Pdf::Paragraphs > value )

Sets a Paragraphs collection that indicates all paragraphs in the cell.

◆ set_Top()

void Aspose::Pdf::FloatingBox::set_Top ( double value )

Sets the table top coordinate.

◆ set_Width()

void Aspose::Pdf::FloatingBox::set_Width ( double value )

Sets a float value that indicates the width of the floating box.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FloatingBox() [1/2]

◆ FloatingBox() [2/2]

Member Function Documentation

◆ Clone()

◆ Deserialize()

◆ get_BackgroundColor()

◆ get_BackgroundImage()

◆ get_Border()

◆ get_ColumnInfo()

◆ get_Height()

◆ get_IsNeedRepeating()

◆ get_Left()

◆ get_Padding()

◆ get_Paragraphs()

◆ get_Top()

◆ get_Width()

◆ Process()

◆ Serialize()

◆ set_BackgroundColor()

◆ set_BackgroundImage()

◆ set_Border()

◆ set_ColumnInfo()

◆ set_Height()

◆ set_IsNeedRepeating()

◆ set_Left()

◆ set_Padding()

◆ set_Paragraphs()

◆ set_Top()

◆ set_Width()