ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / StyleHelper Class / AddStyle Method
The current ArcGIS Pro project to which the style has to be added.
Name of a core ArcGIS Pro style or the full path to a style file (.stylx) on disk that has to be added to the current project.
Example

In This Topic
    AddStyle Method
    In This Topic
    Adds the specified style to the current project. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    public static void AddStyle( 
       Project project,
       string styleName
    )
    Public Shared Sub AddStyle( _
       ByVal project As Project, _
       ByVal styleName As String _
    ) 

    Parameters

    project
    The current ArcGIS Pro project to which the style has to be added.
    styleName
    Name of a core ArcGIS Pro style or the full path to a style file (.stylx) on disk that has to be added to the current project.
    Exceptions
    ExceptionDescription
    This method must be called within the lambda passed to QueuedTask.Run
    Remarks
    The path of style file to be added is case sensitive.
    Example
    How to add a style to project
    {
      var project = Project.Current;
      await QueuedTask.Run(() =>
      {
        //For ArcGIS Pro system styles, just pass in the name of the style to add to the project
        StyleHelper.AddStyle(project, "3D Vehicles");
    
        //For custom styles, pass in the full path to the style file on disk
        string customStyleToAdd = @"C:\Temp\CustomStyle.stylx";
        StyleHelper.AddStyle(project, customStyleToAdd);
      });
    }
    How to determine if a style can be upgraded
    {
      //Add the style to the current project
      string stylePath = @"C:\MyStyles\OldStyle.stylx";
      var project = Project.Current;
      await QueuedTask.Run(() => StyleHelper.AddStyle(project, stylePath));
      StyleProjectItem styleToUpgrade = Project.Current.GetItems<StyleProjectItem>().First(x => x.Path == stylePath);
    
      //returns true if style can be upgraded
      bool canUpgrade = styleToUpgrade.CanUpgrade;
    }
    How to determine if a style is read-only
    {
      //Add the style to the current project
      string stylePath = @"C:\MyStyles\MyStyle.stylx";
      var project = Project.Current;
      await QueuedTask.Run(() => StyleHelper.AddStyle(project, stylePath));
      StyleProjectItem styleToCheck = Project.Current.GetItems<StyleProjectItem>().First(x => x.Path == stylePath);
      //returns true if style is read-only
      bool isReadOnly = styleToCheck.IsReadOnly;
    }
    How to determine if a style is current
    {
      //Add the style to the current project
      string stylePath = @"C:\MyStyles\MyStyle.stylx";
      var project = Project.Current;
      await QueuedTask.Run(() => StyleHelper.AddStyle(project, stylePath));
      StyleProjectItem styleToCheck = Project.Current.GetItems<StyleProjectItem>().First(x => x.Path == stylePath);
      //returns true if style matches the current Pro version
      bool isCurrent = styleToCheck.IsCurrent;
    }
    How to upgrade a style
    {
      bool success = false;
      //Add the style to the current project
      string stylePath = @"C:\MyStyles\OldStyle.stylx";
      var project = Project.Current;
      await QueuedTask.Run(() => StyleHelper.AddStyle(project, stylePath));
      StyleProjectItem styleToUpgrade = Project.Current.GetItems<StyleProjectItem>().First(x => x.Path == stylePath);
    
      //Verify that style can be upgraded
      if (styleToUpgrade.CanUpgrade)
      {
        success = await QueuedTask.Run(() => StyleHelper.UpgradeStyle(styleToUpgrade));
      }
    }
    Requirements

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

    ArcGIS Pro version: 3.0 or higher.
    See Also