Public 成员函数
	constructor () const ructor(page_width
	构造函数。更多...

	Set (page_width, page_height, is_to_page_scale, page_margin, is_convert_link, rotate_degrees, is_generate_tag, page_mode, to_generate_bookmarks, scaling_mode, encoding_format, to_render_images, to_remove_underline_for_link, to_set_headerfooter, headerfooter_title, headerfooter_url, bookmark_root_name, to_resize_objects, to_print_background, to_optimize_tag_tree, media_style, to_load_active_content, to_disable_sandbox, to_use_blacklist, to_hide_header, to_hide_footer)
	设置值。更多...

Public 属性
page_mode	__pad0__: number to_generate_bookmarks
	用于转换的页面模式。请参考从 FSDK.HTML2PDFSettingData.e_PageModeSinglePage 开始的值，应为这些值之一。

	bookmark_root_name
	书签的根名称。

	encoding_format
	HTML 编码格式。请参考从 FSDK.HTML2PDFSettingData.e_EncodingFormatDefault 开始的值，应为这些值之一。

	headerfooter_title
	页眉页脚标题，作为中心页眉的内容。

	headerfooter_url
	页眉页脚 URL，作为左侧页脚的内容。

	is_convert_link
	用于决定是否转换网页链接。

	is_generate_tag
	用于决定是否生成标签。

	is_to_page_scale
	用于决定是否缩放转换后的 PDF 页面。更多...

	media_style
	用于转换的 PDF 文档的媒体样式。请参考从 FSDK.HTML2PDFSettingData.e_MediaStyleScreen 开始的值，应为这些值之一。

	page_height
	用于转换的 PDF 文档的页面高度（单位为 1/72 英寸）。更多...

	page_margin
	用于转换的 PDF 文档的页边距。更多...

	page_width
	用于转换的 PDF 文档的页面宽度（单位为 1/72 英寸）。更多...

	rotate_degrees
	用于转换的 PDF 页面的旋转度数。请参考从 FSDK.e_Rotation0 开始的值，应为这些值之一。

	scaling_mode
	用于转换的 PDF 文档的缩放模式。请参考从 FSDK.HTML2PDFSettingData.e_ScalingModeNone 开始的值，应为这些值之一。

	to_deny_local_file_access
	用于决定在转换 html 文件时是否拒绝本地文件访问。更多...

	to_disable_sandbox
	用于决定是否禁用沙箱。更多...

	to_hide_footer
	用于决定是否隐藏页脚。

	to_hide_header
	用于决定是否隐藏页眉。

	to_load_active_content
	用于决定是否加载活动内容。更多...

	to_optimize_tag_tree
	用于决定是否优化标签树。

	to_print_background
	用于决定是否打印背景。

	to_remove_underline_for_link
	用于决定是否移除链接的下划线装饰。

	to_render_images
	用于决定是否渲染图像。

	to_resize_objects
	是否在渲染过程中启用与 JavaScript 相关的对象大小调整。

	to_set_headerfooter
	用于决定是否设置页眉页脚。

	to_use_blacklist
	用于决定是否使用黑名单。更多...

静态 Public 属性
static	_PageModeSinglePage
	用于将 HTML 转换为 PDF 的页面模式枚举。更多...

static	e_EncodingFormatArabic
	编码格式："Arabic"。

static	e_EncodingFormatASCII
	编码格式："ASCII"。

static	e_EncodingFormatASCII_7_bit
	编码格式："ASCII-7-bit"。

static	e_EncodingFormatBHASKAR
	编码格式："BHASKAR"。

static	e_EncodingFormatBIG5
	编码格式："BIG5"。

static	e_EncodingFormatBIG5_CP950
	编码格式："BIG5-CP950"。

static	e_EncodingFormatBIG5_HKSCS
	编码格式："BIG5_HKSCS"。

static	e_EncodingFormatCNS
	编码格式："CNS"。

static	e_EncodingFormatCP1250
	编码格式："CP1250"。

static	e_EncodingFormatCP1251
	编码格式："CP1251"。

static	e_EncodingFormatCP1252
	编码格式："CP1252"。

static	e_EncodingFormatCP1253
	编码格式："CP1253"。

static	e_EncodingFormatCP1254
	编码格式："CP1254"。

static	e_EncodingFormatCP1255
	编码格式："CP1255"。

static	e_EncodingFormatCP1256
	编码格式："CP1256"。

static	e_EncodingFormatCP1257
	编码格式："CP1257"。

static	e_EncodingFormatCP852
	编码格式："CP852"。

static	e_EncodingFormatCP866
	编码格式："CP866"。

static	e_EncodingFormatCP874
	编码格式："CP874"。

static	e_EncodingFormatCP932
	编码格式："CP932"。

static	e_EncodingFormatCSN_369103
	编码格式："CSN_369103"。

static	e_EncodingFormatDefault
	用于将 HTML 转换为 PDF 的编码格式枚举。更多...

static	e_EncodingFormatEUC
	编码格式："EUC"。

static	e_EncodingFormatEUC_CN
	编码格式："EUC-CN"。

static	e_EncodingFormatEUC_JP
	编码格式："EUC-JP"。

static	e_EncodingFormatGB
	编码格式："GB"。

static	e_EncodingFormatGB18030
	编码格式："GB18030"。

static	e_EncodingFormatGBK
	编码格式："GBK"。

static	e_EncodingFormatGreek
	编码格式："Greek"。

static	e_EncodingFormatHebrew
	编码格式："Hebrew"。

static	e_EncodingFormatHTCHANAKYA
	编码格式："HTCHANAKYA"。

static	e_EncodingFormatHZ_GB_2312
	编码格式："HZ-GB-2312"。

static	e_EncodingFormatISO_2022_CN
	编码格式："ISO_2022_CN"。

static	e_EncodingFormatISO_2022_KR
	编码格式："ISO-2022-KR"。

static	e_EncodingFormatISO_8859_11
	编码格式："ISO-8859-11"。

static	e_EncodingFormatISO_8859_13
	编码格式："ISO-8859-13"。

static	e_EncodingFormatISO_8859_15
	编码格式："ISO-8859-15"。

static	e_EncodingFormatISO_8859_5
	编码格式："ISO-8859-5"。

static	e_EncodingFormatISO_8859_8_I
	编码格式："ISO-8859-8-I"。

static	e_EncodingFormatJAGRAN
	编码格式："JAGRAN"。

static	e_EncodingFormatJIS
	编码格式："JIS"。

static	e_EncodingFormatKOI8R
	编码格式："KOI8R"。

static	e_EncodingFormatKOI8U
	编码格式："KOI8U"。

static	e_EncodingFormatKSC
	编码格式："KSC"。

static	e_EncodingFormatLatin2
	编码格式："Latin2"。

static	e_EncodingFormatLatin3
	编码格式："Latin3"。

static	e_EncodingFormatLatin4
	编码格式："Latin4"。

static	e_EncodingFormatLatin5
	编码格式："Latin5"。

static	e_EncodingFormatLatin6
	编码格式："Latin6"。

static	e_EncodingFormatMACINTOSH
	编码格式："MACINTOSH"。

static	e_EncodingFormatSJS
	编码格式："SJS"。

static	e_EncodingFormatTAB
	编码格式："TAB"。

static	e_EncodingFormatTAM
	编码格式："TAM"。

static	e_EncodingFormatTSCII
	编码格式："TSCII"。

static	e_EncodingFormatUnicode
	编码格式："Unicode"。

static	e_EncodingFormatUTF7
	编码格式："UTF7"。

static	e_EncodingFormatUTF_16BE
	编码格式："UTF-16BE"。

static	e_EncodingFormatUTF_16LE
	编码格式："UTF-16LE"。

static	e_EncodingFormatUTF_32BE
	编码格式："UTF-32BE"。

static	e_EncodingFormatUTF_32LE
	编码格式："UTF-32LE"。

static	e_EncodingFormatVISUAL
	编码格式："VISUAL"。

static	e_EncodingFormatX_BINARYENC
	编码格式："X-BINARYENC"。

static	e_EncodingFormatX_DoCoMo_Shift_JIS
	编码格式："X-DoCoMo-Shift_JIS"。

static	e_EncodingFormatX_KDDI_ISO_2022_JP
	编码格式："X-KDDI-ISO-2022-JP"。

static	e_EncodingFormatX_KDDI_Shift_JIS
	编码格式："X-KDDI-Shift_JIS"。

static	e_EncodingFormatX_SoftBank_ISO_2022_JP
	编码格式："X-SoftBank-ISO-2022-JP"。

static	e_EncodingFormatX_SoftBank_Shift_JIS
	编码格式："X-SoftBank-Shift_JIS"。

static	e_EncodingFormatX_TAM_ELANGO
	编码格式："X-TAM-ELANGO"。

static	e_EncodingFormatX_TAM_LTTMBARANI
	编码格式："X-TAM-LTTMBARANI"。

static	e_EncodingFormatX_TAM_SHREE
	编码格式："X-TAM-SHREE"。

static	e_EncodingFormatX_TAM_TBOOMIS
	编码格式："X-TAM-TBOOMIS"。

static	e_EncodingFormatX_TAM_TMNEWS
	编码格式："X-TAM-TMNEWS"。

static	e_EncodingFormatX_TAM_WEBTAMIL
	编码格式："X-TAM-WEBTAMIL"。

static	e_EncodingFormatX_UTF8UTF8
	编码格式："X-UTF8UTF8"。

static	e_MediaStylePrint
	媒体样式：打印。这意味着 PDF 页面将以打印媒体样式显示。

static	e_MediaStyleScreen
	用于将 HTML 转换为 PDF 的媒体样式枚举。更多...

static	e_PageModeMultiplePage
	多页模式。

static	e_ScalingModeEnlarge
	页面缩放：放大。这意味着 PDF 页面将被放大到 HTML 内容大小。在此模式下，HTML 内容的文本大小不会被更改。

static	e_ScalingModeNone
	用于将 HTML 转换为 PDF 的缩放模式枚举。更多...

static	e_ScalingModeScale
	页面缩放：缩放。这意味着 HTML 内容将被缩放以适应 PDF 页面大小。在此模式下，文本大小可能会被更改。

详细描述

此类表示用于将 HTML 转换为 PDF 的设置数据。

成员函数说明

◆ constructor()

FSDK::HTML2PDFSettingData::constructor ( ) const

构造函数。

带参数的构造函数。

参数

[in]	page_width	用于转换的 PDF 文档的页面宽度（单位为 1/72 英寸）。
[in]	page_height	用于转换的 PDF 文档的页面高度（单位为 1/72 英寸）。如果使用页面模式 FSDK.HTML2PDFSettingData.e_PageModeSinglePage，则将忽略此值。
[in]	is_to_page_scale	（已弃用）用于决定是否缩放转换后的 PDF 页面。
[in]	page_margin	用于转换的 PDF 文档的页边距。
[in]	is_convert_link	用于决定是否转换网页链接。
[in]	rotate_degrees	用于转换的 PDF 页面的旋转度数。请参考从 FSDK.e_Rotation0 开始的值，应为这些值之一。
[in]	is_generate_tag	用于决定是否生成标签。
[in]	page_mode	用于转换的页面模式。请参考从 FSDK.HTML2PDFSettingData.e_PageModeSinglePage 开始的值，应为这些值之一。
[in]	to_generate_bookmarks	用于决定是否生成书签。
[in]	scaling_mode	用于转换的 PDF 文档的缩放模式。请参考从 FSDK.HTML2PDFSettingData.e_ScalingModeNone 开始的值，应为这些值之一。默认值：FSDK.HTML2PDFSettingData.e_ScalingModeScale。
[in]	encoding_format	HTML 编码格式。请参考从 FSDK.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 文档的媒体样式。请参考从 FSDK.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	是否拒绝本地文件访问。

返回: 无。

◆ Set()

FSDK::HTML2PDFSettingData::Set	(	page_width	,
		page_height	,
		is_to_page_scale	,
		page_margin	,
		is_convert_link	,
		rotate_degrees	,
		is_generate_tag	,
		page_mode	,
		to_generate_bookmarks	,
		scaling_mode	,
		encoding_format	,
		to_render_images	,
		to_remove_underline_for_link	,
		to_set_headerfooter	,
		headerfooter_title	,
		headerfooter_url	,
		bookmark_root_name	,
		to_resize_objects	,
		to_print_background	,
		to_optimize_tag_tree	,
		media_style	,
		to_load_active_content	,
		to_disable_sandbox	,
		to_use_blacklist	,
		to_hide_header	,
		to_hide_footer
	)

设置值。

参数

[in]	page_width	用于转换的 PDF 文档的页面宽度（单位为 1/72 英寸）。
[in]	page_height	用于转换的 PDF 文档的页面高度（单位为 1/72 英寸）。如果使用页面模式 FSDK.HTML2PDFSettingData.e_PageModeSinglePage，则将忽略此值。
[in]	is_to_page_scale	（已弃用）用于决定是否缩放转换后的 PDF 页面。
[in]	page_margin	用于转换的 PDF 文档的页边距。
[in]	is_convert_link	用于决定是否转换网页链接。
[in]	rotate_degrees	用于转换的 PDF 页面的旋转度数。请参考从 FSDK.e_Rotation0 开始的值，应为这些值之一。
[in]	is_generate_tag	用于决定是否生成标签。
[in]	page_mode	用于转换的页面模式。请参考从 FSDK.HTML2PDFSettingData.e_PageModeSinglePage 开始的值，应为这些值之一。
[in]	to_generate_bookmarks	用于决定是否生成书签。
[in]	scaling_mode	用于转换的 PDF 文档的缩放模式。请参考从 FSDK.HTML2PDFSettingData.e_ScalingModeNone 开始的值，应为这些值之一。默认值：FSDK.HTML2PDFSettingData.e_PageScalingScale。
[in]	encoding_format	HTML 编码格式。请参考从 FSDK.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 文档的媒体样式。请参考从 FSDK.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	是否拒绝本地文件访问。

返回: 无。

类成员变量说明

◆ _PageModeSinglePage

FSDK::HTML2PDFSettingData::_PageModeSinglePage

static

用于将 HTML 转换为 PDF 的页面模式枚举。

此枚举的值应单独使用。

单页模式。

◆ e_EncodingFormatDefault

FSDK::HTML2PDFSettingData::e_EncodingFormatDefault

static

用于将 HTML 转换为 PDF 的编码格式枚举。

此枚举的值应单独使用。

编码格式：默认。编码格式将在 chromium 中自动检测。

◆ e_MediaStyleScreen

FSDK::HTML2PDFSettingData::e_MediaStyleScreen

static

用于将 HTML 转换为 PDF 的媒体样式枚举。

此枚举的值应单独使用。

媒体样式：屏幕。这意味着 PDF 页面将以屏幕媒体样式显示。

◆ e_ScalingModeNone

FSDK::HTML2PDFSettingData::e_ScalingModeNone

static

用于将 HTML 转换为 PDF 的缩放模式枚举。

此枚举的值应单独使用。

缩放模式：固定页面，不缩放。在此模式下，HTML 内容的文本大小不会被更改。

◆ is_to_page_scale

FSDK::HTML2PDFSettingData::is_to_page_scale

用于决定是否缩放转换后的 PDF 页面。

弃用:: 此属性自 Foxit PDF SDK 8.2 以来已被弃用。此属性将不再对转换 PDF 产生任何影响。对于缩放模式，请参考 scaling_mode。

◆ page_height

FSDK::HTML2PDFSettingData::page_height

用于转换的 PDF 文档的页面高度（单位为 1/72 英寸）。

此值减去上边距和下边距的总和必须大于 16。

注解: 如果使用页面模式 FSDK.HTML2PDFSettingData.e_PageModeSinglePage，则将忽略页面高度。

◆ page_margin

FSDK::HTML2PDFSettingData::page_margin

用于转换的 PDF 文档的页边距。

注解: 此值不表示矩形。它只是定义 PDF 页面的左边距、下边距、右边距和上边距。

◆ page_width

FSDK::HTML2PDFSettingData::page_width

用于转换的 PDF 文档的页面宽度（单位为 1/72 英寸）。

此值减去左边距和右边距的总和必须大于 16。

◆ to_deny_local_file_access

FSDK::HTML2PDFSettingData::to_deny_local_file_access

用于决定在转换 html 文件时是否拒绝本地文件访问。

true 表示阻止 HTML 文件访问其自身目录外的任何本地文件。 false 表示允许 HTML 文件访问任何本地文件路径。默认值：false。

◆ to_disable_sandbox

FSDK::HTML2PDFSettingData::to_disable_sandbox

用于决定是否禁用沙箱。

true 表示禁用沙箱，false 表示不禁用。默认值：true。

◆ to_load_active_content

FSDK::HTML2PDFSettingData::to_load_active_content

用于决定是否加载活动内容。

此参数对于某些优化的网页很有用。这些网页不会加载整个内容。当用户向下滚动页面时，网页的内容将在显示在用户屏幕上时加载。 true 表示加载网页尚未加载的活动内容，false 表示不加载。默认值：false。

◆ to_use_blacklist

FSDK::HTML2PDFSettingData::to_use_blacklist

用于决定是否使用黑名单。

此参数对于在 HTML 到 PDF 转换过程中检查所有访问的 URL 很有用。
在转换特定 URL 期间，转换过程可能会访问许多第三方网站（图像、CSS 样式、来自 JavaScript 的请求等）。
所有这些访问都将根据黑名单记录进行检查。有一个预先准备好的开关，可以在转换器中启用黑名单功能。 true 表示使用黑名单，false 表示不使用。默认值：false。黑名单 JSON 位于 fxhtml2pdf 应用程序旁边，其名称必须为 "blacklist.json"。它由三部分记录组成：

域名列表。
IP 列表。
IP 范围列表。

"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"]}]
         }

Public 成员函数

Public 属性

静态 Public 属性

详细描述

成员函数说明

◆ constructor()

◆ Set()

类成员变量说明

◆ _PageModeSinglePage

◆ e_EncodingFormatDefault

◆ e_MediaStyleScreen

◆ e_ScalingModeNone

◆ is_to_page_scale

◆ page_height

◆ page_margin

◆ page_width

◆ to_deny_local_file_access

◆ to_disable_sandbox

◆ to_load_active_content

◆ to_use_blacklist