search/mag_sel search/close
HtmlSaveOptions.h
1 // Copyright 2001-2021 Aspose Pty Ltd. All Rights Reserved.
3 //
4 // This file is part of Aspose.Words. The source code in this file
5 // is only intended as a supplement to the documentation, and is provided
6 // "as is", without warranty of any kind, either expressed or implied.
9 #pragma once
10 
11 #include <system/string.h>
12 #include <system/enum_helpers.h>
13 #include <cstdint>
14 
15 #include <Aspose.Words.Cpp/Saving/SaveOptions.h>
16 #include <Aspose.Words.Cpp/Saving/HtmlVersion.h>
17 #include <Aspose.Words.Cpp/Saving/HtmlOfficeMathOutputMode.h>
18 #include <Aspose.Words.Cpp/Saving/HtmlMetafileFormat.h>
19 #include <Aspose.Words.Cpp/Saving/HtmlElementSizeOutputMode.h>
20 #include <Aspose.Words.Cpp/Saving/ExportListLabels.h>
21 #include <Aspose.Words.Cpp/Saving/ExportHeadersFootersMode.h>
22 #include <Aspose.Words.Cpp/Saving/DocumentSplitCriteria.h>
23 #include <Aspose.Words.Cpp/Saving/CssStyleSheetType.h>
24 #include <Aspose.Words.Cpp/SaveFormat.h>
25 #include <Aspose.Words.Cpp/aspose_words_api_defs.h>
26 
27 namespace Aspose { namespace Words { namespace RW { namespace Html { class HtmlFontNameResolver; } } } }
28 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlNegativeMarginEliminator; } } } } }
29 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlImageWriter; } } } } }
30 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlStyleWriter; } } } } }
31 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlStyleResolver; } } } } }
32 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlCoreWriter; } } } } }
33 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlDocumentFragmentWriter; } } } } }
34 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlFieldWriter; } } } } }
35 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlSpanWriter; } } } } }
36 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlBookmarkWriter; } } } } }
37 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlTableWriter; } } } } }
38 namespace Aspose { namespace Words { namespace RW { namespace Epub { namespace Writer { class EpubWriter; } } } } }
39 namespace Aspose { namespace Words { namespace RW { namespace Epub { namespace Writer { class OpfBuilder; } } } } }
40 namespace Aspose { namespace Words { namespace RW { namespace Html { class CssUtil; } } } }
41 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlFileBuilder; } } } } }
42 namespace Aspose { namespace Words { namespace RW { namespace Html { namespace Writer { class HtmlListWriter; } } } } }
43 namespace Aspose { namespace Words { namespace RW { namespace Mhtml { namespace Writer { class MhtmlWriter; } } } } }
44 namespace Aspose { namespace Words { namespace RW { namespace Factories { class WriterFactory; } } } }
45 namespace Aspose { namespace Words { namespace Saving { class IDocumentPartSavingCallback; } } }
46 namespace Aspose { namespace Words { namespace Saving { class ICssSavingCallback; } } }
47 namespace System { namespace Text { class Encoding; } }
48 namespace Aspose { namespace Words { namespace Saving { class IFontSavingCallback; } } }
49 namespace Aspose { namespace Words { namespace Saving { class IImageSavingCallback; } } }
50 namespace Aspose { namespace Words { namespace RW { class SaveImageOptions; } } }
51 namespace Aspose { namespace Words { namespace Saving { enum class WebStandard; } } }
52 
53 namespace Aspose {
54 
55 namespace Words {
56 
57 namespace Saving {
58 
229 class ASPOSE_WORDS_SHARED_CLASS HtmlSaveOptions : public Aspose::Words::Saving::SaveOptions
230 {
231  typedef HtmlSaveOptions ThisType;
232  typedef Aspose::Words::Saving::SaveOptions BaseType;
233 
234  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
235  ASPOSE_WORDS_SHARED_RTTI_INFO_DECL();
236 
237  friend class Aspose::Words::RW::Html::HtmlFontNameResolver;
238  friend class Aspose::Words::RW::Html::Writer::HtmlNegativeMarginEliminator;
239  friend class Aspose::Words::RW::Html::Writer::HtmlImageWriter;
240  friend class Aspose::Words::RW::Html::Writer::HtmlStyleWriter;
241  friend class Aspose::Words::RW::Html::Writer::HtmlStyleResolver;
242  friend class Aspose::Words::RW::Html::Writer::HtmlCoreWriter;
243  friend class Aspose::Words::RW::Html::Writer::HtmlDocumentFragmentWriter;
244  friend class Aspose::Words::RW::Html::Writer::HtmlFieldWriter;
245  friend class Aspose::Words::RW::Html::Writer::HtmlSpanWriter;
246  friend class Aspose::Words::RW::Html::Writer::HtmlBookmarkWriter;
247  friend class Aspose::Words::RW::Html::Writer::HtmlTableWriter;
248  friend class Aspose::Words::RW::Epub::Writer::EpubWriter;
249  friend class Aspose::Words::RW::Epub::Writer::OpfBuilder;
250  friend class Aspose::Words::RW::Html::CssUtil;
251  friend class Aspose::Words::RW::Html::Writer::HtmlFileBuilder;
252  friend class Aspose::Words::RW::Html::Writer::HtmlListWriter;
253  friend class Aspose::Words::RW::Mhtml::Writer::MhtmlWriter;
254  friend class Aspose::Words::RW::Factories::WriterFactory;
255 
256 public:
257 
284  ASPOSE_WORDS_SHARED_API Aspose::Words::SaveFormat get_SaveFormat() override;
285 
287  ASPOSE_WORDS_SHARED_API void set_SaveFormat(Aspose::Words::SaveFormat value) override;
288 
355  ASPOSE_WORDS_SHARED_API bool get_AllowNegativeIndent() const;
356 
358  ASPOSE_WORDS_SHARED_API void set_AllowNegativeIndent(bool value);
359 
440  ASPOSE_WORDS_SHARED_API System::String get_CssStyleSheetFileName() const;
441 
443  ASPOSE_WORDS_SHARED_API void set_CssStyleSheetFileName(System::String value);
444 
514  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::CssStyleSheetType get_CssStyleSheetType() const;
515 
517  ASPOSE_WORDS_SHARED_API void set_CssStyleSheetType(Aspose::Words::Saving::CssStyleSheetType value);
518 
552  ASPOSE_WORDS_SHARED_API System::String get_CssClassNamePrefix() const;
553 
555  ASPOSE_WORDS_SHARED_API void set_CssClassNamePrefix(System::String value);
556 
684  ASPOSE_WORDS_SHARED_API System::SharedPtr<Aspose::Words::Saving::IDocumentPartSavingCallback> get_DocumentPartSavingCallback() const;
685 
687  ASPOSE_WORDS_SHARED_API void set_DocumentPartSavingCallback(System::SharedPtr<Aspose::Words::Saving::IDocumentPartSavingCallback> value);
688 
749  ASPOSE_WORDS_SHARED_API System::SharedPtr<Aspose::Words::Saving::ICssSavingCallback> get_CssSavingCallback() const;
750 
752  ASPOSE_WORDS_SHARED_API void set_CssSavingCallback(System::SharedPtr<Aspose::Words::Saving::ICssSavingCallback> value);
753 
791  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::DocumentSplitCriteria get_DocumentSplitCriteria() const;
792 
794  ASPOSE_WORDS_SHARED_API void set_DocumentSplitCriteria(Aspose::Words::Saving::DocumentSplitCriteria value);
795 
862  ASPOSE_WORDS_SHARED_API int32_t get_DocumentSplitHeadingLevel() const;
863 
865  ASPOSE_WORDS_SHARED_API void set_DocumentSplitHeadingLevel(int32_t value);
866 
892  ASPOSE_WORDS_SHARED_API System::SharedPtr<System::Text::Encoding> get_Encoding() const;
893 
895  ASPOSE_WORDS_SHARED_API void set_Encoding(System::SharedPtr<System::Text::Encoding> value);
896 
943  ASPOSE_WORDS_SHARED_API int32_t get_EpubNavigationMapLevel() const;
944 
946  ASPOSE_WORDS_SHARED_API void set_EpubNavigationMapLevel(int32_t value);
947 
973  ASPOSE_WORDS_SHARED_API bool get_ExportDocumentProperties() const;
974 
976  ASPOSE_WORDS_SHARED_API void set_ExportDocumentProperties(bool value);
977 
1064  ASPOSE_WORDS_SHARED_API bool get_ExportFontResources() const;
1065 
1067  ASPOSE_WORDS_SHARED_API void set_ExportFontResources(bool value);
1068 
1104  ASPOSE_WORDS_SHARED_API bool get_ExportFontsAsBase64() const;
1105 
1107  ASPOSE_WORDS_SHARED_API void set_ExportFontsAsBase64(bool value);
1108 
1147  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::ExportHeadersFootersMode get_ExportHeadersFootersMode() const;
1148 
1150  ASPOSE_WORDS_SHARED_API void set_ExportHeadersFootersMode(Aspose::Words::Saving::ExportHeadersFootersMode value);
1151 
1187  ASPOSE_WORDS_SHARED_API bool get_ExportImagesAsBase64();
1188 
1190  ASPOSE_WORDS_SHARED_API void set_ExportImagesAsBase64(bool value);
1191 
1242  ASPOSE_WORDS_SHARED_API bool get_ExportLanguageInformation() const;
1243 
1245  ASPOSE_WORDS_SHARED_API void set_ExportLanguageInformation(bool value);
1246 
1339  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::ExportListLabels get_ExportListLabels() const;
1340 
1342  ASPOSE_WORDS_SHARED_API void set_ExportListLabels(Aspose::Words::Saving::ExportListLabels value);
1343 
1403  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::HtmlMetafileFormat get_MetafileFormat();
1404 
1406  ASPOSE_WORDS_SHARED_API void set_MetafileFormat(Aspose::Words::Saving::HtmlMetafileFormat value);
1407 
1464  ASPOSE_WORDS_SHARED_API bool get_ExportPageSetup() const;
1465 
1467  ASPOSE_WORDS_SHARED_API void set_ExportPageSetup(bool value);
1468 
1513  ASPOSE_WORDS_SHARED_API bool get_ExportPageMargins() const;
1514 
1516  ASPOSE_WORDS_SHARED_API void set_ExportPageMargins(bool value);
1517 
1579  ASPOSE_WORDS_SHARED_API bool get_ExportRelativeFontSize() const;
1580 
1582  ASPOSE_WORDS_SHARED_API void set_ExportRelativeFontSize(bool value);
1583 
1615  ASPOSE_WORDS_SHARED_API bool get_ExportTextInputFormFieldAsText() const;
1616 
1618  ASPOSE_WORDS_SHARED_API void set_ExportTextInputFormFieldAsText(bool value);
1619 
1664  ASPOSE_WORDS_SHARED_API bool get_ExportTextBoxAsSvg();
1665 
1667  ASPOSE_WORDS_SHARED_API void set_ExportTextBoxAsSvg(bool value);
1668 
1710  ASPOSE_WORDS_SHARED_API bool get_ExportDropDownFormFieldAsText() const;
1711 
1713  ASPOSE_WORDS_SHARED_API void set_ExportDropDownFormFieldAsText(bool value);
1714 
1769  ASPOSE_WORDS_SHARED_API bool get_ExportTocPageNumbers() const;
1770 
1772  ASPOSE_WORDS_SHARED_API void set_ExportTocPageNumbers(bool value);
1773 
1829  ASPOSE_WORDS_SHARED_API bool get_ExportXhtmlTransitional() const;
1830 
1832  ASPOSE_WORDS_SHARED_API void set_ExportXhtmlTransitional(bool value);
1833 
1899  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::HtmlVersion get_HtmlVersion() const;
1900 
1902  ASPOSE_WORDS_SHARED_API void set_HtmlVersion(Aspose::Words::Saving::HtmlVersion value);
1903 
1981  ASPOSE_WORDS_SHARED_API bool get_ExportRoundtripInformation() const;
1982 
1984  ASPOSE_WORDS_SHARED_API void set_ExportRoundtripInformation(bool value);
1985 
2025  ASPOSE_WORDS_SHARED_API System::String get_ResourceFolder() const;
2026 
2028  ASPOSE_WORDS_SHARED_API void set_ResourceFolder(System::String value);
2029 
2074  ASPOSE_WORDS_SHARED_API System::String get_ResourceFolderAlias() const;
2075 
2077  ASPOSE_WORDS_SHARED_API void set_ResourceFolderAlias(System::String value);
2078 
2126  ASPOSE_WORDS_SHARED_API System::String get_FontsFolder() const;
2127 
2129  ASPOSE_WORDS_SHARED_API void set_FontsFolder(System::String value);
2130 
2177  ASPOSE_WORDS_SHARED_API System::String get_FontsFolderAlias() const;
2178 
2180  ASPOSE_WORDS_SHARED_API void set_FontsFolderAlias(System::String value);
2181 
2255  ASPOSE_WORDS_SHARED_API int32_t get_FontResourcesSubsettingSizeThreshold() const;
2256 
2258  ASPOSE_WORDS_SHARED_API void set_FontResourcesSubsettingSizeThreshold(int32_t value);
2259 
2328  ASPOSE_WORDS_SHARED_API System::SharedPtr<Aspose::Words::Saving::IFontSavingCallback> get_FontSavingCallback() const;
2329 
2331  ASPOSE_WORDS_SHARED_API void set_FontSavingCallback(System::SharedPtr<Aspose::Words::Saving::IFontSavingCallback> value);
2332 
2380  ASPOSE_WORDS_SHARED_API System::String get_ImagesFolder() const;
2381 
2383  ASPOSE_WORDS_SHARED_API void set_ImagesFolder(System::String value);
2384 
2430  ASPOSE_WORDS_SHARED_API System::String get_ImagesFolderAlias() const;
2431 
2433  ASPOSE_WORDS_SHARED_API void set_ImagesFolderAlias(System::String value);
2434 
2466  ASPOSE_WORDS_SHARED_API int32_t get_ImageResolution();
2467 
2469  ASPOSE_WORDS_SHARED_API void set_ImageResolution(int32_t value);
2470 
2598  ASPOSE_WORDS_SHARED_API System::SharedPtr<Aspose::Words::Saving::IImageSavingCallback> get_ImageSavingCallback();
2599 
2601  ASPOSE_WORDS_SHARED_API void set_ImageSavingCallback(System::SharedPtr<Aspose::Words::Saving::IImageSavingCallback> value);
2602 
2657  ASPOSE_WORDS_SHARED_API bool get_ScaleImageToShapeSize();
2658 
2660  ASPOSE_WORDS_SHARED_API void set_ScaleImageToShapeSize(bool value);
2661 
2740  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::HtmlElementSizeOutputMode get_TableWidthOutputMode() const;
2741 
2743  ASPOSE_WORDS_SHARED_API void set_TableWidthOutputMode(Aspose::Words::Saving::HtmlElementSizeOutputMode value);
2744 
2796  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::HtmlOfficeMathOutputMode get_OfficeMathOutputMode() const;
2797 
2799  ASPOSE_WORDS_SHARED_API void set_OfficeMathOutputMode(Aspose::Words::Saving::HtmlOfficeMathOutputMode value);
2800 
2834  ASPOSE_WORDS_SHARED_API bool get_ExportOriginalUrlForLinkedImages() const;
2835 
2837  ASPOSE_WORDS_SHARED_API void set_ExportOriginalUrlForLinkedImages(bool value);
2838 
2888  ASPOSE_WORDS_SHARED_API bool get_ExportCidUrlsForMhtmlResources() const;
2889 
2891  ASPOSE_WORDS_SHARED_API void set_ExportCidUrlsForMhtmlResources(bool value);
2892 
2903  ASPOSE_WORDS_SHARED_API bool get_ResolveFontNames() const;
2904 
2906  ASPOSE_WORDS_SHARED_API void set_ResolveFontNames(bool value);
2907 
2933  ASPOSE_WORDS_SHARED_API HtmlSaveOptions();
2934 
2974  ASPOSE_WORDS_SHARED_API HtmlSaveOptions(Aspose::Words::SaveFormat saveFormat);
2975 
2976 protected:
2977 
2978  ASPOSE_WORDS_SHARED_API bool get_IsMultipleMainPartsAllowed() override;
2979  bool get_EnforceEpubCompliance() const;
2980  void set_EnforceEpubCompliance(bool value);
2981  bool get_ExportBookmarkIdInsteadOfName();
2982  bool get_ExportGenericFontFamilies() const;
2983  void set_ExportGenericFontFamilies(bool value);
2984  bool get_ExportTimeStamps() const;
2985  void set_ExportTimeStamps(bool value);
2986  bool get_MhtmlEmailCompatible() const;
2987  void set_MhtmlEmailCompatible(bool value);
2988  System::String get_MediaType() const;
2989  void set_MediaType(System::String value);
2990  bool get_IsHtml5();
2991  System::SharedPtr<Aspose::Words::RW::SaveImageOptions> get_SaveImageOptions();
2992  bool get_IsConvertOfficeMathToShape();
2993  Aspose::Words::Saving::WebStandard get_WebStandard();
2994 
2995  static System::SharedPtr<Aspose::Words::Saving::HtmlSaveOptions> CreateSaveFragmentOptions();
2996  System::SharedPtr<Aspose::Words::Saving::HtmlSaveOptions> Clone();
2997  ASPOSE_WORDS_SHARED_API void SetTestMode() override;
2998 
2999 private:
3000 
3001  bool pr_ResolveFontNames;
3002  System::SharedPtr<Aspose::Words::RW::SaveImageOptions> mSaveImageOptions;
3003  Aspose::Words::SaveFormat mSaveFormat;
3004  bool mExportTimeStamps;
3005  bool mExportLanguageInformation;
3006  System::String mResourceFolder;
3007  System::String mResourceFolderAlias;
3008  System::String mImagesFolder;
3009  System::String mImagesFolderAlias;
3010  System::String mCssStyleSheetFileName;
3011  System::SharedPtr<Aspose::Words::Saving::ICssSavingCallback> mCssSavingCallback;
3012  bool mExportTextInputFormFieldAsText;
3013  bool mExportDropDownFormFieldAsText;
3014  Aspose::Words::Saving::ExportHeadersFootersMode mExportHeadersFootersMode;
3015  bool mAllowNegativeIndent;
3016  bool mExportDocumentProperties;
3017  bool mExportRoundtripInformation;
3018  bool mExportOriginalUrlForLinkedImages;
3019  bool mExportCidUrlsForMhtmlResources;
3020  Aspose::Words::Saving::CssStyleSheetType mCssStyleSheetType;
3021  Aspose::Words::Saving::HtmlElementSizeOutputMode mTableWidthOutputMode;
3022  Aspose::Words::Saving::HtmlOfficeMathOutputMode mOfficeMathOutputMode;
3023  bool mExportPageSetup;
3024  System::SharedPtr<System::Text::Encoding> mEncoding;
3025  bool mExportXhtmlTransitional;
3026  Aspose::Words::Saving::HtmlVersion mHtmlVersion;
3027  bool mExportRelativeFontSize;
3028  bool mExportFontResources;
3029  int32_t mFontResourcesSubsettingSizeThreshold;
3030  System::String mFontsFolder;
3031  System::String mFontsFolderAlias;
3032  Aspose::Words::Saving::DocumentSplitCriteria mDocumentSplitCriteria;
3033  int32_t mDocumentSplitHeadingLevel;
3034  Aspose::Words::Saving::ExportListLabels mExportListLabels;
3035  System::SharedPtr<Aspose::Words::Saving::IFontSavingCallback> mFontSavingCallback;
3036  System::SharedPtr<Aspose::Words::Saving::IDocumentPartSavingCallback> mDocumentPartSavingCallback;
3037  bool mExportTocPageNumbers;
3038  bool mMhtmlEmailCompatible;
3039  int32_t mEpubNavigationMapLevel;
3040  System::String mMediaType;
3041  bool mExportGenericFontFamilies;
3042  bool mEnforceEpubCompliance;
3043  bool mExportPageMargins;
3044  bool mExportFontsAsBase64;
3045  System::String mCssClassNamesPrefix;
3046 
3047  void SetSaveFormatCore(Aspose::Words::SaveFormat saveFormat);
3048 
3049 };
3050 
3051 }
3052 }
3053 }