Class TextOverlaySettings

Text overlay settings.

Inheritance
object
TextOverlaySettings
Inherited Members
Namespace: VisioForge.Core.Types.X.VideoEffects
Assembly: VisioForge.Core.dll
Syntax
public class TextOverlaySettings

Constructors

TextOverlaySettings(string)

Initializes a new instance of the TextOverlaySettings class.

Declaration
public TextOverlaySettings(string text)
Parameters
Type Name Description
string text

The text.

Properties

AutoAdjustSize

Gets or sets a value indicating whether [automatic adjust size].

Declaration
public bool AutoAdjustSize { get; set; }
Property Value
Type Description
bool

true if [automatic adjust size]; otherwise, false.

Color

Gets or sets the color.

Declaration
public SKColor Color { get; set; }
Property Value
Type Description
SKColor

The color.

DeltaX

Gets or sets the delta X.

Declaration
public int DeltaX { get; set; }
Property Value
Type Description
int

The delta X.

DeltaY

Gets or sets the delta Y.

Declaration
public int DeltaY { get; set; }
Property Value
Type Description
int

The delta Y.

Font

Gets or sets the font.

Declaration
public FontSettings Font { get; set; }
Property Value
Type Description
FontSettings

The font.

HorizontalAlignment

Gets or sets the horizontal alignment.

Declaration
public TextOverlayHAlign HorizontalAlignment { get; set; }
Property Value
Type Description
TextOverlayHAlign

The horizontal alignment.

LineAlignment

Gets or sets the line alignment.

Declaration
public TextOverlayLineAlign LineAlignment { get; set; }
Property Value
Type Description
TextOverlayLineAlign

The line alignment.

Mode

Gets or sets the mode.

Declaration
public TextOverlayMode Mode { get; set; }
Property Value
Type Description
TextOverlayMode

The mode.

OutlineColor

Gets or sets the color of the outline.

Declaration
public SKColor OutlineColor { get; set; }
Property Value
Type Description
SKColor

The color of the outline.

Shading

Gets or sets a value indicating whether this TextOverlaySettings is shading.

Declaration
public bool Shading { get; set; }
Property Value
Type Description
bool

true if shading; otherwise, false.

Silent

Gets or sets a value indicating whether this TextOverlaySettings is silent.

Declaration
public bool Silent { get; set; }
Property Value
Type Description
bool

true if silent; otherwise, false.

Text

Gets or sets the text.

Declaration
public string Text { get; set; }
Property Value
Type Description
string

The text.

TimeFormat

Gets or sets the time format.

Declaration
public string TimeFormat { get; set; }
Property Value
Type Description
string

The time format.

VerticalAlignment

Gets or sets the vertical alignment.

Declaration
public TextOverlayVAlign VerticalAlignment { get; set; }
Property Value
Type Description
TextOverlayVAlign

The vertical alignment.

VerticalRender

Gets or sets a value indicating whether [vertical render].

Declaration
public bool VerticalRender { get; set; }
Property Value
Type Description
bool

true if [vertical render]; otherwise, false.

WaitText

Gets or sets a value indicating whether [wait text].

Declaration
public bool WaitText { get; set; }
Property Value
Type Description
bool

true if [wait text]; otherwise, false.

WrapMode

Gets or sets the wrap mode.

Declaration
public TextOverlayWrapMode WrapMode { get; set; }
Property Value
Type Description
TextOverlayWrapMode

The wrap mode.

XPad

Gets or sets the x pad.

Declaration
public int XPad { get; set; }
Property Value
Type Description
int

The x pad.

XPos

Gets or sets the X position. Range is 0.0 - 1.0.

Declaration
public double XPos { get; set; }
Property Value
Type Description
double

The X position.

YPad

Gets or sets the Y pad.

Declaration
public int YPad { get; set; }
Property Value
Type Description
int

The Y pad.

YPos

Gets or sets the Y position. Range is 0.0 - 1.0.

Declaration
public double YPos { get; set; }
Property Value
Type Description
double

The Y position.