aspose_cells_cloud 23.8 → 23.10

data/lib/aspose_cells_cloud/models/worksheet.rb

@@ -33,67 +33,67 @@ module AsposeCellsCloud
   class Worksheet
         #            
         attr_accessor :links
-        #Indicates if the specified worksheet is displayed from right to left instead   of from left to right.  Default is false.                        
+        #Indicates if the specified worksheet is displayed from right to left instead of from left to right.            Default is false.             
         attr_accessor :display_right_to_left
-        #True if zero values are displayed.            
+        #True if zero values are displayed.             
         attr_accessor :display_zeros
-        #Represents first visible column index.            
+        #Represents first visible column index.             
         attr_accessor :first_visible_column
-        #Represents first visible row index.                        
+        #Represents first visible row index.             
         attr_accessor :first_visible_row
-        #Gets or sets the name of the worksheet.                        
+        #Gets or sets the name of the worksheet.             
         attr_accessor :name
-        #Gets the index of sheet in the worksheets collection.                        
+        #Gets the index of sheet in the worksheet collection.             
         attr_accessor :index
-        #Gets or sets a value indicating whether the gridelines are visible.Default    is true.            
+        #Gets or sets a value indicating whether the gridlines are visible.Default is true.             
         attr_accessor :is_gridlines_visible
-        #Indicates whether show outline.                        
+        #Indicates whether to show outline.             
         attr_accessor :is_outline_shown
-        #Indications the specified worksheet is shown in normal view or page break preview.            
+        #Indicates whether the specified worksheet is shown in normal view or page break preview.             
         attr_accessor :is_page_break_preview
-        #Represents if the worksheet is visible.                        
+        #Represents if the worksheet is visible.             
         attr_accessor :is_visible
-        #Indicates if the worksheet is protected.            
+        #Indicates if the worksheet is protected.             
         attr_accessor :is_protected
-        #Gets or sets a value indicating whether the worksheet will display row and column headers.Default is true.                        
+        #Gets or sets a value indicating whether the worksheet will display row and column headers.            Default is true.             
         attr_accessor :is_row_column_headers_visible
-        #Indicates whether the ruler is visible. Only apply for page break preview.            
+        #Indicates whether the ruler is visible. This property is only applied for page break preview.             
         attr_accessor :is_ruler_visible
-        #Indicates whether this worksheet is selected when the workbook is opened.            
+        #Indicates whether this worksheet is selected when the workbook is opened.             
         attr_accessor :is_selected
-        #Represents worksheet tab color.            
+        #Represents worksheet tab color.             
         attr_accessor :tab_color
-        #Flag indicating whether the Transition Formula Entry (Lotus compatibility) option is enabled.            
+        #Indicates whether the Transition Formula Entry (Lotus compatibility) option is enabled.             
         attr_accessor :transition_entry
-        #Flag indicating whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.                        
+        #Indicates whether the Transition Formula Evaluation (Lotus compatibility) option is enabled.             
         attr_accessor :transition_evaluation
-        #Represents worksheet type            
+        #Represents worksheet type.             
         attr_accessor :type
-        #Gets and sets the view type.            
+        #Gets and sets the view type.             
         attr_accessor :view_type
-        #Indicates the state for this sheet visibility                        
+        #Indicates the visible state for this sheet.             
         attr_accessor :visibility_type
-        #Represents the scaling factor in percent. It should be btween 10 and 400.                        
+        #Represents the scaling factor in percentage. It should be between 10 and 400.             
         attr_accessor :zoom
-        #            
+        #Gets the  collection.             
         attr_accessor :cells
-        #            
+        #Gets a  collection             
         attr_accessor :charts
         #            
         attr_accessor :auto_shapes
-        #            
+        #Represents a collection of  in a worksheet.             
         attr_accessor :ole_objects
-        #            
+        #Gets the  collection.             
         attr_accessor :comments
-        #            
+        #Gets a  collection.             
         attr_accessor :pictures
         #            
         attr_accessor :merged_cells
-        #            
+        #Gets the data validation setting collection in the worksheet.             
         attr_accessor :validations
-        #            
+        #Gets the ConditionalFormattings in the worksheet.             
         attr_accessor :conditional_formattings
-        #            
+        #Gets the  collection.             
         attr_accessor :hyperlinks
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/aspose_cells_cloud/models/worksheet_operate_parameter.rb

@@ -35,7 +35,7 @@ module AsposeCellsCloud
         attr_accessor :name
         #            
         attr_accessor :sheet_type
-        #            
+        #rename worksheet name            
         attr_accessor :new_name
         #            
         attr_accessor :moving_request

data/lib/aspose_cells_cloud/models/write_protection.rb

@@ -0,0 +1,246 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="WriteProtectionrb.cs">
+   Copyright (c) 2023 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 WriteProtection
+        #Gets and sets the author.             
+        attr_accessor :author
+        #Indicates if the Read Only Recommended option is selected.             
+        attr_accessor :recommend_read_only
+        #Indicates whether this workbook is write protected.             
+        attr_accessor :is_write_protected
+        #Sets the protected password to modify the file.             
+        attr_accessor :password
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'author' => :'Author',
+        :'recommend_read_only' => :'RecommendReadOnly',
+        :'is_write_protected' => :'IsWriteProtected',
+        :'password' => :'Password'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'author' => :'String',
+        :'recommend_read_only' => :'BOOLEAN',
+        :'is_write_protected' => :'BOOLEAN',
+        :'password' => :'String'
+      }
+    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?(:'Author')
+          self.author = attributes[:'Author']
+      end
+      if attributes.has_key?(:'RecommendReadOnly')
+          self.recommend_read_only = attributes[:'RecommendReadOnly']
+      end
+      if attributes.has_key?(:'IsWriteProtected')
+          self.is_write_protected = attributes[:'IsWriteProtected']
+      end
+      if attributes.has_key?(:'Password')
+          self.password = attributes[:'Password']
+      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 @author.nil?
+          invalid_properties.push("invalid value for 'author', author cannot be nil.")
+      end
+      if @recommend_read_only.nil?
+          invalid_properties.push("invalid value for 'recommend_read_only', recommend_read_only cannot be nil.")
+      end
+      if @is_write_protected.nil?
+          invalid_properties.push("invalid value for 'is_write_protected', is_write_protected cannot be nil.")
+      end
+      if @password.nil?
+          invalid_properties.push("invalid value for 'password', password 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 @author.nil?
+      return false if @recommend_read_only.nil?
+      return false if @is_write_protected.nil?
+      return false if @password.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 &&
+          author == o.author &&
+          recommend_read_only == o.recommend_read_only &&
+          is_write_protected == o.is_write_protected &&
+          password == o.password 
+          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
+      [ author , recommend_read_only , is_write_protected , password ].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/xml_data_binding.rb

@@ -0,0 +1,210 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+ <copyright company="Aspose" file="XmlDataBindingrb.cs">
+   Copyright (c) 2023 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 XmlDataBinding
+        #Gets source url of this data binding.             
+        attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'url' => :'Url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'url' => :'String'
+      }
+    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?(:'Url')
+          self.url = attributes[:'Url']
+      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 @url.nil?
+          invalid_properties.push("invalid value for 'url', url 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 @url.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 &&
+          url == o.url 
+          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
+      [ url ].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