aspose_words_cloud 20.10.0 → 20.11.0

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_footnotes operation.
   #
   class GetFootnotesRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # 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.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param node_path Path to the node, which contains collection of footnotes.
+    # @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_form_field_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_form_field operation.
   #
   class GetFormFieldRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # 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.
@@ -52,9 +52,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 that contains collection of formfields.
+    # @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_form_fields_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_form_fields operation.
   #
   class GetFormFieldsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node containing collection of form fields.
+    # 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 containing collection of form fields.
+    # @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_header_footer_of_section_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_header_footer_of_section operation.
   #
   class GetHeaderFooterOfSectionRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Header/footer index.
+    # The index of the HeaderFooter object.
     attr_accessor :header_footer_index
 
-    # Section index.
+    # The index of the section.
     attr_accessor :section_index
 
     # Original document folder.
@@ -50,19 +50,19 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # List of types of headers and footers.
+    # The list of HeaderFooter types.
     attr_accessor :filter_by_type
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param header_footer_index Header/footer index.
-    # @param section_index Section index.
+    # @param name The filename of the input document.
+    # @param header_footer_index The index of the HeaderFooter object.
+    # @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.
     # @param password Password for opening an encrypted document.
-    # @param filter_by_type List of types of headers and footers.
+    # @param filter_by_type The list of HeaderFooter types.
 
     def initialize(name, header_footer_index, section_index, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil)
       self.name = name

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_header_footer operation.
   #
   class GetHeaderFooterRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Header/footer index.
+    # The index of the HeaderFooter object.
     attr_accessor :header_footer_index
 
     # Original document folder.
@@ -47,18 +47,18 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # List of types of headers and footers.
+    # The list of HeaderFooter types.
     attr_accessor :filter_by_type
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param header_footer_index Header/footer index.
+    # @param name The filename of the input document.
+    # @param header_footer_index The index of the HeaderFooter 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.
     # @param password Password for opening an encrypted document.
-    # @param filter_by_type List of types of headers and footers.
+    # @param filter_by_type The list of HeaderFooter types.
 
     def initialize(name, header_footer_index, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil)
       self.name = name

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_header_footers operation.
   #
   class GetHeaderFootersRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to parent section.
+    # The path to the section in the document tree.
     attr_accessor :section_path
 
     # Original document folder.
@@ -47,18 +47,18 @@ module AsposeWordsCloud
     # Password for opening an encrypted document.
     attr_accessor :password
 
-    # List of types of headers and footers.
+    # The list of HeaderFooter types.
     attr_accessor :filter_by_type
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param section_path Path to parent section.
+    # @param name The filename of the input document.
+    # @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.
     # @param password Password for opening an encrypted document.
-    # @param filter_by_type List of types of headers and footers.
+    # @param filter_by_type The list of HeaderFooter types.
 
     def initialize(name, section_path, folder = nil, storage = nil, load_encoding = nil, password = nil, filter_by_type = nil)
       self.name = name

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

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_list operation.
   #
   class GetListRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # List unique identifier.
+    # The list Id.
     attr_accessor :list_id
 
     # Original document folder.
@@ -49,8 +49,8 @@ module AsposeWordsCloud
 
     #
     # Initializes a new instance.
-    # @param name The document name.
-    # @param list_id List unique identifier.
+    # @param name The filename of the input document.
+    # @param list_id The list Id.
     # @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_lists_request.rb

@@ -29,7 +29,7 @@ module AsposeWordsCloud
   # Request model for get_lists operation.
   #
   class GetListsRequest
-    # 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_office_math_object_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_office_math_object operation.
   #
   class GetOfficeMathObjectRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # Object index.
     attr_accessor :index
 
-    # Path to the node, which contains collection of OfficeMath objects.
+    # 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 index Object index.
-    # @param node_path Path to the node, which contains collection of OfficeMath 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/get_office_math_objects_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_office_math_objects operation.
   #
   class GetOfficeMathObjectsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node, which contains collection of OfficeMath objects.
+    # 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, which contains collection of OfficeMath objects.
+    # @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_paragraph_format_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_paragraph_format operation.
   #
   class GetParagraphFormatRequest
-    # 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.
@@ -52,9 +52,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/get_paragraph_list_format_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_paragraph_list_format operation.
   #
   class GetParagraphListFormatRequest
-    # 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.
@@ -52,9 +52,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/get_paragraph_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_paragraph operation.
   #
   class GetParagraphRequest
-    # 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.
@@ -52,9 +52,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/get_paragraph_tab_stops_request.rb

@@ -29,13 +29,13 @@ module AsposeWordsCloud
   # Request model for get_paragraph_tab_stops operation.
   #
   class GetParagraphTabStopsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
     # 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.
@@ -52,9 +52,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 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/get_paragraphs_request.rb

@@ -29,10 +29,10 @@ module AsposeWordsCloud
   # Request model for get_paragraphs operation.
   #
   class GetParagraphsRequest
-    # The document name.
+    # The filename of the input document.
     attr_accessor :name
 
-    # Path to the node which contains paragraphs.
+    # 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 which contains paragraphs.
+    # @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_range_text_request.rb

@@ -29,12 +29,10 @@ module AsposeWordsCloud
   # Request model for get_range_text operation.
   #
   class GetRangeTextRequest
-    # 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.
@@ -54,8 +52,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.