aspose_words_cloud 20.10.0 → 20.11.0

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

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for insert_footnote operation.
   #
   class InsertFootnoteRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Footnote data.
+    # The properties of the footnote.
     attr_accessor :footnote_dto
 
-    # Path to the node, which contains collection of footnotes.
+    # 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 footnote_dto Footnote data.
-    # @param node_path Path to the node, which contains collection of footnotes.
+    # @param name The filename of the input document.
+    # @param footnote_dto The properties of the footnote.
+    # @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/insert_form_field_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for insert_form_field operation.
   #
   class InsertFormFieldRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # From field data.
+    # The properties of the form field.
     attr_accessor :form_field
 
-    # Path to the node that contains collection of formfields.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -59,14 +59,14 @@ module AsposeWordsCloud
     # The date and time to use for revisions.
     attr_accessor :revision_date_time
 
-    # Form field will be inserted before node with index.
+    # The index of the node. A new form field will be inserted before the node with the specified node Id.
     attr_accessor :insert_before_node
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param form_field From field data.
-    # @param node_path Path to the node that contains collection of formfields.
+    # @param name The filename of the input document.
+    # @param form_field The properties of the form field.
+    # @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.
@@ -74,7 +74,7 @@ module AsposeWordsCloud
     # @param dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
     # @param revision_author Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
     # @param revision_date_time The date and time to use for revisions.
-    # @param insert_before_node Form field will be inserted before node with index.
+    # @param insert_before_node The index of the node. A new form field will be inserted before the node with the specified node Id.
 
     def initialize(name, form_field, node_path = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, insert_before_node = nil)
       self.name = name

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

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for insert_header_footer operation.
   #
   class InsertHeaderFooterRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Type of header/footer.
+    # The type of a HeaderFooter object.
     attr_accessor :header_footer_type
 
-    # Path to parent section.
+    # The path to the section in the document tree.
     attr_accessor :section_path
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param header_footer_type Type of header/footer.
-    # @param section_path Path to parent section.
+    # @param name The filename of the input document.
+    # @param header_footer_type The type of a HeaderFooter object.
+    # @param section_path The path to the section 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/insert_list_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for insert_list operation.
   #
   class InsertListRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # List to insert.
+    # The properties of the list.
     attr_accessor :list_insert
 
     # Original document folder.
@@ -58,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param list_insert List to insert.
+    # @param name The filename of the input document.
+    # @param list_insert The properties of the list.
     # @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/insert_or_update_paragraph_tab_stop_request.rb

@@ -29,16 +29,16 @@ module AsposeWordsCloud
   # Request model for insert_or_update_paragraph_tab_stop operation.
   #
   class InsertOrUpdateParagraphTabStopRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Paragraph tab stop.
+    # The properties of the paragraph tab stop.
     attr_accessor :dto
 
     # 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 dto Paragraph tab stop.
+    # @param name The filename of the input document.
+    # @param dto The properties of the paragraph tab stop.
     # @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/insert_page_numbers_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for insert_page_numbers operation.
   #
   class InsertPageNumbersRequest
-    # A document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # PageNumber with the page numbers settings.
+    # The page numbers settings.
     attr_accessor :page_number
 
     # Original document folder.
@@ -58,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name A document name.
-    # @param page_number PageNumber with the page numbers settings.
+    # @param name The filename of the input document.
+    # @param page_number The page numbers settings.
     # @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/insert_paragraph_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for insert_paragraph operation.
   #
   class InsertParagraphRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Paragraph data.
+    # The properties of the paragraph.
     attr_accessor :paragraph
 
-    # Path to the node which contains paragraphs.
+    # The path to the node in the document tree.
     attr_accessor :node_path
 
     # Original document folder.
@@ -59,14 +59,14 @@ module AsposeWordsCloud
     # The date and time to use for revisions.
     attr_accessor :revision_date_time
 
-    # Paragraph will be inserted before node with index.
+    # The index of the node. A new paragraph will be inserted before the node with the specified index.
     attr_accessor :insert_before_node
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param paragraph Paragraph data.
-    # @param node_path Path to the node which contains paragraphs.
+    # @param name The filename of the input document.
+    # @param paragraph The properties of the 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.
@@ -74,7 +74,7 @@ module AsposeWordsCloud
     # @param dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
     # @param revision_author Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
     # @param revision_date_time The date and time to use for revisions.
-    # @param insert_before_node Paragraph will be inserted before node with index.
+    # @param insert_before_node The index of the node. A new paragraph will be inserted before the node with the specified index.
 
     def initialize(name, paragraph, node_path = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, insert_before_node = nil)
       self.name = name

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

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for insert_run operation.
   #
   class InsertRunRequest
-    # 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
 
-    # Run data.
+    # The properties of the Run object.
     attr_accessor :run
 
     # Original document folder.
@@ -59,14 +59,14 @@ module AsposeWordsCloud
     # The date and time to use for revisions.
     attr_accessor :revision_date_time
 
-    # Paragraph will be inserted before node with index.
+    # The index of the node. A new Run object will be inserted before the node with the specified node Id.
     attr_accessor :insert_before_node
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param paragraph_path Path to parent paragraph.
-    # @param run Run data.
+    # @param name The filename of the input document.
+    # @param paragraph_path The path to the paragraph in the document tree.
+    # @param run The properties of the Run object.
     # @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.
@@ -74,7 +74,7 @@ module AsposeWordsCloud
     # @param dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
     # @param revision_author Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
     # @param revision_date_time The date and time to use for revisions.
-    # @param insert_before_node Paragraph will be inserted before node with index.
+    # @param insert_before_node The index of the node. A new Run object will be inserted before the node with the specified node Id.
 
     def initialize(name, paragraph_path, run, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, insert_before_node = nil)
       self.name = name

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for insert_style operation.
   #
   class InsertStyleRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Style to insert.
+    # The properties of the style.
     attr_accessor :style_insert
 
     # Original document folder.
@@ -58,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param style_insert Style to insert.
+    # @param name The filename of the input document.
+    # @param style_insert The properties of the style.
     # @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/insert_table_cell_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for insert_table_cell operation.
   #
   class InsertTableCellRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Table cell parameters/.
+    # The properties of the cell.
     attr_accessor :cell
 
-    # Path to table row.
+    # The path to the table row in the document tree.
     attr_accessor :table_row_path
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param cell Table cell parameters/.
-    # @param table_row_path Path to table row.
+    # @param name The filename of the input document.
+    # @param cell The properties of the cell.
+    # @param table_row_path The path to the table row 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/insert_table_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for insert_table operation.
   #
   class InsertTableRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Table parameters/.
+    # The properties of the table.
     attr_accessor :table
 
-    # 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 table Table parameters/.
-    # @param node_path Path to the node, which contains tables.
+    # @param name The filename of the input document.
+    # @param table The properties of the table.
+    # @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/insert_table_row_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for insert_table_row operation.
   #
   class InsertTableRowRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Table row parameters/.
+    # The properties of the row.
     attr_accessor :row
 
-    # Path to table.
+    # The path to the table in the document tree.
     attr_accessor :table_path
 
     # Original document folder.
@@ -61,9 +61,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param row Table row parameters/.
-    # @param table_path Path to table.
+    # @param name The filename of the input document.
+    # @param row The properties of the row.
+    # @param table_path The path to the table 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/insert_watermark_image_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for insert_watermark_image operation.
   #
   class InsertWatermarkImageRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # File with image.
@@ -56,15 +56,15 @@ module AsposeWordsCloud
     # The date and time to use for revisions.
     attr_accessor :revision_date_time
 
-    # The watermark rotation angle.
+    # The rotation angle of the watermark.
     attr_accessor :rotation_angle
 
-    # The image file server full name. If the name is empty the image is expected in request content.
+    # The filename of the image. If the parameter value is missing — the image data is expected in the request content.
     attr_accessor :image
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param image_file File with image.
     # @param folder Original document folder.
     # @param storage Original document storage.
@@ -73,8 +73,8 @@ module AsposeWordsCloud
     # @param dest_file_name Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
     # @param revision_author Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.
     # @param revision_date_time The date and time to use for revisions.
-    # @param rotation_angle The watermark rotation angle.
-    # @param image The image file server full name. If the name is empty the image is expected in request content.
+    # @param rotation_angle The rotation angle of the watermark.
+    # @param image The filename of the image. If the parameter value is missing — the image data is expected in the request content.
 
     def initialize(name, image_file = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, rotation_angle = nil, image = nil)
       self.name = name

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for insert_watermark_text operation.
   #
   class InsertWatermarkTextRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # WatermarkText with the watermark data.
+    # The watermark text to insert.
     attr_accessor :watermark_text
 
     # Original document folder.
@@ -58,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param watermark_text WatermarkText with the watermark data.
+    # @param name The filename of the input document.
+    # @param watermark_text The watermark text to insert.
     # @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.