API Reference
Class
ExcelStructuralMutationPlan
Validated dry-run plan for a single transactional worksheet mutation.
Inheritance
- Object
- ExcelStructuralMutationPlan
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method ExcelSheet.PlanCopyRange
- Method ExcelSheet.PlanDeleteCells
- Method ExcelSheet.PlanDeleteColumns
- Method ExcelSheet.PlanInsertCells
- Method ExcelSheet.PlanInsertColumns
- Method ExcelSheet.PlanMoveRange
- Method ExcelSheet.PlanTransposeRange
Methods
public ExcelMutationResult Apply(CancellationToken cancellationToken = null) #Returns:
ExcelMutationResultCommits the plan once, rolling package roots back if the operation throws.
Parameters
- cancellationToken System.Threading.CancellationToken = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public ExcelStructuralMutationKind Kind { get; } #Planned operation.
public String SourceRange { get; } #Source or affected A1 range.
public String Destination { get; } #Destination top-left cell, when applicable.
public Int32 AffectedCells { get; } #Bounded estimate of cells affected by the operation.
public IReadOnlyList<ExcelMutationImpact> Impacts { get; } #Dry-run impact categories.
public Boolean IsApplied { get; } #Whether the plan has committed successfully.
public ExcelMutationResult Result { get; set; } #Result after a successful commit.