AddStyle Method—ArcGIS Pro

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

C#
Visual Basic (Declaration)

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

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	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

//For ArcGIS Pro system styles, just pass in the name of the style to add to the project
await QueuedTask.Run(() => StyleHelper.AddStyle(Project.Current, "3D Vehicles"));

//For custom styles, pass in the full path to the style file on disk
string customStyleToAdd = @"C:\Temp\CustomStyle.stylx";
await QueuedTask.Run(() => StyleHelper.AddStyle(Project.Current, customStyleToAdd));

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

StyleHelper Class
StyleHelper Members

Send feedback