Class SaveOptionsProviderAssembling

Implementation to provide save options which save split parts to files and the path of resultant file are named as(it may contains directories): Sheetize.SaveOptionsProviderAssembling.PathHeader+Sheetize.SaveOptionsProviderAssembling.SheetPrefix+SheetIndex(or SheetName) +Sheetize.SaveOptionsProviderAssembling.SplitPartPrefix+SplitPartIndex+Sheetize.SaveOptionsProviderAssembling.PathTail.

public class SaveOptionsProviderAssembling : AbstractSaveOptionsProvider

Inheritance

object ← AbstractSaveOptionsProvider ← SaveOptionsProviderAssembling

Inherited Members

• AbstractSaveOptionsProvider.GetSaveOptions(SplitPartInfo),
• AbstractSaveOptionsProvider.Finish(SaveOptions),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

SaveOptionsProviderAssembling()

public SaveOptionsProviderAssembling()

Properties

BuildPathWithSheetAlways

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.

public bool BuildPathWithSheetAlways { get; set; }

Property Value

bool

BuildPathWithSplitPartAlways

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.

public bool BuildPathWithSplitPartAlways { get; set; }

Property Value

bool

PathHeader

Header part(before added content of sheet and split part) of file path.

public string PathHeader { get; set; }

Property Value

string

PathTail

Tailing part(after sequence numbers) of file path. It should include extension of file name.

public string PathTail { get; set; }

Property Value

string

SaveOptionsTemplate

The template for creating instance of save options in Sheetize.SaveOptionsProviderAssembling.GetSaveOptions(Sheetize.SplitPartInfo).

public SaveOptions SaveOptionsTemplate { get; set; }

Property Value

SaveOptions

Remarks

If the template has been specified, then the created instance will copy all setting from it and update the output file accordingly.

SheetIndexOffset

Offset of sheet’s index between what used in file path and its actual value(Sheetize.SplitPartInfo.SheetIndex).

public int SheetIndexOffset { get; set; }

Property Value

int

Remarks

Only takes effect when Sheetize.SaveOptionsProviderAssembling.UseSheetName is false.

SheetPrefix

Prefix for the index of worksheet.

public string SheetPrefix { get; set; }

Property Value

string

Remarks

If there is only one worksheet and Sheetize.SaveOptionsProviderAssembling.BuildPathWithSheetAlways is false, then this prefix and the sheet index(or name) will not be added to the resultant file path.

SplitPartIndexOffset

Offset of split part’s index between what used in file path and its actual value(Sheetize.SplitPartInfo.PartIndex).

public int SplitPartIndexOffset { get; set; }

Property Value

int

SplitPartPrefix

Prefix for the index of split part.

public string SplitPartPrefix { get; set; }

Property Value

string

Remarks

If there is only one split part and Sheetize.SaveOptionsProviderAssembling.BuildPathWithSplitPartAlways is false, then this prefix and the split part index(0) will not be added to the resultant file path.

UseSheetName

Whether builds the file path with sheet name instead of sheet index. Default value is false.

public bool UseSheetName { get; set; }

Property Value

bool

Remarks

The sheet name will never be rebuilt automatically. So when set it to true, please make sure there is no special sheet name that can cause invalid file path or name.

Methods

GetSaveOptions(SplitPartInfo)

Gets the save options from which to get the output settings for currently split part.

public override SaveOptions GetSaveOptions(SplitPartInfo part)

Parameters

• part SplitPartInfo

Returns

SaveOptions :