aspose_words_cloud 23.9.0 → 23.11.0

data/lib/aspose_words_cloud/models/style_insert.rb

@@ -90,13 +90,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -255,5 +248,10 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property style_name in StyleInsert is required.' if self.style_name.nil?
+      raise ArgumentError, 'Property style_type in StyleInsert is required.' if self.style_type.nil?
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/style_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a style.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/styles/{0}" REST API requests.
   class StyleResponse
     # Gets or sets the request Id.
     attr_accessor :request_id
@@ -67,13 +68,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -214,5 +208,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.style.nil?
+          self.style.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/style_update.rb

@@ -29,34 +29,37 @@ module AsposeWordsCloud
 
   # Represents a single document style properties to update.
   class StyleUpdate
+    # Gets or sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style.
+    # This property is not used by Aspose.Words. The next paragraph style will only be applied automatically when you edit the document in MS Word.
+    attr_accessor :next_paragraph_style_name
+
     # Gets or sets the name of the style this style is based on.
+    # This will be an empty string if the style is not based on any other style and it can be set to an empty string.
     attr_accessor :base_style_name
 
     # Gets or sets a value indicating whether this style is shown in the Quick Style gallery inside MS Word UI.
     attr_accessor :is_quick_style
 
     # Gets or sets the name of the style.
+    # Can not be empty string. If there already is a style with such name in the collection, than this style will override it. All affected nodes will reference new style.
     attr_accessor :name
-
-    # Gets or sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style.
-    attr_accessor :next_paragraph_style_name
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'next_paragraph_style_name' => :'NextParagraphStyleName',
         :'base_style_name' => :'BaseStyleName',
         :'is_quick_style' => :'IsQuickStyle',
-        :'name' => :'Name',
-        :'next_paragraph_style_name' => :'NextParagraphStyleName'
+        :'name' => :'Name'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'next_paragraph_style_name' => :'String',
         :'base_style_name' => :'String',
         :'is_quick_style' => :'BOOLEAN',
-        :'name' => :'String',
-        :'next_paragraph_style_name' => :'String'
+        :'name' => :'String'
       }
     end
 
@@ -68,6 +71,10 @@ module AsposeWordsCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.key?(:'NextParagraphStyleName')
+        self.next_paragraph_style_name = attributes[:'NextParagraphStyleName']
+      end
+
       if attributes.key?(:'BaseStyleName')
         self.base_style_name = attributes[:'BaseStyleName']
       end
@@ -79,17 +86,6 @@ module AsposeWordsCloud
       if attributes.key?(:'Name')
         self.name = attributes[:'Name']
       end
-
-      if attributes.key?(:'NextParagraphStyleName')
-        self.next_paragraph_style_name = attributes[:'NextParagraphStyleName']
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
@@ -103,10 +99,10 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
+          next_paragraph_style_name == other.next_paragraph_style_name &&
           base_style_name == other.base_style_name &&
           is_quick_style == other.is_quick_style &&
-          name == other.name &&
-          next_paragraph_style_name == other.next_paragraph_style_name
+          name == other.name
     end
 
     # @see the `==` method
@@ -118,7 +114,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [base_style_name, is_quick_style, name, next_paragraph_style_name].hash
+      [next_paragraph_style_name, base_style_name, is_quick_style, name].hash
     end
 
     # Builds the object from hash
@@ -234,5 +230,8 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/styles_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with an array of styles.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/styles" REST API requests.
   class StylesResponse
     # Gets or sets the request Id.
     attr_accessor :request_id
@@ -69,13 +70,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -216,5 +210,16 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.styles.nil?
+          for elementStyles in self.styles
+              unless elementStyles.nil?
+                  elementStyles.validate
+              end
+          end
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/svg_save_options_data.rb

@@ -30,25 +30,34 @@ module AsposeWordsCloud
   # Container class for svg save options.
   class SvgSaveOptionsData
     # Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
+    # Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
+    # This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true.
+    # The default value is false.
     attr_accessor :allow_embedding_post_script_fonts
 
     # Gets or sets CustomTimeZoneInfo.
     attr_accessor :custom_time_zone_info_data
 
     # Gets or sets the value determining how 3D effects are rendered.
+    # The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.
     attr_accessor :dml3_d_effects_rendering_mode
 
     # Gets or sets the value determining how DrawingML effects are rendered.
     # { Simplified | None | Fine }.
+    # The default value is Simplified.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_effects_rendering_mode
 
     # Gets or sets the option that controls how DrawingML shapes are rendered.
+    # { Fallback | DrawingML }. The default value is Fallback.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :dml_rendering_mode
 
     # Gets or sets the name of destination file.
     attr_accessor :file_name
 
     # Gets or sets the value determining how ink (InkML) objects are rendered.
+    # The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.
     attr_accessor :iml_rendering_mode
 
     # Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
@@ -62,14 +71,18 @@ module AsposeWordsCloud
     attr_accessor :update_last_printed_property
 
     # Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
+    # The default value is false.
     attr_accessor :update_last_saved_time_property
 
     # Gets or sets a value indicating whether to zip output or not.
     # The default value is false.
+    # When set to true, output files will be zipped.
     attr_accessor :zip_output
 
     # Gets or sets the value determining how colors are rendered.
     # { Normal | Grayscale}.
+    # The default value is Normal.
+    # This property is used when the document is exported to fixed page formats.
     attr_accessor :color_mode
 
     # Gets or sets the quality of the JPEG images inside PDF document.
@@ -310,13 +323,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -595,5 +601,16 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property file_name in SvgSaveOptionsData is required.' if self.file_name.nil?
+      unless self.custom_time_zone_info_data.nil?
+          self.custom_time_zone_info_data.validate
+      end
+      unless self.metafile_rendering_options.nil?
+          self.metafile_rendering_options.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/tab_stop.rb

@@ -108,13 +108,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -291,5 +284,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property alignment in TabStop is required.' if self.alignment.nil?
+      raise ArgumentError, 'Property leader in TabStop is required.' if self.leader.nil?
+      raise ArgumentError, 'Property position in TabStop is required.' if self.position.nil?
+      raise ArgumentError, 'Property is_clear in TabStop is required.' if self.is_clear.nil?
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/tab_stop_insert.rb

@@ -99,13 +99,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -281,5 +274,11 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property alignment in TabStopInsert is required.' if self.alignment.nil?
+      raise ArgumentError, 'Property leader in TabStopInsert is required.' if self.leader.nil?
+      raise ArgumentError, 'Property position in TabStopInsert is required.' if self.position.nil?
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/tab_stops_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with an array of tab stops.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/tabstops" REST API requests.
   class TabStopsResponse
     # Gets or sets the request Id.
     attr_accessor :request_id
@@ -69,13 +70,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -216,5 +210,16 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.tab_stops.nil?
+          for elementTabStops in self.tab_stops
+              unless elementTabStops.nil?
+                  elementTabStops.validate
+              end
+          end
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table.rb

@@ -87,13 +87,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -236,5 +229,22 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+      unless self.table_row_list.nil?
+          for elementTableRowList in self.table_row_list
+              unless elementTableRowList.nil?
+                  elementTableRowList.validate
+              end
+          end
+      end
+      unless self.table_properties.nil?
+          self.table_properties.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table_cell.rb

@@ -78,13 +78,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -226,5 +219,19 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+      unless self.child_nodes.nil?
+          for elementChildNodes in self.child_nodes
+              unless elementChildNodes.nil?
+                  elementChildNodes.validate
+              end
+          end
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table_cell_format.rb

@@ -48,6 +48,7 @@ module AsposeWordsCloud
     attr_accessor :orientation
 
     # Gets or sets the preferred width of the cell.
+    # The preferred width (along with the table's Auto Fit option) determines how the actual width of the cell is calculated by the table layout algorithm. Table layout can be performed by Aspose.Words when it saves the document or by Microsoft Word when it displays the document.The preferred width can be specified in points or in percent. The preferred width can also be specified as "auto", which means no preferred width is specified.The default value is Auto.
     attr_accessor :preferred_width
 
     # Gets or sets the amount of space (in points) to add to the right of the contents of the cell.
@@ -60,9 +61,11 @@ module AsposeWordsCloud
     attr_accessor :vertical_alignment
 
     # Gets or sets the option that controls how the cell is merged with other cells vertically.
+    # Cells can only be merged vertically if their left and right boundaries are identical.When cells are vertically merged, the display areas of the merged cells are consolidated. The consolidated area is used to display the contents of the first vertically merged cell and all other vertically merged cells must be empty.
     attr_accessor :vertical_merge
 
     # Gets or sets the width of the cell in points.
+    # The width is calculated by Aspose.Words on document loading and saving. Currently, not every combination of table, cell and document properties is supported. The returned value may not be accurate for some documents. It may not exactly match the cell width as calculated by MS Word when the document is opened in MS Word.Setting this property is not recommended. There is no guarantee that the cell will actually have the set width. The width may be adjusted to accommodate cell contents in an auto-fit table layout. Cells in other rows may have conflicting width settings. The table may be resized to fit into the container or to meet table width settings. Consider using PreferredWidth for setting the cell width. Setting this property sets PreferredWidth implicitly since version 15.8.
     attr_accessor :width
 
     # Gets or sets a value indicating whether to wrap text in the cell.
@@ -189,13 +192,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -413,5 +409,15 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+      unless self.preferred_width.nil?
+          self.preferred_width.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table_cell_format_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with the formatting properties of a table cell.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/tables/{0}/rows/{1}/cells/{2}/cellformat" REST API requests.
   class TableCellFormatResponse
     # Gets or sets the request Id.
     attr_accessor :request_id
@@ -67,13 +68,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -214,5 +208,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.cell_format.nil?
+          self.cell_format.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table_cell_insert.rb

@@ -58,13 +58,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -204,5 +197,8 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table_cell_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a table cell.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/tables/{0}" REST API requests.
   class TableCellResponse
     # Gets or sets the request Id.
     attr_accessor :request_id
@@ -67,13 +68,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -214,5 +208,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.cell.nil?
+          self.cell.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table_insert.rb

@@ -76,13 +76,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -224,5 +217,14 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property columns_count in TableInsert is required.' if self.columns_count.nil?
+      raise ArgumentError, 'Property rows_count in TableInsert is required.' if self.rows_count.nil?
+      unless self.position.nil?
+          self.position.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table_link.rb

@@ -67,13 +67,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -214,5 +207,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/table_link_collection.rb

@@ -69,13 +69,6 @@ module AsposeWordsCloud
       end
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = []
-      return invalid_properties
-    end
-
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
@@ -216,5 +209,19 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.link.nil?
+          self.link.validate
+      end
+      unless self.table_link_list.nil?
+          for elementTableLinkList in self.table_link_list
+              unless elementTableLinkList.nil?
+                  elementTableLinkList.validate
+              end
+          end
+      end
+
+    end
+
   end
 end