Difference between revisions of "Dashboard class"
CGHelpdesk (talk | contribs) (Created page with "{{CGscriptClass_Template |Name=Dashboard |Description=Class to manipulate dashboards. |Constructors= {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|...") |
|||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
| − | |Name=Dashboard | + | |Name=<nowiki>Dashboard</nowiki> |
| − | |Description=Class to manipulate dashboards. | + | |Description=<nowiki>Class to manipulate dashboards.</nowiki> |
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
| − | {{CGscriptParameters_Template|Type= | + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceId</nowiki>|Description=<nowiki>Resource id of the dashboard to load</nowiki>}} |
| − | |Description=Load existing dashboard}} | + | |Description=<nowiki>Load existing dashboard</nowiki>}} |
{{CGscriptConstructors_Template|Parameters= | {{CGscriptConstructors_Template|Parameters= | ||
| − | {{CGscriptParameters_Template|Type=string|Name=layout|Description=The layout to use.|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=title|Description=The title of the dashboard.|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=isocode|Description=The isocode of the title.}} | + | {{CGscriptParameters_Template|Type=string|Name=<nowiki>layout</nowiki>|Description=<nowiki>The layout to use.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>title</nowiki>|Description=<nowiki>The title of the dashboard.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>isocode</nowiki>|Description=<nowiki>The isocode of the title.</nowiki>}} |
| − | |Description=Make new dashboard}} | + | |Description=<nowiki>Make new dashboard</nowiki>}} |
|Methods= | |Methods= | ||
| − | {{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Parameters= | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Parameters= |
| − | {{CGscriptParameters_Template|Type=string|Name=name|Description=Name of the resource. If empty it will not change the existing name. Required for new scripts.|Comma=,}}{{CGscriptParameters_Template|Type= | + | {{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Name of the resource. If empty it will not change the existing name. Required for new scripts.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentResourceId</nowiki>|Description=<nowiki>Parent of the resource. If 0 it will not change the existing. Required for new scripts.</nowiki>}} |
| − | |Description=Save the current dashboard.}} | + | |Description=<nowiki>Save the current dashboard.</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=Empty|Name=Save|Description=Save the current dashboard using the existing name and parent.}} | + | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the current dashboard using the existing name and parent.</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
| − | {{CGscriptProperties_Template|ReturnType=string|Name=Layout|HasGetter=1|HasSetter=1|Description=The layout.}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Layout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>The layout.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=Dictionary|Name=Title|HasGetter=1|HasSetter=1|Description=Get/Set the localized title of the dashboard.}} | + | {{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>Title</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the localized title of the dashboard.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType= | + | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>UniqueId</nowiki>|HasGetter=1|Description=<nowiki>The resource id of the workflow.</nowiki>}} |
| + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Url</nowiki>|HasGetter=1|Description=<nowiki>Get the relative url to view the dashboard.</nowiki>}} | ||
}} | }} | ||
Revision as of 08:00, 2 July 2020
Dashboard
Class to manipulate dashboards.
Parent class
Inherits from object
Constructors
- (int resourceId "Resource id of the dashboard to load") - Load existing dashboard
- (string layout "The layout to use.", string title "The title of the dashboard.", string isocode "The isocode of the title.") - Make new dashboard
Methods
- Empty Save(string name "Name of the resource. If empty it will not change the existing name. Required for new scripts.", int parentResourceId "Parent of the resource. If 0 it will not change the existing. Required for new scripts.") - Save the current dashboard.
- Empty Save() - Save the current dashboard using the existing name and parent.
- (From object) string ToString() - The string representation of the object.
Properties
- string Layout { get; set; } - The layout.
- string ObjectTypeName { get; } - The name of the type of object.
- Dictionary Title { get; set; } - Get/Set the localized title of the dashboard.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
- int UniqueId { get; } - The resource id of the workflow.
- string Url { get; } - Get the relative url to view the dashboard.
