SetCustomProperty(String,String) Method

In This Topic

Syntax
Exceptions
Remarks
Example
Requirements
See Also

Sets a CustomProperty value for the element. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

void SetCustomProperty( 
   string key,
   string value
)

Overloads Sub SetCustomProperty( _
   ByVal key As String, _
   ByVal value As String _
)

Parameters

key: String
value: String

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method must be called within the lambda passed to QueuedTask.Run.

Remarks

This method was created so developers have a way to uniquely assign a value or multiple values to an element that can not be changed in the UI and therefore provides a predictable way to find an element. Each entry has a key/value pair and you find the value using the GetCustomProperty method. You can overwrite values simply be reentering the same key with a different value. There are no methods to remove keys.

Example

Element_SetCustomProperty

//Set a custom property on an element.

//Perform on the worker thread
await QueuedTask.Run(() =>
{
  element.SetCustomProperty("MyKeyString", "MyValueString");
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

IElement Interface
IElement Members
Overload List

Send feedback