CoreTextFormatUpdatingEventArgs Class

Reference

Definition

Namespace:: Windows.UI.Text.Core

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Provides data for the FormatUpdating event.

public ref class CoreTextFormatUpdatingEventArgs sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class CoreTextFormatUpdatingEventArgs final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class CoreTextFormatUpdatingEventArgs

Public NotInheritable Class CoreTextFormatUpdatingEventArgs

Inheritance: Object Platform::Object IInspectable CoreTextFormatUpdatingEventArgs

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

An object of this type is passed as an argument to a handler for the FormatUpdating event.

Properties

BackgroundColor	Gets a value that represents the background color to be applied to the text range. The text input server populates this property before raising the event.
IsCanceled	Gets a value that indicates whether the format update operation is canceled.
Range	Gets a value that indicates the range of text that the text input server needs to format. The server populates this property before raising the event.
Reason	Gets a value that indicates the reason that the text input server needs to apply formatting to this range of text. The server populates this property before raising the event.
Result	Gets or sets a value that indicates the result of handling the FormatUpdating 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.
TextColor	Gets a value that represents the text color to be applied to the text range. The text input server populates this property before raising the event.
UnderlineColor	Gets a value that represents the underline color to be applied to the text range. The text input server populates this property before raising the event.
UnderlineType	Gets a value that represents the underline type to be applied to the text range. The text input server populates this property before raising the event.

Methods

GetDeferral()

Requests that the format update operation be delayed. Call this method if your text input control is hosted on a worker thread rather than on the UI thread.

Applies to

Dela via