CoreTextCompositionCompletedEventArgs CoreTextCompositionCompletedEventArgs CoreTextCompositionCompletedEventArgs CoreTextCompositionCompletedEventArgs Class

Definition

Provides data for the CompositionCompleted event.

public : sealed class CoreTextCompositionCompletedEventArgs : ICoreTextCompositionCompletedEventArgspublic sealed class CoreTextCompositionCompletedEventArgs : ICoreTextCompositionCompletedEventArgsPublic NotInheritable Class CoreTextCompositionCompletedEventArgs Implements ICoreTextCompositionCompletedEventArgs// You can use this class in JavaScript.
Attributes
Windows 10 requirements
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 CompositionCompleted event.

Properties

CompositionSegments CompositionSegments CompositionSegments CompositionSegments

Gets a collection of CoreTextCompositionSegment objects representing the segments in the composition string. Applications can use this property, for example, to get the pre-conversion string for each composition segment.

public : IVectorView<CoreTextCompositionSegment> CompositionSegments { get; }public IReadOnlyList<CoreTextCompositionSegment> CompositionSegments { get; }Public ReadOnly Property CompositionSegments As IReadOnlyList<CoreTextCompositionSegment>// You can use this property in JavaScript.
Value
IVectorView<CoreTextCompositionSegment> IReadOnlyList<CoreTextCompositionSegment> IReadOnlyList<CoreTextCompositionSegment> IReadOnlyList<CoreTextCompositionSegment>

A collection of CoreTextCompositionSegment objects.

IsCanceled IsCanceled IsCanceled IsCanceled

Gets a value that indicates whether the 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 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.

Methods

GetDeferral() GetDeferral() GetDeferral() GetDeferral()

Requests that the 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.
Returns