Class: AsposeSlidesCloud::OleObjectFrame

Inherits:
ShapeBase show all
Defined in:
lib/aspose_slides_cloud/models/ole_object_frame.rb

Overview

Represents OleObjectFrame resource.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ShapeBase

#alternative_text, #alternative_text_title, #effect_format, #fill_format, #height, #hidden, #hyperlink_click, #hyperlink_mouse_over, #line_format, #name, #three_d_format, #type, #width, #x, #y, #z_order_position

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OleObjectFrame

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
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
145
146
147
148
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 109

def initialize(attributes = {})
  super

  if attributes.has_key?(:'IsObjectIcon')
    self.is_object_icon = attributes[:'IsObjectIcon']
  end

  if attributes.has_key?(:'SubstitutePictureTitle')
    self.substitute_picture_title = attributes[:'SubstitutePictureTitle']
  end

  if attributes.has_key?(:'SubstitutePictureFormat')
    self.substitute_picture_format = attributes[:'SubstitutePictureFormat']
  end

  if attributes.has_key?(:'ObjectName')
    self.object_name = attributes[:'ObjectName']
  end

  if attributes.has_key?(:'EmbeddedFileBase64Data')
    self.embedded_file_base64_data = attributes[:'EmbeddedFileBase64Data']
  end

  if attributes.has_key?(:'EmbeddedFileExtension')
    self.embedded_file_extension = attributes[:'EmbeddedFileExtension']
  end

  if attributes.has_key?(:'ObjectProgId')
    self.object_prog_id = attributes[:'ObjectProgId']
  end

  if attributes.has_key?(:'LinkPath')
    self.link_path = attributes[:'LinkPath']
  end

  if attributes.has_key?(:'UpdateAutomatic')
    self.update_automatic = attributes[:'UpdateAutomatic']
  end
  self.type = 'OleObjectFrame'
end

Instance Attribute Details

#embedded_file_base64_data ⇒ Object

File data of embedded OLE object.



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

def embedded_file_base64_data
  @embedded_file_base64_data
end

#embedded_file_extension ⇒ Object

File extension for the current embedded OLE object



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

def embedded_file_extension
  @embedded_file_extension
end

#is_object_icon ⇒ Object

True if an object is visible as icon.



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

def is_object_icon
  @is_object_icon
end

#link_path ⇒ Object

Full path to a linked file.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 50

def link_path
  @link_path
end

#object_name ⇒ Object

Returns or sets the name of an object.



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

def object_name
  @object_name
end

#object_prog_id ⇒ Object

ProgID of an object.



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

def object_prog_id
  @object_prog_id
end

#substitute_picture_format ⇒ Object

OleObject image fill properties.



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

def substitute_picture_format
  @substitute_picture_format
end

#substitute_picture_title ⇒ Object

The title for OleObject icon.



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

def substitute_picture_title
  @substitute_picture_title
end

#update_automatic ⇒ Object

Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Read/write Boolean.



53
54
55
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 53

def update_automatic
  @update_automatic
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 78

def self.attribute_map
  super.merge({
    :'is_object_icon' => :'IsObjectIcon',
    :'substitute_picture_title' => :'SubstitutePictureTitle',
    :'substitute_picture_format' => :'SubstitutePictureFormat',
    :'object_name' => :'ObjectName',
    :'embedded_file_base64_data' => :'EmbeddedFileBase64Data',
    :'embedded_file_extension' => :'EmbeddedFileExtension',
    :'object_prog_id' => :'ObjectProgId',
    :'link_path' => :'LinkPath',
    :'update_automatic' => :'UpdateAutomatic',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 93

def self.swagger_types
  super.merge({
    :'is_object_icon' => :'BOOLEAN',
    :'substitute_picture_title' => :'String',
    :'substitute_picture_format' => :'PictureFill',
    :'object_name' => :'String',
    :'embedded_file_base64_data' => :'String',
    :'embedded_file_extension' => :'String',
    :'object_prog_id' => :'String',
    :'link_path' => :'String',
    :'update_automatic' => :'BOOLEAN',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      name == o.name &&
      width == o.width &&
      height == o.height &&
      alternative_text == o.alternative_text &&
      alternative_text_title == o.alternative_text_title &&
      hidden == o.hidden &&
      x == o.x &&
      y == o.y &&
      z_order_position == o.z_order_position &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      three_d_format == o.three_d_format &&
      line_format == o.line_format &&
      hyperlink_click == o.hyperlink_click &&
      hyperlink_mouse_over == o.hyperlink_mouse_over &&
      type == o.type &&
      is_object_icon == o.is_object_icon &&
      substitute_picture_title == o.substitute_picture_title &&
      substitute_picture_format == o.substitute_picture_format &&
      object_name == o.object_name &&
      embedded_file_base64_data == o.embedded_file_base64_data &&
      embedded_file_extension == o.embedded_file_extension &&
      object_prog_id == o.object_prog_id &&
      link_path == o.link_path &&
      update_automatic == o.update_automatic
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 251

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 325

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 218

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


205
206
207
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 211

def hash
  [self_uri, alternate_links, name, width, height, alternative_text, alternative_text_title, hidden, x, y, z_order_position, fill_format, effect_format, three_d_format, line_format, hyperlink_click, hyperlink_mouse_over, type, is_object_icon, substitute_picture_title, substitute_picture_format, object_name, embedded_file_base64_data, embedded_file_extension, object_prog_id, link_path, update_automatic].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



152
153
154
155
156
157
158
159
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 152

def list_invalid_properties
  invalid_properties = super
  if @is_object_icon.nil?
    invalid_properties.push('invalid value for "is_object_icon", is_object_icon cannot be nil.')
  end

  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



305
306
307
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 305

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



311
312
313
314
315
316
317
318
319
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 311

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



299
300
301
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 299

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



163
164
165
166
167
 
# File 'lib/aspose_slides_cloud/models/ole_object_frame.rb', line 163

def valid?
  return false if !super
  return false if @is_object_icon.nil?
  true
end