class AsposeSlidesCloud::SwfExportOptions
Provides options that control how a presentation is saved in SWF 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.
Specifies whether the generated SWF document should be compressed or not. Default is true.
Specifies the quality of JPEG images. Default is 95.
Gets or sets the full hyperlink address for a logo. Has an effect only if a LogoImage is specified.
Gets or sets the position of the notes on the page.
Show/hide bottom pane. Can be overridden in flashvars. Default is true.
Show/hide fullscreen button. Can be overridden in flashvars. Default is true.
Show/hide left pane. Can be overridden in flashvars. Default is true.
Specifies whether border around pages should be shown. Default is true.
Show/hide page stepper. Can be overridden in flashvars. Default is true.
Show/hide search section. Can be overridden in flashvars. Default is true.
Show/hide whole top pane. Can be overridden in flashvars. Default is true.
Start with opened left pane. Can be overridden in flashvars. Default is false.
Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
AsposeSlidesCloud::ExportOptions::attribute_map
# File lib/aspose_slides_cloud/models/swf_export_options.rb, line 111 def self.attribute_map super.merge({ :'show_hidden_slides' => :'ShowHiddenSlides', :'compressed' => :'Compressed', :'viewer_included' => :'ViewerIncluded', :'show_page_border' => :'ShowPageBorder', :'show_full_screen' => :'ShowFullScreen', :'show_page_stepper' => :'ShowPageStepper', :'show_search' => :'ShowSearch', :'show_top_pane' => :'ShowTopPane', :'show_bottom_pane' => :'ShowBottomPane', :'show_left_pane' => :'ShowLeftPane', :'start_open_left_pane' => :'StartOpenLeftPane', :'enable_context_menu' => :'EnableContextMenu', :'logo_image' => :'LogoImage', :'logo_link' => :'LogoLink', :'jpeg_quality' => :'JpegQuality', :'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/swf_export_options.rb, line 164 def initialize(attributes = {}) super if attributes.has_key?(:'ShowHiddenSlides') self.show_hidden_slides = attributes[:'ShowHiddenSlides'] end if attributes.has_key?(:'Compressed') self.compressed = attributes[:'Compressed'] end if attributes.has_key?(:'ViewerIncluded') self.viewer_included = attributes[:'ViewerIncluded'] end if attributes.has_key?(:'ShowPageBorder') self.show_page_border = attributes[:'ShowPageBorder'] end if attributes.has_key?(:'ShowFullScreen') self.show_full_screen = attributes[:'ShowFullScreen'] end if attributes.has_key?(:'ShowPageStepper') self.show_page_stepper = attributes[:'ShowPageStepper'] end if attributes.has_key?(:'ShowSearch') self.show_search = attributes[:'ShowSearch'] end if attributes.has_key?(:'ShowTopPane') self.show_top_pane = attributes[:'ShowTopPane'] end if attributes.has_key?(:'ShowBottomPane') self.show_bottom_pane = attributes[:'ShowBottomPane'] end if attributes.has_key?(:'ShowLeftPane') self.show_left_pane = attributes[:'ShowLeftPane'] end if attributes.has_key?(:'StartOpenLeftPane') self.start_open_left_pane = attributes[:'StartOpenLeftPane'] end if attributes.has_key?(:'EnableContextMenu') self.enable_context_menu = attributes[:'EnableContextMenu'] end if attributes.has_key?(:'LogoImage') self.logo_image = attributes[:'LogoImage'] end if attributes.has_key?(:'LogoLink') self.logo_link = attributes[:'LogoLink'] end if attributes.has_key?(:'JpegQuality') self.jpeg_quality = attributes[:'JpegQuality'] 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 = "swf" end
Attribute type mapping.
AsposeSlidesCloud::ExportOptions::swagger_types
# File lib/aspose_slides_cloud/models/swf_export_options.rb, line 137 def self.swagger_types super.merge({ :'show_hidden_slides' => :'BOOLEAN', :'compressed' => :'BOOLEAN', :'viewer_included' => :'BOOLEAN', :'show_page_border' => :'BOOLEAN', :'show_full_screen' => :'BOOLEAN', :'show_page_stepper' => :'BOOLEAN', :'show_search' => :'BOOLEAN', :'show_top_pane' => :'BOOLEAN', :'show_bottom_pane' => :'BOOLEAN', :'show_left_pane' => :'BOOLEAN', :'start_open_left_pane' => :'BOOLEAN', :'enable_context_menu' => :'BOOLEAN', :'logo_image' => :'String', :'logo_link' => :'String', :'jpeg_quality' => :'Integer', :'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/swf_export_options.rb, line 289 def ==(o) return true if self.equal?(o) self.class == o.class && default_regular_font == o.default_regular_font && height == o.height && width == o.width && format == o.format && show_hidden_slides == o.show_hidden_slides && compressed == o.compressed && viewer_included == o.viewer_included && show_page_border == o.show_page_border && show_full_screen == o.show_full_screen && show_page_stepper == o.show_page_stepper && show_search == o.show_search && show_top_pane == o.show_top_pane && show_bottom_pane == o.show_bottom_pane && show_left_pane == o.show_left_pane && start_open_left_pane == o.start_open_left_pane && enable_context_menu == o.enable_context_menu && logo_image == o.logo_image && logo_link == o.logo_link && jpeg_quality == o.jpeg_quality && 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/swf_export_options.rb, line 366 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 registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value) if registry_type type = registry_type end 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/swf_export_options.rb, line 436 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/swf_export_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| 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/swf_export_options.rb, line 279 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/swf_export_options.rb, line 320 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_slides_cloud/models/swf_export_options.rb, line 326 def hash [default_regular_font, height, width, format, show_hidden_slides, compressed, viewer_included, show_page_border, show_full_screen, show_page_stepper, show_search, show_top_pane, show_bottom_pane, show_left_pane, start_open_left_pane, enable_context_menu, logo_image, logo_link, jpeg_quality, 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/swf_export_options.rb, line 251 def list_invalid_properties invalid_properties = super 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/swf_export_options.rb, line 269 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/aspose_slides_cloud/models/swf_export_options.rb, line 422 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/swf_export_options.rb, line 410 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/swf_export_options.rb, line 258 def valid? return false if !super notes_position_validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated']) return false unless notes_position_validator.valid?(@notes_position) comments_position_validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right']) return false unless comments_position_validator.valid?(@comments_position) true end