SystemMonitor object
This class contains the methods and properties used to configure the System Monitor control.
Members
The SystemMonitor object has these types of members:
Events
The SystemMonitor object has these events.
| Event | Description |
|---|---|
| OnCounterAdded | Notifies you when a counter is added to the Counters collection. |
| OnCounterDeleted | Notifies you before a counter is deleted from the Counters collection. |
| OnCounterSelected | Notifies you when a counter is selected. |
| OnDblClick | Notifies you when a user double-clicks the graph line, histogram bar, or report item with the left mouse button. |
| OnSampleCollected | Notifies you when sample values for the counters have been collected. |
Methods
The SystemMonitor object has these methods.
| Method | Description |
|---|---|
| BatchLocking | Locks the System Monitor to prevent it from sampling counter data from the newly added counter or log file. |
| BrowseCounters | Displays the Add Counter dialog box. |
| ClearData | Clears all data fields in the control. |
| CollectSample | Samples a value for each counter in the Counters collection object. |
| Copy | Copies the control's property settings, list of counters, and counter data to the clipboard as an HTML object. |
| DisplayProperties | Displays the Graph Properties dialog box. |
| GetLogViewRange | Retrieves the starting date used to retrieve counter values from the log files. |
| LoadSettings | Adds the counters in the HTML template file to the System Monitor. |
| Paste | Appends the list of counters that were copied to the clipboard to the current collection of counters. |
| Relog | Relogs the counter data to a new file. You can also use this method to specify a new file type and to reduce the number of samples contained in the log file. |
| Reset | Removes all CounterItem objects from the Counters collection object. |
| SaveAs | Saves the counter values in the graph view to a log file. |
| ScaleToFit | Scale counter values to fit in the graph. |
| SetLogViewRange | Sets the starting date used to retrieve counter values from the log files. |
| UpdateGraph | Refreshes the contents of the System Monitor windows. |
Properties
The SystemMonitor object has these properties.
| Property | Description |
|---|---|
| Appearance |
Retrieves or sets the appearance of the control to include or omit three-dimensional display effects. |
| BackColor |
Retrieves or sets the background color of the graph and report views. |
| BackColorCtl |
Retrieves or sets the background color of the control. |
| BorderStyle |
Retrieves or sets the border style of the control. |
| ChartScroll |
Retrieves or sets a value that determines if the line graph scrolls in the view. |
| Counters |
Retrieves the collection of CounterItem objects. |
| DataPointCount |
Retrieves or sets the number of data points displayed in a line graph. |
| DataSourceType |
Retrieves or sets the source of the performance counter data. |
| DisplayType |
Retrieves or sets the type of graph used to graph the performance counter data. |
| EnableDigitGrouping |
Retrieves or sets a value that determines if SYSMON uses digit grouping when displaying numeric values. |
| EnableToolTips |
Retrieves or sets a value that determines if a tool tip is shown when the mouse hovers over a counter in one of the graph views. |
| Font |
Retrieves or sets the font used in the control. |
| ForeColor |
Retrieves or sets the color of the text that appears in the control. |
| GraphTitle |
Retrieves or sets the title of the graph. |
| GridColor |
Retrieves or sets the color of the grid lines used in the graph. |
| Highlight |
Retrieves or sets a value indicating whether the values of the selected counters are highlighted in the graph. |
| LogFileName |
Obsolete. Retrieves or sets the name of a log file to use as the source of counter values displayed in the System Monitor. |
| LogFiles |
Collection of one or more log files to use as the source of counter values displayed in the System Monitor. |
| LogSourceStartTime |
Retrieves the time stamp of the earliest counter value from a counter in your counter collection that was logged in the log files. |
| LogSourceStopTime |
Retrieves the time stamp of the latest counter value from a counter in your counter collection that was logged in the log files. |
| LogViewStart |
Retrieves or sets the starting date used to retrieve counter values from the log files. |
| LogViewStop |
Retrieves or sets the ending date used to retrieve counter values from the log files. |
| ManualUpdate |
Retrieves or sets a value indicating whether the contents of the System Monitor will be updated manually, or automatically at specified intervals. |
| MaximumScale |
Retrieves or sets the maximum value of the vertical (Y) axis of the graph. |
| MinimumScale |
Retrieves or sets the minimum value of the vertical (Y) axis of the graph. |
| MonitorDuplicateInstances |
Retrieves or sets a value that determines whether multiple instances of a counter can be monitored. |
| ReadOnly |
Retrieves or sets a value that determines whether a user can modify the property values of the control. |
| ReportValueType |
Retrieves or sets a value that determines if the Histogram and Report views graph the last value sampled during the sampling interval or a calculated value from the sampling, such as the average or minimum counter value. |
| ShowHorizontalGrid |
Retrieves or sets a value that determines whether horizontal grid lines are displayed in the graph. |
| ShowLegend |
Retrieves or sets a value that determines whether the legend is displayed. |
| ShowScaleLabels |
Retrieves or sets a value that determines whether the scale labels are displayed on the vertical axis of the graph. |
| ShowTimeAxisLabels |
Retrieves or sets a value that determines if the horizontal (X) axis of the graph view contains labels. |
| ShowToolbar |
Retrieves or sets a value that determines whether the toolbar is displayed on the control. |
| ShowValueBar |
Retrieves or sets a value that determines whether the value bar (the set of statistical values below the graph) is displayed on the control. |
| ShowVerticalGrid |
Retrieves or sets a value that determines whether vertical grid lines are displayed in the graph. |
| SqlDsnName |
Retrieves or sets the ODBC data source name. |
| SqlLogSetName |
Retrieves or sets the friendly name of the log set. |
| TimeBarColor |
Retrieves or sets the color of the time bar (the vertical bar that moves across the graph window to indicate the passage of each sampling interval in the line graph view). |
| UpdateInterval |
Retrieves or sets the length of time that SYSMON waits before the next time it updates the graph or report. |
| YAxisLabel |
Retrieves or sets the label of the vertical (Y) axis of the graph. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 2000 Professional [desktop apps only] |
| Minimum supported server |
Windows 2000 Server [desktop apps only] |
| Header |
|
| DLL |
|