Aspose::Pdf::SvgSaveOptions Class Reference

Save options for export to SVG format More...

Inherits Aspose::Pdf::UnifiedSaveOptions.

Classes

class  SvgImageSavingInfo
 This class represents set of data that related to external resource image file's saving during PDF to HTML conversion. More...
 

Public Types

enum  SvgExternalImageType {
  SvgExternalImageType::Jpeg = 0, SvgExternalImageType::Png = 1, SvgExternalImageType::Bmp = 2, SvgExternalImageType::Gif = 3,
  SvgExternalImageType::Tiff = 4, SvgExternalImageType::Unknown = 5
}
 enumerates possible types of image files that can be saved as external resources during during Pdf to SVG conversion More...
 
using EmbeddedImagesSavingStrategy = System::MulticastDelegate< System::String(System::SharedPtr< SvgSaveOptions::SvgImageSavingInfo >)>
 
- 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< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API SvgSaveOptions ()
 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< 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 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 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 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

SvgSaveOptions::EmbeddedImagesSavingStrategy CustomStrategyOfEmbeddedImagesSaving
 This field can contain saving strategy that must be used (if present) during conversion for customized handling of created referenced external images files (like embedded BMP or JPEG) embedded into saved SVG. That strategy must process resources and return string that represents desirable URI of saved resource in generated SVG. If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'imageSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code . More...
 
bool TreatTargetFileNameAsDirectory
 This options defines whether will be created target directory (if absent yet) with same name as requested output file instead of requested output file itself. It so, that directory will contain all output SVG-images of pages (like described below). If no, output files of pages other then first one will be created exactly in requested directory as main output file, but will contain in file name suffix _[2...n], that is defined by page number, f.e. if You define output file "C:\AsposeTests\output.svg" and output will contain several svg-files of pages, then files of pages will be created also in directory "C:\AsposeTests\" and have names 'output.svg', 'output_2.svg', 'output_3.svg' etc. More...
 
bool CompressOutputToZipArchive
 Specifies whether output will be created as one zip-archive. Please refer comment to 'TreatTargetFileNameAsDirectory' options to see rules of naming of svg-files of pages for multipage source document, that are also applied to zipped set of output files. More...
 
bool ScaleToPixels
 Specifies whether to scale the output document from typographic points to pixels. 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...
 

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::UnifiedSaveOptions
using OnePageProcessedEventHandler = System::MulticastDelegate< void(int32_t)>
 
- Protected Member Functions inherited from Aspose::Pdf::UnifiedSaveOptions
int32_t GetNumberOfConvertiblePages (System::SharedPtr< Document > document)
 
- 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 SVG format

Member Typedef Documentation

◆ EmbeddedImagesSavingStrategy

Member Enumeration Documentation

◆ SvgExternalImageType

enumerates possible types of image files that can be saved as external resources during during Pdf to SVG conversion

Enumerator
Jpeg 

Jpeg format

Png 

Png format

Bmp 

Bmp format

Gif 

Gif format

Tiff 

Tiff format

Unknown 

Unknown - means that converter cannot detect type of content itself

Constructor & Destructor Documentation

◆ SvgSaveOptions()

ASPOSE_PDF_SHARED_API Aspose::Pdf::SvgSaveOptions::SvgSaveOptions ( )

Constructor

Member Data Documentation

◆ CompressOutputToZipArchive

bool Aspose::Pdf::SvgSaveOptions::CompressOutputToZipArchive

Specifies whether output will be created as one zip-archive. Please refer comment to 'TreatTargetFileNameAsDirectory' options to see rules of naming of svg-files of pages for multipage source document, that are also applied to zipped set of output files.

◆ CustomStrategyOfEmbeddedImagesSaving

SvgSaveOptions::EmbeddedImagesSavingStrategy Aspose::Pdf::SvgSaveOptions::CustomStrategyOfEmbeddedImagesSaving

This field can contain saving strategy that must be used (if present) during conversion for customized handling of created referenced external images files (like embedded BMP or JPEG) embedded into saved SVG. That strategy must process resources and return string that represents desirable URI of saved resource in generated SVG. If processing for this or that file for some reason must be done by converter's code itself, not in custom code, please set in custom code flag 'CustomProcessingCancelled' of 'imageSavingInfo' parameter's variable It signals to converter that all the necessary steps for processing of that resource must be done in converter itself as if there was no any external custom code .

◆ ScaleToPixels

bool Aspose::Pdf::SvgSaveOptions::ScaleToPixels

Specifies whether to scale the output document from typographic points to pixels.

◆ TreatTargetFileNameAsDirectory

bool Aspose::Pdf::SvgSaveOptions::TreatTargetFileNameAsDirectory

This options defines whether will be created target directory (if absent yet) with same name as requested output file instead of requested output file itself. It so, that directory will contain all output SVG-images of pages (like described below). If no, output files of pages other then first one will be created exactly in requested directory as main output file, but will contain in file name suffix _[2...n], that is defined by page number, f.e. if You define output file "C:\AsposeTests\output.svg" and output will contain several svg-files of pages, then files of pages will be created also in directory "C:\AsposeTests\" and have names 'output.svg', 'output_2.svg', 'output_3.svg' etc.