Aspose::Cells::LowCode::LowCodeSaveOptionsProviderOfAssembling class
Contents
[
Hide
]LowCodeSaveOptionsProviderOfAssembling class
Implementation to provide save options which save split parts to files and the path of resultant file are named as(it may contains directories): PathHeader+SheetPrefix+SheetIndex(or SheetName) +SplitPartPrefix+SplitPartIndex+PathTail.
class LowCodeSaveOptionsProviderOfAssembling : 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(or name) and corresponding prefix 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 will not be added to the file path. |
| GetPathHeader() | Header part(before added content of sheet and split part) of file path. |
| GetPathTail() | Tailing part(after sequence numbers) of file path. It should include extension of file name. |
| 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). |
| GetSheetPrefix() | 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. |
| GetUseSheetName() | Whether builds the file path with sheet name instead of sheet index. Default value is false. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| LowCodeSaveOptionsProviderOfAssembling() | Default constructor. |
| LowCodeSaveOptionsProviderOfAssembling(LowCodeSaveOptionsProviderOfAssembling_Impl* impl) | Constructs from an implementation object. |
| LowCodeSaveOptionsProviderOfAssembling(const LowCodeSaveOptionsProviderOfAssembling& src) | Copy constructor. |
| LowCodeSaveOptionsProviderOfAssembling(const AbstractLowCodeSaveOptionsProvider& src) | Constructs from a parent object. |
| explicit operator bool() const | operator bool() |
| operator=(const LowCodeSaveOptionsProviderOfAssembling& 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(or name) and corresponding prefix 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 will not be added to the file path. |
| SetPathHeader(const U16String& value) | Header part(before added content of sheet and split part) of file path. |
| SetPathHeader(const char16_t* value) | Header part(before added content of sheet and split part) of file path. |
| SetPathTail(const U16String& value) | Tailing part(after sequence numbers) of file path. It should include extension of file name. |
| SetPathTail(const char16_t* value) | Tailing part(after sequence numbers) of file path. It should include extension of file name. |
| 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). |
| SetSheetPrefix(const U16String& value) | Prefix for the index of worksheet. |
| SetSheetPrefix(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. |
| SetUseSheetName(bool value) | Whether builds the file path with sheet name instead of sheet index. Default value is false. |
| ~AbstractLowCodeSaveOptionsProvider() | Destructor. |
| ~LowCodeSaveOptionsProviderOfAssembling() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Class AbstractLowCodeSaveOptionsProvider
- Namespace Aspose::Cells::LowCode
- Library Aspose.Cells for C++