Class: AsposeSlidesCloud::HtmlExportOptions
- Inherits:
-
ExportOptions
- Object
- ExportOptions
- AsposeSlidesCloud::HtmlExportOptions
- Defined in:
- lib/aspose_slides_cloud/models/html_export_options.rb
Overview
Provides options that control how a presentation is saved in Html format.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#comments_area_color ⇒ Object
Gets or sets the color of comments area (Applies only if comments are displayed on the right).
-
#comments_area_width ⇒ Object
Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).
-
#comments_position ⇒ Object
Gets or sets the position of the comments on the page.
-
#delete_pictures_cropped_areas ⇒ Object
A boolean flag indicates if the cropped parts remain as part of the document.
-
#jpeg_quality ⇒ Object
Returns or sets a value determining the quality of the JPEG images inside PDF document.
-
#notes_position ⇒ Object
Gets or sets the position of the notes on the page.
-
#pictures_compression ⇒ Object
Represents the pictures compression level.
-
#save_as_zip ⇒ Object
Get or sets flag for save presentation as zip file.
-
#show_comments_by_no_author ⇒ Object
True if comments that have no author are displayed.
-
#show_hidden_slides ⇒ Object
Specifies whether the generated document should include hidden slides or not.
-
#sub_directory_name ⇒ Object
Get or set name of subdirectory in zip-file for store external files.
-
#svg_responsive_layout ⇒ Object
True to make layout responsive by excluding width and height attributes from svg container.
Attributes inherited from ExportOptions
#default_regular_font, #format
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
-
#==(o) ⇒ 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?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ HtmlExportOptions
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.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ HtmlExportOptions
Initializes the object
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 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/aspose_slides_cloud/models/html_export_options.rb', line 124 def initialize(attributes = {}) super if attributes.has_key?(:'SaveAsZip') self.save_as_zip = attributes[:'SaveAsZip'] end if attributes.has_key?(:'SubDirectoryName') self.sub_directory_name = attributes[:'SubDirectoryName'] end if attributes.has_key?(:'ShowHiddenSlides') self. = attributes[:'ShowHiddenSlides'] end if attributes.has_key?(:'SvgResponsiveLayout') self.svg_responsive_layout = attributes[:'SvgResponsiveLayout'] end if attributes.has_key?(:'JpegQuality') self.jpeg_quality = attributes[:'JpegQuality'] end if attributes.has_key?(:'PicturesCompression') self.pictures_compression = attributes[:'PicturesCompression'] end if attributes.has_key?(:'DeletePicturesCroppedAreas') self.delete_pictures_cropped_areas = attributes[:'DeletePicturesCroppedAreas'] end if attributes.has_key?(:'NotesPosition') self.notes_position = attributes[:'NotesPosition'] end if attributes.has_key?(:'CommentsPosition') self.comments_position = attributes[:'CommentsPosition'] end if attributes.has_key?(:'CommentsAreaWidth') self.comments_area_width = attributes[:'CommentsAreaWidth'] end if attributes.has_key?(:'CommentsAreaColor') self.comments_area_color = attributes[:'CommentsAreaColor'] end if attributes.has_key?(:'ShowCommentsByNoAuthor') self. = attributes[:'ShowCommentsByNoAuthor'] end self.format = "html" end |
Instance Attribute Details
#comments_area_color ⇒ Object
Gets or sets the color of comments area (Applies only if comments are displayed on the right).
59 60 61 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 59 def comments_area_color @comments_area_color end |
#comments_area_width ⇒ Object
Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).
56 57 58 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 56 def comments_area_width @comments_area_width end |
#comments_position ⇒ Object
Gets or sets the position of the comments on the page.
53 54 55 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 53 def comments_position @comments_position end |
#delete_pictures_cropped_areas ⇒ Object
A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file)
47 48 49 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 47 def delete_pictures_cropped_areas @delete_pictures_cropped_areas end |
#jpeg_quality ⇒ Object
Returns or sets a value determining the quality of the JPEG images inside PDF document.
41 42 43 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 41 def jpeg_quality @jpeg_quality end |
#notes_position ⇒ Object
Gets or sets the position of the notes on the page.
50 51 52 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 50 def notes_position @notes_position end |
#pictures_compression ⇒ Object
Represents the pictures compression level
44 45 46 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 44 def pictures_compression @pictures_compression end |
#save_as_zip ⇒ Object
Get or sets flag for save presentation as zip file
29 30 31 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 29 def save_as_zip @save_as_zip end |
#show_comments_by_no_author ⇒ Object
True if comments that have no author are displayed. (Applies only if comments are displayed).
62 63 64 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 62 def @show_comments_by_no_author end |
#show_hidden_slides ⇒ Object
Specifies whether the generated document should include hidden slides or not. Default is false.
35 36 37 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 35 def @show_hidden_slides end |
#sub_directory_name ⇒ Object
Get or set name of subdirectory in zip-file for store external files
32 33 34 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 32 def sub_directory_name @sub_directory_name end |
#svg_responsive_layout ⇒ Object
True to make layout responsive by excluding width and height attributes from svg container.
38 39 40 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 38 def svg_responsive_layout @svg_responsive_layout end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 87 def self.attribute_map super.merge({ :'save_as_zip' => :'SaveAsZip', :'sub_directory_name' => :'SubDirectoryName', :'show_hidden_slides' => :'ShowHiddenSlides', :'svg_responsive_layout' => :'SvgResponsiveLayout', :'jpeg_quality' => :'JpegQuality', :'pictures_compression' => :'PicturesCompression', :'delete_pictures_cropped_areas' => :'DeletePicturesCroppedAreas', :'notes_position' => :'NotesPosition', :'comments_position' => :'CommentsPosition', :'comments_area_width' => :'CommentsAreaWidth', :'comments_area_color' => :'CommentsAreaColor', :'show_comments_by_no_author' => :'ShowCommentsByNoAuthor', }) end |
.swagger_types ⇒ Object
Attribute type mapping.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 105 def self.swagger_types super.merge({ :'save_as_zip' => :'BOOLEAN', :'sub_directory_name' => :'String', :'show_hidden_slides' => :'BOOLEAN', :'svg_responsive_layout' => :'BOOLEAN', :'jpeg_quality' => :'Integer', :'pictures_compression' => :'String', :'delete_pictures_cropped_areas' => :'BOOLEAN', :'notes_position' => :'String', :'comments_position' => :'String', :'comments_area_width' => :'Integer', :'comments_area_color' => :'String', :'show_comments_by_no_author' => :'BOOLEAN', }) end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 274 def ==(o) return true if self.equal?(o) self.class == o.class && default_regular_font == o.default_regular_font && format == o.format && save_as_zip == o.save_as_zip && sub_directory_name == o.sub_directory_name && == o. && svg_responsive_layout == o.svg_responsive_layout && jpeg_quality == o.jpeg_quality && pictures_compression == o.pictures_compression && delete_pictures_cropped_areas == o.delete_pictures_cropped_areas && notes_position == o.notes_position && comments_position == o.comments_position && comments_area_width == o.comments_area_width && comments_area_color == o.comments_area_color && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 341 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 = AsposeSlidesCloud.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
407 408 409 410 411 412 413 414 415 416 417 418 419 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 407 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
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 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 308 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| mapKey = self.class.attribute_map[key] if !mapKey.nil? val = attributes[mapKey] if val.nil? mapKeyString = mapKey.to_s mapKeyString[0] = mapKeyString[0].downcase mapKey = mapKeyString.to_sym val = attributes[mapKey] end if !val.nil? 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 val.is_a?(Array) self.send("#{key}=", val.map { |v| _deserialize($1, v) }) end else self.send("#{key}=", _deserialize(type, val)) end end end end self end |
#eql?(o) ⇒ Boolean
295 296 297 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 295 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
301 302 303 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 301 def hash [default_regular_font, format, save_as_zip, sub_directory_name, , svg_responsive_layout, jpeg_quality, pictures_compression, delete_pictures_cropped_areas, notes_position, comments_position, comments_area_width, comments_area_color, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 179 def list_invalid_properties invalid_properties = super if @save_as_zip.nil? invalid_properties.push('invalid value for "save_as_zip", save_as_zip cannot be nil.') end if @show_hidden_slides.nil? invalid_properties.push('invalid value for "show_hidden_slides", show_hidden_slides cannot be nil.') end if @svg_responsive_layout.nil? invalid_properties.push('invalid value for "svg_responsive_layout", svg_responsive_layout cannot be nil.') end if @jpeg_quality.nil? invalid_properties.push('invalid value for "jpeg_quality", jpeg_quality cannot be nil.') end if @delete_pictures_cropped_areas.nil? invalid_properties.push('invalid value for "delete_pictures_cropped_areas", delete_pictures_cropped_areas cannot be nil.') end if @notes_position.nil? invalid_properties.push('invalid value for "notes_position", notes_position cannot be nil.') end if @comments_position.nil? invalid_properties.push('invalid value for "comments_position", comments_position cannot be nil.') end if @comments_area_width.nil? invalid_properties.push('invalid value for "comments_area_width", comments_area_width cannot be nil.') end if @show_comments_by_no_author.nil? invalid_properties.push('invalid value for "show_comments_by_no_author", show_comments_by_no_author cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
387 388 389 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 387 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
393 394 395 396 397 398 399 400 401 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 393 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
381 382 383 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 381 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 222 def valid? return false if !super return false if @save_as_zip.nil? return false if @show_hidden_slides.nil? return false if @svg_responsive_layout.nil? return false if @jpeg_quality.nil? pictures_compression_validator = EnumAttributeValidator.new('String', ['Dpi330', 'Dpi220', 'Dpi150', 'Dpi96', 'Dpi72', 'DocumentResolution']) return false unless pictures_compression_validator.valid?(@pictures_compression) return false if @delete_pictures_cropped_areas.nil? return false if @notes_position.nil? notes_position_validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated']) return false unless notes_position_validator.valid?(@notes_position) return false if @comments_position.nil? comments_position_validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right']) return false unless comments_position_validator.valid?(@comments_position) return false if @comments_area_width.nil? return false if @show_comments_by_no_author.nil? true end |