Aspose::Pdf::HtmlFragment Class Referencefinal

Represents html fragment. More...

Inherits Aspose::Pdf::FormattedFragment.

Public Member Functions

ASPOSE_PDF_SHARED_API System::Drawing::RectangleF get_Rectangle () const
 Gets rectangle of the HtmlFragment More...
 
ASPOSE_PDF_SHARED_API bool get_IsParagraphHasMargin () const
 Gets is paragraph has default margin otherwise margin is 0 More...
 
ASPOSE_PDF_SHARED_API void set_IsParagraphHasMargin (bool value)
 Sets is paragraph has default margin otherwise margin is 0 More...
 
ASPOSE_PDF_SHARED_API bool get_IsBreakWords () const
 Gets words break More...
 
ASPOSE_PDF_SHARED_API void set_IsBreakWords (bool value)
 Sets words break More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< Aspose::Pdf::Text::TextState > & get_TextState () const
 Gets font More...
 
ASPOSE_PDF_SHARED_API void set_TextState (System::SharedPtr< Aspose::Pdf::Text::TextState > value)
 Sets font More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< Aspose::Pdf::HtmlLoadOptions > & get_HtmlLoadOptions () const
 Gets HtmlLoadOptions that will be used for loading (and rendering) of HTML into this instance of class. Please use it when it's necessary use specific setting for import of HTML for this or that instance (f.e when this or that instance should use specific BasePath for imported HTML or should use specific loader of external resources) If parameter is default (null), then standard HTML loading options will be used. More...
 
ASPOSE_PDF_SHARED_API void set_HtmlLoadOptions (System::SharedPtr< Aspose::Pdf::HtmlLoadOptions > value)
 Sets HtmlLoadOptions that will be used for loading (and rendering) of HTML into this instance of class. Please use it when it's necessary use specific setting for import of HTML for this or that instance (f.e when this or that instance should use specific BasePath for imported HTML or should use specific loader of external resources) If parameter is default (null), then standard HTML loading options will be used. More...
 
ASPOSE_PDF_SHARED_API HtmlFragment (System::String text)
 Initializes a new instance of the HtmlFragment class. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::ObjectClone () override
 Clones html fragment. More...
 
- Public Member Functions inherited from Aspose::Pdf::BaseParagraph
virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::VerticalAlignment get_VerticalAlignment ()
 Gets a vertical alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API void set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
 Sets a vertical alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment get_HorizontalAlignment ()
 Gets a horizontal alignment of paragraph More...
 
virtual ASPOSE_PDF_SHARED_API void set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
 Sets a horizontal alignment of paragraph More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< MarginInfoget_Margin ()
 Gets a outer margin for paragraph (for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_Margin (System::SharedPtr< MarginInfo > value)
 Sets a outer margin for paragraph (for pdf generation) More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API bool get_IsInNewPage () const
 Gets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsInNewPage (bool value)
 Sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API bool get_IsInLineParagraph () const
 Gets a paragraph is inline. Default is false.(for pdf generation) More...
 
ASPOSE_PDF_SHARED_API void set_IsInLineParagraph (bool value)
 Sets a paragraph is inline. Default is false.(for pdf generation) More...
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Hyperlinkget_Hyperlink ()
 Gets the fragment hyperlink(for pdf generator). More...
 
virtual ASPOSE_PDF_SHARED_API void set_Hyperlink (System::SharedPtr< Aspose::Pdf::Hyperlink > value)
 Sets the fragment hyperlink(for pdf generator). More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 TypeInfoGetType () 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

ASPOSE_PDF_SHARED_API void ConvertToPages (System::SharedPtr< Page > page, double width, double firstHeight, double anyHeight, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< PdfPageInfo >>> pageInfos, System::SharedPtr< Matrix > matrix) override
 
ASPOSE_PDF_SHARED_API void Serialize (System::SharedPtr< System::Xml::XmlTextWriter > writer) override
 
- Protected Member Functions inherited from Aspose::Pdf::FormattedFragment
const System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< PdfPageInfo > > > & get_PageInfos () const
 
void set_PageInfos (System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< PdfPageInfo >>> value)
 
bool get_IsConverted () const
 
void set_IsConverted (bool value)
 
double get_Height ()
 
 FormattedFragment (System::String text)
 
bool Process (double &curX, double &curY, bool isCalculatedMode, double width, double bottomY, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> operators, System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Operator >>> keptWithNextOperators, int32_t &keptWithNextParagraphsCount, System::SharedPtr< Page > page, System::SharedPtr< MarginInfo > margin, System::SharedPtr< Table > table, double &lastParagraphHeight, bool isNextParagraphInline, bool isHeaderFooter)
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< MatrixGetMatrix (double curX, double curY, System::SharedPtr< PageInfo > pageInfo)
 
virtual ASPOSE_PDF_SHARED_API System::SharedPtr< Operators::ConcatenateMatrixGetMatrixOperator (double curX, double curY, System::SharedPtr< PageInfo > pageInfo)
 
double CalculateWidth (double maxWidth)
 
ASPOSE_PDF_SHARED_API void Deserialize (System::SharedPtr< System::Xml::XmlReader > reader) override
 
ASPOSE_PDF_SHARED_API void CopyFields (System::SharedPtr< FormattedFragment > fragment)
 Copy fields to fragment. More...
 
- 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...
 
const 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< Objectptr
 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
- Static Protected Member Functions inherited from Aspose::Pdf::FormattedFragment
static void CopyResources (System::SharedPtr< Page > srcPage, System::SharedPtr< Page > destPage)
 Copies the resource dictionary from page to source page and vica versa (for non adding content mode only). 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...
 
- Protected Attributes inherited from Aspose::Pdf::FormattedFragment
System::String text
 Text value. More...
 
System::Drawing::RectangleF rectangle
 Rectangle value. More...
 

Detailed Description

Represents html fragment.

Constructor & Destructor Documentation

◆ HtmlFragment()

ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlFragment::HtmlFragment ( System::String  text)

Initializes a new instance of the HtmlFragment class.

Parameters
textThe fragment text

Member Function Documentation

◆ Clone()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::HtmlFragment::Clone ( )
overridevirtual

Clones html fragment.

Returns
Cloned html fragment object.

Reimplemented from Aspose::Pdf::BaseParagraph.

◆ ConvertToPages()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlFragment::ConvertToPages ( System::SharedPtr< Page page,
double  width,
double  firstHeight,
double  anyHeight,
System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< PdfPageInfo >>>  pageInfos,
System::SharedPtr< Matrix matrix 
)
overrideprotectedvirtual

◆ get_HtmlLoadOptions()

ASPOSE_PDF_SHARED_API const System::SharedPtr<Aspose::Pdf::HtmlLoadOptions>& Aspose::Pdf::HtmlFragment::get_HtmlLoadOptions ( ) const

Gets HtmlLoadOptions that will be used for loading (and rendering) of HTML into this instance of class. Please use it when it's necessary use specific setting for import of HTML for this or that instance (f.e when this or that instance should use specific BasePath for imported HTML or should use specific loader of external resources) If parameter is default (null), then standard HTML loading options will be used.

◆ get_IsBreakWords()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlFragment::get_IsBreakWords ( ) const

Gets words break

◆ get_IsParagraphHasMargin()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlFragment::get_IsParagraphHasMargin ( ) const

Gets is paragraph has default margin otherwise margin is 0

◆ get_Rectangle()

ASPOSE_PDF_SHARED_API System::Drawing::RectangleF Aspose::Pdf::HtmlFragment::get_Rectangle ( ) const

Gets rectangle of the HtmlFragment

◆ get_TextState()

ASPOSE_PDF_SHARED_API const System::SharedPtr<Aspose::Pdf::Text::TextState>& Aspose::Pdf::HtmlFragment::get_TextState ( ) const

Gets font

◆ Serialize()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlFragment::Serialize ( System::SharedPtr< System::Xml::XmlTextWriter writer)
overrideprotectedvirtual

Reimplemented from Aspose::Pdf::FormattedFragment.

◆ set_HtmlLoadOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlFragment::set_HtmlLoadOptions ( System::SharedPtr< Aspose::Pdf::HtmlLoadOptions value)

Sets HtmlLoadOptions that will be used for loading (and rendering) of HTML into this instance of class. Please use it when it's necessary use specific setting for import of HTML for this or that instance (f.e when this or that instance should use specific BasePath for imported HTML or should use specific loader of external resources) If parameter is default (null), then standard HTML loading options will be used.

◆ set_IsBreakWords()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlFragment::set_IsBreakWords ( bool  value)

Sets words break

◆ set_IsParagraphHasMargin()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlFragment::set_IsParagraphHasMargin ( bool  value)

Sets is paragraph has default margin otherwise margin is 0

◆ set_TextState()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlFragment::set_TextState ( System::SharedPtr< Aspose::Pdf::Text::TextState value)

Sets font