Foxit PDF SDK
Public 成员函数 | 属性 | 所有成员列表
foxit.pdf.SplitOutputSettingData类 参考

继承自 SystemIDisposable .

Public 成员函数

 SplitOutputSettingData ()
 构造函数。
 
 SplitOutputSettingData (string output_folder_path, bool add_before_or_after_orginal_name, string custom_name, string separator, bool is_overwrite)
 带参数的构造函数。 更多...
 
void Set (string output_folder_path, bool add_before_or_after_orginal_name, string custom_name, string separator, bool is_overwrite)
 设置值。 更多...
 

属性

bool add_before_or_after_orginal_name [get, set]
 用于确定是否在原始PDF文件名之前或之后添加自定义名称和数字的布尔值。 默认值：false。 更多...
 
string custom_name [get, set]
 用于在原始PDF文件名之前或之后添加以生成新文件名的字符串值。默认值：L""。 更多...
 
bool is_overwrite [get, set]
 用于指示当文件已存在时是否覆盖拆分生成的PDF文档的布尔值。默认值：false。 更多...
 
string output_folder_path [get, set]
 拆分生成的PDF文档的有效文件夹路径。 更多...
 
string separator [get, set]
 用于在原始PDF文件名和自定义名称之间插入以生成新文件名的字符串值。默认值：L""。 更多...
 

详细描述

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

构造及析构函数说明

◆ SplitOutputSettingData()

foxit.pdf.SplitOutputSettingData.SplitOutputSettingData ( string  output_folder_path,
bool  add_before_or_after_orginal_name,
string  custom_name,
string  separator,
bool  is_overwrite 
)
inline

带参数的构造函数。

参数
[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()

void foxit.pdf.SplitOutputSettingData.Set ( string  output_folder_path,
bool  add_before_or_after_orginal_name,
string  custom_name,
string  separator,
bool  is_overwrite 
)
inline

设置值。

参数
[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

bool foxit.pdf.SplitOutputSettingData.add_before_or_after_orginal_name
getset

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

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

◆ custom_name

string foxit.pdf.SplitOutputSettingData.custom_name
getset

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

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

◆ is_overwrite

bool foxit.pdf.SplitOutputSettingData.is_overwrite
getset

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

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

◆ output_folder_path

string foxit.pdf.SplitOutputSettingData.output_folder_path
getset

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

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

◆ separator

string foxit.pdf.SplitOutputSettingData.separator
getset

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

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