CoreTextCompositionCompletedEventArgs.IsCanceled Property

Definition

Namespace:

Windows.UI.Text.Core

Gets a value that indicates whether the operation is canceled.

public:
 property bool IsCanceled { bool get(); };

bool IsCanceled();

public bool IsCanceled { get; }

var boolean = coreTextCompositionCompletedEventArgs.isCanceled;

Public ReadOnly Property IsCanceled As Boolean

Property Value

Boolean

bool

true if the 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.