Class: AsposeWordsCloud::DocSaveOptionsData
- Inherits:
-
Object
- Object
- AsposeWordsCloud::DocSaveOptionsData
- Defined in:
- lib/aspose_words_cloud/models/doc_save_options_data.rb
Overview
Container class for doc/dot save options.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#allow_embedding_post_script_fonts ⇒ Object
Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved.
-
#always_compress_metafiles ⇒ Object
Gets or sets a value indicating when False, that small metafiles are not compressed for performance reason.
-
#custom_time_zone_info_data ⇒ Object
Gets or sets CustomTimeZoneInfo.
-
#dml3_d_effects_rendering_mode ⇒ Object
Gets or sets the value determining how 3D effects are rendered.
-
#dml_effects_rendering_mode ⇒ Object
Gets or sets the value determining how DrawingML effects are rendered.
-
#dml_rendering_mode ⇒ Object
Gets or sets the option that controls how DrawingML shapes are rendered.
-
#file_name ⇒ Object
Gets or sets the name of destination file.
-
#flat_opc_xml_mapping_only ⇒ Object
Gets or sets value determining which document formats are allowed to be mapped by Aspose.Words.Markup.StructuredDocumentTag.XmlMapping.
-
#iml_rendering_mode ⇒ Object
Gets or sets the value determining how ink (InkML) objects are rendered.
-
#password ⇒ Object
Gets or sets the password.
-
#save_format ⇒ Object
Gets or sets the format of save.
-
#save_picture_bullet ⇒ Object
Gets or sets a value indicating when False, that PictureBullet data is not saved to the output document.
-
#save_routing_slip ⇒ Object
Gets or sets a value indicating whether to save RoutingSlip data to output document.
-
#update_created_time_property ⇒ Object
Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
-
#update_fields ⇒ Object
Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format.
-
#update_last_printed_property ⇒ Object
Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
-
#update_last_saved_time_property ⇒ Object
Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
-
#update_sdt_content ⇒ Object
Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.
-
#zip_output ⇒ Object
Gets or sets a value indicating whether to 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 = {}) ⇒ DocSaveOptionsData
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 = {}) ⇒ DocSaveOptionsData
Initializes the object
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 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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 169 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?(:'AllowEmbeddingPostScriptFonts') self. = attributes[:'AllowEmbeddingPostScriptFonts'] end if attributes.key?(:'CustomTimeZoneInfoData') self.custom_time_zone_info_data = attributes[:'CustomTimeZoneInfoData'] end 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?(:'FlatOpcXmlMappingOnly') self.flat_opc_xml_mapping_only = attributes[:'FlatOpcXmlMappingOnly'] end if attributes.key?(:'ImlRenderingMode') self.iml_rendering_mode = attributes[:'ImlRenderingMode'] end if attributes.key?(:'SaveFormat') self.save_format = attributes[:'SaveFormat'] end if attributes.key?(:'UpdateCreatedTimeProperty') self.update_created_time_property = attributes[:'UpdateCreatedTimeProperty'] 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?(:'AlwaysCompressMetafiles') self. = attributes[:'AlwaysCompressMetafiles'] end if attributes.key?(:'Password') self.password = attributes[:'Password'] end if attributes.key?(:'SavePictureBullet') self.save_picture_bullet = attributes[:'SavePictureBullet'] end if attributes.key?(:'SaveRoutingSlip') self.save_routing_slip = attributes[:'SaveRoutingSlip'] end end |
Instance Attribute Details
#allow_embedding_post_script_fonts ⇒ Object
Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..
33 34 35 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 33 def @allow_embedding_post_script_fonts end |
#always_compress_metafiles ⇒ Object
Gets or sets a value indicating when False, that small metafiles are not compressed for performance reason. The default value is true, all metafiles are compressed regardless of its size.
83 84 85 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 83 def @always_compress_metafiles end |
#custom_time_zone_info_data ⇒ Object
Gets or sets CustomTimeZoneInfo.
36 37 38 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 36 def custom_time_zone_info_data @custom_time_zone_info_data end |
#dml3_d_effects_rendering_mode ⇒ Object
Gets or sets the value determining how 3D effects are rendered.
39 40 41 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 39 def dml3_d_effects_rendering_mode @dml3_d_effects_rendering_mode end |
#dml_effects_rendering_mode ⇒ Object
Gets or sets the value determining how DrawingML effects are rendered. { Simplified | None | Fine }.
43 44 45 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 43 def dml_effects_rendering_mode @dml_effects_rendering_mode end |
#dml_rendering_mode ⇒ Object
Gets or sets the option that controls how DrawingML shapes are rendered.
46 47 48 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 46 def dml_rendering_mode @dml_rendering_mode end |
#file_name ⇒ Object
Gets or sets the name of destination file.
49 50 51 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 49 def file_name @file_name end |
#flat_opc_xml_mapping_only ⇒ Object
Gets or sets value determining which document formats are allowed to be mapped by Aspose.Words.Markup.StructuredDocumentTag.XmlMapping. By default only Aspose.Words.LoadFormat.FlatOpc document format is allowed to be mapped.
53 54 55 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 53 def flat_opc_xml_mapping_only @flat_opc_xml_mapping_only end |
#iml_rendering_mode ⇒ Object
Gets or sets the value determining how ink (InkML) objects are rendered.
56 57 58 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 56 def iml_rendering_mode @iml_rendering_mode end |
#password ⇒ Object
Gets or sets the password.
86 87 88 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 86 def password @password end |
#save_format ⇒ Object
Gets or sets the format of save.
59 60 61 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 59 def save_format @save_format end |
#save_picture_bullet ⇒ Object
Gets or sets a value indicating when False, that PictureBullet data is not saved to the output document. The default value is true.
90 91 92 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 90 def save_picture_bullet @save_picture_bullet end |
#save_routing_slip ⇒ Object
Gets or sets a value indicating whether to save RoutingSlip data to output document.
93 94 95 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 93 def save_routing_slip @save_routing_slip end |
#update_created_time_property ⇒ Object
Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false.
63 64 65 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 63 def update_created_time_property @update_created_time_property end |
#update_fields ⇒ Object
Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.
66 67 68 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 66 def update_fields @update_fields end |
#update_last_printed_property ⇒ Object
Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
69 70 71 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 69 def update_last_printed_property @update_last_printed_property end |
#update_last_saved_time_property ⇒ Object
Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
72 73 74 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 72 def update_last_saved_time_property @update_last_saved_time_property end |
#update_sdt_content ⇒ Object
Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.
75 76 77 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 75 def update_sdt_content @update_sdt_content end |
#zip_output ⇒ Object
Gets or sets a value indicating whether to zip output or not. The default value is false.
79 80 81 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 79 def zip_output @zip_output end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 118 def self.attribute_map { :'allow_embedding_post_script_fonts' => :'AllowEmbeddingPostScriptFonts', :'custom_time_zone_info_data' => :'CustomTimeZoneInfoData', :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode', :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode', :'dml_rendering_mode' => :'DmlRenderingMode', :'file_name' => :'FileName', :'flat_opc_xml_mapping_only' => :'FlatOpcXmlMappingOnly', :'iml_rendering_mode' => :'ImlRenderingMode', :'save_format' => :'SaveFormat', :'update_created_time_property' => :'UpdateCreatedTimeProperty', :'update_fields' => :'UpdateFields', :'update_last_printed_property' => :'UpdateLastPrintedProperty', :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty', :'update_sdt_content' => :'UpdateSdtContent', :'zip_output' => :'ZipOutput', :'always_compress_metafiles' => :'AlwaysCompressMetafiles', :'password' => :'Password', :'save_picture_bullet' => :'SavePictureBullet', :'save_routing_slip' => :'SaveRoutingSlip' } end |
.swagger_types ⇒ Object
Attribute type mapping.
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 143 def self.swagger_types { :'allow_embedding_post_script_fonts' => :'BOOLEAN', :'custom_time_zone_info_data' => :'TimeZoneInfoData', :'dml3_d_effects_rendering_mode' => :'String', :'dml_effects_rendering_mode' => :'String', :'dml_rendering_mode' => :'String', :'file_name' => :'String', :'flat_opc_xml_mapping_only' => :'BOOLEAN', :'iml_rendering_mode' => :'String', :'save_format' => :'String', :'update_created_time_property' => :'BOOLEAN', :'update_fields' => :'BOOLEAN', :'update_last_printed_property' => :'BOOLEAN', :'update_last_saved_time_property' => :'BOOLEAN', :'update_sdt_content' => :'BOOLEAN', :'zip_output' => :'BOOLEAN', :'always_compress_metafiles' => :'BOOLEAN', :'password' => :'String', :'save_picture_bullet' => :'BOOLEAN', :'save_routing_slip' => :'BOOLEAN' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 285 def ==(other) return true if self.equal?(other) self.class == other.class && == other. && custom_time_zone_info_data == other.custom_time_zone_info_data && 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 && flat_opc_xml_mapping_only == other.flat_opc_xml_mapping_only && iml_rendering_mode == other.iml_rendering_mode && save_format == other.save_format && update_created_time_property == other.update_created_time_property && 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 && == other. && password == other.password && save_picture_bullet == other.save_picture_bullet && save_routing_slip == other.save_routing_slip end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 346 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
413 414 415 416 417 418 419 420 421 422 423 424 425 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 413 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
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 324 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
311 312 313 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 311 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
317 318 319 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 317 def hash [, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, flat_opc_xml_mapping_only, iml_rendering_mode, save_format, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, , password, save_picture_bullet, save_routing_slip].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
254 255 256 257 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 254 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
393 394 395 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 393 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
399 400 401 402 403 404 405 406 407 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 399 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
387 388 389 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 387 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
261 262 263 264 265 266 |
# File 'lib/aspose_words_cloud/models/doc_save_options_data.rb', line 261 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) return true end |