class AsposeCellsCloud::TxtSaveOptions
Attributes
Indicates whether always adding ‘“’ for each field. If true then all values will be quoted; If false then values will only be quoted when needed(for example, when values contain special characters such as ‘”’ , ‘n’ or separator character). Default is false.
Gets or sets how to quote values in the exported text file.
Gets and sets char Delimiter of text file.
Gets and sets the a string value as separator.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 60 def self.attribute_map { :'quote_type' => :'QuoteType', :'separator' => :'Separator', :'separator_string' => :'SeparatorString', :'always_quoted' => :'AlwaysQuoted', :'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' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 97 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?(:'QuoteType') self.quote_type = attributes[:'QuoteType'] end if attributes.has_key?(:'Separator') self.separator = attributes[:'Separator'] end if attributes.has_key?(:'SeparatorString') self.separator_string = attributes[:'SeparatorString'] end if attributes.has_key?(:'AlwaysQuoted') self.always_quoted = attributes[:'AlwaysQuoted'] 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 end
Attribute type mapping.
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 78 def self.swagger_types { :'quote_type' => :'String', :'separator' => :'String', :'separator_string' => :'String', :'always_quoted' => :'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' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 206 def ==(o) return true if self.equal?(o) self.class == o.class && quote_type == o.quote_type && separator == o.separator && separator_string == o.separator_string && always_quoted == o.always_quoted && 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 std_dev == o.std_dev end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 260 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
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
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 326 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 239 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 226 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 232 def hash [ quote_type , separator , separator_string , always_quoted , save_format , cached_file_folder , clear_data , create_directory , enable_http_compression , refresh_chart_cache , sort_names , validate_merged_areas ].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 144 def list_invalid_properties invalid_properties = Array.new if @quote_type.nil? invalid_properties.push("invalid value for 'quote_type', quote_type cannot be nil.") end if @separator.nil? invalid_properties.push("invalid value for 'separator', separator cannot be nil.") end if @separator_string.nil? invalid_properties.push("invalid value for 'separator_string', separator_string cannot be nil.") end if @always_quoted.nil? invalid_properties.push("invalid value for 'always_quoted', always_quoted 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 return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 312 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 300 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/aspose_cells_cloud/models/txt_save_options.rb, line 188 def valid? return false if @quote_type.nil? return false if @separator.nil? return false if @separator_string.nil? return false if @always_quoted.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 true end