Aspose::Pdf::HtmlLoadOptions Class Referencefinal

Represents options for loading/importing html file into pdf document. More...

Inherits Aspose::Pdf::LoadOptions.

Public Member Functions

ASPOSE_PDF_SHARED_API bool get_IsRenderToSinglePage () const
 Gets rendering all document to single page More...
 
ASPOSE_PDF_SHARED_API void set_IsRenderToSinglePage (bool value)
 Sets rendering all document to single page More...
 
ASPOSE_PDF_SHARED_API bool get_IsEmbedFonts () const
 Gets fonts embedding to result document More...
 
ASPOSE_PDF_SHARED_API void set_IsEmbedFonts (bool value)
 Sets fonts embedding to result document More...
 
ASPOSE_PDF_SHARED_API HtmlPageLayoutOption get_PageLayoutOption () const
 Gets layout option. More...
 
ASPOSE_PDF_SHARED_API void set_PageLayoutOption (HtmlPageLayoutOption value)
 Sets layout option. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlMediaType get_HtmlMediaType () const
 Gets possible media types used during rendering. More...
 
ASPOSE_PDF_SHARED_API void set_HtmlMediaType (Aspose::Pdf::HtmlMediaType value)
 Sets possible media types used during rendering. More...
 
ASPOSE_PDF_SHARED_API System::String get_InputEncoding () const
 Gets the attribute specifying the encoding used for this document at the time of the parsing. If this attribute is null the encoding will determine from document character set atribute. More...
 
ASPOSE_PDF_SHARED_API void set_InputEncoding (System::String value)
 Sets the attribute specifying the encoding used for this document at the time of the parsing. If this attribute is null the encoding will determine from document character set atribute. More...
 
ASPOSE_PDF_SHARED_API System::String get_BasePath () const
 The base path/url for the html file. More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< Aspose::Pdf::PageInfo > & get_PageInfo () const
 Gets document page info More...
 
ASPOSE_PDF_SHARED_API void set_PageInfo (System::SharedPtr< Aspose::Pdf::PageInfo > value)
 Sets document page info More...
 
ASPOSE_PDF_SHARED_API HtmlLoadOptions ()
 Creates load options for converting html into pdf document with empty base path. More...
 
ASPOSE_PDF_SHARED_API HtmlLoadOptions (System::String basePath)
 Creates load options for converting html into pdf document with defined base path. More...
 
- Public Member Functions inherited from Aspose::Pdf::LoadOptions
ASPOSE_PDF_SHARED_API System::SharedPtr< IWarningCallbackget_WarningHandler () const
 Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Load operation continues, however the user may also return Abort in which case the Load operation should cease. More...
 
ASPOSE_PDF_SHARED_API void set_WarningHandler (System::SharedPtr< IWarningCallback > value)
 Callback to handle any warnings generated. The WarningHandler returns ReturnAction enum item specifying either Continue or Abort. Continue is the default action and the Load operation continues, however the user may also return Abort in which case the Load operation should cease. More...
 
ASPOSE_PDF_SHARED_API Aspose::Pdf::LoadFormat get_LoadFormat () const
 Represents file format which LoadOptions describes. More...
 
ASPOSE_PDF_SHARED_API LoadOptions ()
 
- 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...
 

Public Attributes

System::SharedPtr< System::Net::ICredentialsExternalResourcesCredentials
 If loading of external data referenced in HTML requirs credentials, You can put them into this parameter - they will be used during loading of external resources More...
 
LoadOptions::ResourceLoadingStrategy CustomLoaderOfExternalResources
 Sometimes it's necessary to avoid usage of internal loader of external resources(like images or CSSes) and supply custom method that will get requested resources from somewhere. For example, during usage of Aspose.PDF in cloude direct access to referenced files impossible: in such case some custome code put into special method should be used, and delegate that refers that method should be assygned to this attribute. More...
 

Protected Member Functions

bool get_ShowFieldsBorders () const
 Gets the flag that controls visibility of fields borders (button, text, combobox). More...
 
void set_ShowFieldsBorders (bool value)
 Sets the flag that controls visibility of fields borders (button, text, combobox). More...
 

Additional Inherited Members

- Public Types inherited from Aspose::Pdf::LoadOptions
enum  MarginsAreaUsageModes { MarginsAreaUsageModes::PutContentOnMarginAreaIfNecessary = 0, MarginsAreaUsageModes::NeverPutContentOnMarginArea = 1 }
 Represents mode of usage of margins area during conversion (like HTML, EPUB etc), defines treatement of instructions of imported format related to usage of margins. More...
 
enum  PageSizeAdjustmentModes { PageSizeAdjustmentModes::NoAjustmentAllwaysUsePredefinedSize = 0, PageSizeAdjustmentModes::EnlargeRequiredViewportWidthAndDoConversionAgain = 1 }
 ATTENTION! The feature implemented but did not put yet to public API since blocker issue in OSHARED layer revealed for sample document. More...
 
using ResourceLoadingStrategy = System::MulticastDelegate< System::SharedPtr< LoadOptions::ResourceLoadingResult >(System::String)>
 
- 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...
 
- Protected Attributes inherited from Aspose::Pdf::LoadOptions
Aspose::Pdf::LoadFormat _loadFormat
 
UsageMode _usageMode
 
System::String ApsIntermediateFileIfAny
 
System::String XpsIntermediateFileIfAny
 
System::String PngIntermediateFileIfAny
 
ApsToXpsSavingMode ApsAsXpsSavingType
 
System::String PlainApsIntermediateTempFileIfAny
 Sometimes we need use temp file to save APS during conversion to avoid OOM exceptions in PalZipWriter For such hard tests can be used this parameter - it will force usage of ile instead of MemoryStream More...
 
bool UseAreaClipping
 
System::SharedPtr< Aspose::Pdf::PagePage
 
- Static Protected Attributes inherited from Aspose::Pdf::LoadOptions
static const int32_t DefaultBatchSize
 

Detailed Description

Represents options for loading/importing html file into pdf document.

Constructor & Destructor Documentation

◆ HtmlLoadOptions() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlLoadOptions::HtmlLoadOptions ( )

Creates load options for converting html into pdf document with empty base path.

◆ HtmlLoadOptions() [2/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlLoadOptions::HtmlLoadOptions ( System::String  basePath)

Creates load options for converting html into pdf document with defined base path.

Parameters
basePathThe base path/url for the html file.

Member Function Documentation

◆ get_BasePath()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::HtmlLoadOptions::get_BasePath ( ) const

The base path/url for the html file.

◆ get_HtmlMediaType()

ASPOSE_PDF_SHARED_API Aspose::Pdf::HtmlMediaType Aspose::Pdf::HtmlLoadOptions::get_HtmlMediaType ( ) const

Gets possible media types used during rendering.

◆ get_InputEncoding()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::HtmlLoadOptions::get_InputEncoding ( ) const

Gets the attribute specifying the encoding used for this document at the time of the parsing. If this attribute is null the encoding will determine from document character set atribute.

◆ get_IsEmbedFonts()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlLoadOptions::get_IsEmbedFonts ( ) const

Gets fonts embedding to result document

◆ get_IsRenderToSinglePage()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::HtmlLoadOptions::get_IsRenderToSinglePage ( ) const

Gets rendering all document to single page

◆ get_PageInfo()

ASPOSE_PDF_SHARED_API const System::SharedPtr<Aspose::Pdf::PageInfo>& Aspose::Pdf::HtmlLoadOptions::get_PageInfo ( ) const

Gets document page info

◆ get_PageLayoutOption()

ASPOSE_PDF_SHARED_API HtmlPageLayoutOption Aspose::Pdf::HtmlLoadOptions::get_PageLayoutOption ( ) const

Gets layout option.

◆ get_ShowFieldsBorders()

bool Aspose::Pdf::HtmlLoadOptions::get_ShowFieldsBorders ( ) const
protected

Gets the flag that controls visibility of fields borders (button, text, combobox).

◆ set_HtmlMediaType()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlLoadOptions::set_HtmlMediaType ( Aspose::Pdf::HtmlMediaType  value)

Sets possible media types used during rendering.

◆ set_InputEncoding()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlLoadOptions::set_InputEncoding ( System::String  value)

Sets the attribute specifying the encoding used for this document at the time of the parsing. If this attribute is null the encoding will determine from document character set atribute.

◆ set_IsEmbedFonts()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlLoadOptions::set_IsEmbedFonts ( bool  value)

Sets fonts embedding to result document

◆ set_IsRenderToSinglePage()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlLoadOptions::set_IsRenderToSinglePage ( bool  value)

Sets rendering all document to single page

◆ set_PageInfo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlLoadOptions::set_PageInfo ( System::SharedPtr< Aspose::Pdf::PageInfo value)

Sets document page info

◆ set_PageLayoutOption()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::HtmlLoadOptions::set_PageLayoutOption ( HtmlPageLayoutOption  value)

Sets layout option.

◆ set_ShowFieldsBorders()

void Aspose::Pdf::HtmlLoadOptions::set_ShowFieldsBorders ( bool  value)
protected

Sets the flag that controls visibility of fields borders (button, text, combobox).

Member Data Documentation

◆ CustomLoaderOfExternalResources

LoadOptions::ResourceLoadingStrategy Aspose::Pdf::HtmlLoadOptions::CustomLoaderOfExternalResources

Sometimes it's necessary to avoid usage of internal loader of external resources(like images or CSSes) and supply custom method that will get requested resources from somewhere. For example, during usage of Aspose.PDF in cloude direct access to referenced files impossible: in such case some custome code put into special method should be used, and delegate that refers that method should be assygned to this attribute.

◆ ExternalResourcesCredentials

System::SharedPtr<System::Net::ICredentials> Aspose::Pdf::HtmlLoadOptions::ExternalResourcesCredentials

If loading of external data referenced in HTML requirs credentials, You can put them into this parameter - they will be used during loading of external resources