API Reference

Class

ExcelFeatureReport

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Workbook-level feature and compatibility report.

Inheritance

  • Object
  • ExcelFeatureReport

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Methods

public Boolean Can(ExcelPreflightCapability capability) #
Returns: Boolean

Returns true when the requested workflow-level capability can be attempted for this workbook.

Parameters

capability OfficeIMO.Excel.ExcelPreflightCapability requiredposition: 0
The OfficeIMO.Excel workflow capability to check.
public ExcelFeatureReport EnsureCan(ExcelPreflightCapability capability) #
Returns: ExcelFeatureReport

Throws with workflow-specific diagnostics when the requested capability cannot be attempted for this workbook.

Parameters

capability OfficeIMO.Excel.ExcelPreflightCapability requiredposition: 0
The OfficeIMO.Excel workflow capability that must be available.

Returns

The current feature report for fluent guard usage.

public ExcelFeatureReport EnsureNoAdvancedFeatures() #
Returns: ExcelFeatureReport

Throws when the workbook contains preserve-only or unsupported advanced features.

EnsureNoFeatures 3 overloads
public ExcelFeatureReport EnsureNoFeatures(params ExcelFeatureSupportLevel[] supportLevels) #
Returns: ExcelFeatureReport

Throws when the workbook contains any of the named features.

Parameters

featureNames System.String[] requiredposition: 0
Feature names to reject, for example VBA macros or External workbook links.
EnsureNoFeatures(System.Collections.Generic.IEnumerable{System.String} featureNames) #

Throws when the workbook contains any of the named features.

Parameters

featureNames System.Collections.Generic.IEnumerable{System.String} required
Feature names to reject, for example VBA macros or External workbook links.
EnsureNoFeatures(OfficeIMO.Excel.ExcelFeatureSupportLevel[] supportLevels) #

Throws when the workbook contains any features with the provided support levels.

Parameters

supportLevels OfficeIMO.Excel.ExcelFeatureSupportLevel[] required
Support levels to reject.
public ExcelFeatureReport EnsureNoUnsupportedFeatures() #
Returns: ExcelFeatureReport

Throws when the workbook contains unsupported features.

FindFeatures 3 overloads
public IReadOnlyList<ExcelFeatureFinding> FindFeatures(params ExcelFeatureSupportLevel[] supportLevels) #
Returns: IReadOnlyList<ExcelFeatureFinding>

Returns discovered features matching the provided feature names.

Parameters

featureNames System.String[] requiredposition: 0
Feature names to match, for example VBA macros or External workbook links.
FindFeatures(System.Collections.Generic.IEnumerable{System.String} featureNames) #

Returns discovered features matching the provided feature names.

Parameters

featureNames System.Collections.Generic.IEnumerable{System.String} required
Feature names to match, for example VBA macros or External workbook links.
FindFeatures(OfficeIMO.Excel.ExcelFeatureSupportLevel[] supportLevels) #

Returns discovered features with one of the provided support levels.

Parameters

supportLevels OfficeIMO.Excel.ExcelFeatureSupportLevel[] required
Support levels to match.
public IReadOnlyList<String> GetCapabilityDiagnostics(ExcelPreflightCapability capability) #
Returns: IReadOnlyList<String>

Returns operation-specific diagnostics explaining why a workflow-level capability is blocked, or an empty list when it can be attempted.

Parameters

capability OfficeIMO.Excel.ExcelPreflightCapability requiredposition: 0
The OfficeIMO.Excel workflow capability to explain.
public IReadOnlyList<ExcelPreflightRepairHint> GetRepairHints(ExcelPreflightCapability capability) #
Returns: IReadOnlyList<ExcelPreflightRepairHint>

Returns actionable repair or routing hints for a blocked preflight capability.

Parameters

capability OfficeIMO.Excel.ExcelPreflightCapability requiredposition: 0
Capability to explain.
public String ToMarkdown() #
Returns: String

Returns a compact Markdown report of discovered workbook features and support status.

Properties

public IReadOnlyList<ExcelFeatureFinding> Features { get; } #

Features discovered in the workbook.

public IReadOnlyList<ExcelFeatureFinding> EditableFeatures { get; } #

Features OfficeIMO can author or edit directly.

public IReadOnlyList<ExcelFeatureFinding> PartiallyEditableFeatures { get; } #

Features OfficeIMO can partly author or edit.

public IReadOnlyList<ExcelFeatureFinding> PreservedFeatures { get; } #

Advanced features OfficeIMO should preserve but cannot fully author or edit yet.

public IReadOnlyList<ExcelFeatureFinding> UnsupportedFeatures { get; } #

Features OfficeIMO does not meaningfully support yet.

public Boolean HasAdvancedFeatures { get; } #

Whether the workbook contains advanced features that should be checked before edit-heavy round trips.

public Boolean CanReadWorkbookData { get; } #

True when OfficeIMO can attempt read-oriented workbook data operations.

public Boolean CanEditCellValues { get; } #

True when OfficeIMO can attempt cell-value edits without known unsupported package features.

public Boolean CanEditWorkbookStructure { get; } #

True when OfficeIMO can attempt structure-changing workbook edits without preserve-only or unsupported feature blockers.

public Boolean CanUseCachedFormulaValues { get; } #

True when cached formula values can be trusted for read/export workflows.

public Boolean CanCalculateFormulas { get; } #

True when OfficeIMO's lightweight evaluator can calculate all discovered formulas without known dependency issues.

public Boolean CanBindTemplate { get; } #

True when template binding can be attempted without preserve-only or unsupported advanced package features.

public Boolean CanExportPdfReport { get; } #

True when the workbook is suitable for the first-party report-grade Excel-to-PDF export path.