Aspose::Pdf::HtmlLoadOptions Class Referencefinal

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

Inherits Aspose::Pdf::LoadOptions.

Public Member Functions

bool get_IsRenderToSinglePage ()
 Gets rendering all document to single page More...
 
void set_IsRenderToSinglePage (bool value)
 Sets rendering all document to single page More...
 
bool get_IsEmbedFonts ()
 Gets fonts embedding to result document More...
 
void set_IsEmbedFonts (bool value)
 Sets fonts embedding to result document More...
 
Aspose::Pdf::HtmlMediaType get_HtmlMediaType ()
 Gets possible media types used during rendering. More...
 
void set_HtmlMediaType (Aspose::Pdf::HtmlMediaType value)
 Sets possible media types used during rendering. More...
 
System::String get_InputEncoding ()
 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...
 
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...
 
System::String get_BasePath ()
 The base path/url for the html file. More...
 
System::SharedPtr< Aspose::Pdf::PageInfoget_PageInfo ()
 Gets document page info More...
 
void set_PageInfo (System::SharedPtr< Aspose::Pdf::PageInfo > value)
 Sets document page info More...
 
 HtmlLoadOptions ()
 Creates load options for converting html into pdf document with empty base path. More...
 
 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
System::SharedPtr< IWarningCallbackget_WarningHandler ()
 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...
 
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::LoadFormat get_LoadFormat ()
 Represents file format which LoadOptions describes. More...
 
 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 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 () ASPOSE_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 (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)
 

Public Attributes

System::SharedPtr< System::Net::ICredentialsExternalResourcesCredentials
 
LoadOptions::ResourceLoadingStrategy CustomLoaderOfExternalResources
 

Protected Member Functions

bool get_ShowFieldsBorders ()
 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...
 
System::SharedPtr< Aspose::Html::Drawing::Size > get_FirstSize ()
 
void set_FirstSize (System::SharedPtr< Aspose::Html::Drawing::Size > value)
 
System::SharedPtr< Aspose::Html::Drawing::Size > get_AnySize ()
 
void set_AnySize (System::SharedPtr< Aspose::Html::Drawing::Size > value)
 
System::SharedPtr< Aspose::Html::Drawing::Size > get_LastSize ()
 
void set_LastSize (System::SharedPtr< Aspose::Html::Drawing::Size > value)
 

Additional Inherited Members

- Public Types inherited from Aspose::Pdf::LoadOptions
enum  MarginsAreaUsageModes { MarginsAreaUsageModes::PutContentOnMarginAreaIfNecessary = 0, MarginsAreaUsageModes::NeverPutContentOnMarginArea = 1 }
 
enum  PageSizeAdjustmentModes { PageSizeAdjustmentModes::NoAjustmentAllwaysUsePredefinedSize = 0, PageSizeAdjustmentModes::EnlargeRequiredViewportWidthAndDoConversionAgain = 1 }
 
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...
 
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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
- Protected Attributes inherited from Aspose::Pdf::LoadOptions
Aspose::Pdf::LoadFormat _loadFormat
 
System::String ApsIntermediateFileIfAny
 
System::String XpsIntermediateFileIfAny
 
System::String PngIntermediateFileIfAny
 
ApsToXpsSavingType ApsAsXpsSavingType
 
System::String PlainApsIntermediateTempFileIfAny
 
bool UseAreaClipping
 
System::SharedPtr< Aspose::Pdf::PagePage
 
bool DontConvertToPdf
 

Detailed Description

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

Constructor & Destructor Documentation

◆ HtmlLoadOptions() [1/2]

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

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

◆ HtmlLoadOptions() [2/2]

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_AnySize()

System::SharedPtr<Aspose::Html::Drawing::Size> Aspose::Pdf::HtmlLoadOptions::get_AnySize ( )
protected

◆ get_BasePath()

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

The base path/url for the html file.

◆ get_FirstSize()

System::SharedPtr<Aspose::Html::Drawing::Size> Aspose::Pdf::HtmlLoadOptions::get_FirstSize ( )
protected

◆ get_HtmlMediaType()

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

Gets possible media types used during rendering.

◆ get_InputEncoding()

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

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()

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

Gets fonts embedding to result document

◆ get_IsRenderToSinglePage()

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

Gets rendering all document to single page

◆ get_LastSize()

System::SharedPtr<Aspose::Html::Drawing::Size> Aspose::Pdf::HtmlLoadOptions::get_LastSize ( )
protected

◆ get_PageInfo()

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

Gets document page info

◆ get_ShowFieldsBorders()

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

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

◆ set_AnySize()

void Aspose::Pdf::HtmlLoadOptions::set_AnySize ( System::SharedPtr< Aspose::Html::Drawing::Size >  value)
protected

◆ set_FirstSize()

void Aspose::Pdf::HtmlLoadOptions::set_FirstSize ( System::SharedPtr< Aspose::Html::Drawing::Size >  value)
protected

◆ set_HtmlMediaType()

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

Sets possible media types used during rendering.

◆ set_InputEncoding()

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()

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

Sets fonts embedding to result document

◆ set_IsRenderToSinglePage()

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

Sets rendering all document to single page

◆ set_LastSize()

void Aspose::Pdf::HtmlLoadOptions::set_LastSize ( System::SharedPtr< Aspose::Html::Drawing::Size >  value)
protected

◆ set_PageInfo()

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

Sets document page info

◆ 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

◆ ExternalResourcesCredentials

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