Foxit PDF SDK

Public 类型 | Public 成员函数 | 属性 | 所有成员列表
foxit.addon.conversion.HTML2PDFSettingData类 参考

继承自 SystemIDisposable .

## Public 类型
enum | HTML2PDFEncodingFormat { HTML2PDFEncodingFormat.e_EncodingFormatDefault = 0, HTML2PDFEncodingFormat.e_EncodingFormatASCII = 1, HTML2PDFEncodingFormat.e_EncodingFormatLatin2 = 2, HTML2PDFEncodingFormat.e_EncodingFormatLatin3 = 3, HTML2PDFEncodingFormat.e_EncodingFormatLatin4 = 4, HTML2PDFEncodingFormat.e_EncodingFormatLatin5 = 5, HTML2PDFEncodingFormat.e_EncodingFormatLatin6 = 6, HTML2PDFEncodingFormat.e_EncodingFormatISO_8859_5 = 7, HTML2PDFEncodingFormat.e_EncodingFormatArabic = 8, HTML2PDFEncodingFormat.e_EncodingFormatGreek = 9, HTML2PDFEncodingFormat.e_EncodingFormatHebrew = 10, HTML2PDFEncodingFormat.e_EncodingFormatEUC_JP = 11, HTML2PDFEncodingFormat.e_EncodingFormatSJS = 12, HTML2PDFEncodingFormat.e_EncodingFormatJIS = 13, HTML2PDFEncodingFormat.e_EncodingFormatBIG5 = 14, HTML2PDFEncodingFormat.e_EncodingFormatGB = 15, HTML2PDFEncodingFormat.e_EncodingFormatEUC_CN = 16, HTML2PDFEncodingFormat.e_EncodingFormatKSC = 17, HTML2PDFEncodingFormat.e_EncodingFormatUnicode = 18, HTML2PDFEncodingFormat.e_EncodingFormatEUC = 19, HTML2PDFEncodingFormat.e_EncodingFormatCNS = 20, HTML2PDFEncodingFormat.e_EncodingFormatBIG5_CP950 = 21, HTML2PDFEncodingFormat.e_EncodingFormatASCII_7_bit = 22, HTML2PDFEncodingFormat.e_EncodingFormatKOI8R = 23, HTML2PDFEncodingFormat.e_EncodingFormatCP852 = 24, HTML2PDFEncodingFormat.e_EncodingFormatCP866 = 25, HTML2PDFEncodingFormat.e_EncodingFormatCP874 = 26, HTML2PDFEncodingFormat.e_EncodingFormatCP932 = 27, HTML2PDFEncodingFormat.e_EncodingFormatCP1250 = 28, HTML2PDFEncodingFormat.e_EncodingFormatCP1251 = 29, HTML2PDFEncodingFormat.e_EncodingFormatCP1252 = 30, HTML2PDFEncodingFormat.e_EncodingFormatCP1253 = 31, HTML2PDFEncodingFormat.e_EncodingFormatCP1254 = 32, HTML2PDFEncodingFormat.e_EncodingFormatCP1255 = 33, HTML2PDFEncodingFormat.e_EncodingFormatCP1256 = 34, HTML2PDFEncodingFormat.e_EncodingFormatCP1257 = 35, HTML2PDFEncodingFormat.e_EncodingFormatKOI8U = 36, HTML2PDFEncodingFormat.e_EncodingFormatISO_8859_15 = 37, HTML2PDFEncodingFormat.e_EncodingFormatISO_8859_11 = 38, HTML2PDFEncodingFormat.e_EncodingFormatISO_8859_8_I = 39, HTML2PDFEncodingFormat.e_EncodingFormatVISUAL = 40, HTML2PDFEncodingFormat.e_EncodingFormatCSN_369103 = 41, HTML2PDFEncodingFormat.e_EncodingFormatISO_8859_13 = 42, HTML2PDFEncodingFormat.e_EncodingFormatISO_2022_KR = 43, HTML2PDFEncodingFormat.e_EncodingFormatGBK = 44, HTML2PDFEncodingFormat.e_EncodingFormatGB18030 = 45, HTML2PDFEncodingFormat.e_EncodingFormatBIG5_HKSCS = 46, HTML2PDFEncodingFormat.e_EncodingFormatISO_2022_CN = 47, HTML2PDFEncodingFormat.e_EncodingFormatTSCII = 48, HTML2PDFEncodingFormat.e_EncodingFormatTAM = 49, HTML2PDFEncodingFormat.e_EncodingFormatTAB = 50, HTML2PDFEncodingFormat.e_EncodingFormatJAGRAN = 51, HTML2PDFEncodingFormat.e_EncodingFormatMACINTOSH = 52, HTML2PDFEncodingFormat.e_EncodingFormatUTF7 = 53, HTML2PDFEncodingFormat.e_EncodingFormatBHASKAR = 54, HTML2PDFEncodingFormat.e_EncodingFormatHTCHANAKYA = 55, HTML2PDFEncodingFormat.e_EncodingFormatUTF_16BE = 56, HTML2PDFEncodingFormat.e_EncodingFormatUTF_16LE = 57, HTML2PDFEncodingFormat.e_EncodingFormatUTF_32BE = 58, HTML2PDFEncodingFormat.e_EncodingFormatUTF_32LE = 59, HTML2PDFEncodingFormat.e_EncodingFormatX_BINARYENC = 60, HTML2PDFEncodingFormat.e_EncodingFormatHZ_GB_2312 = 61, HTML2PDFEncodingFormat.e_EncodingFormatX_UTF8UTF8 = 62, HTML2PDFEncodingFormat.e_EncodingFormatX_TAM_ELANGO = 63, HTML2PDFEncodingFormat.e_EncodingFormatX_TAM_LTTMBARANI = 64, HTML2PDFEncodingFormat.e_EncodingFormatX_TAM_SHREE = 65, HTML2PDFEncodingFormat.e_EncodingFormatX_TAM_TBOOMIS = 66, HTML2PDFEncodingFormat.e_EncodingFormatX_TAM_TMNEWS = 67, HTML2PDFEncodingFormat.e_EncodingFormatX_TAM_WEBTAMIL = 68, HTML2PDFEncodingFormat.e_EncodingFormatX_KDDI_Shift_JIS = 69, HTML2PDFEncodingFormat.e_EncodingFormatX_DoCoMo_Shift_JIS = 70, HTML2PDFEncodingFormat.e_EncodingFormatX_SoftBank_Shift_JIS = 71, HTML2PDFEncodingFormat.e_EncodingFormatX_KDDI_ISO_2022_JP = 72, HTML2PDFEncodingFormat.e_EncodingFormatX_SoftBank_ISO_2022_JP = 73 }
| 用于将HTML转换为PDF的编码格式枚举。 更多...
enum | HTML2PDFMediaStyle { HTML2PDFMediaStyle.e_MediaStyleScreen = 0, HTML2PDFMediaStyle.e_MediaStylePrint = 1 }
| 用于将HTML转换为PDF的媒体样式枚举。 更多...
enum | HTML2PDFPageMode { HTML2PDFPageMode.e_PageModeSinglePage = 0, HTML2PDFPageMode.e_PageModeMultiplePage = 1 }
| 用于将HTML转换为PDF的页面模式枚举。 更多...
enum | HTML2PDFScalingMode { HTML2PDFScalingMode.e_ScalingModeNone = 0, HTML2PDFScalingMode.e_ScalingModeScale = 1, HTML2PDFScalingMode.e_ScalingModeEnlarge = 2 }
| 用于将HTML转换为PDF的缩放模式枚举。 更多...

## Public 成员函数
| HTML2PDFSettingData ()
| 构造函数。
| HTML2PDFSettingData (float page_width, float page_height, bool is_to_page_scale, RectF page_margin, bool is_convert_link, Rotation rotate_degrees, bool is_generate_tag, HTML2PDFSettingData.HTML2PDFPageMode page_mode, bool to_generate_bookmarks, HTML2PDFSettingData.HTML2PDFScalingMode scaling_mode, HTML2PDFSettingData.HTML2PDFEncodingFormat encoding_format, bool to_render_images, bool to_remove_underline_for_link, bool to_set_headerfooter, string headerfooter_title, string headerfooter_url, string bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree, HTML2PDFSettingData.HTML2PDFMediaStyle media_style, bool to_load_active_content, bool to_disable_sandbox, bool to_use_blacklist, bool to_hide_header, bool to_hide_footer, bool to_deny_local_file_access)
| 带参数的构造函数。 更多...
void | Set (float page_width, float page_height, bool is_to_page_scale, RectF page_margin, bool is_convert_link, Rotation rotate_degrees, bool is_generate_tag, HTML2PDFSettingData.HTML2PDFPageMode page_mode, bool to_generate_bookmarks, HTML2PDFSettingData.HTML2PDFScalingMode scaling_mode, HTML2PDFSettingData.HTML2PDFEncodingFormat encoding_format, bool to_render_images, bool to_remove_underline_for_link, bool to_set_headerfooter, string headerfooter_title, string headerfooter_url, string bookmark_root_name, bool to_resize_objects, bool to_print_background, bool to_optimize_tag_tree, HTML2PDFSettingData.HTML2PDFMediaStyle media_style, bool to_load_active_content, bool to_disable_sandbox, bool to_use_blacklist, bool to_hide_header, bool to_hide_footer, bool to_deny_local_file_access)
| 设置值。 更多...

## 属性
string | bookmark_root_name`[get, set]`
| 书签的根名称。
HTML2PDFSettingData.HTML2PDFEncodingFormat | encoding_format`[get, set]`
| HTML编码格式。请参考从foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFEncodingFormat.e_EncodingFormatDefault 开始的值， 应该是这些值中的一个。
string | headerfooter_title`[get, set]`
| 页眉页脚标题，作为中央页眉的内容。
string | headerfooter_url`[get, set]`
| 页眉页脚URL，作为左侧页脚的内容。
bool | is_convert_link`[get, set]`
| 用于决定是否转换网页链接。
bool | is_generate_tag`[get, set]`
| 用于决定是否生成标签。
bool | is_to_page_scale`[get, set]`
| 用于决定是否缩放转换的PDF页面。 更多...
HTML2PDFSettingData.HTML2PDFMediaStyle | media_style`[get, set]`
| 用于转换的PDF文档的媒体样式。请参考从foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFMediaStyle.e_MediaStyleScreen 开始的值， 应该是这些值中的一个。
float | page_height`[get, set]`
| 用于转换的PDF文档的页面高度（单位为1/72英寸）。 更多...
RectF? | page_margin`[get, set]`
| 用于转换的PDF文档的页面边距。 更多...
HTML2PDFSettingData.HTML2PDFPageMode | page_mode`[get, set]`
| 用于转换的页面模式。请参考从foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage 开始的值， 应该是这些值中的一个。
float | page_width`[get, set]`
| 用于转换的PDF文档的页面宽度（单位为1/72英寸）。 更多...
Rotation | rotate_degrees`[get, set]`
| 用于转换的PDF页面的旋转度数。请参考从foxit.common.Rotation.e_Rotation0 开始的值， 应该是这些值中的一个。
HTML2PDFSettingData.HTML2PDFScalingMode | scaling_mode`[get, set]`
| 用于转换的PDF文档的缩放模式。请参考从foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFScalingMode.e_ScalingModeNone 开始的值， 应该是这些值中的一个。
bool | to_deny_local_file_access`[get, set]`
| 用于决定在转换HTML文件时是否拒绝本地文件访问。 在Linux x86平台上不支持。 更多...
bool | to_disable_sandbox`[get, set]`
| 用于决定是否禁用沙盒。 更多...
bool | to_generate_bookmarks`[get, set]`
| 用于决定是否生成书签。
bool | to_hide_footer`[get, set]`
| 用于决定是否隐藏页脚。在Linux x86平台上不支持。
bool | to_hide_header`[get, set]`
| 用于决定是否隐藏页眉。在Linux x86平台上不支持。
bool | to_load_active_content`[get, set]`
| 用于决定是否加载活动内容。 更多...
bool | to_optimize_tag_tree`[get, set]`
| 用于决定是否优化标签树。
bool | to_print_background`[get, set]`
| 用于决定是否打印背景。
bool | to_remove_underline_for_link`[get, set]`
| 用于决定是否为链接移除下划线装饰。
bool | to_render_images`[get, set]`
| 用于决定是否渲染图像。
bool | to_resize_objects`[get, set]`
| 是否在渲染过程中启用与Javascript相关的对象调整大小功能。
bool | to_set_headerfooter`[get, set]`
| 用于决定是否设置页眉页脚。
bool | to_use_blacklist`[get, set]`
| 用于决定是否使用黑名单。 更多...

## 详细描述

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

## 成员枚举类型说明

## ◆ HTML2PDFEncodingFormat

enum foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFEncodingFormat
| strong

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

此枚举的值应该单独使用。

枚举值
e_EncodingFormatDefault | 编码格式：默认。编码格式将在chromium中自动检测。
e_EncodingFormatASCII | 编码格式："ASCII"。
e_EncodingFormatLatin2 | 编码格式："Latin2"。
e_EncodingFormatLatin3 | 编码格式："Latin3"。
e_EncodingFormatLatin4 | 编码格式："Latin4"。
e_EncodingFormatLatin5 | 编码格式："Latin5"。
e_EncodingFormatLatin6 | 编码格式："Latin6"。
e_EncodingFormatISO_8859_5 | 编码格式："ISO-8859-5"。
e_EncodingFormatArabic | 编码格式："Arabic"。
e_EncodingFormatGreek | 编码格式："Greek"。
e_EncodingFormatHebrew | 编码格式："Hebrew"。
e_EncodingFormatEUC_JP | 编码格式："EUC-JP"。
e_EncodingFormatSJS | 编码格式："SJS"。
e_EncodingFormatJIS | 编码格式："JIS"。
e_EncodingFormatBIG5 | 编码格式："BIG5"。
e_EncodingFormatGB | 编码格式："GB"。
e_EncodingFormatEUC_CN | 编码格式："EUC-CN"。
e_EncodingFormatKSC | 编码格式："KSC"。
e_EncodingFormatUnicode | 编码格式："Unicode"。
e_EncodingFormatEUC | 编码格式："EUC"。
e_EncodingFormatCNS | 编码格式："CNS"。
e_EncodingFormatBIG5_CP950 | 编码格式："BIG5-CP950"。
e_EncodingFormatASCII_7_bit | 编码格式："ASCII-7-bit"。
e_EncodingFormatKOI8R | 编码格式："KOI8R"。
e_EncodingFormatCP852 | 编码格式："CP852"。
e_EncodingFormatCP866 | 编码格式："CP866"。
e_EncodingFormatCP874 | 编码格式："CP874"。
e_EncodingFormatCP932 | 编码格式："CP932"。
e_EncodingFormatCP1250 | 编码格式："CP1250"。
e_EncodingFormatCP1251 | 编码格式："CP1251"。
e_EncodingFormatCP1252 | 编码格式："CP1252"。
e_EncodingFormatCP1253 | 编码格式："CP1253"。
e_EncodingFormatCP1254 | 编码格式："CP1254"。
e_EncodingFormatCP1255 | 编码格式："CP1255"。
e_EncodingFormatCP1256 | 编码格式："CP1256"。
e_EncodingFormatCP1257 | 编码格式："CP1257"。
e_EncodingFormatKOI8U | 编码格式："KOI8U"。
e_EncodingFormatISO_8859_15 | 编码格式："ISO-8859-15"。
e_EncodingFormatISO_8859_11 | 编码格式："ISO-8859-11"。
e_EncodingFormatISO_8859_8_I | 编码格式："ISO-8859-8-I"。
e_EncodingFormatVISUAL | 编码格式："VISUAL"。
e_EncodingFormatCSN_369103 | 编码格式："CSN_369103"。
e_EncodingFormatISO_8859_13 | 编码格式："ISO-8859-13"。
e_EncodingFormatISO_2022_KR | 编码格式："ISO-2022-KR"。
e_EncodingFormatGBK | 编码格式："GBK"。
e_EncodingFormatGB18030 | 编码格式："GB18030"。
e_EncodingFormatBIG5_HKSCS | 编码格式："BIG5_HKSCS"。
e_EncodingFormatISO_2022_CN | 编码格式："ISO_2022_CN"。
e_EncodingFormatTSCII | 编码格式："TSCII"。
e_EncodingFormatTAM | 编码格式："TAM"。
e_EncodingFormatTAB | 编码格式："TAB"。
e_EncodingFormatJAGRAN | 编码格式："JAGRAN"。
e_EncodingFormatMACINTOSH | 编码格式："MACINTOSH"。
e_EncodingFormatUTF7 | 编码格式："UTF7"。
e_EncodingFormatBHASKAR | 编码格式："BHASKAR"。
e_EncodingFormatHTCHANAKYA | 编码格式："HTCHANAKYA"。
e_EncodingFormatUTF_16BE | 编码格式："UTF-16BE"。
e_EncodingFormatUTF_16LE | 编码格式："UTF-16LE"。
e_EncodingFormatUTF_32BE | 编码格式："UTF-32BE"。
e_EncodingFormatUTF_32LE | 编码格式："UTF-32LE"。
e_EncodingFormatX_BINARYENC | 编码格式："X-BINARYENC"。
e_EncodingFormatHZ_GB_2312 | 编码格式："HZ-GB-2312"。
e_EncodingFormatX_UTF8UTF8 | 编码格式："X-UTF8UTF8"。
e_EncodingFormatX_TAM_ELANGO | 编码格式："X-TAM-ELANGO"。
e_EncodingFormatX_TAM_LTTMBARANI | 编码格式："X-TAM-LTTMBARANI"。
e_EncodingFormatX_TAM_SHREE | 编码格式："X-TAM-SHREE"。
e_EncodingFormatX_TAM_TBOOMIS | 编码格式："X-TAM-TBOOMIS"。
e_EncodingFormatX_TAM_TMNEWS | 编码格式："X-TAM-TMNEWS"。
e_EncodingFormatX_TAM_WEBTAMIL | 编码格式："X-TAM-WEBTAMIL"。
e_EncodingFormatX_KDDI_Shift_JIS | 编码格式："X-KDDI-Shift_JIS"。
e_EncodingFormatX_DoCoMo_Shift_JIS | 编码格式："X-DoCoMo-Shift_JIS"。
e_EncodingFormatX_SoftBank_Shift_JIS | 编码格式："X-SoftBank-Shift_JIS"。
e_EncodingFormatX_KDDI_ISO_2022_JP | 编码格式："X-KDDI-ISO-2022-JP"。
e_EncodingFormatX_SoftBank_ISO_2022_JP | 编码格式："X-SoftBank-ISO-2022-JP"。

## ◆ HTML2PDFMediaStyle

enum foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFMediaStyle
| strong

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

此枚举的值应该单独使用。

枚举值
e_MediaStyleScreen | 媒体样式：屏幕。意味着PDF页面将以屏幕媒体样式显示。
e_MediaStylePrint | 媒体样式：打印。意味着PDF页面将以打印媒体样式显示。

## ◆ HTML2PDFPageMode

enum foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode
| strong

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

此枚举的值应该单独使用。

枚举值
e_PageModeSinglePage | 单页模式。
e_PageModeMultiplePage | 多页模式。

## ◆ HTML2PDFScalingMode

enum foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFScalingMode
| strong

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

此枚举的值应该单独使用。

枚举值
e_ScalingModeNone | 缩放模式：固定页面无缩放。在此模式下，HTML内容的文本大小不会改变。
e_ScalingModeScale | 页面缩放：缩放。这意味着HTML内容将被缩放以适应PDF页面大小。在此模式下，文本大小可能会改变。
e_ScalingModeEnlarge | 页面缩放：放大。这意味着PDF页面将被放大到HTML内容大小。在此模式下，HTML内容的文本大小不会改变。

## 构造及析构函数说明

## ◆ HTML2PDFSettingData()

foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFSettingData | ( | float | page_width,
|  | float | page_height,
|  | bool | is_to_page_scale,
|  | RectF | page_margin,
|  | bool | is_convert_link,
|  | Rotation | rotate_degrees,
|  | bool | is_generate_tag,
|  | HTML2PDFSettingData.HTML2PDFPageMode | page_mode,
|  | bool | to_generate_bookmarks,
|  | HTML2PDFSettingData.HTML2PDFScalingMode | scaling_mode,
|  | HTML2PDFSettingData.HTML2PDFEncodingFormat | encoding_format,
|  | bool | to_render_images,
|  | bool | to_remove_underline_for_link,
|  | bool | to_set_headerfooter,
|  | string | headerfooter_title,
|  | string | headerfooter_url,
|  | string | bookmark_root_name,
|  | bool | to_resize_objects,
|  | bool | to_print_background,
|  | bool | to_optimize_tag_tree,
|  | HTML2PDFSettingData.HTML2PDFMediaStyle | media_style,
|  | bool | to_load_active_content,
|  | bool | to_disable_sandbox,
|  | bool | to_use_blacklist,
|  | bool | to_hide_header,
|  | bool | to_hide_footer,
|  | bool | to_deny_local_file_access
| ) |  |
| inline

带参数的构造函数。

参数

  [in] | page_width | 用于转换的PDF文档的页面宽度（单位为1/72英寸）。
  [in] | page_height | 用于转换的PDF文档的页面高度（单位为1/72英寸）。如果使用页面模式 foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage ，此参数将被忽略。
  [in] | is_to_page_scale | （已弃用）用于决定是否缩放转换的PDF页面。
  [in] | page_margin | 用于转换的PDF文档的页面边距。
  [in] | is_convert_link | 用于决定是否转换网页链接。
  [in] | rotate_degrees | 用于转换的PDF页面的旋转度数。请参考从foxit.common.Rotation.e_Rotation0 开始的值， 应该是这些值中的一个。
  [in] | is_generate_tag | 用于决定是否生成标签。
  [in] | page_mode | 用于转换的页面模式。请参考从 foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage 开始的值，应该是这些值中的一个。
  [in] | to_generate_bookmarks | 用于决定是否生成书签。
  [in] | scaling_mode | 用于转换的PDF文档的缩放模式。请参考从foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFScalingMode.e_ScalingModeNone 开始的值， 应该是这些值中的一个。默认值：foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFScalingMode.e_ScalingModeScale 。
  [in] | encoding_format | HTML编码格式。请参考从开始的值， 应该是这些值中的一个。 to_render_images 是否渲染图像。 to_remove_underline_for_link 是否移除链接的下划线装饰。 to_set_headerfooter 是否设置页眉页脚。 headerfooter_title 页眉页脚标题，作为中心页眉的内容。 headerfooter_url 页眉页脚URL，作为左页脚的内容。 bookmark_root_name 书签的根名称。 to_resize_objects 是否在渲染过程中启用与JavaScript相关的对象调整大小。 to_print_background 是否打印背景。 to_optimize_tag_tree 是否优化标签树。 media_style 用于转换的PDF文档的媒体样式。请参考从 foxit::addon::conversion::HTML2PDFSettingData::HTML2PDFMediaStyle::e_MediaStyleScreen foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFMediaStyle.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()

void foxit.addon.conversion.HTML2PDFSettingData.Set | ( | float | page_width,
|  | float | page_height,
|  | bool | is_to_page_scale,
|  | RectF | page_margin,
|  | bool | is_convert_link,
|  | Rotation | rotate_degrees,
|  | bool | is_generate_tag,
|  | HTML2PDFSettingData.HTML2PDFPageMode | page_mode,
|  | bool | to_generate_bookmarks,
|  | HTML2PDFSettingData.HTML2PDFScalingMode | scaling_mode,
|  | HTML2PDFSettingData.HTML2PDFEncodingFormat | encoding_format,
|  | bool | to_render_images,
|  | bool | to_remove_underline_for_link,
|  | bool | to_set_headerfooter,
|  | string | headerfooter_title,
|  | string | headerfooter_url,
|  | string | bookmark_root_name,
|  | bool | to_resize_objects,
|  | bool | to_print_background,
|  | bool | to_optimize_tag_tree,
|  | HTML2PDFSettingData.HTML2PDFMediaStyle | media_style,
|  | bool | to_load_active_content,
|  | bool | to_disable_sandbox,
|  | bool | to_use_blacklist,
|  | bool | to_hide_header,
|  | bool | to_hide_footer,
|  | bool | to_deny_local_file_access
| ) |  |
| inline

设置值。

参数

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

返回
  无。

## 属性说明

## ◆ is_to_page_scale

bool foxit.addon.conversion.HTML2PDFSettingData.is_to_page_scale
| get set

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

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

## ◆ page_height

float foxit.addon.conversion.HTML2PDFSettingData.page_height
| get set

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

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

注解
  如果使用页面模式foxit.addon.conversion.HTML2PDFSettingData.HTML2PDFPageMode.e_PageModeSinglePage ，页面高度将被忽略。

## ◆ page_margin

RectF foxit.addon.conversion.HTML2PDFSettingData.page_margin
| get set

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

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

## ◆ page_width

float foxit.addon.conversion.HTML2PDFSettingData.page_width
| get set

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

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

## ◆ to_deny_local_file_access

bool foxit.addon.conversion.HTML2PDFSettingData.to_deny_local_file_access
| get set

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

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

## ◆ to_disable_sandbox

bool foxit.addon.conversion.HTML2PDFSettingData.to_disable_sandbox
| get set

用于决定是否禁用沙盒。

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

## ◆ to_load_active_content

bool foxit.addon.conversion.HTML2PDFSettingData.to_load_active_content
| get set

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

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

## ◆ to_use_blacklist

bool foxit.addon.conversion.HTML2PDFSettingData.to_use_blacklist
| get set

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

此参数对检查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"]}]
             }