Class: GroupDocsConversionCloud::DocxConvertOptions
- Inherits:
-
Object
- Object
- GroupDocsConversionCloud::DocxConvertOptions
- Defined in:
- lib/groupdocs_conversion_cloud/models/docx_convert_options.rb
Overview
Docx convert options
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#dpi ⇒ Object
Desired page DPI after conversion.
-
#from_page ⇒ Object
Start conversion from FromPage page.
-
#height ⇒ Object
Desired page height after conversion.
-
#page_orientation ⇒ Object
Specifies page orientation.
-
#page_size ⇒ Object
Page size.
-
#pages ⇒ Object
Convert specific pages.
-
#pages_count ⇒ Object
Number of pages to convert.
-
#password ⇒ Object
Set this property if you want to protect the converted document with a password.
-
#pdf_recognition_mode ⇒ Object
Recognition mode when converting from pdf.
-
#watermark_options ⇒ Object
Watermark specific options.
-
#width ⇒ Object
Desired page width after conversion.
-
#zoom ⇒ Object
Specifies the zoom level in percentage.
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 = {}) ⇒ DocxConvertOptions
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 = {}) ⇒ DocxConvertOptions
Initializes the object
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 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 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 129 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?(:'FromPage') self.from_page = attributes[:'FromPage'] end if attributes.key?(:'PagesCount') self.pages_count = attributes[:'PagesCount'] end if attributes.key?(:'Pages') if (value = attributes[:'Pages']).is_a?(Array) self.pages = value end end if attributes.key?(:'WatermarkOptions') self. = attributes[:'WatermarkOptions'] end if attributes.key?(:'Width') self.width = attributes[:'Width'] end if attributes.key?(:'Height') self.height = attributes[:'Height'] end if attributes.key?(:'Dpi') self.dpi = attributes[:'Dpi'] end if attributes.key?(:'Password') self.password = attributes[:'Password'] end if attributes.key?(:'Zoom') self.zoom = attributes[:'Zoom'] end if attributes.key?(:'PdfRecognitionMode') self.pdf_recognition_mode = attributes[:'PdfRecognitionMode'] end if attributes.key?(:'PageSize') self.page_size = attributes[:'PageSize'] end if attributes.key?(:'PageOrientation') self.page_orientation = attributes[:'PageOrientation'] end end |
Instance Attribute Details
#dpi ⇒ Object
Desired page DPI after conversion. The default resolution is: 96dpi
53 54 55 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 53 def dpi @dpi end |
#from_page ⇒ Object
Start conversion from FromPage page
35 36 37 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 35 def from_page @from_page end |
#height ⇒ Object
Desired page height after conversion
50 51 52 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 50 def height @height end |
#page_orientation ⇒ Object
Specifies page orientation
68 69 70 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 68 def page_orientation @page_orientation end |
#page_size ⇒ Object
Page size
65 66 67 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 65 def page_size @page_size end |
#pages ⇒ Object
Convert specific pages. The list contains the page indexes of the pages to be converted
41 42 43 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 41 def pages @pages end |
#pages_count ⇒ Object
Number of pages to convert
38 39 40 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 38 def pages_count @pages_count end |
#password ⇒ Object
Set this property if you want to protect the converted document with a password
56 57 58 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 56 def password @password end |
#pdf_recognition_mode ⇒ Object
Recognition mode when converting from pdf
62 63 64 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 62 def pdf_recognition_mode @pdf_recognition_mode end |
#watermark_options ⇒ Object
Watermark specific options
44 45 46 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 44 def @watermark_options end |
#width ⇒ Object
Desired page width after conversion
47 48 49 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 47 def width @width end |
#zoom ⇒ Object
Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.
59 60 61 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 59 def zoom @zoom end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 92 def self.attribute_map { :'from_page' => :'FromPage', :'pages_count' => :'PagesCount', :'pages' => :'Pages', :'watermark_options' => :'WatermarkOptions', :'width' => :'Width', :'height' => :'Height', :'dpi' => :'Dpi', :'password' => :'Password', :'zoom' => :'Zoom', :'pdf_recognition_mode' => :'PdfRecognitionMode', :'page_size' => :'PageSize', :'page_orientation' => :'PageOrientation' } end |
.swagger_types ⇒ Object
Attribute type mapping.
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 110 def self.swagger_types { :'from_page' => :'Integer', :'pages_count' => :'Integer', :'pages' => :'Array<Integer>', :'watermark_options' => :'WatermarkOptions', :'width' => :'Integer', :'height' => :'Integer', :'dpi' => :'Integer', :'password' => :'String', :'zoom' => :'Integer', :'pdf_recognition_mode' => :'String', :'page_size' => :'String', :'page_orientation' => :'String' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 295 def ==(other) return true if self.equal?(other) self.class == other.class && from_page == other.from_page && pages_count == other.pages_count && pages == other.pages && == other. && width == other.width && height == other.height && dpi == other.dpi && password == other.password && zoom == other.zoom && pdf_recognition_mode == other.pdf_recognition_mode && page_size == other.page_size && page_orientation == other.page_orientation end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 357 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
424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 424 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
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 333 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
314 315 316 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 314 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
320 321 322 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 320 def hash [from_page, pages_count, pages, , width, height, dpi, password, zoom, pdf_recognition_mode, page_size, page_orientation].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 189 def list_invalid_properties invalid_properties = [] if @from_page.nil? invalid_properties.push("invalid value for 'from_page', from_page cannot be nil.") end if @pages_count.nil? invalid_properties.push("invalid value for 'pages_count', pages_count cannot be nil.") end if @width.nil? invalid_properties.push("invalid value for 'width', width cannot be nil.") end if @height.nil? invalid_properties.push("invalid value for 'height', height cannot be nil.") end if @dpi.nil? invalid_properties.push("invalid value for 'dpi', dpi cannot be nil.") end if @zoom.nil? invalid_properties.push("invalid value for 'zoom', zoom cannot be nil.") end if @pdf_recognition_mode.nil? invalid_properties.push("invalid value for 'pdf_recognition_mode', pdf_recognition_mode cannot be nil.") end if @page_size.nil? invalid_properties.push("invalid value for 'page_size', page_size cannot be nil.") end if @page_orientation.nil? invalid_properties.push("invalid value for 'page_orientation', page_orientation cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
404 405 406 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 404 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
410 411 412 413 414 415 416 417 418 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 410 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
398 399 400 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 398 def to_s to_hash.to_s end |
#uncap(str) ⇒ Object
Downcases first letter.
326 327 328 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 326 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
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/groupdocs_conversion_cloud/models/docx_convert_options.rb', line 232 def valid? return false if @from_page.nil? return false if @pages_count.nil? return false if @width.nil? return false if @height.nil? return false if @dpi.nil? return false if @zoom.nil? return false if @pdf_recognition_mode.nil? pdf_recognition_mode_validator = EnumAttributeValidator.new('String', ["Textbox", "Flow"]) return false unless pdf_recognition_mode_validator.valid?(@pdf_recognition_mode) return false if @page_size.nil? page_size_validator = EnumAttributeValidator.new('String', ["Default", "A3", "Statement", "Quarto", "Paper11x17", "Paper10x14", "Letter", "Legal", "Ledger", "Folio", "Executive", "EnvelopeDL", "Custom", "B5", "B4", "A5", "A4", "Tabloid"]) return false unless page_size_validator.valid?(@page_size) return false if @page_orientation.nil? page_orientation_validator = EnumAttributeValidator.new('String', ["Default", "Landscape", "Portrait"]) return false unless page_orientation_validator.valid?(@page_orientation) return true end |