Foxit PDF SDK

Public 成员函数 | 所有成员列表
com.foxit.sdk.pdf.SplitOutputSettingData类 参考

## Public 成员函数
| SplitOutputSettingData ()
| 构造函数。
| SplitOutputSettingData (String output_folder_path, boolean add_before_or_after_orginal_name, String custom_name, String separator, boolean is_overwrite)
| 带参数的构造函数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
boolean | getAdd_before_or_after_orginal_name ()
| Get 用于确定是否在原始PDF文件名之前或之后添加自定义名称和数字的布尔值。 默认值：false。 更多...
String | getCustom_name ()
| Get 用于在原始PDF文件名之前或之后添加以生成新文件名的字符串值。默认值：L""。 更多...
boolean | getIs_overwrite ()
| Get 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。默认值：false。 更多...
String | getOutput_folder_path ()
| Get 拆分生成的PDF文档的有效文件夹路径。 更多...
String | getSeparator ()
| Get 用于在原始PDF文件名和自定义名称之间插入以生成新文件名的字符串值。默认值：L""。 更多...
void | set (String output_folder_path, boolean add_before_or_after_orginal_name, String custom_name, String separator, boolean is_overwrite)
| 设置值。 更多...
void | setAdd_before_or_after_orginal_name (boolean value)
| Set 用于确定是否在原始PDF文件名之前或之后添加自定义名称和数字的布尔值。 默认值：false。 更多...
void | setCustom_name (String value)
| Set 用于在原始PDF文件名之前或之后添加以生成新文件名的字符串值。默认值：L""。 更多...
void | setIs_overwrite (boolean value)
| Set 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。默认值：false。 更多...
void | setOutput_folder_path (String value)
| Set 拆分生成的PDF文档的有效文件夹路径。 更多...
void | setSeparator (String value)
| Set 用于在原始PDF文件名和自定义名称之间插入以生成新文件名的字符串值。默认值：L""。 更多...

## 详细描述

此类表示用于设置拆分生成的PDF文档的名称和目录的设置数据。

## 构造及析构函数说明

## ◆ SplitOutputSettingData()

com.foxit.sdk.pdf.SplitOutputSettingData.SplitOutputSettingData | ( | String | output_folder_path,
|  | boolean | add_before_or_after_orginal_name,
|  | String | custom_name,
|  | String | separator,
|  | boolean | is_overwrite
| ) |  |

带参数的构造函数。

参数

  [in] | output_folder_path | 拆分生成的PDF文档的有效文件夹路径。 如果此值为空，表示使用原始PDF文档的文件夹路径作为拆分生成的PDF文档的文件夹路径。 如果此值不为空，则用作拆分生成的PDF文档的文件夹路径。
  [in] | add_before_or_after_orginal_name | 拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 true表示自定义名称和数字将添加到原始PDF文件名之前。 false表示自定义名称和数字将添加到原始PDF文件名之后。
  [in] | custom_name | 拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 此值表示自定义名称。 如果此值为空，表示不向原始PDF文件名添加自定义名称来生成新文件名。 如果此值不为空，表示向原始PDF文件名添加自定义名称来生成新文件名。
  [in] | separator | 拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 此值表示分隔符。 如果此值为空，表示新生成的文件名不包含分隔符。 如果此值不为空，表示在原始PDF文件名和自定义名称之间插入分隔符来生成新文件名。
  [in] | is_overwrite | 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。 true表示当拆分生成的PDF文档存在时，将被覆盖。 false表示当拆分生成的PDF文档存在时，不会被覆盖。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.SplitOutputSettingData.delete | ( |  | ) |

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

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ getAdd_before_or_after_orginal_name()

com.foxit.sdk.pdf.SplitOutputSettingData.getAdd_before_or_after_orginal_name | ( |  | ) |

Get 用于确定是否在原始PDF文件名之前或之后添加自定义名称和数字的布尔值。 默认值：false。

拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 true表示自定义名称和数字将添加到原始PDF文件名之前。 false表示自定义名称和数字将添加到原始PDF文件名之后。

返回
  用于确定是否在原始PDF文件名之前或之后添加自定义名称和数字的布尔值。 默认值：false。

## ◆ getCustom_name()

com.foxit.sdk.pdf.SplitOutputSettingData.getCustom_name | ( |  | ) |

Get 用于在原始PDF文件名之前或之后添加以生成新文件名的字符串值。默认值：L""。

拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 此值表示自定义名称。 如果此值为空，表示不向原始PDF文件名添加自定义名称来生成新文件名。 如果此值不为空，表示向原始PDF文件名添加自定义名称来生成新文件名。

返回
  用于在原始PDF文件名之前或之后添加以生成新文件名的字符串值。默认值：L""。

## ◆ getIs_overwrite()

com.foxit.sdk.pdf.SplitOutputSettingData.getIs_overwrite | ( |  | ) |

Get 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。默认值：false。

true表示当拆分生成的PDF文档存在时，将被覆盖。 false表示当拆分生成的PDF文档存在时，不会被覆盖。

返回
  用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。默认值：false。

## ◆ getOutput_folder_path()

com.foxit.sdk.pdf.SplitOutputSettingData.getOutput_folder_path | ( |  | ) |

Get 拆分生成的PDF文档的有效文件夹路径。

如果调用的SplitPDFDoc.startSplitByFileSize 函数的参数split_doc_array包含 一个使用带有参数file_reader或doc的SplitDocumentInfo 构造函数构造的对象， 那么此值不能为空。否则，此值可以为空。 如果此值为空，表示使用原始PDF文档的文件夹路径作为拆分生成的PDF文档的文件夹路径。 如果此值不为空，则用作拆分生成的PDF文档的文件夹路径。

返回
  拆分生成的PDF文档的有效文件夹路径。

## ◆ getSeparator()

com.foxit.sdk.pdf.SplitOutputSettingData.getSeparator | ( |  | ) |

Get 用于在原始PDF文件名和自定义名称之间插入以生成新文件名的字符串值。默认值：L""。

拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 此值表示分隔符。 如果此值为空，表示新生成的文件名不包含分隔符。 如果此值不为空，表示在原始PDF文件名和自定义名称之间插入分隔符来生成新文件名。

返回
  用于在原始PDF文件名和自定义名称之间插入以生成新文件名的字符串值。默认值：L""。

## ◆ set()

void com.foxit.sdk.pdf.SplitOutputSettingData.set | ( | String | output_folder_path,
|  | boolean | add_before_or_after_orginal_name,
|  | String | custom_name,
|  | String | separator,
|  | boolean | is_overwrite
| ) |  |

设置值。

参数

  [in] | output_folder_path | 拆分生成的PDF文档的有效文件夹路径。 如果此值为空，表示使用原始PDF文档的文件夹路径作为拆分生成的PDF文档的文件夹路径。 如果此值不为空，则用作拆分生成的PDF文档的文件夹路径。
  [in] | add_before_or_after_orginal_name | 拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 true表示自定义名称和数字将添加到原始PDF文件名之前。 false表示自定义名称和数字将添加到原始PDF文件名之后。
  [in] | custom_name | 拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 此值表示自定义名称。 如果此值为空，表示不向原始PDF文件名添加自定义名称来生成新文件名。 如果此值不为空，表示向原始PDF文件名添加自定义名称来生成新文件名。
  [in] | separator | 拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 此值表示分隔符。 如果此值为空，表示新生成的文件名不包含分隔符。 如果此值不为空，表示在原始PDF文件名和自定义名称之间插入分隔符来生成新文件名。
  [in] | is_overwrite | 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。 true表示当拆分生成的PDF文档存在时，将被覆盖。 false表示当拆分生成的PDF文档存在时，不会被覆盖。

返回
  无。

## ◆ setAdd_before_or_after_orginal_name()

com.foxit.sdk.pdf.SplitOutputSettingData.setAdd_before_or_after_orginal_name | ( | boolean | value | ) |

Set 用于确定是否在原始PDF文件名之前或之后添加自定义名称和数字的布尔值。 默认值：false。

拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 true表示自定义名称和数字将添加到原始PDF文件名之前。 false表示自定义名称和数字将添加到原始PDF文件名之后。

参数

  [in] | value | 用于确定是否在原始PDF文件名之前或之后添加自定义名称和数字的布尔值。 默认值：false。

返回
  None.

## ◆ setCustom_name()

com.foxit.sdk.pdf.SplitOutputSettingData.setCustom_name | ( | String | value | ) |

Set 用于在原始PDF文件名之前或之后添加以生成新文件名的字符串值。默认值：L""。

拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 此值表示自定义名称。 如果此值为空，表示不向原始PDF文件名添加自定义名称来生成新文件名。 如果此值不为空，表示向原始PDF文件名添加自定义名称来生成新文件名。

参数

  [in] | value | 用于在原始PDF文件名之前或之后添加以生成新文件名的字符串值。默认值：L""。

返回
  None.

## ◆ setIs_overwrite()

com.foxit.sdk.pdf.SplitOutputSettingData.setIs_overwrite | ( | boolean | value | ) |

Set 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。默认值：false。

true表示当拆分生成的PDF文档存在时，将被覆盖。 false表示当拆分生成的PDF文档存在时，不会被覆盖。

参数

  [in] | value | 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。默认值：false。

返回
  None.

## ◆ setOutput_folder_path()

com.foxit.sdk.pdf.SplitOutputSettingData.setOutput_folder_path | ( | String | value | ) |

Set 拆分生成的PDF文档的有效文件夹路径。

如果调用的SplitPDFDoc.startSplitByFileSize 函数的参数split_doc_array包含 一个使用带有参数file_reader或doc的SplitDocumentInfo 构造函数构造的对象， 那么此值不能为空。否则，此值可以为空。 如果此值为空，表示使用原始PDF文档的文件夹路径作为拆分生成的PDF文档的文件夹路径。 如果此值不为空，则用作拆分生成的PDF文档的文件夹路径。

参数

  [in] | value | 拆分生成的PDF文档的有效文件夹路径。

返回
  None.

## ◆ setSeparator()

com.foxit.sdk.pdf.SplitOutputSettingData.setSeparator | ( | String | value | ) |

Set 用于在原始PDF文件名和自定义名称之间插入以生成新文件名的字符串值。默认值：L""。

拆分生成的PDF文档的文件名是通过在原始PDF文件名中添加自定义名称、 从1开始的自动生成数字和分隔符来创建的。 此值表示分隔符。 如果此值为空，表示新生成的文件名不包含分隔符。 如果此值不为空，表示在原始PDF文件名和自定义名称之间插入分隔符来生成新文件名。

参数

  [in] | value | 用于在原始PDF文件名和自定义名称之间插入以生成新文件名的字符串值。默认值：L""。

返回
  None.