Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 609 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

TranslationReport

Edit on GitHub
Namespace OfficeIMO.GoogleWorkspace
Assembly OfficeIMO.GoogleWorkspace
Source revision c8404474f9f2 with working tree changes
Source TranslationReport.cs:31
Implements
IOfficeConversionReport
Modifiers sealed

Standard fidelity report shared across exporter packages.

Inheritance

  • Object
  • TranslationReport

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Google Workspace Guide

    Choose and configure the OfficeIMO libraries for Google Docs, Sheets, Slides, Drive, and synchronization. Includes examples and package links.

Usage

Explore 24 API references to this type

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

Returned or exposed by 5

Accepted by parameters 19

Constructors

public TranslationReport() #
TranslationReport.cs:31

Creates an empty, mutable translation report.

Methods

public Void Add(TranslationSeverity severity, String feature, String message, String path = "", String? code = null, TranslationAction action = None, Int32 count = 1, String? targetId = null) #
TranslationReport.cs:88
Returns: Void

Adds a structured translation notice.

Parameters

severity OfficeIMO.GoogleWorkspace.TranslationSeverity requiredposition: 0
Impact of the notice.
feature System.String requiredposition: 1
Source feature to which the notice applies.
message System.String requiredposition: 2
Human-readable explanation.
path System.String = "" optionalposition: 3
Optional source-object path.
code System.String? = null optionalposition: 4
Stable diagnostic code, or null to derive one from feature.
action OfficeIMO.GoogleWorkspace.TranslationAction = None optionalposition: 5
Action selected for the feature.
count System.Int32 = 1 optionalposition: 6
Number of equivalent occurrences represented by the notice; values below one become one.
targetId System.String? = null optionalposition: 7
Optional remote target identifier.
public Void AddUnique(TranslationSeverity severity, String feature, String message, String path = "", String? code = null, TranslationAction action = None, Int32 count = 1, String? targetId = null) #
TranslationReport.cs:118
Returns: Void

Adds a notice unless the report already contains the same severity, code, feature, message, and path.

Parameters

severity OfficeIMO.GoogleWorkspace.TranslationSeverity requiredposition: 0
Impact of the notice.
feature System.String requiredposition: 1
Source feature to which the notice applies.
message System.String requiredposition: 2
Human-readable explanation.
path System.String = "" optionalposition: 3
Optional source-object path.
code System.String? = null optionalposition: 4
Stable diagnostic code, or null to derive one from feature.
action OfficeIMO.GoogleWorkspace.TranslationAction = None optionalposition: 5
Action selected for the feature.
count System.Int32 = 1 optionalposition: 6
Number of equivalent occurrences represented by the notice.
targetId System.String? = null optionalposition: 7
Optional remote target identifier.
public TranslationReport CreateReadOnlySnapshot() #
TranslationReport.cs:133
Returns: TranslationReport

Creates an independent read-only snapshot of the current notices.

public Void RequireNoLoss() #
TranslationReport.cs:61
Returns: Void

Throws when the translation omitted, approximated, or failed to preserve content.

Properties

public IReadOnlyList<TranslationNotice> Notices { get; } #
TranslationReport.cs:40

Gets the notices in the order in which translators recorded them.

public Boolean HasWarnings { get; } #
TranslationReport.cs:42

Gets whether the report contains at least one warning or error.

public Boolean HasErrors { get; } #
TranslationReport.cs:44

Gets whether the report contains at least one error.

public IReadOnlyList<OfficeConversionFidelityDiagnostic> FidelityDiagnostics { get; } #
TranslationReport.cs:48

Gets immutable, category-preserving diagnostics for this translation stage.

public Boolean HasLoss { get; } #
TranslationReport.cs:56

Gets whether the translation omitted, approximated, or failed to preserve content.

Extension Methods

public static IReadOnlyList<GoogleWorkspaceDiagnosticEntry> ToDiagnosticEntries(TranslationReport report) #
GoogleWorkspaceDiagnostics.cs:65
Returns: IReadOnlyList<GoogleWorkspaceDiagnosticEntry>

Converts every notice in a translation report to a structured diagnostic entry.

Parameters

report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 0
Report to convert.

Returns

A snapshot preserving notice order and metadata.