Class: AsposeSlidesCloud::XpsExportOptions

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

Overview

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

Instance Attribute Summary collapse

Attributes inherited from ExportOptions

#default_regular_font, #font_fallback_rules, #font_subst_rules, #format

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ XpsExportOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 57

def initialize(attributes = {})
  super

  if attributes.has_key?(:'ShowHiddenSlides')
    self.show_hidden_slides = attributes[:'ShowHiddenSlides']
  end

  if attributes.has_key?(:'SaveMetafilesAsPng')
    self.save_metafiles_as_png = attributes[:'SaveMetafilesAsPng']
  end

  if attributes.has_key?(:'DrawSlidesFrame')
    self.draw_slides_frame = attributes[:'DrawSlidesFrame']
  end
  self.format = 'xps'
end

Instance Attribute Details

#draw_slides_frame ⇒ Object

True to draw black frame around each slide.



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

def draw_slides_frame
  @draw_slides_frame
end

#save_metafiles_as_png ⇒ Object

True to convert all metafiles used in a presentation to the PNG images.



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

def save_metafiles_as_png
  @save_metafiles_as_png
end

#show_hidden_slides ⇒ Object

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



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

def show_hidden_slides
  @show_hidden_slides
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 38

def self.attribute_map
  super.merge({
    :'show_hidden_slides' => :'ShowHiddenSlides',
    :'save_metafiles_as_png' => :'SaveMetafilesAsPng',
    :'draw_slides_frame' => :'DrawSlidesFrame',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 47

def self.swagger_types
  super.merge({
    :'show_hidden_slides' => :'BOOLEAN',
    :'save_metafiles_as_png' => :'BOOLEAN',
    :'draw_slides_frame' => :'BOOLEAN',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 90

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_regular_font == o.default_regular_font &&
      font_fallback_rules == o.font_fallback_rules &&
      font_subst_rules == o.font_subst_rules &&
      format == o.format &&
      show_hidden_slides == o.show_hidden_slides &&
      save_metafiles_as_png == o.save_metafiles_as_png &&
      draw_slides_frame == o.draw_slides_frame
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 150

def _deserialize(type, value)
  if value.nil?
    nil
  else
    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
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 224

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 117

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


104
105
106
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 104

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



110
111
112
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 110

def hash
  [default_regular_font, font_fallback_rules, font_subst_rules, format, show_hidden_slides, save_metafiles_as_png, draw_slides_frame].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



76
77
78
79
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 76

def list_invalid_properties
  invalid_properties = super
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 204

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



210
211
212
213
214
215
216
217
218
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 210

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



198
199
200
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 198

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



83
84
85
86
 
# File 'lib/aspose_slides_cloud/models/xps_export_options.rb', line 83

def valid?
  return false if !super
  true
end