Foxit PDF SDK
com.foxit.sdk.addon.conversion.HTML2PDFSettingData类 参考

Public 成员函数

 HTML2PDFSettingData ()
 构造函数。

 
 HTML2PDFSettingData (float page_width, float page_height, boolean is_to_page_scale, RectF page_margin, boolean is_convert_link, int rotate_degrees, boolean is_generate_tag, int page_mode, boolean to_generate_bookmarks, int scaling_mode, int encoding_format, boolean to_render_images, boolean to_remove_underline_for_link, boolean to_set_headerfooter, String headerfooter_title, String headerfooter_url, String bookmark_root_name, boolean to_resize_objects, boolean to_print_background, boolean to_optimize_tag_tree, int media_style, boolean to_load_active_content, boolean to_disable_sandbox, boolean to_use_blacklist, boolean to_hide_header, boolean to_hide_footer, boolean to_deny_local_file_access)
 带参数的构造函数。
更多...
 
synchronized void delete ()
 直接清除C++相关资源。 更多...
 
String getBookmark_root_name ()
 Get 书签的根名称。
更多...
 
int getEncoding_format ()
 Get hTML编码格式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_EncodingFormatDefault 开始的值, 应该是这些值中的一个。
更多...
 
String getHeaderfooter_title ()
 Get 页眉页脚标题,作为中央页眉的内容。
更多...
 
String getHeaderfooter_url ()
 Get 页眉页脚URL,作为左侧页脚的内容。
更多...
 
boolean getIs_convert_link ()
 Get 用于决定是否转换网页链接。
更多...
 
boolean getIs_generate_tag ()
 Get 用于决定是否生成标签。
更多...
 
boolean getIs_to_page_scale ()
 Get 用于决定是否缩放转换的PDF页面。
更多...
 
int getMedia_style ()
 Get 用于转换的PDF文档的媒体样式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_MediaStyleScreen 开始的值, 应该是这些值中的一个。
更多...
 
float getPage_height ()
 Get 用于转换的PDF文档的页面高度(单位为1/72英寸)。
更多...
 
RectF getPage_margin ()
 Get 用于转换的PDF文档的页面边距。
更多...
 
int getPage_mode ()
 Get 用于转换的页面模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage 开始的值, 应该是这些值中的一个。
更多...
 
float getPage_width ()
 Get 用于转换的PDF文档的页面宽度(单位为1/72英寸)。
更多...
 
int getRotate_degrees ()
 Get 用于转换的PDF页面的旋转度数。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值, 应该是这些值中的一个。
更多...
 
int getScaling_mode ()
 Get 用于转换的PDF文档的缩放模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_ScalingModeNone 开始的值, 应该是这些值中的一个。
更多...
 
boolean getTo_deny_local_file_access ()
 Get 用于决定在转换HTML文件时是否拒绝本地文件访问。 在Linux x86平台上不支持。
更多...
 
boolean getTo_disable_sandbox ()
 Get 用于决定是否禁用沙盒。
更多...
 
boolean getTo_generate_bookmarks ()
 Get 用于决定是否生成书签。
更多...
 
boolean getTo_hide_footer ()
 Get 用于决定是否隐藏页脚。在Linux x86平台上不支持。
更多...
 
boolean getTo_hide_header ()
 Get 用于决定是否隐藏页眉。在Linux x86平台上不支持。
更多...
 
boolean getTo_load_active_content ()
 Get 用于决定是否加载活动内容。
更多...
 
boolean getTo_optimize_tag_tree ()
 Get 用于决定是否优化标签树。
更多...
 
boolean getTo_print_background ()
 Get 用于决定是否打印背景。
更多...
 
boolean getTo_remove_underline_for_link ()
 Get 用于决定是否为链接移除下划线装饰。
更多...
 
boolean getTo_render_images ()
 Get 用于决定是否渲染图像。
更多...
 
boolean getTo_resize_objects ()
 Get 是否在渲染过程中启用与Javascript相关的对象调整大小功能。
更多...
 
boolean getTo_set_headerfooter ()
 Get 用于决定是否设置页眉页脚。
更多...
 
boolean getTo_use_blacklist ()
 Get 用于决定是否使用黑名单。
更多...
 
void set (float page_width, float page_height, boolean is_to_page_scale, RectF page_margin, boolean is_convert_link, int rotate_degrees, boolean is_generate_tag, int page_mode, boolean to_generate_bookmarks, int scaling_mode, int encoding_format, boolean to_render_images, boolean to_remove_underline_for_link, boolean to_set_headerfooter, String headerfooter_title, String headerfooter_url, String bookmark_root_name, boolean to_resize_objects, boolean to_print_background, boolean to_optimize_tag_tree, int media_style, boolean to_load_active_content, boolean to_disable_sandbox, boolean to_use_blacklist, boolean to_hide_header, boolean to_hide_footer, boolean to_deny_local_file_access)
 设置值。
更多...
 
void setBookmark_root_name (String value)
 Set 书签的根名称。
更多...
 
void setEncoding_format (int value)
 Set hTML编码格式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_EncodingFormatDefault 开始的值, 应该是这些值中的一个。
更多...
 
void setHeaderfooter_title (String value)
 Set 页眉页脚标题,作为中央页眉的内容。
更多...
 
void setHeaderfooter_url (String value)
 Set 页眉页脚URL,作为左侧页脚的内容。
更多...
 
void setIs_convert_link (boolean value)
 Set 用于决定是否转换网页链接。
更多...
 
void setIs_generate_tag (boolean value)
 Set 用于决定是否生成标签。
更多...
 
void setIs_to_page_scale (boolean value)
 Set 用于决定是否缩放转换的PDF页面。
更多...
 
void setMedia_style (int value)
 Set 用于转换的PDF文档的媒体样式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_MediaStyleScreen 开始的值, 应该是这些值中的一个。
更多...
 
void setPage_height (float value)
 Set 用于转换的PDF文档的页面高度(单位为1/72英寸)。
更多...
 
void setPage_margin (RectF value)
 Set 用于转换的PDF文档的页面边距。
更多...
 
void setPage_mode (int value)
 Set 用于转换的页面模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage 开始的值, 应该是这些值中的一个。
更多...
 
void setPage_width (float value)
 Set 用于转换的PDF文档的页面宽度(单位为1/72英寸)。
更多...
 
void setRotate_degrees (int value)
 Set 用于转换的PDF页面的旋转度数。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值, 应该是这些值中的一个。
更多...
 
void setScaling_mode (int value)
 Set 用于转换的PDF文档的缩放模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_ScalingModeNone 开始的值, 应该是这些值中的一个。
更多...
 
void setTo_deny_local_file_access (boolean value)
 Set 用于决定在转换HTML文件时是否拒绝本地文件访问。 在Linux x86平台上不支持。
更多...
 
void setTo_disable_sandbox (boolean value)
 Set 用于决定是否禁用沙盒。
更多...
 
void setTo_generate_bookmarks (boolean value)
 Set 用于决定是否生成书签。
更多...
 
void setTo_hide_footer (boolean value)
 Set 用于决定是否隐藏页脚。在Linux x86平台上不支持。
更多...
 
void setTo_hide_header (boolean value)
 Set 用于决定是否隐藏页眉。在Linux x86平台上不支持。
更多...
 
void setTo_load_active_content (boolean value)
 Set 用于决定是否加载活动内容。
更多...
 
void setTo_optimize_tag_tree (boolean value)
 Set 用于决定是否优化标签树。
更多...
 
void setTo_print_background (boolean value)
 Set 用于决定是否打印背景。
更多...
 
void setTo_remove_underline_for_link (boolean value)
 Set 用于决定是否为链接移除下划线装饰。
更多...
 
void setTo_render_images (boolean value)
 Set 用于决定是否渲染图像。
更多...
 
void setTo_resize_objects (boolean value)
 Set 是否在渲染过程中启用与Javascript相关的对象调整大小功能。
更多...
 
void setTo_set_headerfooter (boolean value)
 Set 用于决定是否设置页眉页脚。
更多...
 
void setTo_use_blacklist (boolean value)
 Set 用于决定是否使用黑名单。
更多...
 

静态 Public 属性

static final int e_EncodingFormatArabic = 8
 编码格式:"Arabic"。

 
static final int e_EncodingFormatASCII = 1
 编码格式:"ASCII"。

 
static final int e_EncodingFormatASCII_7_bit = 22
 编码格式:"ASCII-7-bit"。

 
static final int e_EncodingFormatBHASKAR = 54
 编码格式:"BHASKAR"。

 
static final int e_EncodingFormatBIG5 = 14
 编码格式:"BIG5"。

 
static final int e_EncodingFormatBIG5_CP950 = 21
 编码格式:"BIG5-CP950"。

 
static final int e_EncodingFormatBIG5_HKSCS = 46
 编码格式:"BIG5_HKSCS"。

 
static final int e_EncodingFormatCNS = 20
 编码格式:"CNS"。

 
static final int e_EncodingFormatCP1250 = 28
 编码格式:"CP1250"。

 
static final int e_EncodingFormatCP1251 = 29
 编码格式:"CP1251"。

 
static final int e_EncodingFormatCP1252 = 30
 编码格式:"CP1252"。

 
static final int e_EncodingFormatCP1253 = 31
 编码格式:"CP1253"。

 
static final int e_EncodingFormatCP1254 = 32
 编码格式:"CP1254"。

 
static final int e_EncodingFormatCP1255 = 33
 编码格式:"CP1255"。

 
static final int e_EncodingFormatCP1256 = 34
 编码格式:"CP1256"。

 
static final int e_EncodingFormatCP1257 = 35
 编码格式:"CP1257"。

 
static final int e_EncodingFormatCP852 = 24
 编码格式:"CP852"。

 
static final int e_EncodingFormatCP866 = 25
 编码格式:"CP866"。

 
static final int e_EncodingFormatCP874 = 26
 编码格式:"CP874"。

 
static final int e_EncodingFormatCP932 = 27
 编码格式:"CP932"。

 
static final int e_EncodingFormatCSN_369103 = 41
 编码格式:"CSN_369103"。

 
static final int e_EncodingFormatDefault = 0
 编码格式:默认。编码格式将在chromium中自动检测。

 
static final int e_EncodingFormatEUC = 19
 编码格式:"EUC"。

 
static final int e_EncodingFormatEUC_CN = 16
 编码格式:"EUC-CN"。

 
static final int e_EncodingFormatEUC_JP = 11
 编码格式:"EUC-JP"。

 
static final int e_EncodingFormatGB = 15
 编码格式:"GB"。

 
static final int e_EncodingFormatGB18030 = 45
 编码格式:"GB18030"。

 
static final int e_EncodingFormatGBK = 44
 编码格式:"GBK"。

 
static final int e_EncodingFormatGreek = 9
 编码格式:"Greek"。

 
static final int e_EncodingFormatHebrew = 10
 编码格式:"Hebrew"。

 
static final int e_EncodingFormatHTCHANAKYA = 55
 编码格式:"HTCHANAKYA"。

 
static final int e_EncodingFormatHZ_GB_2312 = 61
 编码格式:"HZ-GB-2312"。

 
static final int e_EncodingFormatISO_2022_CN = 47
 编码格式:"ISO_2022_CN"。

 
static final int e_EncodingFormatISO_2022_KR = 43
 编码格式:"ISO-2022-KR"。

 
static final int e_EncodingFormatISO_8859_11 = 38
 编码格式:"ISO-8859-11"。

 
static final int e_EncodingFormatISO_8859_13 = 42
 编码格式:"ISO-8859-13"。

 
static final int e_EncodingFormatISO_8859_15 = 37
 编码格式:"ISO-8859-15"。

 
static final int e_EncodingFormatISO_8859_5 = 7
 编码格式:"ISO-8859-5"。

 
static final int e_EncodingFormatISO_8859_8_I = 39
 编码格式:"ISO-8859-8-I"。

 
static final int e_EncodingFormatJAGRAN = 51
 编码格式:"JAGRAN"。

 
static final int e_EncodingFormatJIS = 13
 编码格式:"JIS"。

 
static final int e_EncodingFormatKOI8R = 23
 编码格式:"KOI8R"。

 
static final int e_EncodingFormatKOI8U = 36
 编码格式:"KOI8U"。

 
static final int e_EncodingFormatKSC = 17
 编码格式:"KSC"。

 
static final int e_EncodingFormatLatin2 = 2
 编码格式:"Latin2"。

 
static final int e_EncodingFormatLatin3 = 3
 编码格式:"Latin3"。

 
static final int e_EncodingFormatLatin4 = 4
 编码格式:"Latin4"。

 
static final int e_EncodingFormatLatin5 = 5
 编码格式:"Latin5"。

 
static final int e_EncodingFormatLatin6 = 6
 编码格式:"Latin6"。

 
static final int e_EncodingFormatMACINTOSH = 52
 编码格式:"MACINTOSH"。

 
static final int e_EncodingFormatSJS = 12
 编码格式:"SJS"。

 
static final int e_EncodingFormatTAB = 50
 编码格式:"TAB"。

 
static final int e_EncodingFormatTAM = 49
 编码格式:"TAM"。

 
static final int e_EncodingFormatTSCII = 48
 编码格式:"TSCII"。

 
static final int e_EncodingFormatUnicode = 18
 编码格式:"Unicode"。

 
static final int e_EncodingFormatUTF7 = 53
 编码格式:"UTF7"。

 
static final int e_EncodingFormatUTF_16BE = 56
 编码格式:"UTF-16BE"。

 
static final int e_EncodingFormatUTF_16LE = 57
 编码格式:"UTF-16LE"。

 
static final int e_EncodingFormatUTF_32BE = 58
 编码格式:"UTF-32BE"。

 
static final int e_EncodingFormatUTF_32LE = 59
 编码格式:"UTF-32LE"。

 
static final int e_EncodingFormatVISUAL = 40
 编码格式:"VISUAL"。

 
static final int e_EncodingFormatX_BINARYENC = 60
 编码格式:"X-BINARYENC"。

 
static final int e_EncodingFormatX_DoCoMo_Shift_JIS = 70
 编码格式:"X-DoCoMo-Shift_JIS"。

 
static final int e_EncodingFormatX_KDDI_ISO_2022_JP = 72
 编码格式:"X-KDDI-ISO-2022-JP"。

 
static final int e_EncodingFormatX_KDDI_Shift_JIS = 69
 编码格式:"X-KDDI-Shift_JIS"。

 
static final int e_EncodingFormatX_SoftBank_ISO_2022_JP = 73
 编码格式:"X-SoftBank-ISO-2022-JP"。

 
static final int e_EncodingFormatX_SoftBank_Shift_JIS = 71
 编码格式:"X-SoftBank-Shift_JIS"。

 
static final int e_EncodingFormatX_TAM_ELANGO = 63
 编码格式:"X-TAM-ELANGO"。

 
static final int e_EncodingFormatX_TAM_LTTMBARANI = 64
 编码格式:"X-TAM-LTTMBARANI"。

 
static final int e_EncodingFormatX_TAM_SHREE = 65
 编码格式:"X-TAM-SHREE"。

 
static final int e_EncodingFormatX_TAM_TBOOMIS = 66
 编码格式:"X-TAM-TBOOMIS"。

 
static final int e_EncodingFormatX_TAM_TMNEWS = 67
 编码格式:"X-TAM-TMNEWS"。

 
static final int e_EncodingFormatX_TAM_WEBTAMIL = 68
 编码格式:"X-TAM-WEBTAMIL"。

 
static final int e_EncodingFormatX_UTF8UTF8 = 62
 编码格式:"X-UTF8UTF8"。

 
static final int e_MediaStylePrint = 1
 媒体样式:打印。意味着PDF页面将以打印媒体样式显示。

 
static final int e_MediaStyleScreen = 0
 媒体样式:屏幕。意味着PDF页面将以屏幕媒体样式显示。

 
static final int e_PageModeMultiplePage = 1
 多页模式。

 
static final int e_PageModeSinglePage = 0
 单页模式。

 
static final int e_ScalingModeEnlarge = 2
 页面缩放:放大。这意味着PDF页面将被放大到HTML内容大小。在此模式下,HTML内容的文本大小不会改变。

 
static final int e_ScalingModeNone = 0
 缩放模式:固定页面无缩放。在此模式下,HTML内容的文本大小不会改变。

 
static final int e_ScalingModeScale = 1
 页面缩放:缩放。这意味着HTML内容将被缩放以适应PDF页面大小。在此模式下,文本大小可能会改变。

 

详细描述

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

构造及析构函数说明

◆ HTML2PDFSettingData()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.HTML2PDFSettingData ( float  page_width,
float  page_height,
boolean  is_to_page_scale,
RectF  page_margin,
boolean  is_convert_link,
int  rotate_degrees,
boolean  is_generate_tag,
int  page_mode,
boolean  to_generate_bookmarks,
int  scaling_mode,
int  encoding_format,
boolean  to_render_images,
boolean  to_remove_underline_for_link,
boolean  to_set_headerfooter,
String  headerfooter_title,
String  headerfooter_url,
String  bookmark_root_name,
boolean  to_resize_objects,
boolean  to_print_background,
boolean  to_optimize_tag_tree,
int  media_style,
boolean  to_load_active_content,
boolean  to_disable_sandbox,
boolean  to_use_blacklist,
boolean  to_hide_header,
boolean  to_hide_footer,
boolean  to_deny_local_file_access 
)

带参数的构造函数。

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

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.addon.conversion.HTML2PDFSettingData.delete ( )

直接清除C++相关资源。

返回
无。
注解
一旦这个接口被调用,这个对象将不能再被使用。

◆ getBookmark_root_name()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getBookmark_root_name ( )

Get 书签的根名称。

返回
书签的根名称。

◆ getEncoding_format()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getEncoding_format ( )

Get hTML编码格式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_EncodingFormatDefault 开始的值, 应该是这些值中的一个。

返回
HTML编码格式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_EncodingFormatDefault 开始的值, 应该是这些值中的一个。

◆ getHeaderfooter_title()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getHeaderfooter_title ( )

Get 页眉页脚标题,作为中央页眉的内容。

返回
页眉页脚标题,作为中央页眉的内容。

◆ getHeaderfooter_url()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getHeaderfooter_url ( )

Get 页眉页脚URL,作为左侧页脚的内容。

返回
页眉页脚URL,作为左侧页脚的内容。

◆ getIs_convert_link()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getIs_convert_link ( )

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

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

◆ getIs_generate_tag()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getIs_generate_tag ( )

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

返回
用于决定是否生成标签。

◆ getIs_to_page_scale()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getIs_to_page_scale ( )

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

弃用:
自Foxit PDF SDK 8.2以来,当前属性已被弃用。此属性将不再对PDF转换产生任何影响。 对于缩放模式,请参考scaling_mode
返回
用于决定是否缩放转换的PDF页面。

◆ getMedia_style()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getMedia_style ( )

Get 用于转换的PDF文档的媒体样式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_MediaStyleScreen 开始的值, 应该是这些值中的一个。

返回
用于转换的PDF文档的媒体样式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_MediaStyleScreen 开始的值, 应该是这些值中的一个。

◆ getPage_height()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getPage_height ( )

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

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

注解
如果使用页面模式com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage ,页面高度将被忽略。
返回
用于转换的PDF文档的页面高度(单位为1/72英寸)。

◆ getPage_margin()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getPage_margin ( )

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

注解
此值不表示矩形。它只是定义PDF页面的左边距、下边距、 右边距和上边距。
返回
用于转换的PDF文档的页面边距。

◆ getPage_mode()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getPage_mode ( )

Get 用于转换的页面模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage 开始的值, 应该是这些值中的一个。

返回
用于转换的页面模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage 开始的值, 应该是这些值中的一个。

◆ getPage_width()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getPage_width ( )

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

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

返回
用于转换的PDF文档的页面宽度(单位为1/72英寸)。

◆ getRotate_degrees()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getRotate_degrees ( )

Get 用于转换的PDF页面的旋转度数。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值, 应该是这些值中的一个。

返回
用于转换的PDF页面的旋转度数。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值, 应该是这些值中的一个。

◆ getScaling_mode()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getScaling_mode ( )

Get 用于转换的PDF文档的缩放模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_ScalingModeNone 开始的值, 应该是这些值中的一个。

返回
用于转换的PDF文档的缩放模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_ScalingModeNone 开始的值, 应该是这些值中的一个。

◆ getTo_deny_local_file_access()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_deny_local_file_access ( )

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

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

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

◆ getTo_disable_sandbox()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_disable_sandbox ( )

Get 用于决定是否禁用沙盒。

true表示禁用沙盒,false表示不禁用。默认值:true

返回
用于决定是否禁用沙盒。

◆ getTo_generate_bookmarks()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_generate_bookmarks ( )

Get 用于决定是否生成书签。

返回
用于决定是否生成书签。

◆ getTo_hide_footer()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_hide_footer ( )

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

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

◆ getTo_hide_header()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_hide_header ( )

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

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

◆ getTo_load_active_content()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_load_active_content ( )

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

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

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

◆ getTo_optimize_tag_tree()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_optimize_tag_tree ( )

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

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

◆ getTo_print_background()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_print_background ( )

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

返回
用于决定是否打印背景。

◆ getTo_remove_underline_for_link()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_remove_underline_for_link ( )

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

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

◆ getTo_render_images()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_render_images ( )

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

返回
用于决定是否渲染图像。

◆ getTo_resize_objects()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_resize_objects ( )

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

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

◆ getTo_set_headerfooter()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_set_headerfooter ( )

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

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

◆ getTo_use_blacklist()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getTo_use_blacklist ( )

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

此参数对检查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"]}]
         }
         
返回
用于决定是否使用黑名单。

◆ set()

void com.foxit.sdk.addon.conversion.HTML2PDFSettingData.set ( float  page_width,
float  page_height,
boolean  is_to_page_scale,
RectF  page_margin,
boolean  is_convert_link,
int  rotate_degrees,
boolean  is_generate_tag,
int  page_mode,
boolean  to_generate_bookmarks,
int  scaling_mode,
int  encoding_format,
boolean  to_render_images,
boolean  to_remove_underline_for_link,
boolean  to_set_headerfooter,
String  headerfooter_title,
String  headerfooter_url,
String  bookmark_root_name,
boolean  to_resize_objects,
boolean  to_print_background,
boolean  to_optimize_tag_tree,
int  media_style,
boolean  to_load_active_content,
boolean  to_disable_sandbox,
boolean  to_use_blacklist,
boolean  to_hide_header,
boolean  to_hide_footer,
boolean  to_deny_local_file_access 
)

设置值。

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

◆ setBookmark_root_name()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setBookmark_root_name ( String  value)

Set 书签的根名称。

参数
[in]value书签的根名称。
返回
None.

◆ setEncoding_format()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setEncoding_format ( int  value)

Set hTML编码格式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_EncodingFormatDefault 开始的值, 应该是这些值中的一个。

参数
[in]valueHTML编码格式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_EncodingFormatDefault 开始的值, 应该是这些值中的一个。
返回
None.

◆ setHeaderfooter_title()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setHeaderfooter_title ( String  value)

Set 页眉页脚标题,作为中央页眉的内容。

参数
[in]value页眉页脚标题,作为中央页眉的内容。
返回
None.

◆ setHeaderfooter_url()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setHeaderfooter_url ( String  value)

Set 页眉页脚URL,作为左侧页脚的内容。

参数
[in]value页眉页脚URL,作为左侧页脚的内容。
返回
None.

◆ setIs_convert_link()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setIs_convert_link ( boolean  value)

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

参数
[in]value用于决定是否转换网页链接。
返回
None.

◆ setIs_generate_tag()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setIs_generate_tag ( boolean  value)

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

参数
[in]value用于决定是否生成标签。
返回
None.

◆ setIs_to_page_scale()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setIs_to_page_scale ( boolean  value)

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

弃用:
自Foxit PDF SDK 8.2以来,当前属性已被弃用。此属性将不再对PDF转换产生任何影响。 对于缩放模式,请参考scaling_mode
参数
[in]value用于决定是否缩放转换的PDF页面。
返回
None.

◆ setMedia_style()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setMedia_style ( int  value)

Set 用于转换的PDF文档的媒体样式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_MediaStyleScreen 开始的值, 应该是这些值中的一个。

参数
[in]value用于转换的PDF文档的媒体样式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_MediaStyleScreen 开始的值, 应该是这些值中的一个。
返回
None.

◆ setPage_height()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setPage_height ( float  value)

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

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

注解
如果使用页面模式com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage ,页面高度将被忽略。
参数
[in]value用于转换的PDF文档的页面高度(单位为1/72英寸)。
返回
None.

◆ setPage_margin()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setPage_margin ( RectF  value)

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

注解
此值不表示矩形。它只是定义PDF页面的左边距、下边距、 右边距和上边距。
参数
[in]value用于转换的PDF文档的页面边距。
返回
None.

◆ setPage_mode()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setPage_mode ( int  value)

Set 用于转换的页面模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage 开始的值, 应该是这些值中的一个。

参数
[in]value用于转换的页面模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage 开始的值, 应该是这些值中的一个。
返回
None.

◆ setPage_width()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setPage_width ( float  value)

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

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

参数
[in]value用于转换的PDF文档的页面宽度(单位为1/72英寸)。
返回
None.

◆ setRotate_degrees()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setRotate_degrees ( int  value)

Set 用于转换的PDF页面的旋转度数。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值, 应该是这些值中的一个。

参数
[in]value用于转换的PDF页面的旋转度数。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值, 应该是这些值中的一个。
返回
None.

◆ setScaling_mode()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setScaling_mode ( int  value)

Set 用于转换的PDF文档的缩放模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_ScalingModeNone 开始的值, 应该是这些值中的一个。

参数
[in]value用于转换的PDF文档的缩放模式。请参考从com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_ScalingModeNone 开始的值, 应该是这些值中的一个。
返回
None.

◆ setTo_deny_local_file_access()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_deny_local_file_access ( boolean  value)

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

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

参数
[in]value用于决定在转换HTML文件时是否拒绝本地文件访问。 在Linux x86平台上不支持。
返回
None.

◆ setTo_disable_sandbox()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_disable_sandbox ( boolean  value)

Set 用于决定是否禁用沙盒。

true表示禁用沙盒,false表示不禁用。默认值:true

参数
[in]value用于决定是否禁用沙盒。
返回
None.

◆ setTo_generate_bookmarks()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_generate_bookmarks ( boolean  value)

Set 用于决定是否生成书签。

参数
[in]value用于决定是否生成书签。
返回
None.

◆ setTo_hide_footer()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_hide_footer ( boolean  value)

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

参数
[in]value用于决定是否隐藏页脚。在Linux x86平台上不支持。
返回
None.

◆ setTo_hide_header()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_hide_header ( boolean  value)

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

参数
[in]value用于决定是否隐藏页眉。在Linux x86平台上不支持。
返回
None.

◆ setTo_load_active_content()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_load_active_content ( boolean  value)

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

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

参数
[in]value用于决定是否加载活动内容。
返回
None.

◆ setTo_optimize_tag_tree()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_optimize_tag_tree ( boolean  value)

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

参数
[in]value用于决定是否优化标签树。
返回
None.

◆ setTo_print_background()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_print_background ( boolean  value)

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

参数
[in]value用于决定是否打印背景。
返回
None.

◆ setTo_remove_underline_for_link()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_remove_underline_for_link ( boolean  value)

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

参数
[in]value用于决定是否为链接移除下划线装饰。
返回
None.

◆ setTo_render_images()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_render_images ( boolean  value)

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

参数
[in]value用于决定是否渲染图像。
返回
None.

◆ setTo_resize_objects()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_resize_objects ( boolean  value)

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

参数
[in]value是否在渲染过程中启用与Javascript相关的对象调整大小功能。
返回
None.

◆ setTo_set_headerfooter()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_set_headerfooter ( boolean  value)

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

参数
[in]value用于决定是否设置页眉页脚。
返回
None.

◆ setTo_use_blacklist()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setTo_use_blacklist ( boolean  value)

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"]}]
         }
         
参数
[in]value用于决定是否使用黑名单。
返回
None.