Save options for export to EPUB format More...

#include "EpubSaveOptions.h"

Inherits Aspose::Pdf::UnifiedSaveOptions.

Public Types
enum	RecognitionMode { RecognitionMode::Flow, RecognitionMode::PdfFlow, RecognitionMode::Fixed }
	When PDF file (that usually has fixed layout) is being converted, the conversion engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce result in flow layout. This property tunes that conversion for this or that desirable method of recognition of content. More...

Public Types inherited from Aspose::Pdf::UnifiedSaveOptions
using	ConversionProgressEventHandler = System::MulticastDelegate< void(System::SharedPtr< UnifiedSaveOptions::ProgressEventHandlerInfo >)>

Public Types inherited from Aspose::Pdf::SaveOptions
enum	HtmlBorderLineType { HtmlBorderLineType::None = 0, HtmlBorderLineType::Dotted = 1, HtmlBorderLineType::Dashed = 2, HtmlBorderLineType::Solid = 3, HtmlBorderLineType::Double = 4, HtmlBorderLineType::Groove = 5, HtmlBorderLineType::Ridge = 6, HtmlBorderLineType::Inset = 7, HtmlBorderLineType::Outset = 8 }
	Represents line types that can be used in result document for drawing borders or another lines More...

enum	NodeLevelResourceType { NodeLevelResourceType::Image = 0, NodeLevelResourceType::Font = 1 }
	enumerates possible types of saved external resources More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
ASPOSE_PDF_SHARED_API System::String	get_Title () const
	Gets EPUB document title. More...

ASPOSE_PDF_SHARED_API void	set_Title (System::String value)
	Sets EPUB document title. More...

ASPOSE_PDF_SHARED_API	EpubSaveOptions ()
	Constructor More...

Public Member Functions inherited from Aspose::Pdf::UnifiedSaveOptions
ASPOSE_PDF_SHARED_API bool	get_ExtractOcrSublayerOnly () const
	This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. More...

ASPOSE_PDF_SHARED_API void	set_ExtractOcrSublayerOnly (bool value)
	This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. More...

ASPOSE_PDF_SHARED_API	UnifiedSaveOptions ()

Public Member Functions inherited from Aspose::Pdf::SaveOptions
ASPOSE_PDF_SHARED_API System::SharedPtr< IWarningCallback >	get_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 Save operation continues, however the user may also return Abort in which case the Save 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 Save operation continues, however the user may also return Abort in which case the Save operation should cease. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::SaveFormat	get_SaveFormat () const
	Format of data save. More...

ASPOSE_PDF_SHARED_API bool	get_CloseResponse () const
	Gets boolean value which indicates will Response object be closed after document saved into response. More...

ASPOSE_PDF_SHARED_API void	set_CloseResponse (bool value)
	Sets boolean value which indicates will Response object be closed after document saved into response. More...

ASPOSE_PDF_SHARED_API bool	get_CacheGlyphs () const
	Gets boolean value which indicates if will font glyphs be cached while preparing aps pages. Improves performance of conversion pdf to other formats but increases memory consumption. More...

ASPOSE_PDF_SHARED_API void	set_CacheGlyphs (bool value)
	Sets boolean value which indicates if will font glyphs be cached while preparing aps pages. Improves performance of conversion pdf to other formats but increases memory consumption. More...

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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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
EpubSaveOptions::RecognitionMode	ContentRecognitionMode
	When PDF file (that usually has fixed layout) is being converted, the conversion engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce result in flow layout. This property tunes that conversion for this or that desirable method of recognition of content. More...

Public Attributes inherited from Aspose::Pdf::UnifiedSaveOptions
bool	TryMergeAdjacentSameBackgroundImages
	Sometimes PDFs contain background images (of pages or table cells) constructed from several same tiling background images put one near other. In such case renderers of target formats (f.e MsWord for DOCS format) sometimes generates visible boundaries beetween parts of background images, cause their techniques of image edge smoothing (anti-aliasing) is different from Acrobat Reader. If it looks like exported document contains such visible boundaries between parts of same background images, please try use this setting to get rid of that unwanted effect. ATTENTION! This optimization of quality usually essentially slows down conversion, so, please, use this option only when it's really necessary. More...

Protected Member Functions
System::SharedPtr< Aspose::Shared::Epub::ApsToEpubConverterOptions >	ToInnerSaveOptions ()
	During export to EPUB several modes of entity recognition of layout can be used This parameter defines such mode. More...

Protected Member Functions inherited from Aspose::Pdf::UnifiedSaveOptions
int32_t	GetNumberOfConvertiblePages (System::SharedPtr< Document > document)

Protected Member Functions inherited from Aspose::Pdf::SaveOptions
ASPOSE_PDF_SHARED_API	SaveOptions ()
	Default ctor. More...

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 TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Protected Types inherited from Aspose::Pdf::UnifiedSaveOptions
using	OnePageProcessedEventHandler = System::MulticastDelegate< void(int32_t)>

Protected Attributes inherited from Aspose::Pdf::UnifiedSaveOptions
System::SharedPtr< ConversionProgressEventsTranslator >	ProgressEventsRetranslator
	Represents internal progress events processor that works during conversion and translates conversion events of internal conversion stages into external total progress events Also class broadcasts events that allow to free resources that not needed anymore This internal class handles events of PDF to APS and APS to [Other format] progress to calculate total progress and inform customer's code about that total progress events this class uses two types of events : ApsToExternal model conversion and events of conversion Pdf to APS to generate total progress events Export has three stage : 1) Pdf to Aps 2) Aps recognition 3_ Aps export to target format Constructor allows tune how much pages are converted and what is approximmate part of this or that stage in total progress More...

Protected Attributes inherited from Aspose::Pdf::SaveOptions
Aspose::Pdf::SaveFormat	_saveFormat

System::String	ApsIntermediateFileIfAny

System::String	XpsIntermediateFileIfAny

System::String	PngIntermediateFileIfAny

ApsToXpsSavingMode	ApsAsXpsSavingMode

System::SharedPtr< Aspose::DocumentInfo >	DocumentInfoForSaveAsXps

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...

Static Protected Attributes inherited from Aspose::Pdf::UnifiedSaveOptions
static const int32_t	DefaultBatchSize

Detailed Description

Save options for export to EPUB format

Member Enumeration Documentation

◆ RecognitionMode

enum Aspose::Pdf::EpubSaveOptions::RecognitionMode

strong

When PDF file (that usually has fixed layout) is being converted, the conversion engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce result in flow layout. This property tunes that conversion for this or that desirable method of recognition of content.

Enumerator
Flow	Full recognition mode, the engine tries to perform grouping and multi-level analysis to restore the original document author's intent and produce xhtml in flow layout.
PdfFlow	The main idea of this conversion is based on saving "natural" order of content rendering that is formed during processing of pdf documents. In the general cases pdf documents keep top-down, left-right rendering order (see attachment directions.png). This assumption allows to create a single-path algorithm that will transform Aps elements that have positions (fixed-layout) into flow formats like HTML,EPUB,DOC. This mode will be especially useful for converting from PDF(APS) into EPUB, because the EPUB format was developed for e-readers like the Kindle or smart-phones. The size of screen those devices usually is less than the size of screen of ordinary PC. Therefore the content of EPUB documents is better to save in the flow format, for correct rendering on screens with different sizes. In this mode every column will be added to the end of previous column this allows to keep the logical structure of transformed document during "pagination" in EPUB readers. This achievement allows correctly render scientific or magazine articles.
Fixed	This mode is fast and good for maximally preserving the original look pages, but unfortunately many EPUB readeres don't support xhtml with fixed layout

Constructor & Destructor Documentation

◆ EpubSaveOptions()

ASPOSE_PDF_SHARED_API Aspose::Pdf::EpubSaveOptions::EpubSaveOptions ( )

Constructor

Member Function Documentation

◆ get_Title()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::EpubSaveOptions::get_Title ( ) const

Gets EPUB document title.

◆ set_Title()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::EpubSaveOptions::set_Title ( System::String value )

Sets EPUB document title.

◆ ToInnerSaveOptions()

System::SharedPtr<Aspose::Shared::Epub::ApsToEpubConverterOptions> Aspose::Pdf::EpubSaveOptions::ToInnerSaveOptions ( )

protected

During export to EPUB several modes of entity recognition of layout can be used This parameter defines such mode.

Member Data Documentation

◆ ContentRecognitionMode

EpubSaveOptions::RecognitionMode Aspose::Pdf::EpubSaveOptions::ContentRecognitionMode