LowCodeSaveOptionsProviderOfPlaceHolders class

LowCodeSaveOptionsProviderOfPlaceHolders class

Implementation to provide save options which save split parts to files and the path of resultant file are defined with placeholders.

Inheritance: LowCodeSaveOptionsProviderOfPlaceHolders

The LowCodeSaveOptionsProviderOfPlaceHolders type exposes the following members:

Constructors

ConstructorDescription
__init__(self, path_template)Instantiates an instance to provide save options according to specified templates.

Properties

PropertyDescription
sheet_index_offsetOffset of sheet’s index between what used in file path
and its actual value(SplitPartInfo.sheet_index).
split_part_index_offsetOffset of split part’s index between what used in file path
and its actual value(SplitPartInfo.part_index).
build_path_with_sheet_alwaysWhether add sheet index or name to file path always.
Default value is false, that is, when there is only one sheet,
the sheet index and name and corresponding prefix(LowCodeSaveOptionsProviderOfPlaceHolders.sheet_name_prefix)
will not be added to the file path.
build_path_with_split_part_alwaysWhether add split part index to file path always.
Default value is false, that is, when there is only one split part,
the split part index and corresponding prefix(LowCodeSaveOptionsProviderOfPlaceHolders.split_part_prefix)
will not be added to the file path.
sheet_name_prefixPrefix for the index of worksheet.
sheet_index_prefixPrefix for the index of worksheet.
split_part_prefixPrefix for the index of split part.
save_options_templateThe template for creating instance of save options in LowCodeSaveOptionsProviderOfPlaceHolders.get_save_options.

Methods

MethodDescription
get_save_options(self, part)Gets the save options from which to get the output settings for currently split part.
finish(self, part)

See Also