Aspose::Pdf::XslFoLoadOptions Class Referencefinal

Represents options for loading/importing XSL-FO file into pdf document. More...

#include "XslFoLoadOptions.h"

Inherits Aspose::Pdf::XmlLoadOptions.

Public Types

enum  ParsingErrorsHandlingTypes { ParsingErrorsHandlingTypes::TryIgnore, ParsingErrorsHandlingTypes::ThrowExceptionImmediately, ParsingErrorsHandlingTypes::InvokeCustomHandler }
 Source XSLFO document can contain formatting errors. This enum enumerates possible strategies of handling of such formatting errors More...
 
- 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...
 

Public Member Functions

ASPOSE_PDF_SHARED_API System::String get_BasePath () const
 The base path/url from which are searched relative paths to external resources (if any) referenced in loaded SVG file. More...
 
ASPOSE_PDF_SHARED_API void set_BasePath (System::String value)
 The base path/url from which are searched relative paths to external resources (if any) referenced in loaded SVG file. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Xml::Xsl::XsltArgumentListget_XsltArgumentList () const
 XsltArgumentList for inserting values into existing xls parameters More...
 
ASPOSE_PDF_SHARED_API void set_XsltArgumentList (System::SharedPtr< System::Xml::Xsl::XsltArgumentList > value)
 XsltArgumentList for inserting values into existing xls parameters More...
 
ASPOSE_PDF_SHARED_API XslFoLoadOptions ()
 Creates XslFoLoadOptions object without xsl data. More...
 
ASPOSE_PDF_SHARED_API XslFoLoadOptions (System::String xslFile)
 Creates XslFoLoadOptions object with xsl data. More...
 
ASPOSE_PDF_SHARED_API XslFoLoadOptions (System::SharedPtr< System::IO::Stream > xslStream)
 Creates XslFoLoadOptions object with xsl data. More...
 
- Public Member Functions inherited from Aspose::Pdf::XmlLoadOptions
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Streamget_XslStream () const
 Gets xsl data for converting xml into pdf document. More...
 
ASPOSE_PDF_SHARED_API XmlLoadOptions ()
 Creates XmlLoadOptions object without xsl data. More...
 
ASPOSE_PDF_SHARED_API XmlLoadOptions (System::String xslFile)
 Creates XmlLoadOptions object with xsl data. More...
 
ASPOSE_PDF_SHARED_API XmlLoadOptions (System::SharedPtr< System::IO::Stream > xslStream)
 Creates XmlLoadOptions object with xsl data. More...
 
virtual ASPOSE_PDF_SHARED_API ~XmlLoadOptions ()
 
- 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 bool get_DisableFontLicenseVerifications () const
 Gets flag to disable any license restrictions for all fonts while loading the file. When , allows to execute operations with font that are prohibited by a license of this font, for example allows to embed a font into a PDF document even if license rules disable embedding for this font. By default . More...
 
ASPOSE_PDF_SHARED_API void set_DisableFontLicenseVerifications (bool value)
 Sets flag to disable any license restrictions for all fonts while loading the file. When , allows to execute operations with font that are prohibited by a license of this font, for example allows to embed a font into a PDF document even if license rules disable embedding for this font. By default . 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

XslFoLoadOptions::ParsingErrorsHandlingTypes ParsingErrorsHandlingType
 Source XSLFO document can contain formatting errors. This enum enumerates possible strategies of handking of that errors More...
 

Protected Attributes

System::String IntermediateXmlFileIfXslTransformUsed
 Internal parameter - we can ask with it to save XML that will be get after XML+XSLT to XSLFO transformation More...
 
- Protected Attributes inherited from Aspose::Pdf::XmlLoadOptions
XmlLoadOptions::RenderingEngines RenderingEngine
 defines rendering engine that will be used for loading and rendering of XML model of document 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
 

Additional Inherited Members

- 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 Types inherited from Aspose::Pdf::XmlLoadOptions
enum  RenderingEngines { RenderingEngines::LegacyEngine }
 enumerates engine that loads XML that describes document More...
 
- Static Protected Attributes inherited from Aspose::Pdf::LoadOptions
static const int32_t DefaultBatchSize
 

Detailed Description

Represents options for loading/importing XSL-FO file into pdf document.

Member Enumeration Documentation

◆ ParsingErrorsHandlingTypes

Source XSLFO document can contain formatting errors. This enum enumerates possible strategies of handling of such formatting errors

Enumerator
TryIgnore 

In this case converter will be instructed to try proceed with conversion and ignore found formatting errors. In this case success not guaranteed, serious problems can occure later in converter, anf in suck case will be thrown exception with list of found formatting errors.

ThrowExceptionImmediately 

In this case conversion will be stopped immediately and exception will be thrown immediately after detecting of first formatting error

InvokeCustomHandler 

This is the most agile method - custom code must supply (in WarningCallback property) special handler that will be called when formatting error detected. That handler can f.e. log or count errors etc and will supply decision whether processing can be continued for this or that error.

Constructor & Destructor Documentation

◆ XslFoLoadOptions() [1/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::XslFoLoadOptions::XslFoLoadOptions ( )

Creates XslFoLoadOptions object without xsl data.

◆ XslFoLoadOptions() [2/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::XslFoLoadOptions::XslFoLoadOptions ( System::String  xslFile)

Creates XslFoLoadOptions object with xsl data.

Parameters
xslFileXsl file to convert XSL-FO document into pdf document.

◆ XslFoLoadOptions() [3/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::XslFoLoadOptions::XslFoLoadOptions ( System::SharedPtr< System::IO::Stream xslStream)

Creates XslFoLoadOptions object with xsl data.

Parameters
xslStreamXsl stream to convert XSL-FO document into pdf document.

Member Function Documentation

◆ get_BasePath()

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

The base path/url from which are searched relative paths to external resources (if any) referenced in loaded SVG file.

◆ get_XsltArgumentList()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Xml::Xsl::XsltArgumentList> Aspose::Pdf::XslFoLoadOptions::get_XsltArgumentList ( ) const

XsltArgumentList for inserting values into existing xls parameters

◆ set_BasePath()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XslFoLoadOptions::set_BasePath ( System::String  value)

The base path/url from which are searched relative paths to external resources (if any) referenced in loaded SVG file.

◆ set_XsltArgumentList()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XslFoLoadOptions::set_XsltArgumentList ( System::SharedPtr< System::Xml::Xsl::XsltArgumentList value)

XsltArgumentList for inserting values into existing xls parameters

Member Data Documentation

◆ IntermediateXmlFileIfXslTransformUsed

System::String Aspose::Pdf::XslFoLoadOptions::IntermediateXmlFileIfXslTransformUsed
protected

Internal parameter - we can ask with it to save XML that will be get after XML+XSLT to XSLFO transformation

◆ ParsingErrorsHandlingType

XslFoLoadOptions::ParsingErrorsHandlingTypes Aspose::Pdf::XslFoLoadOptions::ParsingErrorsHandlingType

Source XSLFO document can contain formatting errors. This enum enumerates possible strategies of handking of that errors