Class PageFactory
Inheritance
System.Object
PageFactory
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
A factory class for creating pages in a more streamlined way
Properties
View Source
Page
Declaration
public Page Page { get; }
Public ReadOnly Property Page As Page
Property Value
Methods
View Source
CopyPage(Page)
Declaration
public static PageFactory CopyPage(Page page)
Public Shared Function CopyPage(page As Page) As PageFactory
Parameters
| Type |
Name |
Description |
| Page |
page |
|
Returns
View Source
CreateDeviceConfigPage(String, String)
Create a new device configuration page
Declaration
public static PageFactory CreateDeviceConfigPage(string id, string name)
Public Shared Function CreateDeviceConfigPage(id As String, name As String) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
The ID for the page
|
| System.String |
name |
The name of the page
|
Returns
| Type |
Description |
| PageFactory |
A new PageFactory containing a page with its type set to EPageType.DeviceConfig
|
View Source
CreateEventActionPage(String, String)
Create a new, event action page
Declaration
public static PageFactory CreateEventActionPage(string id, string name)
Public Shared Function CreateEventActionPage(id As String, name As String) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
The ID for the page
|
| System.String |
name |
The name of the page
|
Returns
| Type |
Description |
| PageFactory |
A new PageFactory containing a page with its type set to EPageType.EventAction
|
View Source
CreateEventTriggerPage(String, String)
Create a new, event trigger page
Declaration
public static PageFactory CreateEventTriggerPage(string id, string name)
Public Shared Function CreateEventTriggerPage(id As String, name As String) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
The ID for the page
|
| System.String |
name |
The name of the page
|
Returns
| Type |
Description |
| PageFactory |
A new PageFactory containing a page with its type set to EPageType.EventTrigger
|
View Source
CreateGenericPage(String, String)
Create a new, generic page
Declaration
public static PageFactory CreateGenericPage(string id, string name)
Public Shared Function CreateGenericPage(id As String, name As String) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
The ID for the page
|
| System.String |
name |
The name of the page
|
Returns
| Type |
Description |
| PageFactory |
A new PageFactory containing a page with its type set to EPageType.Generic
|
View Source
CreateSettingsPage(String, String)
Create a new settings page
Declaration
public static PageFactory CreateSettingsPage(string id, string name)
Public Shared Function CreateSettingsPage(id As String, name As String) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
The ID for the page
|
| System.String |
name |
The name of the page
|
Returns
| Type |
Description |
| PageFactory |
A new PageFactory containing a page with its type set to EPageType.Settings
|
View Source
WithCheckBox(String, String, Boolean)
Declaration
public PageFactory WithCheckBox(string id, string name, bool isEnabled = false)
Public Function WithCheckBox(id As String, name As String, isEnabled As Boolean = False) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.Boolean |
isEnabled |
|
Returns
View Source
WithDropDownSelectList(String, String, List<String>, List<String>, Int32)
Declaration
public PageFactory WithDropDownSelectList(string id, string name, List<string> options, List<string> optionKeys, int selection = -1)
Public Function WithDropDownSelectList(id As String, name As String, options As List(Of String), optionKeys As List(Of String), selection As Integer = -1) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.Collections.Generic.List<System.String> |
options |
|
| System.Collections.Generic.List<System.String> |
optionKeys |
|
| System.Int32 |
selection |
|
Returns
View Source
WithDropDownSelectList(String, String, List<String>, Int32)
Declaration
public PageFactory WithDropDownSelectList(string id, string name, List<string> options, int selection = -1)
Public Function WithDropDownSelectList(id As String, name As String, options As List(Of String), selection As Integer = -1) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.Collections.Generic.List<System.String> |
options |
|
| System.Int32 |
selection |
|
Returns
View Source
WithGroup(String, String, IEnumerable<AbstractView>)
Declaration
public PageFactory WithGroup(string id, string name, IEnumerable<AbstractView> views)
Public Function WithGroup(id As String, name As String, views As IEnumerable(Of AbstractView)) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.Collections.Generic.IEnumerable<AbstractView> |
views |
|
Returns
View Source
WithInput(String, String, EInputType)
Declaration
public PageFactory WithInput(string id, string name, EInputType type = EInputType.Text)
Public Function WithInput(id As String, name As String, type As EInputType = EInputType.Text) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| EInputType |
type |
|
Returns
View Source
WithInput(String, String, String, EInputType)
Declaration
public PageFactory WithInput(string id, string name, string value, EInputType type = EInputType.Text)
Public Function WithInput(id As String, name As String, value As String, type As EInputType = EInputType.Text) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.String |
value |
|
| EInputType |
type |
|
Returns
View Source
WithLabel(String, String)
Declaration
public PageFactory WithLabel(string id, string name)
Public Function WithLabel(id As String, name As String) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
Returns
View Source
WithLabel(String, String, String)
Declaration
public PageFactory WithLabel(string id, string name, string value = "")
Public Function WithLabel(id As String, name As String, value As String = "") As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.String |
value |
|
Returns
View Source
WithRadioSelectList(String, String, List<String>, List<String>, Int32)
Declaration
public PageFactory WithRadioSelectList(string id, string name, List<string> options, List<string> optionKeys, int selection = -1)
Public Function WithRadioSelectList(id As String, name As String, options As List(Of String), optionKeys As List(Of String), selection As Integer = -1) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.Collections.Generic.List<System.String> |
options |
|
| System.Collections.Generic.List<System.String> |
optionKeys |
|
| System.Int32 |
selection |
|
Returns
View Source
WithRadioSelectList(String, String, List<String>, Int32)
Declaration
public PageFactory WithRadioSelectList(string id, string name, List<string> options, int selection = -1)
Public Function WithRadioSelectList(id As String, name As String, options As List(Of String), selection As Integer = -1) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.Collections.Generic.List<System.String> |
options |
|
| System.Int32 |
selection |
|
Returns
View Source
WithTextArea(String, String, Int32)
Declaration
public PageFactory WithTextArea(string id, string name, int rows = 5)
Public Function WithTextArea(id As String, name As String, rows As Integer = 5) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.Int32 |
rows |
|
Returns
View Source
WithTextArea(String, String, String, Int32)
Declaration
public PageFactory WithTextArea(string id, string name, string value, int rows = 5)
Public Function WithTextArea(id As String, name As String, value As String, rows As Integer = 5) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.String |
value |
|
| System.Int32 |
rows |
|
Returns
View Source
WithTimeSpan(String, String, TimeSpan, Boolean, Boolean)
Declaration
public PageFactory WithTimeSpan(string id, string name, TimeSpan timeSpan = default(TimeSpan), bool showDays = true, bool showSeconds = true)
Public Function WithTimeSpan(id As String, name As String, timeSpan As TimeSpan = Nothing, showDays As Boolean = True, showSeconds As Boolean = True) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.TimeSpan |
timeSpan |
|
| System.Boolean |
showDays |
|
| System.Boolean |
showSeconds |
|
Returns
View Source
WithToggle(String, String, Boolean)
Declaration
public PageFactory WithToggle(string id, string name, bool isEnabled = false)
Public Function WithToggle(id As String, name As String, isEnabled As Boolean = False) As PageFactory
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
| System.String |
name |
|
| System.Boolean |
isEnabled |
|
Returns
View Source
WithView(AbstractView)
Declaration
public PageFactory WithView(AbstractView view)
Public Function WithView(view As AbstractView) As PageFactory
Parameters
Returns