Foxit PDF Conversion SDK
com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData类 参考

Public 成员函数

 Md2PDFSettingData ()
 构造函数。
 
 Md2PDFSettingData (float page_width, float page_height, float margin_top, float margin_bottom, float margin_left, float margin_right, float base_font_size, String custom_font_path, String style_config_path, boolean is_embed_font)
 带参数的构造函数。 更多...
 
synchronized void delete ()
 直接清除C++相关资源。 更多...
 
float getBase_font_size ()
 Get 正文基础字号,单位:点。默认值:10。 更多...
 
String getCustom_font_path ()
 Get trueType 字体文件路径,用于 CJK 或自定义字体支持。 更多...
 
boolean getIs_embed_font ()
 Get 是否将字体数据嵌入输出 PDF。默认值:false。 更多...
 
float getMargin_bottom ()
 Get 下边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。 更多...
 
float getMargin_left ()
 Get 左边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。 更多...
 
float getMargin_right ()
 Get 右边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。 更多...
 
float getMargin_top ()
 Get 上边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。 更多...
 
float getPage_height ()
 Get 页面高度,单位:点。默认值:792。必须大于 0。 更多...
 
float getPage_width ()
 Get 页面宽度,单位:点。默认值:612。必须大于 0。 更多...
 
String getStyle_config_path ()
 Get jSON 样式配置文件路径。 更多...
 
void set (float page_width, float page_height, float margin_top, float margin_bottom, float margin_left, float margin_right, float base_font_size, String custom_font_path, String style_config_path, boolean is_embed_font)
 设置值。 更多...
 
void setBase_font_size (float value)
 Set 正文基础字号,单位:点。默认值:10。 更多...
 
void setCustom_font_path (String value)
 Set trueType 字体文件路径,用于 CJK 或自定义字体支持。 更多...
 
void setIs_embed_font (boolean value)
 Set 是否将字体数据嵌入输出 PDF。默认值:false。 更多...
 
void setMargin_bottom (float value)
 Set 下边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。 更多...
 
void setMargin_left (float value)
 Set 左边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。 更多...
 
void setMargin_right (float value)
 Set 右边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。 更多...
 
void setMargin_top (float value)
 Set 上边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。 更多...
 
void setPage_height (float value)
 Set 页面高度,单位:点。默认值:792。必须大于 0。 更多...
 
void setPage_width (float value)
 Set 页面宽度,单位:点。默认值:612。必须大于 0。 更多...
 
void setStyle_config_path (String value)
 Set jSON 样式配置文件路径。 更多...
 

详细描述

此类表示将 Markdown 格式文件转换为 PDF 格式文件时使用的设置数据。

构造及析构函数说明

◆ Md2PDFSettingData()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.Md2PDFSettingData ( float  page_width,
float  page_height,
float  margin_top,
float  margin_bottom,
float  margin_left,
float  margin_right,
float  base_font_size,
String  custom_font_path,
String  style_config_path,
boolean  is_embed_font 
)

带参数的构造函数。

参数
[in]page_width页面宽度,单位:点。默认值:612。必须大于 0。
[in]page_height页面高度,单位:点。默认值:792。必须大于 0。
[in]margin_top上边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。
[in]margin_bottom下边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。
[in]margin_left左边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。
[in]margin_right右边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。
[in]base_font_size正文基础字号,单位:点。默认值:10。
[in]custom_font_pathTrueType 字体文件路径,用于 CJK 或自定义字体支持。空字符串表示使用标准 PDF 字体。
[in]style_config_pathJSON 样式配置文件路径。
[in]is_embed_font是否将字体数据嵌入输出 PDF。默认值:false。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.delete ( )

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

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

◆ getBase_font_size()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getBase_font_size ( )

Get 正文基础字号,单位:点。默认值:10。

各级标题的字号以此值为基准倍数计算。

返回
正文基础字号,单位:点。默认值:10。

◆ getCustom_font_path()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getCustom_font_path ( )

Get trueType 字体文件路径,用于 CJK 或自定义字体支持。

非空时,将使用指定字体进行文本渲染。 默认值:空字符串。

返回
TrueType 字体文件路径,用于 CJK 或自定义字体支持。

◆ getIs_embed_font()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getIs_embed_font ( )

Get 是否将字体数据嵌入输出 PDF。默认值:false。

返回
是否将字体数据嵌入输出 PDF。默认值:false。

◆ getMargin_bottom()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getMargin_bottom ( )

Get 下边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。

返回
下边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。

◆ getMargin_left()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getMargin_left ( )

Get 左边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。

返回
左边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。

◆ getMargin_right()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getMargin_right ( )

Get 右边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。

返回
右边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。

◆ getMargin_top()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getMargin_top ( )

Get 上边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。

返回
上边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。

◆ getPage_height()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getPage_height ( )

Get 页面高度,单位:点。默认值:792。必须大于 0。

返回
页面高度,单位:点。默认值:792。必须大于 0。

◆ getPage_width()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getPage_width ( )

Get 页面宽度,单位:点。默认值:612。必须大于 0。

返回
页面宽度,单位:点。默认值:612。必须大于 0。

◆ getStyle_config_path()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.getStyle_config_path ( )

Get jSON 样式配置文件路径。

非空时,将从指定 JSON 文件中加载各元素类型的字体、字号、颜色、粗体、斜体、 行间距等样式设置。 默认值:空字符串(使用内置默认样式)。

每个元素对象支持的 JSON 键 (适用元素:h1-h6、paragraph、code_block、block_quote、list_item、table_cell):

  • "font_size" : 浮点数,字号(单位:点),例如 14.0

  • "bold" : 布尔值,是否粗体

  • "italic" : 布尔值,是否斜体

  • "color_r/g/b" : 浮点数 0.0-1.0,RGB 颜色分量

  • "line_spacing" : 浮点数 0.5-5.0,行高倍数

  • "space_before" : 浮点数 0.0-10.0,块前间距,以 font_size 为单位的倍数。 仅对标题元素(h1-h6)生效,其他元素类型忽略此字段。

  • "space_after" : 浮点数 0.0-10.0,块后间距,以 font_size 为单位的倍数。

超出有效范围的值将被静默忽略,回退到内置默认间距。

JSON 文件示例:

返回
JSON 样式配置文件路径。

◆ set()

void com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.set ( float  page_width,
float  page_height,
float  margin_top,
float  margin_bottom,
float  margin_left,
float  margin_right,
float  base_font_size,
String  custom_font_path,
String  style_config_path,
boolean  is_embed_font 
)

设置值。

参数
[in]page_width页面宽度,单位:点。默认值:612。必须大于 0。
[in]page_height页面高度,单位:点。默认值:792。必须大于 0。
[in]margin_top上边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。
[in]margin_bottom下边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。
[in]margin_left左边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。
[in]margin_right右边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。
[in]base_font_size正文基础字号,单位:点。
[in]custom_font_pathTrueType 字体文件路径,用于 CJK 或自定义字体支持。
[in]style_config_pathJSON 样式配置文件路径。
[in]is_embed_font是否将字体数据嵌入输出 PDF。
返回
无。

◆ setBase_font_size()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setBase_font_size ( float  value)

Set 正文基础字号,单位:点。默认值:10。

各级标题的字号以此值为基准倍数计算。

参数
[in]value正文基础字号,单位:点。默认值:10。
返回
None.

◆ setCustom_font_path()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setCustom_font_path ( String  value)

Set trueType 字体文件路径,用于 CJK 或自定义字体支持。

非空时,将使用指定字体进行文本渲染。 默认值:空字符串。

参数
[in]valueTrueType 字体文件路径,用于 CJK 或自定义字体支持。
返回
None.

◆ setIs_embed_font()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setIs_embed_font ( boolean  value)

Set 是否将字体数据嵌入输出 PDF。默认值:false。

参数
[in]value是否将字体数据嵌入输出 PDF。默认值:false。
返回
None.

◆ setMargin_bottom()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setMargin_bottom ( float  value)

Set 下边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。

参数
[in]value下边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。
返回
None.

◆ setMargin_left()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setMargin_left ( float  value)

Set 左边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。

参数
[in]value左边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。
返回
None.

◆ setMargin_right()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setMargin_right ( float  value)

Set 右边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。

参数
[in]value右边距,单位:点。默认值:72。必须大于或等于 0,且左、右边距之和必须小于页面宽度。
返回
None.

◆ setMargin_top()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setMargin_top ( float  value)

Set 上边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。

参数
[in]value上边距,单位:点。默认值:72。必须大于或等于 0,且上、下边距之和必须小于页面高度。
返回
None.

◆ setPage_height()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setPage_height ( float  value)

Set 页面高度,单位:点。默认值:792。必须大于 0。

参数
[in]value页面高度,单位:点。默认值:792。必须大于 0。
返回
None.

◆ setPage_width()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setPage_width ( float  value)

Set 页面宽度,单位:点。默认值:612。必须大于 0。

参数
[in]value页面宽度,单位:点。默认值:612。必须大于 0。
返回
None.

◆ setStyle_config_path()

com.foxit.sdk.conversion.md2pdf.Md2PDFSettingData.setStyle_config_path ( String  value)

Set jSON 样式配置文件路径。

非空时,将从指定 JSON 文件中加载各元素类型的字体、字号、颜色、粗体、斜体、 行间距等样式设置。 默认值:空字符串(使用内置默认样式)。

每个元素对象支持的 JSON 键 (适用元素:h1-h6、paragraph、code_block、block_quote、list_item、table_cell):

  • "font_size" : 浮点数,字号(单位:点),例如 14.0

  • "bold" : 布尔值,是否粗体

  • "italic" : 布尔值,是否斜体

  • "color_r/g/b" : 浮点数 0.0-1.0,RGB 颜色分量

  • "line_spacing" : 浮点数 0.5-5.0,行高倍数

  • "space_before" : 浮点数 0.0-10.0,块前间距,以 font_size 为单位的倍数。 仅对标题元素(h1-h6)生效,其他元素类型忽略此字段。

  • "space_after" : 浮点数 0.0-10.0,块后间距,以 font_size 为单位的倍数。

超出有效范围的值将被静默忽略,回退到内置默认间距。

JSON 文件示例:

参数
[in]valueJSON 样式配置文件路径。
返回
None.