Namespace: Consultingwerk.Framework.Enum
Class 
DialogResultEnum Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Enum
Consultingwerk.Framework.Enum.DialogResultEnum

Inherits: Consultingwerk.Enum

File:DialogResultEnum
Purpose:A platform neutral Enumeration for DialogResults
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Apr 20 07:40:51 CEST 2011
Notes:Used by MessageFormHelper / IMessageForm
Enum members prefixed with DialogResult (in comparison
to System.Windows.Forms.DialogResult members) because
Yes and No wouldn't be valid property names

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ LOGICAL Equals (Object) Compares this Enum member to another member of this Enum by Value
Inherited from Consultingwerk.Enum
+ Consultingwerk.Framework.Enum.DialogResultEnum FromSystemWindowsForms (DialogResult) Returns the Consultingwerk DialogResultEnum member that matches a System.Windows.Forms.DialogResult member
+ Consultingwerk.Framework.Collections.CharacterList GetNames () Returns a CharacterList with the names of the Enum members
+ F INT64 GetValue () Returns the Value of the Enum Member
Inherited from Consultingwerk.Enum
+ LOGICAL ToLogical () Converts a DialogResultEnum member to a default LOGICAL representation
+ LOGICAL ToLogical (DialogResultEnum[]) Converts a DialogResultEnum member to a default LOGICAL representation
+ CHARACTER ToString () Returns a CHARACTER representation (human readable) of the Enum member
Inherited from Consultingwerk.Enum
+ System.Windows.Forms.DialogResult ToSystemWindowsForms (DialogResultEnum) Returns the System.Windows.Forms.DialogResult member that matches a Consultingwerk DialogResultEnum member

Top Constructor Summary
Options Name Purpose
- DialogResultEnum (integer, character) Constructor for the DialogResultEnum class

Top Property Summary
Options Name Purpose
+ Consultingwerk.Framework.Enum.DialogResultEnum DialogResultAbort /* Static members */
+ Consultingwerk.Framework.Enum.DialogResultEnum DialogResultCancel
+ Consultingwerk.Framework.Enum.DialogResultEnum DialogResultIgnore
+ Consultingwerk.Framework.Enum.DialogResultEnum DialogResultNo
+ Consultingwerk.Framework.Enum.DialogResultEnum DialogResultNone
+ Consultingwerk.Framework.Enum.DialogResultEnum DialogResultOK
+ Consultingwerk.Framework.Enum.DialogResultEnum DialogResultRetry
+ Consultingwerk.Framework.Enum.DialogResultEnum DialogResultYes
# CHARACTER Label Returns the character label associated with an enum member instance
Inherited from Consultingwerk.Enum
+ INTEGER Value Returns the integer value associated with an enum member instance
Inherited from Consultingwerk.Enum


Method Detail
Top

PUBLIC LOGICAL Equals (Object)
Inherited from Consultingwerk.Enum
Purpose: Compares this Enum member to another member of this Enum by Value
Notes: Returns FALSE when the passed in object reference is not of this
Enum type

Parameters:
poParam Progress.Lang.Object
The object to compare by value and type with the current enum member
Returns LOGICAL
Logical value indicating if the two compared enum members are euqally
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum FromSystemWindowsForms (DialogResult)
Purpose: Returns the Consultingwerk DialogResultEnum member that matches a
System.Windows.Forms.DialogResult member
Notes:

Parameters:
poDialogResult System.Windows.Forms.DialogResult
The .NET DialogResult member
Returns Consultingwerk.Framework.Enum.DialogResultEnum
The DialogResultEnum member matching the parameter value
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList GetNames ()
Purpose: Returns a CharacterList with the names of the Enum members
Notes:

Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the names of the Enum members
Top

PUBLIC INT64 GetValue ()
Inherited from Consultingwerk.Enum
Purpose: Returns the Value of the Enum Member
Notes: Introduced for compability with 11.6 native Enums

Returns INT64
The Enum Memeber value
Top

PUBLIC LOGICAL ToLogical ()
Purpose: Converts a DialogResultEnum member to a default LOGICAL representation
Notes: Converts Abort, Cancel, No, None to FALSE,
Converts OK, Yes, Retry to TRUE
Converts Ignore to ?

Returns LOGICAL
The logical value matching the Enum's value
Top

PUBLIC LOGICAL ToLogical (DialogResultEnum[])
Purpose: Converts a DialogResultEnum member to a default LOGICAL representation
Notes: Converts Cancel to ? in a yes-no-cancel dialog
Converts Abort, Cancel, No, None to FALSE,
Converts OK, Yes, Retry to TRUE
Converts Ignore to ?

Parameters:
poDialogResults Consultingwerk.Framework.Enum.DialogResultEnum
The array of DialogResultEnum enum values as returned by MessageFormDefaults:GetDialogResult....
Returns LOGICAL
The logical value matching the Enum's value
Top

PUBLIC CHARACTER ToString ()
Inherited from Consultingwerk.Enum
Purpose: Returns a CHARACTER representation (human readable) of the
Enum member
Notes:

Returns CHARACTER
The CHARACTER representation of the enum member, identically to the Label property
Top

PUBLIC System.Windows.Forms.DialogResult ToSystemWindowsForms (DialogResultEnum)
Purpose: Returns the System.Windows.Forms.DialogResult member that matches a
Consultingwerk DialogResultEnum member
Notes:

Parameters:
poDialogResultEnum Consultingwerk.Framework.Enum.DialogResultEnum
A DialogResultEnum to return the .NET DialogResult enum member for
Returns System.Windows.Forms.DialogResult
The DialogResult Enum member matching the DialogResultEnum member


Constructor Detail
Top

PRIVATE DialogResultEnum (integer, character)
Purpose: Constructor for the DialogResultEnum class
Notes:

Parameters:
piValue INTEGER
The internal (numeric) representation of the Enumeration member
pcLabel CHARACTER
The text label of the Enumaration member


Property Detail
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DialogResultAbort
/* Static members

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DialogResultCancel

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DialogResultIgnore

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DialogResultNo

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DialogResultNone

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DialogResultOK

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DialogResultRetry

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum DialogResultYes

Returns Consultingwerk.Framework.Enum.DialogResultEnum
Top

PROTECTED CHARACTER Label
Inherited from Consultingwerk.Enum
Purpose: Returns the character label associated with an enum member instance
Notes: Instance member

Returns CHARACTER
Top

PUBLIC INTEGER Value
Inherited from Consultingwerk.Enum
Purpose: Returns the integer value associated with an enum member instance
Notes: Instance member

Returns INTEGER


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