Class: AsposeCellsCloud::TxtSaveOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/txt_save_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TxtSaveOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 95

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?(:'EnableHTTPCompression')
    self.enable_http_compression = attributes[:'EnableHTTPCompression']
  end

  if attributes.has_key?(:'SaveFormat')
    self.save_format = attributes[:'SaveFormat']
  end

  if attributes.has_key?(:'ClearData')
    self.clear_data = attributes[:'ClearData']
  end

  if attributes.has_key?(:'CachedFileFolder')
    self.cached_file_folder = attributes[:'CachedFileFolder']
  end

  if attributes.has_key?(:'ValidateMergedAreas')
    self.validate_merged_areas = attributes[:'ValidateMergedAreas']
  end

  if attributes.has_key?(:'RefreshChartCache')
    self.refresh_chart_cache = attributes[:'RefreshChartCache']
  end

  if attributes.has_key?(:'CreateDirectory')
    self.create_directory = attributes[:'CreateDirectory']
  end

  if attributes.has_key?(:'SortNames')
    self.sort_names = attributes[:'SortNames']
  end

  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

end

Instance Attribute Details

#always_quoted ⇒ Object

Returns the value of attribute always_quoted.



54
55
56
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 54

def always_quoted
  @always_quoted
end

#cached_file_folder ⇒ Object

The cached file folder is used to store some large data.



36
37
38
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 36

def cached_file_folder
  @cached_file_folder
end

#clear_data ⇒ Object

Make the workbook empty after saving the file.



33
34
35
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 33

def clear_data
  @clear_data
end

#create_directory ⇒ Object

If true and the directory does not exist, the directory will be automatically created before saving the file.



44
45
46
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 44

def create_directory
  @create_directory
end

#enable_http_compression ⇒ Object

Returns the value of attribute enable_http_compression.



28
29
30
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 28

def enable_http_compression
  @enable_http_compression
end

#quote_type ⇒ Object

Returns the value of attribute quote_type.



48
49
50
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 48

def quote_type
  @quote_type
end

#refresh_chart_cache ⇒ Object

Returns the value of attribute refresh_chart_cache.



41
42
43
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 41

def refresh_chart_cache
  @refresh_chart_cache
end

#save_format ⇒ Object

Returns the value of attribute save_format.



30
31
32
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 30

def save_format
  @save_format
end

#separator ⇒ Object

Returns the value of attribute separator.



50
51
52
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 50

def separator
  @separator
end

#separator_string ⇒ Object

Returns the value of attribute separator_string.



52
53
54
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 52

def separator_string
  @separator_string
end

#sort_names ⇒ Object

Returns the value of attribute sort_names.



46
47
48
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 46

def sort_names
  @sort_names
end

#validate_merged_areas ⇒ Object

Indicates whether validate merged areas before saving the file. The default value is false.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 39

def validate_merged_areas
  @validate_merged_areas
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 58

def self.attribute_map
  {
    :'enable_http_compression' => :'EnableHTTPCompression',
    :'save_format' => :'SaveFormat',
    :'clear_data' => :'ClearData',
    :'cached_file_folder' => :'CachedFileFolder',
    :'validate_merged_areas' => :'ValidateMergedAreas',
    :'refresh_chart_cache' => :'RefreshChartCache',
    :'create_directory' => :'CreateDirectory',
    :'sort_names' => :'SortNames',
    :'quote_type' => :'QuoteType',
    :'separator' => :'Separator',
    :'separator_string' => :'SeparatorString',
    :'always_quoted' => :'AlwaysQuoted'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 76

def self.swagger_types
  {
    :'enable_http_compression' => :'BOOLEAN',
    :'save_format' => :'String',
    :'clear_data' => :'BOOLEAN',
    :'cached_file_folder' => :'String',
    :'validate_merged_areas' => :'BOOLEAN',
    :'refresh_chart_cache' => :'BOOLEAN',
    :'create_directory' => :'BOOLEAN',
    :'sort_names' => :'BOOLEAN',
    :'quote_type' => :'String',
    :'separator' => :'String',
    :'separator_string' => :'String',
    :'always_quoted' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enable_http_compression == o.enable_http_compression &&
      save_format == o.save_format &&
      clear_data == o.clear_data &&
      cached_file_folder == o.cached_file_folder &&
      validate_merged_areas == o.validate_merged_areas &&
      refresh_chart_cache == o.refresh_chart_cache &&
      create_directory == o.create_directory &&
      sort_names == o.sort_names &&
      quote_type == o.quote_type &&
      separator == o.separator &&
      separator_string == o.separator_string &&
      always_quoted == o.always_quoted
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 219

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 285

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 198

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 191

def hash
  [enable_http_compression, save_format, clear_data, cached_file_folder, validate_merged_areas, refresh_chart_cache, create_directory, sort_names, quote_type, separator, separator_string, always_quoted].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



153
154
155
156
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 265

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 271

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



259
260
261
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 259

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



160
161
162
 
# File 'lib/aspose_cells_cloud/models/txt_save_options.rb', line 160

def valid?
  return true
end