class AsposeSlidesCloud::HtmlExportOptions

Provides options that control how a presentation is saved in Html format.

Attributes

delete_pictures_cropped_areas[RW]

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)

jpeg_quality[RW]

Returns or sets a value determining the quality of the JPEG images inside PDF document.

pictures_compression[RW]

Represents the pictures compression level

save_as_zip[RW]

Get or sets flag for save presentation as zip file

show_hidden_slides[RW]

Specifies whether the generated document should include hidden slides or not. Default is false.

slides_layout_options[RW]

Slides layouting options

sub_directory_name[RW]

Get or set name of subdirectory in zip-file for store external files

svg_responsive_layout[RW]

True to make layout responsive by excluding width and height attributes from svg container.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_slides_cloud/models/html_export_options.rb, line 53
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',
    :'slides_layout_options' => :'SlidesLayoutOptions',
  })
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Calls superclass method AsposeSlidesCloud::ExportOptions::new
# File lib/aspose_slides_cloud/models/html_export_options.rb, line 82
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.show_hidden_slides = 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?(:'SlidesLayoutOptions')
    self.slides_layout_options = attributes[:'SlidesLayoutOptions']
  end
  self.format = 'html'
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/html_export_options.rb, line 67
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',
    :'slides_layout_options' => :'SlidesLayoutOptions',
  })
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/html_export_options.rb, line 147
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_regular_font == o.default_regular_font &&
      gradient_style == o.gradient_style &&
      font_fallback_rules == o.font_fallback_rules &&
      font_subst_rules == o.font_subst_rules &&
      format == o.format &&
      save_as_zip == o.save_as_zip &&
      sub_directory_name == o.sub_directory_name &&
      show_hidden_slides == o.show_hidden_slides &&
      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 &&
      slides_layout_options == o.slides_layout_options
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/html_export_options.rb, line 167
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_slides_cloud/models/html_export_options.rb, line 173
def hash
  [default_regular_font, gradient_style, font_fallback_rules, font_subst_rules, format, save_as_zip, sub_directory_name, show_hidden_slides, svg_responsive_layout, jpeg_quality, pictures_compression, delete_pictures_cropped_areas, slides_layout_options].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aspose_slides_cloud/models/html_export_options.rb, line 121
def list_invalid_properties
  invalid_properties = super
  invalid_properties
end
pictures_compression=(pictures_compression) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] pictures_compression Object to be assigned

# File lib/aspose_slides_cloud/models/html_export_options.rb, line 137
def pictures_compression=(pictures_compression)
  validator = EnumAttributeValidator.new('String', ['Dpi330', 'Dpi220', 'Dpi150', 'Dpi96', 'Dpi72', 'DocumentResolution'])
  unless validator.valid?(pictures_compression)
    fail ArgumentError, 'invalid value for "pictures_compression", must be one of #{validator.allowable_values}.'
  end
  @pictures_compression = pictures_compression
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

Calls superclass method AsposeSlidesCloud::ExportOptions#valid?
# File lib/aspose_slides_cloud/models/html_export_options.rb, line 128
def valid?
  return false if !super
  pictures_compression_validator = EnumAttributeValidator.new('String', ['Dpi330', 'Dpi220', 'Dpi150', 'Dpi96', 'Dpi72', 'DocumentResolution'])
  return false unless pictures_compression_validator.valid?(@pictures_compression)
  true
end