[This is preliminary documentation and is subject to change.]
A ModalResult contains the result of showing an object in a modal
dialogue box.
Declaration Syntax| C# |
public struct ModalResult : IMultiValue
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | ModalResult(Int32) | Creates a new ModalResult from an integer value. |
  | ButtonOne | This is the value for button one. |
 | Buttons | Gets only the button values from this ModalResult. This value
can safely be used in a switch statement. |
| ButtonThree | This is the value for button three. |
| ButtonTwo | This is the value for button two. |
| Empty | This is the default ModalResult value. |
| Equals(Object) | Performs an equality comparison with another object. (Overrides ValueType.Equals(Object).) |
| Error | This is the value for error. |
 | ExplicitNarrowingExplicitExplicitExplicit(ModalResult to String) | Explicit conversion from ModalResult to string. |
 | Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetHashCode()()()() | Creates a hash code for the ModalResult. (Overrides ValueType.GetHashCode()()()().) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| ImplicitWideningImplicitImplicitImplicit(ModalResult to Int32) | Implicit conversion from ModalResult to int. |
| ImplicitWideningImplicitImplicitImplicit(Int32 to ModalResult) | Implicit conversion from int to ModalResult. |
| ImplicitWideningImplicitImplicitImplicit(String to ModalResult) | Implicit conversion from string to ModalResult. |
| IsCombinable | Indicates whether ModalResult values can be combined. |
| IsError | Determines whether the ModalResult has a value indicative of an
error result. |
| IsNegative | Determines whether the ModalResult has a value indicative of a
negative result. |
| IsNeutral | Determines whether the ModalResult has a value indicative of a
neutral result. |
| IsNotPositive | Determines whether the ModalResult has a value which is other
than positive. |
| IsPositive | Determines whether the ModalResult has a value indicative of a
positive result. |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| Negative | This is the value for negative. |
| Neutral | This is the value for neutral. |
| ordinal | Contains the value of the ModalResult. |
| Ordinal | Gets the integer ordinal value of this ModalResult. |
| Outcome | Gets only the outcome values from this ModalResult. This value
can safely be used in a switch statement. |
| Parse(String) | Parses a string containing a textual representation of an ModalResult. |
| Positive | This is the value for positive. |
| sourcePairs | This array contains one source pair for each ModalResult value. |
| SourcePairs | Gets the array of ISourcePairs holding ordinal and text values. |
| TopValue | This is the value for the top value. |
| ToString()()()() | Creates a textual representation of the ModalResult. (Overrides ValueType.ToString()()()().) |
Remarks Modal dialogues displayed with for example UserInterface.ShowModalButtons can have up to three buttons,
any of which can be labelled as having a positive, negative or neutral result.
This struct has combinable values, and generally combines a value indicating
which button was clicked to close the box with a value indicating whether that
button was positive, negative or neutral.