Class: WordsRubySdk::RtfSaveOptionsData
- Inherits:
-
Object
- Object
- WordsRubySdk::RtfSaveOptionsData
- Defined in:
- lib/words_ruby_sdk/models/rtf_save_options_data.rb
Overview
container class for rtf save options
Instance Attribute Summary collapse
-
#color_mode ⇒ Object
Gets or sets a value determining how colors are rendered.
-
#dml_effects_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML effects are rendered.
-
#dml_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML shapes are rendered.
-
#export_compact_size ⇒ Object
Allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly.
-
#export_images_for_old_readers ⇒ Object
Specifies whether the keywords for "old readers" are written to RTF or not.
-
#file_name ⇒ Object
name of destination file.
-
#pretty_format ⇒ Object
Specifies whether or not use pretty formats output.
-
#save_format ⇒ Object
format of save.
-
#update_fields ⇒ Object
Gets or sets a value determining if fields should be updated before saving the document to a fixed page format.
-
#update_last_saved_time_property ⇒ Object
Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
-
#update_sdt_content ⇒ Object
Gets or sets value determining whether content of is updated before saving.
-
#zip_output ⇒ Object
Controls zip output or not.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ RtfSaveOptionsData
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ RtfSaveOptionsData
Initializes the object
109 110 111 112 113 114 115 116 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 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 109 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?(:'ColorMode') self.color_mode = attributes[:'ColorMode'] end if attributes.key?(:'SaveFormat') self.save_format = attributes[:'SaveFormat'] end if attributes.key?(:'FileName') self.file_name = attributes[:'FileName'] end if attributes.key?(:'DmlRenderingMode') self.dml_rendering_mode = attributes[:'DmlRenderingMode'] end if attributes.key?(:'DmlEffectsRenderingMode') self.dml_effects_rendering_mode = attributes[:'DmlEffectsRenderingMode'] end if attributes.key?(:'ZipOutput') self.zip_output = attributes[:'ZipOutput'] end if attributes.key?(:'UpdateLastSavedTimeProperty') self.update_last_saved_time_property = attributes[:'UpdateLastSavedTimeProperty'] end if attributes.key?(:'UpdateSdtContent') self.update_sdt_content = attributes[:'UpdateSdtContent'] end if attributes.key?(:'UpdateFields') self.update_fields = attributes[:'UpdateFields'] end if attributes.key?(:'ExportCompactSize') self.export_compact_size = attributes[:'ExportCompactSize'] end if attributes.key?(:'ExportImagesForOldReaders') self.export_images_for_old_readers = attributes[:'ExportImagesForOldReaders'] end if attributes.key?(:'PrettyFormat') self.pretty_format = attributes[:'PrettyFormat'] end end |
Instance Attribute Details
#color_mode ⇒ Object
Gets or sets a value determining how colors are rendered. { Normal | Grayscale}
35 36 37 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 35 def color_mode @color_mode end |
#dml_effects_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML effects are rendered. { Simplified | None | Fine }
47 48 49 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 47 def dml_effects_rendering_mode @dml_effects_rendering_mode end |
#dml_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML shapes are rendered. { Fallback | DrawingML }
44 45 46 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 44 def dml_rendering_mode @dml_rendering_mode end |
#export_compact_size ⇒ Object
Allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly
62 63 64 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 62 def export_compact_size @export_compact_size end |
#export_images_for_old_readers ⇒ Object
Specifies whether the keywords for "old readers" are written to RTF or not
65 66 67 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 65 def export_images_for_old_readers @export_images_for_old_readers end |
#file_name ⇒ Object
name of destination file
41 42 43 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 41 def file_name @file_name end |
#pretty_format ⇒ Object
Specifies whether or not use pretty formats output
68 69 70 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 68 def pretty_format @pretty_format end |
#save_format ⇒ Object
format of save
38 39 40 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 38 def save_format @save_format end |
#update_fields ⇒ Object
Gets or sets a value determining if fields should be updated before saving the document to a fixed page format. Default value for this property is true
59 60 61 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 59 def update_fields @update_fields end |
#update_last_saved_time_property ⇒ Object
Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
53 54 55 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 53 def update_last_saved_time_property @update_last_saved_time_property end |
#update_sdt_content ⇒ Object
Gets or sets value determining whether content of is updated before saving.
56 57 58 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 56 def update_sdt_content @update_sdt_content end |
#zip_output ⇒ Object
Controls zip output or not. Default value is false.
50 51 52 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 50 def zip_output @zip_output end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 72 def self.attribute_map { :'color_mode' => :'ColorMode', :'save_format' => :'SaveFormat', :'file_name' => :'FileName', :'dml_rendering_mode' => :'DmlRenderingMode', :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode', :'zip_output' => :'ZipOutput', :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty', :'update_sdt_content' => :'UpdateSdtContent', :'update_fields' => :'UpdateFields', :'export_compact_size' => :'ExportCompactSize', :'export_images_for_old_readers' => :'ExportImagesForOldReaders', :'pretty_format' => :'PrettyFormat' } end |
.swagger_types ⇒ Object
Attribute type mapping.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 90 def self.swagger_types { :'color_mode' => :'String', :'save_format' => :'String', :'file_name' => :'String', :'dml_rendering_mode' => :'String', :'dml_effects_rendering_mode' => :'String', :'zip_output' => :'BOOLEAN', :'update_last_saved_time_property' => :'BOOLEAN', :'update_sdt_content' => :'BOOLEAN', :'update_fields' => :'BOOLEAN', :'export_compact_size' => :'BOOLEAN', :'export_images_for_old_readers' => :'BOOLEAN', :'pretty_format' => :'BOOLEAN' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 180 def ==(other) return true if self.equal?(other) self.class == other.class && color_mode == other.color_mode && save_format == other.save_format && file_name == other.file_name && dml_rendering_mode == other.dml_rendering_mode && dml_effects_rendering_mode == other.dml_effects_rendering_mode && zip_output == other.zip_output && update_last_saved_time_property == other.update_last_saved_time_property && update_sdt_content == other.update_sdt_content && update_fields == other.update_fields && export_compact_size == other.export_compact_size && export_images_for_old_readers == other.export_images_for_old_readers && pretty_format == other.pretty_format end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 234 def _deserialize(type, value) case type.to_sym when :DateTime Time.at(/\d/.match(value)[0].to_f).to_datetime when :Date Time.at(/\d/.match(value)[0].to_f).to_date 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 = WordsRubySdk.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
301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 301 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
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 212 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?(other) ⇒ Boolean
199 200 201 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 199 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
205 206 207 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 205 def hash [color_mode, save_format, file_name, dml_rendering_mode, dml_effects_rendering_mode, zip_output, update_last_saved_time_property, update_sdt_content, update_fields, export_compact_size, export_images_for_old_readers, pretty_format].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
167 168 169 170 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 167 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
281 282 283 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 281 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
287 288 289 290 291 292 293 294 295 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 287 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
275 276 277 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 275 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
174 175 176 |
# File 'lib/words_ruby_sdk/models/rtf_save_options_data.rb', line 174 def valid? return true end |