aspose_cells_cloud 25.4 → 25.6

data/lib/aspose_cells_cloud/models/dbf_save_options.rb

@@ -0,0 +1,366 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="DbfSaveOptionsrb.cs">
+   Copyright (c) 2025 Aspose.Cells Cloud
+ </copyright>
+ <summary>
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+ </summary>
+--------------------------------------------------------------------------------------------------------------------
+=end
+
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class DbfSaveOptions
+        #            
+        attr_accessor :export_as_string
+        #            
+        attr_accessor :save_format
+        #            
+        attr_accessor :cached_file_folder
+        #            
+        attr_accessor :clear_data
+        #            
+        attr_accessor :create_directory
+        #            
+        attr_accessor :enable_http_compression
+        #            
+        attr_accessor :refresh_chart_cache
+        #            
+        attr_accessor :sort_names
+        #            
+        attr_accessor :validate_merged_areas
+        #            
+        attr_accessor :merge_areas
+        #            
+        attr_accessor :sort_external_names
+        #            
+        attr_accessor :check_excel_restriction
+        #            
+        attr_accessor :update_smart_art
+        #            
+        attr_accessor :encrypt_document_properties
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'export_as_string' => :'ExportAsString',
+        :'save_format' => :'SaveFormat',
+        :'cached_file_folder' => :'CachedFileFolder',
+        :'clear_data' => :'ClearData',
+        :'create_directory' => :'CreateDirectory',
+        :'enable_http_compression' => :'EnableHTTPCompression',
+        :'refresh_chart_cache' => :'RefreshChartCache',
+        :'sort_names' => :'SortNames',
+        :'validate_merged_areas' => :'ValidateMergedAreas',
+        :'merge_areas' => :'MergeAreas',
+        :'sort_external_names' => :'SortExternalNames',
+        :'check_excel_restriction' => :'CheckExcelRestriction',
+        :'update_smart_art' => :'UpdateSmartArt',
+        :'encrypt_document_properties' => :'EncryptDocumentProperties'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'export_as_string' => :'BOOLEAN',
+        :'save_format' => :'String',
+        :'cached_file_folder' => :'String',
+        :'clear_data' => :'BOOLEAN',
+        :'create_directory' => :'BOOLEAN',
+        :'enable_http_compression' => :'BOOLEAN',
+        :'refresh_chart_cache' => :'BOOLEAN',
+        :'sort_names' => :'BOOLEAN',
+        :'validate_merged_areas' => :'BOOLEAN',
+        :'merge_areas' => :'BOOLEAN',
+        :'sort_external_names' => :'BOOLEAN',
+        :'check_excel_restriction' => :'BOOLEAN',
+        :'update_smart_art' => :'BOOLEAN',
+        :'encrypt_document_properties' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'ExportAsString')
+          self.export_as_string = attributes[:'ExportAsString']
+      end
+      if attributes.has_key?(:'SaveFormat')
+          self.save_format = attributes[:'SaveFormat']
+      end
+      if attributes.has_key?(:'CachedFileFolder')
+          self.cached_file_folder = attributes[:'CachedFileFolder']
+      end
+      if attributes.has_key?(:'ClearData')
+          self.clear_data = attributes[:'ClearData']
+      end
+      if attributes.has_key?(:'CreateDirectory')
+          self.create_directory = attributes[:'CreateDirectory']
+      end
+      if attributes.has_key?(:'EnableHTTPCompression')
+          self.enable_http_compression = attributes[:'EnableHTTPCompression']
+      end
+      if attributes.has_key?(:'RefreshChartCache')
+          self.refresh_chart_cache = attributes[:'RefreshChartCache']
+      end
+      if attributes.has_key?(:'SortNames')
+          self.sort_names = attributes[:'SortNames']
+      end
+      if attributes.has_key?(:'ValidateMergedAreas')
+          self.validate_merged_areas = attributes[:'ValidateMergedAreas']
+      end
+      if attributes.has_key?(:'MergeAreas')
+          self.merge_areas = attributes[:'MergeAreas']
+      end
+      if attributes.has_key?(:'SortExternalNames')
+          self.sort_external_names = attributes[:'SortExternalNames']
+      end
+      if attributes.has_key?(:'CheckExcelRestriction')
+          self.check_excel_restriction = attributes[:'CheckExcelRestriction']
+      end
+      if attributes.has_key?(:'UpdateSmartArt')
+          self.update_smart_art = attributes[:'UpdateSmartArt']
+      end
+      if attributes.has_key?(:'EncryptDocumentProperties')
+          self.encrypt_document_properties = attributes[:'EncryptDocumentProperties']
+      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 = Array.new
+      if @export_as_string.nil?
+          invalid_properties.push("invalid value for 'export_as_string', export_as_string cannot be nil.")
+      end
+      if @save_format.nil?
+          invalid_properties.push("invalid value for 'save_format', save_format cannot be nil.")
+      end
+      if @cached_file_folder.nil?
+          invalid_properties.push("invalid value for 'cached_file_folder', cached_file_folder cannot be nil.")
+      end
+      if @clear_data.nil?
+          invalid_properties.push("invalid value for 'clear_data', clear_data cannot be nil.")
+      end
+      if @create_directory.nil?
+          invalid_properties.push("invalid value for 'create_directory', create_directory cannot be nil.")
+      end
+      if @enable_http_compression.nil?
+          invalid_properties.push("invalid value for 'enable_http_compression', enable_http_compression cannot be nil.")
+      end
+      if @refresh_chart_cache.nil?
+          invalid_properties.push("invalid value for 'refresh_chart_cache', refresh_chart_cache cannot be nil.")
+      end
+      if @sort_names.nil?
+          invalid_properties.push("invalid value for 'sort_names', sort_names cannot be nil.")
+      end
+      if @validate_merged_areas.nil?
+          invalid_properties.push("invalid value for 'validate_merged_areas', validate_merged_areas cannot be nil.")
+      end
+      if @merge_areas.nil?
+          invalid_properties.push("invalid value for 'merge_areas', merge_areas cannot be nil.")
+      end
+      if @sort_external_names.nil?
+          invalid_properties.push("invalid value for 'sort_external_names', sort_external_names cannot be nil.")
+      end
+      if @check_excel_restriction.nil?
+          invalid_properties.push("invalid value for 'check_excel_restriction', check_excel_restriction cannot be nil.")
+      end
+      if @update_smart_art.nil?
+          invalid_properties.push("invalid value for 'update_smart_art', update_smart_art cannot be nil.")
+      end
+      if @encrypt_document_properties.nil?
+          invalid_properties.push("invalid value for 'encrypt_document_properties', encrypt_document_properties cannot be nil.")
+      end
+
+      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?
+      return false if @export_as_string.nil?
+      return false if @save_format.nil?
+      return false if @cached_file_folder.nil?
+      return false if @clear_data.nil?
+      return false if @create_directory.nil?
+      return false if @enable_http_compression.nil?
+      return false if @refresh_chart_cache.nil?
+      return false if @sort_names.nil?
+      return false if @validate_merged_areas.nil?
+      return false if @merge_areas.nil?
+      return false if @sort_external_names.nil?
+      return false if @check_excel_restriction.nil?
+      return false if @update_smart_art.nil?
+      return false if @encrypt_document_properties.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          export_as_string == o.export_as_string &&
+          save_format == o.save_format &&
+          cached_file_folder == o.cached_file_folder &&
+          clear_data == o.clear_data &&
+          create_directory == o.create_directory &&
+          enable_http_compression == o.enable_http_compression &&
+          refresh_chart_cache == o.refresh_chart_cache &&
+          sort_names == o.sort_names &&
+          validate_merged_areas == o.validate_merged_areas &&
+          merge_areas == o.merge_areas &&
+          sort_external_names == o.sort_external_names &&
+          check_excel_restriction == o.check_excel_restriction &&
+          update_smart_art == o.update_smart_art &&
+          encrypt_document_properties == o.encrypt_document_properties 
+          std_dev == o.std_dev
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [ export_as_string , save_format , cached_file_folder , clear_data , create_directory , enable_http_compression , refresh_chart_cache , sort_names , validate_merged_areas , merge_areas , sort_external_names , check_excel_restriction , update_smart_art , encrypt_document_properties ].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = AsposeCellsCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/aspose_cells_cloud/models/html_save_options.rb

@@ -31,7 +31,7 @@ require 'date'
 module AsposeCellsCloud
 
   class HtmlSaveOptions
-        #Indicates whether exporting page headers.            
+        #            
         attr_accessor :export_page_headers
         #            
         attr_accessor :export_page_footers
@@ -41,71 +41,71 @@ module AsposeCellsCloud
         attr_accessor :show_all_sheets
         #            
         attr_accessor :image_options
-        #Indicates whether save the html as single file. The default value is false.            
+        #            
         attr_accessor :save_as_single_file
-        #Indicates whether save the html as single file. The default value is false.            
+        #            
         attr_accessor :export_hidden_worksheet
-        #Indicating whether exporting the gridlines.The default value is false.            
+        #            
         attr_accessor :export_grid_lines
-        #Indicating if html or mht file is presentation preference.The default value is             false.if you want to get more beautiful presentation,please set the value to                true.            
+        #            
         attr_accessor :presentation_preference
-        #Gets and sets the prefix of the css name,the default value is "".            
+        #            
         attr_accessor :cell_css_prefix
-        #Gets and sets the prefix of the type css name such as tr,col,td and so on, they                are contained in the table element which has the specific TableCssId attribute.                The default value is "".            
+        #            
         attr_accessor :table_css_id
-        #Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.                The default value is false.            
+        #            
         attr_accessor :is_full_path_link
-        #Indicating whether export the worksheet css separately.The default value is false.            
+        #            
         attr_accessor :export_worksheet_css_separately
         #            
         attr_accessor :export_similar_border_style
-        #Indicates whether merging empty TD element forcely when exporting file to html.                The size of html file will be reduced significantly after setting value to true.                The default value is false. If you want to import the html file to excel or export                perfect grid lines when saving file to html, please keep the default value.            
+        #            
         attr_accessor :merge_empty_td_forcely
-        #Indicates whether exporting excel coordinate of nonblank cells when saving file                to html. The default value is false. If you want to import the output html to                excel, please keep the default value.            
+        #            
         attr_accessor :export_cell_coordinate
-        #Indicates whether exporting extra headings when the length of text is longer                than max display column. The default value is false. If you want to import the                html file to excel, please keep the default value.            
+        #            
         attr_accessor :export_extra_headings
-        #Indicates whether exporting headings when saving file to html.The default value                is false. If you want to import the html file to excel, please keep the default                value.            
+        #            
         attr_accessor :export_headings
-        #Indicates whether exporting formula when saving file to html. The default value                is true. If you want to import the output html to excel, please keep the default                value            
+        #            
         attr_accessor :export_formula
-        #Indicates whether adding tooltip text when the data can't be fully displayed.            
+        #            
         attr_accessor :add_tooltip_text
-        #Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file to excel, please keep the default value.            
+        #            
         attr_accessor :export_bogus_row_data
-        #Indicating whether excluding unused styles.The default value is false.If you  want to import the html or mht file to excel, please keep the default value.            
+        #            
         attr_accessor :exclude_unused_styles
-        #Indicating whether exporting document properties.The default value is true.If  you want to import the html or mht file to excel, please keep the default value.            
+        #            
         attr_accessor :export_document_properties
-        #Indicating whether exporting worksheet properties.The default value is true.If  you want to import the html or mht file to excel, please keep the default value.            
+        #            
         attr_accessor :export_worksheet_properties
-        #Indicating whether exporting workbook properties.The default value is true.If  you want to import the html or mht file to excel, please keep the default value.            
+        #            
         attr_accessor :export_workbook_properties
-        #Indicating whether exporting frame scripts and document properties. The default  value is true.If you want to import the html or mht file to excel, please keep the default value.            
+        #            
         attr_accessor :export_frame_scripts_and_properties
-        #The directory that the attached files will be saved to.  Only for saving to html stream.            
+        #            
         attr_accessor :attached_files_directory
-        #Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.            
+        #            
         attr_accessor :attached_files_url_prefix
         #            
         attr_accessor :encoding
-        #Indicates if exporting the whole workbook to html file.            
+        #            
         attr_accessor :export_active_worksheet_only
-        #Get or set the format of chart image before exporting            
+        #            
         attr_accessor :export_chart_image_format
         #            
         attr_accessor :export_images_as_base64
-        #Hidden column(the width of this column is 0) in excel,before save this into               html format, if HtmlHiddenColDisplayType is "Remove",the hidden column would               ont been output, if the value is "Hidden", the column would been output,but was hidden,the default value is "Hidden"            
+        #            
         attr_accessor :hidden_col_display_type
-        #Hidden row(the height of this row is 0) in excel,before save this into html               format, if HtmlHiddenRowDisplayType is "Remove",the hidden row would ont               been output, if the value is "Hidden", the row would been output,but was               hidden,the default value is "Hidden"            
+        #            
         attr_accessor :hidden_row_display_type
-        #Indicates if a cross-cell string will be displayed in the same way as MS               Excel when saving an Excel file in html format.  By default the value is               Default, so, for cross-cell strings, there is little difference between the               html files created by Aspose.Cells and MS Excel. But the performance for               creating large html files,setting the value to Cross would be several times               faster than setting it to Default or Fit2Cell.            
+        #            
         attr_accessor :html_cross_string_type
-        #Indicates if export image files to temp directory.  Only for saving to html  stream.            
+        #            
         attr_accessor :is_exp_image_to_temp_dir
-        #The title of the html page.  Only for saving to html stream.            
+        #            
         attr_accessor :page_title
-        #Parse html tag in cell,like ,as cell value,or as html tag,default is true            
+        #            
         attr_accessor :parse_html_tag_in_cell
         #            
         attr_accessor :cell_name_attribute

data/lib/aspose_cells_cloud/models/image_or_print_options.rb

@@ -31,11 +31,11 @@ require 'date'
 module AsposeCellsCloud
 
   class ImageOrPrintOptions
-        #TextCrossType            
+        #            
         attr_accessor :text_cross_type
-        #GridlineType            
+        #            
         attr_accessor :gridline_type
-        #Indicates whether to output a blank page when there is nothing to print.            
+        #            
         attr_accessor :output_blank_page_when_nothing_to_print
         #            
         attr_accessor :check_workbook_default_font
@@ -65,21 +65,21 @@ module AsposeCellsCloud
         attr_accessor :horizontal_resolution
         #            
         attr_accessor :vertical_resolution
-        #DefaultEditLanguage            
+        #            
         attr_accessor :default_edit_language
-        #ColorDepth            
+        #            
         attr_accessor :tiff_color_depth
-        #TiffCompression            
+        #            
         attr_accessor :tiff_compression
-        #PrintingPageType            
+        #            
         attr_accessor :printing_page
         #            
         attr_accessor :quality
-        #ImageType            
+        #            
         attr_accessor :image_type
         #            
         attr_accessor :one_page_per_sheet
-        #ImageBinarizationMethod            
+        #            
         attr_accessor :tiff_binarization_method
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/image_save_options.rb

@@ -31,29 +31,29 @@ require 'date'
 module AsposeCellsCloud
 
   class ImageSaveOptions
-        #Indicate the chart imagetype when converting.            
+        #            
         attr_accessor :chart_image_type
-        #Indicate the filename of embeded image in svg. This should be full path with directory like "c:\\xpsEmbeded"            
+        #            
         attr_accessor :embeded_image_name_in_svg
-        #Gets or sets the horizontal resolution for generated images, in dots per inch.                 Applies generating image method except Emf format images.               The default value is 96.            
+        #            
         attr_accessor :horizontal_resolution
-        #Gets or sets the format of the generated images.  Don't apply the method that returns a Bitmap object.             The default value is ImageFormat.Bmp.  Don't apply the method that returns a Bitmap object.            
+        #            
         attr_accessor :image_format
-        #Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.            
+        #            
         attr_accessor :is_cell_auto_fit
-        #If OnePagePerSheet is true , all content of one sheet will output to only                one page in result. The paper size of pagesetup will be invalid, and the                other settings of pagesetup will still take effect.            
+        #            
         attr_accessor :one_page_per_sheet
-        #If this property is true , onle Area will be output, and no scale will take effect.            
+        #            
         attr_accessor :only_area
-        #Indicates which pages will not be printed.            
+        #            
         attr_accessor :printing_page
-        #If PrintWithStatusDialog = true , there will be a dialog that shows current print status.  else no such dialog will show.            
+        #            
         attr_accessor :print_with_status_dialog
-        #Gets or sets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format.            Has effect only when saving to JPEG.  The value must be between 0 and 100. The default value is 100.            
+        #            
         attr_accessor :quality
-        #Gets or sets the type of compression to apply only when saving pages to the Tiff format.            Has effect only when saving to TIFF.  The default value is Lzw.            
+        #            
         attr_accessor :tiff_compression
-        #Gets or sets the vertical resolution for generated images, in dots per inch.            Applies generating image method except Emf format image.            The default value is 96.            
+        #            
         attr_accessor :vertical_resolution
         #            
         attr_accessor :save_format

data/lib/aspose_cells_cloud/models/json_save_options.rb

@@ -31,13 +31,13 @@ require 'date'
 module AsposeCellsCloud
 
   class JsonSaveOptions
-        #Gets or sets the exporting range.            
+        #            
         attr_accessor :export_area
-        #Indicates whether the range contains header row.            
+        #            
         attr_accessor :has_header_row
-        #Exports the string value of the cells to json.            
+        #            
         attr_accessor :export_as_string
-        #Indicates the indent.            
+        #            
         attr_accessor :indent
         #            
         attr_accessor :save_format