Share via


TimedTextRegion Class

Definition

Exposes properties for customizing the appearance of the rendering area of a TimedTextCue.

public ref class TimedTextRegion sealed
/// [Windows.Foundation.Metadata.Activatable(65536, Windows.Foundation.UniversalApiContract)]
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class TimedTextRegion final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class TimedTextRegion final
[Windows.Foundation.Metadata.Activatable(65536, typeof(Windows.Foundation.UniversalApiContract))]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class TimedTextRegion
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class TimedTextRegion
function TimedTextRegion()
Public NotInheritable Class TimedTextRegion
Inheritance
Object Platform::Object IInspectable TimedTextRegion
Attributes

Windows requirements

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

Constructors

TimedTextRegion()

Initializes a new instance of the TimedTextRegion class.

Properties

Background

Gets or sets the background color of the TimedTextRegion.

DisplayAlignment

Gets or sets the display alignment of the TimedTextRegion.

Extent

Gets or sets the extent of the TimedTextRegion, which is the rendered size of the region either in pixels or in percentage of available space.

IsOverflowClipped

Gets or sets a value indicating whether text overflowing the region is clipped.

LineHeight

Gets or sets a value that indicates the height of each line of content.

Name

Gets or sets a string representing the name of the TimedTextRegion.

Padding

Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a TimedTextRegion.

Position

Gets or sets the position of the TimedTextRegion, relative to the top left corner of the video frame.

ScrollMode

Gets a value indicating the method in which lines of text scroll through the region.

TextWrapping

Gets or sets a value indicating whether text wraps when it reaches the edge of the TimedTextRegion.

WritingMode

Gets or sets a value indicating the direction that text flows within the TimedTextRegion.

ZIndex

Gets or sets the Z-order of the TimedTextRegion, relative to other active regions on the screen, in case they overlap.

Applies to