search/mag_sel search/close
MailMergeSettings.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 <cstdint>
13 
14 #include <Aspose.Words.Cpp/Settings/MailMergeMainDocumentType.h>
15 #include <Aspose.Words.Cpp/Settings/MailMergeDestination.h>
16 #include <Aspose.Words.Cpp/Settings/MailMergeDataType.h>
17 #include <Aspose.Words.Cpp/Settings/MailMergeCheckErrors.h>
18 #include <Aspose.Words.Cpp/aspose_words_api_defs.h>
19 
20 namespace Aspose { namespace Words { namespace Fields { class FormattableMergeFieldMerger; } } }
21 namespace Aspose { namespace Words { namespace Validation { class DocumentValidator; } } }
22 namespace Aspose { namespace Words { namespace RW { namespace Nrx { namespace Writer { class NrxMailMergePrWriter; } } } } }
23 namespace Aspose { namespace Words { namespace RW { namespace Doc { namespace Reader { class MailMergePrReader; } } } } }
24 namespace Aspose { namespace Words { namespace RW { namespace Doc { namespace Writer { class MailMergePrWriter; } } } } }
25 namespace Aspose { namespace Words { namespace Settings { class Odso; } } }
26 namespace Aspose { namespace Words { namespace Settings { enum class MailMergeLegacySeparator; } } }
27 
28 namespace Aspose {
29 
30 namespace Words {
31 
32 namespace Settings {
33 
62 class ASPOSE_WORDS_SHARED_CLASS MailMergeSettings : public System::Object
63 {
64  typedef MailMergeSettings ThisType;
65  typedef System::Object BaseType;
66 
67  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
68  ASPOSE_WORDS_SHARED_RTTI_INFO_DECL();
69 
70  friend class Aspose::Words::Fields::FormattableMergeFieldMerger;
71  friend class Aspose::Words::Validation::DocumentValidator;
72  friend class Aspose::Words::RW::Nrx::Writer::NrxMailMergePrWriter;
73  friend class Aspose::Words::RW::Doc::Reader::MailMergePrReader;
74  friend class Aspose::Words::RW::Doc::Writer::MailMergePrWriter;
75 
76 public:
77 
79  ASPOSE_WORDS_SHARED_API int32_t get_ActiveRecord() const;
80 
82  ASPOSE_WORDS_SHARED_API void set_ActiveRecord(int32_t value);
83 
85  ASPOSE_WORDS_SHARED_API System::String get_AddressFieldName() const;
86 
88  ASPOSE_WORDS_SHARED_API void set_AddressFieldName(System::String value);
89 
92  ASPOSE_WORDS_SHARED_API Aspose::Words::Settings::MailMergeCheckErrors get_CheckErrors() const;
93 
96  ASPOSE_WORDS_SHARED_API void set_CheckErrors(Aspose::Words::Settings::MailMergeCheckErrors value);
97 
99  ASPOSE_WORDS_SHARED_API System::String get_ConnectString() const;
100 
102  ASPOSE_WORDS_SHARED_API void set_ConnectString(System::String value);
103 
105  ASPOSE_WORDS_SHARED_API System::String get_DataSource() const;
106 
108  ASPOSE_WORDS_SHARED_API void set_DataSource(System::String value);
109 
112  ASPOSE_WORDS_SHARED_API Aspose::Words::Settings::MailMergeDataType get_DataType() const;
113 
116  ASPOSE_WORDS_SHARED_API void set_DataType(Aspose::Words::Settings::MailMergeDataType value);
117 
120  ASPOSE_WORDS_SHARED_API Aspose::Words::Settings::MailMergeDestination get_Destination() const;
121 
124  ASPOSE_WORDS_SHARED_API void set_Destination(Aspose::Words::Settings::MailMergeDestination value);
125 
128  ASPOSE_WORDS_SHARED_API bool get_DoNotSupressBlankLines() const;
129 
132  ASPOSE_WORDS_SHARED_API void set_DoNotSupressBlankLines(bool value);
133 
136  ASPOSE_WORDS_SHARED_API System::String get_HeaderSource() const;
137 
140  ASPOSE_WORDS_SHARED_API void set_HeaderSource(System::String value);
141 
147  ASPOSE_WORDS_SHARED_API bool get_LinkToQuery() const;
148 
150  ASPOSE_WORDS_SHARED_API void set_LinkToQuery(bool value);
151 
154  ASPOSE_WORDS_SHARED_API bool get_MailAsAttachment() const;
155 
158  ASPOSE_WORDS_SHARED_API void set_MailAsAttachment(bool value);
159 
162  ASPOSE_WORDS_SHARED_API System::String get_MailSubject() const;
163 
166  ASPOSE_WORDS_SHARED_API void set_MailSubject(System::String value);
167 
172  ASPOSE_WORDS_SHARED_API Aspose::Words::Settings::MailMergeMainDocumentType get_MainDocumentType() const;
173 
175  ASPOSE_WORDS_SHARED_API void set_MainDocumentType(Aspose::Words::Settings::MailMergeMainDocumentType value);
176 
180  ASPOSE_WORDS_SHARED_API System::SharedPtr<Aspose::Words::Settings::Odso> get_Odso() const;
181 
185  ASPOSE_WORDS_SHARED_API void set_Odso(System::SharedPtr<Aspose::Words::Settings::Odso> value);
186 
190  ASPOSE_WORDS_SHARED_API System::String get_Query() const;
191 
195  ASPOSE_WORDS_SHARED_API void set_Query(System::String value);
196 
199  ASPOSE_WORDS_SHARED_API bool get_ViewMergedData() const;
200 
203  ASPOSE_WORDS_SHARED_API void set_ViewMergedData(bool value);
204 
207  ASPOSE_WORDS_SHARED_API void Clear();
208 
210  ASPOSE_WORDS_SHARED_API System::SharedPtr<Aspose::Words::Settings::MailMergeSettings> Clone();
211 
212  ASPOSE_WORDS_SHARED_API MailMergeSettings();
213 
214 protected:
215 
216  bool get_IsEmpty();
217  Aspose::Words::Settings::MailMergeLegacySeparator get_LegacyDataFieldSeparator() const;
218  void set_LegacyDataFieldSeparator(Aspose::Words::Settings::MailMergeLegacySeparator value);
219  Aspose::Words::Settings::MailMergeLegacySeparator get_LegacyDataRowSeparator() const;
220  void set_LegacyDataRowSeparator(Aspose::Words::Settings::MailMergeLegacySeparator value);
221  Aspose::Words::Settings::MailMergeLegacySeparator get_LegacyHeaderFieldSeparator() const;
222  void set_LegacyHeaderFieldSeparator(Aspose::Words::Settings::MailMergeLegacySeparator value);
223  Aspose::Words::Settings::MailMergeLegacySeparator get_LegacyHeaderRowSeparator() const;
224  void set_LegacyHeaderRowSeparator(Aspose::Words::Settings::MailMergeLegacySeparator value);
225 
226 private:
227 
228  int32_t mActiveRecord;
229  System::String mAddressFieldName;
230  Aspose::Words::Settings::MailMergeCheckErrors mCheckErrors;
231  System::String mConnectString;
232  System::String mDataSource;
233  Aspose::Words::Settings::MailMergeDataType mDataType;
234  Aspose::Words::Settings::MailMergeDestination mDestination;
235  bool mDoNotSupressBlankLines;
236  System::String mHeaderSource;
237  bool mLinkToQuery;
238  bool mMailAsAttachment;
239  System::String mMailSubject;
240  Aspose::Words::Settings::MailMergeMainDocumentType mMainDocumentType;
241  System::SharedPtr<Aspose::Words::Settings::Odso> mOdso;
242  System::String mQuery;
243  bool mViewMergedData;
244  Aspose::Words::Settings::MailMergeLegacySeparator mLegacyDataFieldSeparator;
245  Aspose::Words::Settings::MailMergeLegacySeparator mLegacyDataRowSeparator;
246  Aspose::Words::Settings::MailMergeLegacySeparator mLegacyHeaderFieldSeparator;
247  Aspose::Words::Settings::MailMergeLegacySeparator mLegacyHeaderRowSeparator;
248 
249 };
250 
251 }
252 }
253 }