GetReference Method

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

Visual Basic
C#
C++/CLI

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

'Usage
 
Dim element As UIElement
Dim value As String
 
value = AlarmAdorner.GetReference(element)

[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

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

AlarmAdorner Class
AlarmAdorner Members