Skip to main content

DashboardBuilder Methods

Contains methods that allow you to customize the Web Dashboard.
Name Description
AllowMaximizeItems(Boolean) Specifies whether end users can maximize dashboard items.
BackendOptions(Action<DashboardBackendOptionsBuilder>) Specifies options that allow you to configure the Web Dashboard’s back-end.
ControllerName(String) Specifies a Web Dashboard’s controller name.
DataRequestOptions(Action<DataRequestOptionsBuilder>) Specifies options that allow you to configure a data request mode.
EncodeHtml(Boolean) Specifies whether the web control’s value and element content are rendered as pure HTML, or HTML markers are stripped out.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Extensions(Action<DashboardExtensionsOptionBuilder>) Provides access to the registered extensions’ settings.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
Height(Int32) Gets or sets the Web Dashboard control’s height.
Height(String) Gets or sets the Web Dashboard control’s height.
InitialDashboardId(String) Specifies the identifier of the dashboard to be loaded to the Web Dashboard.
InitialDashboardState(String) Specifies the initial state of the loaded dashboard.
LimitVisibleDataMode(LimitVisibleDataMode) Specifies a data limitation mode that allows you to display a reduced form of the visible data.
LoadDefaultDashboard(Boolean) Specifies whether the default dashboard should be loaded from the dashboard storage.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
Name(String) Specifies the dashboard control’s name.
Nonce(String) Specifies the nonce value.
OnBeforeRender(String) Specifies the JavaScript function (or its name) executed when the BeforeRender event is raised.
OnDashboardBeginUpdate(String) Specifies the JavaScript function (or its name) executed when the DashboardBeginUpdate event is raised.
OnDashboardEndUpdate(String) Specifies the JavaScript function (or its name) executed when the DashboardEndUpdate event is raised.
OnDashboardInitialized(String) Specifies the JavaScript function (or its name) executed when the DashboardInitialized event is raised.
OnDashboardInitializing(String) Specifies the JavaScript function (or its name) executed when the DashboardInitializing event is raised.
OnDashboardStateChanged(String) Specifies the JavaScript function (or its name) executed when the DashboardStateChanged event is raised.
OnInitializing(String) Specifies the JavaScript function (or its name) executed when the Initializing event is raised.
OnItemBeginUpdate(String) Specifies the JavaScript function (or its name) executed when the ItemBeginUpdate event is raised.
OnItemEndUpdate(String) Specifies the JavaScript function (or its name) executed when the ItemEndUpdate event is raised.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ResizeByTimer(Boolean) Specifies whether to redraw the Web Dashboard control when the size of a container is changed.
ShowConfirmationOnBrowserClosing(Boolean) Specifies whether to show a browser warning if an end-user attempts to leave the page with unsaved data.
ToString() Returns a string that represents the current object. Inherited from Object.
UseCardLegacyLayout(Boolean) Specifies whether to enable the legacy card layout used prior to v17.1.
UseNeutralFilterMode(Boolean) Specifies whether to show all items in the filter elements deselected by default.
Width(Int32) Gets or sets the Web Dashboard control’s width.
Width(String) Gets or sets the Web Dashboard control’s width.
WorkingMode(WorkingMode) Specifies the working mode of the Web Dashboard.
See Also