aspose_words_cloud 23.9.0 → 23.11.0

data/lib/aspose_words_cloud/models/footnote_insert.rb

@@ -29,17 +29,19 @@ module AsposeWordsCloud
 
   # Footnote for insert.
   class FootnoteInsert
-    # Gets or sets the option, that specifies whether this is a footnote or endnote.
-    attr_accessor :footnote_type
-
     # Gets or sets the link to comment range start node.
     attr_accessor :position
 
+    # Gets or sets the option, that specifies whether this is a footnote or endnote.
+    attr_accessor :footnote_type
+
     # Gets or sets the custom reference mark to be used for this footnote.
     # Default value is Empty, meaning auto-numbered footnotes are used.
+    # RTF-format can only store 1 symbol as custom reference mark, so upon export only the first symbol will be written others will be discard.
     attr_accessor :reference_mark
 
     # Gets or sets text of the footnote.
+    # This method allows to quickly set text of a footnote from a string. The string can contain paragraph breaks, this will create paragraphs of text in the footnote accordingly.
     attr_accessor :text
 
     class EnumAttributeValidator
@@ -67,8 +69,8 @@ module AsposeWordsCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'footnote_type' => :'FootnoteType',
         :'position' => :'Position',
+        :'footnote_type' => :'FootnoteType',
         :'reference_mark' => :'ReferenceMark',
         :'text' => :'Text'
       }
@@ -77,8 +79,8 @@ module AsposeWordsCloud
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'footnote_type' => :'String',
         :'position' => :'NewDocumentPosition',
+        :'footnote_type' => :'String',
         :'reference_mark' => :'String',
         :'text' => :'String'
       }
@@ -92,14 +94,14 @@ 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?(:'FootnoteType')
-        self.footnote_type = attributes[:'FootnoteType']
-      end
-
       if attributes.key?(:'Position')
         self.position = attributes[:'Position']
       end
 
+      if attributes.key?(:'FootnoteType')
+        self.footnote_type = attributes[:'FootnoteType']
+      end
+
       if attributes.key?(:'ReferenceMark')
         self.reference_mark = attributes[:'ReferenceMark']
       end
@@ -109,13 +111,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?
@@ -145,8 +140,8 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          footnote_type == other.footnote_type &&
           position == other.position &&
+          footnote_type == other.footnote_type &&
           reference_mark == other.reference_mark &&
           text == other.text
     end
@@ -160,7 +155,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [footnote_type, position, reference_mark, text].hash
+      [position, footnote_type, reference_mark, text].hash
     end
 
     # Builds the object from hash
@@ -276,5 +271,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.position.nil?
+          self.position.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/footnote_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/footnote_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a footnote.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/footnote/0" REST API requests.
   class FootnoteResponse
     # 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.footnote.nil?
+          self.footnote.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/footnote_update.rb

@@ -29,17 +29,19 @@ module AsposeWordsCloud
 
   # Footnote for update.
   class FootnoteUpdate
-    # Gets or sets the option, that specifies whether this is a footnote or endnote.
-    attr_accessor :footnote_type
-
     # Gets or sets the link to comment range start node.
     attr_accessor :position
 
+    # Gets or sets the option, that specifies whether this is a footnote or endnote.
+    attr_accessor :footnote_type
+
     # Gets or sets the custom reference mark to be used for this footnote.
     # Default value is Empty, meaning auto-numbered footnotes are used.
+    # RTF-format can only store 1 symbol as custom reference mark, so upon export only the first symbol will be written others will be discard.
     attr_accessor :reference_mark
 
     # Gets or sets text of the footnote.
+    # This method allows to quickly set text of a footnote from a string. The string can contain paragraph breaks, this will create paragraphs of text in the footnote accordingly.
     attr_accessor :text
 
     class EnumAttributeValidator
@@ -67,8 +69,8 @@ module AsposeWordsCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'footnote_type' => :'FootnoteType',
         :'position' => :'Position',
+        :'footnote_type' => :'FootnoteType',
         :'reference_mark' => :'ReferenceMark',
         :'text' => :'Text'
       }
@@ -77,8 +79,8 @@ module AsposeWordsCloud
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'footnote_type' => :'String',
         :'position' => :'NewDocumentPosition',
+        :'footnote_type' => :'String',
         :'reference_mark' => :'String',
         :'text' => :'String'
       }
@@ -92,14 +94,14 @@ 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?(:'FootnoteType')
-        self.footnote_type = attributes[:'FootnoteType']
-      end
-
       if attributes.key?(:'Position')
         self.position = attributes[:'Position']
       end
 
+      if attributes.key?(:'FootnoteType')
+        self.footnote_type = attributes[:'FootnoteType']
+      end
+
       if attributes.key?(:'ReferenceMark')
         self.reference_mark = attributes[:'ReferenceMark']
       end
@@ -109,13 +111,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?
@@ -145,8 +140,8 @@ module AsposeWordsCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          footnote_type == other.footnote_type &&
           position == other.position &&
+          footnote_type == other.footnote_type &&
           reference_mark == other.reference_mark &&
           text == other.text
     end
@@ -160,7 +155,7 @@ module AsposeWordsCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [footnote_type, position, reference_mark, text].hash
+      [position, footnote_type, reference_mark, text].hash
     end
 
     # Builds the object from hash
@@ -276,5 +271,12 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      unless self.position.nil?
+          self.position.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/footnotes_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a collection of footnotes.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/footnotes" REST API requests.
   class FootnotesResponse
     # 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.footnotes.nil?
+          self.footnotes.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/footnotes_stat_data.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,10 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property paragraph_count in FootnotesStatData is required.' if self.paragraph_count.nil?
+      raise ArgumentError, 'Property word_count in FootnotesStatData is required.' if self.word_count.nil?
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/form_field_checkbox.rb

@@ -39,27 +39,35 @@ module AsposeWordsCloud
     attr_accessor :name
 
     # Gets or sets a value indicating whether a form field is enabled.
+    # If a form field is enabled, its contents can be changed as the form is filled in.
     attr_accessor :enabled
 
     # Gets or sets text, displayed in the status bar when a form field has the focus.
+    # If the OwnStatus property is set to true, the StatusText property specifies the status bar text. If the OwnStatus property is set to false, the StatusText property specifies the name of an AutoText entry that contains status bar text for the form field.
     attr_accessor :status_text
 
     # Gets or sets a value indicating whether the source of the text that's displayed in the status bar when a form field has the focus.
+    # If true, the text specified by the StatusText property is displayed. If false, the text of the AutoText entry specified by the StatusText property is displayed.
     attr_accessor :own_status
 
     # Gets or sets text, displayed in a message box when the form field has the focus and the user presses F1.
+    # If the OwnHelp property is set to True, HelpText specifies the text string value. If OwnHelp is set to False, HelpText specifies the name of an AutoText entry that contains help text for the form field.
     attr_accessor :help_text
 
     # Gets or sets a value indicating whether the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.
+    # If True, the text specified by the HelpText property is displayed. If False, the text in the AutoText entry specified by the HelpText property is displayed.
     attr_accessor :own_help
 
     # Gets or sets a value indicating whether references to the specified form field are automatically updated whenever the field is exited.
+    # Setting CalculateOnExit only affects the behavior of the form field when the document is opened in Microsoft Word. Aspose.Words never updates references to the form field.
     attr_accessor :calculate_on_exit
 
     # Gets or sets the entry macro name for the form field.
+    # The entry macro runs when the form field gets the focus in Microsoft Word.
     attr_accessor :entry_macro
 
     # Gets or sets the exit macro name for the form field.
+    # The exit macro runs when the form field loses the focus in Microsoft Word.
     attr_accessor :exit_macro
 
     # Gets or sets a value indicating whether the size of the textbox is automatic or specified explicitly.
@@ -175,13 +183,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?
@@ -334,5 +335,14 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property name in FormFieldCheckbox is required.' if self.name.nil?
+      raise ArgumentError, 'Property checked in FormFieldCheckbox is required.' if self.checked.nil?
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/form_field_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.list.nil?
+          for elementList in self.list
+              unless elementList.nil?
+                  elementList.validate
+              end
+          end
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/form_field_drop_down.rb

@@ -39,30 +39,39 @@ module AsposeWordsCloud
     attr_accessor :name
 
     # Gets or sets a value indicating whether a form field is enabled.
+    # If a form field is enabled, its contents can be changed as the form is filled in.
     attr_accessor :enabled
 
     # Gets or sets text, displayed in the status bar when a form field has the focus.
+    # If the OwnStatus property is set to true, the StatusText property specifies the status bar text. If the OwnStatus property is set to false, the StatusText property specifies the name of an AutoText entry that contains status bar text for the form field.
     attr_accessor :status_text
 
     # Gets or sets a value indicating whether the source of the text that's displayed in the status bar when a form field has the focus.
+    # If true, the text specified by the StatusText property is displayed. If false, the text of the AutoText entry specified by the StatusText property is displayed.
     attr_accessor :own_status
 
     # Gets or sets text, displayed in a message box when the form field has the focus and the user presses F1.
+    # If the OwnHelp property is set to True, HelpText specifies the text string value. If OwnHelp is set to False, HelpText specifies the name of an AutoText entry that contains help text for the form field.
     attr_accessor :help_text
 
     # Gets or sets a value indicating whether the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.
+    # If True, the text specified by the HelpText property is displayed. If False, the text in the AutoText entry specified by the HelpText property is displayed.
     attr_accessor :own_help
 
     # Gets or sets a value indicating whether references to the specified form field are automatically updated whenever the field is exited.
+    # Setting CalculateOnExit only affects the behavior of the form field when the document is opened in Microsoft Word. Aspose.Words never updates references to the form field.
     attr_accessor :calculate_on_exit
 
     # Gets or sets the entry macro name for the form field.
+    # The entry macro runs when the form field gets the focus in Microsoft Word.
     attr_accessor :entry_macro
 
     # Gets or sets the exit macro name for the form field.
+    # The exit macro runs when the form field loses the focus in Microsoft Word.
     attr_accessor :exit_macro
 
     # Gets or sets the items array of a dropdown form field.
+    # Microsoft Word allows maximum 25 items in a dropdown form field.
     attr_accessor :drop_down_items
 
     # Gets or sets the index specifying the currently selected item in a dropdown form field.
@@ -168,13 +177,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?
@@ -326,5 +328,14 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property name in FormFieldDropDown is required.' if self.name.nil?
+      raise ArgumentError, 'Property drop_down_items in FormFieldDropDown is required.' if self.drop_down_items.nil?
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/form_field_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a form field.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/paragraphs/{0}/form fields/{1}" REST API requests.
   class FormFieldResponse
     # 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.form_field.nil?
+          self.form_field.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/form_field_text_input.rb

@@ -39,36 +39,46 @@ module AsposeWordsCloud
     attr_accessor :name
 
     # Gets or sets a value indicating whether a form field is enabled.
+    # If a form field is enabled, its contents can be changed as the form is filled in.
     attr_accessor :enabled
 
     # Gets or sets text, displayed in the status bar when a form field has the focus.
+    # If the OwnStatus property is set to true, the StatusText property specifies the status bar text. If the OwnStatus property is set to false, the StatusText property specifies the name of an AutoText entry that contains status bar text for the form field.
     attr_accessor :status_text
 
     # Gets or sets a value indicating whether the source of the text that's displayed in the status bar when a form field has the focus.
+    # If true, the text specified by the StatusText property is displayed. If false, the text of the AutoText entry specified by the StatusText property is displayed.
     attr_accessor :own_status
 
     # Gets or sets text, displayed in a message box when the form field has the focus and the user presses F1.
+    # If the OwnHelp property is set to True, HelpText specifies the text string value. If OwnHelp is set to False, HelpText specifies the name of an AutoText entry that contains help text for the form field.
     attr_accessor :help_text
 
     # Gets or sets a value indicating whether the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.
+    # If True, the text specified by the HelpText property is displayed. If False, the text in the AutoText entry specified by the HelpText property is displayed.
     attr_accessor :own_help
 
     # Gets or sets a value indicating whether references to the specified form field are automatically updated whenever the field is exited.
+    # Setting CalculateOnExit only affects the behavior of the form field when the document is opened in Microsoft Word. Aspose.Words never updates references to the form field.
     attr_accessor :calculate_on_exit
 
     # Gets or sets the entry macro name for the form field.
+    # The entry macro runs when the form field gets the focus in Microsoft Word.
     attr_accessor :entry_macro
 
     # Gets or sets the exit macro name for the form field.
+    # The exit macro runs when the form field loses the focus in Microsoft Word.
     attr_accessor :exit_macro
 
     # Gets or sets text formatting for the text form field.
+    # If the text form field contains regular text, then valid format strings are "", "UPPERCASE", "LOWERCASE", "FIRST CAPITAL" and "TITLE CASE". The strings are case-insensitive.If the text form field contains a number or a date/time value, then valid format strings are number or date and time format strings.
     attr_accessor :text_input_format
 
     # Gets or sets the type of the text form field.
     attr_accessor :text_input_type
 
     # Gets or sets the default string or a calculation expression of the text form field.
+    # The meaning of this property depends on the value of the TextInputType property.When TextInputType is Regular or Number, this string specifies the default string for the text form field. This string is the content that Microsoft Word will display in the document when the form field is empty.When TextInputType is Calculated, then this string holds the expression to be calculated. The expression needs to be a formula valid according to Microsoft Word formula field requirements. When you set a new expression using this property, Aspose.Words calculates the formula result automatically and inserts it into the form field.
     attr_accessor :text_input_default
 
     # Gets or sets the maximum length for the text field. Zero when the length is not limited.
@@ -207,13 +217,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?
@@ -385,5 +388,15 @@ module AsposeWordsCloud
     def collectFilesContent(resultFilesContent)
     end
 
+    def validate()
+      raise ArgumentError, 'Property name in FormFieldTextInput is required.' if self.name.nil?
+      raise ArgumentError, 'Property text_input_format in FormFieldTextInput is required.' if self.text_input_format.nil?
+      raise ArgumentError, 'Property text_input_default in FormFieldTextInput is required.' if self.text_input_default.nil?
+      unless self.link.nil?
+          self.link.validate
+      end
+
+    end
+
   end
 end

data/lib/aspose_words_cloud/models/form_fields_response.rb

@@ -28,6 +28,7 @@ require 'date'
 module AsposeWordsCloud
 
   # The REST response with a collection of form fields.
+  # This response is returned by the Service when handling "GET https://api.aspose.cloud/v4.0/words/Test.doc/{nodePath}/form fields" REST API requests.
   class FormFieldsResponse
     # 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.form_fields.nil?
+          self.form_fields.validate
+      end
+
+    end
+
   end
 end