java.lang.Objectcom.aspose.words.FontSavingArgs
public class FontSavingArgs
When Aspose.Words saves a document to HTML or related formats and To decide whether to save a particular font resource, use the To save fonts into streams instead of files, use the Example:
public void saveHtmlExportFonts() throws Exception
{
Document doc = new Document(getMyDir() + "Document.doc");
// Set the option to export font resources.
HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.MHTML);
options.setExportFontResources(true);
// Create and pass the object which implements the handler methods.
options.setFontSavingCallback(new HandleFontSaving());
doc.save(getMyDir() + "Document.SaveWithFontsExport Out.html", options);
}
public class HandleFontSaving implements IFontSavingCallback
{
public void fontSaving(FontSavingArgs args) throws Exception
{
// You can implement logic here to rename fonts, save to file etc. For this example just print some details about the current font being handled.
System.out.println(MessageFormat.format("Font Name = {0}, Font Filename = {1}", args.getFontFamilyName(), args.getFontFileName()));
}
}
Property Getters/Setters Summary | ||
---|---|---|
boolean | getBold() | |
Indicates whether the current font is bold. | ||
Document | getDocument() | |
Gets the document object that is being saved. | ||
java.lang.String | getFontFamilyName() | |
Indicates the current font family name. | ||
java.lang.String | getFontFileName() | |
void | setFontFileName(java.lang.String value) | |
Gets or sets the file name (without path) where the font will be saved to. | ||
java.io.OutputStream | getFontStream() | |
void | setFontStream(java.io.OutputStream value) | |
Allows to specify the stream where the font will be saved to. | ||
boolean | isExportNeeded() | |
void | isExportNeeded(boolean value) | |
Allows to specify whether the current font will be exported as a font resource. Default is true .
|
||
boolean | isSubsettingNeeded() | |
void | isSubsettingNeeded(boolean value) | |
Allows to specify whether the current font will be subsetted before exporting as a font resource. | ||
boolean | getItalic() | |
Indicates whether the current font is italic. | ||
boolean | getKeepFontStreamOpen() | |
void | setKeepFontStreamOpen(boolean value) | |
Specifies whether Aspose.Words should keep the stream open or close it after saving a font. | ||
java.lang.String | getOriginalFileName() | |
Gets the original font file name with an extension. | ||
int | getOriginalFileSize() | |
Gets the original font file size. |
Property Getters/Setters Detail |
---|
getBold | |
public boolean getBold() |
getDocument | |
public Document getDocument() |
getFontFamilyName | |
public java.lang.String getFontFamilyName() |
Example:
Shows how to define custom logic for handling font exporting when saving to HTML based formats.public void saveHtmlExportFonts() throws Exception { Document doc = new Document(getMyDir() + "Document.doc"); // Set the option to export font resources. HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.MHTML); options.setExportFontResources(true); // Create and pass the object which implements the handler methods. options.setFontSavingCallback(new HandleFontSaving()); doc.save(getMyDir() + "Document.SaveWithFontsExport Out.html", options); } public class HandleFontSaving implements IFontSavingCallback { public void fontSaving(FontSavingArgs args) throws Exception { // You can implement logic here to rename fonts, save to file etc. For this example just print some details about the current font being handled. System.out.println(MessageFormat.format("Font Name = {0}, Font Filename = {1}", args.getFontFamilyName(), args.getFontFileName())); } }
getFontFileName/setFontFileName | |
public java.lang.String getFontFileName() / public void setFontFileName(java.lang.String value) |
This property allows you to redefine how the font file names are generated during export to HTML.
When the event is fired, this property contains the file name that was generated by Aspose.Words. You can change the value of this property to save the font into a different file. Note that file names must be unique.
Aspose.Words automatically generates a unique file name for every embedded font when exporting to HTML format. How the font file name is generated depends on whether you save the document to a file or to a stream.
When saving a document to a file, the generated font file name looks like <document base file name>.<original file name><optional suffix>.<extension>.
When saving a document to a stream, the generated font file name looks like Aspose.Words.<document guid>.<original file name><optional suffix>.<extension>.
Example:
Shows how to define custom logic for handling font exporting when saving to HTML based formats.public void saveHtmlExportFonts() throws Exception { Document doc = new Document(getMyDir() + "Document.doc"); // Set the option to export font resources. HtmlSaveOptions options = new HtmlSaveOptions(SaveFormat.MHTML); options.setExportFontResources(true); // Create and pass the object which implements the handler methods. options.setFontSavingCallback(new HandleFontSaving()); doc.save(getMyDir() + "Document.SaveWithFontsExport Out.html", options); } public class HandleFontSaving implements IFontSavingCallback { public void fontSaving(FontSavingArgs args) throws Exception { // You can implement logic here to rename fonts, save to file etc. For this example just print some details about the current font being handled. System.out.println(MessageFormat.format("Font Name = {0}, Font Filename = {1}", args.getFontFamilyName(), args.getFontFileName())); } }
getFontStream/setFontStream | |
public java.io.OutputStream getFontStream() / public void setFontStream(java.io.OutputStream value) |
This property allows you to save fonts to streams instead of files during HTML export.
The default value is null
. When this property is null
, the font
will be saved to a file specified in the
isExportNeeded/isExportNeeded | |
public boolean isExportNeeded() / public void isExportNeeded(boolean value) |
true
.
isSubsettingNeeded/isSubsettingNeeded | |
public boolean isSubsettingNeeded() / public void isSubsettingNeeded(boolean value) |
Fonts can be exported as complete original font files or subsetted to include only the characters that are used in the document. Subsetting allows to reduce the resulting font resource size.
By default, Aspose.Words decides whether to perform subsetting or not by comparing the original font file size
with the one specified in
getItalic | |
public boolean getItalic() |
getKeepFontStreamOpen/setKeepFontStreamOpen | |
public boolean getKeepFontStreamOpen() / public void setKeepFontStreamOpen(boolean value) |
Default is false
and Aspose.Words will close the stream you provided
in the true
to keep the stream open.
getOriginalFileName | |
public java.lang.String getOriginalFileName() |
This property contains the original file name of the current font if it is known. Otherwise it can be an empty string.
getOriginalFileSize | |
public int getOriginalFileSize() |
This property contains the original file size of the current font if it is known. Otherwise it can be zero.