Interface ITemplate

Interfaces with the actively running template. Represents the actual WPF main window and is the parent of all template modules or 'zones'.

Namespace: RevelDigital.Player.RevelScript
Assembly: RevelDigital.Player.RevelScript.dll
Syntax
public interface ITemplate

Properties

Controller

Gets the controller.

Declaration
IController Controller { get; }
Property Value
Type Description
IController

Description

Gets the description.

Declaration
string Description { get; }
Property Value
Type Description
System.String

DisplayCount

Gets the number of attached displays.

Declaration
int DisplayCount { get; }
Property Value
Type Description
System.Int32

DisplayMode

Gets the display mode.

Declaration
DisplayMode DisplayMode { get; }
Property Value
Type Description
DisplayMode
See Also

Height

Gets the height.

Declaration
double Height { get; }
Property Value
Type Description
System.Double

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.

Item[String]

Gets the IRevelControl with the specified module name.

Declaration
IRevelControl this[string moduleName] { get; }
Parameters
Type Name Description
System.String moduleName
Property Value
Type Description
IRevelControl

Modules

Gets the modules.

Declaration
List<dynamic> Modules { get; }
Property Value
Type Description
System.Collections.Generic.List<System.Object>
See Also

Name

Gets the name.

Declaration
string Name { get; }
Property Value
Type Description
System.String

Orientation

Gets the orientation.

Declaration
Orientation Orientation { get; }
Property Value
Type Description
Orientation
See Also

ScriptVars

Gets the script vars.

Declaration
IDictionary<string, string> ScriptVars { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>

Width

Gets the width.

Declaration
double Width { get; }
Property Value
Type Description
System.Double

Methods

Reload()

Reloads this instance.

Declaration
Task Reload()
Returns
Type Description
System.Threading.Tasks.Task

Start()

Starts this instance.

Declaration
bool Start()
Returns
Type Description
System.Boolean

Stop()

Stops this instance.

Declaration
Task<bool> Stop()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Stop(Action)

Stops this instance and executes the supplied delegate on completion.

Declaration
Task<bool> Stop(Action OnSuspended)
Parameters
Type Name Description
System.Action OnSuspended

The delegate to execute on completion.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Events

TemplateLoaded

Occurs when [loaded].

Declaration
event EventHandler TemplateLoaded
Event Type
Type Description
System.EventHandler