com.aspose.words

Class FolderFontSource

  • All Implemented Interfaces:
    com.aspose.words.internal.zzO2
    public class FolderFontSource 
    extends FontSourceBase

Represents the folder that contains TrueType font files.

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);

Constructor Summary
FolderFontSource(java.lang.StringfolderPath, booleanscanSubfolders)
Ctor.
FolderFontSource(java.lang.StringfolderPath, booleanscanSubfolders, intpriority)
Ctor.
 
Property Getters/Setters Summary
java.lang.StringgetFolderPath()
Path to the folder.
intgetPriority()
Returns the font source priority.
booleangetScanSubfolders()
Determines whether or not to scan the subfolders.
intgetType()
Returns the type of the font source. The value of the property is FontSourceType integer constant.
 
Method Summary
java.util.ArrayList<PhysicalFontInfo>getAvailableFonts()
Returns list of fonts available via this source.
 

    • Constructor Detail

      • FolderFontSource

        public FolderFontSource(java.lang.String folderPath, boolean scanSubfolders)
        Ctor.
        Parameters:
        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);
      • FolderFontSource

        public FolderFontSource(java.lang.String folderPath, boolean scanSubfolders, int priority)
        Ctor.
        Parameters:
        folderPath - Path to folder.
        scanSubfolders - Determines whether or not to scan subfolders.
        priority - Font source priority. See the Priority property description for more information.

        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()
        
        Path to the folder.

        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

        public int getPriority()
        
        Returns the font source priority.

        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()
        
        Determines whether or not to scan the 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);
      • getType

        public int getType()
        
        Returns the type of the font source. The value of the property is FontSourceType integer constant.

        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

        public java.util.ArrayList<PhysicalFontInfo> getAvailableFonts()
        Returns list of fonts available via this source.

        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()));
        }