# ------------------------------------------------------------------------------------
#
# Copyright (c) 2024 Aspose.Words for Cloud
#
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#
# ------------------------------------------------------------------------------------
require 'date'
module AsposeWordsCloud
# Container class for fopc_template save options.
class FlatOpcTemplateSaveOptionsData
# 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.
attr_accessor :allow_embedding_post_script_fonts
# Gets or sets CustomTimeZoneInfo.
attr_accessor :custom_time_zone_info_data
# Gets or sets the value determining how 3D effects are rendered.
# The default value is Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic.
attr_accessor :dml3_d_effects_rendering_mode
# 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.
attr_accessor :dml_effects_rendering_mode
# 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.
attr_accessor :dml_rendering_mode
# Gets or sets the name of destination file.
attr_accessor :file_name
# Gets or sets the value determining how ink (InkML) objects are rendered.
# The default value is Aspose.Words.Saving.ImlRenderingMode.InkML.
attr_accessor :iml_rendering_mode
# Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving.
# Default value is false.
attr_accessor :update_created_time_property
# 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.
attr_accessor :update_fields
# Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.
attr_accessor :update_last_printed_property
# Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
# The default value is false.
attr_accessor :update_last_saved_time_property
# 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.
attr_accessor :zip_output
# Gets or sets the oOXML version for the output document.
attr_accessor :compliance
# Gets or sets the compression level.
attr_accessor :compression_level
# Gets or sets the password to encrypt document using ECMA376 Standard encryption algorithm.
attr_accessor :password
# Gets or sets a value indicating whether to use pretty formats output.
attr_accessor :pretty_format
# Gets the format of save.
attr_accessor :save_format
class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
def initialize(datatype, allowable_values)
@allowable_values = allowable_values.map do |value|
case datatype.to_s
when /Integer/i
value.to_i
when /Float/i
value.to_f
else
value
end
end
end
def valid?(value)
!value || allowable_values.include?(value)
end
end
# Attribute mapping from ruby-style variable name to JSON key.
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',
:'compliance' => :'Compliance',
:'compression_level' => :'CompressionLevel',
:'password' => :'Password',
:'pretty_format' => :'PrettyFormat',
:'save_format' => :'SaveFormat'
}
end
# Attribute type mapping.
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',
:'compliance' => :'String',
:'compression_level' => :'String',
:'password' => :'String',
:'pretty_format' => :'BOOLEAN',
:'save_format' => :'String'
}
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
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 = 'fopc_template'
if attributes.key?(:'AllowEmbeddingPostScriptFonts')
self.allow_embedding_post_script_fonts = 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?(:'Compliance')
self.compliance = attributes[:'Compliance']
end
if attributes.key?(:'CompressionLevel')
self.compression_level = attributes[:'CompressionLevel']
end
if attributes.key?(:'Password')
self.password = attributes[:'Password']
end
if attributes.key?(:'PrettyFormat')
self.pretty_format = attributes[:'PrettyFormat']
end
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
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)
compliance_validator = EnumAttributeValidator.new('String', ["Ecma376_2006", "Iso29500_2008_Transitional", "Iso29500_2008_Strict"])
return false unless compliance_validator.valid?(@compliance)
compression_level_validator = EnumAttributeValidator.new('String', ["Normal", "Maximum", "Fast", "SuperFast"])
return false unless compression_level_validator.valid?(@compression_level)
return true
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] dml3_d_effects_rendering_mode Object to be assigned
def dml3_d_effects_rendering_mode=(dml3_d_effects_rendering_mode)
validator = EnumAttributeValidator.new('String', ["Basic", "Advanced"])
if dml3_d_effects_rendering_mode.to_i == 0
unless validator.valid?(dml3_d_effects_rendering_mode)
raise ArgumentError, "invalid value for 'dml3_d_effects_rendering_mode', must be one of #{validator.allowable_values}."
end
@dml3_d_effects_rendering_mode = dml3_d_effects_rendering_mode
else
@dml3_d_effects_rendering_mode = validator.allowable_values[dml3_d_effects_rendering_mode.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] dml_effects_rendering_mode Object to be assigned
def dml_effects_rendering_mode=(dml_effects_rendering_mode)
validator = EnumAttributeValidator.new('String', ["Simplified", "None", "Fine"])
if dml_effects_rendering_mode.to_i == 0
unless validator.valid?(dml_effects_rendering_mode)
raise ArgumentError, "invalid value for 'dml_effects_rendering_mode', must be one of #{validator.allowable_values}."
end
@dml_effects_rendering_mode = dml_effects_rendering_mode
else
@dml_effects_rendering_mode = validator.allowable_values[dml_effects_rendering_mode.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] dml_rendering_mode Object to be assigned
def dml_rendering_mode=(dml_rendering_mode)
validator = EnumAttributeValidator.new('String', ["Fallback", "DrawingML"])
if dml_rendering_mode.to_i == 0
unless validator.valid?(dml_rendering_mode)
raise ArgumentError, "invalid value for 'dml_rendering_mode', must be one of #{validator.allowable_values}."
end
@dml_rendering_mode = dml_rendering_mode
else
@dml_rendering_mode = validator.allowable_values[dml_rendering_mode.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] iml_rendering_mode Object to be assigned
def iml_rendering_mode=(iml_rendering_mode)
validator = EnumAttributeValidator.new('String', ["Fallback", "InkML"])
if iml_rendering_mode.to_i == 0
unless validator.valid?(iml_rendering_mode)
raise ArgumentError, "invalid value for 'iml_rendering_mode', must be one of #{validator.allowable_values}."
end
@iml_rendering_mode = iml_rendering_mode
else
@iml_rendering_mode = validator.allowable_values[iml_rendering_mode.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] compliance Object to be assigned
def compliance=(compliance)
validator = EnumAttributeValidator.new('String', ["Ecma376_2006", "Iso29500_2008_Transitional", "Iso29500_2008_Strict"])
if compliance.to_i == 0
unless validator.valid?(compliance)
raise ArgumentError, "invalid value for 'compliance', must be one of #{validator.allowable_values}."
end
@compliance = compliance
else
@compliance = validator.allowable_values[compliance.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] compression_level Object to be assigned
def compression_level=(compression_level)
validator = EnumAttributeValidator.new('String', ["Normal", "Maximum", "Fast", "SuperFast"])
if compression_level.to_i == 0
unless validator.valid?(compression_level)
raise ArgumentError, "invalid value for 'compression_level', must be one of #{validator.allowable_values}."
end
@compression_level = compression_level
else
@compression_level = validator.allowable_values[compression_level.to_i]
end
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(other)
return true if self.equal?(other)
self.class == other.class &&
allow_embedding_post_script_fonts == other.allow_embedding_post_script_fonts &&
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 &&
compliance == other.compliance &&
compression_level == other.compression_level &&
password == other.password &&
pretty_format == other.pretty_format &&
save_format == other.save_format
end
# @see the `==` method
# @param [Object] Object to be compared
def eql?(other)
self == other
end
# Calculates hash code according to all attributes.
# @return [Fixnum] Hash code
def hash
[allow_embedding_post_script_fonts, 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, compliance, compression_level, password, pretty_format, save_format].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
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
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
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<(?.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?.+?), (?.+)>\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
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
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
# 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
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
def collectFilesContent(resultFilesContent)
end
def validate()
raise ArgumentError, 'Property file_name in FlatOpcTemplateSaveOptionsData is required.' if self.file_name.nil?
unless self.custom_time_zone_info_data.nil?
self.custom_time_zone_info_data.validate
end
end
end
end