API Reference
WordFeatureReport
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.
Returned or exposed by
Methods
public Boolean Can(WordPreflightCapability capability) #BooleanReturns whether the requested workflow capability can be attempted.
Parameters
- capability OfficeIMO.Word.WordPreflightCapability
public WordFeatureReport EnsureCan(WordPreflightCapability capability) #WordFeatureReportThrows with operation-specific diagnostics when a capability is unavailable.
Parameters
- capability OfficeIMO.Word.WordPreflightCapability
public WordFeatureReport EnsureNoAdvancedFeatures() #WordFeatureReportThrows when the document contains preserve-only or unsupported advanced features.
public WordFeatureReport EnsureNoFeatures(params String[] featureNames) #WordFeatureReportThrows when the document contains any of the named features.
Parameters
- featureNames System.String[]
- Feature names to reject, for example VBA macros or Digital signatures.
public WordFeatureReport EnsureNoFeatures(IEnumerable<String> featureNames) #WordFeatureReportThrows when the document contains any of the named features.
Parameters
- featureNames System.Collections.Generic.IEnumerable{System.String}
- Feature names to reject, for example VBA macros or Digital signatures.
public WordFeatureReport EnsureNoFeatures(params OfficeFeatureSupportLevel[] supportLevels) #WordFeatureReportThrows when the document contains any features with the provided support levels.
Parameters
- supportLevels OfficeIMO.OfficeFeatureSupportLevel[]
- Support levels to reject.
public WordFeatureReport EnsureNoUnsupportedFeatures() #WordFeatureReportThrows when the document contains unsupported features.
public IReadOnlyList<WordFeatureFinding> FindFeatures(params String[] featureNames) #IReadOnlyList<WordFeatureFinding>Returns discovered features matching the provided feature names.
Parameters
- featureNames System.String[]
- Feature names to match, for example VBA macros or Digital signatures.
public IReadOnlyList<WordFeatureFinding> FindFeatures(IEnumerable<String> featureNames) #IReadOnlyList<WordFeatureFinding>Returns discovered features matching the provided feature names.
Parameters
- featureNames System.Collections.Generic.IEnumerable{System.String}
- Feature names to match, for example VBA macros or Digital signatures.
public IReadOnlyList<WordFeatureFinding> FindFeatures(params OfficeFeatureSupportLevel[] supportLevels) #IReadOnlyList<WordFeatureFinding>Returns discovered features with one of the provided support levels.
Parameters
- supportLevels OfficeIMO.OfficeFeatureSupportLevel[]
- Support levels to match.
public IReadOnlyList<String> GetCapabilityDiagnostics(WordPreflightCapability capability) #IReadOnlyList<String>Explains why a workflow capability is unavailable.
Parameters
- capability OfficeIMO.Word.WordPreflightCapability
public IReadOnlyList<WordPreflightRepairHint> GetRepairHints(WordPreflightCapability capability) #IReadOnlyList<WordPreflightRepairHint>Returns actionable repair or routing hints for an unavailable capability.
Parameters
- capability OfficeIMO.Word.WordPreflightCapability
public String ToMarkdown() #StringReturns a compact Markdown report of discovered document features and support status.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
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.
public Boolean CanReadDocumentContent { get; } #True when core document content can be read despite non-content package metadata.
public Boolean CanEditDocumentContent { get; } #True when ordinary content edits have no known unsupported package blocker.
public Boolean CanEditDocumentStructure { get; } #True when structure-changing edits have no preserve-only or unsupported blocker.
public Boolean CanBindTemplate { get; } #True when template binding has no preserve-only or unsupported blocker.
public Boolean CanRenderFixedLayout { get; } #True when no discovered feature is known to require external materialization or exact unsupported layout.
public Boolean CanSavePackageRoundTrip { get; } #True when saving is not known to invalidate an unsupported package contract.