class AsposeSlidesCloud::MarkdownExportOptions

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

Attributes

export_type[RW]

Specifies markdown specification to convert presentation. Default is TextOnly.

flavor[RW]

Specifies markdown specification to convert presentation. Default is MultiMarkdown.

images_save_folder_name[RW]

Specifies folder name to save images. Default is Images.

new_line_type[RW]

Specifies whether the generated document should have new lines of \\r(Macintosh), \\n(Unix) or \\r\\n(Windows). Default is Unix.

show_comments[RW]

Specifies whether the generated document should include comments. Default is false.

show_hidden_slides[RW]

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

show_slide_number[RW]

Specifies whether the generated document should include slide number. Default is false.

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/markdown_export_options.rb, line 50
def self.attribute_map
  super.merge({
    :'export_type' => :'ExportType',
    :'flavor' => :'Flavor',
    :'new_line_type' => :'NewLineType',
    :'images_save_folder_name' => :'ImagesSaveFolderName',
    :'show_slide_number' => :'ShowSlideNumber',
    :'show_comments' => :'ShowComments',
    :'show_hidden_slides' => :'ShowHiddenSlides',
  })
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/markdown_export_options.rb, line 77
def initialize(attributes = {})
  super

  if attributes.has_key?(:'ExportType')
    self.export_type = attributes[:'ExportType']
  end

  if attributes.has_key?(:'Flavor')
    self.flavor = attributes[:'Flavor']
  end

  if attributes.has_key?(:'NewLineType')
    self.new_line_type = attributes[:'NewLineType']
  end

  if attributes.has_key?(:'ImagesSaveFolderName')
    self.images_save_folder_name = attributes[:'ImagesSaveFolderName']
  end

  if attributes.has_key?(:'ShowSlideNumber')
    self.show_slide_number = attributes[:'ShowSlideNumber']
  end

  if attributes.has_key?(:'ShowComments')
    self.show_comments = attributes[:'ShowComments']
  end

  if attributes.has_key?(:'ShowHiddenSlides')
    self.show_hidden_slides = attributes[:'ShowHiddenSlides']
  end
  self.format = 'md'
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/markdown_export_options.rb, line 63
def self.swagger_types
  super.merge({
    :'export_type' => :'String',
    :'flavor' => :'String',
    :'new_line_type' => :'String',
    :'images_save_folder_name' => :'String',
    :'show_slide_number' => :'BOOLEAN',
    :'show_comments' => :'BOOLEAN',
    :'show_hidden_slides' => :'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/markdown_export_options.rb, line 162
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 &&
      export_type == o.export_type &&
      flavor == o.flavor &&
      new_line_type == o.new_line_type &&
      images_save_folder_name == o.images_save_folder_name &&
      show_slide_number == o.show_slide_number &&
      show_comments == o.show_comments &&
      show_hidden_slides == o.show_hidden_slides
end
eql?(o) click to toggle source

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

# File lib/aspose_slides_cloud/models/markdown_export_options.rb, line 181
def eql?(o)
  self == o
end
export_type=(export_type) click to toggle source

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

# File lib/aspose_slides_cloud/models/markdown_export_options.rb, line 132
def export_type=(export_type)
  validator = EnumAttributeValidator.new('String', ['Sequential', 'TextOnly', 'Visual'])
  unless validator.valid?(export_type)
    fail ArgumentError, 'invalid value for "export_type", must be one of #{validator.allowable_values}.'
  end
  @export_type = export_type
end
flavor=(flavor) click to toggle source

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

# File lib/aspose_slides_cloud/models/markdown_export_options.rb, line 142
def flavor=(flavor)
  validator = EnumAttributeValidator.new('String', ['Github', 'Gruber', 'MultiMarkdown', 'CommonMark', 'MarkdownExtra', 'Pandoc', 'Kramdown', 'Markua', 'Maruku', 'Markdown2', 'Remarkable', 'Showdown', 'Ghost', 'GitLab', 'Haroopad', 'IaWriter', 'Redcarpet', 'ScholarlyMarkdown', 'Taiga', 'Trello', 'S9ETextFormatter', 'XWiki', 'StackOverflow', 'Default'])
  unless validator.valid?(flavor)
    fail ArgumentError, 'invalid value for "flavor", must be one of #{validator.allowable_values}.'
  end
  @flavor = flavor
end
hash() click to toggle source

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

# File lib/aspose_slides_cloud/models/markdown_export_options.rb, line 187
def hash
  [default_regular_font, gradient_style, font_fallback_rules, font_subst_rules, format, export_type, flavor, new_line_type, images_save_folder_name, show_slide_number, show_comments, show_hidden_slides].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/markdown_export_options.rb, line 112
def list_invalid_properties
  invalid_properties = super
  invalid_properties
end
new_line_type=(new_line_type) click to toggle source

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

# File lib/aspose_slides_cloud/models/markdown_export_options.rb, line 152
def new_line_type=(new_line_type)
  validator = EnumAttributeValidator.new('String', ['Windows', 'Unix', 'Mac'])
  unless validator.valid?(new_line_type)
    fail ArgumentError, 'invalid value for "new_line_type", must be one of #{validator.allowable_values}.'
  end
  @new_line_type = new_line_type
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/markdown_export_options.rb, line 119
def valid?
  return false if !super
  export_type_validator = EnumAttributeValidator.new('String', ['Sequential', 'TextOnly', 'Visual'])
  return false unless export_type_validator.valid?(@export_type)
  flavor_validator = EnumAttributeValidator.new('String', ['Github', 'Gruber', 'MultiMarkdown', 'CommonMark', 'MarkdownExtra', 'Pandoc', 'Kramdown', 'Markua', 'Maruku', 'Markdown2', 'Remarkable', 'Showdown', 'Ghost', 'GitLab', 'Haroopad', 'IaWriter', 'Redcarpet', 'ScholarlyMarkdown', 'Taiga', 'Trello', 'S9ETextFormatter', 'XWiki', 'StackOverflow', 'Default'])
  return false unless flavor_validator.valid?(@flavor)
  new_line_type_validator = EnumAttributeValidator.new('String', ['Windows', 'Unix', 'Mac'])
  return false unless new_line_type_validator.valid?(@new_line_type)
  true
end