WarningType

WarningType enumeration

Specifies the type of a warning that is issued by Aspose.Words during document loading or saving.

[Flags]
public enum WarningType

Values

NameValueDescription
DataLossCategoryFFSome text/char/image or other data will be missing from either the document tree following load, or from the created document following save.
DataLoss1Generic data loss, no specific code.
MajorFormattingLossCategoryFF00The resulting document or a particular location in it might look substantially different compared to the original document.
MajorFormattingLoss100Generic major formatting loss, no specific code.
MinorFormattingLossCategoryFF0000The resulting document or a particular location in it might look somewhat different compared to the original document.
MinorFormattingLoss10000Generic minor formatting loss, no specific code.
FontSubstitution20000Font has been substituted.
FontEmbedding40000Loss of embedded font information during document saving.
UnexpectedContentCategoryF000000Some content in the source document could not be recognized (i.e. is unsupported), this may or may not cause issues or result in data/formatting loss.
UnexpectedContent1000000Generic unexpected content, no specific code.
Hint10000000Advises of a potential problem or suggests an improvement.

Examples

Shows how to set the property for finding the closest match for a missing font from the available font sources.

public void EnableFontSubstitution()
{
    // Open a document that contains text formatted with a font that does not exist in any of our font sources.
    Document doc = new Document(MyDir + "Missing font.docx");

    // Assign a callback for handling font substitution warnings.
    HandleDocumentSubstitutionWarnings substitutionWarningHandler = new HandleDocumentSubstitutionWarnings();
    doc.WarningCallback = substitutionWarningHandler;

    // Set a default font name and enable font substitution.
    FontSettings fontSettings = new FontSettings();
    fontSettings.SubstitutionSettings.DefaultFontSubstitution.DefaultFontName = "Arial";
    ;
    fontSettings.SubstitutionSettings.FontInfoSubstitution.Enabled = true;

    // Original font metrics should be used after font substitution.
    doc.LayoutOptions.KeepOriginalFontMetrics = true;

    // We will get a font substitution warning if we save a document with a missing font.
    doc.FontSettings = fontSettings;
    doc.Save(ArtifactsDir + "FontSettings.EnableFontSubstitution.pdf");

    using (IEnumerator<WarningInfo> warnings = substitutionWarningHandler.FontWarnings.GetEnumerator())
        while (warnings.MoveNext())
            Console.WriteLine(warnings.Current.Description);

    // We can also verify warnings in the collection and clear them.
    Assert.AreEqual(WarningSource.Layout, substitutionWarningHandler.FontWarnings[0].Source);
    Assert.AreEqual(
        "Font '28 Days Later' has not been found. Using 'Calibri' font instead. Reason: alternative name from document.",
        substitutionWarningHandler.FontWarnings[0].Description);

    substitutionWarningHandler.FontWarnings.Clear();

    Assert.AreEqual(0, substitutionWarningHandler.FontWarnings.Count);
}

public class HandleDocumentSubstitutionWarnings : IWarningCallback
{
    /// <summary>
    /// Called every time a warning occurs during loading/saving.
    /// </summary>
    public void Warning(WarningInfo info)
    {
        if (info.WarningType == WarningType.FontSubstitution)
            FontWarnings.Warning(info);
    }

    public WarningInfoCollection FontWarnings = new WarningInfoCollection();
}

See Also

WarningSource Enum Watermark Class