OMI SDK 2023

GetReference Method

Save PDF

GetReference Method

Save PDF

Last UpdatedSep 29, 2026
1 minute read

Contains either the fully qualified model hierarchy path for any type of node, or optionally an asset node's associated tagname or hierarchical name.

Setting this property to a non-blank string starts monitoring associated alarms. An adorner appears when required.

Setting this property to a null or empty string stops monitoring associated alarms (if no other adorners are monitoring the same asset), and removes the displayed adorner if it exists.

Syntax

'Declaration
 
<SuppressMessageAttribute("Microsoft.Design", 
   "CA1011:ConsiderPassingBaseTypesAsParameters", 
   Justification="Only UIElement can be adorned.")>
Public Shared Function GetReference( _
   ByVal element As UIElement _
) As String

[SuppressMessage("Microsoft.Design", 
   "CA1011:ConsiderPassingBaseTypesAsParameters", 
   Justification="Only UIElement can be adorned.")]
public static string GetReference( 
   UIElement element
)

[SuppressMessage("Microsoft.Design", 
   "CA1011:ConsiderPassingBaseTypesAsParameters", 
   Justification="Only UIElement can be adorned.")]
public:
static String^ GetReference( 
   UIElement^ element
)

Parameters

element: The UIElement to be adorned with alarm-related information for the given reference.

Return Value

The reference to the alarmed asset or custom hierarchy node

OMI SDK 2023