继承自 NSObject .

构造函数
(id)	- init
	构造函数。

(id)	- initWithPage_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:to_deny_local_file_access:
	带参数的构造函数。更多...

(void)	- set: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:to_deny_local_file_access:
	设置值。更多...

属性
NSString *	bookmark_root_name
	书签的根名称。

FSHTML2PDFSettingDataHTML2PDFEncodingFormat	encoding_format
	HTML编码格式。请参考从 FSHTML2PDFSettingDataEncodingFormatDefault 开始的值，应该是这些值中的一个。

NSString *	headerfooter_title
	页眉页脚标题，作为中央页眉的内容。

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

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

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

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

FSHTML2PDFSettingDataHTML2PDFMediaStyle	media_style
	用于转换的PDF文档的媒体样式。请参考从 FSHTML2PDFSettingDataMediaStyleScreen 开始的值，应该是这些值中的一个。

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

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

FSHTML2PDFSettingDataHTML2PDFPageMode	page_mode
	用于转换的页面模式。请参考从 FSHTML2PDFSettingDataPageModeSinglePage 开始的值，应该是这些值中的一个。

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

FSRotation	rotate_degrees
	用于转换的PDF页面的旋转度数。请参考从 FSRotation0 开始的值，应该是这些值中的一个。

FSHTML2PDFSettingDataHTML2PDFScalingMode	scaling_mode
	用于转换的PDF文档的缩放模式。请参考从 FSHTML2PDFSettingDataScalingModeNone 开始的值，应该是这些值中的一个。

BOOL	to_deny_local_file_access
	用于决定在转换HTML文件时是否拒绝本地文件访问。在Linux x86平台上不支持。更多...

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

BOOL	to_generate_bookmarks
	用于决定是否生成书签。

BOOL	to_hide_footer
	用于决定是否隐藏页脚。在Linux x86平台上不支持。

BOOL	to_hide_header
	用于决定是否隐藏页眉。在Linux x86平台上不支持。

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

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

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

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

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

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

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

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

详细描述

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

函数文档

◆ initWithPage_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:to_deny_local_file_access:()

- (id) initWithPage_width:	(float)	page_width
page_height:	(float)	page_height
is_to_page_scale:	(BOOL)	is_to_page_scale
page_margin:	(FSRectF*)	page_margin
is_convert_link:	(BOOL)	is_convert_link
rotate_degrees:	(FSRotation)	rotate_degrees
is_generate_tag:	(BOOL)	is_generate_tag
page_mode:	(FSHTML2PDFSettingDataHTML2PDFPageMode)	page_mode
to_generate_bookmarks:	(BOOL)	to_generate_bookmarks
scaling_mode:	(FSHTML2PDFSettingDataHTML2PDFScalingMode)	scaling_mode
encoding_format:	(FSHTML2PDFSettingDataHTML2PDFEncodingFormat)	encoding_format
to_render_images:	(BOOL)	to_render_images
to_remove_underline_for_link:	(BOOL)	to_remove_underline_for_link
to_set_headerfooter:	(BOOL)	to_set_headerfooter
headerfooter_title:	(NSString *)	headerfooter_title
headerfooter_url:	(NSString *)	headerfooter_url
bookmark_root_name:	(NSString *)	bookmark_root_name
to_resize_objects:	(BOOL)	to_resize_objects
to_print_background:	(BOOL)	to_print_background
to_optimize_tag_tree:	(BOOL)	to_optimize_tag_tree
media_style:	(FSHTML2PDFSettingDataHTML2PDFMediaStyle)	media_style
to_load_active_content:	(BOOL)	to_load_active_content
to_disable_sandbox:	(BOOL)	to_disable_sandbox
to_use_blacklist:	(BOOL)	to_use_blacklist
to_hide_header:	(BOOL)	to_hide_header
to_hide_footer:	(BOOL)	to_hide_footer
to_deny_local_file_access:	(BOOL)	to_deny_local_file_access

带参数的构造函数。

参数

[in]	page_width	用于转换的PDF文档的页面宽度（单位为1/72英寸）。
[in]	page_height	用于转换的PDF文档的页面高度（单位为1/72英寸）。如果使用页面模式 FSHTML2PDFSettingDataPageModeSinglePage ，此参数将被忽略。
[in]	is_to_page_scale	（已弃用）用于决定是否缩放转换的PDF页面。
[in]	page_margin	用于转换的PDF文档的页面边距。
[in]	is_convert_link	用于决定是否转换网页链接。
[in]	rotate_degrees	用于转换的PDF页面的旋转度数。请参考从 FSRotation0 开始的值，应该是这些值中的一个。
[in]	is_generate_tag	用于决定是否生成标签。
[in]	page_mode	用于转换的页面模式。请参考从 FSHTML2PDFSettingDataPageModeSinglePage 开始的值，应该是这些值中的一个。
[in]	to_generate_bookmarks	用于决定是否生成书签。
[in]	scaling_mode	用于转换的PDF文档的缩放模式。请参考从 FSHTML2PDFSettingDataScalingModeNone 开始的值，应该是这些值中的一个。默认值： FSHTML2PDFSettingDataScalingModeScale 。
[in]	encoding_format	HTML编码格式。请参考从开始的值，应该是这些值中的一个。
[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文档的媒体样式。请参考从 FSHTML2PDFSettingDataMediaStyleScreen 开始的值，应该是这些值中的一个。
[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: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:to_deny_local_file_access:()

- (void) set:	(float)	page_width
page_height:	(float)	page_height
is_to_page_scale:	(BOOL)	is_to_page_scale
page_margin:	(FSRectF*)	page_margin
is_convert_link:	(BOOL)	is_convert_link
rotate_degrees:	(FSRotation)	rotate_degrees
is_generate_tag:	(BOOL)	is_generate_tag
page_mode:	(FSHTML2PDFSettingDataHTML2PDFPageMode)	page_mode
to_generate_bookmarks:	(BOOL)	to_generate_bookmarks
scaling_mode:	(FSHTML2PDFSettingDataHTML2PDFScalingMode)	scaling_mode
encoding_format:	(FSHTML2PDFSettingDataHTML2PDFEncodingFormat)	encoding_format
to_render_images:	(BOOL)	to_render_images
to_remove_underline_for_link:	(BOOL)	to_remove_underline_for_link
to_set_headerfooter:	(BOOL)	to_set_headerfooter
headerfooter_title:	(NSString *)	headerfooter_title
headerfooter_url:	(NSString *)	headerfooter_url
bookmark_root_name:	(NSString *)	bookmark_root_name
to_resize_objects:	(BOOL)	to_resize_objects
to_print_background:	(BOOL)	to_print_background
to_optimize_tag_tree:	(BOOL)	to_optimize_tag_tree
media_style:	(FSHTML2PDFSettingDataHTML2PDFMediaStyle)	media_style
to_load_active_content:	(BOOL)	to_load_active_content
to_disable_sandbox:	(BOOL)	to_disable_sandbox
to_use_blacklist:	(BOOL)	to_use_blacklist
to_hide_header:	(BOOL)	to_hide_header
to_hide_footer:	(BOOL)	to_hide_footer
to_deny_local_file_access:	(BOOL)	to_deny_local_file_access

设置值。

参数

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

返回: 无。

属性说明

◆ is_to_page_scale

- (BOOL) is_to_page_scale

readwritenonatomicassign

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

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

◆ page_height

- (float) page_height

readwritenonatomicassign

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

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

注解: 如果使用页面模式 FSHTML2PDFSettingDataPageModeSinglePage ，页面高度将被忽略。

◆ page_margin

- (FSRectF *) page_margin

readwritenonatomicweak

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

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

◆ page_width

- (float) page_width

readwritenonatomicassign

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

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

◆ to_deny_local_file_access

- (BOOL) to_deny_local_file_access

readwritenonatomicassign

用于决定在转换HTML文件时是否拒绝本地文件访问。在Linux x86平台上不支持。

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

◆ to_disable_sandbox

- (BOOL) to_disable_sandbox

readwritenonatomicassign

用于决定是否禁用沙盒。

YES表示禁用沙盒，NO表示不禁用。默认值：YES。

◆ to_load_active_content

- (BOOL) to_load_active_content

readwritenonatomicassign

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

此参数对一些优化的网页很有用。这些网页不会加载全部内容。当用户向下滚动页面时，网页内容会在显示在用户屏幕上时才加载。 YES表示加载网页尚未加载的活动内容，NO表示不加载。默认值：NO。

◆ to_use_blacklist

- (BOOL) to_use_blacklist

readwritenonatomicassign

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

此参数对检查HTML转PDF转换过程中访问的所有URL很有用。
在转换特定URL时，转换过程可能会访问许多第三方网站（图像、CSS样式、Javascript请求等）。
所有这些访问都将对照黑名单记录进行检查。转换器中有一个准备好的开关，可启用黑名单功能。 YES表示使用黑名单，NO表示不使用。默认值：NO。黑名单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"]}]
         }