class AsposePdfCloud::TextReplace

Single text replacement setting.

Attributes

center_text_horizontally[RW]

The text after replacement is centered horizontally relative to the text being replaced.

new_value[RW]

New text.

old_value[RW]

Original text.

rect[RW]

Rectangle area where searched original text.

regex[RW]

Gets or sets a value indicating whether search text is regular expression.

text_state[RW]

Text properties of a new text.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 48
def self.attribute_map
  {
    :'old_value' => :'OldValue',
    :'new_value' => :'NewValue',
    :'regex' => :'Regex',
    :'text_state' => :'TextState',
    :'rect' => :'Rect',
    :'center_text_horizontally' => :'CenterTextHorizontally'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 73
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?(:'OldValue')
    self.old_value = attributes[:'OldValue']
  end

  if attributes.has_key?(:'NewValue')
    self.new_value = attributes[:'NewValue']
  end

  if attributes.has_key?(:'Regex')
    self.regex = attributes[:'Regex']
  end

  if attributes.has_key?(:'TextState')
    self.text_state = attributes[:'TextState']
  end

  if attributes.has_key?(:'Rect')
    self.rect = attributes[:'Rect']
  end

  if attributes.has_key?(:'CenterTextHorizontally')
    self.center_text_horizontally = attributes[:'CenterTextHorizontally']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 60
def self.swagger_types
  {
    :'old_value' => :'String',
    :'new_value' => :'String',
    :'regex' => :'BOOLEAN',
    :'text_state' => :'TextState',
    :'rect' => :'Rectangle',
    :'center_text_horizontally' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 149
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      old_value == o.old_value &&
      new_value == o.new_value &&
      regex == o.regex &&
      text_state == o.text_state &&
      rect == o.rect &&
      center_text_horizontally == o.center_text_horizontally
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 196
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 = AsposePdfCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 262
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 175
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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 162
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 168
def hash
  [old_value, new_value, regex, text_state, rect, center_text_horizontally].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 107
def list_invalid_properties
  invalid_properties = Array.new
  if @old_value.nil?
    invalid_properties.push("invalid value for 'old_value', old_value cannot be nil.")
  end

  if @old_value.to_s.length < 1
    invalid_properties.push("invalid value for 'old_value', the character length must be great than or equal to 1.")
  end

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

  return invalid_properties
end
old_value=(old_value) click to toggle source

Custom attribute writer method with validation @param [Object] old_value Value to be assigned

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 135
def old_value=(old_value)
  if old_value.nil?
    fail ArgumentError, "old_value cannot be nil"
  end

  if old_value.to_s.length < 1
    fail ArgumentError, "invalid value for 'old_value', the character length must be great than or equal to 1."
  end

  @old_value = old_value
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 242
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 248
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 236
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_pdf_cloud/models/text_replace.rb, line 126
def valid?
  return false if @old_value.nil?
  return false if @old_value.to_s.length < 1
  return false if @regex.nil?
  return true
end