SetDefaultFont(String) Method

In This Topic

Sets the application default font family name and style. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Overloads Sub SetDefaultFont( _
   ByVal familyName As String _
)

public void SetDefaultFont( 
   string familyName
)

Parameters

familyName: The font family to set as the default

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	font not found

Remarks

The default font style for the given font family will be assigned. Use SetDefaultFont(String,String) to set a specific font style.
If the input font family name does not exist an System.ArgumentException will be thrown

Example

Get/Set Default Font

{
    var def_font = SymbolFactory.Instance.DefaultFont;
    System.Diagnostics.Debug.WriteLine($"{def_font.fontName}, styles: {def_font.styleName}");

    //set default font - set through application options
    //Note: Must use QueuedTask
    ApplicationOptions.TextAndGraphicsElementsOptions.SetDefaultFont("tahoma");
    ApplicationOptions.TextAndGraphicsElementsOptions.SetDefaultFont("tahoma", "bold");
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

TextAndGraphicsElementsOptions Class
TextAndGraphicsElementsOptions Members
Overload List

Send feedback