 | Control |
Control used to display current events configured in the Events Service.
Inheritance HierarchyNamespace: AxiomCore2.Controls
Assembly: Canary.Axiom.Session (in Canary.Axiom.Session.exe) Version: 25.6.0.25344+3070493948bf7d32a86bd3e9a8bcf4cc9a5b1929
SyntaxC#
public sealed class ControlEventsTable : ControlBase, IControlBase, IDisposable
The ControlEventsTable type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Columns | Order and visibility of columns to display in table. |
| EventInstances | Array of event instances that match search criteria. Number of event instances is limited to prevent UI from becoming slow or unresponsive. It is possible that all events within the specified search criteria may not be returned. |
| EventServer | Server that events will be retrieved from. |
| EventSourceFilter | Filter to return only events with a source that matches the given string. Any spaces are treated as AND operations. Example: "Inverter 1" will match any sources that contain both "Inverter" and "1". So "Plant 1.Inverter 2" would match because the source contains "1" and "Inverter". To match a string that contains spaces, surround the match with a single quote. Example: "'Inverter 1' 'Plant1'" will match any sources that contain both "Inverter 1" and "Plant 1". |
| EventTypes | Filter to return only events that are defined within the array. If null or empty, all event types will be returned. |
| Height | Height of control in pixels. |
| IsVisible | Visibility of control. Default value is true. |
| Kind |
Kind of control.
(Inherited from ControlBase) |
| Name |
Control name that is unique within the owning screen.
Name of control must conform to the regex pattern [a-zA-Z0-9], as only letters and numbers are valid characters.
(Inherited from ControlBase) |
| OnEventClick | Name of a method defined in the screen script that will be invoked when the client clicks on an event. Method must have same signature as EventDelegatesOnEventClick. Default value is null. |
| Parent |
Parent of the control.
(Inherited from ControlBase) |
| RowCount | Maximum number of rows that will be displayed. |
| Screen |
Screen the control resides in.
(Inherited from ControlBase) |
| TemplateId |
Id used to find sibling controls within a template. All siblings will have the same id.
Default value is null.
(Inherited from ControlBase) |
| TimeDuration | Filter to return only events that fall within the range of "Now - TimeDuration". Not all events that fall within the specified time range may be returned. See comments on EventInstances for details. |
| Width | Width of control in pixels. |
| X | X position of a control relative to its parent in pixels. |
| Y | Y position of a control relative to its parent in pixels. |
Methods| Name | Description | |
|---|---|---|
 | AncestorsT |
Get ancestor controls that implement generic control interface defined by T.
(Inherited from ControlBase) |
| Dispose | Releases all resources used by the ControlEventsTable (Overrides ControlBase.Dispose) |
See Also