Namespace: Consultingwerk.Util
Class 
InputPromptHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.InputPromptHelper

Inherits: Progress.Lang.Object

File:InputPromptHelper
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Feb 17 20:35:38 CET 2012

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ LOGICAL PromptForCharacterValue (character, character, character) Prompts the user for a CHARACTER Value using a modal dialog
+ LOGICAL PromptForCharacterValue (character, character, CharacterPromptTypeEnum, character) Prompts the user for a CHARACTER Value using a modal dialog
+ LOGICAL PromptForCharacterValue (character, character, ICharacterInputValidator, character) Prompts the user for a CHARACTER Value using a modal dialog
+ LOGICAL PromptForCharacterValue (character, character, ICharacterInputValidator, CharacterPromptTypeEnum, character) Prompts the user for a CHARACTER Value using a modal dialog
+ LOGICAL PromptForCharacterValue (character, character, ListNameValuePair, character) Prompts the user for a CHARACTER Value using a modal dialog using a combo-box of possible values
+ LOGICAL PromptForCharacterValue (character, character, ListNameValuePair, ICharacterInputValidator, character) Prompts the user for a CHARACTER Value using a modal dialog using a combo-box of possible values
+ LOGICAL PromptForIntegerValue (character, character, integer) Prompts the user for a Integer Value using a modal dialog
+ LOGICAL PromptForIntegerValue (character, character, IIntegerInputValidator, integer) Prompts the user for a Integer Value using a modal dialog
+ LOGICAL PromptForIntegerValue (character, character, IIntegerInputValidator, NumericPromptTypeEnum, integer) Prompts the user for a Integer Value using a modal dialog
+ LOGICAL PromptForIntegerValue (character, character, IIntegerInputValidator, NumericPromptTypeEnum, integer, integer, integer) Prompts the user for a Integer Value using a modal dialog
+ LOGICAL PromptForIntegerValue (character, character, NumericPromptTypeEnum, integer) Prompts the user for a Integer Value using a modal dialog
# ShowDialog (Form, DialogResult) Invokes the dialog form using WAIT-FOR :ShowDialog ()

Top Constructor Summary
Options Name Purpose
# InputPromptHelper () Constructor for the InputPromptHelper class


Method Detail
Top

PUBLIC LOGICAL PromptForCharacterValue (character, character, character)
Purpose: Prompts the user for a CHARACTER Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
pcValue CHARACTER
INPUT-OUTPUT The Character value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForCharacterValue (character, character, CharacterPromptTypeEnum, character)
Purpose: Prompts the user for a CHARACTER Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poPromptType Consultingwerk.Framework.Enum.CharacterPromptTypeEnum
The prompt type (e.g. single line, editor, file name
pcValue CHARACTER
INPUT-OUTPUT The Character value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForCharacterValue (character, character, ICharacterInputValidator, character)
Purpose: Prompts the user for a CHARACTER Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poValidator Consultingwerk.Framework.ICharacterInputValidator
The ICharacterInputValidator instance to validate the value entered by the user
pcValue CHARACTER
INPUT-OUTPUT The Character value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForCharacterValue (character, character, ICharacterInputValidator, CharacterPromptTypeEnum, character)
Purpose: Prompts the user for a CHARACTER Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poValidator Consultingwerk.Framework.ICharacterInputValidator
The ICharacterInputValidator instance to validate the value entered by the user
poPromptType Consultingwerk.Framework.Enum.CharacterPromptTypeEnum
The prompt type (e.g. single line, editor, file name
pcValue CHARACTER
INPUT-OUTPUT The Character value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForCharacterValue (character, character, ListNameValuePair, character)
Purpose: Prompts the user for a CHARACTER Value using a modal dialog using
a combo-box of possible values
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poValueList Consultingwerk.ListNameValuePair
A ListNameValuePair with the possible choices
pcValue CHARACTER
INPUT-OUTPUT The Character value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForCharacterValue (character, character, ListNameValuePair, ICharacterInputValidator, character)
Purpose: Prompts the user for a CHARACTER Value using a modal dialog using
a combo-box of possible values
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poValueList Consultingwerk.ListNameValuePair
A ListNameValuePair with the possible choices
poValidator Consultingwerk.Framework.ICharacterInputValidator
The ICharacterInputValidator instance to validate the value entered by the user
pcValue CHARACTER
INPUT-OUTPUT The Character value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForIntegerValue (character, character, integer)
Purpose: Prompts the user for a Integer Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
piValue INTEGER
INPUT-OUTPUT The Integer value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForIntegerValue (character, character, IIntegerInputValidator, integer)
Purpose: Prompts the user for a Integer Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poValidator Consultingwerk.Framework.IIntegerInputValidator
The IIntegerInputValidator instance to validate the value entered by the user
piValue INTEGER
INPUT-OUTPUT The Integer value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForIntegerValue (character, character, IIntegerInputValidator, NumericPromptTypeEnum, integer)
Purpose: Prompts the user for a Integer Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poValidator Consultingwerk.Framework.IIntegerInputValidator
The ICharacterInputValidator instance to validate the value entered by the user
poPromptType Consultingwerk.Framework.Enum.NumericPromptTypeEnum
The prompt type (e.g. single line, editor, file name
piValue INTEGER
INPUT-OUTPUT The Character value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForIntegerValue (character, character, IIntegerInputValidator, NumericPromptTypeEnum, integer, integer, integer)
Purpose: Prompts the user for a Integer Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poValidator Consultingwerk.Framework.IIntegerInputValidator
The ICharacterInputValidator instance to validate the value entered by the user
poPromptType Consultingwerk.Framework.Enum.NumericPromptTypeEnum
The prompt type (e.g. single line, editor, file name
piMinimumValue INTEGER
The minimum value that is acceptable
piMaximumValue INTEGER
The maximum value that is acceptable
piValue INTEGER
INPUT-OUTPUT The Character value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PUBLIC LOGICAL PromptForIntegerValue (character, character, NumericPromptTypeEnum, integer)
Purpose: Prompts the user for a Integer Value using a modal dialog
Notes:

Parameters:
pcTitle CHARACTER
The title for the input prompt
pcDescription CHARACTER
The description shown in the Input prompt
poPromptType Consultingwerk.Framework.Enum.NumericPromptTypeEnum
The prompt type (e.g. single line, editor, file name
piValue INTEGER
INPUT-OUTPUT The Integer value entered
Returns LOGICAL
Logical value indicating if the user has choosen Ok or Cancel
Top

PROTECTED ShowDialog (Form, DialogResult)
Purpose: Invokes the dialog form using WAIT-FOR :ShowDialog ()
Notes: Seperate method that returns a void value to allow compilation when
-IOEverywhere 1 is not set. However for the runtime -IOEverywhere 1
is retured

Parameters:
poForm System.Windows.Forms.Form
The dialog form to show
poDialogResult System.Windows.Forms.DialogResult
OUTPUT The DialogResult of the current Form


Constructor Detail
Top

PROTECTED InputPromptHelper ()
Purpose: Constructor for the InputPromptHelper class
Notes: Disallow instance creation



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