Class: AsposeWordsCloud::ExecuteMailMergeRequest
- Inherits:
-
Object
- Object
- AsposeWordsCloud::ExecuteMailMergeRequest
- Defined in:
- lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb
Overview
Request model for execute_mail_merge operation.
Instance Attribute Summary collapse
-
#cleanup ⇒ Object
The cleanup options.
-
#data ⇒ Object
Mail merge data.
-
#dest_file_name ⇒ Object
The filename of the output document.
-
#folder ⇒ Object
Original document folder.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#mail_merge_data_file ⇒ Object
The data file.
-
#name ⇒ Object
The filename of the input document.
-
#password ⇒ Object
Password for opening an encrypted document.
-
#storage ⇒ Object
Original document storage.
-
#use_whole_paragraph_as_region ⇒ Object
The flag indicating whether paragraph with TableStart or TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields.
-
#with_regions ⇒ Object
The flag indicating whether to execute Mail Merge operation with regions.
Instance Method Summary collapse
-
#initialize(name, data = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, with_regions = nil, mail_merge_data_file = nil, cleanup = nil, use_whole_paragraph_as_region = nil, dest_file_name = nil) ⇒ ExecuteMailMergeRequest
constructor
Initializes a new instance.
Constructor Details
#initialize(name, data = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, with_regions = nil, mail_merge_data_file = nil, cleanup = nil, use_whole_paragraph_as_region = nil, dest_file_name = nil) ⇒ ExecuteMailMergeRequest
Initializes a new instance.
79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 79 def initialize(name, data = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, with_regions = nil, mail_merge_data_file = nil, cleanup = nil, use_whole_paragraph_as_region = nil, dest_file_name = nil) self.name = name self.data = data self.folder = folder self.storage = storage self.load_encoding = load_encoding self.password = password self.with_regions = with_regions self.mail_merge_data_file = mail_merge_data_file self.cleanup = cleanup self.use_whole_paragraph_as_region = use_whole_paragraph_as_region self.dest_file_name = dest_file_name end |
Instance Attribute Details
#cleanup ⇒ Object
The cleanup options.
57 58 59 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 57 def cleanup @cleanup end |
#data ⇒ Object
Mail merge data.
36 37 38 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 36 def data @data end |
#dest_file_name ⇒ Object
The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
63 64 65 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 63 def dest_file_name @dest_file_name end |
#folder ⇒ Object
Original document folder.
39 40 41 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 39 def folder @folder end |
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
45 46 47 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 45 def load_encoding @load_encoding end |
#mail_merge_data_file ⇒ Object
The data file.
54 55 56 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 54 def mail_merge_data_file @mail_merge_data_file end |
#name ⇒ Object
The filename of the input document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 33 def name @name end |
#password ⇒ Object
Password for opening an encrypted document.
48 49 50 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 48 def password @password end |
#storage ⇒ Object
Original document storage.
42 43 44 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 42 def storage @storage end |
#use_whole_paragraph_as_region ⇒ Object
The flag indicating whether paragraph with TableStart or TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.
60 61 62 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 60 def use_whole_paragraph_as_region @use_whole_paragraph_as_region end |
#with_regions ⇒ Object
The flag indicating whether to execute Mail Merge operation with regions.
51 52 53 |
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 51 def with_regions @with_regions end |