WarningInfoCollection class

WarningInfoCollection class

Represents a typed collection of WarningInfo objects. To learn more, visit the Programming with Documents documentation article.

Remarks

You can use this collection object as the simplest form of IWarningCallback implementation to gather all warnings that Aspose.Words generates during a load or save operation. Create an instance of this class and assign it to the LoadOptions.warning_callback or DocumentBase.warning_callback property.

Interfaces: IWarningCallback

Constructors

NameDescription
WarningInfoCollection()The default constructor.

Indexers

NameDescription
__getitem__(index)Gets an item at the specified index.

Properties

NameDescription
countGets the number of elements contained in the collection.

Methods

NameDescription
clear()Removes all elements from the collection.
warning(info)Implements the IWarningCallback interface. Adds a warning to this collection.

Examples

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

# Open a document that contains text formatted with a font that does not exist in any of our font sources.
doc = aw.Document(file_name=MY_DIR + 'Missing font.docx')
# Assign a callback for handling font substitution warnings.
warning_collector = aw.WarningInfoCollection()
doc.warning_callback = warning_collector
# Set a default font name and enable font substitution.
font_settings = aw.fonts.FontSettings()
font_settings.substitution_settings.default_font_substitution.default_font_name = 'Arial'
font_settings.substitution_settings.font_info_substitution.enabled = True
# Original font metrics should be used after font substitution.
doc.layout_options.keep_original_font_metrics = True
# We will get a font substitution warning if we save a document with a missing font.
doc.font_settings = font_settings
doc.save(file_name=ARTIFACTS_DIR + 'FontSettings.EnableFontSubstitution.pdf')
for info in warning_collector:
    if info.warning_type == aw.WarningType.FONT_SUBSTITUTION:
        print(info.description)

See Also