Class: AsposeSlidesCloud::MarkdownExportOptions

Inherits:
ExportOptions show all
Defined in:
lib/aspose_slides_cloud/models/markdown_export_options.rb

Overview

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

Instance Attribute Summary collapse

Attributes inherited from ExportOptions

#default_regular_font, #font_fallback_rules, #font_subst_rules, #format, #gradient_style

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ MarkdownExportOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# 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

Instance Attribute Details

#export_type ⇒ Object

Specifies markdown specification to convert presentation. Default is TextOnly.



29
30
31
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 29

def export_type
  @export_type
end

#flavor ⇒ Object

Specifies markdown specification to convert presentation. Default is MultiMarkdown.



32
33
34
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 32

def flavor
  @flavor
end

#images_save_folder_name ⇒ Object

Specifies folder name to save images. Default is Images.



38
39
40
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 38

def images_save_folder_name
  @images_save_folder_name
end

#new_line_type ⇒ Object

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



35
36
37
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 35

def new_line_type
  @new_line_type
end

#show_comments ⇒ Object

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



44
45
46
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 44

def show_comments
  @show_comments
end

#show_hidden_slides ⇒ Object

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



47
48
49
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 47

def show_hidden_slides
  @show_hidden_slides
end

#show_slide_number ⇒ Object

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



41
42
43
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 41

def show_slide_number
  @show_slide_number
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



187
188
189
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



112
113
114
115
 
# File 'lib/aspose_slides_cloud/models/markdown_export_options.rb', line 112

def list_invalid_properties
  invalid_properties = super
  invalid_properties
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



119
120
121
122
123
124
125
126
127
128
 
# 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