Aspose::Pdf::FloatingBox class

FloatingBox class

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

class FloatingBox : public Aspose::Pdf::BaseParagraph

Methods

MethodDescription
BaseParagraph()
Clone() overrideClones a new FloatingBox object. Paragraphs in the floating box are not cloned.
FloatingBox(float, float)Initializes a new instance of the FloatingBox class with specified width and height.
FloatingBox()Initializes a new instance of the FloatingBox class.
get_BackgroundColor() constGets a Aspose::Pdf::Color object that indicates the background color of the floating box.
get_BackgroundImage() constGets background image for page (for generator only, not filled in when reading document).
get_Border() constGets a BorderInfo object that indicates the border info of the floating box.
get_ColumnInfo() constGets a column info.
get_Height() constGets a float value that indicates the height of the floating box.
virtual get_HorizontalAlignment()Gets a horizontal alignment of paragraph.
virtual get_Hyperlink()Gets the fragment hyperlink(for pdf generator).
get_IsFirstParagraphInColumn() constGets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)
get_IsInLineParagraph() constGets a paragraph is inline. Default is false.(for pdf generation)
get_IsInNewPage() constGets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
get_IsKeptWithNext() constGets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)
get_IsNeedRepeating() constGets 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() constGets the table left coordinate.
get_Margin()Gets a outer margin for paragraph (for pdf generation)
get_Padding() constGets a MarginInfo object that indicates the padding of the floating box.
get_Paragraphs() constGets a Paragraphs collection that indicates all paragraphs in the cell.
get_Top() constGets the table top coordinate.
virtual get_VerticalAlignment()Gets a vertical alignment of paragraph.
get_Width() constGets a float value that indicates the width of the floating box.
get_ZIndex() constGets 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.
set_BackgroundColor(System::SharedPtr<Color>)Sets a Aspose::Pdf::Color object that indicates the background color of the floating box.
set_BackgroundImage(System::SharedPtr<Image>)Sets background image for page (for generator only, not filled in when reading document).
set_Border(System::SharedPtr<BorderInfo>)Sets a BorderInfo object that indicates the border info of the floating box.
set_ColumnInfo(System::SharedPtr<Aspose::Pdf::ColumnInfo>)Sets a column info.
set_Height(double)Sets a float value that indicates the height of the floating box.
virtual set_HorizontalAlignment(Aspose::Pdf::HorizontalAlignment)Sets a horizontal alignment of paragraph.
virtual set_Hyperlink(System::SharedPtr<Aspose::Pdf::Hyperlink>)Sets the fragment hyperlink(for pdf generator).
set_IsFirstParagraphInColumn(bool)Sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)
set_IsInLineParagraph(bool)Sets a paragraph is inline. Default is false.(for pdf generation)
set_IsInNewPage(bool)Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
set_IsKeptWithNext(bool)Sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)
set_IsNeedRepeating(bool)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(double)Sets the table left coordinate.
set_Margin(System::SharedPtr<MarginInfo>)Sets a outer margin for paragraph (for pdf generation)
set_Padding(System::SharedPtr<MarginInfo>)Sets a MarginInfo object that indicates the padding of the floating box.
set_Paragraphs(System::SharedPtr<Aspose::Pdf::Paragraphs>)Sets a Paragraphs collection that indicates all paragraphs in the cell.
set_Top(double)Sets the table top coordinate.
virtual set_VerticalAlignment(Aspose::Pdf::VerticalAlignment)Sets a vertical alignment of paragraph.
set_Width(double)Sets a float value that indicates the width of the floating box.
set_ZIndex(int32_t)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.

See Also