Namespace: Consultingwerk.Windows.Util.Forms
Class 
MessageForm Copy to Clipboard
Parent classes:
Progress.Windows.Form
Consultingwerk.Windows.Util.Forms.MessageForm

Inherits: Progress.Windows.Form
Implements: Consultingwerk.Util.Forms.IMessageForm

File:MessageForm
Purpose:Default message Form, see Consultingwerk.Util.MessageFormHelper
Description:See http://confluence.consultingwerkcloud.com/wiki/display/SCL/Using+custom+buttons+on+the+MessageForm
for instructions on how to add custom buttons to Message Form
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Jul 16 16:01:51 CEST 2009

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
- btnDetails_Click (Object, EventArgs) Event handler for the Click event of the btnDetails
# CreateButtons () Creates the Message Buttons
# CustomButtonClickHandler (Object, EventArgs) Event handler for the click event of custom buttons
- InitializeComponent () Initializes the Visual Design
- KeyDownHandler (Object, KeyEventArgs) Event handler for the KeyDown event of the MessageForm
# OnFormClosing (FormClosingEventArgs) Raises the FormClosing event
# OnLoad (EventArgs) Raises the Load event
# OnShown (EventArgs) Raises the Shown event
# RenderCustomButtons () Renders buttons provided by the IErrorMessageFormButtonProvider
- TimerTickHandler (Object, EventArgs) Event handler for the Tick event of the Timer component
+ ToggleButtonState (logical) Toggles the Button state

Top Constructor Summary
Options Name Purpose
+ MessageForm () Constructor for the MessageForm class

Top Property Summary
Options Name Purpose
+ Consultingwerk.Framework.Enum.DialogResultEnum DefaultDialogResult Gets and sets the DialogResult of the default button
+ LOGICAL DisplayDetails Gets and sets if details should be shown
+ Consultingwerk.Framework.Enum.DialogResultEnum MessageButtonDialogResults Gets and sets the Array of Message Button Dialog Results
+ CHARACTER MessageButtonLabels Gets and sets the Array of Message Button Labels
+ CHARACTER MessageDetail Gets and sets the detail message text
+ Progress.Lang.Object MessageImage Gets and Sets the Message Image
+ CHARACTER MessageText Gets and sets the Message Text
+ INTEGER MessageTimer Gets and sets the Message Timer Value


Method Detail
Top

PRIVATE btnDetails_Click (Object, EventArgs)
Purpose: Event handler for the Click event of the btnDetails
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED CreateButtons ()
Purpose: Creates the Message Buttons
Notes:

Top

PROTECTED CustomButtonClickHandler (Object, EventArgs)
Purpose: Event handler for the click event of custom buttons
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data to this event
Top

PRIVATE InitializeComponent ()
Purpose: Initializes the Visual Design
Notes:

Top

PRIVATE KeyDownHandler (Object, KeyEventArgs)
Purpose: Event handler for the KeyDown event of the MessageForm
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event
Top

PROTECTED OnFormClosing (FormClosingEventArgs)
Purpose: Raises the FormClosing event
Notes:

Parameters:
e System.Windows.Forms.FormClosingEventArgs
The FormClosingEventArgs with the data for this event
Top

PROTECTED OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED OnShown (EventArgs)
Purpose: Raises the Shown event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

PROTECTED RenderCustomButtons ()
Purpose: Renders buttons provided by the IErrorMessageFormButtonProvider
Notes:

Top

PRIVATE TimerTickHandler (Object, EventArgs)
Purpose: Event handler for the Tick event of the Timer component
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

PUBLIC ToggleButtonState (logical)
Purpose: Toggles the Button state
Notes:

Parameters:
plDisplayStack LOGICAL
Logical value indicating if the stack should be shown


Constructor Detail
Top

PUBLIC MessageForm ()
Purpose: Constructor for the MessageForm class
Notes:



Property Detail
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DefaultDialogResult
Purpose: Gets and sets the DialogResult of the default button
Notes:

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC LOGICAL DisplayDetails
Purpose: Gets and sets if details should be shown
Notes:

Returns LOGICAL
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum MessageButtonDialogResults
Purpose: Gets and sets the Array of Message Button Dialog Results
Notes:

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC CHARACTER MessageButtonLabels
Purpose: Gets and sets the Array of Message Button Labels
Notes:

Returns CHARACTER
Top

PUBLIC CHARACTER MessageDetail
Purpose: Gets and sets the detail message text
Notes:

Returns CHARACTER
Top

PUBLIC Progress.Lang.Object MessageImage
Purpose: Gets and Sets the Message Image
Notes: This implementation requires a System.Drawing.Image

Returns Progress.Lang.Object
Top

PUBLIC CHARACTER MessageText
Purpose: Gets and sets the Message Text
Notes:

Returns CHARACTER
Top

PUBLIC INTEGER MessageTimer
Purpose: Gets and sets the Message Timer Value
Notes:

Returns INTEGER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:54:52