Click or drag to resize
OSIsoft, LLC

AFAnalysisExtendedProperties Property

A dictionary of extended properties that can be used to store application specific information.

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version:
public IDictionary<string, Object> ExtendedProperties { get; }

Property Value

Type: IDictionaryString, Object
A dictionary of extended properties which can be used by users of AF SDK to store application specific information. The returned dictionary supports the standard .NET IDictionary, ICollection, and IEnumerable interfaces.

Each item in the dictionary is a key-and-value pair stored in a .NET DictionaryEntry object. When using the foreach statement of the C# language to enumerate this collection, make sure to use the DictionaryEntry object for the item in the enumeration. For example: foreach(DictionaryEntry extendedProp in ExtendedProperties) {...}.

It is important that names of the extended properties (the collection's keys) be unique. Therefore it is suggested that property names include the name of the application that is defining the property, for example "ProcessBook.AFModeler.Graphic".

The FindElementsByExtendedProperty Overload and FindEventFramesByExtendedProperty Overload methods can be used to find elements or event frames by an extended property value. All extended property values of type String and Guid on an AFElement and an AFEventFrame are automatically indexed in the server to speed up the search on these types of property values. These are the only type of property values that can be searched.

Version Information


Supported in: 2.10.5, 2.10, 2.9.5
See Also
Enabling Operational Intelligence