TimedTextStyle
TimedTextStyle
TimedTextStyle
TimedTextStyle
Class
Definition
Defines the style of the rendered text in a TimedTextCue. You can set the style of a substring within a TimedTextLine by using the Subformats property.
public : sealed class TimedTextStyle : ITimedTextStyle, ITimedTextStyle2public sealed class TimedTextStyle : ITimedTextStyle, ITimedTextStyle2Public NotInheritable Class TimedTextStyle Implements ITimedTextStyle, ITimedTextStyle2// 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
TimedTextStyle() TimedTextStyle() TimedTextStyle() TimedTextStyle()
Initializes a new instance of the TimedTextStyle class.
public : TimedTextStyle()public TimedTextStyle()Public Sub New()// You can use this method in JavaScript.
Properties
Background Background Background Background
Gets or sets the background color of timed text.
public : Color Background { get; set; }public Color Background { get; set; }Public ReadWrite Property Background As Color// You can use this property in JavaScript.
Remarks
This TimedTextStyle.Background color is rendered behind character glyphs or spaces in timed text content. The TimedTextRegion.Background color sets the color of the background of the container in which the timed text lines are rendered.
FlowDirection FlowDirection FlowDirection FlowDirection
Gets or sets a value indicating the direction that timed text is flowed.
public : TimedTextFlowDirection FlowDirection { get; set; }public TimedTextFlowDirection FlowDirection { get; set; }Public ReadWrite Property FlowDirection As TimedTextFlowDirection// You can use this property in JavaScript.
A value indicating the direction that the timed text is flows.
FontFamily FontFamily FontFamily FontFamily
Gets or sets the font family of timed text.
public : PlatForm::String FontFamily { get; set; }public string FontFamily { get; set; }Public ReadWrite Property FontFamily As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The font family of timed text.
FontSize FontSize FontSize FontSize
Gets or sets the font size of timed text.
public : TimedTextDouble FontSize { get; set; }public TimedTextDouble FontSize { get; set; }Public ReadWrite Property FontSize As TimedTextDouble// You can use this property in JavaScript.
The font size of timed text.
FontStyle FontStyle FontStyle FontStyle
Gets or sets a value that specifies the font style of timed text.
public : TimedTextFontStyle FontStyle { get; set; }public TimedTextFontStyle FontStyle { get; set; }Public ReadWrite Property FontStyle As TimedTextFontStyle// You can use this property in JavaScript.
A value that specifies the font style of timed text.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
FontWeight FontWeight FontWeight FontWeight
Gets or sets the weight of timed text.
public : TimedTextWeight FontWeight { get; set; }public TimedTextWeight FontWeight { get; set; }Public ReadWrite Property FontWeight As TimedTextWeight// You can use this property in JavaScript.
The weight of timed text.
IsBackgroundAlwaysShown IsBackgroundAlwaysShown IsBackgroundAlwaysShown IsBackgroundAlwaysShown
Gets or sets a value indicating if the background color stays visible when no text is being displayed.
public : PlatForm::Boolean IsBackgroundAlwaysShown { get; set; }public bool IsBackgroundAlwaysShown { get; set; }Public ReadWrite Property IsBackgroundAlwaysShown As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
A value indicating if the background color stays visible when no text is being displayed.
IsLineThroughEnabled IsLineThroughEnabled IsLineThroughEnabled IsLineThroughEnabled
Gets or sets a value indicating whether strikethrough text is enabled for the timed text.
public : PlatForm::Boolean IsLineThroughEnabled { get; set; }public bool IsLineThroughEnabled { get; set; }Public ReadWrite Property IsLineThroughEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if strikethrough text is enabled; otherwise, false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
IsOverlineEnabled IsOverlineEnabled IsOverlineEnabled IsOverlineEnabled
Gets or sets a value indicating whether overline text is enabled for the timed text.
public : PlatForm::Boolean IsOverlineEnabled { get; set; }public bool IsOverlineEnabled { get; set; }Public ReadWrite Property IsOverlineEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if overline text is enabled; otherwise, false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
IsUnderlineEnabled IsUnderlineEnabled IsUnderlineEnabled IsUnderlineEnabled
Gets or sets a value indicating whether underline text is enabled for the timed text.
public : PlatForm::Boolean IsUnderlineEnabled { get; set; }public bool IsUnderlineEnabled { get; set; }Public ReadWrite Property IsUnderlineEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if underline text is enabled; otherwise, false.
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
LineAlignment LineAlignment LineAlignment LineAlignment
Gets or sets the alignment of timed text lines.
public : TimedTextLineAlignment LineAlignment { get; set; }public TimedTextLineAlignment LineAlignment { get; set; }Public ReadWrite Property LineAlignment As TimedTextLineAlignment// You can use this property in JavaScript.
The alignment of timed text lines.
Name Name Name Name
Gets or sets the name of the timed text style.
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 timed text style.
OutlineRadius OutlineRadius OutlineRadius OutlineRadius
Gets or sets the radius of the blur applied to outline of the timed text.
public : TimedTextDouble OutlineRadius { get; set; }public TimedTextDouble OutlineRadius { get; set; }Public ReadWrite Property OutlineRadius As TimedTextDouble// You can use this property in JavaScript.
The radius of the blur applied to outline of the timed text.
Remarks
A value of zero results in no blurring of the text outline. Set the thickness of the outline with OutlineThickness.
OutlineThickness OutlineThickness OutlineThickness OutlineThickness
Gets or sets the thickness of the outline of the timed text.
public : TimedTextDouble OutlineThickness { get; set; }public TimedTextDouble OutlineThickness { get; set; }Public ReadWrite Property OutlineThickness As TimedTextDouble// You can use this property in JavaScript.
The thickness of the outline of the timed text.