ExcelWorkbookMergeOptions
OfficeIMO.Excel
Options for importing worksheets from one workbook into another.
Inheritance
- object
- ExcelWorkbookMergeOptions
Usage
Explore 2 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
Accepted by parameters 1
Constructors
public ExcelWorkbookMergeOptions() #Methods
public ExcelWorkbookMergeOptions Clone() #Creates an independent copy of the workbook import settings, selected sheet names and target sheet names.
Returns
ExcelWorkbookMergeOptionsInherited Methods
Properties
public IReadOnlyList<string>? SheetNames { get; set; } #Gets or sets source worksheet names to import. When empty, all source worksheets are imported.
public string? SheetNamePrefix { get; set; } #Gets or sets an optional prefix added to every imported worksheet name.
public IReadOnlyDictionary<string, string>? TargetSheetNames { get; set; } #Gets or sets explicit target worksheet names keyed by source worksheet name. Keys match source worksheet names case-insensitively and must name imported worksheets. A worksheet with an entry takes that name as given, without ExcelWorkbookMergeOptions.SheetNamePrefix; a worksheet without one keeps the prefixed source name. Names are validated with ExcelWorkbookMergeOptions.SheetNameValidationMode. When this map is nonempty and ExcelSheetNameValidationMode.Strict is selected, every requested name is checked before any worksheet is imported. References between imported worksheets map each source name directly to its target name, so a target name may reuse the name of another source worksheet.
public ExcelSheetNameValidationMode SheetNameValidationMode { get; set; } #Gets or sets sheet name validation behavior for imported worksheets.
public ExcelWorksheetCopyMode CopyMode { get; set; } #Gets or sets the worksheet copy strategy used for imported sheets.
public bool CopyExternalWorkbookReferences { get; set; } #Gets or sets whether package-mode imports may preserve external-workbook references. External links are rejected unless callers opt in explicitly.
public int MaxDefinedNames { get; set; } #Gets or sets the maximum number of referenced defined names copied in package mode.
public int MaxDefinedNameCharacters { get; set; } #Gets or sets the maximum aggregate formula characters across copied defined names.
public int MaxInCellImages { get; set; } #Gets or sets the maximum number of in-cell image references copied across package-mode imports.
public long MaxInCellImageBytes { get; set; } #Gets or sets the maximum payload size of one in-cell image copied in package mode.
public long MaxTotalInCellImageBytes { get; set; } #Gets or sets the maximum aggregate resolved in-cell image bytes copied across package-mode imports. Shared image assets are charged once per referencing cell.