Class: GroupDocsSignatureCloud::SignQRCodeOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb

Overview

Represents the QR-code signature options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignQRCodeOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
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
357
358
359
360
361
362
363
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 229

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.key?(:'SignatureType')
    self.signature_type = attributes[:'SignatureType']
  end

  if attributes.key?(:'Page')
    self.page = attributes[:'Page']
  end

  if attributes.key?(:'AllPages')
    self.all_pages = attributes[:'AllPages']
  end

  if attributes.key?(:'PagesSetup')
    self.pages_setup = attributes[:'PagesSetup']
  end

  if attributes.key?(:'Appearance')
    self.appearance = attributes[:'Appearance']
  end

  if attributes.key?(:'Left')
    self.left = attributes[:'Left']
  end

  if attributes.key?(:'Top')
    self.top = attributes[:'Top']
  end

  if attributes.key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.key?(:'LocationMeasureType')
    self.location_measure_type = attributes[:'LocationMeasureType']
  end

  if attributes.key?(:'SizeMeasureType')
    self.size_measure_type = attributes[:'SizeMeasureType']
  end

  if attributes.key?(:'Stretch')
    self.stretch = attributes[:'Stretch']
  end

  if attributes.key?(:'RotationAngle')
    self.rotation_angle = attributes[:'RotationAngle']
  end

  if attributes.key?(:'HorizontalAlignment')
    self.horizontal_alignment = attributes[:'HorizontalAlignment']
  end

  if attributes.key?(:'VerticalAlignment')
    self.vertical_alignment = attributes[:'VerticalAlignment']
  end

  if attributes.key?(:'Margin')
    self.margin = attributes[:'Margin']
  end

  if attributes.key?(:'MarginMeasureType')
    self.margin_measure_type = attributes[:'MarginMeasureType']
  end

  if attributes.key?(:'Text')
    self.text = attributes[:'Text']
  end

  if attributes.key?(:'Font')
    self.font = attributes[:'Font']
  end

  if attributes.key?(:'ForeColor')
    self.fore_color = attributes[:'ForeColor']
  end

  if attributes.key?(:'BackgroundColor')
    self.background_color = attributes[:'BackgroundColor']
  end

  if attributes.key?(:'BackgroundBrush')
    self.background_brush = attributes[:'BackgroundBrush']
  end

  if attributes.key?(:'Border')
    self.border = attributes[:'Border']
  end

  if attributes.key?(:'TextHorizontalAlignment')
    self.text_horizontal_alignment = attributes[:'TextHorizontalAlignment']
  end

  if attributes.key?(:'TextVerticalAlignment')
    self.text_vertical_alignment = attributes[:'TextVerticalAlignment']
  end

  if attributes.key?(:'ZOrder')
    self.z_order = attributes[:'ZOrder']
  end

  if attributes.key?(:'Native')
    self.native = attributes[:'Native']
  end

  if attributes.key?(:'QRCodeType')
    self.qr_code_type = attributes[:'QRCodeType']
  end

  if attributes.key?(:'Transparency')
    self.transparency = attributes[:'Transparency']
  end

  if attributes.key?(:'CodeTextAlignment')
    self.code_text_alignment = attributes[:'CodeTextAlignment']
  end

  if attributes.key?(:'InnerMargins')
    self.inner_margins = attributes[:'InnerMargins']
  end

  if attributes.key?(:'LogoFilePath')
    self.logo_file_path = attributes[:'LogoFilePath']
  end

end

Instance Attribute Details

#all_pages ⇒ Object

Process all document pages. Type of processing depends on SignatureType For Images Document Type it can be used only for multi-frames images like .tiff



41
42
43
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 41

def all_pages
  @all_pages
end

#appearance ⇒ Object

Specifies Appearance with additional properties for this options instance



47
48
49
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 47

def appearance
  @appearance
end

#background_brush ⇒ Object

Gets or sets the signature background brush. Value by default is null. If this property has a value it will be used instead BackgroundBrush property. For Spreadsheet documents TextStamp implementation RadialGradientBrush is not applicable, it is replaced by LinearGradientBrush. Spreadsheets, Images, Presentations It is not used for Watermark implementation. PDF For Stamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. PDF It is not used for Annotation, Sticker, TextToFormField and Watermark implementations. Presentations For TextStamp implementation RadialGradientBrush is not applicable, it is replaced by LinearGradientBrush. Word Processing For TextStamp implementation LinearGradientBrush (ColorStart) and RadialGradientBrush (ColorInner) are used as SolidBrush. Word Processing It is not used for TextToFormField and Watermark implementations



98
99
100
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 98

def background_brush
  @background_brush
end

#background_color ⇒ Object

Gets or sets the background color of signature



95
96
97
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 95

def background_color
  @background_color
end

#border ⇒ Object

Gets or sets the signature border properties



101
102
103
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 101

def border
  @border
end

#code_text_alignment ⇒ Object

Gets or sets the alignment of text in the result QR-code Default value is None



122
123
124
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 122

def code_text_alignment
  @code_text_alignment
end

#font ⇒ Object

Gets or sets the font of signature



89
90
91
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 89

def font
  @font
end

#fore_color ⇒ Object

Gets or sets the fore color of signature



92
93
94
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 92

def fore_color
  @fore_color
end

#height ⇒ Object

Height of Signature are on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property)



59
60
61
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 59

def height
  @height
end

#horizontal_alignment ⇒ Object

Horizontal alignment of signature on document page



74
75
76
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 74

def horizontal_alignment
  @horizontal_alignment
end

#inner_margins ⇒ Object

Gets or sets the space between QRCode elements and result image borders



125
126
127
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 125

def inner_margins
  @inner_margins
end

#left ⇒ Object

Left X position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property)



50
51
52
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 50

def left
  @left
end

#location_measure_type ⇒ Object

Measure type (pixels or percent) for Left and Top properties



62
63
64
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 62

def location_measure_type
  @location_measure_type
end

#logo_file_path ⇒ Object

Gets or sets the QR-code logo image file name. This property in use only if LogoStream is not specified. Using of this property could cause problems with verification. Use it carefully



128
129
130
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 128

def logo_file_path
  @logo_file_path
end

#margin ⇒ Object

Gets or sets the space between Sign and Document edges (works ONLY if horizontal or vertical alignment are specified)



80
81
82
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 80

def margin
  @margin
end

#margin_measure_type ⇒ Object

Gets or sets the measure type (pixels or percent) for Margin



83
84
85
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 83

def margin_measure_type
  @margin_measure_type
end

#native ⇒ Object

Gets or sets the native attribute. If it is set document specific signatures could be used. Native text watermark for WordProcessing documents is different than regular, for example.



113
114
115
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 113

def native
  @native
end

#page ⇒ Object

Gets or sets a document page number for processing. Value is optional



38
39
40
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 38

def page
  @page
end

#pages_setup ⇒ Object

Options to specify pages for processing



44
45
46
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 44

def pages_setup
  @pages_setup
end

#qr_code_type ⇒ Object

Get or set QRCode type. Value should be one from supported QRCode types list



116
117
118
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 116

def qr_code_type
  @qr_code_type
end

#rotation_angle ⇒ Object

Rotation angle of signature on document page (clockwise)



71
72
73
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 71

def rotation_angle
  @rotation_angle
end

#signature_type ⇒ Object

Specifies the signature type of processing



35
36
37
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 35

def signature_type
  @signature_type
end

#size_measure_type ⇒ Object

Measure type (pixels or percent) for Width and Height properties



65
66
67
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 65

def size_measure_type
  @size_measure_type
end

#stretch ⇒ Object

Stretch mode on document page



68
69
70
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 68

def stretch
  @stretch
end

#text ⇒ Object

Text of signature



86
87
88
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 86

def text
  @text
end

#text_horizontal_alignment ⇒ Object

Horizontal alignment of text inside a signature



104
105
106
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 104

def text_horizontal_alignment
  @text_horizontal_alignment
end

#text_vertical_alignment ⇒ Object

Vertical alignment of text inside a signature



107
108
109
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 107

def text_vertical_alignment
  @text_vertical_alignment
end

#top ⇒ Object

Top Y Position of Signature on Document Page in Measure values (pixels or percent see MeasureType LocationMeasureType property)



53
54
55
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 53

def top
  @top
end

#transparency ⇒ Object

Gets or sets the signature transparency (value from 0.0 (opaque) through 1.0 (clear)). Default value is 0 (opaque).



119
120
121
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 119

def transparency
  @transparency
end

#vertical_alignment ⇒ Object

Vertical alignment of signature on document page



77
78
79
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 77

def vertical_alignment
  @vertical_alignment
end

#width ⇒ Object

Width of Signature area on Document Page in Measure values (pixels or percent see MeasureType SizeMeasureType property)



56
57
58
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 56

def width
  @width
end

#z_order ⇒ Object

Gets or sets the Z-order position of text signature. Determines the display order of overlapping signatures.



110
111
112
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 110

def z_order
  @z_order
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 152

def self.attribute_map
  {
    :'signature_type' => :'SignatureType',
    :'page' => :'Page',
    :'all_pages' => :'AllPages',
    :'pages_setup' => :'PagesSetup',
    :'appearance' => :'Appearance',
    :'left' => :'Left',
    :'top' => :'Top',
    :'width' => :'Width',
    :'height' => :'Height',
    :'location_measure_type' => :'LocationMeasureType',
    :'size_measure_type' => :'SizeMeasureType',
    :'stretch' => :'Stretch',
    :'rotation_angle' => :'RotationAngle',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'margin' => :'Margin',
    :'margin_measure_type' => :'MarginMeasureType',
    :'text' => :'Text',
    :'font' => :'Font',
    :'fore_color' => :'ForeColor',
    :'background_color' => :'BackgroundColor',
    :'background_brush' => :'BackgroundBrush',
    :'border' => :'Border',
    :'text_horizontal_alignment' => :'TextHorizontalAlignment',
    :'text_vertical_alignment' => :'TextVerticalAlignment',
    :'z_order' => :'ZOrder',
    :'native' => :'Native',
    :'qr_code_type' => :'QRCodeType',
    :'transparency' => :'Transparency',
    :'code_text_alignment' => :'CodeTextAlignment',
    :'inner_margins' => :'InnerMargins',
    :'logo_file_path' => :'LogoFilePath'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 190

def self.swagger_types
  {
    :'signature_type' => :'String',
    :'page' => :'Integer',
    :'all_pages' => :'BOOLEAN',
    :'pages_setup' => :'PagesSetup',
    :'appearance' => :'SignatureAppearance',
    :'left' => :'Integer',
    :'top' => :'Integer',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'location_measure_type' => :'String',
    :'size_measure_type' => :'String',
    :'stretch' => :'String',
    :'rotation_angle' => :'Integer',
    :'horizontal_alignment' => :'String',
    :'vertical_alignment' => :'String',
    :'margin' => :'Padding',
    :'margin_measure_type' => :'String',
    :'text' => :'String',
    :'font' => :'SignatureFont',
    :'fore_color' => :'Color',
    :'background_color' => :'Color',
    :'background_brush' => :'Brush',
    :'border' => :'BorderLine',
    :'text_horizontal_alignment' => :'String',
    :'text_vertical_alignment' => :'String',
    :'z_order' => :'Integer',
    :'native' => :'BOOLEAN',
    :'qr_code_type' => :'String',
    :'transparency' => :'Float',
    :'code_text_alignment' => :'String',
    :'inner_margins' => :'Padding',
    :'logo_file_path' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 635

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      signature_type == other.signature_type &&
      page == other.page &&
      all_pages == other.all_pages &&
      pages_setup == other.pages_setup &&
      appearance == other.appearance &&
      left == other.left &&
      top == other.top &&
      width == other.width &&
      height == other.height &&
      location_measure_type == other.location_measure_type &&
      size_measure_type == other.size_measure_type &&
      stretch == other.stretch &&
      rotation_angle == other.rotation_angle &&
      horizontal_alignment == other.horizontal_alignment &&
      vertical_alignment == other.vertical_alignment &&
      margin == other.margin &&
      margin_measure_type == other.margin_measure_type &&
      text == other.text &&
      font == other.font &&
      fore_color == other.fore_color &&
      background_color == other.background_color &&
      background_brush == other.background_brush &&
      border == other.border &&
      text_horizontal_alignment == other.text_horizontal_alignment &&
      text_vertical_alignment == other.text_vertical_alignment &&
      z_order == other.z_order &&
      native == other.native &&
      qr_code_type == other.qr_code_type &&
      transparency == other.transparency &&
      code_text_alignment == other.code_text_alignment &&
      inner_margins == other.inner_margins &&
      logo_file_path == other.logo_file_path
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



717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 717

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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
    # Signature type fix
    ttype = type
    if value.is_a?(Hash) and !value[:signatureType].nil?
      ttype = value[:signatureType] + 'Signature'
      if value[:signatureType] == 'FormField' and !value[:type].nil?
        type = value[:type]
        if type == 'Checkbox'
          ttype = 'CheckboxFormFieldSignature'
        end
        if type == 'Text'
          ttype = 'TextFormFieldSignature'
        end
        if type == 'Combobox'
          ttype = 'ComboboxFormFieldSignature'
        end
        if type == 'DigitalSignature'
          ttype = 'DigitalFormFieldSignature'
        end
        if type == 'Radio'
          ttype = 'RadioButtonFormFieldSignature'
        end
      end
    end      
    temp_model = GroupDocsSignatureCloud.const_get(ttype).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



807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 807

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



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 693

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

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


674
675
676
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 674

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



680
681
682
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 680

def hash
  [signature_type, page, all_pages, pages_setup, appearance, left, top, width, height, location_measure_type, size_measure_type, stretch, rotation_angle, horizontal_alignment, vertical_alignment, margin, margin_measure_type, text, font, fore_color, background_color, background_brush, border, text_horizontal_alignment, text_vertical_alignment, z_order, native, qr_code_type, transparency, code_text_alignment, inner_margins, logo_file_path].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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 367

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

  if @all_pages.nil?
    invalid_properties.push("invalid value for 'all_pages', all_pages cannot be nil.")
  end

  if @left.nil?
    invalid_properties.push("invalid value for 'left', left cannot be nil.")
  end

  if @top.nil?
    invalid_properties.push("invalid value for 'top', top cannot be nil.")
  end

  if @width.nil?
    invalid_properties.push("invalid value for 'width', width cannot be nil.")
  end

  if @height.nil?
    invalid_properties.push("invalid value for 'height', height cannot be nil.")
  end

  if @location_measure_type.nil?
    invalid_properties.push("invalid value for 'location_measure_type', location_measure_type cannot be nil.")
  end

  if @size_measure_type.nil?
    invalid_properties.push("invalid value for 'size_measure_type', size_measure_type cannot be nil.")
  end

  if @stretch.nil?
    invalid_properties.push("invalid value for 'stretch', stretch cannot be nil.")
  end

  if @rotation_angle.nil?
    invalid_properties.push("invalid value for 'rotation_angle', rotation_angle cannot be nil.")
  end

  if @horizontal_alignment.nil?
    invalid_properties.push("invalid value for 'horizontal_alignment', horizontal_alignment cannot be nil.")
  end

  if @vertical_alignment.nil?
    invalid_properties.push("invalid value for 'vertical_alignment', vertical_alignment cannot be nil.")
  end

  if @margin_measure_type.nil?
    invalid_properties.push("invalid value for 'margin_measure_type', margin_measure_type cannot be nil.")
  end

  if @text_horizontal_alignment.nil?
    invalid_properties.push("invalid value for 'text_horizontal_alignment', text_horizontal_alignment cannot be nil.")
  end

  if @text_vertical_alignment.nil?
    invalid_properties.push("invalid value for 'text_vertical_alignment', text_vertical_alignment cannot be nil.")
  end

  if @z_order.nil?
    invalid_properties.push("invalid value for 'z_order', z_order cannot be nil.")
  end

  if @native.nil?
    invalid_properties.push("invalid value for 'native', native cannot be nil.")
  end

  if @transparency.nil?
    invalid_properties.push("invalid value for 'transparency', transparency cannot be nil.")
  end

  if @code_text_alignment.nil?
    invalid_properties.push("invalid value for 'code_text_alignment', code_text_alignment 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



787
788
789
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 787

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



793
794
795
796
797
798
799
800
801
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 793

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



781
782
783
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 781

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



686
687
688
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 686

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
 
# File 'lib/groupdocs_signature_cloud/models/sign_qr_code_options.rb', line 450

def valid?
  return false if @signature_type.nil?
  signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp", "FormField", "Metadata"])
  return false unless signature_type_validator.valid?(@signature_type)
  return false if @all_pages.nil?
  return false if @left.nil?
  return false if @top.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @location_measure_type.nil?
  location_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
  return false unless location_measure_type_validator.valid?(@location_measure_type)
  return false if @size_measure_type.nil?
  size_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
  return false unless size_measure_type_validator.valid?(@size_measure_type)
  return false if @stretch.nil?
  stretch_validator = EnumAttributeValidator.new('String', ["None", "PageWidth", "PageHeight", "PageArea"])
  return false unless stretch_validator.valid?(@stretch)
  return false if @rotation_angle.nil?
  return false if @horizontal_alignment.nil?
  horizontal_alignment_validator = EnumAttributeValidator.new('String', ["None", "Left", "Center", "Right"])
  return false unless horizontal_alignment_validator.valid?(@horizontal_alignment)
  return false if @vertical_alignment.nil?
  vertical_alignment_validator = EnumAttributeValidator.new('String', ["None", "Top", "Center", "Bottom"])
  return false unless vertical_alignment_validator.valid?(@vertical_alignment)
  return false if @margin_measure_type.nil?
  margin_measure_type_validator = EnumAttributeValidator.new('String', ["Pixels", "Percents", "Millimeters"])
  return false unless margin_measure_type_validator.valid?(@margin_measure_type)
  return false if @text_horizontal_alignment.nil?
  text_horizontal_alignment_validator = EnumAttributeValidator.new('String', ["Left", "Center", "Right"])
  return false unless text_horizontal_alignment_validator.valid?(@text_horizontal_alignment)
  return false if @text_vertical_alignment.nil?
  text_vertical_alignment_validator = EnumAttributeValidator.new('String', ["Top", "Center", "Bottom"])
  return false unless text_vertical_alignment_validator.valid?(@text_vertical_alignment)
  return false if @z_order.nil?
  return false if @native.nil?
  return false if @transparency.nil?
  return false if @code_text_alignment.nil?
  code_text_alignment_validator = EnumAttributeValidator.new('String', ["None", "Above", "Below", "Right"])
  return false unless code_text_alignment_validator.valid?(@code_text_alignment)
  return true
end