API Reference
WordTemplatePreflightReport
Summarizes whether a Word mail-merge template can be safely bound with supplied data.
Inheritance
- Object
- WordTemplatePreflightReport
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(WordTemplatePreflightCapability capability) #BooleanReturns whether the requested template binding capability has no blocking diagnostics.
Parameters
- capability OfficeIMO.Word.WordTemplatePreflightCapability
- Capability to check.
public WordTemplatePreflightReport EnsureCan(WordTemplatePreflightCapability capability) #WordTemplatePreflightReportThrows when the requested capability has blocking diagnostics, otherwise returns this report.
Parameters
- capability OfficeIMO.Word.WordTemplatePreflightCapability
- Capability to enforce.
public static WordTemplatePreflightReport FromInspection(WordMailMergeTemplateInspection inspection) #WordTemplatePreflightReportCreates a preflight report from an existing template inspection.
Parameters
- inspection OfficeIMO.Word.WordMailMergeTemplateInspection
- Template inspection returned by String>).
public IReadOnlyList<WordMailMergeTemplateIssue> GetDiagnostics(WordTemplatePreflightCapability capability) #IReadOnlyList<WordMailMergeTemplateIssue>Returns diagnostics that block the requested template binding capability.
Parameters
- capability OfficeIMO.Word.WordTemplatePreflightCapability
- Capability to inspect.
public String ToJson() #StringSerializes this report to deterministic JSON for CI and service logs.
public String ToMarkdown() #StringRenders this report as Markdown suitable for review notes and automation logs.
Inherited Methods
Properties
public IReadOnlyList<String> MergeFieldNames { get; } #Unique MERGEFIELD names found in the template.
public IReadOnlyList<String> ConditionalBlockNames { get; } #Unique conditional block names found in the template.
public IReadOnlyList<String> RepeatingBlockNames { get; } #Unique repeated block names found in the template.
public IReadOnlyList<WordMailMergeTemplateIssue> Issues { get; } #Validation issues found during template inspection.
public Int32 MergeFieldCount { get; } #Number of unique MERGEFIELD names found in the template.
public Int32 ConditionalBlockCount { get; } #Number of unique conditional block names found in the template.
public Int32 RepeatingBlockCount { get; } #Number of unique repeated block names found in the template.
public Int32 IssueCount { get; } #Number of validation issues found during template inspection.
public Boolean CanBindTemplate { get; } #True when no known issue prevents binding the template with the supplied data.