Class: AsposeCellsCloud::Protection

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_cells_cloud/models/protection.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Protection

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
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
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 117

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'AllowDeletingColumn')
      self.allow_deleting_column = attributes[:'AllowDeletingColumn']
  end
  if attributes.has_key?(:'AllowDeletingRow')
      self.allow_deleting_row = attributes[:'AllowDeletingRow']
  end
  if attributes.has_key?(:'AllowFiltering')
      self.allow_filtering = attributes[:'AllowFiltering']
  end
  if attributes.has_key?(:'AllowFormattingCell')
      self.allow_formatting_cell = attributes[:'AllowFormattingCell']
  end
  if attributes.has_key?(:'AllowFormattingColumn')
      self.allow_formatting_column = attributes[:'AllowFormattingColumn']
  end
  if attributes.has_key?(:'AllowFormattingRow')
      self.allow_formatting_row = attributes[:'AllowFormattingRow']
  end
  if attributes.has_key?(:'AllowInsertingColumn')
      self.allow_inserting_column = attributes[:'AllowInsertingColumn']
  end
  if attributes.has_key?(:'AllowInsertingHyperlink')
      self.allow_inserting_hyperlink = attributes[:'AllowInsertingHyperlink']
  end
  if attributes.has_key?(:'AllowInsertingRow')
      self.allow_inserting_row = attributes[:'AllowInsertingRow']
  end
  if attributes.has_key?(:'AllowSorting')
      self.allow_sorting = attributes[:'AllowSorting']
  end
  if attributes.has_key?(:'AllowUsingPivotTable')
      self.allow_using_pivot_table = attributes[:'AllowUsingPivotTable']
  end
  if attributes.has_key?(:'AllowEditingContent')
      self.allow_editing_content = attributes[:'AllowEditingContent']
  end
  if attributes.has_key?(:'AllowEditingObject')
      self.allow_editing_object = attributes[:'AllowEditingObject']
  end
  if attributes.has_key?(:'AllowEditingScenario')
      self.allow_editing_scenario = attributes[:'AllowEditingScenario']
  end
  if attributes.has_key?(:'Password')
      self.password = attributes[:'Password']
  end
  if attributes.has_key?(:'AllowSelectingLockedCell')
      self.allow_selecting_locked_cell = attributes[:'AllowSelectingLockedCell']
  end
  if attributes.has_key?(:'AllowSelectingUnlockedCell')
      self.allow_selecting_unlocked_cell = attributes[:'AllowSelectingUnlockedCell']
  end

end

Instance Attribute Details

#allow_deleting_column ⇒ Object

Represents if the deletion of columns is allowed on a protected worksheet.



35
36
37
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 35

def allow_deleting_column
  @allow_deleting_column
end

#allow_deleting_row ⇒ Object

Represents if the deletion of rows is allowed on a protected worksheet.



37
38
39
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 37

def allow_deleting_row
  @allow_deleting_row
end

#allow_editing_content ⇒ Object

Represents if the user is allowed to edit contents of locked cells on a protected worksheet.



57
58
59
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 57

def allow_editing_content
  @allow_editing_content
end

#allow_editing_object ⇒ Object

Represents if the user is allowed to manipulate drawing objects on a protected worksheet.



59
60
61
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 59

def allow_editing_object
  @allow_editing_object
end

#allow_editing_scenario ⇒ Object

Represents if the user is allowed to edit scenarios on a protected worksheet.



61
62
63
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 61

def allow_editing_scenario
  @allow_editing_scenario
end

#allow_filtering ⇒ Object

Represents if the user is allowed to make use of an AutoFilter that was created before the sheet was protected.



39
40
41
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 39

def allow_filtering
  @allow_filtering
end

#allow_formatting_cell ⇒ Object

Represents if the formatting of cells is allowed on a protected worksheet.



41
42
43
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 41

def allow_formatting_cell
  @allow_formatting_cell
end

#allow_formatting_column ⇒ Object

Represents if the formatting of columns is allowed on a protected worksheet



43
44
45
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 43

def allow_formatting_column
  @allow_formatting_column
end

#allow_formatting_row ⇒ Object

Represents if the formatting of rows is allowed on a protected worksheet



45
46
47
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 45

def allow_formatting_row
  @allow_formatting_row
end

#allow_inserting_column ⇒ Object

Represents if the insertion of columns is allowed on a protected worksheet



47
48
49
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 47

def allow_inserting_column
  @allow_inserting_column
end

#allow_inserting_hyperlink ⇒ Object

Represents if the insertion of hyperlinks is allowed on a protected worksheet



49
50
51
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 49

def allow_inserting_hyperlink
  @allow_inserting_hyperlink
end

#allow_inserting_row ⇒ Object

Represents if the insertion of rows is allowed on a protected worksheet



51
52
53
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 51

def allow_inserting_row
  @allow_inserting_row
end

#allow_selecting_locked_cell ⇒ Object

Represents if the user is allowed to select locked cells on a protected worksheet.



65
66
67
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 65

def allow_selecting_locked_cell
  @allow_selecting_locked_cell
end

#allow_selecting_unlocked_cell ⇒ Object

Represents if the user is allowed to select unlocked cells on a protected worksheet.



67
68
69
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 67

def allow_selecting_unlocked_cell
  @allow_selecting_unlocked_cell
end

#allow_sorting ⇒ Object

Represents if the sorting option is allowed on a protected worksheet.



53
54
55
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 53

def allow_sorting
  @allow_sorting
end

#allow_using_pivot_table ⇒ Object

Represents if the user is allowed to manipulate pivot tables on a protected worksheet.



55
56
57
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 55

def allow_using_pivot_table
  @allow_using_pivot_table
end

#password ⇒ Object

Represents the password to protect the worksheet.



63
64
65
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 63

def password
  @password
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 70

def self.attribute_map
  {
    :'allow_deleting_column' => :'AllowDeletingColumn',
    :'allow_deleting_row' => :'AllowDeletingRow',
    :'allow_filtering' => :'AllowFiltering',
    :'allow_formatting_cell' => :'AllowFormattingCell',
    :'allow_formatting_column' => :'AllowFormattingColumn',
    :'allow_formatting_row' => :'AllowFormattingRow',
    :'allow_inserting_column' => :'AllowInsertingColumn',
    :'allow_inserting_hyperlink' => :'AllowInsertingHyperlink',
    :'allow_inserting_row' => :'AllowInsertingRow',
    :'allow_sorting' => :'AllowSorting',
    :'allow_using_pivot_table' => :'AllowUsingPivotTable',
    :'allow_editing_content' => :'AllowEditingContent',
    :'allow_editing_object' => :'AllowEditingObject',
    :'allow_editing_scenario' => :'AllowEditingScenario',
    :'password' => :'Password',
    :'allow_selecting_locked_cell' => :'AllowSelectingLockedCell',
    :'allow_selecting_unlocked_cell' => :'AllowSelectingUnlockedCell'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 93

def self.swagger_types
  {
    :'allow_deleting_column' => :'BOOLEAN',
    :'allow_deleting_row' => :'BOOLEAN',
    :'allow_filtering' => :'BOOLEAN',
    :'allow_formatting_cell' => :'BOOLEAN',
    :'allow_formatting_column' => :'BOOLEAN',
    :'allow_formatting_row' => :'BOOLEAN',
    :'allow_inserting_column' => :'BOOLEAN',
    :'allow_inserting_hyperlink' => :'BOOLEAN',
    :'allow_inserting_row' => :'BOOLEAN',
    :'allow_sorting' => :'BOOLEAN',
    :'allow_using_pivot_table' => :'BOOLEAN',
    :'allow_editing_content' => :'BOOLEAN',
    :'allow_editing_object' => :'BOOLEAN',
    :'allow_editing_scenario' => :'BOOLEAN',
    :'password' => :'String',
    :'allow_selecting_locked_cell' => :'BOOLEAN',
    :'allow_selecting_unlocked_cell' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      allow_deleting_column == o.allow_deleting_column &&
      allow_deleting_row == o.allow_deleting_row &&
      allow_filtering == o.allow_filtering &&
      allow_formatting_cell == o.allow_formatting_cell &&
      allow_formatting_column == o.allow_formatting_column &&
      allow_formatting_row == o.allow_formatting_row &&
      allow_inserting_column == o.allow_inserting_column &&
      allow_inserting_hyperlink == o.allow_inserting_hyperlink &&
      allow_inserting_row == o.allow_inserting_row &&
      allow_sorting == o.allow_sorting &&
      allow_using_pivot_table == o.allow_using_pivot_table &&
      allow_editing_content == o.allow_editing_content &&
      allow_editing_object == o.allow_editing_object &&
      allow_editing_scenario == o.allow_editing_scenario &&
      password == o.password &&
      allow_selecting_locked_cell == o.allow_selecting_locked_cell &&
      allow_selecting_unlocked_cell == o.allow_selecting_unlocked_cell 
      std_dev == o.std_dev
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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 320

def _deserialize(type, value)
  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
    temp_model = AsposeCellsCloud.const_get(type).new
    temp_model.build_from_hash(value)
  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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 386

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 299

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    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 attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



292
293
294
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 292

def hash
  [ allow_deleting_column , allow_deleting_row , allow_filtering , allow_formatting_cell , allow_formatting_column , allow_formatting_row , allow_inserting_column , allow_inserting_hyperlink , allow_inserting_row , allow_sorting , allow_using_pivot_table , allow_editing_content , allow_editing_object , allow_editing_scenario , password , allow_selecting_locked_cell , allow_selecting_unlocked_cell ].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  if @allow_deleting_column.nil?
      invalid_properties.push("invalid value for 'allow_deleting_column', allow_deleting_column cannot be nil.")
  end
  if @allow_deleting_row.nil?
      invalid_properties.push("invalid value for 'allow_deleting_row', allow_deleting_row cannot be nil.")
  end
  if @allow_filtering.nil?
      invalid_properties.push("invalid value for 'allow_filtering', allow_filtering cannot be nil.")
  end
  if @allow_formatting_cell.nil?
      invalid_properties.push("invalid value for 'allow_formatting_cell', allow_formatting_cell cannot be nil.")
  end
  if @allow_formatting_column.nil?
      invalid_properties.push("invalid value for 'allow_formatting_column', allow_formatting_column cannot be nil.")
  end
  if @allow_formatting_row.nil?
      invalid_properties.push("invalid value for 'allow_formatting_row', allow_formatting_row cannot be nil.")
  end
  if @allow_inserting_column.nil?
      invalid_properties.push("invalid value for 'allow_inserting_column', allow_inserting_column cannot be nil.")
  end
  if @allow_inserting_hyperlink.nil?
      invalid_properties.push("invalid value for 'allow_inserting_hyperlink', allow_inserting_hyperlink cannot be nil.")
  end
  if @allow_inserting_row.nil?
      invalid_properties.push("invalid value for 'allow_inserting_row', allow_inserting_row cannot be nil.")
  end
  if @allow_sorting.nil?
      invalid_properties.push("invalid value for 'allow_sorting', allow_sorting cannot be nil.")
  end
  if @allow_using_pivot_table.nil?
      invalid_properties.push("invalid value for 'allow_using_pivot_table', allow_using_pivot_table cannot be nil.")
  end
  if @allow_editing_content.nil?
      invalid_properties.push("invalid value for 'allow_editing_content', allow_editing_content cannot be nil.")
  end
  if @allow_editing_object.nil?
      invalid_properties.push("invalid value for 'allow_editing_object', allow_editing_object cannot be nil.")
  end
  if @allow_editing_scenario.nil?
      invalid_properties.push("invalid value for 'allow_editing_scenario', allow_editing_scenario cannot be nil.")
  end
  if @password.nil?
      invalid_properties.push("invalid value for 'password', password cannot be nil.")
  end
  if @allow_selecting_locked_cell.nil?
      invalid_properties.push("invalid value for 'allow_selecting_locked_cell', allow_selecting_locked_cell cannot be nil.")
  end
  if @allow_selecting_unlocked_cell.nil?
      invalid_properties.push("invalid value for 'allow_selecting_unlocked_cell', allow_selecting_unlocked_cell cannot be nil.")
  end

  return 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



366
367
368
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 366

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



372
373
374
375
376
377
378
379
380
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 372

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



360
361
362
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 360

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/aspose_cells_cloud/models/protection.rb', line 238

def valid?
  return false if @allow_deleting_column.nil?
  return false if @allow_deleting_row.nil?
  return false if @allow_filtering.nil?
  return false if @allow_formatting_cell.nil?
  return false if @allow_formatting_column.nil?
  return false if @allow_formatting_row.nil?
  return false if @allow_inserting_column.nil?
  return false if @allow_inserting_hyperlink.nil?
  return false if @allow_inserting_row.nil?
  return false if @allow_sorting.nil?
  return false if @allow_using_pivot_table.nil?
  return false if @allow_editing_content.nil?
  return false if @allow_editing_object.nil?
  return false if @allow_editing_scenario.nil?
  return false if @password.nil?
  return false if @allow_selecting_locked_cell.nil?
  return false if @allow_selecting_unlocked_cell.nil?
  return true
end