Class: WordsRubySdk::PutDocumentSaveAsTiffRequest
- Inherits:
-
Object
- Object
- WordsRubySdk::PutDocumentSaveAsTiffRequest
- Defined in:
- lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb
Overview
Request model for put_document_save_as_tiff operation.
Instance Attribute Summary collapse
-
#dest_file_name ⇒ Object
Result name of the document after the operation.
-
#dml_effects_rendering_mode ⇒ Object
Optional, default is Simplified.
-
#dml_rendering_mode ⇒ Object
Optional, default is Fallback.
-
#folder ⇒ Object
Original document folder.
-
#fonts_location ⇒ Object
Folder in filestorage with custom fonts.
-
#image_brightness ⇒ Object
Brightness for the generated images.
-
#image_color_mode ⇒ Object
Color mode for the generated images.
-
#image_contrast ⇒ Object
The contrast for the generated images.
-
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
-
#name ⇒ Object
The document name.
-
#numeral_format ⇒ Object
The images numeral format.
-
#page_count ⇒ Object
Number of pages to render.
-
#page_index ⇒ Object
Page index to start rendering.
-
#paper_color ⇒ Object
Background image color.
-
#password ⇒ Object
Password for opening an encrypted document.
-
#pixel_format ⇒ Object
The pixel format of generated images.
-
#resolution ⇒ Object
The resolution of generated images.
-
#result_file ⇒ Object
The resulting file name.
-
#save_options ⇒ Object
Tiff save options.
-
#scale ⇒ Object
Zoom factor for generated images.
-
#storage ⇒ Object
File storage, which have to be used.
-
#tiff_binarization_method ⇒ Object
Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold.
-
#tiff_compression ⇒ Object
The compression tipe.
-
#use_anti_aliasing ⇒ Object
Use antialiasing flag.
-
#use_high_quality_rendering ⇒ Object
Use high quality flag.
-
#zip_output ⇒ Object
Optional.
Instance Method Summary collapse
Constructor Details
#initialize(name, save_options, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, result_file = nil, use_anti_aliasing = nil, use_high_quality_rendering = nil, image_brightness = nil, image_color_mode = nil, image_contrast = nil, numeral_format = nil, page_count = nil, page_index = nil, paper_color = nil, pixel_format = nil, resolution = nil, scale = nil, tiff_compression = nil, dml_rendering_mode = nil, dml_effects_rendering_mode = nil, tiff_binarization_method = nil, zip_output = nil, fonts_location = nil) ⇒ PutDocumentSaveAsTiffRequest
Initializes a new instance.
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 116 def initialize(name, , folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil, result_file = nil, use_anti_aliasing = nil, use_high_quality_rendering = nil, image_brightness = nil, image_color_mode = nil, image_contrast = nil, numeral_format = nil, page_count = nil, page_index = nil, paper_color = nil, pixel_format = nil, resolution = nil, scale = nil, tiff_compression = nil, dml_rendering_mode = nil, dml_effects_rendering_mode = nil, tiff_binarization_method = nil, zip_output = nil, fonts_location = nil) self.name = name self. = self.folder = folder self.storage = storage self.load_encoding = load_encoding self.password = password self.dest_file_name = dest_file_name self.result_file = result_file self.use_anti_aliasing = use_anti_aliasing self.use_high_quality_rendering = use_high_quality_rendering self.image_brightness = image_brightness self.image_color_mode = image_color_mode self.image_contrast = image_contrast self.numeral_format = numeral_format self.page_count = page_count self.page_index = page_index self.paper_color = paper_color self.pixel_format = pixel_format self.resolution = resolution self.scale = scale self.tiff_compression = tiff_compression self.dml_rendering_mode = dml_rendering_mode self.dml_effects_rendering_mode = dml_effects_rendering_mode self.tiff_binarization_method = tiff_binarization_method self.zip_output = zip_output self.fonts_location = fonts_location end |
Instance Attribute Details
#dest_file_name ⇒ Object
Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.
48 49 50 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 48 def dest_file_name @dest_file_name end |
#dml_effects_rendering_mode ⇒ Object
Optional, default is Simplified.
80 81 82 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 80 def dml_effects_rendering_mode @dml_effects_rendering_mode end |
#dml_rendering_mode ⇒ Object
Optional, default is Fallback.
78 79 80 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 78 def dml_rendering_mode @dml_rendering_mode end |
#folder ⇒ Object
Original document folder.
40 41 42 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 40 def folder @folder end |
#fonts_location ⇒ Object
Folder in filestorage with custom fonts.
86 87 88 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 86 def fonts_location @fonts_location end |
#image_brightness ⇒ Object
Brightness for the generated images.
56 57 58 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 56 def image_brightness @image_brightness end |
#image_color_mode ⇒ Object
Color mode for the generated images.
58 59 60 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 58 def image_color_mode @image_color_mode end |
#image_contrast ⇒ Object
The contrast for the generated images.
60 61 62 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 60 def image_contrast @image_contrast end |
#load_encoding ⇒ Object
Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
44 45 46 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 44 def load_encoding @load_encoding end |
#name ⇒ Object
The document name.
36 37 38 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 36 def name @name end |
#numeral_format ⇒ Object
The images numeral format.
62 63 64 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 62 def numeral_format @numeral_format end |
#page_count ⇒ Object
Number of pages to render.
64 65 66 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 64 def page_count @page_count end |
#page_index ⇒ Object
Page index to start rendering.
66 67 68 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 66 def page_index @page_index end |
#paper_color ⇒ Object
Background image color.
68 69 70 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 68 def paper_color @paper_color end |
#password ⇒ Object
Password for opening an encrypted document.
46 47 48 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 46 def password @password end |
#pixel_format ⇒ Object
The pixel format of generated images.
70 71 72 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 70 def pixel_format @pixel_format end |
#resolution ⇒ Object
The resolution of generated images.
72 73 74 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 72 def resolution @resolution end |
#result_file ⇒ Object
The resulting file name.
50 51 52 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 50 def result_file @result_file end |
#save_options ⇒ Object
Tiff save options.
38 39 40 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 38 def @save_options end |
#scale ⇒ Object
Zoom factor for generated images.
74 75 76 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 74 def scale @scale end |
#storage ⇒ Object
File storage, which have to be used.
42 43 44 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 42 def storage @storage end |
#tiff_binarization_method ⇒ Object
Optional, Tiff binarization method, possible values are: FloydSteinbergDithering, Threshold.
82 83 84 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 82 def tiff_binarization_method @tiff_binarization_method end |
#tiff_compression ⇒ Object
The compression tipe.
76 77 78 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 76 def tiff_compression @tiff_compression end |
#use_anti_aliasing ⇒ Object
Use antialiasing flag.
52 53 54 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 52 def use_anti_aliasing @use_anti_aliasing end |
#use_high_quality_rendering ⇒ Object
Use high quality flag.
54 55 56 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 54 def use_high_quality_rendering @use_high_quality_rendering end |
#zip_output ⇒ Object
Optional. A value determining zip output or not.
84 85 86 |
# File 'lib/words_ruby_sdk/models/requests/PutDocumentSaveAsTiffRequest.rb', line 84 def zip_output @zip_output end |