Class: AsposeWordsCloud::XamlFlowPackSaveOptionsData
- Inherits:
-
Object
- Object
- AsposeWordsCloud::XamlFlowPackSaveOptionsData
- Defined in:
- lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb
Overview
Container class for xamlflow_pack 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.
-
#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.
-
#images_folder ⇒ Object
Gets or sets the physical folder where images are saved when exporting.
-
#images_folder_alias ⇒ Object
Gets or sets the name of the folder used to construct image URIs.
-
#iml_rendering_mode ⇒ Object
Gets or sets the value determining how ink (InkML) objects are rendered.
-
#save_format ⇒ Object
Gets the format of save.
-
#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.
-
#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.
- #collectFilesContent(resultFilesContent) ⇒ Object
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ XamlFlowPackSaveOptionsData
constructor
Initializes the object.
-
#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.
- #validate ⇒ Object
Constructor Details
#initialize(attributes = {}) ⇒ XamlFlowPackSaveOptionsData
Initializes the object
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 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 157 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 } self.save_format = 'xamlflow_pack' 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?(:'ImlRenderingMode') self.iml_rendering_mode = attributes[:'ImlRenderingMode'] 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?(:'ZipOutput') self.zip_output = attributes[:'ZipOutput'] end if attributes.key?(:'ImagesFolder') self.images_folder = attributes[:'ImagesFolder'] end if attributes.key?(:'ImagesFolderAlias') self.images_folder_alias = attributes[:'ImagesFolderAlias'] 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.. Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type. This option only works when Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts of the Aspose.Words.DocumentBase.FontInfos property is set to true. The default value is false.
36 37 38 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 36 def @allow_embedding_post_script_fonts end |
#custom_time_zone_info_data ⇒ Object
Gets or sets CustomTimeZoneInfo.
39 40 41 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 39 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. The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.
43 44 45 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 43 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 }. The default value is Simplified. This property is used when the document is exported to fixed page formats.
49 50 51 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 49 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. { Fallback | DrawingML }. The default value is Fallback. This property is used when the document is exported to fixed page formats.
54 55 56 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 54 def dml_rendering_mode @dml_rendering_mode end |
#file_name ⇒ Object
Gets or sets the name of destination file.
57 58 59 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 57 def file_name @file_name end |
#images_folder ⇒ Object
Gets or sets the physical folder where images are saved when exporting.
83 84 85 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 83 def images_folder @images_folder end |
#images_folder_alias ⇒ Object
Gets or sets the name of the folder used to construct image URIs.
86 87 88 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 86 def images_folder_alias @images_folder_alias end |
#iml_rendering_mode ⇒ Object
Gets or sets the value determining how ink (InkML) objects are rendered. The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.
61 62 63 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 61 def iml_rendering_mode @iml_rendering_mode end |
#save_format ⇒ Object
Gets the format of save.
89 90 91 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 89 def save_format @save_format 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.
65 66 67 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 65 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.
68 69 70 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 68 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.
71 72 73 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 71 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. The default value is false.
75 76 77 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 75 def update_last_saved_time_property @update_last_saved_time_property end |
#zip_output ⇒ Object
Gets or sets a value indicating whether to zip output or not. The default value is false. When set to true, output files will be zipped.
80 81 82 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 80 def zip_output @zip_output end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 114 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', :'iml_rendering_mode' => :'ImlRenderingMode', :'update_created_time_property' => :'UpdateCreatedTimeProperty', :'update_fields' => :'UpdateFields', :'update_last_printed_property' => :'UpdateLastPrintedProperty', :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty', :'zip_output' => :'ZipOutput', :'images_folder' => :'ImagesFolder', :'images_folder_alias' => :'ImagesFolderAlias', :'save_format' => :'SaveFormat' } end |
.swagger_types ⇒ Object
Attribute type mapping.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 135 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', :'iml_rendering_mode' => :'String', :'update_created_time_property' => :'BOOLEAN', :'update_fields' => :'BOOLEAN', :'update_last_printed_property' => :'BOOLEAN', :'update_last_saved_time_property' => :'BOOLEAN', :'zip_output' => :'BOOLEAN', :'images_folder' => :'String', :'images_folder_alias' => :'String', :'save_format' => :'String' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 296 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 && iml_rendering_mode == other.iml_rendering_mode && 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 && zip_output == other.zip_output && images_folder == other.images_folder && images_folder_alias == other.images_folder_alias && save_format == other.save_format end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 353 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 if value[:'$type'] type = value[:'$type'][0..-4] end 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
424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 424 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
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 331 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 |
#collectFilesContent(resultFilesContent) ⇒ Object
438 439 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 438 def collectFilesContent(resultFilesContent) end |
#eql?(other) ⇒ Boolean
318 319 320 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 318 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
324 325 326 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 324 def hash [, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, iml_rendering_mode, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, zip_output, images_folder, images_folder_alias, save_format].hash end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
404 405 406 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 404 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
410 411 412 413 414 415 416 417 418 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 410 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
398 399 400 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 398 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 224 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) dml_effects_rendering_mode_validator = EnumAttributeValidator.new('String', ["Simplified", "None", "Fine"]) return false unless dml_effects_rendering_mode_validator.valid?(@dml_effects_rendering_mode) dml_rendering_mode_validator = EnumAttributeValidator.new('String', ["Fallback", "DrawingML"]) return false unless dml_rendering_mode_validator.valid?(@dml_rendering_mode) iml_rendering_mode_validator = EnumAttributeValidator.new('String', ["Fallback", "InkML"]) return false unless iml_rendering_mode_validator.valid?(@iml_rendering_mode) return true end |
#validate ⇒ Object
441 442 443 444 445 446 447 |
# File 'lib/aspose_words_cloud/models/xaml_flow_pack_save_options_data.rb', line 441 def validate() raise ArgumentError, 'Property file_name in XamlFlowPackSaveOptionsData is required.' if self.file_name.nil? unless self.custom_time_zone_info_data.nil? self.custom_time_zone_info_data.validate end end |