[This is preliminary documentation and is subject to change.]
Represents the various states that a user interface item
representing an Operation can take.
Declaration Syntax
C# |
public class OperationPresence
Members
All Members | Constructors | Methods | Properties | Fields | |
Icon | Member | Description |
---|---|---|
OperationPresence(OperationPresence..::..Visibility, String) | Creates a new OperationPresence with a particular visibility and
tooltip. | |
Disabled(String) | Creates an OperationPresence with Visibility of Disabled and a
particular tooltip. | |
Enabled(String) | Creates an OperationPresence with Visibility of Enabled and a
particular tooltip. | |
Equals(Object) | (Inherited from Object.) | |
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()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
Invisible |
This OperationPresence indicates that the item representing the Operation
should not be visible in the user interface. No tooltip is displayed.
| |
IsEnabled |
Gets a value indicating whether the operation should be enabled.
| |
IsVisible |
Gets a value indicating whether the operation should be visible.
| |
MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
OperationDisabled |
This OperationPresence indicates that the item representing the Operation
should be visible but disabled in the user interface. No tooltip is
displayed.
| |
OperationEnabled |
This OperationPresence indicates that the item representing the Operation
should be visible and enabled in the user interface. No tooltip is
displayed.
| |
OperationVisibility |
Gets the operation Visibility indicated by this OperationPresence.
| |
Tooltip |
Gets the tooltip to display for the operation.
| |
ToString()()()() | (Inherited from Object.) |
Remarks
The state comprises of a Visibility and a tooltip. The visibility indicates whether the Operation should be visible at all, and if so whether it should be enabled. The tooltip can give a summary of the Operation when it's enabled, or an explanation of why it is disabled.
An OperationPresence is used for the return value from the [operation name]Presence methods generated for all defined Operations. The Persistate infrastructure calls these methods to determine whether user interface items such as menu items or toolbar buttons should be enabled and/or visible at a particular point in time.
Inheritance Hierarchy
Object | |
OperationPresence |