Difference between revisions of "Dashboard class"
| Line 18: | Line 18: | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Layout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>The layout.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Layout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>The layout.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
| + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ShortUrl</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the short url to view the dashboard. This only works for full-html5 dashboards</nowiki>}} | ||
{{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=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=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} | ||
Latest revision as of 05:30, 28 December 2021
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.
- string ShortUrl { get; set; } - Get/Set the short url to view the dashboard. This only works for full-html5 dashboards
- 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.
