Class: AsposeSlidesCloud::NotesCommentsLayoutingOptions

Inherits:
SlidesLayoutOptions show all
Defined in:
lib/aspose_slides_cloud/models/notes_comments_layouting_options.rb

Overview

Notes & comments layouting options.

Instance Attribute Summary collapse

Attributes inherited from SlidesLayoutOptions

#layout_type

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

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
90
 
# File 'lib/aspose_slides_cloud/models/notes_comments_layouting_options.rb', line 67

def initialize(attributes = {})
  super

  if attributes.has_key?(:'NotesPosition')
    self.notes_position = attributes[:'NotesPosition']
  end

  if attributes.has_key?(:'CommentsPosition')
    self.comments_position = attributes[:'CommentsPosition']
  end

  if attributes.has_key?(:'CommentsAreaWidth')
    self.comments_area_width = attributes[:'CommentsAreaWidth']
  end

  if attributes.has_key?(:'CommentsAreaColor')
    self.comments_area_color = attributes[:'CommentsAreaColor']
  end

  if attributes.has_key?(:'ShowCommentsByNoAuthor')
    self.show_comments_by_no_author = attributes[:'ShowCommentsByNoAuthor']
  end
  self.layout_type = 'NotesComments'
end

Instance Attribute Details

#comments_area_color ⇒ Object

Gets or sets the color of comments area (Applies only if comments are displayed on the right).



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

def comments_area_color
  @comments_area_color
end

#comments_area_width ⇒ Object

Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).



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

def comments_area_width
  @comments_area_width
end

#comments_position ⇒ Object

Gets or sets the position of the comments on the page.



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

def comments_position
  @comments_position
end

#notes_position ⇒ Object

Gets or sets the position of the notes on the page.



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

def notes_position
  @notes_position
end

#show_comments_by_no_author ⇒ Object

True if comments that have no author are displayed. (Applies only if comments are displayed).



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

def show_comments_by_no_author
  @show_comments_by_no_author
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/notes_comments_layouting_options.rb', line 44

def self.attribute_map
  super.merge({
    :'notes_position' => :'NotesPosition',
    :'comments_position' => :'CommentsPosition',
    :'comments_area_width' => :'CommentsAreaWidth',
    :'comments_area_color' => :'CommentsAreaColor',
    :'show_comments_by_no_author' => :'ShowCommentsByNoAuthor',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  super.merge({
    :'notes_position' => :'String',
    :'comments_position' => :'String',
    :'comments_area_width' => :'Integer',
    :'comments_area_color' => :'String',
    :'show_comments_by_no_author' => :'BOOLEAN',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/aspose_slides_cloud/models/notes_comments_layouting_options.rb', line 132

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      layout_type == o.layout_type &&
      notes_position == o.notes_position &&
      comments_position == o.comments_position &&
      comments_area_width == o.comments_area_width &&
      comments_area_color == o.comments_area_color &&
      show_comments_by_no_author == o.show_comments_by_no_author
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


145
146
147
 
# File 'lib/aspose_slides_cloud/models/notes_comments_layouting_options.rb', line 145

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



151
152
153
 
# File 'lib/aspose_slides_cloud/models/notes_comments_layouting_options.rb', line 151

def hash
  [layout_type, notes_position, comments_position, comments_area_width, comments_area_color, show_comments_by_no_author].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



94
95
96
97
 
# File 'lib/aspose_slides_cloud/models/notes_comments_layouting_options.rb', line 94

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



101
102
103
104
105
106
107
108
 
# File 'lib/aspose_slides_cloud/models/notes_comments_layouting_options.rb', line 101

def valid?
  return false if !super
  notes_position_validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated'])
  return false unless notes_position_validator.valid?(@notes_position)
  comments_position_validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right'])
  return false unless comments_position_validator.valid?(@comments_position)
  true
end