com.aspose.words

Constructor Detail

• FontSettings

  public FontSettings()

Property Getters/Setters Detail

• getDefaultInstance

  public static FontSettings getDefaultInstance()
  

  Static default font settings.

  This instance is used by default in a document unless Document.FontSettings is specified.

• getFallbackSettings

  public FontFallbackSettings getFallbackSettings()
  

  Settings related to font fallback mechanism.

• getSubstitutionSettings

  public FontSubstitutionSettings getSubstitutionSettings()
  

  Settings related to font substitution mechanism.

Method Detail

• getFontsSources

  public FontSourceBase[] getFontsSources()

  Gets a copy of the array that contains the list of sources where Aspose.Words looks for TrueType fonts.

  The returned value is a copy of the data that Aspose.Words uses. If you change the entries in the returned array, it will have no effect on document rendering. To specify new font sources use the setFontsSources(com.aspose.words.FontSourceBase[]) method.

  Returns:

  A copy of the current font sources.

  Example:

  Demonstrates how to set Aspose.Words to look for TrueType fonts in system folders as well as a custom defined folder when scanning for fonts.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Retrieve the array of environment-dependent font sources that are searched by default
  // For example this will contain a "Windows\Fonts\" source on a Windows machines
  // We add this array to a new ArrayList to make adding or removing font entries much easier
  ArrayList fontSources = new ArrayList(Arrays.asList(FontSettings.getDefaultInstance().getFontsSources()));
  
  // Add a new folder source which will instruct Aspose.Words to search the following folder for fonts
  FolderFontSource folderFontSource = new FolderFontSource("C:\\MyFonts\\", true);
  
  // Add the custom folder which contains our fonts to the list of existing font sources
  fontSources.add(folderFontSource);
  
  // Convert the ArrayList of source back into a primitive array of FontSource objects
  FontSourceBase[] updatedFontSources = (FontSourceBase[]) fontSources.toArray(new FontSourceBase[fontSources.size()]);
  
  // Apply the new set of font sources to use
  FontSettings.getDefaultInstance().setFontsSources(updatedFontSources);
  
  doc.save(getArtifactsDir() + "Rendering.SetFontsFoldersSystemAndCustomFolder.pdf");

• resetFontSources

  public void resetFontSources()

  Resets the fonts sources to the system default.

• setFontsFolder

  public void setFontsFolder(java.lang.String fontFolder, boolean recursive)

  Sets the folder where Aspose.Words looks for TrueType fonts when rendering documents or embedding fonts. This is a shortcut to setFontsFolders(java.lang.String[],boolean) for setting only one font directory.

  Parameters:

  fontFolder - The folder that contains TrueType fonts.

  recursive - True to scan the specified folders for fonts recursively.

  Example:

  Demonstrates how to set the folder Aspose.Words uses to look for TrueType fonts during rendering or embedding of fonts.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Note that this setting will override any default font sources that are being searched by default
  // Now only these folders will be searched for fonts when rendering or embedding fonts
  // To add an extra font source while keeping system font sources then use both FontSettings.GetFontSources and 
  // FontSettings.SetFontSources instead
  FontSettings.getDefaultInstance().setFontsFolder("C:\\MyFonts\\", false);
  
  doc.save(getArtifactsDir() + "Rendering.SetTrueTypeFontsFolder.pdf");

• setFontsFolders

  public void setFontsFolders(java.lang.String[] fontsFolders, boolean recursive)

  Sets the folders where Aspose.Words looks for TrueType fonts when rendering documents or embedding fonts.

  By default, Aspose.Words looks for fonts installed to the system.

  Setting this property resets the cache of all previously loaded fonts.

  Parameters:

  fontsFolders - An array of folders that contain TrueType fonts.

  recursive - True to scan the specified folders for fonts recursively.

  Example:

  Demonstrates how to set Aspose.Words to look in multiple folders for TrueType fonts when rendering or embedding fonts.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Note that this setting will override any default font sources that are being searched by default
  // Now only these folders will be searched for fonts when rendering or embedding fonts
  // To add an extra font source while keeping system font sources then use both FontSettings.GetFontSources and 
  // FontSettings.SetFontSources instead
  FontSettings.getDefaultInstance().setFontsFolders(new String[]{"C:\\MyFonts\\", "D:\\Misc\\Fonts\\"}, true);
  
  doc.save(getArtifactsDir() + "Rendering.SetFontsFoldersMultipleFolders.pdf");

• setFontsSources

  public void setFontsSources(FontSourceBase[] sources)

  Sets the sources where Aspose.Words looks for TrueType fonts when rendering documents or embedding fonts.

  By default, Aspose.Words looks for fonts installed to the system.

  Setting this property resets the cache of all previously loaded fonts.

  Parameters:

  sources - An array of sources that contain TrueType fonts.

  Example:

  Demonstrates how to set Aspose.Words to look for TrueType fonts in system folders as well as a custom defined folder when scanning for fonts.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Retrieve the array of environment-dependent font sources that are searched by default
  // For example this will contain a "Windows\Fonts\" source on a Windows machines
  // We add this array to a new ArrayList to make adding or removing font entries much easier
  ArrayList fontSources = new ArrayList(Arrays.asList(FontSettings.getDefaultInstance().getFontsSources()));
  
  // Add a new folder source which will instruct Aspose.Words to search the following folder for fonts
  FolderFontSource folderFontSource = new FolderFontSource("C:\\MyFonts\\", true);
  
  // Add the custom folder which contains our fonts to the list of existing font sources
  fontSources.add(folderFontSource);
  
  // Convert the ArrayList of source back into a primitive array of FontSource objects
  FontSourceBase[] updatedFontSources = (FontSourceBase[]) fontSources.toArray(new FontSourceBase[fontSources.size()]);
  
  // Apply the new set of font sources to use
  FontSettings.getDefaultInstance().setFontsSources(updatedFontSources);
  
  doc.save(getArtifactsDir() + "Rendering.SetFontsFoldersSystemAndCustomFolder.pdf");