java.lang.ObjectFontSourceBase
com.aspose.words.FolderFontSource
public class FolderFontSource
Example:
Document doc = new Document();
// Create a font settings object for our document
doc.setFontSettings(new FontSettings());
// Create a font source from a folder that contains font files
FolderFontSource folderFontSource = new FolderFontSource(getMyDir() + "MyFonts", false, 1);
// Add that source to our document
doc.getFontSettings().setFontsSources(new FontSourceBase[]{folderFontSource});
Assert.assertEquals(folderFontSource.getFolderPath(), getMyDir() + "MyFonts");
Assert.assertEquals(folderFontSource.getScanSubfolders(), false);
Assert.assertEquals(folderFontSource.getType(), FontSourceType.FONTS_FOLDER);
Assert.assertEquals(folderFontSource.getPriority(), 1);
Constructor Summary |
---|
FolderFontSource(java.lang.String folderPath, boolean scanSubfolders)
Ctor. |
FolderFontSource(java.lang.String folderPath, boolean scanSubfolders, int priority)
Ctor. |
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getFolderPath() | |
Path to the folder. | ||
int | getPriority() | → inherited from FontSourceBase |
Returns the font source priority. | ||
boolean | getScanSubfolders() | |
Determines whether or not to scan the subfolders. | ||
int | getType() | |
Returns the type of the font source. The value of the property is FontSourceType integer constant. |
Method Summary | ||
---|---|---|
java.util.ArrayList<PhysicalFontInfo> | getAvailableFonts() | → inherited from FontSourceBase |
Returns list of fonts available via this source. |
Constructor Detail |
---|
public FolderFontSource(java.lang.String folderPath, boolean scanSubfolders)
folderPath
- Path to folder.scanSubfolders
- Determines whether or not to scan subfolders.Example:
Shows how to create a folder font source.Document doc = new Document(); // Create a font settings object for our document doc.setFontSettings(new FontSettings()); // Create a font source from a folder that contains font files FolderFontSource folderFontSource = new FolderFontSource(getMyDir() + "MyFonts", false, 1); // Add that source to our document doc.getFontSettings().setFontsSources(new FontSourceBase[]{folderFontSource}); Assert.assertEquals(folderFontSource.getFolderPath(), getMyDir() + "MyFonts"); Assert.assertEquals(folderFontSource.getScanSubfolders(), false); Assert.assertEquals(folderFontSource.getType(), FontSourceType.FONTS_FOLDER); Assert.assertEquals(folderFontSource.getPriority(), 1);
public FolderFontSource(java.lang.String folderPath, boolean scanSubfolders, int priority)
folderPath
- Path to folder.scanSubfolders
- Determines whether or not to scan subfolders.priority
- Font source priority. See the Example:
Shows how to create a folder font source.Document doc = new Document(); // Create a font settings object for our document doc.setFontSettings(new FontSettings()); // Create a font source from a folder that contains font files FolderFontSource folderFontSource = new FolderFontSource(getMyDir() + "MyFonts", false, 1); // Add that source to our document doc.getFontSettings().setFontsSources(new FontSourceBase[]{folderFontSource}); Assert.assertEquals(folderFontSource.getFolderPath(), getMyDir() + "MyFonts"); Assert.assertEquals(folderFontSource.getScanSubfolders(), false); Assert.assertEquals(folderFontSource.getType(), FontSourceType.FONTS_FOLDER); Assert.assertEquals(folderFontSource.getPriority(), 1);
Property Getters/Setters Detail |
---|
getFolderPath | |
public java.lang.String getFolderPath() |
Example:
Shows how to create a folder font source.Document doc = new Document(); // Create a font settings object for our document doc.setFontSettings(new FontSettings()); // Create a font source from a folder that contains font files FolderFontSource folderFontSource = new FolderFontSource(getMyDir() + "MyFonts", false, 1); // Add that source to our document doc.getFontSettings().setFontsSources(new FontSourceBase[]{folderFontSource}); Assert.assertEquals(folderFontSource.getFolderPath(), getMyDir() + "MyFonts"); Assert.assertEquals(folderFontSource.getScanSubfolders(), false); Assert.assertEquals(folderFontSource.getType(), FontSourceType.FONTS_FOLDER); Assert.assertEquals(folderFontSource.getPriority(), 1);
getPriority | → inherited from FontSourceBase |
public int getPriority() |
This value is used when there are fonts with the same family name and style in different font sources. In this case Aspose.Words selects the font from the source with the higher priority value.
The default value is 0.
Example:
Shows how to create a file font source.Document doc = new Document(); // Create a font settings object for our document doc.setFontSettings(new FontSettings()); // Create a font source from a file in our system FileFontSource fileFontSource = new FileFontSource(getMyDir() + "Alte DIN 1451 Mittelschrift.ttf", 0); // Import the font source into our document doc.getFontSettings().setFontsSources(new FontSourceBase[]{fileFontSource}); Assert.assertEquals(fileFontSource.getFilePath(), getMyDir() + "Alte DIN 1451 Mittelschrift.ttf"); Assert.assertEquals(fileFontSource.getType(), FontSourceType.FONT_FILE); Assert.assertEquals(fileFontSource.getPriority(), 0);
getScanSubfolders | |
public boolean getScanSubfolders() |
Example:
Shows how to create a folder font source.Document doc = new Document(); // Create a font settings object for our document doc.setFontSettings(new FontSettings()); // Create a font source from a folder that contains font files FolderFontSource folderFontSource = new FolderFontSource(getMyDir() + "MyFonts", false, 1); // Add that source to our document doc.getFontSettings().setFontsSources(new FontSourceBase[]{folderFontSource}); Assert.assertEquals(folderFontSource.getFolderPath(), getMyDir() + "MyFonts"); Assert.assertEquals(folderFontSource.getScanSubfolders(), false); Assert.assertEquals(folderFontSource.getType(), FontSourceType.FONTS_FOLDER); Assert.assertEquals(folderFontSource.getPriority(), 1);
getType | |
public int getType() |
Example:
Shows how to create a folder font source.Document doc = new Document(); // Create a font settings object for our document doc.setFontSettings(new FontSettings()); // Create a font source from a folder that contains font files FolderFontSource folderFontSource = new FolderFontSource(getMyDir() + "MyFonts", false, 1); // Add that source to our document doc.getFontSettings().setFontsSources(new FontSourceBase[]{folderFontSource}); Assert.assertEquals(folderFontSource.getFolderPath(), getMyDir() + "MyFonts"); Assert.assertEquals(folderFontSource.getScanSubfolders(), false); Assert.assertEquals(folderFontSource.getType(), FontSourceType.FONTS_FOLDER); Assert.assertEquals(folderFontSource.getPriority(), 1);
Method Detail |
---|
getAvailableFonts | → inherited from FontSourceBase |
public java.util.ArrayList<PhysicalFontInfo> getAvailableFonts() |
Example:
Shows how to get available fonts and information about them.// Add a new folder source which will instruct Aspose.Words to search the following folder for fonts. FontSourceBase[] folderFontSource = {new FolderFontSource(getMyDir() + "MyFonts\\", true)}; for (PhysicalFontInfo fontInfo : folderFontSource[0].getAvailableFonts()) { System.out.println(MessageFormat.format("FontFamilyName : {0}", fontInfo.getFontFamilyName())); System.out.println(MessageFormat.format("FullFontName : {0}", fontInfo.getFullFontName())); System.out.println(MessageFormat.format("Version : {0}", fontInfo.getVersion())); System.out.println(MessageFormat.format("FilePath : {0}\n", fontInfo.getFilePath())); }