Aspose::Pdf::ExcelSaveOptions Class Reference

Enumerates conversion engines that can be used for conversion More...

Inherits Aspose::Pdf::UnifiedSaveOptions.

Public Types

enum  ExcelFormat { ExcelFormat::XMLSpreadSheet2003, ExcelFormat::XLSX }
 
enum  ConversionEngines { ConversionEngines::LegacyEngine, ConversionEngines::NewEngine }
 
- 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

bool get_MinimizeTheNumberOfWorksheets ()
 Set true if you need to minimize the number of worksheets in resultant workbook. Default value is false; it means save of each PDF page as separated worksheet. More...
 
void set_MinimizeTheNumberOfWorksheets (bool value)
 Set true if you need to minimize the number of worksheets in resultant workbook. Default value is false; it means save of each PDF page as separated worksheet. More...
 
bool get_InsertBlankColumnAtFirst ()
 Set false if you need suppress inserting of blank column as the first column of worksheet. Default value is true; it means that blank column will be inserted. More...
 
void set_InsertBlankColumnAtFirst (bool value)
 Set false if you need suppress inserting of blank column as the first column of worksheet. Default value is true; it means that blank column will be inserted. More...
 
bool get_UniformWorksheets ()
 Set true for using uniform columns division through the document. Default value is false; it means that columns division will independent for each page. More...
 
void set_UniformWorksheets (bool value)
 Set true for using uniform columns division through the document. Default value is false; it means that columns division will independent for each page. More...
 
double get_ScaleFactor ()
 Gets factor that will be applied to (virtual) scaling font size during conversion to Excel table. Setting of less value facilitates the search for columns and prevents merging of them for some documents. Default value is 0.9; Setting value to zero allows algorithm choose scaling automatically. More...
 
void set_ScaleFactor (double value)
 Sets factor that will be applied to (virtual) scaling font size during conversion to Excel table. Setting of less value facilitates the search for columns and prevents merging of them for some documents. Default value is 0.9; Setting value to zero allows algorithm choose scaling automatically. More...
 
ExcelSaveOptions::ExcelFormat get_Format ()
 Output format More...
 
void set_Format (ExcelSaveOptions::ExcelFormat value)
 Output format More...
 
 ExcelSaveOptions ()
 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

ExcelSaveOptions::ConversionEngines ConversionEngine
 
- Public Attributes inherited from Aspose::Pdf::UnifiedSaveOptions
bool TryMergeAdjacentSameBackgroundImages
 

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)>
 
- 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
 
ApsToXpsSavingMode ApsAsXpsSavingMode
 
System::SharedPtr< Aspose::DocumentInfo > DocumentInfoForSaveAsXps
 
System::String PlainApsIntermediateTempFileIfAny
 
- Static Protected Attributes inherited from Aspose::Pdf::UnifiedSaveOptions
static const int32_t DefaultBatchSize
 

Detailed Description

Enumerates conversion engines that can be used for conversion

Member Enumeration Documentation

◆ ConversionEngines

Enumerator
LegacyEngine 

Legacy conversion engine is conversion engine thay was used for a while and is used by default.

NewEngine 

New conversion engine is currently in A-testing state. We open it into public API to get some feedback. It's currently recommended to use it only when old conversion engine cannot convert document for some reasons.

◆ ExcelFormat

Enumerator
XMLSpreadSheet2003 

Excel 2003 XML Format

XLSX 

Office Open XML (.xlsx) File Format

Constructor & Destructor Documentation

◆ ExcelSaveOptions()

Aspose::Pdf::ExcelSaveOptions::ExcelSaveOptions ( )

Constructor

Member Function Documentation

◆ get_Format()

ExcelSaveOptions::ExcelFormat Aspose::Pdf::ExcelSaveOptions::get_Format ( )

Output format

◆ get_InsertBlankColumnAtFirst()

bool Aspose::Pdf::ExcelSaveOptions::get_InsertBlankColumnAtFirst ( )

Set false if you need suppress inserting of blank column as the first column of worksheet. Default value is true; it means that blank column will be inserted.

◆ get_MinimizeTheNumberOfWorksheets()

bool Aspose::Pdf::ExcelSaveOptions::get_MinimizeTheNumberOfWorksheets ( )

Set true if you need to minimize the number of worksheets in resultant workbook. Default value is false; it means save of each PDF page as separated worksheet.

◆ get_ScaleFactor()

double Aspose::Pdf::ExcelSaveOptions::get_ScaleFactor ( )

Gets factor that will be applied to (virtual) scaling font size during conversion to Excel table. Setting of less value facilitates the search for columns and prevents merging of them for some documents. Default value is 0.9; Setting value to zero allows algorithm choose scaling automatically.

◆ get_UniformWorksheets()

bool Aspose::Pdf::ExcelSaveOptions::get_UniformWorksheets ( )

Set true for using uniform columns division through the document. Default value is false; it means that columns division will independent for each page.

◆ set_Format()

void Aspose::Pdf::ExcelSaveOptions::set_Format ( ExcelSaveOptions::ExcelFormat  value)

Output format

◆ set_InsertBlankColumnAtFirst()

void Aspose::Pdf::ExcelSaveOptions::set_InsertBlankColumnAtFirst ( bool  value)

Set false if you need suppress inserting of blank column as the first column of worksheet. Default value is true; it means that blank column will be inserted.

◆ set_MinimizeTheNumberOfWorksheets()

void Aspose::Pdf::ExcelSaveOptions::set_MinimizeTheNumberOfWorksheets ( bool  value)

Set true if you need to minimize the number of worksheets in resultant workbook. Default value is false; it means save of each PDF page as separated worksheet.

◆ set_ScaleFactor()

void Aspose::Pdf::ExcelSaveOptions::set_ScaleFactor ( double  value)

Sets factor that will be applied to (virtual) scaling font size during conversion to Excel table. Setting of less value facilitates the search for columns and prevents merging of them for some documents. Default value is 0.9; Setting value to zero allows algorithm choose scaling automatically.

◆ set_UniformWorksheets()

void Aspose::Pdf::ExcelSaveOptions::set_UniformWorksheets ( bool  value)

Set true for using uniform columns division through the document. Default value is false; it means that columns division will independent for each page.

Member Data Documentation

◆ ConversionEngine

ExcelSaveOptions::ConversionEngines Aspose::Pdf::ExcelSaveOptions::ConversionEngine