class AsposeSlidesCloud::PdfExportOptions
Provides options that control how a presentation is saved in Pdf format.
Attributes
Access permissions that should be granted when the document is opened with user access. Default is AccessPermissions.None.
Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common.
True to apply specified ImageTransparentColor to an image.
Gets or sets the color of comments area (Applies only if comments are displayed on the right).
Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).
Gets or sets the position of the comments on the page.
Desired conformance level for generated PDF document.
True to draw black frame around each slide.
Determines if all characters of font should be embedded or only used subset.
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.
Image
transparent color.
Returns or sets a value determining the quality of the JPEG images inside PDF document.
Gets or sets the position of the notes on the page.
Setting user password to protect the PDF document.
True to convert all metafiles used in a presentation to the PNG images.
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.
Specifies compression type to be used for all textual content in the document.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
AsposeSlidesCloud::ExportOptions::attribute_map
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
AsposeSlidesCloud::ExportOptions::new
# 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.embed_full_fonts = 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.draw_slides_frame = attributes[:'DrawSlidesFrame'] end if attributes.has_key?(:'ShowHiddenSlides') self.show_hidden_slides = attributes[:'ShowHiddenSlides'] end if attributes.has_key?(:'SaveMetafilesAsPng') self.save_metafiles_as_png = attributes[:'SaveMetafilesAsPng'] end if attributes.has_key?(:'Password') self.password = attributes[:'Password'] end if attributes.has_key?(:'EmbedTrueTypeFontsForASCII') self.embed_true_type_fonts_for_ascii = 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.show_comments_by_no_author = 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.access_permissions = attributes[:'AccessPermissions'] end self.format = "pdf" end
Attribute type mapping.
AsposeSlidesCloud::ExportOptions::swagger_types
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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 && embed_full_fonts == o.embed_full_fonts && compliance == o.compliance && sufficient_resolution == o.sufficient_resolution && jpeg_quality == o.jpeg_quality && draw_slides_frame == o.draw_slides_frame && show_hidden_slides == o.show_hidden_slides && save_metafiles_as_png == o.save_metafiles_as_png && password == o.password && embed_true_type_fonts_for_ascii == o.embed_true_type_fonts_for_ascii && 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 && show_comments_by_no_author == o.show_comments_by_no_author && image_transparent_color == o.image_transparent_color && apply_image_transparent == o.apply_image_transparent && access_permissions == o.access_permissions end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
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
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] access_permissions
Object to be assigned
# File lib/aspose_slides_cloud/models/pdf_export_options.rb, line 383 def access_permissions=(access_permissions) validator = EnumAttributeValidator.new('String', ['None', 'PrintDocument', 'ModifyContent', 'CopyTextAndGraphics', 'AddOrModifyFields', 'FillExistingFields', 'ExtractTextAndGraphics', 'AssembleDocument', 'HighQualityPrint']) unless validator.valid?(access_permissions) fail ArgumentError, 'invalid value for "access_permissions", must be one of #{validator.allowable_values}.' end @access_permissions = access_permissions end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] comments_position
Object to be assigned
# File lib/aspose_slides_cloud/models/pdf_export_options.rb, line 373 def comments_position=(comments_position) validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right']) unless validator.valid?(comments_position) fail ArgumentError, 'invalid value for "comments_position", must be one of #{validator.allowable_values}.' end @comments_position = comments_position end
Custom attribute writer method checking allowed values (enum). @param [Object] compliance Object to be assigned
# File lib/aspose_slides_cloud/models/pdf_export_options.rb, line 353 def compliance=(compliance) validator = EnumAttributeValidator.new('String', ['Pdf15', 'PdfA1b', 'PdfA1a', 'PdfUa']) unless validator.valid?(compliance) fail ArgumentError, 'invalid value for "compliance", must be one of #{validator.allowable_values}.' end @compliance = compliance end
@see the `==` method @param [Object] Object to be compared
# File lib/aspose_slides_cloud/models/pdf_export_options.rb, line 421 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_slides_cloud/models/pdf_export_options.rb, line 427 def hash [default_regular_font, format, text_compression, embed_full_fonts, compliance, sufficient_resolution, jpeg_quality, draw_slides_frame, show_hidden_slides, save_metafiles_as_png, password, embed_true_type_fonts_for_ascii, additional_common_font_families, notes_position, comments_position, comments_area_width, comments_area_color, show_comments_by_no_author, image_transparent_color, apply_image_transparent, access_permissions].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
AsposeSlidesCloud::ExportOptions#list_invalid_properties
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] notes_position
Object to be assigned
# File lib/aspose_slides_cloud/models/pdf_export_options.rb, line 363 def notes_position=(notes_position) validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated']) unless validator.valid?(notes_position) fail ArgumentError, 'invalid value for "notes_position", must be one of #{validator.allowable_values}.' end @notes_position = notes_position end
Custom attribute writer method checking allowed values (enum). @param [Object] text_compression
Object to be assigned
# File lib/aspose_slides_cloud/models/pdf_export_options.rb, line 343 def text_compression=(text_compression) validator = EnumAttributeValidator.new('String', ['None', 'Flate']) unless validator.valid?(text_compression) fail ArgumentError, 'invalid value for "text_compression", must be one of #{validator.allowable_values}.' end @text_compression = text_compression end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/aspose_slides_cloud/models/pdf_export_options.rb, line 507 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
AsposeSlidesCloud::ExportOptions#valid?
# 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? access_permissions_validator = EnumAttributeValidator.new('String', ['None', 'PrintDocument', 'ModifyContent', 'CopyTextAndGraphics', 'AddOrModifyFields', 'FillExistingFields', 'ExtractTextAndGraphics', 'AssembleDocument', 'HighQualityPrint']) return false unless access_permissions_validator.valid?(@access_permissions) true end