Class: Pdfcrowd::HtmlToPdfClient

Inherits:
Object
  • Object
show all
Defined in:
lib/pdfcrowd.rb

Overview

Conversion from HTML to PDF.

Instance Method Summary collapse

Constructor Details

#initialize(user_name, api_key) ⇒ HtmlToPdfClient

Constructor for the Pdfcrowd API client.

  • user_name - Your username at Pdfcrowd.

  • api_key - Your API key.



751
752
753
754
755
756
757
758
759
760
 
# File 'lib/pdfcrowd.rb', line 751

def initialize(user_name, api_key)
    @helper = ConnectionHelper.new(user_name, api_key)
    @fields = {
        'input_format'=>'html',
        'output_format'=>'pdf'
    }
    @file_id = 1
    @files = {}
    @raw_data = {}
end

Instance Method Details

#convertFile(file) ⇒ Object

Convert a local file.

  • file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.

  • Returns - Byte array containing the conversion output.



812
813
814
815
816
817
818
819
 
# File 'lib/pdfcrowd.rb', line 812

def convertFile(file)
    if (!(File.file?(file) && !File.zero?(file)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file, "convertFile", "html-to-pdf", "The file must exist and not be empty.", "convert_file"), 470);
    end
    
    @files['file'] = file
    @helper.post(@fields, @files, @raw_data)
end

#convertFileToFile(file, file_path) ⇒ Object

Convert a local file and write the result to a local file.

  • file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.

  • file_path - The output file path. The string must not be empty.



838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
 
# File 'lib/pdfcrowd.rb', line 838

def convertFileToFile(file, file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertFileToFile::file_path", "html-to-pdf", "The string must not be empty.", "convert_file_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    begin
        convertFileToStream(file, output_file)
        output_file.close()
    rescue Error => why
        output_file.close()
        FileUtils.rm(file_path)
        raise
    end
end

#convertFileToStream(file, out_stream) ⇒ Object

Convert a local file and write the result to an output stream.

  • file - The path to a local file to convert. The file can be either a single file or an archive (.tar.gz, .tar.bz2, or .zip). If the HTML document refers to local external assets (images, style sheets, javascript), zip the document together with the assets. The file must exist and not be empty. The file name must have a valid extension.

  • out_stream - The output stream that will contain the conversion output.



825
826
827
828
829
830
831
832
 
# File 'lib/pdfcrowd.rb', line 825

def convertFileToStream(file, out_stream)
    if (!(File.file?(file) && !File.zero?(file)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file, "convertFileToStream::file", "html-to-pdf", "The file must exist and not be empty.", "convert_file_to_stream"), 470);
    end
    
    @files['file'] = file
    @helper.post(@fields, @files, @raw_data, out_stream)
end

#convertStream(in_stream) ⇒ Object

Convert the contents of an input stream.

  • in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).

  • Returns - Byte array containing the conversion output.



904
905
906
907
 
# File 'lib/pdfcrowd.rb', line 904

def convertStream(in_stream)
    @raw_data['stream'] = in_stream.read
    @helper.post(@fields, @files, @raw_data)
end

#convertStreamToFile(in_stream, file_path) ⇒ Object

Convert the contents of an input stream and write the result to a local file.

  • in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).

  • file_path - The output file path. The string must not be empty.



922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/pdfcrowd.rb', line 922

def convertStreamToFile(in_stream, file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertStreamToFile::file_path", "html-to-pdf", "The string must not be empty.", "convert_stream_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    begin
        convertStreamToStream(in_stream, output_file)
        output_file.close()
    rescue Error => why
        output_file.close()
        FileUtils.rm(file_path)
        raise
    end
end

#convertStreamToStream(in_stream, out_stream) ⇒ Object

Convert the contents of an input stream and write the result to an output stream.

  • in_stream - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).

  • out_stream - The output stream that will contain the conversion output.



913
914
915
916
 
# File 'lib/pdfcrowd.rb', line 913

def convertStreamToStream(in_stream, out_stream)
    @raw_data['stream'] = in_stream.read
    @helper.post(@fields, @files, @raw_data, out_stream)
end

#convertString(text) ⇒ Object

Convert a string.

  • text - The string content to convert. The string must not be empty.

  • Returns - Byte array containing the conversion output.



858
859
860
861
862
863
864
865
 
# File 'lib/pdfcrowd.rb', line 858

def convertString(text)
    if (!(!text.nil? && !text.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(text, "convertString", "html-to-pdf", "The string must not be empty.", "convert_string"), 470);
    end
    
    @fields['text'] = text
    @helper.post(@fields, @files, @raw_data)
end

#convertStringToFile(text, file_path) ⇒ Object

Convert a string and write the output to a file.

  • text - The string content to convert. The string must not be empty.

  • file_path - The output file path. The string must not be empty.



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'lib/pdfcrowd.rb', line 884

def convertStringToFile(text, file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertStringToFile::file_path", "html-to-pdf", "The string must not be empty.", "convert_string_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    begin
        convertStringToStream(text, output_file)
        output_file.close()
    rescue Error => why
        output_file.close()
        FileUtils.rm(file_path)
        raise
    end
end

#convertStringToStream(text, out_stream) ⇒ Object

Convert a string and write the output to an output stream.

  • text - The string content to convert. The string must not be empty.

  • out_stream - The output stream that will contain the conversion output.



871
872
873
874
875
876
877
878
 
# File 'lib/pdfcrowd.rb', line 871

def convertStringToStream(text, out_stream)
    if (!(!text.nil? && !text.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(text, "convertStringToStream::text", "html-to-pdf", "The string must not be empty.", "convert_string_to_stream"), 470);
    end
    
    @fields['text'] = text
    @helper.post(@fields, @files, @raw_data, out_stream)
end

#convertUrl(url) ⇒ Object

Convert a web page.

  • url - The address of the web page to convert. The supported protocols are http:// and https://.

  • Returns - Byte array containing the conversion output.



766
767
768
769
770
771
772
773
 
# File 'lib/pdfcrowd.rb', line 766

def convertUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "convertUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "convert_url"), 470);
    end
    
    @fields['url'] = url
    @helper.post(@fields, @files, @raw_data)
end

#convertUrlToFile(url, file_path) ⇒ Object

Convert a web page and write the result to a local file.

  • url - The address of the web page to convert. The supported protocols are http:// and https://.

  • file_path - The output file path. The string must not be empty.



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/pdfcrowd.rb', line 792

def convertUrlToFile(url, file_path)
    if (!(!file_path.nil? && !file_path.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertUrlToFile::file_path", "html-to-pdf", "The string must not be empty.", "convert_url_to_file"), 470);
    end
    
    output_file = open(file_path, "wb")
    begin
        convertUrlToStream(url, output_file)
        output_file.close()
    rescue Error => why
        output_file.close()
        FileUtils.rm(file_path)
        raise
    end
end

#convertUrlToStream(url, out_stream) ⇒ Object

Convert a web page and write the result to an output stream.

  • url - The address of the web page to convert. The supported protocols are http:// and https://.

  • out_stream - The output stream that will contain the conversion output.



779
780
781
782
783
784
785
786
 
# File 'lib/pdfcrowd.rb', line 779

def convertUrlToStream(url, out_stream)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "convertUrlToStream::url", "html-to-pdf", "The supported protocols are http:// and https://.", "convert_url_to_stream"), 470);
    end
    
    @fields['url'] = url
    @helper.post(@fields, @files, @raw_data, out_stream)
end

#getConsumedCreditCount ⇒ Object

Get the number of credits consumed by the last conversion.

  • Returns - The number of credits.



2218
2219
2220
 
# File 'lib/pdfcrowd.rb', line 2218

def getConsumedCreditCount()
    return @helper.getConsumedCreditCount()
end

#getDebugLogUrl ⇒ Object

Get the URL of the debug log for the last conversion.

  • Returns - The link to the debug log.



2203
2204
2205
 
# File 'lib/pdfcrowd.rb', line 2203

def getDebugLogUrl()
    return @helper.getDebugLogUrl()
end

#getJobId ⇒ Object

Get the job id.

  • Returns - The unique job identifier.



2224
2225
2226
 
# File 'lib/pdfcrowd.rb', line 2224

def getJobId()
    return @helper.getJobId()
end

#getOutputSize ⇒ Object

Get the size of the output in bytes.

  • Returns - The count of bytes.



2242
2243
2244
 
# File 'lib/pdfcrowd.rb', line 2242

def getOutputSize()
    return @helper.getOutputSize()
end

#getPageCount ⇒ Object

Get the number of pages in the output document.

  • Returns - The page count.



2230
2231
2232
 
# File 'lib/pdfcrowd.rb', line 2230

def getPageCount()
    return @helper.getPageCount()
end

#getRemainingCreditCount ⇒ Object

Get the number of conversion credits available in your account. This method can only be called after a call to one of the convertXtoY methods. The returned value can differ from the actual count if you run parallel conversions. The special value 999999 is returned if the information is not available.

  • Returns - The number of credits.



2212
2213
2214
 
# File 'lib/pdfcrowd.rb', line 2212

def getRemainingCreditCount()
    return @helper.getRemainingCreditCount()
end

#getTotalPageCount ⇒ Object

Get the total number of pages in the original output document, including the pages excluded by setPrintPageRange().

  • Returns - The total page count.



2236
2237
2238
 
# File 'lib/pdfcrowd.rb', line 2236

def getTotalPageCount()
    return @helper.getTotalPageCount()
end

#getVersion ⇒ Object

Get the version details.

  • Returns - API version, converter version, and client version.



2248
2249
2250
 
# File 'lib/pdfcrowd.rb', line 2248

def getVersion()
    return "client " + CLIENT_VERSION + ", API v2, converter " + @helper.getConverterVersion()
end

#setAuthor(author) ⇒ Object

Set the author of the PDF.

  • author - The author.

  • Returns - The converter object.



1965
1966
1967
1968
 
# File 'lib/pdfcrowd.rb', line 1965

def setAuthor(author)
    @fields['author'] = author
    self
end

#setAutoDetectElementToConvert(value) ⇒ Object

The main HTML element for conversion is detected automatically.

  • value - Set to true to detect the main element.

  • Returns - The converter object.



1738
1739
1740
1741
 
# File 'lib/pdfcrowd.rb', line 1738

def setAutoDetectElementToConvert(value)
    @fields['auto_detect_element_to_convert'] = value
    self
end

#setBlockAds(value) ⇒ Object

Try to block ads. Enabling this option can produce smaller output and speed up the conversion.

  • value - Set to true to block ads in web pages.

  • Returns - The converter object.



1533
1534
1535
1536
 
# File 'lib/pdfcrowd.rb', line 1533

def setBlockAds(value)
    @fields['block_ads'] = value
    self
end

#setCenterWindow(value) ⇒ Object

Specify whether to position the document’s window in the center of the screen.

  • value - Set to true to center the window.

  • Returns - The converter object.



2093
2094
2095
2096
 
# File 'lib/pdfcrowd.rb', line 2093

def setCenterWindow(value)
    @fields['center_window'] = value
    self
end

#setClientCertificate(certificate) ⇒ Object

A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security.

  • certificate - The file must be in PKCS12 format. The file must exist and not be empty.

  • Returns - The converter object.



2291
2292
2293
2294
2295
2296
2297
2298
 
# File 'lib/pdfcrowd.rb', line 2291

def setClientCertificate(certificate)
    if (!(File.file?(certificate) && !File.zero?(certificate)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(certificate, "setClientCertificate", "html-to-pdf", "The file must exist and not be empty.", "set_client_certificate"), 470);
    end
    
    @files['client_certificate'] = certificate
    self
end

#setClientCertificatePassword(password) ⇒ Object

A password for PKCS12 file with a client certificate if it is needed.

  • password -

  • Returns - The converter object.



2304
2305
2306
2307
 
# File 'lib/pdfcrowd.rb', line 2304

def setClientCertificatePassword(password)
    @fields['client_certificate_password'] = password
    self
end

#setContentArea(x, y, width, height) ⇒ Object

Set the content area position and size. The content area enables to specify a web page area to be converted.

  • x - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”. It may contain a negative value.

  • y - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”. It may contain a negative value.

  • width - Set the width of the content area. It should be at least 1 inch. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • height - Set the height of the content area. It should be at least 1 inch. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/pdfcrowd.rb', line 1167

def setContentArea(x, y, width, height)
    setContentAreaX(x)
    setContentAreaY(y)
    setContentAreaWidth(width)
    setContentAreaHeight(height)
    self
end

#setContentAreaHeight(height) ⇒ Object

Set the height of the content area. It should be at least 1 inch.

  • height - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/pdfcrowd.rb', line 1151

def setContentAreaHeight(height)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
        raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setContentAreaHeight", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_content_area_height"), 470);
    end
    
    @fields['content_area_height'] = height
    self
end

#setContentAreaWidth(width) ⇒ Object

Set the width of the content area. It should be at least 1 inch.

  • width - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/pdfcrowd.rb', line 1138

def setContentAreaWidth(width)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(width)
        raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setContentAreaWidth", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_content_area_width"), 470);
    end
    
    @fields['content_area_width'] = width
    self
end

#setContentAreaX(x) ⇒ Object

Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.

  • x - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”. It may contain a negative value.

  • Returns - The converter object.



1112
1113
1114
1115
1116
1117
1118
1119
 
# File 'lib/pdfcrowd.rb', line 1112

def setContentAreaX(x)
    unless /(?i)^0$|^\-?[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(x)
        raise Error.new(Pdfcrowd.create_invalid_value_message(x, "setContentAreaX", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\". It may contain a negative value.", "set_content_area_x"), 470);
    end
    
    @fields['content_area_x'] = x
    self
end

#setContentAreaY(y) ⇒ Object

Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.

  • y - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”. It may contain a negative value.

  • Returns - The converter object.



1125
1126
1127
1128
1129
1130
1131
1132
 
# File 'lib/pdfcrowd.rb', line 1125

def setContentAreaY(y)
    unless /(?i)^0$|^\-?[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(y)
        raise Error.new(Pdfcrowd.create_invalid_value_message(y, "setContentAreaY", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\". It may contain a negative value.", "set_content_area_y"), 470);
    end
    
    @fields['content_area_y'] = y
    self
end

#setContentsMatrix(matrix) ⇒ Object

A 2D transformation matrix applied to the main contents on each page. The origin [0,0] is located at the top-left corner of the contents. The resolution is 72 dpi.

  • matrix - A comma separated string of matrix elements: “scaleX,skewX,transX,skewY,scaleY,transY”

  • Returns - The converter object.



2326
2327
2328
2329
 
# File 'lib/pdfcrowd.rb', line 2326

def setContentsMatrix(matrix)
    @fields['contents_matrix'] = matrix
    self
end

#setConverterVersion(version) ⇒ Object

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.

  • version - The version identifier. Allowed values are latest, 20.10, 18.10.

  • Returns - The converter object.



2394
2395
2396
2397
2398
2399
2400
2401
 
# File 'lib/pdfcrowd.rb', line 2394

def setConverterVersion(version)
    unless /(?i)^(latest|20.10|18.10)$/.match(version)
        raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "html-to-pdf", "Allowed values are latest, 20.10, 18.10.", "set_converter_version"), 470);
    end
    
    @helper.setConverterVersion(version)
    self
end

#setConvertImagesToJpeg(images) ⇒ Object

Specify which image types will be converted to JPEG. Converting lossless compression image formats (PNG, GIF, …) to JPEG may result in a smaller PDF file.

  • images - The image category. Allowed values are none, opaque, all.

  • Returns - The converter object.



1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/pdfcrowd.rb', line 1849

def setConvertImagesToJpeg(images)
    unless /(?i)^(none|opaque|all)$/.match(images)
        raise Error.new(Pdfcrowd.create_invalid_value_message(images, "setConvertImagesToJpeg", "html-to-pdf", "Allowed values are none, opaque, all.", "set_convert_images_to_jpeg"), 470);
    end
    
    @fields['convert_images_to_jpeg'] = images
    self
end

#setCookies(cookies) ⇒ Object

Set cookies that are sent in Pdfcrowd HTTP requests.

  • cookies - The cookie string.

  • Returns - The converter object.



1589
1590
1591
1592
 
# File 'lib/pdfcrowd.rb', line 1589

def setCookies(cookies)
    @fields['cookies'] = cookies
    self
end

#setCssPageRuleMode(mode) ⇒ Object

Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation.

  • mode - The page rule mode. Allowed values are default, mode1, mode2.

  • Returns - The converter object.



1179
1180
1181
1182
1183
1184
1185
1186
 
# File 'lib/pdfcrowd.rb', line 1179

def setCssPageRuleMode(mode)
    unless /(?i)^(default|mode1|mode2)$/.match(mode)
        raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setCssPageRuleMode", "html-to-pdf", "Allowed values are default, mode1, mode2.", "set_css_page_rule_mode"), 470);
    end
    
    @fields['css_page_rule_mode'] = mode
    self
end

#setCustomCss(css) ⇒ Object

Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.

  • css - A string containing valid CSS. The string must not be empty.

  • Returns - The converter object.



1634
1635
1636
1637
1638
1639
1640
1641
 
# File 'lib/pdfcrowd.rb', line 1634

def setCustomCss(css)
    if (!(!css.nil? && !css.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(css, "setCustomCss", "html-to-pdf", "The string must not be empty.", "set_custom_css"), 470);
    end
    
    @fields['custom_css'] = css
    self
end

#setCustomHttpHeader(header) ⇒ Object

Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.

  • header - A string containing the header name and value separated by a colon.

  • Returns - The converter object.



1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'lib/pdfcrowd.rb', line 1673

def setCustomHttpHeader(header)
    unless /^.+:.+$/.match(header)
        raise Error.new(Pdfcrowd.create_invalid_value_message(header, "setCustomHttpHeader", "html-to-pdf", "A string containing the header name and value separated by a colon.", "set_custom_http_header"), 470);
    end
    
    @fields['custom_http_header'] = header
    self
end

#setCustomJavascript(javascript) ⇒ Object

Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, …). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.

  • javascript - A string containing a JavaScript code. The string must not be empty.

  • Returns - The converter object.



1647
1648
1649
1650
1651
1652
1653
1654
 
# File 'lib/pdfcrowd.rb', line 1647

def setCustomJavascript(javascript)
    if (!(!javascript.nil? && !javascript.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(javascript, "setCustomJavascript", "html-to-pdf", "The string must not be empty.", "set_custom_javascript"), 470);
    end
    
    @fields['custom_javascript'] = javascript
    self
end

#setDataAutoEscape(value) ⇒ Object

Auto escape HTML symbols in the input data before placing them into the output.

  • value - Set to true to turn auto escaping on.

  • Returns - The converter object.



2169
2170
2171
2172
 
# File 'lib/pdfcrowd.rb', line 2169

def setDataAutoEscape(value)
    @fields['data_auto_escape'] = value
    self
end

#setDataEncoding(encoding) ⇒ Object

Set the encoding of the data file set by setDataFile.

  • encoding - The data file encoding.

  • Returns - The converter object.



2151
2152
2153
2154
 
# File 'lib/pdfcrowd.rb', line 2151

def setDataEncoding(encoding)
    @fields['data_encoding'] = encoding
    self
end

#setDataFile(data_file) ⇒ Object

Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.

  • data_file - The file path to a local file containing the input data.

  • Returns - The converter object.



2129
2130
2131
2132
 
# File 'lib/pdfcrowd.rb', line 2129

def setDataFile(data_file)
    @files['data_file'] = data_file
    self
end

#setDataFormat(data_format) ⇒ Object

Specify the input data format.

  • data_format - The data format. Allowed values are auto, json, xml, yaml, csv.

  • Returns - The converter object.



2138
2139
2140
2141
2142
2143
2144
2145
 
# File 'lib/pdfcrowd.rb', line 2138

def setDataFormat(data_format)
    unless /(?i)^(auto|json|xml|yaml|csv)$/.match(data_format)
        raise Error.new(Pdfcrowd.create_invalid_value_message(data_format, "setDataFormat", "html-to-pdf", "Allowed values are auto, json, xml, yaml, csv.", "set_data_format"), 470);
    end
    
    @fields['data_format'] = data_format
    self
end

#setDataIgnoreUndefined(value) ⇒ Object

Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use if variable is defined % to check if the variable is defined.

  • value - Set to true to ignore undefined variables.

  • Returns - The converter object.



2160
2161
2162
2163
 
# File 'lib/pdfcrowd.rb', line 2160

def setDataIgnoreUndefined(value)
    @fields['data_ignore_undefined'] = value
    self
end

#setDataOptions(options) ⇒ Object

Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.

  • options - Comma separated list of options.

  • Returns - The converter object.



2187
2188
2189
2190
 
# File 'lib/pdfcrowd.rb', line 2187

def setDataOptions(options)
    @fields['data_options'] = options
    self
end

#setDataString(data_string) ⇒ Object

Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.

  • data_string - The input data string.

  • Returns - The converter object.



2120
2121
2122
2123
 
# File 'lib/pdfcrowd.rb', line 2120

def setDataString(data_string)
    @fields['data_string'] = data_string
    self
end

#setDataTrimBlocks(value) ⇒ Object

Auto trim whitespace around each template command block.

  • value - Set to true to turn auto trimming on.

  • Returns - The converter object.



2178
2179
2180
2181
 
# File 'lib/pdfcrowd.rb', line 2178

def setDataTrimBlocks(value)
    @fields['data_trim_blocks'] = value
    self
end

#setDebugLog(value) ⇒ Object

Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

  • value - Set to true to enable the debug logging.

  • Returns - The converter object.



2196
2197
2198
2199
 
# File 'lib/pdfcrowd.rb', line 2196

def setDebugLog(value)
    @fields['debug_log'] = value
    self
end

#setDefaultEncoding(encoding) ⇒ Object

Set the default HTML content text encoding.

  • encoding - The text encoding of the HTML content.

  • Returns - The converter object.



1542
1543
1544
1545
 
# File 'lib/pdfcrowd.rb', line 1542

def setDefaultEncoding(encoding)
    @fields['default_encoding'] = encoding
    self
end

#setDisableImageLoading(value) ⇒ Object

Do not load images.

  • value - Set to true to disable loading of images.

  • Returns - The converter object.



1493
1494
1495
1496
 
# File 'lib/pdfcrowd.rb', line 1493

def setDisableImageLoading(value)
    @fields['disable_image_loading'] = value
    self
end

#setDisableJavascript(value) ⇒ Object

Do not execute JavaScript.

  • value - Set to true to disable JavaScript in web pages.

  • Returns - The converter object.



1484
1485
1486
1487
 
# File 'lib/pdfcrowd.rb', line 1484

def setDisableJavascript(value)
    @fields['disable_javascript'] = value
    self
end

#setDisablePageHeightOptimization(value) ⇒ Object

Disable automatic height adjustment that compensates for pixel to point rounding errors.

  • value - Set to true to disable automatic height scale.

  • Returns - The converter object.



2353
2354
2355
2356
 
# File 'lib/pdfcrowd.rb', line 2353

def setDisablePageHeightOptimization(value)
    @fields['disable_page_height_optimization'] = value
    self
end

#setDisableRemoteFonts(value) ⇒ Object

Disable loading fonts from remote sources.

  • value - Set to true disable loading remote fonts.

  • Returns - The converter object.



1502
1503
1504
1505
 
# File 'lib/pdfcrowd.rb', line 1502

def setDisableRemoteFonts(value)
    @fields['disable_remote_fonts'] = value
    self
end

#setDisplayTitle(value) ⇒ Object

Specify whether the window’s title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.

  • value - Set to true to display the title.

  • Returns - The converter object.



2102
2103
2104
2105
 
# File 'lib/pdfcrowd.rb', line 2102

def setDisplayTitle(value)
    @fields['display_title'] = value
    self
end

#setElementToConvert(selectors) ⇒ Object

Convert only the specified element from the main document and its children. The element is specified by one or more CSS selectors. If the element is not found, the conversion fails. If multiple elements are found, the first one is used.

  • selectors - One or more CSS selectors separated by commas. The string must not be empty.

  • Returns - The converter object.



1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'lib/pdfcrowd.rb', line 1699

def setElementToConvert(selectors)
    if (!(!selectors.nil? && !selectors.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(selectors, "setElementToConvert", "html-to-pdf", "The string must not be empty.", "set_element_to_convert"), 470);
    end
    
    @fields['element_to_convert'] = selectors
    self
end

#setElementToConvertMode(mode) ⇒ Object

Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.

  • mode - Allowed values are cut-out, remove-siblings, hide-siblings.

  • Returns - The converter object.



1712
1713
1714
1715
1716
1717
1718
1719
 
# File 'lib/pdfcrowd.rb', line 1712

def setElementToConvertMode(mode)
    unless /(?i)^(cut-out|remove-siblings|hide-siblings)$/.match(mode)
        raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setElementToConvertMode", "html-to-pdf", "Allowed values are cut-out, remove-siblings, hide-siblings.", "set_element_to_convert_mode"), 470);
    end
    
    @fields['element_to_convert_mode'] = mode
    self
end

#setEnablePdfForms(value) ⇒ Object

Convert HTML forms to fillable PDF forms. Details can be found in the blog post.

  • value - Set to true to make fillable PDF forms.

  • Returns - The converter object.



1875
1876
1877
1878
 
# File 'lib/pdfcrowd.rb', line 1875

def setEnablePdfForms(value)
    @fields['enable_pdf_forms'] = value
    self
end

#setEncrypt(value) ⇒ Object

Encrypt the PDF. This prevents search engines from indexing the contents.

  • value - Set to true to enable PDF encryption.

  • Returns - The converter object.



1893
1894
1895
1896
 
# File 'lib/pdfcrowd.rb', line 1893

def setEncrypt(value)
    @fields['encrypt'] = value
    self
end

#setExcludeFooterOnPages(pages) ⇒ Object

The page footer is not printed on the specified pages.

  • pages - List of physical page numbers. Negative numbers count backwards from the last page: -1 is the last page, -2 is the last but one page, and so on. A comma separated list of page numbers.

  • Returns - The converter object.



1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/pdfcrowd.rb', line 1323

def setExcludeFooterOnPages(pages)
    unless /^(?:\s*\-?\d+\s*,)*\s*\-?\d+\s*$/.match(pages)
        raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setExcludeFooterOnPages", "html-to-pdf", "A comma separated list of page numbers.", "set_exclude_footer_on_pages"), 470);
    end
    
    @fields['exclude_footer_on_pages'] = pages
    self
end

#setExcludeHeaderOnPages(pages) ⇒ Object

The page header is not printed on the specified pages.

  • pages - List of physical page numbers. Negative numbers count backwards from the last page: -1 is the last page, -2 is the last but one page, and so on. A comma separated list of page numbers.

  • Returns - The converter object.



1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'lib/pdfcrowd.rb', line 1310

def setExcludeHeaderOnPages(pages)
    unless /^(?:\s*\-?\d+\s*,)*\s*\-?\d+\s*$/.match(pages)
        raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setExcludeHeaderOnPages", "html-to-pdf", "A comma separated list of page numbers.", "set_exclude_header_on_pages"), 470);
    end
    
    @fields['exclude_header_on_pages'] = pages
    self
end

#setExtractMetaTags(value) ⇒ Object

Extract meta tags (author, keywords and description) from the input HTML and use them in the output PDF.

  • value - Set to true to extract meta tags.

  • Returns - The converter object.



1983
1984
1985
1986
 
# File 'lib/pdfcrowd.rb', line 1983

def setExtractMetaTags(value)
    @fields['extract_meta_tags'] = value
    self
end

#setFailOnAnyUrlError(fail_on_error) ⇒ Object

Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.

  • fail_on_error - Set to true to abort the conversion.

  • Returns - The converter object.



1616
1617
1618
1619
 
# File 'lib/pdfcrowd.rb', line 1616

def setFailOnAnyUrlError(fail_on_error)
    @fields['fail_on_any_url_error'] = fail_on_error
    self
end

#setFailOnMainUrlError(fail_on_error) ⇒ Object

Abort the conversion if the main URL HTTP status code is greater than or equal to 400.

  • fail_on_error - Set to true to abort the conversion.

  • Returns - The converter object.



1607
1608
1609
1610
 
# File 'lib/pdfcrowd.rb', line 1607

def setFailOnMainUrlError(fail_on_error)
    @fields['fail_on_main_url_error'] = fail_on_error
    self
end

#setFitWindow(value) ⇒ Object

Specify whether to resize the document’s window to fit the size of the first displayed page.

  • value - Set to true to resize the window.

  • Returns - The converter object.



2084
2085
2086
2087
 
# File 'lib/pdfcrowd.rb', line 2084

def setFitWindow(value)
    @fields['fit_window'] = value
    self
end

#setFooterHeight(height) ⇒ Object

Set the footer height.

  • height - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/pdfcrowd.rb', line 1279

def setFooterHeight(height)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
        raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setFooterHeight", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_footer_height"), 470);
    end
    
    @fields['footer_height'] = height
    self
end

#setFooterHtml(html) ⇒ Object

Use the specified HTML as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: <span class=‘pdfcrowd-page-number’ data-pdfcrowd-number-format=‘roman’></span> data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: <span class=‘pdfcrowd-source-url’></span> will produce <span>example.com</span> href - the URL is set to the href attribute Example: <a class=‘pdfcrowd-source-url’ data-pdfcrowd-placement=‘href’>Link to source</a> will produce <a href=‘example.com’>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class=‘pdfcrowd-source-url’ data-pdfcrowd-placement=‘href-and-content’></a> will produce <a href=‘example.com’>example.com</a>

  • html - The string must not be empty.

  • Returns - The converter object.



1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'lib/pdfcrowd.rb', line 1266

def setFooterHtml(html)
    if (!(!html.nil? && !html.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(html, "setFooterHtml", "html-to-pdf", "The string must not be empty.", "set_footer_html"), 470);
    end
    
    @fields['footer_html'] = html
    self
end

#setFooterMatrix(matrix) ⇒ Object

A 2D transformation matrix applied to the page footer contents. The origin [0,0] is located at the top-left corner of the footer. The resolution is 72 dpi.

  • matrix - A comma separated string of matrix elements: “scaleX,skewX,transX,skewY,scaleY,transY”

  • Returns - The converter object.



2344
2345
2346
2347
 
# File 'lib/pdfcrowd.rb', line 2344

def setFooterMatrix(matrix)
    @fields['footer_matrix'] = matrix
    self
end

#setFooterUrl(url) ⇒ Object

Load an HTML code from the specified URL and use it as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: <span class=‘pdfcrowd-page-number’ data-pdfcrowd-number-format=‘roman’></span> data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: <span class=‘pdfcrowd-source-url’></span> will produce <span>example.com</span> href - the URL is set to the href attribute Example: <a class=‘pdfcrowd-source-url’ data-pdfcrowd-placement=‘href’>Link to source</a> will produce <a href=‘example.com’>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class=‘pdfcrowd-source-url’ data-pdfcrowd-placement=‘href-and-content’></a> will produce <a href=‘example.com’>example.com</a>

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/pdfcrowd.rb', line 1253

def setFooterUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setFooterUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_footer_url"), 470);
    end
    
    @fields['footer_url'] = url
    self
end

#setHeaderFooterCssAnnotation(value) ⇒ Object

Add special CSS classes to the header/footer’s body element. This allows applying custom styling based on these classes: pdfcrowd-page-X - where X is the current page number pdfcrowd-page-count-X - where X is the total page count pdfcrowd-page-first - the first page pdfcrowd-page-last - the last page pdfcrowd-page-odd - odd page pdfcrowd-page-even - even page

  • value - Set to true to add the special CSS classes.

  • Returns - The converter object.



2372
2373
2374
2375
 
# File 'lib/pdfcrowd.rb', line 2372

def setHeaderFooterCssAnnotation(value)
    @fields['header_footer_css_annotation'] = value
    self
end

#setHeaderFooterScaleFactor(factor) ⇒ Object

Set the scaling factor (zoom) for the header and footer.

  • factor - The percentage value. The value must be in the range 10-500.

  • Returns - The converter object.



1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/pdfcrowd.rb', line 1336

def setHeaderFooterScaleFactor(factor)
    if (!(Integer(factor) >= 10 && Integer(factor) <= 500))
        raise Error.new(Pdfcrowd.create_invalid_value_message(factor, "setHeaderFooterScaleFactor", "html-to-pdf", "The value must be in the range 10-500.", "set_header_footer_scale_factor"), 470);
    end
    
    @fields['header_footer_scale_factor'] = factor
    self
end

#setHeaderHeight(height) ⇒ Object

Set the header height.

  • height - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1231
1232
1233
1234
1235
1236
1237
1238
 
# File 'lib/pdfcrowd.rb', line 1231

def setHeaderHeight(height)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
        raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setHeaderHeight", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_header_height"), 470);
    end
    
    @fields['header_height'] = height
    self
end

#setHeaderHtml(html) ⇒ Object

Use the specified HTML code as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: <span class=‘pdfcrowd-page-number’ data-pdfcrowd-number-format=‘roman’></span> data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: <span class=‘pdfcrowd-source-url’></span> will produce <span>example.com</span> href - the URL is set to the href attribute Example: <a class=‘pdfcrowd-source-url’ data-pdfcrowd-placement=‘href’>Link to source</a> will produce <a href=‘example.com’>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class=‘pdfcrowd-source-url’ data-pdfcrowd-placement=‘href-and-content’></a> will produce <a href=‘example.com’>example.com</a>

  • html - The string must not be empty.

  • Returns - The converter object.



1218
1219
1220
1221
1222
1223
1224
1225
 
# File 'lib/pdfcrowd.rb', line 1218

def setHeaderHtml(html)
    if (!(!html.nil? && !html.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(html, "setHeaderHtml", "html-to-pdf", "The string must not be empty.", "set_header_html"), 470);
    end
    
    @fields['header_html'] = html
    self
end

#setHeaderMatrix(matrix) ⇒ Object

A 2D transformation matrix applied to the page header contents. The origin [0,0] is located at the top-left corner of the header. The resolution is 72 dpi.

  • matrix - A comma separated string of matrix elements: “scaleX,skewX,transX,skewY,scaleY,transY”

  • Returns - The converter object.



2335
2336
2337
2338
 
# File 'lib/pdfcrowd.rb', line 2335

def setHeaderMatrix(matrix)
    @fields['header_matrix'] = matrix
    self
end

#setHeaderUrl(url) ⇒ Object

Load an HTML code from the specified URL and use it as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of the converted document pdfcrowd-source-title - the title of the converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: <span class=‘pdfcrowd-page-number’ data-pdfcrowd-number-format=‘roman’></span> data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: <span class=‘pdfcrowd-source-url’></span> will produce <span>example.com</span> href - the URL is set to the href attribute Example: <a class=‘pdfcrowd-source-url’ data-pdfcrowd-placement=‘href’>Link to source</a> will produce <a href=‘example.com’>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class=‘pdfcrowd-source-url’ data-pdfcrowd-placement=‘href-and-content’></a> will produce <a href=‘example.com’>example.com</a>

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



1205
1206
1207
1208
1209
1210
1211
1212
 
# File 'lib/pdfcrowd.rb', line 1205

def setHeaderUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setHeaderUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_header_url"), 470);
    end
    
    @fields['header_url'] = url
    self
end

#setHideMenubar(value) ⇒ Object

Specify whether to hide the viewer application’s menu bar when the document is active.

  • value - Set to true to hide the menu bar.

  • Returns - The converter object.



2066
2067
2068
2069
 
# File 'lib/pdfcrowd.rb', line 2066

def setHideMenubar(value)
    @fields['hide_menubar'] = value
    self
end

#setHideToolbar(value) ⇒ Object

Specify whether to hide the viewer application’s tool bars when the document is active.

  • value - Set to true to hide tool bars.

  • Returns - The converter object.



2057
2058
2059
2060
 
# File 'lib/pdfcrowd.rb', line 2057

def setHideToolbar(value)
    @fields['hide_toolbar'] = value
    self
end

#setHideWindowUi(value) ⇒ Object

Specify whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed.

  • value - Set to true to hide ui elements.

  • Returns - The converter object.



2075
2076
2077
2078
 
# File 'lib/pdfcrowd.rb', line 2075

def setHideWindowUi(value)
    @fields['hide_window_ui'] = value
    self
end

#setHttpAuth(user_name, password) ⇒ Object

Set credentials to access HTTP base authentication protected websites.

  • user_name - Set the HTTP authentication user name.

  • password - Set the HTTP authentication password.

  • Returns - The converter object.



1579
1580
1581
1582
1583
 
# File 'lib/pdfcrowd.rb', line 1579

def setHttpAuth(user_name, password)
    setHttpAuthUserName(user_name)
    setHttpAuthPassword(password)
    self
end

#setHttpAuthPassword(password) ⇒ Object

Set the HTTP authentication password.

  • password - The password.

  • Returns - The converter object.



1569
1570
1571
1572
 
# File 'lib/pdfcrowd.rb', line 1569

def setHttpAuthPassword(password)
    @fields['http_auth_password'] = password
    self
end

#setHttpAuthUserName(user_name) ⇒ Object

Set the HTTP authentication user name.

  • user_name - The user name.

  • Returns - The converter object.



1560
1561
1562
1563
 
# File 'lib/pdfcrowd.rb', line 1560

def setHttpAuthUserName(user_name)
    @fields['http_auth_user_name'] = user_name
    self
end

#setHttpProxy(proxy) ⇒ Object

A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

  • proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

  • Returns - The converter object.



2265
2266
2267
2268
2269
2270
2271
2272
 
# File 'lib/pdfcrowd.rb', line 2265

def setHttpProxy(proxy)
    unless /(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$/.match(proxy)
        raise Error.new(Pdfcrowd.create_invalid_value_message(proxy, "setHttpProxy", "html-to-pdf", "The value must have format DOMAIN_OR_IP_ADDRESS:PORT.", "set_http_proxy"), 470);
    end
    
    @fields['http_proxy'] = proxy
    self
end

#setHttpsProxy(proxy) ⇒ Object

A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

  • proxy - The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

  • Returns - The converter object.



2278
2279
2280
2281
2282
2283
2284
2285
 
# File 'lib/pdfcrowd.rb', line 2278

def setHttpsProxy(proxy)
    unless /(?i)^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z0-9]{1,}:\d+$/.match(proxy)
        raise Error.new(Pdfcrowd.create_invalid_value_message(proxy, "setHttpsProxy", "html-to-pdf", "The value must have format DOMAIN_OR_IP_ADDRESS:PORT.", "set_https_proxy"), 470);
    end
    
    @fields['https_proxy'] = proxy
    self
end

#setImageDpi(dpi) ⇒ Object

Set the DPI of images in PDF. A lower DPI may result in a smaller PDF file. If the specified DPI is higher than the actual image DPI, the original image DPI is retained (no upscaling is performed). Use 0 to leave the images unaltered.

  • dpi - The DPI value. Must be a positive integer number or 0.

  • Returns - The converter object.



1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/pdfcrowd.rb', line 1862

def setImageDpi(dpi)
    if (!(Integer(dpi) >= 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(dpi, "setImageDpi", "html-to-pdf", "Must be a positive integer number or 0.", "set_image_dpi"), 470);
    end
    
    @fields['image_dpi'] = dpi
    self
end

#setInitialPage(page) ⇒ Object

Display the specified page when the document is opened.

  • page - Must be a positive integer number.

  • Returns - The converter object.



2031
2032
2033
2034
2035
2036
2037
2038
 
# File 'lib/pdfcrowd.rb', line 2031

def setInitialPage(page)
    if (!(Integer(page) > 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(page, "setInitialPage", "html-to-pdf", "Must be a positive integer number.", "set_initial_page"), 470);
    end
    
    @fields['initial_page'] = page
    self
end

#setInitialZoom(zoom) ⇒ Object

Specify the initial page zoom in percents when the document is opened.

  • zoom - Must be a positive integer number.

  • Returns - The converter object.



2044
2045
2046
2047
2048
2049
2050
2051
 
# File 'lib/pdfcrowd.rb', line 2044

def setInitialZoom(zoom)
    if (!(Integer(zoom) > 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(zoom, "setInitialZoom", "html-to-pdf", "Must be a positive integer number.", "set_initial_zoom"), 470);
    end
    
    @fields['initial_zoom'] = zoom
    self
end

#setInitialZoomType(zoom_type) ⇒ Object

Specify how the page should be displayed when opened.

  • zoom_type - Allowed values are fit-width, fit-height, fit-page.

  • Returns - The converter object.



2018
2019
2020
2021
2022
2023
2024
2025
 
# File 'lib/pdfcrowd.rb', line 2018

def setInitialZoomType(zoom_type)
    unless /(?i)^(fit-width|fit-height|fit-page)$/.match(zoom_type)
        raise Error.new(Pdfcrowd.create_invalid_value_message(zoom_type, "setInitialZoomType", "html-to-pdf", "Allowed values are fit-width, fit-height, fit-page.", "set_initial_zoom_type"), 470);
    end
    
    @fields['initial_zoom_type'] = zoom_type
    self
end

#setJavascriptDelay(delay) ⇒ Object

Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by “Max Delay” parameter.

  • delay - The number of milliseconds to wait. Must be a positive integer number or 0.

  • Returns - The converter object.



1686
1687
1688
1689
1690
1691
1692
1693
 
# File 'lib/pdfcrowd.rb', line 1686

def setJavascriptDelay(delay)
    if (!(Integer(delay) >= 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(delay, "setJavascriptDelay", "html-to-pdf", "Must be a positive integer number or 0.", "set_javascript_delay"), 470);
    end
    
    @fields['javascript_delay'] = delay
    self
end

#setJpegQuality(quality) ⇒ Object

Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts.

  • quality - The percentage value. The value must be in the range 1-100.

  • Returns - The converter object.



1836
1837
1838
1839
1840
1841
1842
1843
 
# File 'lib/pdfcrowd.rb', line 1836

def setJpegQuality(quality)
    if (!(Integer(quality) >= 1 && Integer(quality) <= 100))
        raise Error.new(Pdfcrowd.create_invalid_value_message(quality, "setJpegQuality", "html-to-pdf", "The value must be in the range 1-100.", "set_jpeg_quality"), 470);
    end
    
    @fields['jpeg_quality'] = quality
    self
end

#setKeywords(keywords) ⇒ Object

Associate keywords with the document.

  • keywords - The string with the keywords.

  • Returns - The converter object.



1974
1975
1976
1977
 
# File 'lib/pdfcrowd.rb', line 1974

def setKeywords(keywords)
    @fields['keywords'] = keywords
    self
end

#setLayoutDpi(dpi) ⇒ Object

Set the internal DPI resolution used for positioning of PDF contents. It can help in situations when there are small inaccuracies in the PDF. It is recommended to use values that are a multiple of 72, such as 288 or 360.

  • dpi - The DPI value. The value must be in the range of 72-600.

  • Returns - The converter object.



2313
2314
2315
2316
2317
2318
2319
2320
 
# File 'lib/pdfcrowd.rb', line 2313

def setLayoutDpi(dpi)
    if (!(Integer(dpi) >= 72 && Integer(dpi) <= 600))
        raise Error.new(Pdfcrowd.create_invalid_value_message(dpi, "setLayoutDpi", "html-to-pdf", "The value must be in the range of 72-600.", "set_layout_dpi"), 470);
    end
    
    @fields['layout_dpi'] = dpi
    self
end

#setLinearize(value) ⇒ Object

Create linearized PDF. This is also known as Fast Web View.

  • value - Set to true to create linearized PDF.

  • Returns - The converter object.



1884
1885
1886
1887
 
# File 'lib/pdfcrowd.rb', line 1884

def setLinearize(value)
    @fields['linearize'] = value
    self
end

#setLoadIframes(iframes) ⇒ Object

Specifies how iframes are handled.

  • iframes - Allowed values are all, same-origin, none.

  • Returns - The converter object.



1520
1521
1522
1523
1524
1525
1526
1527
 
# File 'lib/pdfcrowd.rb', line 1520

def setLoadIframes(iframes)
    unless /(?i)^(all|same-origin|none)$/.match(iframes)
        raise Error.new(Pdfcrowd.create_invalid_value_message(iframes, "setLoadIframes", "html-to-pdf", "Allowed values are all, same-origin, none.", "set_load_iframes"), 470);
    end
    
    @fields['load_iframes'] = iframes
    self
end

#setLocale(locale) ⇒ Object

Set the locale for the conversion. This may affect the output format of dates, times and numbers.

  • locale - The locale code according to ISO 639.

  • Returns - The converter object.



1551
1552
1553
1554
 
# File 'lib/pdfcrowd.rb', line 1551

def setLocale(locale)
    @fields['locale'] = locale
    self
end

#setMainDocumentCssAnnotation(value) ⇒ Object

Add special CSS classes to the main document’s body element. This allows applying custom styling based on these classes: pdfcrowd-page-X - where X is the current page number pdfcrowd-page-odd - odd page pdfcrowd-page-even - even page Warning: If your custom styling affects the contents area size (e.g. by using different margins, padding, border width), the resulting PDF may contain duplicit contents or some contents may be missing.

  • value - Set to true to add the special CSS classes.

  • Returns - The converter object.



2363
2364
2365
2366
 
# File 'lib/pdfcrowd.rb', line 2363

def setMainDocumentCssAnnotation(value)
    @fields['main_document_css_annotation'] = value
    self
end

#setMarginBottom(bottom) ⇒ Object

Set the output page bottom margin.

  • bottom - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1040
1041
1042
1043
1044
1045
1046
1047
 
# File 'lib/pdfcrowd.rb', line 1040

def setMarginBottom(bottom)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(bottom)
        raise Error.new(Pdfcrowd.create_invalid_value_message(bottom, "setMarginBottom", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_margin_bottom"), 470);
    end
    
    @fields['margin_bottom'] = bottom
    self
end

#setMarginLeft(left) ⇒ Object

Set the output page left margin.

  • left - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1053
1054
1055
1056
1057
1058
1059
1060
 
# File 'lib/pdfcrowd.rb', line 1053

def setMarginLeft(left)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(left)
        raise Error.new(Pdfcrowd.create_invalid_value_message(left, "setMarginLeft", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_margin_left"), 470);
    end
    
    @fields['margin_left'] = left
    self
end

#setMarginRight(right) ⇒ Object

Set the output page right margin.

  • right - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'lib/pdfcrowd.rb', line 1027

def setMarginRight(right)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(right)
        raise Error.new(Pdfcrowd.create_invalid_value_message(right, "setMarginRight", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_margin_right"), 470);
    end
    
    @fields['margin_right'] = right
    self
end

#setMarginTop(top) ⇒ Object

Set the output page top margin.

  • top - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/pdfcrowd.rb', line 1014

def setMarginTop(top)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(top)
        raise Error.new(Pdfcrowd.create_invalid_value_message(top, "setMarginTop", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_margin_top"), 470);
    end
    
    @fields['margin_top'] = top
    self
end

#setMaxLoadingTime(max_time) ⇒ Object

Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.

  • max_time - The number of seconds to wait. The value must be in the range 10-30.

  • Returns - The converter object.



2381
2382
2383
2384
2385
2386
2387
2388
 
# File 'lib/pdfcrowd.rb', line 2381

def setMaxLoadingTime(max_time)
    if (!(Integer(max_time) >= 10 && Integer(max_time) <= 30))
        raise Error.new(Pdfcrowd.create_invalid_value_message(max_time, "setMaxLoadingTime", "html-to-pdf", "The value must be in the range 10-30.", "set_max_loading_time"), 470);
    end
    
    @fields['max_loading_time'] = max_time
    self
end

#setMultipageBackground(background) ⇒ Object

Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.

  • background - The file path to a local file. The file must exist and not be empty.

  • Returns - The converter object.



1427
1428
1429
1430
1431
1432
1433
1434
 
# File 'lib/pdfcrowd.rb', line 1427

def setMultipageBackground(background)
    if (!(File.file?(background) && !File.zero?(background)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(background, "setMultipageBackground", "html-to-pdf", "The file must exist and not be empty.", "set_multipage_background"), 470);
    end
    
    @files['multipage_background'] = background
    self
end

#setMultipageBackgroundUrl(url) ⇒ Object

Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



1440
1441
1442
1443
1444
1445
1446
1447
 
# File 'lib/pdfcrowd.rb', line 1440

def setMultipageBackgroundUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setMultipageBackgroundUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_multipage_background_url"), 470);
    end
    
    @fields['multipage_background_url'] = url
    self
end

#setMultipageWatermark(watermark) ⇒ Object

Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.

  • watermark - The file path to a local file. The file must exist and not be empty.

  • Returns - The converter object.



1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/pdfcrowd.rb', line 1375

def setMultipageWatermark(watermark)
    if (!(File.file?(watermark) && !File.zero?(watermark)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(watermark, "setMultipageWatermark", "html-to-pdf", "The file must exist and not be empty.", "set_multipage_watermark"), 470);
    end
    
    @files['multipage_watermark'] = watermark
    self
end

#setMultipageWatermarkUrl(url) ⇒ Object

Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'lib/pdfcrowd.rb', line 1388

def setMultipageWatermarkUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setMultipageWatermarkUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_multipage_watermark_url"), 470);
    end
    
    @fields['multipage_watermark_url'] = url
    self
end

#setNoBackground(value) ⇒ Object

Do not print the background graphics.

  • value - Set to true to disable the background graphics.

  • Returns - The converter object.



1475
1476
1477
1478
 
# File 'lib/pdfcrowd.rb', line 1475

def setNoBackground(value)
    @fields['no_background'] = value
    self
end

#setNoCopy(value) ⇒ Object

Disallow text and graphics extraction from the output PDF.

  • value - Set to true to set the no-copy flag in the output PDF.

  • Returns - The converter object.



1938
1939
1940
1941
 
# File 'lib/pdfcrowd.rb', line 1938

def setNoCopy(value)
    @fields['no_copy'] = value
    self
end

#setNoHeaderFooterHorizontalMargins(value) ⇒ Object

Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.

  • value - Set to true to disable horizontal margins for header and footer.

  • Returns - The converter object.



1301
1302
1303
1304
 
# File 'lib/pdfcrowd.rb', line 1301

def setNoHeaderFooterHorizontalMargins(value)
    @fields['no_header_footer_horizontal_margins'] = value
    self
end

#setNoMargins(value) ⇒ Object

Disable page margins.

  • value - Set to true to disable margins.

  • Returns - The converter object.



1066
1067
1068
1069
 
# File 'lib/pdfcrowd.rb', line 1066

def setNoMargins(value)
    @fields['no_margins'] = value
    self
end

#setNoModify(value) ⇒ Object

Disallow modification of the output PDF.

  • value - Set to true to set the read-only only flag in the output PDF.

  • Returns - The converter object.



1929
1930
1931
1932
 
# File 'lib/pdfcrowd.rb', line 1929

def setNoModify(value)
    @fields['no_modify'] = value
    self
end

#setNoPrint(value) ⇒ Object

Disallow printing of the output PDF.

  • value - Set to true to set the no-print flag in the output PDF.

  • Returns - The converter object.



1920
1921
1922
1923
 
# File 'lib/pdfcrowd.rb', line 1920

def setNoPrint(value)
    @fields['no_print'] = value
    self
end

#setNoXpdfcrowdHeader(value) ⇒ Object

Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.

  • value - Set to true to disable sending X-Pdfcrowd HTTP header.

  • Returns - The converter object.



1625
1626
1627
1628
 
# File 'lib/pdfcrowd.rb', line 1625

def setNoXpdfcrowdHeader(value)
    @fields['no_xpdfcrowd_header'] = value
    self
end

#setOnLoadJavascript(javascript) ⇒ Object

Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, …). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.

  • javascript - A string containing a JavaScript code. The string must not be empty.

  • Returns - The converter object.



1660
1661
1662
1663
1664
1665
1666
1667
 
# File 'lib/pdfcrowd.rb', line 1660

def setOnLoadJavascript(javascript)
    if (!(!javascript.nil? && !javascript.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(javascript, "setOnLoadJavascript", "html-to-pdf", "The string must not be empty.", "set_on_load_javascript"), 470);
    end
    
    @fields['on_load_javascript'] = javascript
    self
end

#setOrientation(orientation) ⇒ Object

Set the output page orientation.

  • orientation - Allowed values are landscape, portrait.

  • Returns - The converter object.



1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/pdfcrowd.rb', line 1001

def setOrientation(orientation)
    unless /(?i)^(landscape|portrait)$/.match(orientation)
        raise Error.new(Pdfcrowd.create_invalid_value_message(orientation, "setOrientation", "html-to-pdf", "Allowed values are landscape, portrait.", "set_orientation"), 470);
    end
    
    @fields['orientation'] = orientation
    self
end

#setOwnerPassword(password) ⇒ Object

Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.

  • password - The owner password.

  • Returns - The converter object.



1911
1912
1913
1914
 
# File 'lib/pdfcrowd.rb', line 1911

def setOwnerPassword(password)
    @fields['owner_password'] = password
    self
end

#setPageBackground(background) ⇒ Object

Apply a background to each page of the output PDF file. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.

  • background - The file path to a local file. The file must exist and not be empty.

  • Returns - The converter object.



1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/pdfcrowd.rb', line 1401

def setPageBackground(background)
    if (!(File.file?(background) && !File.zero?(background)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(background, "setPageBackground", "html-to-pdf", "The file must exist and not be empty.", "set_page_background"), 470);
    end
    
    @files['page_background'] = background
    self
end

#setPageBackgroundColor(color) ⇒ Object

The page background color in RGB or RGBA hexadecimal format. The color fills the entire page regardless of the margins.

  • color - The value must be in RRGGBB or RRGGBBAA hexadecimal format.

  • Returns - The converter object.



1453
1454
1455
1456
1457
1458
1459
1460
 
# File 'lib/pdfcrowd.rb', line 1453

def setPageBackgroundColor(color)
    unless /^[0-9a-fA-F]{6,8}$/.match(color)
        raise Error.new(Pdfcrowd.create_invalid_value_message(color, "setPageBackgroundColor", "html-to-pdf", "The value must be in RRGGBB or RRGGBBAA hexadecimal format.", "set_page_background_color"), 470);
    end
    
    @fields['page_background_color'] = color
    self
end

#setPageBackgroundUrl(url) ⇒ Object

Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the background.

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/pdfcrowd.rb', line 1414

def setPageBackgroundUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setPageBackgroundUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_page_background_url"), 470);
    end
    
    @fields['page_background_url'] = url
    self
end

#setPageDimensions(width, height) ⇒ Object

Set the output page dimensions.

  • width - Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • height - Set the output page height. Use -1 for a single page PDF. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF. The value must be -1 or specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



991
992
993
994
995
 
# File 'lib/pdfcrowd.rb', line 991

def setPageDimensions(width, height)
    setPageWidth(width)
    setPageHeight(height)
    self
end

#setPageHeight(height) ⇒ Object

Set the output page height. Use -1 for a single page PDF. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.

  • height - The value must be -1 or specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



977
978
979
980
981
982
983
984
 
# File 'lib/pdfcrowd.rb', line 977

def setPageHeight(height)
    unless /(?i)^0$|^\-1$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
        raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setPageHeight", "html-to-pdf", "The value must be -1 or specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_page_height"), 470);
    end
    
    @fields['page_height'] = height
    self
end

#setPageLayout(layout) ⇒ Object

Specify the page layout to be used when the document is opened.

  • layout - Allowed values are single-page, one-column, two-column-left, two-column-right.

  • Returns - The converter object.



1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/pdfcrowd.rb', line 1992

def setPageLayout(layout)
    unless /(?i)^(single-page|one-column|two-column-left|two-column-right)$/.match(layout)
        raise Error.new(Pdfcrowd.create_invalid_value_message(layout, "setPageLayout", "html-to-pdf", "Allowed values are single-page, one-column, two-column-left, two-column-right.", "set_page_layout"), 470);
    end
    
    @fields['page_layout'] = layout
    self
end

#setPageMargins(top, right, bottom, left) ⇒ Object

Set the output page margins.

  • top - Set the output page top margin. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • right - Set the output page right margin. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • bottom - Set the output page bottom margin. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • left - Set the output page left margin. The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/pdfcrowd.rb', line 1078

def setPageMargins(top, right, bottom, left)
    setMarginTop(top)
    setMarginRight(right)
    setMarginBottom(bottom)
    setMarginLeft(left)
    self
end

#setPageMode(mode) ⇒ Object

Specify how the document should be displayed when opened.

  • mode - Allowed values are full-screen, thumbnails, outlines.

  • Returns - The converter object.



2005
2006
2007
2008
2009
2010
2011
2012
 
# File 'lib/pdfcrowd.rb', line 2005

def setPageMode(mode)
    unless /(?i)^(full-screen|thumbnails|outlines)$/.match(mode)
        raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setPageMode", "html-to-pdf", "Allowed values are full-screen, thumbnails, outlines.", "set_page_mode"), 470);
    end
    
    @fields['page_mode'] = mode
    self
end

#setPageNumberingOffset(offset) ⇒ Object

Set an offset between physical and logical page numbers.

  • offset - Integer specifying page offset.

  • Returns - The converter object.



1103
1104
1105
1106
 
# File 'lib/pdfcrowd.rb', line 1103

def setPageNumberingOffset(offset)
    @fields['page_numbering_offset'] = offset
    self
end

#setPageSize(size) ⇒ Object

Set the output page size.

  • size - Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.

  • Returns - The converter object.



951
952
953
954
955
956
957
958
 
# File 'lib/pdfcrowd.rb', line 951

def setPageSize(size)
    unless /(?i)^(A0|A1|A2|A3|A4|A5|A6|Letter)$/.match(size)
        raise Error.new(Pdfcrowd.create_invalid_value_message(size, "setPageSize", "html-to-pdf", "Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.", "set_page_size"), 470);
    end
    
    @fields['page_size'] = size
    self
end

#setPageWatermark(watermark) ⇒ Object

Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.

  • watermark - The file path to a local file. The file must exist and not be empty.

  • Returns - The converter object.



1349
1350
1351
1352
1353
1354
1355
1356
 
# File 'lib/pdfcrowd.rb', line 1349

def setPageWatermark(watermark)
    if (!(File.file?(watermark) && !File.zero?(watermark)))
        raise Error.new(Pdfcrowd.create_invalid_value_message(watermark, "setPageWatermark", "html-to-pdf", "The file must exist and not be empty.", "set_page_watermark"), 470);
    end
    
    @files['page_watermark'] = watermark
    self
end

#setPageWatermarkUrl(url) ⇒ Object

Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.

  • url - The supported protocols are http:// and https://.

  • Returns - The converter object.



1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'lib/pdfcrowd.rb', line 1362

def setPageWatermarkUrl(url)
    unless /(?i)^https?:\/\/.*$/.match(url)
        raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setPageWatermarkUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_page_watermark_url"), 470);
    end
    
    @fields['page_watermark_url'] = url
    self
end

#setPageWidth(width) ⇒ Object

Set the output page width. The safe maximum is 200in otherwise some PDF viewers may be unable to open the PDF.

  • width - The value must be specified in inches “in”, millimeters “mm”, centimeters “cm”, pixels “px”, or points “pt”.

  • Returns - The converter object.



964
965
966
967
968
969
970
971
 
# File 'lib/pdfcrowd.rb', line 964

def setPageWidth(width)
    unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(width)
        raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setPageWidth", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_page_width"), 470);
    end
    
    @fields['page_width'] = width
    self
end

#setPrintPageRange(pages) ⇒ Object

Set the page range to print.

  • pages - A comma separated list of page numbers or ranges.

  • Returns - The converter object.



1090
1091
1092
1093
1094
1095
1096
1097
 
# File 'lib/pdfcrowd.rb', line 1090

def setPrintPageRange(pages)
    unless /^(?:\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*,\s*)*\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*$/.match(pages)
        raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setPrintPageRange", "html-to-pdf", "A comma separated list of page numbers or ranges.", "set_print_page_range"), 470);
    end
    
    @fields['print_page_range'] = pages
    self
end

#setProxy(host, port, user_name, password) ⇒ Object

Specifies an HTTP proxy that the API client library will use to connect to the internet.

  • host - The proxy hostname.

  • port - The proxy port.

  • user_name - The username.

  • password - The password.

  • Returns - The converter object.



2429
2430
2431
2432
 
# File 'lib/pdfcrowd.rb', line 2429

def setProxy(host, port, user_name, password)
    @helper.setProxy(host, port, user_name, password)
    self
end

#setReadabilityEnhancements(enhancements) ⇒ Object

The input HTML is automatically enhanced to improve the readability.

  • enhancements - Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.

  • Returns - The converter object.



1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'lib/pdfcrowd.rb', line 1747

def setReadabilityEnhancements(enhancements)
    unless /(?i)^(none|readability-v1|readability-v2|readability-v3|readability-v4)$/.match(enhancements)
        raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-pdf", "Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.", "set_readability_enhancements"), 470);
    end
    
    @fields['readability_enhancements'] = enhancements
    self
end

#setRemoveBlankPages(pages) ⇒ Object

Specifies which blank pages to exclude from the output document.

  • pages - The empty page behavior. Allowed values are trailing, none.

  • Returns - The converter object.



1192
1193
1194
1195
1196
1197
1198
1199
 
# File 'lib/pdfcrowd.rb', line 1192

def setRemoveBlankPages(pages)
    unless /(?i)^(trailing|none)$/.match(pages)
        raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setRemoveBlankPages", "html-to-pdf", "Allowed values are trailing, none.", "set_remove_blank_pages"), 470);
    end
    
    @fields['remove_blank_pages'] = pages
    self
end

#setRenderingMode(mode) ⇒ Object

Set the rendering mode.

  • mode - The rendering mode. Allowed values are default, viewport.

  • Returns - The converter object.



1797
1798
1799
1800
1801
1802
1803
1804
 
# File 'lib/pdfcrowd.rb', line 1797

def setRenderingMode(mode)
    unless /(?i)^(default|viewport)$/.match(mode)
        raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setRenderingMode", "html-to-pdf", "Allowed values are default, viewport.", "set_rendering_mode"), 470);
    end
    
    @fields['rendering_mode'] = mode
    self
end

#setRetryCount(count) ⇒ Object

Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.

  • count - Number of retries.

  • Returns - The converter object.



2438
2439
2440
2441
 
# File 'lib/pdfcrowd.rb', line 2438

def setRetryCount(count)
    @helper.setRetryCount(count)
    self
end

#setRightToLeft(value) ⇒ Object

Set the predominant reading order for text to right-to-left. This option has no direct effect on the document’s contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up

  • value - Set to true to set right-to-left reading order.

  • Returns - The converter object.



2111
2112
2113
2114
 
# File 'lib/pdfcrowd.rb', line 2111

def setRightToLeft(value)
    @fields['right_to_left'] = value
    self
end

#setScaleFactor(factor) ⇒ Object

Set the scaling factor (zoom) for the main page area.

  • factor - The percentage value. The value must be in the range 10-500.

  • Returns - The converter object.



1823
1824
1825
1826
1827
1828
1829
1830
 
# File 'lib/pdfcrowd.rb', line 1823

def setScaleFactor(factor)
    if (!(Integer(factor) >= 10 && Integer(factor) <= 500))
        raise Error.new(Pdfcrowd.create_invalid_value_message(factor, "setScaleFactor", "html-to-pdf", "The value must be in the range 10-500.", "set_scale_factor"), 470);
    end
    
    @fields['scale_factor'] = factor
    self
end

#setSmartScalingMode(mode) ⇒ Object

Specifies the scaling mode used for fitting the HTML contents to the print area.

  • mode - The smart scaling mode. Allowed values are default, disabled, viewport-fit, content-fit, single-page-fit, single-page-fit-ex, mode1.

  • Returns - The converter object.



1810
1811
1812
1813
1814
1815
1816
1817
 
# File 'lib/pdfcrowd.rb', line 1810

def setSmartScalingMode(mode)
    unless /(?i)^(default|disabled|viewport-fit|content-fit|single-page-fit|single-page-fit-ex|mode1)$/.match(mode)
        raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setSmartScalingMode", "html-to-pdf", "Allowed values are default, disabled, viewport-fit, content-fit, single-page-fit, single-page-fit-ex, mode1.", "set_smart_scaling_mode"), 470);
    end
    
    @fields['smart_scaling_mode'] = mode
    self
end

#setSubject(subject) ⇒ Object

Set the subject of the PDF.

  • subject - The subject.

  • Returns - The converter object.



1956
1957
1958
1959
 
# File 'lib/pdfcrowd.rb', line 1956

def setSubject(subject)
    @fields['subject'] = subject
    self
end

#setTag(tag) ⇒ Object

Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.

  • tag - A string with the custom tag.

  • Returns - The converter object.



2256
2257
2258
2259
 
# File 'lib/pdfcrowd.rb', line 2256

def setTag(tag)
    @fields['tag'] = tag
    self
end

#setTitle(title) ⇒ Object

Set the title of the PDF.

  • title - The title.

  • Returns - The converter object.



1947
1948
1949
1950
 
# File 'lib/pdfcrowd.rb', line 1947

def setTitle(title)
    @fields['title'] = title
    self
end

#setUseHttp(value) ⇒ Object

Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API. Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.

  • value - Set to true to use HTTP.

  • Returns - The converter object.



2408
2409
2410
2411
 
# File 'lib/pdfcrowd.rb', line 2408

def setUseHttp(value)
    @helper.setUseHttp(value)
    self
end

#setUseMobileUserAgent(value) ⇒ Object

Use a mobile user agent.

  • value - Set to true to use a mobile user agent.

  • Returns - The converter object.



1511
1512
1513
1514
 
# File 'lib/pdfcrowd.rb', line 1511

def setUseMobileUserAgent(value)
    @fields['use_mobile_user_agent'] = value
    self
end

#setUsePrintMedia(value) ⇒ Object

Use the print version of the page if available (@media print).

  • value - Set to true to use the print version of the page.

  • Returns - The converter object.



1466
1467
1468
1469
 
# File 'lib/pdfcrowd.rb', line 1466

def setUsePrintMedia(value)
    @fields['use_print_media'] = value
    self
end

#setUserAgent(agent) ⇒ Object

Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.

  • agent - The user agent string.

  • Returns - The converter object.



2417
2418
2419
2420
 
# File 'lib/pdfcrowd.rb', line 2417

def setUserAgent(agent)
    @helper.setUserAgent(agent)
    self
end

#setUserPassword(password) ⇒ Object

Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.

  • password - The user password.

  • Returns - The converter object.



1902
1903
1904
1905
 
# File 'lib/pdfcrowd.rb', line 1902

def setUserPassword(password)
    @fields['user_password'] = password
    self
end

#setVerifySslCertificates(value) ⇒ Object

Do not allow insecure HTTPS connections.

  • value - Set to true to enable SSL certificate verification.

  • Returns - The converter object.



1598
1599
1600
1601
 
# File 'lib/pdfcrowd.rb', line 1598

def setVerifySslCertificates(value)
    @fields['verify_ssl_certificates'] = value
    self
end

#setViewport(width, height) ⇒ Object

Set the viewport size. The viewport is the user’s visible area of the page.

  • width - Set the viewport width in pixels. The viewport is the user’s visible area of the page. The value must be in the range 96-65000.

  • height - Set the viewport height in pixels. The viewport is the user’s visible area of the page. If the input HTML uses lazily loaded images, try using a large value that covers the entire height of the HTML, e.g. 100000. Must be a positive integer number.

  • Returns - The converter object.



1787
1788
1789
1790
1791
 
# File 'lib/pdfcrowd.rb', line 1787

def setViewport(width, height)
    setViewportWidth(width)
    setViewportHeight(height)
    self
end

#setViewportHeight(height) ⇒ Object

Set the viewport height in pixels. The viewport is the user’s visible area of the page. If the input HTML uses lazily loaded images, try using a large value that covers the entire height of the HTML, e.g. 100000.

  • height - Must be a positive integer number.

  • Returns - The converter object.



1773
1774
1775
1776
1777
1778
1779
1780
 
# File 'lib/pdfcrowd.rb', line 1773

def setViewportHeight(height)
    if (!(Integer(height) > 0))
        raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setViewportHeight", "html-to-pdf", "Must be a positive integer number.", "set_viewport_height"), 470);
    end
    
    @fields['viewport_height'] = height
    self
end

#setViewportWidth(width) ⇒ Object

Set the viewport width in pixels. The viewport is the user’s visible area of the page.

  • width - The value must be in the range 96-65000.

  • Returns - The converter object.



1760
1761
1762
1763
1764
1765
1766
1767
 
# File 'lib/pdfcrowd.rb', line 1760

def setViewportWidth(width)
    if (!(Integer(width) >= 96 && Integer(width) <= 65000))
        raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setViewportWidth", "html-to-pdf", "The value must be in the range 96-65000.", "set_viewport_width"), 470);
    end
    
    @fields['viewport_width'] = width
    self
end

#setWaitForElement(selectors) ⇒ Object

Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by “Max Delay” parameter.

  • selectors - One or more CSS selectors separated by commas. The string must not be empty.

  • Returns - The converter object.



1725
1726
1727
1728
1729
1730
1731
1732
 
# File 'lib/pdfcrowd.rb', line 1725

def setWaitForElement(selectors)
    if (!(!selectors.nil? && !selectors.empty?))
        raise Error.new(Pdfcrowd.create_invalid_value_message(selectors, "setWaitForElement", "html-to-pdf", "The string must not be empty.", "set_wait_for_element"), 470);
    end
    
    @fields['wait_for_element'] = selectors
    self
end

#setZipFooterFilename(filename) ⇒ Object

Set the file name of the footer HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.

  • filename - The file name.

  • Returns - The converter object.



1292
1293
1294
1295
 
# File 'lib/pdfcrowd.rb', line 1292

def setZipFooterFilename(filename)
    @fields['zip_footer_filename'] = filename
    self
end

#setZipHeaderFilename(filename) ⇒ Object

Set the file name of the header HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.

  • filename - The file name.

  • Returns - The converter object.



1244
1245
1246
1247
 
# File 'lib/pdfcrowd.rb', line 1244

def setZipHeaderFilename(filename)
    @fields['zip_header_filename'] = filename
    self
end

#setZipMainFilename(filename) ⇒ Object

Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.

  • filename - The file name.

  • Returns - The converter object.



942
943
944
945
 
# File 'lib/pdfcrowd.rb', line 942

def setZipMainFilename(filename)
    @fields['zip_main_filename'] = filename
    self
end