|
Foxit PDF SDK
|
继承自 Object .
此类表示用于将HTML转换为PDF的设置数据。
用于将HTML转换为PDF的编码格式枚举。
此枚举的值应该单独使用。
|
inline |
带参数的构造函数。
| [in] | page_width | 用于转换的PDF文档的页面宽度(单位为1/72英寸)。 |
| [in] | page_height | 用于转换的PDF文档的页面高度(单位为1/72英寸)。如果使用页面模式 HTML2PDFSettingData::e_PageModeSinglePage,此参数将被忽略。 |
| [in] | is_to_page_scale | (已弃用)用于决定是否缩放转换的PDF页面。 |
| [in] | page_margin | 用于转换的PDF文档的页面边距。 |
| [in] | is_convert_link | 用于决定是否转换网页链接。 |
| [in] | rotate_degrees | 用于转换的PDF页面的旋转度数。请参考从common::e_Rotation0开始的值, 应该是这些值中的一个。 |
| [in] | is_generate_tag | 用于决定是否生成标签。 |
| [in] | page_mode | 用于转换的页面模式。请参考从 HTML2PDFSettingData::e_PageModeSinglePage开始的值,应该是这些值中的一个。 |
| [in] | to_generate_bookmarks | 用于决定是否生成书签。 |
| [in] | scaling_mode | 用于转换的PDF文档的缩放模式。请参考从HTML2PDFSettingData::e_ScalingModeNone开始的值, 应该是这些值中的一个。默认值:HTML2PDFSettingData::e_ScalingModeScale。 |
| [in] | encoding_format | HTML编码格式。请参考从HTML2PDFEncodingFormat::e_EncodingFormatDefault开始的值, 应该是这些值中的一个。 |
| [in] | to_render_images | 是否渲染图像。 |
| [in] | to_remove_underline_for_link | 是否移除链接的下划线装饰。 |
| [in] | to_set_headerfooter | 是否设置页眉页脚。 |
| [in] | headerfooter_title | 页眉页脚标题,作为中心页眉的内容。 |
| [in] | headerfooter_url | 页眉页脚URL,作为左页脚的内容。 |
| [in] | bookmark_root_name | 书签的根名称。 |
| [in] | to_resize_objects | 是否在渲染过程中启用与JavaScript相关的对象调整大小。 |
| [in] | to_print_background | 是否打印背景。 |
| [in] | to_optimize_tag_tree | 是否优化标签树。 |
| [in] | media_style | 用于转换的PDF文档的媒体样式。请参考从HTML2PDFSettingData::e_MediaStyleScreen开始的值, 应该是这些值中的一个。 |
| [in] | to_load_active_content | 是否加载活动内容。 |
| [in] | to_disable_sandbox | 是否禁用沙盒。 |
| [in] | to_use_blacklist | 是否使用黑名单。 |
| [in] | to_hide_header | 是否隐藏页眉。 |
| [in] | to_hide_footer | 是否隐藏页脚。 |
| [in] | to_deny_local_file_access | 是否拒绝本地文件访问。 |
|
inline |
赋值操作符。
| [in] | data | 另一个HTML到PDF设置数据对象,其值将被赋给当前对象。 |
|
inline |
设置值。
| [in] | page_width | 用于转换的PDF文档的页面宽度(单位为1/72英寸)。 |
| [in] | page_height | 用于转换的PDF文档的页面高度(单位为1/72英寸)。如果使用页面模式 HTML2PDFSettingData::e_PageModeSinglePage,此参数将被忽略。 |
| [in] | is_to_page_scale | (已弃用)用于决定是否缩放转换的PDF页面。 |
| [in] | page_margin | 用于转换的PDF文档的页面边距。 |
| [in] | is_convert_link | 用于决定是否转换网页链接。 |
| [in] | rotate_degrees | 用于转换的PDF页面的旋转度数。请参考从common::e_Rotation0开始的值, 应该是这些值中的一个。 |
| [in] | is_generate_tag | 用于决定是否生成标签。 |
| [in] | page_mode | 用于转换的页面模式。请参考从 HTML2PDFSettingData::e_PageModeSinglePage开始的值,应该是这些值中的一个。 |
| [in] | to_generate_bookmarks | 用于决定是否生成书签。 |
| [in] | scaling_mode | 用于转换的PDF文档的缩放模式。请参考从HTML2PDFSettingData::e_ScalingModeNone开始的值, 应该是这些值中的一个。默认值:HTML2PDFSettingData::e_PageScalingScale。 |
| [in] | encoding_format | HTML编码格式。请参考从HTML2PDFEncodingFormat::e_EncodingFormatDefault开始的值, 应该是这些值中的一个。 |
| [in] | to_render_images | 是否渲染图像。 |
| [in] | to_remove_underline_for_link | 是否移除链接的下划线装饰。 |
| [in] | to_set_headerfooter | 是否设置页眉页脚。 |
| [in] | headerfooter_title | 页眉页脚标题,作为中心页眉的内容。 |
| [in] | headerfooter_url | 页眉页脚URL,作为左页脚的内容。 |
| [in] | bookmark_root_name | 书签的根名称。 |
| [in] | to_resize_objects | 是否在渲染过程中启用与JavaScript相关的对象调整大小。 |
| [in] | to_print_background | 是否打印背景。 |
| [in] | to_optimize_tag_tree | 是否优化标签树。 |
| [in] | media_style | 用于转换的PDF文档的媒体样式。请参考从HTML2PDFSettingData::e_MediaStyleScreen开始的值, 应该是这些值中的一个。 |
| [in] | to_load_active_content | 是否加载活动内容。 |
| [in] | to_disable_sandbox | 是否禁用沙盒。 |
| [in] | to_use_blacklist | 是否使用黑名单。 |
| [in] | to_hide_header | 是否隐藏页眉。 |
| [in] | to_hide_footer | 是否隐藏页脚。 |
| [in] | to_deny_local_file_access | 是否拒绝本地文件访问。 |
| bool foxit::addon::conversion::HTML2PDFSettingData::is_to_page_scale |
用于决定是否缩放转换的PDF页面。
| float foxit::addon::conversion::HTML2PDFSettingData::page_height |
用于转换的PDF文档的页面高度(单位为1/72英寸)。
此值减去上下边距的总和必须大于16。
| RectF foxit::addon::conversion::HTML2PDFSettingData::page_margin |
用于转换的PDF文档的页面边距。
| float foxit::addon::conversion::HTML2PDFSettingData::page_width |
用于转换的PDF文档的页面宽度(单位为1/72英寸)。
此值减去左右边距的总和必须大于16。
| bool foxit::addon::conversion::HTML2PDFSettingData::to_deny_local_file_access |
用于决定在转换HTML文件时是否拒绝本地文件访问。 在Linux x86平台上不支持。
true表示阻止HTML文件访问其自身目录之外的任何本地文件。 false表示允许HTML文件访问任何本地文件路径。 默认值:false。
| bool foxit::addon::conversion::HTML2PDFSettingData::to_disable_sandbox |
用于决定是否禁用沙盒。
true表示禁用沙盒,false表示不禁用。默认值:true。
| bool foxit::addon::conversion::HTML2PDFSettingData::to_load_active_content |
用于决定是否加载活动内容。
此参数对一些优化的网页很有用。这些网页不会加载全部内容。 当用户向下滚动页面时,网页内容会在显示在用户屏幕上时才加载。 true表示加载网页尚未加载的活动内容,false表示不加载。默认值:false。
| bool foxit::addon::conversion::HTML2PDFSettingData::to_use_blacklist |
用于决定是否使用黑名单。
此参数对检查HTML转PDF转换过程中访问的所有URL很有用。
在转换特定URL时,转换过程可能会访问许多第三方网站(图像、CSS样式、Javascript请求等)。
所有这些访问都将对照黑名单记录进行检查。转换器中有一个准备好的开关,可启用黑名单功能。 true表示使用黑名单,false表示不使用。默认值:false。 黑名单JSON位于fxhtml2pdf应用程序旁边,其名称必须为"blacklist.json"。它由三部分记录组成:
"blacklist.json"示例:
{"Domains":[
"xxx.com",
"xxx.com"
]
,
"IPs":["1.2.3.4","5.6.7.8"]
,
"IPsegments":[{"16":["104.193.88.0","104.193.88.100"]},{"16":["20.0.0.1","20.0.0.10"]}]
}