FixedPageSaveOptions.h
1 // Copyright 2001-2020 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/shared_ptr.h>
12 #include <system/object.h>
13 #include <system/io/stream.h>
14 #include <cstdint>
15 
16 #include "Aspose.Words.Cpp/Model/Saving/SaveOptions.h"
17 #include "Aspose.Words.Cpp/Model/Saving/NumeralFormat.h"
18 #include "Aspose.Words.Cpp/Model/Saving/ColorMode.h"
19 #include "Aspose.Words.Cpp/aspose_words_api_defs.h"
20 
21 namespace Aspose { namespace Words { namespace Saving { class PageSavingCallbackCore; } } }
22 namespace Aspose { namespace Words { namespace Layout { namespace Core { class DocumentLayout; } } } }
23 namespace Aspose { namespace Words { namespace Layout { class LayoutOptionsCore; } } }
24 namespace Aspose { namespace Words { class Document; } }
25 namespace Aspose { namespace Words { namespace RW { class FixedPageWriterBase; } } }
26 namespace Aspose { namespace Words { namespace RW { namespace Imaging { namespace Writer { class ImagingWriter; } } } } }
27 namespace Aspose { namespace Words { namespace Saving { class PageSet; } } }
28 namespace Aspose { namespace Words { namespace Saving { class IPageSavingCallback; } } }
29 namespace Aspose { namespace Words { namespace Saving { class MetafileRenderingOptions; } } }
30 
31 namespace Aspose {
32 
33 namespace Words {
34 
35 namespace Saving {
36 
55 class ASPOSE_WORDS_SHARED_CLASS FixedPageSaveOptions : public Aspose::Words::Saving::SaveOptions
56 {
59 
60  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
61  ASPOSE_WORDS_SHARED_RTTI_INFO_DECL();
62 
63  friend class Aspose::Words::Saving::PageSavingCallbackCore;
64  friend class Aspose::Words::Layout::Core::DocumentLayout;
65  friend class Aspose::Words::Layout::LayoutOptionsCore;
66  friend class Aspose::Words::Document;
67  friend class Aspose::Words::RW::FixedPageWriterBase;
68  friend class Aspose::Words::RW::Imaging::Writer::ImagingWriter;
69 
70 public:
71 
75 
79 
97  ASPOSE_WORDS_SHARED_API int32_t get_PageIndex() const;
98 
100  ASPOSE_WORDS_SHARED_API void set_PageIndex(int32_t value);
101 
119  ASPOSE_WORDS_SHARED_API int32_t get_PageCount() const;
120 
122  ASPOSE_WORDS_SHARED_API void set_PageCount(int32_t value);
123 
126 
129 
148 
150  ASPOSE_WORDS_SHARED_API void set_NumeralFormat(Aspose::Words::Saving::NumeralFormat value);
151 
154 
157 
184  ASPOSE_WORDS_SHARED_API int32_t get_JpegQuality() const;
185 
187  ASPOSE_WORDS_SHARED_API void set_JpegQuality(int32_t value);
188 
203  ASPOSE_WORDS_SHARED_API Aspose::Words::Saving::ColorMode get_ColorMode() const;
204 
206  ASPOSE_WORDS_SHARED_API void set_ColorMode(Aspose::Words::Saving::ColorMode value);
207 
255  virtual ASPOSE_WORDS_SHARED_API bool get_OptimizeOutput();
256 
258  virtual ASPOSE_WORDS_SHARED_API void set_OptimizeOutput(bool value);
259 
261  ASPOSE_WORDS_SHARED_API bool Equals(System::SharedPtr<System::Object> obj) override;
262 
263 protected:
264 
265  ASPOSE_WORDS_SHARED_API bool get_IsFlowFormat() override;
266  System::SharedPtr<System::IO::Stream> get_LayoutExportStream() const;
267  void set_LayoutExportStream(System::SharedPtr<System::IO::Stream> value);
268  virtual ASPOSE_WORDS_SHARED_API bool get_CreateOutlinesForHeadingsInTables();
269 
270  ASPOSE_WORDS_SHARED_API FixedPageSaveOptions();
271 
273  Aspose::Words::Saving::NumeralFormat GetNumeralFormatInternal();
274  void UpdatePageSet();
275  ASPOSE_WORDS_SHARED_API System::Object::shared_members_type GetSharedMembers() override;
276 
277 private:
278 
279  System::SharedPtr<System::IO::Stream> mLayoutExportStream;
280  int32_t mPageCount;
281  int32_t mPageIndex;
285  int32_t mJpegQuality;
287  bool mOptimizeOutput;
289  bool mIsPageSetUpdateFromIndexAndCountNeeded;
290 
291 };
292 
293 }
294 }
295 }
virtual bool get_OptimizeOutput()
Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvas...
Aspose::Words::Saving::ColorMode get_ColorMode() const
Gets or sets a value determining how colors are rendered.
System::Details::SharedMembersType shared_members_type
NumeralFormat
Indicates the symbol set that is used to represent numbers while rendering to fixed page formats.
Definition: NumeralFormat.h:40
void set_PageSet(System::SharedPtr< Aspose::Words::Saving::PageSet > value)
Sets the pages to render. Default is all the pages in the document.
Contains common options that can be specified when saving a document into fixed page formats (PDF,...
Definition: FixedPageSaveOptions.h:56
@ Normal
ColorMode
Specifies how colors are rendered.
Definition: ColorMode.h:37
Represents a Word document.
Definition: Document.h:277
virtual void set_OptimizeOutput(bool value)
Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_OptimizeOutput.
System::SharedPtr< Aspose::Words::Saving::IPageSavingCallback > get_PageSavingCallback() const
Allows to control how separate pages are saved when a document is exported to fixed page format.
System::SharedPtr< Aspose::Words::Saving::MetafileRenderingOptions > get_MetafileRenderingOptions() const
Allows to specify metafile rendering options.
void set_PageIndex(int32_t value)
Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_PageIndex.
int32_t get_JpegQuality() const
Gets or sets a value determining the quality of the JPEG images inside Html document.
This is an abstract base class for classes that allow the user to specify additional options when sav...
Definition: SaveOptions.h:81
void set_MetafileRenderingOptions(System::SharedPtr< Aspose::Words::Saving::MetafileRenderingOptions > value)
Allows to specify metafile rendering options.
System::SharedPtr< Aspose::Words::Saving::PageSet > get_PageSet() const
Gets the pages to render. Default is all the pages in the document.
bool Equals(System::SharedPtr< System::Object > obj) override
Determines whether the specified object is equal in value to the current object.
void set_JpegQuality(int32_t value)
Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_JpegQuality.
void set_ColorMode(Aspose::Words::Saving::ColorMode value)
Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_ColorMode.
void set_PageCount(int32_t value)
Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_PageCount.
@ Image
Image.
void set_NumeralFormat(Aspose::Words::Saving::NumeralFormat value)
Setter for Aspose::Words::Saving::FixedPageSaveOptions::get_NumeralFormat.
int32_t get_PageIndex() const
Gets or sets the 0-based index of the first page to save. Default is 0.
Aspose::Words::Saving::NumeralFormat get_NumeralFormat() const
Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default.
int32_t get_PageCount() const
Gets or sets the number of pages to save. Default is MaxValue which means all pages of the document w...
void set_PageSavingCallback(System::SharedPtr< Aspose::Words::Saving::IPageSavingCallback > value)
Allows to control how separate pages are saved when a document is exported to fixed page format.