Foxit PDF Conversion SDK

静态 Public 成员函数 | 所有成员列表
foxit.conversion.office2pdf.Office2PDF类 参考
类 foxit.conversion.office2pdf.Office2PDF 继承关系图:

## 静态 Public 成员函数
static bool | ConvertFromExcel (string src_excel_file_path, string src_file_password, string saved_pdf_path, Office2PDFSettingData setting_data)
| 将Excel格式文件转换为PDF文件。 更多...
static bool | ConvertFromExcel (FileReaderCallback src_excel_reader, string src_file_password, StreamCallback saved_pdf_file_stream, Office2PDFSettingData setting_data)
| 将Excel格式文件转换为PDF文件。 更多...
static bool | ConvertFromPowerPoint (string src_ppt_file_path, string src_file_password, string saved_pdf_path, Office2PDFSettingData setting_data)
| 将PowerPoint格式文件转换为PDF文件。 更多...
static bool | ConvertFromPowerPoint (FileReaderCallback src_ppt_reader, string src_file_password, StreamCallback saved_pdf_file_stream, Office2PDFSettingData setting_data)
| 将PowerPoint格式文件转换为PDF文件。 更多...
static bool | ConvertFromWord (string src_word_file_path, string src_file_password, string saved_pdf_path, Office2PDFSettingData setting_data)
| 将Word格式文件转换为PDF文件。 更多...
static bool | ConvertFromWord (FileReaderCallback src_word_reader, string src_file_password, StreamCallback saved_pdf_file_stream, Office2PDFSettingData setting_data)
| 将Word格式文件转换为PDF文件。 更多...

## 详细描述

此类可用于将Office(Word、Excel或PowerPoint)格式文件转换为PDF文件。 在使用此模块中的方法之前，请确保Foxit PDF Conversion SDK已通过 函数 common.Library.Initialize 使用包含"Office2PDF"模块的密钥成功初始化。

参见
  foxit.common.Library

## 成员函数说明

## ◆ ConvertFromExcel() [1/2]

static bool foxit.conversion.office2pdf.Office2PDF.ConvertFromExcel | ( | string | src_excel_file_path,
|  | string | src_file_password,
|  | string | saved_pdf_path,
|  | Office2PDFSettingData | setting_data
| ) |  |
| inline static

将Excel格式文件转换为PDF文件。

目前，此函数仅适用于Windows和Linux桌面（32位和64位），仅支持从XLSX格式文件转换。

参数

  [in] | src_excel_file_path | Excel格式文件的路径。此参数不应为空字符串。
  [in] | src_file_password | （保留，尚不支持加密文件）输入Excel格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的PDF文件路径。此参数不应为空字符串。
  [in] | setting_data | 用于转换的 foxit.conversion.office2pdf.Office2PDFSettingData 对象。

返回
  true表示成功，false表示失败。

注解
  如果在函数 common.Library.Initialize 中使用的许可信息中未定义模块"Office2PDF"， 则表示用户无权使用此函数，此函数将抛出异常 foxit.common.ErrorCode.e_ErrNoOffice2PDFModuleRight 。

## ◆ ConvertFromExcel() [2/2]

static bool foxit.conversion.office2pdf.Office2PDF.ConvertFromExcel | ( | FileReaderCallback | src_excel_reader,
|  | string | src_file_password,
|  | StreamCallback | saved_pdf_file_stream,
|  | Office2PDFSettingData | setting_data
| ) |  |
| inline static

将Excel格式文件转换为PDF文件。

目前，此函数仅适用于Windows和Linux桌面（32位和64位），仅支持从XLSX格式文件转换。 文件一次性全部读取，而不是逐步读取。

参数

  [in] | src_excel_reader | 由用户实现的 FileReaderCallback 对象，用于 加载Excel文档。此参数不应为null。
  [in] | src_file_password | （保留，尚不支持加密文件）输入Word格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_file_stream | 由用户实现的 foxit.common.fxcrt.StreamCallback 对象， 用于读取转换后的PDF文件的内容。此参数不应为null。
  [in] | setting_data | 用于转换的 foxit.conversion.office2pdf.Office2PDFSettingData 对象。

返回
  true表示成功，false表示失败。

注解
  如果在函数 common.Library.Initialize 中使用的许可信息中未定义模块"Office2PDF"， 则表示用户无权使用此函数，此函数将抛出异常 foxit.common.ErrorCode.e_ErrNoOffice2PDFModuleRight 。

## ◆ ConvertFromPowerPoint() [1/2]

static bool foxit.conversion.office2pdf.Office2PDF.ConvertFromPowerPoint | ( | string | src_ppt_file_path,
|  | string | src_file_password,
|  | string | saved_pdf_path,
|  | Office2PDFSettingData | setting_data
| ) |  |
| inline static

将PowerPoint格式文件转换为PDF文件。

目前，此函数仅适用于Windows和Linux桌面（32位和64位），仅支持从PPTX格式文件转换。

参数

  [in] | src_ppt_file_path | PowerPoint格式文件的路径。此参数不应为空字符串。
  [in] | src_file_password | （保留，尚不支持加密文件）输入Excel格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的PDF文件路径。此参数不应为空字符串。
  [in] | setting_data | 用于转换的 foxit.conversion.office2pdf.Office2PDFSettingData 对象。

返回
  true表示成功，false表示失败。

注解
  如果在函数 common.Library.Initialize 中使用的许可信息中未定义模块"Office2PDF"， 则表示用户无权使用此函数，此函数将抛出异常 foxit.common.ErrorCode.e_ErrNoOffice2PDFModuleRight 。

## ◆ ConvertFromPowerPoint() [2/2]

static bool foxit.conversion.office2pdf.Office2PDF.ConvertFromPowerPoint | ( | FileReaderCallback | src_ppt_reader,
|  | string | src_file_password,
|  | StreamCallback | saved_pdf_file_stream,
|  | Office2PDFSettingData | setting_data
| ) |  |
| inline static

将PowerPoint格式文件转换为PDF文件。

目前，此函数仅适用于Windows和Linux桌面（32位和64位），仅支持从PPTX格式文件转换。 文件一次性全部读取，而不是逐步读取。

参数

  [in] | src_ppt_reader | 由用户实现的 FileReaderCallback 对象，用于 加载PowerPoint文档。此参数不应为null。
  [in] | src_file_password | （保留，尚不支持加密文件）输入Word格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_file_stream | 由用户实现的 foxit.common.fxcrt.StreamCallback 对象， 用于读取转换后的PDF文件的内容。此参数不应为null。
  [in] | setting_data | 用于转换的 foxit.conversion.office2pdf.Office2PDFSettingData 对象。

返回
  true表示成功，false表示失败。

注解
  如果在函数 common.Library.Initialize 中使用的许可信息中未定义模块"Office2PDF"， 则表示用户无权使用此函数，此函数将抛出异常 foxit.common.ErrorCode.e_ErrNoOffice2PDFModuleRight 。

## ◆ ConvertFromWord() [1/2]

static bool foxit.conversion.office2pdf.Office2PDF.ConvertFromWord | ( | string | src_word_file_path,
|  | string | src_file_password,
|  | string | saved_pdf_path,
|  | Office2PDFSettingData | setting_data
| ) |  |
| inline static

将Word格式文件转换为PDF文件。

目前，此函数仅适用于Windows和Linux桌面（32位和64位），仅支持从DOC和DOCX格式文件转换。

参数

  [in] | src_word_file_path | Word格式文件的路径。此参数不应为空字符串。
  [in] | src_file_password | （保留，尚不支持加密文件）输入Word格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_path | 作为转换结果保存的PDF文件路径。此参数不应为空字符串。
  [in] | setting_data | 用于转换的 foxit.conversion.office2pdf.Office2PDFSettingData 对象。

返回
  true表示成功，false表示失败。

注解
  如果在函数 common.Library.Initialize 中使用的许可信息中未定义模块"Office2PDF"， 则表示用户无权使用此函数，此函数将抛出异常 foxit.common.ErrorCode.e_ErrNoOffice2PDFModuleRight 。

## ◆ ConvertFromWord() [2/2]

static bool foxit.conversion.office2pdf.Office2PDF.ConvertFromWord | ( | FileReaderCallback | src_word_reader,
|  | string | src_file_password,
|  | StreamCallback | saved_pdf_file_stream,
|  | Office2PDFSettingData | setting_data
| ) |  |
| inline static

将Word格式文件转换为PDF文件。

目前，此函数仅适用于Windows和Linux桌面（32位和64位），仅支持从DOC和DOCX格式文件转换。 文件一次性全部读取，而不是逐步读取。

参数

  [in] | src_word_reader | 由用户实现的 FileReaderCallback 对象，用于 加载Word文档。此参数不应为null。
  [in] | src_file_password | （保留，尚不支持加密文件）输入Word格式文件的密码。如果文件不需要密码， 请传递空字符串。
  [in] | saved_pdf_file_stream | 由用户实现的 foxit.common.fxcrt.StreamCallback 对象， 用于读取转换后的PDF文件的内容。此参数不应为null。
  [in] | setting_data | 用于转换的 foxit.conversion.office2pdf.Office2PDFSettingData 对象。

返回
  true表示成功，false表示失败。

注解
  如果在函数 common.Library.Initialize 中使用的许可信息中未定义模块"Office2PDF"， 则表示用户无权使用此函数，此函数将抛出异常 foxit.common.ErrorCode.e_ErrNoOffice2PDFModuleRight 。