Class: AsposeSlidesCloud::PdfExportOptions
- Inherits:
-
ExportOptions
- Object
- ExportOptions
- AsposeSlidesCloud::PdfExportOptions
- Defined in:
- lib/aspose_slides_cloud/models/pdf_export_options.rb
Overview
Provides options that control how a presentation is saved in Pdf format.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#access_permissions ⇒ Object
Access permissions that should be granted when the document is opened with user access.
-
#additional_common_font_families ⇒ Object
Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common.
-
#apply_image_transparent ⇒ Object
True to apply specified ImageTransparentColor to an image.
-
#comments_area_color ⇒ Object
Gets or sets the color of comments area (Applies only if comments are displayed on the right).
-
#comments_area_width ⇒ Object
Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).
-
#comments_position ⇒ Object
Gets or sets the position of the comments on the page.
-
#compliance ⇒ Object
Desired conformance level for generated PDF document.
-
#draw_slides_frame ⇒ Object
True to draw black frame around each slide.
-
#embed_full_fonts ⇒ Object
Determines if all characters of font should be embedded or only used subset.
-
#embed_true_type_fonts_for_ascii ⇒ Object
Determines if Aspose.Slides will embed common fonts for ASCII (33..127 code range) text.
-
#image_transparent_color ⇒ Object
Image transparent color.
-
#jpeg_quality ⇒ Object
Returns or sets a value determining the quality of the JPEG images inside PDF document.
-
#notes_position ⇒ Object
Gets or sets the position of the notes on the page.
-
#password ⇒ Object
Setting user password to protect the PDF document.
-
#save_metafiles_as_png ⇒ Object
True to convert all metafiles used in a presentation to the PNG images.
-
#show_comments_by_no_author ⇒ Object
True if comments that have no author are displayed.
-
#show_hidden_slides ⇒ Object
Specifies whether the generated document should include hidden slides or not.
-
#sufficient_resolution ⇒ Object
Returns or sets a value determining resolution of images inside PDF document.
-
#text_compression ⇒ Object
Specifies compression type to be used for all textual content in the document.
Attributes inherited from ExportOptions
#default_regular_font, #format
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
-
#==(o) ⇒ 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?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PdfExportOptions
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 = {}) ⇒ PdfExportOptions
Initializes the object
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 159 def initialize(attributes = {}) super if attributes.has_key?(:'TextCompression') self.text_compression = attributes[:'TextCompression'] end if attributes.has_key?(:'EmbedFullFonts') self. = attributes[:'EmbedFullFonts'] end if attributes.has_key?(:'Compliance') self.compliance = attributes[:'Compliance'] end if attributes.has_key?(:'SufficientResolution') self.sufficient_resolution = attributes[:'SufficientResolution'] end if attributes.has_key?(:'JpegQuality') self.jpeg_quality = attributes[:'JpegQuality'] end if attributes.has_key?(:'DrawSlidesFrame') self. = attributes[:'DrawSlidesFrame'] end if attributes.has_key?(:'ShowHiddenSlides') self. = attributes[:'ShowHiddenSlides'] end if attributes.has_key?(:'SaveMetafilesAsPng') self. = attributes[:'SaveMetafilesAsPng'] end if attributes.has_key?(:'Password') self.password = attributes[:'Password'] end if attributes.has_key?(:'EmbedTrueTypeFontsForASCII') self. = attributes[:'EmbedTrueTypeFontsForASCII'] end if attributes.has_key?(:'AdditionalCommonFontFamilies') if (value = attributes[:'AdditionalCommonFontFamilies']).is_a?(Array) self.additional_common_font_families = value end end if attributes.has_key?(:'NotesPosition') self.notes_position = attributes[:'NotesPosition'] end if attributes.has_key?(:'CommentsPosition') self.comments_position = attributes[:'CommentsPosition'] end if attributes.has_key?(:'CommentsAreaWidth') self.comments_area_width = attributes[:'CommentsAreaWidth'] end if attributes.has_key?(:'CommentsAreaColor') self.comments_area_color = attributes[:'CommentsAreaColor'] end if attributes.has_key?(:'ShowCommentsByNoAuthor') self. = attributes[:'ShowCommentsByNoAuthor'] end if attributes.has_key?(:'ImageTransparentColor') self.image_transparent_color = attributes[:'ImageTransparentColor'] end if attributes.has_key?(:'ApplyImageTransparent') self.apply_image_transparent = attributes[:'ApplyImageTransparent'] end if attributes.has_key?(:'AccessPermissions') self. = attributes[:'AccessPermissions'] end self.format = "pdf" end |
Instance Attribute Details
#access_permissions ⇒ Object
Access permissions that should be granted when the document is opened with user access. Default is AccessPermissions.None.
83 84 85 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 83 def @access_permissions end |
#additional_common_font_families ⇒ Object
Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common.
59 60 61 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 59 def additional_common_font_families @additional_common_font_families end |
#apply_image_transparent ⇒ Object
True to apply specified ImageTransparentColor to an image.
80 81 82 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 80 def apply_image_transparent @apply_image_transparent end |
#comments_area_color ⇒ Object
Gets or sets the color of comments area (Applies only if comments are displayed on the right).
71 72 73 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 71 def comments_area_color @comments_area_color end |
#comments_area_width ⇒ Object
Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).
68 69 70 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 68 def comments_area_width @comments_area_width end |
#comments_position ⇒ Object
Gets or sets the position of the comments on the page.
65 66 67 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 65 def comments_position @comments_position end |
#compliance ⇒ Object
Desired conformance level for generated PDF document.
35 36 37 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 35 def compliance @compliance end |
#draw_slides_frame ⇒ Object
True to draw black frame around each slide.
44 45 46 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 44 def @draw_slides_frame end |
#embed_full_fonts ⇒ Object
Determines if all characters of font should be embedded or only used subset.
32 33 34 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 32 def @embed_full_fonts end |
#embed_true_type_fonts_for_ascii ⇒ Object
Determines if Aspose.Slides will embed common fonts for ASCII (33..127 code range) text. Fonts for character codes greater than 127 are always embedded. Common fonts list includes PDF’s base 14 fonts and additional user specified fonts.
56 57 58 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 56 def @embed_true_type_fonts_for_ascii end |
#image_transparent_color ⇒ Object
Image transparent color.
77 78 79 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 77 def image_transparent_color @image_transparent_color end |
#jpeg_quality ⇒ Object
Returns or sets a value determining the quality of the JPEG images inside PDF document.
41 42 43 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 41 def jpeg_quality @jpeg_quality end |
#notes_position ⇒ Object
Gets or sets the position of the notes on the page.
62 63 64 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 62 def notes_position @notes_position end |
#password ⇒ Object
Setting user password to protect the PDF document.
53 54 55 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 53 def password @password end |
#save_metafiles_as_png ⇒ Object
True to convert all metafiles used in a presentation to the PNG images.
50 51 52 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 50 def @save_metafiles_as_png end |
#show_comments_by_no_author ⇒ Object
True if comments that have no author are displayed. (Applies only if comments are displayed).
74 75 76 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 74 def @show_comments_by_no_author end |
#show_hidden_slides ⇒ Object
Specifies whether the generated document should include hidden slides or not. Default is false.
47 48 49 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 47 def @show_hidden_slides end |
#sufficient_resolution ⇒ Object
Returns or sets a value determining resolution of images inside PDF document. Property affects on file size, time of export and image quality. The default value is 96.
38 39 40 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 38 def sufficient_resolution @sufficient_resolution end |
#text_compression ⇒ Object
Specifies compression type to be used for all textual content in the document.
29 30 31 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 29 def text_compression @text_compression end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 108 def self.attribute_map super.merge({ :'text_compression' => :'TextCompression', :'embed_full_fonts' => :'EmbedFullFonts', :'compliance' => :'Compliance', :'sufficient_resolution' => :'SufficientResolution', :'jpeg_quality' => :'JpegQuality', :'draw_slides_frame' => :'DrawSlidesFrame', :'show_hidden_slides' => :'ShowHiddenSlides', :'save_metafiles_as_png' => :'SaveMetafilesAsPng', :'password' => :'Password', :'embed_true_type_fonts_for_ascii' => :'EmbedTrueTypeFontsForASCII', :'additional_common_font_families' => :'AdditionalCommonFontFamilies', :'notes_position' => :'NotesPosition', :'comments_position' => :'CommentsPosition', :'comments_area_width' => :'CommentsAreaWidth', :'comments_area_color' => :'CommentsAreaColor', :'show_comments_by_no_author' => :'ShowCommentsByNoAuthor', :'image_transparent_color' => :'ImageTransparentColor', :'apply_image_transparent' => :'ApplyImageTransparent', :'access_permissions' => :'AccessPermissions', }) end |
.swagger_types ⇒ Object
Attribute type mapping.
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 133 def self.swagger_types super.merge({ :'text_compression' => :'String', :'embed_full_fonts' => :'BOOLEAN', :'compliance' => :'String', :'sufficient_resolution' => :'Float', :'jpeg_quality' => :'Integer', :'draw_slides_frame' => :'BOOLEAN', :'show_hidden_slides' => :'BOOLEAN', :'save_metafiles_as_png' => :'BOOLEAN', :'password' => :'String', :'embed_true_type_fonts_for_ascii' => :'BOOLEAN', :'additional_common_font_families' => :'Array<String>', :'notes_position' => :'String', :'comments_position' => :'String', :'comments_area_width' => :'Integer', :'comments_area_color' => :'String', :'show_comments_by_no_author' => :'BOOLEAN', :'image_transparent_color' => :'String', :'apply_image_transparent' => :'BOOLEAN', :'access_permissions' => :'String', }) end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
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 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 393 def ==(o) return true if self.equal?(o) self.class == o.class && default_regular_font == o.default_regular_font && format == o.format && text_compression == o.text_compression && == o. && compliance == o.compliance && sufficient_resolution == o.sufficient_resolution && jpeg_quality == o.jpeg_quality && == o. && == o. && == o. && password == o.password && == o. && additional_common_font_families == o.additional_common_font_families && notes_position == o.notes_position && comments_position == o.comments_position && comments_area_width == o.comments_area_width && comments_area_color == o.comments_area_color && == o. && image_transparent_color == o.image_transparent_color && apply_image_transparent == o.apply_image_transparent && == o. end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 500 501 502 503 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 467 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) 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 = AsposeSlidesCloud.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
533 534 535 536 537 538 539 540 541 542 543 544 545 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 533 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
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 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 434 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| mapKey = self.class.attribute_map[key] if !mapKey.nil? val = attributes[mapKey] if val.nil? mapKeyString = mapKey.to_s mapKeyString[0] = mapKeyString[0].downcase mapKey = mapKeyString.to_sym val = attributes[mapKey] end if !val.nil? 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 val.is_a?(Array) self.send("#{key}=", val.map { |v| _deserialize($1, v) }) end else self.send("#{key}=", _deserialize(type, val)) end end end end self end |
#eql?(o) ⇒ Boolean
421 422 423 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 421 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
427 428 429 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 427 def hash [default_regular_font, format, text_compression, , compliance, sufficient_resolution, jpeg_quality, , , , password, , additional_common_font_families, notes_position, comments_position, comments_area_width, comments_area_color, , image_transparent_color, apply_image_transparent, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
244 245 246 247 248 249 250 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 302 303 304 305 306 307 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 244 def list_invalid_properties invalid_properties = super if @text_compression.nil? invalid_properties.push('invalid value for "text_compression", text_compression cannot be nil.') end if @embed_full_fonts.nil? invalid_properties.push('invalid value for "embed_full_fonts", embed_full_fonts cannot be nil.') end if @compliance.nil? invalid_properties.push('invalid value for "compliance", compliance cannot be nil.') end if @sufficient_resolution.nil? invalid_properties.push('invalid value for "sufficient_resolution", sufficient_resolution cannot be nil.') end if @jpeg_quality.nil? invalid_properties.push('invalid value for "jpeg_quality", jpeg_quality cannot be nil.') end if @draw_slides_frame.nil? invalid_properties.push('invalid value for "draw_slides_frame", draw_slides_frame cannot be nil.') end if @show_hidden_slides.nil? invalid_properties.push('invalid value for "show_hidden_slides", show_hidden_slides cannot be nil.') end if @save_metafiles_as_png.nil? invalid_properties.push('invalid value for "save_metafiles_as_png", save_metafiles_as_png cannot be nil.') end if @embed_true_type_fonts_for_ascii.nil? invalid_properties.push('invalid value for "embed_true_type_fonts_for_ascii", embed_true_type_fonts_for_ascii cannot be nil.') end if @notes_position.nil? invalid_properties.push('invalid value for "notes_position", notes_position cannot be nil.') end if @comments_position.nil? invalid_properties.push('invalid value for "comments_position", comments_position cannot be nil.') end if @comments_area_width.nil? invalid_properties.push('invalid value for "comments_area_width", comments_area_width cannot be nil.') end if @show_comments_by_no_author.nil? invalid_properties.push('invalid value for "show_comments_by_no_author", show_comments_by_no_author cannot be nil.') end if @apply_image_transparent.nil? invalid_properties.push('invalid value for "apply_image_transparent", apply_image_transparent cannot be nil.') end if @access_permissions.nil? invalid_properties.push('invalid value for "access_permissions", access_permissions cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
513 514 515 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 513 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
519 520 521 522 523 524 525 526 527 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 519 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
507 508 509 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 507 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
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 |
# File 'lib/aspose_slides_cloud/models/pdf_export_options.rb', line 311 def valid? return false if !super return false if @text_compression.nil? text_compression_validator = EnumAttributeValidator.new('String', ['None', 'Flate']) return false unless text_compression_validator.valid?(@text_compression) return false if @embed_full_fonts.nil? return false if @compliance.nil? compliance_validator = EnumAttributeValidator.new('String', ['Pdf15', 'PdfA1b', 'PdfA1a', 'PdfUa']) return false unless compliance_validator.valid?(@compliance) return false if @sufficient_resolution.nil? return false if @jpeg_quality.nil? return false if @draw_slides_frame.nil? return false if @show_hidden_slides.nil? return false if @save_metafiles_as_png.nil? return false if @embed_true_type_fonts_for_ascii.nil? return false if @notes_position.nil? notes_position_validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated']) return false unless notes_position_validator.valid?(@notes_position) return false if @comments_position.nil? comments_position_validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right']) return false unless comments_position_validator.valid?(@comments_position) return false if @comments_area_width.nil? return false if @show_comments_by_no_author.nil? return false if @apply_image_transparent.nil? return false if @access_permissions.nil? = EnumAttributeValidator.new('String', ['None', 'PrintDocument', 'ModifyContent', 'CopyTextAndGraphics', 'AddOrModifyFields', 'FillExistingFields', 'ExtractTextAndGraphics', 'AssembleDocument', 'HighQualityPrint']) return false unless .valid?(@access_permissions) true end |