ConstructProceduralSymbol Method (ISymbolFactory)

In This Topic

Create a symbol reference with a procedural symbol layer for a rule package. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

CIMSymbolReference ConstructProceduralSymbol( 
   string rulePackagePath,
   FeatureLayer featureLayer,
   IEnumerable<CIMPrimitiveOverride> overrides
)

Function ConstructProceduralSymbol( _
   ByVal rulePackagePath As String, _
   ByVal featureLayer As FeatureLayer, _
   Optional ByVal overrides As IEnumerable(Of CIMPrimitiveOverride) _
) As CIMSymbolReference

Parameters

rulePackagePath: full path to a rule package
featureLayer: FeatureLayer
overrides: ArcGIS.Core.CIM.CIMPrimitiveOverride

Return Value

ArcGIS.Core.CIM.CIMSymbolReference

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.IO.FileNotFoundException	{rulePackagePath} not found or is inaccessible
System.ArgumentException	Invalid layer geometry type
System.ArgumentException	Rule package geometry type not compatible with FeatureClass geometry type.
System.ArgumentException	Procedural symbol cannot be applied to rasterized feature layers. Feature layers that are in the 2D Layers group in the Contents pane are rasterized
System.ApplicationException	Call to retrieve rule package attributes failed.
System.NotSupportedException	Cannot use rule packages that create leaf shapes with procedural symbols.

Remarks

Pass in null (default) for the overrides parameter to have default field mappings applied in the renderer

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

ISymbolFactory Interface
ISymbolFactory Members

Send feedback