C-DEngine 5.105

TheNMIEngine..::..AddFormToDashboard Method (TheDashboardInfo, TheThing, TheFormInfo, Int32, String, String, Int32, Int32, String, String, ThePropertyBag)

This method creates an NMI Form and adds it to the Dashboard specified in the first parameter

Namespace:  nsCDEngine.Engines.NMIService
Assembly:  C-DEngine (in C-DEngine.dll)

Syntax


public static TheDashPanelInfo AddFormToDashboard(
	TheDashboardInfo tDash,
	TheThing pOwnerThing,
	TheFormInfo pForm,
	int pOrder,
	string pClassName,
	string pFormTitle,
	int pFlags,
	int pACL,
	string pCategory,
	string OnChangeName,
	ThePropertyBag pPropertyBag
)
Public Shared Function AddFormToDashboard ( _
	tDash As TheDashboardInfo, _
	pOwnerThing As TheThing, _
	pForm As TheFormInfo, _
	pOrder As Integer, _
	pClassName As String, _
	pFormTitle As String, _
	pFlags As Integer, _
	pACL As Integer, _
	pCategory As String, _
	OnChangeName As String, _
	pPropertyBag As ThePropertyBag _
) As TheDashPanelInfo
public:
static TheDashPanelInfo^ AddFormToDashboard(
	TheDashboardInfo^ tDash, 
	TheThing^ pOwnerThing, 
	TheFormInfo^ pForm, 
	int^ pOrder, 
	String^ pClassName, 
	String^ pFormTitle, 
	int^ pFlags, 
	int^ pACL, 
	String^ pCategory, 
	String^ OnChangeName, 
	ThePropertyBag^ pPropertyBag
)

Parameters

tDash
Type: nsCDEngine.Engines.NMIService..::..TheDashboardInfo
DashPanel this Form will be added to
pOwnerThing
Type: nsCDEngine.Engines.ThingService..::..TheThing
The Onwer Thing of this Form
pForm
Type: nsCDEngine.Engines.NMIService..::..TheFormInfo
All the Form Parameter
pOrder
Type: Int32
If the Dashpanel has multiple forms, this order sorts the forms
pClassName
Type: String
Style ClassName
pFormTitle
Type: String
Caption of the Dashboard Icon
pFlags
Type: Int32
1=Show On Local Relay 2=Show on Cloud Relay 4=Hide on Mobile 8=Do not include with ShowAll
pACL
Type: Int32
Access Level for this Form
pCategory
Type: String
Category in the Dashboard this Form will be in
OnChangeName
Type: String
Name of a Thing-Property this form is monitoring
pPropertyBag
Type: nsCDEngine.Engines.NMIService..::..ThePropertyBag
Propertybag with custom properties of the form

Return Value

Returns a GUID of the new Form. Guid.Empty is returned if this function failed