Interface IRevelControl

Interfaces with a running template module or 'zone'. Represents the actual WPF control used to render to the module content.

Namespace: RevelDigital.Player.RevelScript

Assembly: RevelDigital.Player.RevelScript.dll

Syntax

public interface IRevelControl

Properties

AutoStart

Gets or sets a value indicating whether [auto start]. Determines wether or not the module should start playing immediately after the template finishes loading.

Declaration

bool AutoStart { get; set; }

Property Value

Type	Description
System.Boolean	true if [auto start]; otherwise, false.

Controller

Gets the controller.

Declaration

IController Controller { get; }

Property Value

Type	Description
IController

See Also

IController

IsLoaded

Declaration

bool IsLoaded { get; set; }

Property Value

Type	Description
System.Boolean

IsPlaying

Gets a value indicating whether this instance is playing.

Declaration

bool IsPlaying { get; }

Property Value

Type	Description
System.Boolean	true if this instance is playing; otherwise, false.

Left

Gets or sets the left position.

Declaration

double Left { get; set; }

Property Value

Type	Description
System.Double	The left position.

ModuleOptions

Gets the module options.

Declaration

IList<Option> ModuleOptions { get; }

Property Value

Type	Description
System.Collections.Generic.IList<Option>

See Also

Option

Name

Gets the name.

Declaration

string Name { get; }

Property Value

Type	Description
System.String

Playlist

Gets the playlist.

Declaration

Playlist Playlist { get; }

Property Value

Type	Description
Playlist

See Also

Playlist

Top

Gets or sets the top position.

Declaration

double Top { get; set; }

Property Value

Type	Description
System.Double	The top position.

Type

Gets the type.

Declaration

string Type { get; }

Property Value

Type	Description
System.String

See Also

ModuleTypes

ZIndex

Gets or sets the depth position index

Declaration

int ZIndex { get; set; }

Property Value

Type	Description
System.Int32	Depth position index.

Methods

FadeIn()

Declaration

IRevelControl FadeIn()

Returns

Type	Description
IRevelControl

FadeIn(TimeSpan)

Declaration

IRevelControl FadeIn(TimeSpan duration)

Parameters

Type	Name	Description
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

FadeOut()

Declaration

IRevelControl FadeOut()

Returns

Type	Description
IRevelControl

FadeOut(TimeSpan)

Declaration

IRevelControl FadeOut(TimeSpan duration)

Parameters

Type	Name	Description
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

Reload()

Reloads this instance.

Declaration

void Reload()

Resize(Double, Double)

Declaration

IRevelControl Resize(double widthTo, double heightTo)

Parameters

Type	Name	Description
System.Double	widthTo
System.Double	heightTo

Returns

Type	Description
IRevelControl

Resize(Double, Double, TimeSpan)

Declaration

IRevelControl Resize(double widthTo, double heightTo, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	widthTo
System.Double	heightTo
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

ResizeHeight(Double)

Declaration

IRevelControl ResizeHeight(double to)

Parameters

Type	Name	Description
System.Double	to

Returns

Type	Description
IRevelControl

ResizeHeight(Double, Double)

Declaration

IRevelControl ResizeHeight(double from, double to)

Parameters

Type	Name	Description
System.Double	from
System.Double	to

Returns

Type	Description
IRevelControl

ResizeHeight(Double, Double, TimeSpan)

Declaration

IRevelControl ResizeHeight(double from, double to, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	from
System.Double	to
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

ResizeHeight(Double, TimeSpan)

Declaration

IRevelControl ResizeHeight(double to, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	to
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

ResizeWidth(Double)

Declaration

IRevelControl ResizeWidth(double to)

Parameters

Type	Name	Description
System.Double	to

Returns

Type	Description
IRevelControl

ResizeWidth(Double, Double)

Declaration

IRevelControl ResizeWidth(double from, double to)

Parameters

Type	Name	Description
System.Double	from
System.Double	to

Returns

Type	Description
IRevelControl

ResizeWidth(Double, Double, TimeSpan)

Declaration

IRevelControl ResizeWidth(double from, double to, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	from
System.Double	to
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

ResizeWidth(Double, TimeSpan)

Declaration

IRevelControl ResizeWidth(double to, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	to
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

Start()

Starts this instance.

Declaration

bool Start()

Returns

Type	Description
System.Boolean

Stop()

Stops this instance.

Declaration

bool Stop()

Returns

Type	Description
System.Boolean

Translate(Double, Double)

Declaration

IRevelControl Translate(double leftTo, double topTo)

Parameters

Type	Name	Description
System.Double	leftTo
System.Double	topTo

Returns

Type	Description
IRevelControl

Translate(Double, Double, TimeSpan)

Declaration

IRevelControl Translate(double leftTo, double topTo, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	leftTo
System.Double	topTo
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

TranslateLeft(Double)

Declaration

IRevelControl TranslateLeft(double to)

Parameters

Type	Name	Description
System.Double	to

Returns

Type	Description
IRevelControl

TranslateLeft(Double, Double)

Declaration

IRevelControl TranslateLeft(double from, double to)

Parameters

Type	Name	Description
System.Double	from
System.Double	to

Returns

Type	Description
IRevelControl

TranslateLeft(Double, Double, TimeSpan)

Declaration

IRevelControl TranslateLeft(double from, double to, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	from
System.Double	to
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

TranslateLeft(Double, TimeSpan)

Declaration

IRevelControl TranslateLeft(double to, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	to
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

TranslateTop(Double)

Declaration

IRevelControl TranslateTop(double to)

Parameters

Type	Name	Description
System.Double	to

Returns

Type	Description
IRevelControl

TranslateTop(Double, Double)

Declaration

IRevelControl TranslateTop(double from, double to)

Parameters

Type	Name	Description
System.Double	from
System.Double	to

Returns

Type	Description
IRevelControl

TranslateTop(Double, Double, TimeSpan)

Declaration

IRevelControl TranslateTop(double from, double to, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	from
System.Double	to
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

TranslateTop(Double, TimeSpan)

Declaration

IRevelControl TranslateTop(double to, TimeSpan duration)

Parameters

Type	Name	Description
System.Double	to
System.TimeSpan	duration

Returns

Type	Description
IRevelControl

Events

FadeInCompleted

Occurs when the fade in animation has completed.

Declaration

event EventHandler FadeInCompleted

Event Type

Type	Description
System.EventHandler

FadeOutCompleted

Occurs when the fade out animation has completed.

Declaration

event EventHandler FadeOutCompleted

Event Type

Type	Description
System.EventHandler

Played

Occurs when a media source is played.

Declaration

event EventHandler<PlayedEventArgs> Played

Event Type

Type	Description
System.EventHandler<PlayedEventArgs>

Recreate

Occurs when the control is recreated.

Declaration

event EventHandler Recreate

Event Type

Type	Description
System.EventHandler

ResizeHeightCompleted

Occurs when the resize height animation has completed.

Declaration

event EventHandler ResizeHeightCompleted

Event Type

Type	Description
System.EventHandler

ResizeWidthCompleted

Occurs when the resize width animation has completed.

Declaration

event EventHandler ResizeWidthCompleted

Event Type

Type	Description
System.EventHandler

TranslateLeftCompleted

Occurs when the translate left animation has completed.

Declaration

event EventHandler TranslateLeftCompleted

Event Type

Type	Description
System.EventHandler

TranslateTopCompleted

Occurs when the translate top animation has completed.

Declaration

event EventHandler TranslateTopCompleted

Event Type

Type	Description
System.EventHandler