LowCodeSaveOptionsProviderOfPlaceHolders (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.AbstractLowCodeSaveOptionsProvider
- - com.aspose.cells.LowCodeSaveOptionsProviderOfPlaceHolders

```
public class LowCodeSaveOptionsProviderOfPlaceHolders
extends AbstractLowCodeSaveOptionsProvider
```
Implementation to provide save options which save split parts to files and the path of resultant file are defined with placeholders.

Constructor Summary

Constructors
Constructor and Description
`LowCodeSaveOptionsProviderOfPlaceHolders(java.lang.String pathTemplate)` Instantiates an instance to provide save options according to specified templates.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getBuildPathWithSheetAlways()` Whether add sheet index or name to file path always.
`boolean`	`getBuildPathWithSplitPartAlways()` Whether add split part index to file path always.
`LowCodeSaveOptions`	`getSaveOptions(SplitPartInfo part)` Gets the save options from which to get the output settings for currently split part.
`LowCodeSaveOptions`	`getSaveOptionsTemplate()` The template for creating instance of save options in `AbstractLowCodeSaveOptionsProvider.getSaveOptions(SplitPartInfo)`.
`int`	`getSheetIndexOffset()` Offset of sheet's index between what used in file path and its actual value(`SplitPartInfo.getSheetIndex()`).
`java.lang.String`	`getSheetIndexPrefix()` Prefix for the index of worksheet.
`java.lang.String`	`getSheetNamePrefix()` Prefix for the index of worksheet.
`int`	`getSplitPartIndexOffset()` Offset of split part's index between what used in file path and its actual value(`SplitPartInfo.getPartIndex()`).
`java.lang.String`	`getSplitPartPrefix()` Prefix for the index of split part.
`void`	`setBuildPathWithSheetAlways(boolean value)` Whether add sheet index or name to file path always.
`void`	`setBuildPathWithSplitPartAlways(boolean value)` Whether add split part index to file path always.
`void`	`setSaveOptionsTemplate(LowCodeSaveOptions value)` The template for creating instance of save options in `AbstractLowCodeSaveOptionsProvider.getSaveOptions(SplitPartInfo)`.
`void`	`setSheetIndexOffset(int value)` Offset of sheet's index between what used in file path and its actual value(`SplitPartInfo.getSheetIndex()`).
`void`	`setSheetIndexPrefix(java.lang.String value)` Prefix for the index of worksheet.
`void`	`setSheetNamePrefix(java.lang.String value)` Prefix for the index of worksheet.
`void`	`setSplitPartIndexOffset(int value)` Offset of split part's index between what used in file path and its actual value(`SplitPartInfo.getPartIndex()`).
`void`	`setSplitPartPrefix(java.lang.String value)` Prefix for the index of split part.

Methods inherited from class com.aspose.cells.AbstractLowCodeSaveOptionsProvider
finish

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LowCodeSaveOptionsProviderOfPlaceHolders
```
public LowCodeSaveOptionsProviderOfPlaceHolders(java.lang.String pathTemplate)
```
    Instantiates an instance to provide save options according to specified templates.
    Remarks
    The supported placeholders in file path template:
    - ${SheetIndex}: will be replaced by the sheet index of the split part
    - ${SheetName}: will be replaced by the sheet name of the split part
    - ${SplitPartIndex}: will be replaced by the index of the split part
    - ${SheetIndexPrefix}: will be replaced by
    - ${SheetNamePrefix}: will be replaced by
    - ${SplitPartPrefix}: will be replaced by
    Parameters:
    pathTemplate - The template of the resultant file path.
- Method Detail
  - getSheetIndexOffset
```
public int getSheetIndexOffset()
```
    Offset of sheet's index between what used in file path and its actual value(SplitPartInfo.getSheetIndex()).
  - setSheetIndexOffset
```
public void setSheetIndexOffset(int value)
```
    Offset of sheet's index between what used in file path and its actual value(SplitPartInfo.getSheetIndex()).
  - getSplitPartIndexOffset
```
public int getSplitPartIndexOffset()
```
    Offset of split part's index between what used in file path and its actual value(SplitPartInfo.getPartIndex()).
  - setSplitPartIndexOffset
```
public void setSplitPartIndexOffset(int value)
```
    Offset of split part's index between what used in file path and its actual value(SplitPartInfo.getPartIndex()).
  - getBuildPathWithSheetAlways
```
public boolean 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(getSheetNamePrefix()) will not be added to the file path.
  - setBuildPathWithSheetAlways
```
public void setBuildPathWithSheetAlways(boolean 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(getSheetNamePrefix()) will not be added to the file path.
  - getBuildPathWithSplitPartAlways
```
public boolean 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(LowCodeSaveOptionsProviderOfAssembling.getSplitPartPrefix()) will not be added to the file path.
  - setBuildPathWithSplitPartAlways
```
public void setBuildPathWithSplitPartAlways(boolean 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(LowCodeSaveOptionsProviderOfAssembling.getSplitPartPrefix()) will not be added to the file path.
  - getSheetNamePrefix
```
public java.lang.String getSheetNamePrefix()
```
    Prefix for the index of worksheet.
    Remarks
    If there is only one worksheet and LowCodeSaveOptionsProviderOfAssembling.getBuildPathWithSheetAlways() is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.
  - setSheetNamePrefix
```
public void setSheetNamePrefix(java.lang.String value)
```
    Prefix for the index of worksheet.
    Remarks
    If there is only one worksheet and LowCodeSaveOptionsProviderOfAssembling.getBuildPathWithSheetAlways() is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.
  - getSheetIndexPrefix
```
public java.lang.String getSheetIndexPrefix()
```
    Prefix for the index of worksheet.
    Remarks
    If there is only one worksheet and LowCodeSaveOptionsProviderOfAssembling.getBuildPathWithSheetAlways() is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.
  - setSheetIndexPrefix
```
public void setSheetIndexPrefix(java.lang.String value)
```
    Prefix for the index of worksheet.
    Remarks
    If there is only one worksheet and LowCodeSaveOptionsProviderOfAssembling.getBuildPathWithSheetAlways() is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.
  - getSplitPartPrefix
```
public java.lang.String getSplitPartPrefix()
```
    Prefix for the index of split part.
    Remarks
    If there is only one split part and LowCodeSaveOptionsProviderOfAssembling.getBuildPathWithSplitPartAlways() is false, then this prefix and the split part index(0) will not be added to the resultant file path.
  - setSplitPartPrefix
```
public void setSplitPartPrefix(java.lang.String value)
```
    Prefix for the index of split part.
    Remarks
    If there is only one split part and LowCodeSaveOptionsProviderOfAssembling.getBuildPathWithSplitPartAlways() is false, then this prefix and the split part index(0) will not be added to the resultant file path.
  - getSaveOptionsTemplate
```
public LowCodeSaveOptions getSaveOptionsTemplate()
```
    The template for creating instance of save options in AbstractLowCodeSaveOptionsProvider.getSaveOptions(SplitPartInfo).
    Remarks
    If the template has been specified, then the created instance will copy all setting from it and update the output file accordingly.
  - setSaveOptionsTemplate
```
public void setSaveOptionsTemplate(LowCodeSaveOptions value)
```
    The template for creating instance of save options in AbstractLowCodeSaveOptionsProvider.getSaveOptions(SplitPartInfo).
    Remarks
    If the template has been specified, then the created instance will copy all setting from it and update the output file accordingly.
  - getSaveOptions
```
public LowCodeSaveOptions getSaveOptions(SplitPartInfo part)
```
    Gets the save options from which to get the output settings for currently split part.
    
    Specified by:
    
    getSaveOptions in class AbstractLowCodeSaveOptionsProvider

Class LowCodeSaveOptionsProviderOfPlaceHolders

Constructor Summary

Method Summary

Methods inherited from class com.aspose.cells.AbstractLowCodeSaveOptionsProvider

Methods inherited from class java.lang.Object

Constructor Detail

LowCodeSaveOptionsProviderOfPlaceHolders

Method Detail

getSheetIndexOffset

setSheetIndexOffset

getSplitPartIndexOffset

setSplitPartIndexOffset

getBuildPathWithSheetAlways

setBuildPathWithSheetAlways

getBuildPathWithSplitPartAlways

setBuildPathWithSplitPartAlways

getSheetNamePrefix

setSheetNamePrefix

getSheetIndexPrefix

setSheetIndexPrefix

getSplitPartPrefix

setSplitPartPrefix

getSaveOptionsTemplate

setSaveOptionsTemplate

getSaveOptions