TimedTextRegion
TimedTextRegion
TimedTextRegion
TimedTextRegion
Class
Definition
Exposes properties for customizing the appearance of the rendering area of a TimedTextCue.
public : sealed class TimedTextRegion : ITimedTextRegionpublic sealed class TimedTextRegion : ITimedTextRegionPublic NotInheritable Class TimedTextRegion Implements ITimedTextRegion// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Constructors
TimedTextRegion() TimedTextRegion() TimedTextRegion() TimedTextRegion()
Initializes a new instance of the TimedTextRegion class.
public : TimedTextRegion()public TimedTextRegion()Public Sub New()// You can use this method in JavaScript.
Properties
Background Background Background Background
Gets or sets the background color of the TimedTextRegion.
public : Color Background { get; set; }public Color Background { get; set; }Public ReadWrite Property Background As Color// You can use this property in JavaScript.
The background color of the TimedTextRegion.
DisplayAlignment DisplayAlignment DisplayAlignment DisplayAlignment
Gets or sets the display alignment of the TimedTextRegion.
public : TimedTextDisplayAlignment DisplayAlignment { get; set; }public TimedTextDisplayAlignment DisplayAlignment { get; set; }Public ReadWrite Property DisplayAlignment As TimedTextDisplayAlignment// You can use this property in JavaScript.
- Value
- TimedTextDisplayAlignment TimedTextDisplayAlignment TimedTextDisplayAlignment TimedTextDisplayAlignment
The display alignment of the TimedTextRegion.
Extent Extent Extent 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.
public : TimedTextSize Extent { get; set; }public TimedTextSize Extent { get; set; }Public ReadWrite Property Extent As TimedTextSize// You can use this property in JavaScript.
The extent of the TimedTextRegion.
IsOverflowClipped IsOverflowClipped IsOverflowClipped IsOverflowClipped
Gets or sets a value indicating whether text overflowing the region is clipped.
public : PlatForm::Boolean IsOverflowClipped { get; set; }public bool IsOverflowClipped { get; set; }Public ReadWrite Property IsOverflowClipped As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if overflowing text is clipped; otherwise, false.
LineHeight LineHeight LineHeight LineHeight
Gets or sets a value that indicates the height of each line of content.
public : TimedTextDouble LineHeight { get; set; }public TimedTextDouble LineHeight { get; set; }Public ReadWrite Property LineHeight As TimedTextDouble// You can use this property in JavaScript.
A value that indicates the height of each line of content.
- See Also
Name Name Name Name
Gets or sets a string representing the name of the TimedTextRegion.
public : PlatForm::String Name { get; set; }public string Name { get; set; }Public ReadWrite Property Name As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The name of the TimedTextRegion.
Padding Padding Padding 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.
public : TimedTextPadding Padding { get; set; }public TimedTextPadding Padding { get; set; }Public ReadWrite Property Padding As TimedTextPadding// You can use this property in JavaScript.
A value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a TimedTextRegion.
Position Position Position Position
Gets or sets the position of the TimedTextRegion, relative to the top left corner of the video frame.
public : TimedTextPoint Position { get; set; }public TimedTextPoint Position { get; set; }Public ReadWrite Property Position As TimedTextPoint// You can use this property in JavaScript.
The position of the TimedTextRegion
ScrollMode ScrollMode ScrollMode ScrollMode
Gets a value indicating the method in which lines of text scroll through the region.
public : TimedTextScrollMode ScrollMode { get; set; }public TimedTextScrollMode ScrollMode { get; set; }Public ReadWrite Property ScrollMode As TimedTextScrollMode// You can use this property in JavaScript.
A value indicating the method in which lines of text scroll through the region.
- See Also
TextWrapping TextWrapping TextWrapping TextWrapping
Gets or sets a value indicating whether text wraps when it reaches the edge of the TimedTextRegion.
public : TimedTextWrapping TextWrapping { get; set; }public TimedTextWrapping TextWrapping { get; set; }Public ReadWrite Property TextWrapping As TimedTextWrapping// You can use this property in JavaScript.
A value indicating whether text wraps when it reaches the edge of the region.
- See Also
WritingMode WritingMode WritingMode WritingMode
Gets or sets a value indicating the direction that text flows within the TimedTextRegion.
public : TimedTextWritingMode WritingMode { get; set; }public TimedTextWritingMode WritingMode { get; set; }Public ReadWrite Property WritingMode As TimedTextWritingMode// You can use this property in JavaScript.
A value indicating the direction that text flows within the region.
- See Also
ZIndex ZIndex ZIndex ZIndex
Gets or sets the Z-order of the TimedTextRegion, relative to other active regions on the screen, in case they overlap.
public : int ZIndex { get; set; }public int ZIndex { get; set; }Public ReadWrite Property ZIndex As int// You can use this property in JavaScript.
- Value
- int int int int
The Z-order of the TimedTextRegion.