class AsposeSlidesCloud::HtmlExportOptions
Provides options that control how a presentation is saved in Html format.
Attributes
Gets or sets the color of comments area (Applies only if comments are displayed on the right).
Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).
Gets or sets the position of the comments on the page.
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)
Returns or sets a value determining the quality of the JPEG images inside PDF document.
Gets or sets the position of the notes on the page.
Represents the pictures compression level
Get or sets flag for save presentation as zip file
Get or set name of subdirectory in zip-file for store external files
True to make layout responsive by excluding width and height attributes from svg container.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
AsposeSlidesCloud::ExportOptions::attribute_map
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
AsposeSlidesCloud::ExportOptions::new
# 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.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?(:'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.show_comments_by_no_author = attributes[:'ShowCommentsByNoAuthor'] end self.format = "html" end
Attribute type mapping.
AsposeSlidesCloud::ExportOptions::swagger_types
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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 && 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 && notes_position == o.notes_position && comments_position == o.comments_position && comments_area_width == o.comments_area_width && comments_area_color == o.comments_area_color && show_comments_by_no_author == o.show_comments_by_no_author end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] comments_position
Object to be assigned
# File lib/aspose_slides_cloud/models/html_export_options.rb, line 264 def comments_position=(comments_position) validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right']) unless validator.valid?(comments_position) fail ArgumentError, 'invalid value for "comments_position", must be one of #{validator.allowable_values}.' end @comments_position = comments_position end
@see the `==` method @param [Object] Object to be compared
# File lib/aspose_slides_cloud/models/html_export_options.rb, line 295 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_slides_cloud/models/html_export_options.rb, line 301 def hash [default_regular_font, format, save_as_zip, sub_directory_name, show_hidden_slides, svg_responsive_layout, jpeg_quality, pictures_compression, delete_pictures_cropped_areas, notes_position, comments_position, comments_area_width, comments_area_color, show_comments_by_no_author].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
AsposeSlidesCloud::ExportOptions#list_invalid_properties
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] notes_position
Object to be assigned
# File lib/aspose_slides_cloud/models/html_export_options.rb, line 254 def notes_position=(notes_position) validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated']) unless validator.valid?(notes_position) fail ArgumentError, 'invalid value for "notes_position", must be one of #{validator.allowable_values}.' end @notes_position = notes_position end
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 244 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose_slides_cloud/models/html_export_options.rb, line 381 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
AsposeSlidesCloud::ExportOptions#valid?
# 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