Class: WordsRubySdk::HtmlSaveOptionsData
- Inherits:
-
Object
- Object
- WordsRubySdk::HtmlSaveOptionsData
- Defined in:
- lib/words_ruby_sdk/models/html_save_options_data.rb
Overview
container class for html save options
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#allow_negative_indent ⇒ Object
Specifies whether negative left and right indents of paragraphs are allowed (not normalized).
-
#color_mode ⇒ Object
Gets or sets a value determining how colors are rendered.
-
#css_class_name_prefix ⇒ Object
Specifies a prefix which is added to all CSS class names.
-
#css_style_sheet_file_name ⇒ Object
Specifies the name of the CSS file written when the document is exported to HTML.
-
#css_style_sheet_type ⇒ Object
Specifies how CSS styles are exported.
-
#dml_effects_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML effects are rendered.
-
#dml_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML shapes are rendered.
-
#document_split_criteria ⇒ Object
Specifies how the document should be split when saving.
-
#document_split_heading_level ⇒ Object
Specifies the maximum level of headings at which to split the document.
-
#encoding ⇒ Object
Specifies the encoding to use when exporting.
-
#export_document_properties ⇒ Object
Specifies whether to export built-in and custom document properties.
-
#export_drop_down_form_field_as_text ⇒ Object
Controls how drop-down form fields are saved to HTML.
-
#export_font_resources ⇒ Object
Specifies whether font resources should be exported.
-
#export_fonts_as_base64 ⇒ Object
Specifies whether fonts resources should be embedded to HTML in Base64 encoding.
-
#export_headers_footers_mode ⇒ Object
Specifies how headers and footers are output.
-
#export_images_as_base64 ⇒ Object
Specifies whether images are saved in Base64 format.
-
#export_language_information ⇒ Object
Specifies whether language information is exported.
-
#export_list_labels ⇒ Object
Controls how list labels are output.
-
#export_original_url_for_linked_images ⇒ Object
Specifies whether original URL should be used as the URL of the linked images.
-
#export_page_margins ⇒ Object
Specifies whether page margins is exported to HTML, MHTML or EPUB.
-
#export_page_setup ⇒ Object
Specifies whether page setup is exported.
-
#export_relative_font_size ⇒ Object
Specifies whether font sizes should be output in relative units when saving.
-
#export_roundtrip_information ⇒ Object
Specifies whether to write the roundtrip information when saving to HTML Default value is true.
-
#export_text_box_as_svg ⇒ Object
Controls how textboxes represented by Aspose.Words.Drawing.Shape are saved to HTML, MHTML or EPUB.
-
#export_text_input_form_field_as_text ⇒ Object
Controls how text input form fields are saved.
-
#export_toc_page_numbers ⇒ Object
Specifies whether to write page numbers to table of contents when saving.
-
#export_xhtml_transitional ⇒ Object
Specifies whether to write the DOCTYPE declaration when saving.
-
#file_name ⇒ Object
name of destination file.
-
#font_resources_subsetting_size_threshold ⇒ Object
Controls which font resources need subsetting when saving.
-
#fonts_folder ⇒ Object
Specifies the physical folder where fonts are saved when exporting a document.
-
#fonts_folder_alias ⇒ Object
Specifies the name of the folder used to construct font URIs.
-
#html_version ⇒ Object
Specifies version of HTML standard that should be used when saving the document to HTML or MHTML.
-
#image_resolution ⇒ Object
Specifies the output resolution for images when exporting.
-
#images_folder ⇒ Object
Specifies the physical folder where images are saved when exporting a document.
-
#images_folder_alias ⇒ Object
Specifies the name of the folder used to construct image URIs.
-
#metafile_format ⇒ Object
Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
-
#office_math_output_mode ⇒ Object
Controls how OfficeMath objects are exported to HTML, MHTML or EPUB.
-
#pretty_format ⇒ Object
Specifies whether or not use pretty formats output.
-
#resource_folder ⇒ Object
Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML.
-
#resource_folder_alias ⇒ Object
Specifies the name of the folder used to construct URIs of all resources written into an HTML document.
-
#save_format ⇒ Object
format of save.
-
#scale_image_to_shape_size ⇒ Object
Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting.
-
#table_width_output_mode ⇒ Object
Controls how table, row and cell widths are exported.
-
#update_fields ⇒ Object
Gets or sets a value determining if fields should be updated before saving the document to a fixed page format.
-
#update_last_saved_time_property ⇒ Object
Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
-
#update_sdt_content ⇒ Object
Gets or sets value determining whether content of is updated before saving.
-
#zip_output ⇒ Object
Controls zip output or not.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ HtmlSaveOptionsData
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 = {}) ⇒ HtmlSaveOptionsData
Initializes the object
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 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 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 305 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?(:'ColorMode') self.color_mode = attributes[:'ColorMode'] end if attributes.key?(:'SaveFormat') self.save_format = attributes[:'SaveFormat'] end if attributes.key?(:'FileName') self.file_name = attributes[:'FileName'] end if attributes.key?(:'DmlRenderingMode') self.dml_rendering_mode = attributes[:'DmlRenderingMode'] end if attributes.key?(:'DmlEffectsRenderingMode') self.dml_effects_rendering_mode = attributes[:'DmlEffectsRenderingMode'] end if attributes.key?(:'ZipOutput') self.zip_output = attributes[:'ZipOutput'] 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?(:'UpdateFields') self.update_fields = attributes[:'UpdateFields'] 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. = 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?(:'ExportTextBoxAsSvg') self.export_text_box_as_svg = attributes[:'ExportTextBoxAsSvg'] 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. = 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?(:'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 end |
Instance Attribute Details
#allow_negative_indent ⇒ Object
Specifies whether negative left and right indents of paragraphs are allowed (not normalized)
62 63 64 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 62 def allow_negative_indent @allow_negative_indent end |
#color_mode ⇒ Object
Gets or sets a value determining how colors are rendered. { Normal | Grayscale}
35 36 37 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 35 def color_mode @color_mode end |
#css_class_name_prefix ⇒ Object
Specifies a prefix which is added to all CSS class names. 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.
65 66 67 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 65 def css_class_name_prefix @css_class_name_prefix end |
#css_style_sheet_file_name ⇒ Object
Specifies the name of the CSS file written when the document is exported to HTML
68 69 70 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 68 def css_style_sheet_file_name @css_style_sheet_file_name end |
#css_style_sheet_type ⇒ Object
Specifies how CSS styles are exported
71 72 73 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 71 def css_style_sheet_type @css_style_sheet_type end |
#dml_effects_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML effects are rendered. { Simplified | None | Fine }
47 48 49 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 47 def dml_effects_rendering_mode @dml_effects_rendering_mode end |
#dml_rendering_mode ⇒ Object
Gets or sets a value determining how DrawingML shapes are rendered. { Fallback | DrawingML }
44 45 46 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 44 def dml_rendering_mode @dml_rendering_mode end |
#document_split_criteria ⇒ Object
Specifies how the document should be split when saving
74 75 76 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 74 def document_split_criteria @document_split_criteria end |
#document_split_heading_level ⇒ Object
Specifies the maximum level of headings at which to split the document
77 78 79 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 77 def document_split_heading_level @document_split_heading_level end |
#encoding ⇒ Object
Specifies the encoding to use when exporting
80 81 82 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 80 def encoding @encoding end |
#export_document_properties ⇒ Object
Specifies whether to export built-in and custom document properties
83 84 85 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 83 def export_document_properties @export_document_properties end |
#export_drop_down_form_field_as_text ⇒ Object
Controls how drop-down form fields are saved to HTML. Default value is false.
86 87 88 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 86 def export_drop_down_form_field_as_text @export_drop_down_form_field_as_text end |
#export_font_resources ⇒ Object
Specifies whether font resources should be exported
89 90 91 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 89 def export_font_resources @export_font_resources end |
#export_fonts_as_base64 ⇒ Object
Specifies whether fonts resources should be embedded to HTML in Base64 encoding. Default is false.
92 93 94 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 92 def export_fonts_as_base64 @export_fonts_as_base64 end |
#export_headers_footers_mode ⇒ Object
Specifies how headers and footers are output
95 96 97 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 95 def @export_headers_footers_mode end |
#export_images_as_base64 ⇒ Object
Specifies whether images are saved in Base64 format
98 99 100 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 98 def export_images_as_base64 @export_images_as_base64 end |
#export_language_information ⇒ Object
Specifies whether language information is exported
101 102 103 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 101 def export_language_information @export_language_information end |
#export_list_labels ⇒ Object
Controls how list labels are output
104 105 106 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 104 def export_list_labels @export_list_labels end |
#export_original_url_for_linked_images ⇒ Object
Specifies whether original URL should be used as the URL of the linked images. Default value is false.
107 108 109 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 107 def export_original_url_for_linked_images @export_original_url_for_linked_images end |
#export_page_margins ⇒ Object
Specifies whether page margins is exported to HTML, MHTML or EPUB. Default is false.
110 111 112 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 110 def export_page_margins @export_page_margins end |
#export_page_setup ⇒ Object
Specifies whether page setup is exported
113 114 115 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 113 def export_page_setup @export_page_setup end |
#export_relative_font_size ⇒ Object
Specifies whether font sizes should be output in relative units when saving
116 117 118 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 116 def export_relative_font_size @export_relative_font_size end |
#export_roundtrip_information ⇒ Object
Specifies whether to write the roundtrip information when saving to HTML Default value is true.
119 120 121 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 119 def export_roundtrip_information @export_roundtrip_information end |
#export_text_box_as_svg ⇒ Object
Controls how textboxes represented by Aspose.Words.Drawing.Shape are saved to HTML, MHTML or EPUB. Default value is false. When set to true, exports textboxes as inline "svg" elements. When false, exports as "image" elements.
122 123 124 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 122 def export_text_box_as_svg @export_text_box_as_svg end |
#export_text_input_form_field_as_text ⇒ Object
Controls how text input form fields are saved
125 126 127 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 125 def export_text_input_form_field_as_text @export_text_input_form_field_as_text end |
#export_toc_page_numbers ⇒ Object
Specifies whether to write page numbers to table of contents when saving
128 129 130 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 128 def export_toc_page_numbers @export_toc_page_numbers end |
#export_xhtml_transitional ⇒ Object
Specifies whether to write the DOCTYPE declaration when saving
131 132 133 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 131 def export_xhtml_transitional @export_xhtml_transitional end |
#file_name ⇒ Object
name of destination file
41 42 43 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 41 def file_name @file_name end |
#font_resources_subsetting_size_threshold ⇒ Object
Controls which font resources need subsetting when saving
134 135 136 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 134 def font_resources_subsetting_size_threshold @font_resources_subsetting_size_threshold end |
#fonts_folder ⇒ Object
Specifies the physical folder where fonts are saved when exporting a document
137 138 139 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 137 def fonts_folder @fonts_folder end |
#fonts_folder_alias ⇒ Object
Specifies the name of the folder used to construct font URIs
140 141 142 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 140 def fonts_folder_alias @fonts_folder_alias end |
#html_version ⇒ Object
Specifies version of HTML standard that should be used when saving the document to HTML or MHTML. Default value is Aspose.Words.Saving.HtmlVersion.Xhtml.
143 144 145 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 143 def html_version @html_version end |
#image_resolution ⇒ Object
Specifies the output resolution for images when exporting
146 147 148 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 146 def image_resolution @image_resolution end |
#images_folder ⇒ Object
Specifies the physical folder where images are saved when exporting a document
149 150 151 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 149 def images_folder @images_folder end |
#images_folder_alias ⇒ Object
Specifies the name of the folder used to construct image URIs
152 153 154 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 152 def images_folder_alias @images_folder_alias end |
#metafile_format ⇒ Object
Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB. 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.
155 156 157 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 155 def @metafile_format end |
#office_math_output_mode ⇒ Object
Controls how OfficeMath objects are exported to HTML, MHTML or EPUB. Default value is HtmlOfficeMathOutputMode.Image.
158 159 160 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 158 def office_math_output_mode @office_math_output_mode end |
#pretty_format ⇒ Object
Specifies whether or not use pretty formats output
161 162 163 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 161 def pretty_format @pretty_format end |
#resource_folder ⇒ Object
Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document is exported to HTML. Default is an empty string.
164 165 166 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 164 def resource_folder @resource_folder end |
#resource_folder_alias ⇒ Object
Specifies the name of the folder used to construct URIs of all resources written into an HTML document. Default is an empty string.
167 168 169 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 167 def resource_folder_alias @resource_folder_alias end |
#save_format ⇒ Object
format of save
38 39 40 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 38 def save_format @save_format end |
#scale_image_to_shape_size ⇒ Object
Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting
170 171 172 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 170 def scale_image_to_shape_size @scale_image_to_shape_size end |
#table_width_output_mode ⇒ Object
Controls how table, row and cell widths are exported
173 174 175 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 173 def table_width_output_mode @table_width_output_mode end |
#update_fields ⇒ Object
Gets or sets a value determining if fields should be updated before saving the document to a fixed page format. Default value for this property is true
59 60 61 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 59 def update_fields @update_fields end |
#update_last_saved_time_property ⇒ Object
Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.
53 54 55 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 53 def update_last_saved_time_property @update_last_saved_time_property end |
#update_sdt_content ⇒ Object
Gets or sets value determining whether content of is updated before saving.
56 57 58 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 56 def update_sdt_content @update_sdt_content end |
#zip_output ⇒ Object
Controls zip output or not. Default value is false.
50 51 52 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 50 def zip_output @zip_output end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 198 def self.attribute_map { :'color_mode' => :'ColorMode', :'save_format' => :'SaveFormat', :'file_name' => :'FileName', :'dml_rendering_mode' => :'DmlRenderingMode', :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode', :'zip_output' => :'ZipOutput', :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty', :'update_sdt_content' => :'UpdateSdtContent', :'update_fields' => :'UpdateFields', :'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_box_as_svg' => :'ExportTextBoxAsSvg', :'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', :'resource_folder' => :'ResourceFolder', :'resource_folder_alias' => :'ResourceFolderAlias', :'scale_image_to_shape_size' => :'ScaleImageToShapeSize', :'table_width_output_mode' => :'TableWidthOutputMode' } end |
.swagger_types ⇒ Object
Attribute type mapping.
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 251 def self.swagger_types { :'color_mode' => :'String', :'save_format' => :'String', :'file_name' => :'String', :'dml_rendering_mode' => :'String', :'dml_effects_rendering_mode' => :'String', :'zip_output' => :'BOOLEAN', :'update_last_saved_time_property' => :'BOOLEAN', :'update_sdt_content' => :'BOOLEAN', :'update_fields' => :'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_box_as_svg' => :'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', :'resource_folder' => :'String', :'resource_folder_alias' => :'String', :'scale_image_to_shape_size' => :'BOOLEAN', :'table_width_output_mode' => :'String' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 564 def ==(other) return true if self.equal?(other) self.class == other.class && color_mode == other.color_mode && save_format == other.save_format && file_name == other.file_name && dml_rendering_mode == other.dml_rendering_mode && dml_effects_rendering_mode == other.dml_effects_rendering_mode && zip_output == other.zip_output && update_last_saved_time_property == other.update_last_saved_time_property && update_sdt_content == other.update_sdt_content && update_fields == other.update_fields && 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 && == other. && 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_box_as_svg == other.export_text_box_as_svg && 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 && == other. && office_math_output_mode == other.office_math_output_mode && pretty_format == other.pretty_format && 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 end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 653 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 = WordsRubySdk.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
720 721 722 723 724 725 726 727 728 729 730 731 732 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 720 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
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 631 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
618 619 620 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 618 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
624 625 626 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 624 def hash [color_mode, save_format, file_name, dml_rendering_mode, dml_effects_rendering_mode, zip_output, update_last_saved_time_property, update_sdt_content, update_fields, 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_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_box_as_svg, 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, , office_math_output_mode, pretty_format, resource_folder, resource_folder_alias, scale_image_to_shape_size, table_width_output_mode].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
503 504 505 506 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 503 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
700 701 702 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 700 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
706 707 708 709 710 711 712 713 714 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 706 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
694 695 696 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 694 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
510 511 512 513 514 515 516 517 518 |
# File 'lib/words_ruby_sdk/models/html_save_options_data.rb', line 510 def valid? html_version_validator = EnumAttributeValidator.new('String', %w["Xhtml", "Html5"]) return false unless html_version_validator.valid?(@html_version) = EnumAttributeValidator.new('String', %w["Png", "Svg", "EmfOrWmf"]) return false unless .valid?(@metafile_format) office_math_output_mode_validator = EnumAttributeValidator.new('String', %w["Image", "MathML", "Text"]) return false unless office_math_output_mode_validator.valid?(@office_math_output_mode) return true end |