Class: AsposeSlidesCloud::HeaderFooter

Inherits:
ResourceBase show all
Defined in:
lib/aspose_slides_cloud/models/header_footer.rb

Overview

Represents header/footer info of slide

Instance Attribute Summary collapse

Attributes inherited from ResourceBase

#alternate_links, #self_uri

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 = {}) ⇒ HeaderFooter

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 67

def initialize(attributes = {})
  super

  if attributes.has_key?(:'IsDateTimeVisible')
    self.is_date_time_visible = attributes[:'IsDateTimeVisible']
  end

  if attributes.has_key?(:'DateTimeText')
    self.date_time_text = attributes[:'DateTimeText']
  end

  if attributes.has_key?(:'IsFooterVisible')
    self.is_footer_visible = attributes[:'IsFooterVisible']
  end

  if attributes.has_key?(:'FooterText')
    self.footer_text = attributes[:'FooterText']
  end

  if attributes.has_key?(:'IsSlideNumberVisible')
    self.is_slide_number_visible = attributes[:'IsSlideNumberVisible']
  end
end

Instance Attribute Details

#date_time_text ⇒ Object

Text to be displayed as date in the footer



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

def date_time_text
  @date_time_text
end

#footer_text ⇒ Object

Text to be displayed in the footer



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

def footer_text
  @footer_text
end

#is_date_time_visible ⇒ Object

True if date is displayed in the footer



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

def is_date_time_visible
  @is_date_time_visible
end

#is_footer_visible ⇒ Object

True if footer is displayed



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

def is_footer_visible
  @is_footer_visible
end

#is_slide_number_visible ⇒ Object

True if slide number is displayed in the footer



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

def is_slide_number_visible
  @is_slide_number_visible
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 44

def self.attribute_map
  super.merge({
    :'is_date_time_visible' => :'IsDateTimeVisible',
    :'date_time_text' => :'DateTimeText',
    :'is_footer_visible' => :'IsFooterVisible',
    :'footer_text' => :'FooterText',
    :'is_slide_number_visible' => :'IsSlideNumberVisible',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 55

def self.swagger_types
  super.merge({
    :'is_date_time_visible' => :'BOOLEAN',
    :'date_time_text' => :'String',
    :'is_footer_visible' => :'BOOLEAN',
    :'footer_text' => :'String',
    :'is_slide_number_visible' => :'BOOLEAN',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      is_date_time_visible == o.is_date_time_visible &&
      date_time_text == o.date_time_text &&
      is_footer_visible == o.is_footer_visible &&
      footer_text == o.footer_text &&
      is_slide_number_visible == o.is_slide_number_visible
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


121
122
123
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 121

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 127

def hash
  [self_uri, alternate_links, is_date_time_visible, date_time_text, is_footer_visible, footer_text, is_slide_number_visible].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



93
94
95
96
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 93

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



100
101
102
103
 
# File 'lib/aspose_slides_cloud/models/header_footer.rb', line 100

def valid?
  return false if !super
  true
end