Aspose::Pdf::XslFoLoadOptions Class Referencefinal

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

Inherits Aspose::Pdf::XmlLoadOptions.

Public Types

enum  ParsingErrorsHandlingTypes { ParsingErrorsHandlingTypes::TryIgnore, ParsingErrorsHandlingTypes::ThrowExceptionImmediately, ParsingErrorsHandlingTypes::InvokeCustomHandler }
 
- 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...
 

Public Member Functions

System::String get_BasePath ()
 The base path/url from which are searched relative pathes to external resources (if any) referenced in loaded SVG file. More...
 
void set_BasePath (System::String value)
 The base path/url from which are searched relative pathes to external resources (if any) referenced in loaded SVG file. More...
 
 XslFoLoadOptions ()
 Creates XslFoLoadOptions object without xsl data. More...
 
 XslFoLoadOptions (System::String xslFile)
 Creates XslFoLoadOptions object with xsl data. More...
 
 XslFoLoadOptions (System::SharedPtr< System::IO::Stream > xslStream)
 Creates XslFoLoadOptions object with xsl data. More...
 
- Public Member Functions inherited from Aspose::Pdf::XmlLoadOptions
System::SharedPtr< System::IO::Streamget_XslStream ()
 Gets xsl data for converting xml into pdf document. More...
 
 XmlLoadOptions ()
 Creates XmlLoadOptions object without xsl data. More...
 
 XmlLoadOptions (System::String xslFile)
 Creates XmlLoadOptions object with xsl data. More...
 
 XmlLoadOptions (System::SharedPtr< System::IO::Stream > xslStream)
 Creates XmlLoadOptions object with xsl data. More...
 
virtual ~XmlLoadOptions ()
 
- 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

XslFoLoadOptions::ParsingErrorsHandlingTypes ParsingErrorsHandlingType
 

Protected Attributes

System::String IntermediateXmlFileIfXslTransformUsed
 
- Protected Attributes inherited from Aspose::Pdf::XmlLoadOptions
XmlLoadOptions::RenderingEngines RenderingEngine
 
- 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
 

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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 
- Protected Types inherited from Aspose::Pdf::XmlLoadOptions
enum  RenderingEngines { RenderingEngines::LegacyEngine, RenderingEngines::NewEngine }
 

Detailed Description

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

Member Enumeration Documentation

◆ ParsingErrorsHandlingTypes

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

Creates XslFoLoadOptions object without xsl data.

◆ XslFoLoadOptions() [2/3]

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

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

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

◆ set_BasePath()

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

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

Member Data Documentation

◆ IntermediateXmlFileIfXslTransformUsed

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

◆ ParsingErrorsHandlingType

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