aspose_words_cloud 20.10.0 → 20.11.0

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

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for load_web_document operation.
   #
   class LoadWebDocumentRequest
-    # Parameters of loading.
+    # The properties of data downloading.
     attr_accessor :data
 
     # Original document storage.
@@ -37,7 +37,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param data Parameters of loading.
+    # @param data The properties of data downloading.
     # @param storage Original document storage.
 
     def initialize(data, storage = nil)

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

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for optimize_document operation.
   #
   class OptimizeDocumentRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # The document optimization options.
@@ -58,7 +58,7 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param options The document optimization options.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for protect_document operation.
   #
   class ProtectDocumentRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # ProtectionRequest with protection settings.
+    # The protection settings.
     attr_accessor :protection_request
 
     # Original document folder.
@@ -52,8 +52,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param protection_request ProtectionRequest with protection settings.
+    # @param name The filename of the input document.
+    # @param protection_request The protection 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/reject_all_revisions_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for reject_all_revisions operation.
   #
   class RejectAllRevisionsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Original document folder.
@@ -49,7 +49,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/remove_range_request.rb

@@ -29,12 +29,10 @@ module AsposeWordsCloud
   # Request model for remove_range operation.
   #
   class RemoveRangeRequest
-    # The document.
+    # The filename of the input document.
     attr_accessor :name
 
     # The range start identifier.
-    # Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id".
-    # It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
     attr_accessor :range_start_identifier
 
     # The range end identifier.
@@ -57,8 +55,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document.
-    # @param range_start_identifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
+    # @param name The filename of the input document.
+    # @param range_start_identifier The range start identifier.
     # @param range_end_identifier The range end identifier.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for render_drawing_object operation.
   #
   class RenderDrawingObjectRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # The destination format.
@@ -38,7 +38,7 @@ module AsposeWordsCloud
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains drawing objects.
+    # 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 name The filename of the input document.
     # @param format The destination format.
     # @param index Object index.
-    # @param node_path Path to the node, which contains drawing objects.
+    # @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/render_math_object_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for render_math_object operation.
   #
   class RenderMathObjectRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # The destination format.
@@ -38,7 +38,7 @@ module AsposeWordsCloud
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains office math objects.
+    # 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 name The filename of the input document.
     # @param format The destination format.
     # @param index Object index.
-    # @param node_path Path to the node, which contains office math objects.
+    # @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/render_page_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for render_page operation.
   #
   class RenderPageRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Comment index.
+    # The index of the page.
     attr_accessor :page_index
 
     # The destination format.
@@ -55,8 +55,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param page_index Comment index.
+    # @param name The filename of the input document.
+    # @param page_index The index of the page.
     # @param format The destination format.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for render_paragraph operation.
   #
   class RenderParagraphRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # The destination format.
@@ -38,7 +38,7 @@ module AsposeWordsCloud
     # 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.
@@ -58,10 +58,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param format The destination format.
     # @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/render_table_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for render_table operation.
   #
   class RenderTableRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # The destination format.
@@ -38,7 +38,7 @@ module AsposeWordsCloud
     # 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.
@@ -58,10 +58,10 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
+    # @param name The filename of the input document.
     # @param format The destination format.
     # @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/replace_text_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for replace_text operation.
   #
   class ReplaceTextRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # ReplaceTextResponse with the replace operation settings.
+    # The text replacement parameters.
     attr_accessor :replace_text
 
     # Original document folder.
@@ -58,8 +58,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param replace_text ReplaceTextResponse with the replace operation settings.
+    # @param name The filename of the input document.
+    # @param replace_text The text replacement parameters.
     # @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/replace_with_text_request.rb

@@ -29,15 +29,13 @@ module AsposeWordsCloud
   # Request model for replace_with_text operation.
   #
   class ReplaceWithTextRequest
-    # The document.
+    # The filename of the input document.
     attr_accessor :name
 
     # The range start identifier.
-    # Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id".
-    # It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
     attr_accessor :range_start_identifier
 
-    # Model with text for replacement.
+    # The text replacement properties.
     attr_accessor :range_text
 
     # The range end identifier.
@@ -60,9 +58,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document.
-    # @param range_start_identifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
-    # @param range_text Model with text for replacement.
+    # @param name The filename of the input document.
+    # @param range_start_identifier The range start identifier.
+    # @param range_text The text replacement properties.
     # @param range_end_identifier The range end identifier.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,15 +29,13 @@ module AsposeWordsCloud
   # Request model for save_as_range operation.
   #
   class SaveAsRangeRequest
-    # The document.
+    # The filename of the input document.
     attr_accessor :name
 
     # The range start identifier.
-    # Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id".
-    # It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
     attr_accessor :range_start_identifier
 
-    # Parameters of a new document.
+    # The parameters of a new document.
     attr_accessor :document_parameters
 
     # The range end identifier.
@@ -57,9 +55,9 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document.
-    # @param range_start_identifier The range start identifier. Identifier is the value of the "nodeId" field, which every document node has, extended with the prefix "id". It looks like "id0.0.7". Also values like "image5" and "table3" can be used as an identifier for images and tables, where the number is an index of the image/table.
-    # @param document_parameters Parameters of a new document.
+    # @param name The filename of the input document.
+    # @param range_start_identifier The range start identifier.
+    # @param document_parameters The parameters of a new document.
     # @param range_end_identifier The range end identifier.
     # @param folder Original document folder.
     # @param storage Original document storage.

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for save_as operation.
   #
   class SaveAsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Save options.
+    # The save options.
     attr_accessor :save_options_data
 
     # Original document folder.
@@ -52,8 +52,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param save_options_data Save options.
+    # @param name The filename of the input document.
+    # @param save_options_data The save options.
     # @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/save_as_tiff_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for save_as_tiff operation.
   #
   class SaveAsTiffRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Tiff save options.
+    # The save options to TIFF format.
     attr_accessor :save_options
 
     # Original document folder.
@@ -47,16 +47,16 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # Use antialiasing flag.
+    # The flag indicating whether to use antialiasing.
     attr_accessor :use_anti_aliasing
 
-    # Use high quality flag.
+    # The flag indicating whether to use high quality.
     attr_accessor :use_high_quality_rendering
 
-    # Brightness for the generated images.
+    # The level of brightness for the generated images.
     attr_accessor :image_brightness
 
-    # Color mode for the generated images.
+    # The color mode for the generated images.
     attr_accessor :image_color_mode
 
     # The contrast for the generated images.
@@ -65,37 +65,37 @@ module AsposeWordsCloud
     # The images numeral format.
     attr_accessor :numeral_format
 
-    # Number of pages to render.
+    # The number of pages to render.
     attr_accessor :page_count
 
-    # Page index to start rendering.
+    # The index of the page to start rendering.
     attr_accessor :page_index
 
-    # Background image color.
+    # The background image color.
     attr_accessor :paper_color
 
-    # The pixel format of generated images.
+    # The pixel format of the generated images.
     attr_accessor :pixel_format
 
-    # The resolution of generated images.
+    # The resolution of the generated images.
     attr_accessor :resolution
 
-    # Zoom factor for generated images.
+    # The zoom factor for the generated images.
     attr_accessor :scale
 
     # The compression tipe.
     attr_accessor :tiff_compression
 
-    # Optional, default is Fallback.
+    # The optional dml rendering mode. The default value is Fallback.
     attr_accessor :dml_rendering_mode
 
-    # Optional, default is Simplified.
+    # The optional dml effects rendering mode. The default value is Simplified.
     attr_accessor :dml_effects_rendering_mode
 
-    # Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold.
+    # The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.
     attr_accessor :tiff_binarization_method
 
-    # Optional. A value determining zip output or not.
+    # The flag indicating whether to ZIP the output.
     attr_accessor :zip_output
 
     # Folder in filestorage with custom fonts.
@@ -103,29 +103,29 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param save_options Tiff save options.
+    # @param name The filename of the input document.
+    # @param save_options The save options to TIFF format.
     # @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 use_anti_aliasing Use antialiasing flag.
-    # @param use_high_quality_rendering Use high quality flag.
-    # @param image_brightness Brightness for the generated images.
-    # @param image_color_mode Color mode for the generated images.
+    # @param use_anti_aliasing The flag indicating whether to use antialiasing.
+    # @param use_high_quality_rendering The flag indicating whether to use high quality.
+    # @param image_brightness The level of brightness for the generated images.
+    # @param image_color_mode The color mode for the generated images.
     # @param image_contrast The contrast for the generated images.
     # @param numeral_format The images numeral format.
-    # @param page_count Number of pages to render.
-    # @param page_index Page index to start rendering.
-    # @param paper_color Background image color.
-    # @param pixel_format The pixel format of generated images.
-    # @param resolution The resolution of generated images.
-    # @param scale Zoom factor for generated images.
+    # @param page_count The number of pages to render.
+    # @param page_index The index of the page to start rendering.
+    # @param paper_color The background image color.
+    # @param pixel_format The pixel format of the generated images.
+    # @param resolution The resolution of the generated images.
+    # @param scale The zoom factor for the generated images.
     # @param tiff_compression The compression tipe.
-    # @param dml_rendering_mode Optional, default is Fallback.
-    # @param dml_effects_rendering_mode Optional, default is Simplified.
-    # @param tiff_binarization_method Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold.
-    # @param zip_output Optional. A value determining zip output or not.
+    # @param dml_rendering_mode The optional dml rendering mode. The default value is Fallback.
+    # @param dml_effects_rendering_mode The optional dml effects rendering mode. The default value is Simplified.
+    # @param tiff_binarization_method The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold.
+    # @param zip_output The flag indicating whether to ZIP the output.
     # @param fonts_location Folder in filestorage with custom fonts.
 
     def initialize(name, save_options, folder = nil, storage = nil, load_encoding = nil, password = nil, use_anti_aliasing = nil, use_high_quality_rendering = nil, image_brightness = nil, image_color_mode = nil, image_contrast = nil, numeral_format = nil, page_count = nil, page_index = nil, paper_color = nil, pixel_format = nil, resolution = nil, scale = nil, tiff_compression = nil, dml_rendering_mode = nil, dml_effects_rendering_mode = nil, tiff_binarization_method = nil, zip_output = nil, fonts_location = nil)