NavigateTab Class

Provides functionality for a tab displayed a report in the Web Report Designer.

Declaration

class NavigateTab extends Analytics.Utils.Disposable implements INavigateTab

Remarks

You can use the Report Designer’s GetTabs method to obtain all currently opened tabs.

Properties

displayName Property

Specifies the display name of the current tab.

Declaration

displayName: ko.Computed<string>

Property Value

Type	Description
Computed<string>	A knockout computed string that specifies the tab’s display name.

isModified Property

Specifies whether the report in the current tab has been changed.

Declaration

isModified: ko.Observable<boolean> | ko.Computed<boolean>

Property Value

Type
Observable<boolean>
Computed<boolean>

report Property

Specifies a report opened in the current tab.

Declaration

report: ko.Computed<Controls.ReportViewModel>

Property Value

Type	Description
Computed<ReportViewModel>	A knockout observable object that specifies a report opened in the current tab.

undoEngine Property

Specifies an engine that manages undo and redo operations in the Web Report Designer.

Declaration

undoEngine: Analytics.Utils.UndoEngine

Property Value

Type	Description
UndoEngine	An object that specifies an undo/redo engine.

url Property

Specifies the URL of a report opened in the current tab.

Declaration

url: ko.Computed<string>

Property Value

Type	Description
Computed<string>	A knockout computed string that specifies the report URL.

Methods

refresh Method

Reopens an assigned report.

Declaration

refresh(): void

Remarks

The refresh method reopens a report assigned to the current tab without saving changes made to this report. This method works only if you implemented a custom server-side report storage.

The following code snippet demonstrates how to use the client-side GetCurrentTab method to get the currently active Report Designer tab and reopen an assigned report.

ASPX

<script type="text/javascript">       
    function Refresh() {
        var tab = reportDesigner.GetCurrentTab();
        tab.refresh();
    }
</script>

<div onclick="Refresh()">Refresh</div>
<dx:ASPxReportDesigner ID="ASPxReportDesigner1" ClientInstanceName="reportDesigner" runat="server" />

resetIsModified Method

Resets the value returned by the isModified property.

Declaration

resetIsModified(): void

Remarks

The following code snippet demonstrates how to reset the isModified property value for all Report Designer tabs. To obtain these tabs, use the GetTabs method.

 <script type="text/javascript">
    function ResetIsModified() {
        reportDesigner.GetTabs().forEach(function (item) { item.resetIsModified(); })
    }
</script>

<div onclick="ResetIsModified()">Reset IsModified</div>
<dx:ASPxReportDesigner ID="ASPxReportDesigner1" ClientInstanceName="reportDesigner" runat="server"/>