Aspose::Cells::LowCode::LowCodeSaveOptionsProviderOfPlaceHolders class
Contents
[
Hide
]LowCodeSaveOptionsProviderOfPlaceHolders class
Implementation to provide save options which save split parts to files and the path of resultant file are defined with placeholders.
class LowCodeSaveOptionsProviderOfPlaceHolders : public Aspose::Cells::LowCode::AbstractLowCodeSaveOptionsProvider
Methods
| Method | Description |
|---|---|
| AbstractLowCodeSaveOptionsProvider(AbstractLowCodeSaveOptionsProvider_Impl* impl) | Constructs from an implementation object. |
| AbstractLowCodeSaveOptionsProvider(const AbstractLowCodeSaveOptionsProvider& src) | Copy constructor. |
| Finish(const LowCodeSaveOptions& part) | Releases resources after processing currently split part. |
| GetBuildPathWithSheetAlways() | Whether 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(SheetNamePrefix) will not be added to the file path. |
| GetBuildPathWithSplitPartAlways() | Whether 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(SplitPartPrefix) will not be added to the file path. |
| virtual GetSaveOptions(const SplitPartInfo& part) | Gets the save options from which to get the output settings for currently split part. |
| GetSaveOptionsTemplate() | The template for creating instance of save options in GetSaveOptions(SplitPartInfo). |
| GetSheetIndexOffset() | Offset of sheet’s index between what used in file path and its actual value(SplitPartInfo.SheetIndex). |
| GetSheetIndexPrefix() | Prefix for the index of worksheet. |
| GetSheetNamePrefix() | Prefix for the index of worksheet. |
| GetSplitPartIndexOffset() | Offset of split part’s index between what used in file path and its actual value(SplitPartInfo.PartIndex). |
| GetSplitPartPrefix() | Prefix for the index of split part. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| explicit LowCodeSaveOptionsProviderOfPlaceHolders(const U16String& pathTemplate) | Instantiates an instance to provide save options according to specified templates. |
| explicit LowCodeSaveOptionsProviderOfPlaceHolders(const char16_t* pathTemplate) | Instantiates an instance to provide save options according to specified templates. |
| LowCodeSaveOptionsProviderOfPlaceHolders(LowCodeSaveOptionsProviderOfPlaceHolders_Impl* impl) | Constructs from an implementation object. |
| LowCodeSaveOptionsProviderOfPlaceHolders(const LowCodeSaveOptionsProviderOfPlaceHolders& src) | Copy constructor. |
| LowCodeSaveOptionsProviderOfPlaceHolders(const AbstractLowCodeSaveOptionsProvider& src) | Constructs from a parent object. |
| explicit operator bool() const | operator bool() |
| operator=(const LowCodeSaveOptionsProviderOfPlaceHolders& src) | operator= |
| operator=(const AbstractLowCodeSaveOptionsProvider& src) | operator= |
| SetBuildPathWithSheetAlways(bool value) | Whether 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(SheetNamePrefix) will not be added to the file path. |
| SetBuildPathWithSplitPartAlways(bool value) | Whether 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(SplitPartPrefix) will not be added to the file path. |
| SetSaveOptionsTemplate(const LowCodeSaveOptions& value) | The template for creating instance of save options in GetSaveOptions(SplitPartInfo). |
| SetSheetIndexOffset(int32_t value) | Offset of sheet’s index between what used in file path and its actual value(SplitPartInfo.SheetIndex). |
| SetSheetIndexPrefix(const U16String& value) | Prefix for the index of worksheet. |
| SetSheetIndexPrefix(const char16_t* value) | Prefix for the index of worksheet. |
| SetSheetNamePrefix(const U16String& value) | Prefix for the index of worksheet. |
| SetSheetNamePrefix(const char16_t* value) | Prefix for the index of worksheet. |
| SetSplitPartIndexOffset(int32_t value) | Offset of split part’s index between what used in file path and its actual value(SplitPartInfo.PartIndex). |
| SetSplitPartPrefix(const U16String& value) | Prefix for the index of split part. |
| SetSplitPartPrefix(const char16_t* value) | Prefix for the index of split part. |
| ~AbstractLowCodeSaveOptionsProvider() | Destructor. |
| ~LowCodeSaveOptionsProviderOfPlaceHolders() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Class AbstractLowCodeSaveOptionsProvider
- Namespace Aspose::Cells::LowCode
- Library Aspose.Cells for C++