class AsposeSlidesCloud::SwfExportOptions

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

Attributes

comments_area_color[RW]

Gets or sets the color of comments area (Applies only if comments are displayed on the right).

comments_area_width[RW]

Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).

comments_position[RW]

Gets or sets the position of the comments on the page.

compressed[RW]

Specifies whether the generated SWF document should be compressed or not. Default is true.

enable_context_menu[RW]

Enable/disable context menu. Default is true.

jpeg_quality[RW]

Specifies the quality of JPEG images. Default is 95.

logo_image[RW]

Image that will be displayed as logo in the top right corner of the viewer. The image data is a base 64 string. Image should be 32x64 pixels PNG image, otherwise logo can be displayed improperly.

notes_position[RW]

Gets or sets the position of the notes on the page.

show_bottom_pane[RW]

Show/hide bottom pane. Can be overridden in flashvars. Default is true.

show_comments_by_no_author[RW]

True if comments that have no author are displayed. (Applies only if comments are displayed).

show_full_screen[RW]

Show/hide fullscreen button. Can be overridden in flashvars. Default is true.

show_hidden_slides[RW]

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

show_left_pane[RW]

Show/hide left pane. Can be overridden in flashvars. Default is true.

show_page_border[RW]

Specifies whether border around pages should be shown. Default is true.

show_page_stepper[RW]

Show/hide page stepper. Can be overridden in flashvars. Default is true.

show_top_pane[RW]

Show/hide whole top pane. Can be overridden in flashvars. Default is true.

start_open_left_pane[RW]

Start with opened left pane. Can be overridden in flashvars. Default is false.

viewer_included[RW]

Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.

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/swf_export_options.rb, line 89
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
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/swf_export_options.rb, line 142
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/swf_export_options.rb, line 115
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

==(o) click to toggle source

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

# File lib/aspose_slides_cloud/models/swf_export_options.rb, line 267
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 &&
      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
comments_position=(comments_position) click to toggle source

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 257
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
eql?(o) click to toggle source

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

# File lib/aspose_slides_cloud/models/swf_export_options.rb, line 299
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/swf_export_options.rb, line 305
def hash
  [default_regular_font, gradient_style, font_fallback_rules, font_subst_rules, 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
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/swf_export_options.rb, line 229
def list_invalid_properties
  invalid_properties = super
  invalid_properties
end
notes_position=(notes_position) click to toggle source

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 247
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
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/swf_export_options.rb, line 236
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