Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FoxitPDFSDKPython3.SplitOutputSettingData类 参考

继承自 FoxitPDFSDKPython3._object .

## Public 成员函数
def | SplitOutputSettingData ()
| 构造函数。 更多...
def | Set (output_folder_path, add_before_or_after_orginal_name, custom_name, separator, is_overwrite)
| 设置值。 更多...

## 静态 Public 属性
| add_before_or_after_orginal_name = _fsdk.SplitOutputSettingData_add_before_or_after_orginal_name
| 用于确定是否在原始PDF文件名之前或之后添加自定义名称和数字的布尔值。 默认值：false。 更多...
| custom_name = _fsdk.SplitOutputSettingData_custom_name
| 用于在原始PDF文件名之前或之后添加以生成新文件名的字符串值。默认值：L""。 更多...
| is_overwrite = _fsdk.SplitOutputSettingData_is_overwrite
| 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。默认值：false。 更多...
| output_folder_path = _fsdk.SplitOutputSettingData_output_folder_path
| 拆分生成的PDF文档的有效文件夹路径。 更多...
| separator = _fsdk.SplitOutputSettingData_separator
| 用于在原始PDF文件名和自定义名称之间插入以生成新文件名的字符串值。默认值：L""。 更多...

## 详细描述

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

## 构造及析构函数说明

## ◆ SplitOutputSettingData()

def FoxitPDFSDKPython3.SplitOutputSettingData.SplitOutputSettingData | ( |  | ) |

构造函数。

带参数的构造函数。

参数

  [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文档存在时，不会被覆盖。

## 成员函数说明

## ◆ Set()

def FoxitPDFSDKPython3.SplitOutputSettingData.Set | ( |  | output_folder_path,
|  |  | add_before_or_after_orginal_name,
|  |  | custom_name,
|  |  | separator,
|  |  | 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文档存在时，不会被覆盖。

返回
  无。

## 类成员变量说明

## ◆ add_before_or_after_orginal_name

FoxitPDFSDKPython3.SplitOutputSettingData.add_before_or_after_orginal_name = _fsdk.SplitOutputSettingData_add_before_or_after_orginal_name
| static

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

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

## ◆ custom_name

FoxitPDFSDKPython3.SplitOutputSettingData.custom_name = _fsdk.SplitOutputSettingData_custom_name
| static

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

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

## ◆ is_overwrite

FoxitPDFSDKPython3.SplitOutputSettingData.is_overwrite = _fsdk.SplitOutputSettingData_is_overwrite
| static

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

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

## ◆ output_folder_path

FoxitPDFSDKPython3.SplitOutputSettingData.output_folder_path = _fsdk.SplitOutputSettingData_output_folder_path
| static

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

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

## ◆ separator

FoxitPDFSDKPython3.SplitOutputSettingData.separator = _fsdk.SplitOutputSettingData_separator
| static

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

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