Class: GroupDocsConversionCloud::TsvLoadOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_conversion_cloud/models/tsv_load_options.rb

Overview

Tsv load options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TsvLoadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 179

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

  if attributes.key?(:'ClearCustomDocumentProperties')
    self.clear_custom_document_properties = attributes[:'ClearCustomDocumentProperties']
  end

  if attributes.key?(:'ClearBuiltInDocumentProperties')
    self.clear_built_in_document_properties = attributes[:'ClearBuiltInDocumentProperties']
  end

  if attributes.key?(:'RowsPerPage')
    self.rows_per_page = attributes[:'RowsPerPage']
  end

  if attributes.key?(:'ColumnsPerPage')
    self.columns_per_page = attributes[:'ColumnsPerPage']
  end

  if attributes.key?(:'AutoFitRows')
    self.auto_fit_rows = attributes[:'AutoFitRows']
  end

  if attributes.key?(:'AllColumnsInOnePagePerSheet')
    self.all_columns_in_one_page_per_sheet = attributes[:'AllColumnsInOnePagePerSheet']
  end

  if attributes.key?(:'CultureInfo')
    self.culture_info = attributes[:'CultureInfo']
  end

  if attributes.key?(:'CheckExcelRestriction')
    self.check_excel_restriction = attributes[:'CheckExcelRestriction']
  end

  if attributes.key?(:'Password')
    self.password = attributes[:'Password']
  end

  if attributes.key?(:'SkipEmptyRowsAndColumns')
    self.skip_empty_rows_and_columns = attributes[:'SkipEmptyRowsAndColumns']
  end

  if attributes.key?(:'ConvertRange')
    self.convert_range = attributes[:'ConvertRange']
  end

  if attributes.key?(:'OptimizePdfSize')
    self.optimize_pdf_size = attributes[:'OptimizePdfSize']
  end

  if attributes.key?(:'OnePagePerSheet')
    self.one_page_per_sheet = attributes[:'OnePagePerSheet']
  end

  if attributes.key?(:'ShowHiddenSheets')
    self.show_hidden_sheets = attributes[:'ShowHiddenSheets']
  end

  if attributes.key?(:'ShowGridLines')
    self.show_grid_lines = attributes[:'ShowGridLines']
  end

  if attributes.key?(:'FontSubstitutes')
    if (value = attributes[:'FontSubstitutes']).is_a?(Hash)
      self.font_substitutes = value
    end
  end

  if attributes.key?(:'DefaultFont')
    self.default_font = attributes[:'DefaultFont']
  end

  if attributes.key?(:'SheetIndexes')
    if (value = attributes[:'SheetIndexes']).is_a?(Array)
      self.sheet_indexes = value
    end
  end

  if attributes.key?(:'Sheets')
    if (value = attributes[:'Sheets']).is_a?(Array)
      self.sheets = value
    end
  end

  if attributes.key?(:'PrintComments')
    self.print_comments = attributes[:'PrintComments']
  end

  if attributes.key?(:'ResetFontFolders')
    self.reset_font_folders = attributes[:'ResetFontFolders']
  end

end

Instance Attribute Details

#all_columns_in_one_page_per_sheet ⇒ Object

If AllColumnsInOnePagePerSheet is true, all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.



53
54
55
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 53

def all_columns_in_one_page_per_sheet
  @all_columns_in_one_page_per_sheet
end

#auto_fit_rows ⇒ Object

Autofits all rows when converting



50
51
52
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 50

def auto_fit_rows
  @auto_fit_rows
end

#check_excel_restriction ⇒ Object

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell’s value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.



59
60
61
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 59

def check_excel_restriction
  @check_excel_restriction
end

#clear_built_in_document_properties ⇒ Object

Clear built-in document properties. Default is false.



41
42
43
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 41

def clear_built_in_document_properties
  @clear_built_in_document_properties
end

#clear_custom_document_properties ⇒ Object

Clear custom document properties. Default is false.



38
39
40
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 38

def clear_custom_document_properties
  @clear_custom_document_properties
end

#columns_per_page ⇒ Object

Split a worksheet into pages by columns. Default is 0, no pagination.



47
48
49
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 47

def columns_per_page
  @columns_per_page
end

#convert_range ⇒ Object

Convert specific range when converting to other than cells format. Example: "D1:F8"



68
69
70
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 68

def convert_range
  @convert_range
end

#culture_info ⇒ Object

System culture info at the time file is loaded



56
57
58
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 56

def culture_info
  @culture_info
end

#default_font ⇒ Object

Default font for Cells document. The following font will be used if a font is missing.



86
87
88
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 86

def default_font
  @default_font
end

#font_substitutes ⇒ Object

Substitute specific fonts when converting Cells document.



83
84
85
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 83

def font_substitutes
  @font_substitutes
end

#format ⇒ Object

The format of input file, ("docx", for example). This field must be filled with correct input file format when using ConvertDirect method, which accept input file as binary stream, and, because of that, API can correctly handle LoadOptions. In regular conversion, the input file format taken from the input file name and this field ignored.



35
36
37
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 35

def format
  @format
end

#one_page_per_sheet ⇒ Object

If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document. Default value is true.



74
75
76
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 74

def one_page_per_sheet
  @one_page_per_sheet
end

#optimize_pdf_size ⇒ Object

If True and converting to Pdf the conversion is optimized for better file size than print quality.



71
72
73
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 71

def optimize_pdf_size
  @optimize_pdf_size
end

#password ⇒ Object

Set password to unprotect protected document



62
63
64
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 62

def password
  @password
end

#print_comments ⇒ Object

Represents the way comments are printed with the sheet. Default is PrintNoComments.



95
96
97
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 95

def print_comments
  @print_comments
end

#reset_font_folders ⇒ Object

Reset font folders before loading document



98
99
100
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 98

def reset_font_folders
  @reset_font_folders
end

#rows_per_page ⇒ Object

Split a worksheet into pages by rows. Default is 0, no pagination.



44
45
46
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 44

def rows_per_page
  @rows_per_page
end

#sheet_indexes ⇒ Object

List of sheet indexes to convert. The indexes must be zero-based



89
90
91
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 89

def sheet_indexes
  @sheet_indexes
end

#sheets ⇒ Object

List of sheet names to convert



92
93
94
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 92

def sheets
  @sheets
end

#show_grid_lines ⇒ Object

Show grid lines when converting Excel files



80
81
82
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 80

def show_grid_lines
  @show_grid_lines
end

#show_hidden_sheets ⇒ Object

Show hidden sheets when converting Excel files



77
78
79
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 77

def show_hidden_sheets
  @show_hidden_sheets
end

#skip_empty_rows_and_columns ⇒ Object

Skips empty rows and columns when converting. Default is True.



65
66
67
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 65

def skip_empty_rows_and_columns
  @skip_empty_rows_and_columns
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 122

def self.attribute_map
  {
    :'format' => :'Format',
    :'clear_custom_document_properties' => :'ClearCustomDocumentProperties',
    :'clear_built_in_document_properties' => :'ClearBuiltInDocumentProperties',
    :'rows_per_page' => :'RowsPerPage',
    :'columns_per_page' => :'ColumnsPerPage',
    :'auto_fit_rows' => :'AutoFitRows',
    :'all_columns_in_one_page_per_sheet' => :'AllColumnsInOnePagePerSheet',
    :'culture_info' => :'CultureInfo',
    :'check_excel_restriction' => :'CheckExcelRestriction',
    :'password' => :'Password',
    :'skip_empty_rows_and_columns' => :'SkipEmptyRowsAndColumns',
    :'convert_range' => :'ConvertRange',
    :'optimize_pdf_size' => :'OptimizePdfSize',
    :'one_page_per_sheet' => :'OnePagePerSheet',
    :'show_hidden_sheets' => :'ShowHiddenSheets',
    :'show_grid_lines' => :'ShowGridLines',
    :'font_substitutes' => :'FontSubstitutes',
    :'default_font' => :'DefaultFont',
    :'sheet_indexes' => :'SheetIndexes',
    :'sheets' => :'Sheets',
    :'print_comments' => :'PrintComments',
    :'reset_font_folders' => :'ResetFontFolders'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 150

def self.swagger_types
  {
    :'format' => :'String',
    :'clear_custom_document_properties' => :'BOOLEAN',
    :'clear_built_in_document_properties' => :'BOOLEAN',
    :'rows_per_page' => :'Integer',
    :'columns_per_page' => :'Integer',
    :'auto_fit_rows' => :'BOOLEAN',
    :'all_columns_in_one_page_per_sheet' => :'BOOLEAN',
    :'culture_info' => :'String',
    :'check_excel_restriction' => :'BOOLEAN',
    :'password' => :'String',
    :'skip_empty_rows_and_columns' => :'BOOLEAN',
    :'convert_range' => :'String',
    :'optimize_pdf_size' => :'BOOLEAN',
    :'one_page_per_sheet' => :'BOOLEAN',
    :'show_hidden_sheets' => :'BOOLEAN',
    :'show_grid_lines' => :'BOOLEAN',
    :'font_substitutes' => :'Hash<String, String>',
    :'default_font' => :'String',
    :'sheet_indexes' => :'Array<Integer>',
    :'sheets' => :'Array<String>',
    :'print_comments' => :'String',
    :'reset_font_folders' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 382

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      format == other.format &&
      clear_custom_document_properties == other.clear_custom_document_properties &&
      clear_built_in_document_properties == other.clear_built_in_document_properties &&
      rows_per_page == other.rows_per_page &&
      columns_per_page == other.columns_per_page &&
      auto_fit_rows == other.auto_fit_rows &&
      all_columns_in_one_page_per_sheet == other.all_columns_in_one_page_per_sheet &&
      culture_info == other.culture_info &&
      check_excel_restriction == other.check_excel_restriction &&
      password == other.password &&
      skip_empty_rows_and_columns == other.skip_empty_rows_and_columns &&
      convert_range == other.convert_range &&
      optimize_pdf_size == other.optimize_pdf_size &&
      one_page_per_sheet == other.one_page_per_sheet &&
      show_hidden_sheets == other.show_hidden_sheets &&
      show_grid_lines == other.show_grid_lines &&
      font_substitutes == other.font_substitutes &&
      default_font == other.default_font &&
      sheet_indexes == other.sheet_indexes &&
      sheets == other.sheets &&
      print_comments == other.print_comments &&
      reset_font_folders == other.reset_font_folders
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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 454

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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 = GroupDocsConversionCloud.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



521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 521

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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 430

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


411
412
413
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 411

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



417
418
419
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 417

def hash
  [format, clear_custom_document_properties, clear_built_in_document_properties, rows_per_page, columns_per_page, auto_fit_rows, all_columns_in_one_page_per_sheet, culture_info, check_excel_restriction, password, skip_empty_rows_and_columns, convert_range, optimize_pdf_size, one_page_per_sheet, show_hidden_sheets, show_grid_lines, font_substitutes, default_font, sheet_indexes, sheets, print_comments, reset_font_folders].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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 283

def list_invalid_properties
  invalid_properties = []
  if @clear_custom_document_properties.nil?
    invalid_properties.push("invalid value for 'clear_custom_document_properties', clear_custom_document_properties cannot be nil.")
  end

  if @clear_built_in_document_properties.nil?
    invalid_properties.push("invalid value for 'clear_built_in_document_properties', clear_built_in_document_properties cannot be nil.")
  end

  if @rows_per_page.nil?
    invalid_properties.push("invalid value for 'rows_per_page', rows_per_page cannot be nil.")
  end

  if @columns_per_page.nil?
    invalid_properties.push("invalid value for 'columns_per_page', columns_per_page cannot be nil.")
  end

  if @auto_fit_rows.nil?
    invalid_properties.push("invalid value for 'auto_fit_rows', auto_fit_rows cannot be nil.")
  end

  if @all_columns_in_one_page_per_sheet.nil?
    invalid_properties.push("invalid value for 'all_columns_in_one_page_per_sheet', all_columns_in_one_page_per_sheet 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 @skip_empty_rows_and_columns.nil?
    invalid_properties.push("invalid value for 'skip_empty_rows_and_columns', skip_empty_rows_and_columns cannot be nil.")
  end

  if @optimize_pdf_size.nil?
    invalid_properties.push("invalid value for 'optimize_pdf_size', optimize_pdf_size cannot be nil.")
  end

  if @one_page_per_sheet.nil?
    invalid_properties.push("invalid value for 'one_page_per_sheet', one_page_per_sheet cannot be nil.")
  end

  if @show_hidden_sheets.nil?
    invalid_properties.push("invalid value for 'show_hidden_sheets', show_hidden_sheets cannot be nil.")
  end

  if @show_grid_lines.nil?
    invalid_properties.push("invalid value for 'show_grid_lines', show_grid_lines cannot be nil.")
  end

  if @print_comments.nil?
    invalid_properties.push("invalid value for 'print_comments', print_comments cannot be nil.")
  end

  if @reset_font_folders.nil?
    invalid_properties.push("invalid value for 'reset_font_folders', reset_font_folders cannot be nil.")
  end

  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



501
502
503
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 501

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



507
508
509
510
511
512
513
514
515
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 507

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



495
496
497
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 495

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



423
424
425
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 423

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/groupdocs_conversion_cloud/models/tsv_load_options.rb', line 346

def valid?
  return false if @clear_custom_document_properties.nil?
  return false if @clear_built_in_document_properties.nil?
  return false if @rows_per_page.nil?
  return false if @columns_per_page.nil?
  return false if @auto_fit_rows.nil?
  return false if @all_columns_in_one_page_per_sheet.nil?
  return false if @check_excel_restriction.nil?
  return false if @skip_empty_rows_and_columns.nil?
  return false if @optimize_pdf_size.nil?
  return false if @one_page_per_sheet.nil?
  return false if @show_hidden_sheets.nil?
  return false if @show_grid_lines.nil?
  return false if @print_comments.nil?
  print_comments_validator = EnumAttributeValidator.new('String', ["PrintInPlace", "PrintNoComments", "PrintSheetEnd", "PrintWithThreadedComments"])
  return false unless print_comments_validator.valid?(@print_comments)
  return false if @reset_font_folders.nil?
  return true
end