Aspose::Pdf::DocSaveOptions class

DocSaveOptions class

Save options for export to Doc format.

class DocSaveOptions : public Aspose::Pdf::UnifiedSaveOptions,
                       public Aspose::Pdf::IPipelineOptions

Methods

MethodDescription
DocSaveOptions()Constructor.
get_AddReturnToLineEnd() constUse paragraph or line breaks.
get_BatchSize() overrideDefines batch size if batched conversion is applicable to source and destination formats pair.
get_CacheGlyphs() constGets 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.
get_CloseResponse() constGets boolean value which indicates will Response object be closed after document saved into response.
get_ConvertType3Fonts() constGets conversion for Type3 fonts. In Type 3 fonts, glyphs shall be defined by streams of graphics operators. This means that in the DOC/DOCX output we see images instead of text. Set this flag to true to convert Type3 fonts to TTF and get text in the resulting file.
get_ExtractOcrSublayerOnly() constThis atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer.
get_Format() constOutput format.
get_ImageResolutionX() constConverted images X resolution.
get_ImageResolutionY() constConverted images Y resolution.
get_MaxDistanceBetweenTextLines() constThis 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_MemorySaveModePath() constDefines the path (file name or directory name) to hold temporary data when converting in memory save mode.
get_Mode() constRecognition mode.
get_RecognizeBullets() constSwitch on the recognition of bullets.
get_RelativeHorizontalProximity() constIn 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.
get_ReSaveFonts() constGets the procedure for resaving fonts. If set to true, we reload fonts on every page to avoid the influence of previous font properties and load the newly created font from scratch. Set this option to false if you want to improve performance. The default value is true;.
get_SaveFormat() constFormat of data save.
get_WarningHandler() constCallback 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.
set_AddReturnToLineEnd(bool)Use paragraph or line breaks.
set_BatchSize(int32_t) overrideDefines batch size if batched conversion is applicable to source and destination formats pair.
set_CacheGlyphs(bool)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.
set_CloseResponse(bool)Sets boolean value which indicates will Response object be closed after document saved into response.
set_ConvertType3Fonts(bool)Sets conversion for Type3 fonts. In Type 3 fonts, glyphs shall be defined by streams of graphics operators. This means that in the DOC/DOCX output we see images instead of text. Set this flag to true to convert Type3 fonts to TTF and get text in the resulting file.
set_ExtractOcrSublayerOnly(bool)This atrribute turned on functionality for extracting image or text for PDF documents with OCR sublayer.
set_Format(DocSaveOptions::DocFormat)Output format.
set_ImageResolutionX(int32_t)Converted images X resolution.
set_ImageResolutionY(int32_t)Converted images Y resolution.
set_MaxDistanceBetweenTextLines(float)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_MemorySaveModePath(System::String)Defines the path (file name or directory name) to hold temporary data when converting in memory save mode.
set_Mode(DocSaveOptions::RecognitionMode)Recognition mode.
set_RecognizeBullets(bool)Switch on the recognition of bullets.
set_RelativeHorizontalProximity(float)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_ReSaveFonts(bool)Sets the procedure for resaving fonts. If set to true, we reload fonts on every page to avoid the influence of previous font properties and load the newly created font from scratch. Set this option to false if you want to improve performance. The default value is true;.
set_WarningHandler(System::SharedPtr<IWarningCallback>)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.
UnifiedSaveOptions()

See Also