# ------------------------------------------------------------------------------------
#
# 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 mhtml save options.
class MhtmlSaveOptionsData
# 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 a value indicating whether negative left and right indents of paragraphs are allowed (not normalized).
attr_accessor :allow_negative_indent
# Gets or sets the prefix which is added to all CSS class names. The default value is an empty string and generated CSS class names have no common prefix.
# If this value is not empty, all CSS classes generated by Aspose.Words will start with the specified prefix.This might be useful, for example, if you add custom CSS to generated documents and want to prevent class name conflicts.
# If the value is not null or empty, it must be a valid CSS identifier.
attr_accessor :css_class_name_prefix
# Gets or sets the name of the CSS file written when the document is exported to HTML.
attr_accessor :css_style_sheet_file_name
# Gets or sets the option that controls how the CSS styles are exported.
attr_accessor :css_style_sheet_type
# Gets or sets the option that controls how the document should be split when saving.
attr_accessor :document_split_criteria
# Gets or sets the maximum level of headings at which to split the document.
attr_accessor :document_split_heading_level
# Gets or sets the character encoding to use when exporting.
attr_accessor :encoding
# Gets or sets a value indicating whether to export built-in and custom document properties.
attr_accessor :export_document_properties
# Gets or sets the flag, that controls how drop-down form fields are saved to HTML.
# The default value is false.
# When set to true, exports drop-down form fields as normal text.
# When false, exports drop-down form fields as SELECT element in HTML.
attr_accessor :export_drop_down_form_field_as_text
# Gets or sets a value indicating whether font resources should be exported.
attr_accessor :export_font_resources
# Gets or sets a value indicating whether fonts resources should be embedded to HTML in Base64 encoding. The default value is false.
attr_accessor :export_fonts_as_base64
# Gets or sets the option that controls how headers and footers are exported.
attr_accessor :export_headers_footers_mode
# Gets or sets a value indicating whether images are saved in Base64 format.
attr_accessor :export_images_as_base64
# Gets or sets a value indicating whether language information is exported.
attr_accessor :export_language_information
# Gets or sets the option that controls how list labels are exported.
attr_accessor :export_list_labels
# Gets or sets a value indicating whether the original URL should be used as the URL of the linked images.
# The default value is false.
# If value is set to true - ResourceFolder value is used as the URL of linked images and linked images are not loaded into document's folder or ImagesFolder.If value is set to false - linked images are loaded into document's folder or ImagesFolder and URL of each linked image is constructed depending on document's folder, ImagesFolder and ImagesFolderAlias properties.
attr_accessor :export_original_url_for_linked_images
# Gets or sets a value indicating whether page margins are exported to HTML, MHTML or EPUB.
# The default value is false.
# Aspose.Words does not show area of page margins by default. If any elements are completely or partially clipped by the document edge the displayed area can be extended with this option.
attr_accessor :export_page_margins
# Gets or sets a value indicating whether page setup is exported.
attr_accessor :export_page_setup
# Gets or sets a value indicating whether font sizes should be output in relative units when saving.
attr_accessor :export_relative_font_size
# Gets or sets a value indicating whether to write the roundtrip information when saving to HTML. The default value is true.
# Saving of the roundtrip information allows to restore document properties such as tab stops, comments, headers and footers during the HTML documents loading back into a Document object.When true, the roundtrip information is exported as -aw-* CSS properties of the corresponding HTML elements.When false, causes no roundtrip information to be output into produced files.
attr_accessor :export_roundtrip_information
# Gets or sets the flag, that controls how text input form fields are saved.
attr_accessor :export_text_input_form_field_as_text
# Gets or sets a value indicating whether to write page numbers to table of contents when saving.
attr_accessor :export_toc_page_numbers
# Gets or sets a value indicating whether to write the DOCTYPE declaration when saving.
attr_accessor :export_xhtml_transitional
# Gets or sets the option that controls which font resources need subsetting when saving.
attr_accessor :font_resources_subsetting_size_threshold
# Gets or sets the physical folder where fonts are saved when exporting a document.
attr_accessor :fonts_folder
# Gets or sets the name of the folder used to construct font URIs.
attr_accessor :fonts_folder_alias
# Gets or sets the version of HTML standard, that should be used when saving the document to HTML or MHTML.
# Default value is Aspose.Words.Saving.HtmlVersion.Xhtml.
attr_accessor :html_version
# Gets or sets the output resolution for images when exporting.
attr_accessor :image_resolution
# Gets or sets the physical folder where images are saved when exporting a document.
attr_accessor :images_folder
# Gets or sets the name of the folder used to construct image URIs.
attr_accessor :images_folder_alias
# Gets or sets the options, that controls in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
# The default value is Aspose.Words.Saving.HtmlMetafileFormat.Png, meaning that metafiles are rendered to raster PNG images.
# Metafiles are not natively displayed by HTML browsers. By default, Aspose.Words converts WMF and EMF images into PNG files when exporting to HTML.Other options are to convert metafiles to SVG images or to export them as is without conversion.
# Some image transforms, in particular image cropping, will not be applied to metafile images if they are exported to HTML without conversion.
attr_accessor :metafile_format
# Gets or sets the option that controls how OfficeMath objects are exported to HTML, MHTML or EPUB. The default value is HtmlOfficeMathOutputMode.Image.
attr_accessor :office_math_output_mode
# Gets or sets a value indicating whether to use pretty formats output.
attr_accessor :pretty_format
# Gets or sets the flag that indicates whether backslash characters should be replaced with yen signs.
# Default value is false.
# By default, Aspose.Words mimics MS Word's behavior and doesn't replace backslash characters with yen signs in
# generated HTML documents. However, previous versions of Aspose.Words performed such replacements in certain
# scenarios. This flag enables backward compatibility with previous versions of Aspose.Words.
attr_accessor :replace_backslash_with_yen_sign
# Gets or sets a value indicating whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats.
# The default value is false.
attr_accessor :resolve_font_names
# Gets or sets the physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. The default value is an empty string.
attr_accessor :resource_folder
# Gets or sets the name of the folder used to construct URIs of all resources written into HTML document. The default value is an empty string.
attr_accessor :resource_folder_alias
# Gets or sets a value indicating whether images are scaled by Aspose.Words to the bounding shape size when exporting.
attr_accessor :scale_image_to_shape_size
# Gets or sets the option that controls how table, row and cell widths are exported.
attr_accessor :table_width_output_mode
# Gets or sets a value indicating whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML documents. The default value is false.
# By default, resources in MHTML documents are referenced by file name (for example, "image.png"), which are matched against "Content-Location" headers of MIME parts. This option enables an alternative method, where references to resource files are written as CID (Content-ID) URLs (for example, "cid:image.png") and are matched against "Content-ID" headers. In theory, there should be no difference between the two referencing methods and either of them should work fine in any browser or mail agent. In practice, however, some agents fail to fetch resources by file name. If your browser or mail agent refuses to load resources included in an MTHML document (doesn't show images or doesn't load CSS styles), try exporting the document with CID URLs.
attr_accessor :export_cid_urls_for_mhtml_resources
# 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',
:'allow_negative_indent' => :'AllowNegativeIndent',
:'css_class_name_prefix' => :'CssClassNamePrefix',
:'css_style_sheet_file_name' => :'CssStyleSheetFileName',
:'css_style_sheet_type' => :'CssStyleSheetType',
:'document_split_criteria' => :'DocumentSplitCriteria',
:'document_split_heading_level' => :'DocumentSplitHeadingLevel',
:'encoding' => :'Encoding',
:'export_document_properties' => :'ExportDocumentProperties',
:'export_drop_down_form_field_as_text' => :'ExportDropDownFormFieldAsText',
:'export_font_resources' => :'ExportFontResources',
:'export_fonts_as_base64' => :'ExportFontsAsBase64',
:'export_headers_footers_mode' => :'ExportHeadersFootersMode',
:'export_images_as_base64' => :'ExportImagesAsBase64',
:'export_language_information' => :'ExportLanguageInformation',
:'export_list_labels' => :'ExportListLabels',
:'export_original_url_for_linked_images' => :'ExportOriginalUrlForLinkedImages',
:'export_page_margins' => :'ExportPageMargins',
:'export_page_setup' => :'ExportPageSetup',
:'export_relative_font_size' => :'ExportRelativeFontSize',
:'export_roundtrip_information' => :'ExportRoundtripInformation',
:'export_text_input_form_field_as_text' => :'ExportTextInputFormFieldAsText',
:'export_toc_page_numbers' => :'ExportTocPageNumbers',
:'export_xhtml_transitional' => :'ExportXhtmlTransitional',
:'font_resources_subsetting_size_threshold' => :'FontResourcesSubsettingSizeThreshold',
:'fonts_folder' => :'FontsFolder',
:'fonts_folder_alias' => :'FontsFolderAlias',
:'html_version' => :'HtmlVersion',
:'image_resolution' => :'ImageResolution',
:'images_folder' => :'ImagesFolder',
:'images_folder_alias' => :'ImagesFolderAlias',
:'metafile_format' => :'MetafileFormat',
:'office_math_output_mode' => :'OfficeMathOutputMode',
:'pretty_format' => :'PrettyFormat',
:'replace_backslash_with_yen_sign' => :'ReplaceBackslashWithYenSign',
:'resolve_font_names' => :'ResolveFontNames',
:'resource_folder' => :'ResourceFolder',
:'resource_folder_alias' => :'ResourceFolderAlias',
:'scale_image_to_shape_size' => :'ScaleImageToShapeSize',
:'table_width_output_mode' => :'TableWidthOutputMode',
:'export_cid_urls_for_mhtml_resources' => :'ExportCidUrlsForMhtmlResources',
:'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',
:'allow_negative_indent' => :'BOOLEAN',
:'css_class_name_prefix' => :'String',
:'css_style_sheet_file_name' => :'String',
:'css_style_sheet_type' => :'String',
:'document_split_criteria' => :'String',
:'document_split_heading_level' => :'Integer',
:'encoding' => :'String',
:'export_document_properties' => :'BOOLEAN',
:'export_drop_down_form_field_as_text' => :'BOOLEAN',
:'export_font_resources' => :'BOOLEAN',
:'export_fonts_as_base64' => :'BOOLEAN',
:'export_headers_footers_mode' => :'String',
:'export_images_as_base64' => :'BOOLEAN',
:'export_language_information' => :'BOOLEAN',
:'export_list_labels' => :'String',
:'export_original_url_for_linked_images' => :'BOOLEAN',
:'export_page_margins' => :'BOOLEAN',
:'export_page_setup' => :'BOOLEAN',
:'export_relative_font_size' => :'BOOLEAN',
:'export_roundtrip_information' => :'BOOLEAN',
:'export_text_input_form_field_as_text' => :'BOOLEAN',
:'export_toc_page_numbers' => :'BOOLEAN',
:'export_xhtml_transitional' => :'BOOLEAN',
:'font_resources_subsetting_size_threshold' => :'Integer',
:'fonts_folder' => :'String',
:'fonts_folder_alias' => :'String',
:'html_version' => :'String',
:'image_resolution' => :'Integer',
:'images_folder' => :'String',
:'images_folder_alias' => :'String',
:'metafile_format' => :'String',
:'office_math_output_mode' => :'String',
:'pretty_format' => :'BOOLEAN',
:'replace_backslash_with_yen_sign' => :'BOOLEAN',
:'resolve_font_names' => :'BOOLEAN',
:'resource_folder' => :'String',
:'resource_folder_alias' => :'String',
:'scale_image_to_shape_size' => :'BOOLEAN',
:'table_width_output_mode' => :'String',
:'export_cid_urls_for_mhtml_resources' => :'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 = 'mht'
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?(:'AllowNegativeIndent')
self.allow_negative_indent = attributes[:'AllowNegativeIndent']
end
if attributes.key?(:'CssClassNamePrefix')
self.css_class_name_prefix = attributes[:'CssClassNamePrefix']
end
if attributes.key?(:'CssStyleSheetFileName')
self.css_style_sheet_file_name = attributes[:'CssStyleSheetFileName']
end
if attributes.key?(:'CssStyleSheetType')
self.css_style_sheet_type = attributes[:'CssStyleSheetType']
end
if attributes.key?(:'DocumentSplitCriteria')
self.document_split_criteria = attributes[:'DocumentSplitCriteria']
end
if attributes.key?(:'DocumentSplitHeadingLevel')
self.document_split_heading_level = attributes[:'DocumentSplitHeadingLevel']
end
if attributes.key?(:'Encoding')
self.encoding = attributes[:'Encoding']
end
if attributes.key?(:'ExportDocumentProperties')
self.export_document_properties = attributes[:'ExportDocumentProperties']
end
if attributes.key?(:'ExportDropDownFormFieldAsText')
self.export_drop_down_form_field_as_text = attributes[:'ExportDropDownFormFieldAsText']
end
if attributes.key?(:'ExportFontResources')
self.export_font_resources = attributes[:'ExportFontResources']
end
if attributes.key?(:'ExportFontsAsBase64')
self.export_fonts_as_base64 = attributes[:'ExportFontsAsBase64']
end
if attributes.key?(:'ExportHeadersFootersMode')
self.export_headers_footers_mode = attributes[:'ExportHeadersFootersMode']
end
if attributes.key?(:'ExportImagesAsBase64')
self.export_images_as_base64 = attributes[:'ExportImagesAsBase64']
end
if attributes.key?(:'ExportLanguageInformation')
self.export_language_information = attributes[:'ExportLanguageInformation']
end
if attributes.key?(:'ExportListLabels')
self.export_list_labels = attributes[:'ExportListLabels']
end
if attributes.key?(:'ExportOriginalUrlForLinkedImages')
self.export_original_url_for_linked_images = attributes[:'ExportOriginalUrlForLinkedImages']
end
if attributes.key?(:'ExportPageMargins')
self.export_page_margins = attributes[:'ExportPageMargins']
end
if attributes.key?(:'ExportPageSetup')
self.export_page_setup = attributes[:'ExportPageSetup']
end
if attributes.key?(:'ExportRelativeFontSize')
self.export_relative_font_size = attributes[:'ExportRelativeFontSize']
end
if attributes.key?(:'ExportRoundtripInformation')
self.export_roundtrip_information = attributes[:'ExportRoundtripInformation']
end
if attributes.key?(:'ExportTextInputFormFieldAsText')
self.export_text_input_form_field_as_text = attributes[:'ExportTextInputFormFieldAsText']
end
if attributes.key?(:'ExportTocPageNumbers')
self.export_toc_page_numbers = attributes[:'ExportTocPageNumbers']
end
if attributes.key?(:'ExportXhtmlTransitional')
self.export_xhtml_transitional = attributes[:'ExportXhtmlTransitional']
end
if attributes.key?(:'FontResourcesSubsettingSizeThreshold')
self.font_resources_subsetting_size_threshold = attributes[:'FontResourcesSubsettingSizeThreshold']
end
if attributes.key?(:'FontsFolder')
self.fonts_folder = attributes[:'FontsFolder']
end
if attributes.key?(:'FontsFolderAlias')
self.fonts_folder_alias = attributes[:'FontsFolderAlias']
end
if attributes.key?(:'HtmlVersion')
self.html_version = attributes[:'HtmlVersion']
end
if attributes.key?(:'ImageResolution')
self.image_resolution = attributes[:'ImageResolution']
end
if attributes.key?(:'ImagesFolder')
self.images_folder = attributes[:'ImagesFolder']
end
if attributes.key?(:'ImagesFolderAlias')
self.images_folder_alias = attributes[:'ImagesFolderAlias']
end
if attributes.key?(:'MetafileFormat')
self.metafile_format = attributes[:'MetafileFormat']
end
if attributes.key?(:'OfficeMathOutputMode')
self.office_math_output_mode = attributes[:'OfficeMathOutputMode']
end
if attributes.key?(:'PrettyFormat')
self.pretty_format = attributes[:'PrettyFormat']
end
if attributes.key?(:'ReplaceBackslashWithYenSign')
self.replace_backslash_with_yen_sign = attributes[:'ReplaceBackslashWithYenSign']
end
if attributes.key?(:'ResolveFontNames')
self.resolve_font_names = attributes[:'ResolveFontNames']
end
if attributes.key?(:'ResourceFolder')
self.resource_folder = attributes[:'ResourceFolder']
end
if attributes.key?(:'ResourceFolderAlias')
self.resource_folder_alias = attributes[:'ResourceFolderAlias']
end
if attributes.key?(:'ScaleImageToShapeSize')
self.scale_image_to_shape_size = attributes[:'ScaleImageToShapeSize']
end
if attributes.key?(:'TableWidthOutputMode')
self.table_width_output_mode = attributes[:'TableWidthOutputMode']
end
if attributes.key?(:'ExportCidUrlsForMhtmlResources')
self.export_cid_urls_for_mhtml_resources = attributes[:'ExportCidUrlsForMhtmlResources']
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)
css_style_sheet_type_validator = EnumAttributeValidator.new('String', ["Inline", "Embedded", "External"])
return false unless css_style_sheet_type_validator.valid?(@css_style_sheet_type)
document_split_criteria_validator = EnumAttributeValidator.new('String', ["None", "PageBreak", "ColumnBreak", "SectionBreak", "HeadingParagraph"])
return false unless document_split_criteria_validator.valid?(@document_split_criteria)
export_headers_footers_mode_validator = EnumAttributeValidator.new('String', ["None", "PerSection", "FirstSectionHeaderLastSectionFooter", "FirstPageHeaderFooterPerSection"])
return false unless export_headers_footers_mode_validator.valid?(@export_headers_footers_mode)
export_list_labels_validator = EnumAttributeValidator.new('String', ["Auto", "AsInlineText", "ByHtmlTags"])
return false unless export_list_labels_validator.valid?(@export_list_labels)
html_version_validator = EnumAttributeValidator.new('String', ["Xhtml", "Html5"])
return false unless html_version_validator.valid?(@html_version)
metafile_format_validator = EnumAttributeValidator.new('String', ["Png", "Svg", "EmfOrWmf"])
return false unless metafile_format_validator.valid?(@metafile_format)
office_math_output_mode_validator = EnumAttributeValidator.new('String', ["Image", "MathML", "Text"])
return false unless office_math_output_mode_validator.valid?(@office_math_output_mode)
table_width_output_mode_validator = EnumAttributeValidator.new('String', ["All", "RelativeOnly", "None"])
return false unless table_width_output_mode_validator.valid?(@table_width_output_mode)
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] css_style_sheet_type Object to be assigned
def css_style_sheet_type=(css_style_sheet_type)
validator = EnumAttributeValidator.new('String', ["Inline", "Embedded", "External"])
if css_style_sheet_type.to_i == 0
unless validator.valid?(css_style_sheet_type)
raise ArgumentError, "invalid value for 'css_style_sheet_type', must be one of #{validator.allowable_values}."
end
@css_style_sheet_type = css_style_sheet_type
else
@css_style_sheet_type = validator.allowable_values[css_style_sheet_type.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] document_split_criteria Object to be assigned
def document_split_criteria=(document_split_criteria)
validator = EnumAttributeValidator.new('String', ["None", "PageBreak", "ColumnBreak", "SectionBreak", "HeadingParagraph"])
if document_split_criteria.to_i == 0
unless validator.valid?(document_split_criteria)
raise ArgumentError, "invalid value for 'document_split_criteria', must be one of #{validator.allowable_values}."
end
@document_split_criteria = document_split_criteria
else
@document_split_criteria = validator.allowable_values[document_split_criteria.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] export_headers_footers_mode Object to be assigned
def export_headers_footers_mode=(export_headers_footers_mode)
validator = EnumAttributeValidator.new('String', ["None", "PerSection", "FirstSectionHeaderLastSectionFooter", "FirstPageHeaderFooterPerSection"])
if export_headers_footers_mode.to_i == 0
unless validator.valid?(export_headers_footers_mode)
raise ArgumentError, "invalid value for 'export_headers_footers_mode', must be one of #{validator.allowable_values}."
end
@export_headers_footers_mode = export_headers_footers_mode
else
@export_headers_footers_mode = validator.allowable_values[export_headers_footers_mode.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] export_list_labels Object to be assigned
def export_list_labels=(export_list_labels)
validator = EnumAttributeValidator.new('String', ["Auto", "AsInlineText", "ByHtmlTags"])
if export_list_labels.to_i == 0
unless validator.valid?(export_list_labels)
raise ArgumentError, "invalid value for 'export_list_labels', must be one of #{validator.allowable_values}."
end
@export_list_labels = export_list_labels
else
@export_list_labels = validator.allowable_values[export_list_labels.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] html_version Object to be assigned
def html_version=(html_version)
validator = EnumAttributeValidator.new('String', ["Xhtml", "Html5"])
if html_version.to_i == 0
unless validator.valid?(html_version)
raise ArgumentError, "invalid value for 'html_version', must be one of #{validator.allowable_values}."
end
@html_version = html_version
else
@html_version = validator.allowable_values[html_version.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] metafile_format Object to be assigned
def metafile_format=(metafile_format)
validator = EnumAttributeValidator.new('String', ["Png", "Svg", "EmfOrWmf"])
if metafile_format.to_i == 0
unless validator.valid?(metafile_format)
raise ArgumentError, "invalid value for 'metafile_format', must be one of #{validator.allowable_values}."
end
@metafile_format = metafile_format
else
@metafile_format = validator.allowable_values[metafile_format.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] office_math_output_mode Object to be assigned
def office_math_output_mode=(office_math_output_mode)
validator = EnumAttributeValidator.new('String', ["Image", "MathML", "Text"])
if office_math_output_mode.to_i == 0
unless validator.valid?(office_math_output_mode)
raise ArgumentError, "invalid value for 'office_math_output_mode', must be one of #{validator.allowable_values}."
end
@office_math_output_mode = office_math_output_mode
else
@office_math_output_mode = validator.allowable_values[office_math_output_mode.to_i]
end
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] table_width_output_mode Object to be assigned
def table_width_output_mode=(table_width_output_mode)
validator = EnumAttributeValidator.new('String', ["All", "RelativeOnly", "None"])
if table_width_output_mode.to_i == 0
unless validator.valid?(table_width_output_mode)
raise ArgumentError, "invalid value for 'table_width_output_mode', must be one of #{validator.allowable_values}."
end
@table_width_output_mode = table_width_output_mode
else
@table_width_output_mode = validator.allowable_values[table_width_output_mode.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 &&
allow_negative_indent == other.allow_negative_indent &&
css_class_name_prefix == other.css_class_name_prefix &&
css_style_sheet_file_name == other.css_style_sheet_file_name &&
css_style_sheet_type == other.css_style_sheet_type &&
document_split_criteria == other.document_split_criteria &&
document_split_heading_level == other.document_split_heading_level &&
encoding == other.encoding &&
export_document_properties == other.export_document_properties &&
export_drop_down_form_field_as_text == other.export_drop_down_form_field_as_text &&
export_font_resources == other.export_font_resources &&
export_fonts_as_base64 == other.export_fonts_as_base64 &&
export_headers_footers_mode == other.export_headers_footers_mode &&
export_images_as_base64 == other.export_images_as_base64 &&
export_language_information == other.export_language_information &&
export_list_labels == other.export_list_labels &&
export_original_url_for_linked_images == other.export_original_url_for_linked_images &&
export_page_margins == other.export_page_margins &&
export_page_setup == other.export_page_setup &&
export_relative_font_size == other.export_relative_font_size &&
export_roundtrip_information == other.export_roundtrip_information &&
export_text_input_form_field_as_text == other.export_text_input_form_field_as_text &&
export_toc_page_numbers == other.export_toc_page_numbers &&
export_xhtml_transitional == other.export_xhtml_transitional &&
font_resources_subsetting_size_threshold == other.font_resources_subsetting_size_threshold &&
fonts_folder == other.fonts_folder &&
fonts_folder_alias == other.fonts_folder_alias &&
html_version == other.html_version &&
image_resolution == other.image_resolution &&
images_folder == other.images_folder &&
images_folder_alias == other.images_folder_alias &&
metafile_format == other.metafile_format &&
office_math_output_mode == other.office_math_output_mode &&
pretty_format == other.pretty_format &&
replace_backslash_with_yen_sign == other.replace_backslash_with_yen_sign &&
resolve_font_names == other.resolve_font_names &&
resource_folder == other.resource_folder &&
resource_folder_alias == other.resource_folder_alias &&
scale_image_to_shape_size == other.scale_image_to_shape_size &&
table_width_output_mode == other.table_width_output_mode &&
export_cid_urls_for_mhtml_resources == other.export_cid_urls_for_mhtml_resources &&
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, allow_negative_indent, css_class_name_prefix, css_style_sheet_file_name, css_style_sheet_type, document_split_criteria, document_split_heading_level, encoding, export_document_properties, export_drop_down_form_field_as_text, export_font_resources, export_fonts_as_base64, export_headers_footers_mode, export_images_as_base64, export_language_information, export_list_labels, export_original_url_for_linked_images, export_page_margins, export_page_setup, export_relative_font_size, export_roundtrip_information, export_text_input_form_field_as_text, export_toc_page_numbers, export_xhtml_transitional, font_resources_subsetting_size_threshold, fonts_folder, fonts_folder_alias, html_version, image_resolution, images_folder, images_folder_alias, metafile_format, office_math_output_mode, pretty_format, replace_backslash_with_yen_sign, resolve_font_names, resource_folder, resource_folder_alias, scale_image_to_shape_size, table_width_output_mode, export_cid_urls_for_mhtml_resources, 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 MhtmlSaveOptionsData 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