Aspose.Tasks for C++
PageSavingArgs.h
1 #pragma once
2 //-----------------------------------------------------------------------
3 // <copyright file="PageSavingArgs.cs" company="Aspose Pty Ltd">
4 // Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
5 // </copyright>
6 //-----------------------------------------------------------------------
7 
8 #include <system/object.h>
9 #include <cstdint>
10 
11 #include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
12 
13 namespace Aspose
14 {
15 namespace Tasks
16 {
17 namespace Saving
18 {
19 class HtmlWriter;
20 class ImageWriter;
21 class PdfWriter;
22 class SvgWriter;
23 } // namespace Saving
24 } // namespace Tasks
25 } // namespace Aspose
26 namespace System
27 {
28 namespace IO
29 {
30 class Stream;
31 } // namespace IO
32 } // namespace System
33 
34 namespace Aspose {
35 
36 namespace Tasks {
37 
38 namespace Saving {
39 
40 /// <summary>
41 /// This class represents set of data that related to saving of document's page to a stream.
42 /// </summary>
43 class ASPOSE_TASKS_SHARED_CLASS PageSavingArgs final : public System::Object
44 {
45  typedef PageSavingArgs ThisType;
46  typedef System::Object BaseType;
47 
48  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
49  ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
50 
51  friend class Aspose::Tasks::Saving::HtmlWriter;
52  friend class Aspose::Tasks::Saving::ImageWriter;
53  friend class Aspose::Tasks::Saving::PdfWriter;
54  friend class Aspose::Tasks::Saving::SvgWriter;
55 
56 public:
57 
58  /// <summary>
59  /// Gets a number of page to be written.
60  /// </summary>
61  ASPOSE_TASKS_SHARED_API int32_t get_PageNumber() const;
62  /// <summary>
63  /// Gets a value indicating whether rendering routine should keep <see cref="Stream"></see> opened after a page is written.
64  /// </summary>
65  ASPOSE_TASKS_SHARED_API bool get_KeepStreamOpen() const;
66  /// <summary>
67  /// Sets a value indicating whether rendering routine should keep <see cref="Stream"></see> opened after a page is written.
68  /// </summary>
69  ASPOSE_TASKS_SHARED_API void set_KeepStreamOpen(bool value);
70  /// <summary>
71  /// Gets a stream for writing a page.
72  /// </summary>
73  ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::IO::Stream>& get_Stream() const;
74  /// <summary>
75  /// Sets a stream for writing a page.
76  /// </summary>
77  ASPOSE_TASKS_SHARED_API void set_Stream(const System::SharedPtr<System::IO::Stream>& value);
78 
79 protected:
80 
81  ASPOSE_TASKS_SHARED_API PageSavingArgs(int32_t pageNumber);
82 
83  ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(PageSavingArgs, CODEPORTING_ARGS(int32_t pageNumber));
84  #ifdef ASPOSE_GET_SHARED_MEMBERS
85  ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
86  #endif
87 
88 
89 private:
90 
91  int32_t pr_PageNumber;
92 
93  /// <summary>
94  /// Gets a number of page to be written.
95  /// </summary>
96  ASPOSE_TASKS_SHARED_API void set_PageNumber(int32_t value);
97 
98  bool pr_KeepStreamOpen;
99  System::SharedPtr<System::IO::Stream> pr_Stream;
100 
101 };
102 
103 } // namespace Saving
104 } // namespace Tasks
105 } // namespace Aspose
106 
107 
This class represents set of data that related to saving of document's page to a stream.
Definition: PageSavingArgs.h:44
const System::SharedPtr< System::IO::Stream > & get_Stream() const
Gets a stream for writing a page.
void set_Stream(const System::SharedPtr< System::IO::Stream > &value)
Sets a stream for writing a page.
int32_t get_PageNumber() const
Gets a number of page to be written.
void set_KeepStreamOpen(bool value)
Sets a value indicating whether rendering routine should keep Stream opened after a page is written.
bool get_KeepStreamOpen() const
Gets a value indicating whether rendering routine should keep Stream opened after a page is written.
Definition: Asn.h:13