API Reference

Class

WordFeatureReport

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Modifiers sealed

Document-level feature and compatibility report.

Inheritance

  • Object
  • WordFeatureReport

Usage

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

Methods

public WordFeatureReport EnsureNoAdvancedFeatures() #
Returns: WordFeatureReport

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

EnsureNoFeatures 3 overloads
public WordFeatureReport EnsureNoFeatures(params WordFeatureSupportLevel[] supportLevels) #
Returns: WordFeatureReport

Throws when the document contains any of the named features.

Parameters

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

Throws when the document contains any of the named features.

Parameters

featureNames System.Collections.Generic.IEnumerable{System.String} required
Feature names to reject, for example VBA macros or Digital signatures.
EnsureNoFeatures(OfficeIMO.Word.WordFeatureSupportLevel[] supportLevels) #

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

Parameters

supportLevels OfficeIMO.Word.WordFeatureSupportLevel[] required
Support levels to reject.
public WordFeatureReport EnsureNoUnsupportedFeatures() #
Returns: WordFeatureReport

Throws when the document contains unsupported features.

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

Returns discovered features matching the provided feature names.

Parameters

featureNames System.String[] requiredposition: 0
Feature names to match, for example VBA macros or Digital signatures.
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 Digital signatures.
FindFeatures(OfficeIMO.Word.WordFeatureSupportLevel[] supportLevels) #

Returns discovered features with one of the provided support levels.

Parameters

supportLevels OfficeIMO.Word.WordFeatureSupportLevel[] required
Support levels to match.
public String ToMarkdown() #
Returns: String

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

Properties

public IReadOnlyList<WordFeatureFinding> Features { get; } #

Features discovered in the document.

public IReadOnlyList<WordFeatureFinding> EditableFeatures { get; } #

Features OfficeIMO can author or edit directly.

public IReadOnlyList<WordFeatureFinding> PartiallyEditableFeatures { get; } #

Features OfficeIMO can partly author or edit.

public IReadOnlyList<WordFeatureFinding> PreservedFeatures { get; } #

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

public IReadOnlyList<WordFeatureFinding> UnsupportedFeatures { get; } #

Features OfficeIMO does not meaningfully support yet.

public Boolean HasAdvancedFeatures { get; } #

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