CoreTextLayoutRequest CoreTextLayoutRequest CoreTextLayoutRequest CoreTextLayoutRequest Class

Definition

Represents information about a LayoutRequested event.

public : sealed class CoreTextLayoutRequest : ICoreTextLayoutRequestpublic sealed class CoreTextLayoutRequest : ICoreTextLayoutRequestPublic NotInheritable Class CoreTextLayoutRequest Implements ICoreTextLayoutRequest// 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 can be obtained from the CoreTextLayoutRequestedEventArgs.Request property inside a handler for the CoreTextEditContext.LayoutRequested event handler.

Properties

IsCanceled IsCanceled IsCanceled IsCanceled

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

LayoutBounds LayoutBounds LayoutBounds LayoutBounds

Gets an object that represents the layout bounds information requested by the text input server. The application should populate the properties of this object to the layout bounds being requested before returning from the event handler.

public : CoreTextLayoutBounds LayoutBounds { get; }public CoreTextLayoutBounds LayoutBounds { get; }Public ReadOnly Property LayoutBounds As CoreTextLayoutBounds// You can use this property in JavaScript.
Value
CoreTextLayoutBounds CoreTextLayoutBounds CoreTextLayoutBounds CoreTextLayoutBounds

An object that represents the layout bounds information requested by the server.

Range Range Range Range

Gets a value that indicates the range of text whose bounding box is being requested by the text input server. The server populates this property before raising the event.

public : CoreTextRange Range { get; }public CoreTextRange Range { get; }Public ReadOnly Property Range As CoreTextRange// You can use this property in JavaScript.
Value
CoreTextRange CoreTextRange CoreTextRange CoreTextRange

The range of text whose bounding box is being requested by the server.

Methods

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

Requests that the layout request 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