Allows to specify .doc or .docx file format. More...

Inherits Aspose::Pdf::UnifiedSaveOptions.

Public Types

enum  RecognitionMode { RecognitionMode::Textbox, RecognitionMode::Flow }
 
enum  DocFormat { DocFormat::Doc, DocFormat::DocX }
 
- 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
}
 
enum  NodeLevelResourceType { NodeLevelResourceType::Image = 0, NodeLevelResourceType::Font = 1 }
 
- 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

DocSaveOptions::RecognitionMode get_Mode ()
 Recognition mode. More...
 
void set_Mode (DocSaveOptions::RecognitionMode value)
 Recognition mode. More...
 
float get_RelativeHorizontalProximity ()
 In Pdf words may be innerly represented with operators that prints words by independently printing their letters or syllables. So, to detect words sometimes we need detect groups of independent chars that are in fact words. This setting defines width of space between text elements(letters, syllables) that must be treated as distance between words during recognition of words in source PDF. (presence of empty space at least with this width between letters means that textual elements pertain to different words). It's normed to font size - 1.0 means 100% of supposed word's font size. ATTENTION!It's used only in cases when source PDF contains specific rarely used fonts for which optimal value cannot be calculated from font. So, in vast majority of cases this parameter changes nothing in result document. More...
 
void set_RelativeHorizontalProximity (float value)
 In Pdf words may be innerly represented with operators that prints words by independently printing their letters or syllables. So, to detect words sometimes we need detect groups of independent chars that are in fact words. This setting defines width of space between text elements(letters, syllables) that must be treated as distance between words during recognition of words in source PDF. (presence of empty space at least with this width between letters means that textual elements pertain to different words). It's normed to font size - 1.0 means 100% of supposed word's font size. ATTENTION!It's used only in cases when source PDF contains specific rarely used fonts for which optimal value cannot be calculated from font. So, in vast majority of cases this parameter changes nothing in result document. More...
 
float get_MaxDistanceBetweenTextLines ()
 
void set_MaxDistanceBetweenTextLines (float value)
 
bool get_RecognizeBullets ()
 Switch on the recognition of bullets More...
 
void set_RecognizeBullets (bool value)
 Switch on the recognition of bullets More...
 
bool get_AddReturnToLineEnd ()
 Use paragraph or line breaks More...
 
void set_AddReturnToLineEnd (bool value)
 Use paragraph or line breaks More...
 
int32_t get_ImageResolutionX ()
 Converted images X resolution. More...
 
void set_ImageResolutionX (int32_t value)
 Converted images X resolution. More...
 
int32_t get_ImageResolutionY ()
 Converted images Y resolution. More...
 
void set_ImageResolutionY (int32_t value)
 Converted images Y resolution. More...
 
DocSaveOptions::DocFormat get_Format ()
 Output format More...
 
void set_Format (DocSaveOptions::DocFormat value)
 Output format More...
 
 DocSaveOptions ()
 Constructor More...
 
- Public Member Functions inherited from Aspose::Pdf::UnifiedSaveOptions
bool get_ExtractOcrSublayerOnly ()
 This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. More...
 
void set_ExtractOcrSublayerOnly (bool value)
 This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer. More...
 
 UnifiedSaveOptions ()
 
- Public Member Functions inherited from Aspose::Pdf::SaveOptions
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 Save operation continues, however the user may also return Abort in which case the Save 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 Save operation continues, however the user may also return Abort in which case the Save operation should cease. More...
 
Aspose::Pdf::SaveFormat get_SaveFormat ()
 Format of data save. More...
 
bool get_CloseResponse ()
 Gets boolean value which indicates will Response object be closed after document saved into response. More...
 
void set_CloseResponse (bool value)
 Sets boolean value which indicates will Response object be closed after document saved into response. More...
 
 SaveOptions ()
 
- 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

UnifiedSaveOptions::ConversionProgressEventHandler CustomProgressHandler
 
- Public Attributes inherited from Aspose::Pdf::UnifiedSaveOptions
bool TryMergeAdjacentSameBackgroundImages
 

Protected Attributes

bool UseNewTextBoxRecognitionAlgorithm
 
- Protected Attributes inherited from Aspose::Pdf::UnifiedSaveOptions
System::SharedPtr< ConversionProgressEventsTranslator > ProgressEventsRetranslator
 
- Protected Attributes inherited from Aspose::Pdf::SaveOptions
Aspose::Pdf::SaveFormat _saveFormat
 
System::String ApsIntermediateFileIfAny
 
System::String XpsIntermediateFileIfAny
 
System::String PngIntermediateFileIfAny
 
ApsToXpsSavingType ApsAsXpsSavingType
 
System::SharedPtr< Aspose::DocumentInfo > DocumentInfoForSaveAsXps
 
System::String PlainApsIntermediateTempFileIfAny
 

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::UnifiedSaveOptions
using OnePageProcessedEventHandler = System::MulticastDelegate< void(int32_t)>
 

Detailed Description

Allows to specify .doc or .docx file format.

Member Enumeration Documentation

◆ DocFormat

Enumerator
Doc 
DocX 

Office Open XML (.docx) File Format

◆ RecognitionMode

Enumerator
Textbox 

This mode is fast and good for maximally preserving original look of the PDF file, but editability of the resulting document could be limited.

Every visually grouped block of text int the original PDF file is converted into a textbox in the resulting document. This achieves maximal resemblance of the output document to the original PDF file. The output document will look good, but it will consist entirely of textboxes and it could makes further editing of the document in Microsoft Word quite hard.

This is the default mode.

Flow 

Full recognition mode, the engine performs grouping and multi-level analysis to restore the original document author's intent and produce a maximally editable document. The downside is that the output document might look different from the original PDF file.

Constructor & Destructor Documentation

◆ DocSaveOptions()

Aspose::Pdf::DocSaveOptions::DocSaveOptions ( )

Constructor

Member Function Documentation

◆ get_AddReturnToLineEnd()

bool Aspose::Pdf::DocSaveOptions::get_AddReturnToLineEnd ( )

Use paragraph or line breaks

◆ get_Format()

DocSaveOptions::DocFormat Aspose::Pdf::DocSaveOptions::get_Format ( )

Output format

◆ get_ImageResolutionX()

int32_t Aspose::Pdf::DocSaveOptions::get_ImageResolutionX ( )

Converted images X resolution.

◆ get_ImageResolutionY()

int32_t Aspose::Pdf::DocSaveOptions::get_ImageResolutionY ( )

Converted images Y resolution.

◆ get_MaxDistanceBetweenTextLines()

float Aspose::Pdf::DocSaveOptions::get_MaxDistanceBetweenTextLines ( )

This parameter is used for grouping text lines into paragraphs. Determines how far apart can be two relative text lines. Specified in hundreds of percent of the text lines height.

◆ get_Mode()

DocSaveOptions::RecognitionMode Aspose::Pdf::DocSaveOptions::get_Mode ( )

Recognition mode.

◆ get_RecognizeBullets()

bool Aspose::Pdf::DocSaveOptions::get_RecognizeBullets ( )

Switch on the recognition of bullets

◆ get_RelativeHorizontalProximity()

float Aspose::Pdf::DocSaveOptions::get_RelativeHorizontalProximity ( )

In Pdf words may be innerly represented with operators that prints words by independently printing their letters or syllables. So, to detect words sometimes we need detect groups of independent chars that are in fact words. This setting defines width of space between text elements(letters, syllables) that must be treated as distance between words during recognition of words in source PDF. (presence of empty space at least with this width between letters means that textual elements pertain to different words). It's normed to font size - 1.0 means 100% of supposed word's font size. ATTENTION!It's used only in cases when source PDF contains specific rarely used fonts for which optimal value cannot be calculated from font. So, in vast majority of cases this parameter changes nothing in result document.

◆ set_AddReturnToLineEnd()

void Aspose::Pdf::DocSaveOptions::set_AddReturnToLineEnd ( bool  value)

Use paragraph or line breaks

◆ set_Format()

void Aspose::Pdf::DocSaveOptions::set_Format ( DocSaveOptions::DocFormat  value)

Output format

◆ set_ImageResolutionX()

void Aspose::Pdf::DocSaveOptions::set_ImageResolutionX ( int32_t  value)

Converted images X resolution.

◆ set_ImageResolutionY()

void Aspose::Pdf::DocSaveOptions::set_ImageResolutionY ( int32_t  value)

Converted images Y resolution.

◆ set_MaxDistanceBetweenTextLines()

void Aspose::Pdf::DocSaveOptions::set_MaxDistanceBetweenTextLines ( float  value)

This parameter is used for grouping text lines into paragraphs. Determines how far apart can be two relative text lines. Specified in hundreds of percent of the text lines height.

◆ set_Mode()

void Aspose::Pdf::DocSaveOptions::set_Mode ( DocSaveOptions::RecognitionMode  value)

Recognition mode.

◆ set_RecognizeBullets()

void Aspose::Pdf::DocSaveOptions::set_RecognizeBullets ( bool  value)

Switch on the recognition of bullets

◆ set_RelativeHorizontalProximity()

void Aspose::Pdf::DocSaveOptions::set_RelativeHorizontalProximity ( float  value)

In Pdf words may be innerly represented with operators that prints words by independently printing their letters or syllables. So, to detect words sometimes we need detect groups of independent chars that are in fact words. This setting defines width of space between text elements(letters, syllables) that must be treated as distance between words during recognition of words in source PDF. (presence of empty space at least with this width between letters means that textual elements pertain to different words). It's normed to font size - 1.0 means 100% of supposed word's font size. ATTENTION!It's used only in cases when source PDF contains specific rarely used fonts for which optimal value cannot be calculated from font. So, in vast majority of cases this parameter changes nothing in result document.

Member Data Documentation

◆ CustomProgressHandler

UnifiedSaveOptions::ConversionProgressEventHandler Aspose::Pdf::DocSaveOptions::CustomProgressHandler

◆ UseNewTextBoxRecognitionAlgorithm

bool Aspose::Pdf::DocSaveOptions::UseNewTextBoxRecognitionAlgorithm
protected