Class: AsposeWordsCloud::TxtSaveOptionsBaseData
- Inherits:
-
Object
- Object
- AsposeWordsCloud::TxtSaveOptionsBaseData
- Defined in:
- lib/aspose_words_cloud/models/txt_save_options_base_data.rb
Overview
Base class for save options of text formats.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#dml3_d_effects_rendering_mode ⇒ Object
Gets or sets a value determining how 3D effects 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.
-
#encoding ⇒ Object
Gets or sets specifies the encoding to use when exporting in plain text format.
-
#export_headers_footers_mode ⇒ Object
Gets or sets specifies whether to output headers and footers when exporting in plain text format.
-
#file_name ⇒ Object
Gets or sets name of destination file.
-
#force_page_breaks ⇒ Object
Gets or sets allows to specify whether the page breaks should be preserved during export.
-
#paragraph_break ⇒ Object
Gets or sets specifies the string to use as a paragraph break when exporting in plain text format.
-
#save_format ⇒ Object
Gets or sets 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_printed_property ⇒ Object
Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
-
#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 StructuredDocumentTag is updated before saving.
-
#zip_output ⇒ Object
Gets or sets 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 = {}) ⇒ TxtSaveOptionsBaseData
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 = {}) ⇒ TxtSaveOptionsBaseData
Initializes the object
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 176 177 178 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 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 145 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?(:'Dml3DEffectsRenderingMode') self.dml3_d_effects_rendering_mode = attributes[:'Dml3DEffectsRenderingMode'] end if attributes.key?(:'DmlEffectsRenderingMode') self.dml_effects_rendering_mode = attributes[:'DmlEffectsRenderingMode'] end if attributes.key?(:'DmlRenderingMode') self.dml_rendering_mode = attributes[:'DmlRenderingMode'] end if attributes.key?(:'FileName') self.file_name = attributes[:'FileName'] end if attributes.key?(:'SaveFormat') self.save_format = attributes[:'SaveFormat'] end if attributes.key?(:'UpdateFields') self.update_fields = attributes[:'UpdateFields'] end if attributes.key?(:'UpdateLastPrintedProperty') self.update_last_printed_property = attributes[:'UpdateLastPrintedProperty'] 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?(:'ZipOutput') self.zip_output = attributes[:'ZipOutput'] end if attributes.key?(:'Encoding') self.encoding = attributes[:'Encoding'] end if attributes.key?(:'ExportHeadersFootersMode') self. = attributes[:'ExportHeadersFootersMode'] end if attributes.key?(:'ForcePageBreaks') self.force_page_breaks = attributes[:'ForcePageBreaks'] end if attributes.key?(:'ParagraphBreak') self.paragraph_break = attributes[:'ParagraphBreak'] end end |
Instance Attribute Details
#dml3_d_effects_rendering_mode ⇒ Object
Gets or sets a value determining how 3D effects are rendered.
33 34 35 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 33 def dml3_d_effects_rendering_mode @dml3_d_effects_rendering_mode end |
#dml_effects_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML effects are rendered. { Simplified | None | Fine }.
37 38 39 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 37 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 }.
41 42 43 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 41 def dml_rendering_mode @dml_rendering_mode end |
#encoding ⇒ Object
Gets or sets specifies the encoding to use when exporting in plain text format.
68 69 70 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 68 def encoding @encoding end |
#export_headers_footers_mode ⇒ Object
Gets or sets specifies whether to output headers and footers when exporting in plain text format. default value is TxtExportHeadersFootersMode.PrimaryOnly.
72 73 74 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 72 def @export_headers_footers_mode end |
#file_name ⇒ Object
Gets or sets name of destination file.
44 45 46 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 44 def file_name @file_name end |
#force_page_breaks ⇒ Object
Gets or sets allows to specify whether the page breaks should be preserved during export. The default value is false.
76 77 78 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 76 def force_page_breaks @force_page_breaks end |
#paragraph_break ⇒ Object
Gets or sets specifies the string to use as a paragraph break when exporting in plain text format.
79 80 81 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 79 def paragraph_break @paragraph_break end |
#save_format ⇒ Object
Gets or sets format of save.
47 48 49 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 47 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.
51 52 53 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 51 def update_fields @update_fields end |
#update_last_printed_property ⇒ Object
Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
55 56 57 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 55 def update_last_printed_property @update_last_printed_property 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.
58 59 60 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 58 def update_last_saved_time_property @update_last_saved_time_property end |
#update_sdt_content ⇒ Object
Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
61 62 63 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 61 def update_sdt_content @update_sdt_content end |
#zip_output ⇒ Object
Gets or sets controls zip output or not. Default value is false.
65 66 67 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 65 def zip_output @zip_output end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 104 def self.attribute_map { :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode', :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode', :'dml_rendering_mode' => :'DmlRenderingMode', :'file_name' => :'FileName', :'save_format' => :'SaveFormat', :'update_fields' => :'UpdateFields', :'update_last_printed_property' => :'UpdateLastPrintedProperty', :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty', :'update_sdt_content' => :'UpdateSdtContent', :'zip_output' => :'ZipOutput', :'encoding' => :'Encoding', :'export_headers_footers_mode' => :'ExportHeadersFootersMode', :'force_page_breaks' => :'ForcePageBreaks', :'paragraph_break' => :'ParagraphBreak' } end |
.swagger_types ⇒ Object
Attribute type mapping.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 124 def self.swagger_types { :'dml3_d_effects_rendering_mode' => :'String', :'dml_effects_rendering_mode' => :'String', :'dml_rendering_mode' => :'String', :'file_name' => :'String', :'save_format' => :'String', :'update_fields' => :'BOOLEAN', :'update_last_printed_property' => :'BOOLEAN', :'update_last_saved_time_property' => :'BOOLEAN', :'update_sdt_content' => :'BOOLEAN', :'zip_output' => :'BOOLEAN', :'encoding' => :'String', :'export_headers_footers_mode' => :'String', :'force_page_breaks' => :'BOOLEAN', :'paragraph_break' => :'String' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 257 def ==(other) return true if self.equal?(other) self.class == other.class && dml3_d_effects_rendering_mode == other.dml3_d_effects_rendering_mode && dml_effects_rendering_mode == other.dml_effects_rendering_mode && dml_rendering_mode == other.dml_rendering_mode && file_name == other.file_name && save_format == other.save_format && update_fields == other.update_fields && update_last_printed_property == other.update_last_printed_property && update_last_saved_time_property == other.update_last_saved_time_property && update_sdt_content == other.update_sdt_content && zip_output == other.zip_output && encoding == other.encoding && == other. && force_page_breaks == other.force_page_breaks && paragraph_break == other.paragraph_break end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 313 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 = AsposeWordsCloud.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
380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 380 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
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 291 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
278 279 280 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 278 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
284 285 286 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 284 def hash [dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, save_format, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, encoding, , force_page_breaks, paragraph_break].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
210 211 212 213 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 210 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
360 361 362 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 360 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
366 367 368 369 370 371 372 373 374 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 366 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
354 355 356 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 354 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
217 218 219 220 221 222 223 224 |
# File 'lib/aspose_words_cloud/models/txt_save_options_base_data.rb', line 217 def valid? dml3_d_effects_rendering_mode_validator = EnumAttributeValidator.new('String', ["Basic", "Advanced"]) return false unless dml3_d_effects_rendering_mode_validator.valid?(@dml3_d_effects_rendering_mode) = EnumAttributeValidator.new('String', ["None", "PrimaryOnly", "AllAtEnd"]) return false unless .valid?(@export_headers_footers_mode) return true end |