CoreTextSelectionUpdatingEventArgs
CoreTextSelectionUpdatingEventArgs
CoreTextSelectionUpdatingEventArgs
CoreTextSelectionUpdatingEventArgs
Class
Definition
Provides data for the SelectionUpdating event.
public : sealed class CoreTextSelectionUpdatingEventArgs : ICoreTextSelectionUpdatingEventArgspublic sealed class CoreTextSelectionUpdatingEventArgs : ICoreTextSelectionUpdatingEventArgsPublic NotInheritable Class CoreTextSelectionUpdatingEventArgs Implements ICoreTextSelectionUpdatingEventArgs// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
An object of this type is passed as an argument to a handler for the SelectionUpdating event.
Properties
IsCanceled IsCanceled IsCanceled IsCanceled
Gets a value that indicates whether the selection update operation is canceled.
public : PlatForm::Boolean IsCanceled { get; }public bool IsCanceled { get; }Public ReadOnly Property IsCanceled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if the selection update operation is canceled; otherwise, false.
Examples
// Notify Windows that the deferred operation is beginning
if (!args.IsCanceled)
{
// Perform deferred operation
// …
// Notify Windows that the deferred operation is complete
deferral.Complete();
}
Remarks
If the app defers the operation, it is possible for it to be canceled before the app responds to it. For this reason, you should read this property, only once, immediately before responding to a deferred operation.
Note
The "getter" for the IsCanceled property notifies Windows that the app is beginning the deferred operation. You should consider reading this property as a required step before you perform the deferred operation. Use the pattern shown in the example when reading IsCanceled.
Result Result Result Result
Gets or sets a value that indicates the result of handling the SelectionUpdating event. The default value is Succeeded but if you can't action the operation as the text input server expects then before returning from the event handler set the property to the appropriate value to indicate what has happened.
public : CoreTextSelectionUpdatingResult Result { get; set; }public CoreTextSelectionUpdatingResult Result { get; set; }Public ReadWrite Property Result As CoreTextSelectionUpdatingResult// You can use this property in JavaScript.
- Value
- CoreTextSelectionUpdatingResult CoreTextSelectionUpdatingResult CoreTextSelectionUpdatingResult CoreTextSelectionUpdatingResult
The result of handling the SelectionUpdating event. The default is Succeeded.
Selection Selection Selection Selection
Gets a value that indicates the range of text that the text input server indicates should be selected. The server populates this property before raising the event.
public : CoreTextRange Selection { get; }public CoreTextRange Selection { get; }Public ReadOnly Property Selection As CoreTextRange// You can use this property in JavaScript.
The range of text that the server indicates should be selected.
Methods
GetDeferral() GetDeferral() GetDeferral() GetDeferral()
Requests that the selection update operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.
public : Deferral GetDeferral()public Deferral GetDeferral()Public Function GetDeferral() As Deferral// You can use this method in JavaScript.