WarningInfoCollection

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.words.IWarningCallback, java.lang.Iterable

public class WarningInfoCollection implements IWarningCallback, Iterable

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.getWarningCallback() / LoadOptions.setWarningCallback(com.aspose.words.IWarningCallback) or DocumentBase.getWarningCallback() / DocumentBase.setWarningCallback(com.aspose.words.IWarningCallback) property.

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.
 Document doc = new Document(getMyDir() + "Missing font.docx");

 // Assign a callback for handling font substitution warnings.
 WarningInfoCollection warningCollector = new WarningInfoCollection();
 doc.setWarningCallback(warningCollector);

 // Set a default font name and enable font substitution.
 FontSettings fontSettings = new FontSettings();
 fontSettings.getSubstitutionSettings().getDefaultFontSubstitution().setDefaultFontName("Arial");
 fontSettings.getSubstitutionSettings().getFontInfoSubstitution().setEnabled(true);

 // Original font metrics should be used after font substitution.
 doc.getLayoutOptions().setKeepOriginalFontMetrics(true);

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

 for (WarningInfo info : warningCollector)
 {
     if (info.getWarningType() == WarningType.FONT_SUBSTITUTION)
         System.out.println(info.getDescription());
 }
 

Methods

Method	Description
clear()	Removes all elements from the collection.
get(int index)	Gets an item at the specified index.
getCount()	Gets the number of elements contained in the collection.
iterator()	Returns an iterator object that can be used to iterate over all items in the collection.
warning(WarningInfo info)	Implements the IWarningCallback interface.

clear()

public void clear()

Removes all elements from the 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.
 Document doc = new Document(getMyDir() + "Missing font.docx");

 // Assign a callback for handling font substitution warnings.
 WarningInfoCollection warningCollector = new WarningInfoCollection();
 doc.setWarningCallback(warningCollector);

 // Set a default font name and enable font substitution.
 FontSettings fontSettings = new FontSettings();
 fontSettings.getSubstitutionSettings().getDefaultFontSubstitution().setDefaultFontName("Arial");
 fontSettings.getSubstitutionSettings().getFontInfoSubstitution().setEnabled(true);

 // Original font metrics should be used after font substitution.
 doc.getLayoutOptions().setKeepOriginalFontMetrics(true);

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

 for (WarningInfo info : warningCollector)
 {
     if (info.getWarningType() == WarningType.FONT_SUBSTITUTION)
         System.out.println(info.getDescription());
 }
 

get(int index)

public WarningInfo get(int index)

Gets an item at the specified index.

Examples:

Shows how to get warnings about unsupported formats.

 WarningInfoCollection warings = new WarningInfoCollection();
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setWarningCallback(warings);
 Document doc = new Document(getMyDir() + "FB2 document.fb2", loadOptions);

 Assert.assertEquals("The original file load format is FB2, which is not supported by Aspose.Words. The file is loaded as an XML document.", warings.get(0).getDescription());
 

Parameters:

Parameter	Type	Description
index	int	Zero-based index of the item.

Returns: WarningInfo - An item at the specified index.

getCount()

public int getCount()

Gets the number of elements contained in the collection.

Examples:

Shows how to get warnings about unsupported formats.

 WarningInfoCollection warings = new WarningInfoCollection();
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setWarningCallback(warings);
 Document doc = new Document(getMyDir() + "FB2 document.fb2", loadOptions);

 Assert.assertEquals("The original file load format is FB2, which is not supported by Aspose.Words. The file is loaded as an XML document.", warings.get(0).getDescription());
 

Returns: int - The number of elements contained in the collection.

iterator()

public Iterator iterator()

Returns an iterator object that can be used to iterate over all items in the collection.

Returns: java.util.Iterator

warning(WarningInfo info)

public void warning(WarningInfo 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.
 Document doc = new Document(getMyDir() + "Missing font.docx");

 // Assign a callback for handling font substitution warnings.
 WarningInfoCollection warningCollector = new WarningInfoCollection();
 doc.setWarningCallback(warningCollector);

 // Set a default font name and enable font substitution.
 FontSettings fontSettings = new FontSettings();
 fontSettings.getSubstitutionSettings().getDefaultFontSubstitution().setDefaultFontName("Arial");
 fontSettings.getSubstitutionSettings().getFontInfoSubstitution().setEnabled(true);

 // Original font metrics should be used after font substitution.
 doc.getLayoutOptions().setKeepOriginalFontMetrics(true);

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

 for (WarningInfo info : warningCollector)
 {
     if (info.getWarningType() == WarningType.FONT_SUBSTITUTION)
         System.out.println(info.getDescription());
 }
 

Parameters:

Parameter	Type	Description
info	WarningInfo