ExcelRowMutationPlan
OfficeIMO.Excel
Validated, non-mutating impact plan for inserting or deleting worksheet rows.
Inheritance
- object
- ExcelRowMutationPlan
Remarks
Applying a plan re-runs every safety check against the current workbook state. A plan therefore cannot be used to bypass a new array-formula, PivotTable, control, mapping, or capacity conflict. Planning rejects pending deferred worksheet writes rather than materializing them as a side effect. Each plan permits one application attempt. A failed attempt consumes the plan because mutation may already have started before a later validation, package, or save failure is observed.
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 2
- Method ExcelSheet.PlanDeleteRows
- Method ExcelSheet.PlanInsertRows
Methods
public void Apply() #Revalidates and applies the planned operation exactly once.
public ExcelMutationResult ApplyWithDiagnostics(CancellationToken cancellationToken = default) #Revalidates and transactionally applies the plan, returning package diagnostics.
Parameters
- cancellationToken System.Threading.CancellationToken = default
Returns
ExcelMutationResultInherited Methods
Properties
public int ScannedElements { get; } #Workbook elements inspected while producing the bounded impact summary.
public IReadOnlyList<ExcelMutationImpact> Impacts { get; } #Potentially affected workbook structures grouped by stable category.
public bool RequiresFullRecalculation { get; } #Whether applying the mutation requests a complete workbook recalculation.
public bool IsApplied { get; } #Whether this plan has already been applied successfully.
public bool IsConsumed { get; } #Whether an application attempt has started, succeeded, or failed.
public ExcelMutationResult? Result { get; private set; } #Post-edit result after a successful application.