Foxit PDF SDK
fsdk.SplitOutputSettingData Class Reference

Public Member Functions

def GetAdd_before_or_after_orginal_name ()
 Get a boolean value is used to determine whether to add the custom name and number before or after the original PDF file name. More...
 
def GetCustom_name ()
 Get a string value used to be added before or after the original PDF file name to generate a new file name. More...
 
def GetIs_overwrite ()
 Get a boolean value used to indicate whether to overwrite the PDF document generated by splitting when the file already exists. More...
 
def GetOutput_folder_path ()
 Get a valid folder path for the PDF documents generated by splitting. More...
 
def GetSeparator ()
 Get a string value used to inserted between the original PDF file name and the custom name to generate a new file name. More...
 
def Set (output_folder_path, add_before_or_after_orginal_name, custom_name, separator, is_overwrite)
 Set value.
More...
 
def SetAdd_before_or_after_orginal_name (value)
 Set a boolean value is used to determine whether to add the custom name and number before or after the original PDF file name. More...
 
def SetCustom_name (value)
 Set a string value used to be added before or after the original PDF file name to generate a new file name. More...
 
def SetIs_overwrite (value)
 Set a boolean value used to indicate whether to overwrite the PDF document generated by splitting when the file already exists. More...
 
def SetOutput_folder_path (value)
 Set a valid folder path for the PDF documents generated by splitting. More...
 
def SetSeparator (value)
 Set a string value used to inserted between the original PDF file name and the custom name to generate a new file name. More...
 

Detailed Description

This class represents setting data used to set the name and directory of the PDF documents generated by splitting.

Member Function Documentation

◆ GetAdd_before_or_after_orginal_name()

fsdk.SplitOutputSettingData.GetAdd_before_or_after_orginal_name ( )

Get a boolean value is used to determine whether to add the custom name and number before or after the original PDF file name.

The file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. true means a custom name and number will be added before the original PDF file name. false means a custom name and number will be added after the original PDF file name.

Returns
A boolean value is used to determine whether to add the custom name and number before or after the original PDF file name. Default value: false.

◆ GetCustom_name()

fsdk.SplitOutputSettingData.GetCustom_name ( )

Get a string value used to be added before or after the original PDF file name to generate a new file name.

The file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. This value represents the custom name. If this value is empty, it means that a custom name is not added to the original PDF file name to generate a new file name. If this value is not empty, it means that a custom name is added to the original PDF file name to generate a new file name.

Returns
A string value used to be added before or after the original PDF file name to generate a new file name. Default value: L"".

◆ GetIs_overwrite()

fsdk.SplitOutputSettingData.GetIs_overwrite ( )

Get a boolean value used to indicate whether to overwrite the PDF document generated by splitting when the file already exists.

true means that when the PDF document generated by splitting exists, it will be overwritten. false means that when the PDF document generated by splitting exists, it will not be overwritten.

Returns
A boolean value used to indicate whether to overwrite the PDF document generated by splitting when the file already exists. Default value: false.

◆ GetOutput_folder_path()

fsdk.SplitOutputSettingData.GetOutput_folder_path ( )

Get a valid folder path for the PDF documents generated by splitting.

If the parameter split_doc_array of the called function fsdk.SplitPDFDocStartSplitByFileSize contains an object constructed using a constructor of SplitDocumentInfo with parameter file_reader or doc, then this value cannot be empty. Otherwise, this value can be empty. If the value is empty, it means using the folder path of the original PDF document as the folder path for the PDF documents generated through splitting. If the value is not empty, it is used as the folder path for the PDF documents generated through splitting.

Returns
A valid folder path for the PDF documents generated by splitting.

◆ GetSeparator()

fsdk.SplitOutputSettingData.GetSeparator ( )

Get a string value used to inserted between the original PDF file name and the custom name to generate a new file name.

The file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. This value represents the separator. If this value is empty, it means that the newly generated file name does not include a separator. If this value is not empty, it means that a separator is inserted between the original PDF file name and the custom name to generate a new file name.

Returns
A string value used to inserted between the original PDF file name and the custom name to generate a new file name. Default value: L"".

◆ Set()

def fsdk.SplitOutputSettingData.Set (   output_folder_path,
  add_before_or_after_orginal_name,
  custom_name,
  separator,
  is_overwrite 
)

Set value.

Parameters
[in]output_folder_pathA valid folder path for the PDF documents generated by splitting. If the value is empty, it means using the folder path of the original PDF document as the folder path for the PDF documents generated through splitting. If the value is not empty, it is used as the folder path for the PDF documents generated through splitting.
[in]add_before_or_after_orginal_nameThe file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. true means a custom name and number will be added before the original PDF file name. false means a custom name and number will be added after the original PDF file name.
[in]custom_nameThe file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. This value represents the custom name. If this value is empty, it means that a custom name is not added to the original PDF file name to generate a new file name. If this value is not empty, it means that a custom name is added to the original PDF file name to generate a new file name.
[in]separatorThe file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. This value represents the separator. If this value is empty, it means that the newly generated file name does not include a separator. If this value is not empty, it means that a separator is inserted between the original PDF file name and the custom name to generate a new file name.
[in]is_overwriteA boolean value used to indicate whether to overwrite the PDF document generated by splitting when the file already exists. true means that when the PDF document generated by splitting exists, it will be overwritten. false means that when the PDF document generated by splitting exists, it will not be overwritten.
Returns
None.

◆ SetAdd_before_or_after_orginal_name()

fsdk.SplitOutputSettingData.SetAdd_before_or_after_orginal_name (   value)

Set a boolean value is used to determine whether to add the custom name and number before or after the original PDF file name.

The file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. true means a custom name and number will be added before the original PDF file name. false means a custom name and number will be added after the original PDF file name.

Parameters
[in]valueA boolean value is used to determine whether to add the custom name and number before or after the original PDF file name. Default value: false.
Returns
None.

◆ SetCustom_name()

fsdk.SplitOutputSettingData.SetCustom_name (   value)

Set a string value used to be added before or after the original PDF file name to generate a new file name.

The file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. This value represents the custom name. If this value is empty, it means that a custom name is not added to the original PDF file name to generate a new file name. If this value is not empty, it means that a custom name is added to the original PDF file name to generate a new file name.

Parameters
[in]valueA string value used to be added before or after the original PDF file name to generate a new file name. Default value: L"".
Returns
None.

◆ SetIs_overwrite()

fsdk.SplitOutputSettingData.SetIs_overwrite (   value)

Set a boolean value used to indicate whether to overwrite the PDF document generated by splitting when the file already exists.

true means that when the PDF document generated by splitting exists, it will be overwritten. false means that when the PDF document generated by splitting exists, it will not be overwritten.

Parameters
[in]valueA boolean value used to indicate whether to overwrite the PDF document generated by splitting when the file already exists. Default value: false.
Returns
None.

◆ SetOutput_folder_path()

fsdk.SplitOutputSettingData.SetOutput_folder_path (   value)

Set a valid folder path for the PDF documents generated by splitting.

If the parameter split_doc_array of the called function fsdk.SplitPDFDocStartSplitByFileSize contains an object constructed using a constructor of SplitDocumentInfo with parameter file_reader or doc, then this value cannot be empty. Otherwise, this value can be empty. If the value is empty, it means using the folder path of the original PDF document as the folder path for the PDF documents generated through splitting. If the value is not empty, it is used as the folder path for the PDF documents generated through splitting.

Parameters
[in]valueA valid folder path for the PDF documents generated by splitting.
Returns
None.

◆ SetSeparator()

fsdk.SplitOutputSettingData.SetSeparator (   value)

Set a string value used to inserted between the original PDF file name and the custom name to generate a new file name.

The file name of the PDF document generated through splitting is created by adding a custom name, automatically generated numbers starting from 1, and separator to the original PDF file name. This value represents the separator. If this value is empty, it means that the newly generated file name does not include a separator. If this value is not empty, it means that a separator is inserted between the original PDF file name and the custom name to generate a new file name.

Parameters
[in]valueA string value used to inserted between the original PDF file name and the custom name to generate a new file name. Default value: L"".
Returns
None.