API Reference
ExcelRowMutationPlan
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
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.PlanDeleteRows
- Method ExcelSheet.PlanInsertRows
Methods
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public ExcelRowMutationKind Kind { get; } #Planned operation.
public String SheetName { get; } #Worksheet name captured by the plan.
public Int32 FirstRow { get; } #First affected 1-based worksheet row.
public Int32 Count { get; } #Number of rows inserted or deleted.
public Int32 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 Boolean RequiresFullRecalculation { get; } #Whether applying the mutation requests a complete workbook recalculation.
public Boolean IsApplied { get; } #Whether this plan has already been applied successfully.
public Boolean IsConsumed { get; } #Whether an application attempt has started, succeeded, or failed.