aspose_words_cloud 20.10.0 → 20.11.0

data/lib/aspose_words_cloud/models/requests/delete_paragraph_list_format_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for delete_paragraph_list_format operation.
   #
   class DeleteParagraphListFormatRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node which contains paragraphs.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node which contains paragraphs.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/delete_paragraph_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for delete_paragraph operation.
   #
   class DeleteParagraphRequest
-    # The file name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node which contains paragraphs.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The file name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node which contains paragraphs.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/delete_paragraph_tab_stop_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for delete_paragraph_tab_stop operation.
   #
   class DeleteParagraphTabStopRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # a tab stop position to remove.
+    # The position of a tab stop to remove.
     attr_accessor :position
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node which contains paragraph.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -58,10 +58,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param position a tab stop position to remove.
+    # @param name The filename of the input document.
+    # @param position The position of a tab stop to remove.
     # @param index Object index.
-    # @param node_path Path to the node which contains paragraph.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/delete_run_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for delete_run operation.
   #
   class DeleteRunRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to parent paragraph.
+    # The path to the paragraph in the document tree.
     attr_accessor :paragraph_path
 
     # Object index.
@@ -61,8 +61,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param paragraph_path Path to parent paragraph.
+    # @param name The filename of the input document.
+    # @param paragraph_path The path to the paragraph in the document tree.
     # @param index Object index.
     # @param folder Original document folder.
     # @param storage Original document storage.

data/lib/aspose_words_cloud/models/requests/delete_section_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for delete_section operation.
   #
   class DeleteSectionRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Section index.
+    # The index of the section.
     attr_accessor :section_index
 
     # Original document folder.
@@ -58,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param section_index Section index.
+    # @param name The filename of the input document.
+    # @param section_index The index of the section.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/delete_table_cell_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for delete_table_cell operation.
   #
   class DeleteTableCellRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to table row.
+    # The path to the table row in the document tree.
     attr_accessor :table_row_path
 
     # Object index.
@@ -61,8 +61,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param table_row_path Path to table row.
+    # @param name The filename of the input document.
+    # @param table_row_path The path to the table row in the document tree.
     # @param index Object index.
     # @param folder Original document folder.
     # @param storage Original document storage.

data/lib/aspose_words_cloud/models/requests/delete_table_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for delete_table operation.
   #
   class DeleteTableRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains tables.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param index Object index.
-    # @param node_path Path to the node, which contains tables.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/delete_table_row_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for delete_table_row operation.
   #
   class DeleteTableRowRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to table.
+    # The path to the table in the document tree.
     attr_accessor :table_path
 
     # Object index.
@@ -61,8 +61,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param table_path Path to table.
+    # @param name The filename of the input document.
+    # @param table_path The path to the table in the document tree.
     # @param index Object index.
     # @param folder Original document folder.
     # @param storage Original document storage.

data/lib/aspose_words_cloud/models/requests/delete_watermark_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for delete_watermark operation.
   #
   class DeleteWatermarkRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -55,7 +55,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/execute_mail_merge_online_request.rb

@@ -35,22 +35,22 @@ module AsposeWordsCloud
     # File with mailmerge data.
     attr_accessor :data
 
-    # With regions flag.
+    # The flag indicating whether to execute Mail Merge operation with regions.
     attr_accessor :with_regions
 
-    # Clean up options.
+    # The cleanup options.
     attr_accessor :cleanup
 
-    # This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "template" will be used instead.
+    # The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "template" will be used instead.
     attr_accessor :document_file_name
 
     #
     # Initializes a new instance.
     # @param template File with template.
     # @param data File with mailmerge data.
-    # @param with_regions With regions flag.
-    # @param cleanup Clean up options.
-    # @param document_file_name This file name will be used when resulting document has dynamic field for document file name {filename}. If it is not set, "template" will be used instead.
+    # @param with_regions The flag indicating whether to execute Mail Merge operation with regions.
+    # @param cleanup The cleanup options.
+    # @param document_file_name The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the "template" will be used instead.
 
     def initialize(template, data, with_regions = nil, cleanup = nil, document_file_name = nil)
       self.template = template

data/lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for execute_mail_merge operation.
   #
   class ExecuteMailMergeRequest
-    # The template name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Mail merge data.
@@ -47,36 +47,34 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # With regions flag.
+    # The flag indicating whether to execute Mail Merge operation with regions.
     attr_accessor :with_regions
 
-    # Mail merge data file.
+    # The data file.
     attr_accessor :mail_merge_data_file
 
-    # Clean up options.
+    # The cleanup options.
     attr_accessor :cleanup
 
-    # Gets or sets a value 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.
+    # 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.
     attr_accessor :use_whole_paragraph_as_region
 
-    # Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.
+    # The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
     attr_accessor :dest_file_name
 
     #
     # Initializes a new instance.
-    # @param name The template name.
+    # @param name The filename of the input document.
     # @param data Mail merge data.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
     # @param password Password for opening an encrypted document.
-    # @param with_regions With regions flag.
-    # @param mail_merge_data_file Mail merge data file.
-    # @param cleanup Clean up options.
-    # @param use_whole_paragraph_as_region Gets or sets a value 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.
-    # @param dest_file_name Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.
+    # @param with_regions The flag indicating whether to execute Mail Merge operation with regions.
+    # @param mail_merge_data_file The data file.
+    # @param cleanup The cleanup options.
+    # @param use_whole_paragraph_as_region 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.
+    # @param dest_file_name The filename of the output document. If this parameter is omitted, the result will be saved with autogenerated name.
 
     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

data/lib/aspose_words_cloud/models/requests/get_available_fonts_request.rb

@@ -29,12 +29,12 @@ module AsposeWordsCloud
   # Request model for get_available_fonts operation.
   #
   class GetAvailableFontsRequest
-    # Folder in filestorage with custom fonts.
+    # The folder in cloud storage with custom fonts.
     attr_accessor :fonts_location
 
     #
     # Initializes a new instance.
-    # @param fonts_location Folder in filestorage with custom fonts.
+    # @param fonts_location The folder in cloud storage with custom fonts.
 
     def initialize(fonts_location = nil)
       self.fonts_location = fonts_location

data/lib/aspose_words_cloud/models/requests/get_bookmark_by_name_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_bookmark_by_name operation.
   #
   class GetBookmarkByNameRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The bookmark name.
+    # The name of the bookmark.
     attr_accessor :bookmark_name
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param bookmark_name The bookmark name.
+    # @param name The filename of the input document.
+    # @param bookmark_name The name of the bookmark.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_bookmarks_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_bookmarks operation.
   #
   class GetBookmarksRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -46,7 +46,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_border_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_border operation.
   #
   class GetBorderRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Border type.
     attr_accessor :border_type
 
-    # Path to the node with border(node should be paragraph, cell or row).
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -52,9 +52,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param border_type Border type.
-    # @param node_path Path to the node with border(node should be paragraph, cell or row).
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_borders_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_borders operation.
   #
   class GetBordersRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node with borders (node should be paragraph, cell or row).
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param node_path Path to the node with borders (node should be paragraph, cell or row).
+    # @param name The filename of the input document.
+    # @param node_path The path to the node in the document tree.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

data/lib/aspose_words_cloud/models/requests/get_comment_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_comment operation.
   #
   class GetCommentRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # The comment index.
+    # The index of the comment.
     attr_accessor :comment_index
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param comment_index The comment index.
+    # @param name The filename of the input document.
+    # @param comment_index The index of the comment.
     # @param folder Original document folder.
     # @param storage Original document storage.
     # @param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.