GSF.Windows
Represents a dialog box that can be used to display detailed exception information.
Initializes a new instance of the class.
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Represents a logger that can be used for logging handled as well as unhandled exceptions across multiple
application types (Windows Application, Console Application, Windows Service, Web Application, Web Service).
This example shows how to use the component to log handled and unhandled exceptions:
using System;
using System.IO;
using GSF.Windows.ErrorManagement;
class Program
{
static ErrorLogger s_logger;
static Program()
{
s_logger = new ErrorLogger();
s_logger.LogToUI = true; // Show exception info on the UI.
s_logger.LogToFile = true; // Log exception info to a file.
s_logger.LogToEmail = true; // Send exception info in an e-mail.
s_logger.LogToEventLog = true; // Log exception info to the event log.
s_logger.LogToScreenshot = true; // Take a screenshot of desktop on exception.
s_logger.ContactEmail = "dev@email.com"; // Provide an e-mail address.
s_logger.HandleUnhandledException = true; // Configure to handle unhandled exceptions.
s_logger.PersistSettings = true; // Save settings to the config file.
s_logger.Initialize(); // Initialize ErrorLogger component for use.
}
static void Main(string[] args)
{
try
{
// This may cause a handled FileNotFoundException if the file doesn't exist.
string data = File.ReadAllText(@"c:\NonExistentFile.txt");
}
catch (Exception ex)
{
// When logging handled exceptions we want to disable loggers (UI logger and E-mail logger) that
// may require interaction either directly or indirectly as it can be annoying. All the loggers
// are enabled automatically after the handled exception has been logged.
s_logger.SuppressInteractiveLogging();
s_logger.Log(ex);
}
int numerator = 1;
int denominator = 0;
int result = numerator / denominator; // This will cause an unhandled DivideByZeroException.
Console.ReadLine();
}
}
Specifies the default value for the property.
Initializes a new instance of the class.
Gets or sets a boolean value that indicates whether a screenshot of the user's desktop is to be taken
when an is logged.
This setting is ignored in Web Application and Web Service application types.
Gets the descriptive status of the object.
Saves settings for the object to the config file if the
property is set to true.
has a value of null or empty string.
Loads saved settings for the object from the config file if the
property is set to true.
has a value of null or empty string.
Registers the object to handle unhandled if the
property is set to true.
true if handlers were registered; otherwise false.
Unregister the object from handling unhandled .
true if handlers were unregistered; otherwise false.
Shows information in a Windows Application.
Takes a screenshot of the user's desktop when the is encountered.
that was encountered.
Gets or sets the comma-separated or semicolon-separated list of file names to be attached to the message.
Allows other loggers to extend "more info text".
Type of bullet to use for extended info text.
Represents a common about dialog box.
Initializes a new instance of the class.
Conceals the tab where disclaimer text is displayed.
Conceals the tab where application information is displayed.
Conceals the tab where assemblies and their information is displayed.
Sets the URL that will be opened when the logo is clicked.
URL of the company's home page.
Sets the logo that is to be displayed in the About Dialog.
Location of the logo file.
Sets the logo that is to be displayed in the About Dialog.
System.IO.Stream of the logo.
Sets the disclaimer text that is to be displayed in the About Dialog.
Location of the file that contains the disclaimer text.
Sets the disclaimer text that is to be displayed in the About Dialog.
System.IO.Stream of the disclaimer text.
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Defines extension methods for s.
Sets the size of the chart while also setting the font size of the
axes and legend as well as the border width of each of the series.
The chart to be resized.
The new width of the chart.
The new height of the chart.
The ratio of chart height to font size.
The ratio of chart height to border width.
Saves the chart to a memory stream using the given image
and returns the stream, ready for reading.
The chart to be saved to the stream.
The format to used to save the image.
The stream containing the chart as an image.
Extensions applied to all System.Windows.Forms.Form objects.
Config file category under which the window size information will be saved.
Config file category under which the window location information will be saved.
Saves the size and location information of the specified windowsForm to the application configuration file.
The Form whose size and location information is to be saved.
This function simply calls the SaveWindowSize and SaveWindowLocation functions using the default settings categories
Restores the size and location of the specified windowsForm from the size and location information saved in the
application configuration file.
The Form whose size and location is to be restored.
This function simply calls the RestoreWindowSize and RestoreWindowLocation functions using the default settings categories
Saves the size information of the specified windowsForm to the application configuration file.
The Form whose size information is to be saved.
This function uses the default settings category "LastWindowSize"
Saves the size information of the specified windowsForm to the application configuration file.
The Form whose size information is to be saved.
Settings category used to persist form size information
Saves the location information of the specified windowsForm to the application configuration file.
The Form whose location information is to be saved.
This function uses the default settings category "LastWindowLocation"
Saves the location information of the specified windowsForm to the application configuration file.
The Form whose location information is to be saved.
Settings category used to persist form location information
Restores the size of the specified windowsForm from the size information saved in the application configuration file.
The Form whose size is to be restored.
This function uses the default settings category "LastWindowSize"
Restores the size of the specified windowsForm from the size information saved in the application configuration file.
The Form whose size is to be restored.
Settings category used to persist form size information
Restores the location of the specified windowsForm from the location information saved in the application configuration file.
The Form whose location is to be restored.
This function uses the default settings category "LastWindowLocation"
Restores the location of the specified windowsForm from the location information saved in the application configuration file.
The Form whose location is to be restored.
Settings category used to persist form location information
Contains classes, extension functions and forms used to simplify and standardize usage of basic Windows forms.
Defines extension functions for the control.
Adjusts a property grid's label ratio
Property grid to adjust
Ratio to use use for label column
Smaller ratios (e.g., 1.75) produce a wider label column.
This function only has an effect on property grids when their Visible property is set to True. To use
this on an initially hidden property grid - set the property grid's Visible property to True at design
time, call this function during form load, then set the Visible property to False.
This function was written to work with the .NET 2.0 PropertyGrid control. Note that reflection is used
to set private properties of the property grid and as a result this function may not work with future
versions of the .NET property grid.
Adjusts a property grid's comment area height
Property grid to adjust
Number of lines to display in comment area
This function only has an effect on property grids when their Visible property is set to True. To use
this on an initially hidden property grid - set the property grid's Visible property to True at design
time, call this function during form load, then set the Visible property to False.
This function was written to work with the .NET 2.0 PropertyGrid control. Note that reflection is used
to set private properties of the property grid and as a result this function may not work with future
versions of the .NET property grid.
Returns screen area statistics and capture functionality for all connected screens.
Gets the least "x" coordinate of all screens on the system
The smallest visible "x" screen coordinate
Gets the greatest "x" coordinate of all screens on the system
The largest visible "x" screen coordinate
Gets the least "y" coordinate of all screens on the system
The smallest visible "y" screen coordinate
Gets the greatest "y" coordinate of all screens on the system
The largest visible "y" screen coordinate
Gets the width of the screen with the highest resolution.
The width of the screen with the highest resolution.
Gets the width of the screen with the lowest resolution.
The width of the screen with the lowest resolution.
Gets the height of the screen with the highest resolution.
The height of the screen with the highest resolution.
Gets the height of the screen with the lowest resolution.
The height of the screen with the lowest resolution.
Gets the total width of all the screens relative to their arrangement.
The total width of all the screens relative to their arrangement.
Gets the total height of all the screens relative to their arrangement.
The total height of all the screens relative to their arrangement.
Performs screen capture over all monitors.
Captured screen image over all monitors.
Size captured will be for total width and height of all screens relative to their arrangement.
An image square will be created large enough to cover all screens for the capture.
Performs screen capture over all monitors.
Desired for captured .
Captured screen image over all monitors.
Size captured will be for total width and height of all screens relative to their arrangement.
An image square will be created large enough to cover all screens for the capture.
Performs screen capture for given .
A object to capture.
Captured screen image for given .
Performs screen capture for given and .
Desired to capture
Desired for captured .
Captured screen image for given .
Performs a screen capture the given .
Screen area to capture.
Captured screen image for given area.
Performs a screen capture the given and .
Screen area to capture.
Desired for captured .
Captured screen image for given area.
Represents a windows form secured using role-based security.
Required config file entries:
]]>
Initializes a new instance of the class.
Gets current security principal for secure form.
Gets or sets exception handler for secure form.
Gets the name of resource being accessed.
Name of the resource being accessed.
Required designer variable.
Clean up any resources being used.
true if managed resources should be disposed; otherwise, false.
Required method for Designer support - do not modify
the contents of this method with the code editor.
Contains classes and extension functions related to .NET Windows-based platforms such as Windows Forms and WPF.
Defines an enumeration of secure resource accessibility modes.
Resource security is controlled via configuration.
Resource is always secured.
Resource is never secured.
Represents a WPF window secured using role-based security.
Required config file entries:
]]>
XAML to be used for the WPF window that inherits from :
]]>
Initializes a new instance of the class.
Gets or sets flags to force login display.
Gets or sets window's secure .
Gets or sets applicable roles when == .
Gets or sets the security principal used to test authentication and role membership.
Gets the name of resource being accessed.
Name of the resource being accessed.
Identifies the dependency property.
identifier for the dependency property.
Identifies the dependency property.
identifier for the dependency property.
Identifies the dependency property.
identifier for the dependency property.
Identifies the dependency property.
identifier for the dependency property.
Enumerable list of portlets to be displayed on the screen.
Login screen.
Access Denied screen.
Change Password screen.
Represents a WPF window used to request user credentials and other security related information.
SecurityPortal
Initializes a new WPF window.
Type of the message received from security API which is used to decide controls to be displayed on the screen.
Gets the security principal used for role-based authorization.
Gets or sets flag that indicates if there was a failure during provider initialization.
Displays requested screen section based on received request.
Displays error message.
Error message to display.
Clears error message.
Handles window closed.
Source of this event.
Arguments of this event.
Handles mouse down event anywhere on the screen so user can click and drag this window around.
Logins the user.
Source of this event.
Arguments of this event.
Attempts to change user's password.
Source of this event.
Arguments of this event.
Exits window.
Source of this event.
Arguments of this event.
Closes window.
Source of this event.
Arguments of this event.
Displays help for the user on how to reset password.
Source of this event.
Arguments of this event.
Navigates users to Change Password screen.
Source of this event.
Arguments of this event.
Navigates users back to Login screen.
Source of this event.
Arguments of this event.
Keeps the user names on the separate sections synchronized and clears error messages when text changes.
Source of this event.
Arguments of this event.
Clears error messages when text changes.
Source of this event.
Arguments of this event.
We make sure all text boxes "select-all" when they receive focus.
Source of this event.
Arguments of this event.
InitializeComponent