Class: GroupDocsConversionCloud::XlsxLoadOptions
- Inherits:
-
Object
- Object
- GroupDocsConversionCloud::XlsxLoadOptions
- Defined in:
- lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb
Overview
Xlsx load options
Instance Attribute Summary collapse
-
#convert_range ⇒ Object
Convert specific range when converting to other than cells format.
-
#default_font ⇒ Object
Default font for Cells document.
-
#font_substitutes ⇒ Object
Substitute specific fonts when converting Cells document.
-
#format ⇒ Object
The format of input file, ("docx", for example).
-
#hide_comments ⇒ Object
Hide comments.
-
#one_page_per_sheet ⇒ Object
If OnePagePerSheet is true the content of the sheet will be converted to one page in the PDF document.
-
#password ⇒ Object
Set password to unprotect protected document.
-
#show_grid_lines ⇒ Object
Show grid lines when converting Excel files.
-
#show_hidden_sheets ⇒ Object
Show hidden sheets when converting Excel files.
-
#skip_empty_rows_and_columns ⇒ Object
Skips empty rows and columns when converting.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ XlsxLoadOptions
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#uncap(str) ⇒ Object
Downcases first letter.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ XlsxLoadOptions
Initializes the object
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 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 98 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?(:'DefaultFont') self.default_font = attributes[:'DefaultFont'] end if attributes.key?(:'FontSubstitutes') if (value = attributes[:'FontSubstitutes']).is_a?(Hash) self.font_substitutes = value end end if attributes.key?(:'ShowGridLines') self.show_grid_lines = attributes[:'ShowGridLines'] end if attributes.key?(:'ShowHiddenSheets') self.show_hidden_sheets = attributes[:'ShowHiddenSheets'] end if attributes.key?(:'OnePagePerSheet') self.one_page_per_sheet = attributes[:'OnePagePerSheet'] end if attributes.key?(:'ConvertRange') self.convert_range = attributes[:'ConvertRange'] end if attributes.key?(:'SkipEmptyRowsAndColumns') self.skip_empty_rows_and_columns = attributes[:'SkipEmptyRowsAndColumns'] end if attributes.key?(:'Password') self.password = attributes[:'Password'] end if attributes.key?(:'HideComments') self.hide_comments = attributes[:'HideComments'] end end |
Instance Attribute Details
#convert_range ⇒ Object
Convert specific range when converting to other than cells format. Example: "D1:F8"
53 54 55 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 53 def convert_range @convert_range end |
#default_font ⇒ Object
Default font for Cells document. The following font will be used if a font is missing.
38 39 40 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 38 def default_font @default_font end |
#font_substitutes ⇒ Object
Substitute specific fonts when converting Cells document.
41 42 43 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 41 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/xlsx_load_options.rb', line 35 def format @format end |
#hide_comments ⇒ Object
Hide comments
62 63 64 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 62 def hide_comments @hide_comments 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.
50 51 52 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 50 def one_page_per_sheet @one_page_per_sheet end |
#password ⇒ Object
Set password to unprotect protected document
59 60 61 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 59 def password @password end |
#show_grid_lines ⇒ Object
Show grid lines when converting Excel files
44 45 46 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 44 def show_grid_lines @show_grid_lines end |
#show_hidden_sheets ⇒ Object
Show hidden sheets when converting Excel files
47 48 49 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 47 def show_hidden_sheets @show_hidden_sheets end |
#skip_empty_rows_and_columns ⇒ Object
Skips empty rows and columns when converting. Default is True.
56 57 58 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 56 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.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 65 def self.attribute_map { :'format' => :'Format', :'default_font' => :'DefaultFont', :'font_substitutes' => :'FontSubstitutes', :'show_grid_lines' => :'ShowGridLines', :'show_hidden_sheets' => :'ShowHiddenSheets', :'one_page_per_sheet' => :'OnePagePerSheet', :'convert_range' => :'ConvertRange', :'skip_empty_rows_and_columns' => :'SkipEmptyRowsAndColumns', :'password' => :'Password', :'hide_comments' => :'HideComments' } end |
.swagger_types ⇒ Object
Attribute type mapping.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 81 def self.swagger_types { :'format' => :'String', :'default_font' => :'String', :'font_substitutes' => :'Hash<String, String>', :'show_grid_lines' => :'BOOLEAN', :'show_hidden_sheets' => :'BOOLEAN', :'one_page_per_sheet' => :'BOOLEAN', :'convert_range' => :'String', :'skip_empty_rows_and_columns' => :'BOOLEAN', :'password' => :'String', :'hide_comments' => :'BOOLEAN' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 188 def ==(other) return true if self.equal?(other) self.class == other.class && format == other.format && default_font == other.default_font && font_substitutes == other.font_substitutes && show_grid_lines == other.show_grid_lines && show_hidden_sheets == other.show_hidden_sheets && one_page_per_sheet == other.one_page_per_sheet && convert_range == other.convert_range && skip_empty_rows_and_columns == other.skip_empty_rows_and_columns && password == other.password && hide_comments == other.hide_comments end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 280 281 282 283 284 285 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 248 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
315 316 317 318 319 320 321 322 323 324 325 326 327 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 315 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
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 224 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
205 206 207 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 205 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
211 212 213 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 211 def hash [format, default_font, font_substitutes, show_grid_lines, show_hidden_sheets, one_page_per_sheet, convert_range, skip_empty_rows_and_columns, password, hide_comments].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 150 def list_invalid_properties invalid_properties = [] if @show_grid_lines.nil? invalid_properties.push("invalid value for 'show_grid_lines', show_grid_lines 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 @one_page_per_sheet.nil? invalid_properties.push("invalid value for 'one_page_per_sheet', one_page_per_sheet 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 @hide_comments.nil? invalid_properties.push("invalid value for 'hide_comments', hide_comments cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
295 296 297 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 295 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
301 302 303 304 305 306 307 308 309 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 301 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
289 290 291 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 289 def to_s to_hash.to_s end |
#uncap(str) ⇒ Object
Downcases first letter.
217 218 219 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 217 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
177 178 179 180 181 182 183 184 |
# File 'lib/groupdocs_conversion_cloud/models/xlsx_load_options.rb', line 177 def valid? return false if @show_grid_lines.nil? return false if @show_hidden_sheets.nil? return false if @one_page_per_sheet.nil? return false if @skip_empty_rows_and_columns.nil? return false if @hide_comments.nil? return true end |