ASP.NET Core

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ReportDesigner - ASP.NETCore API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ReportDesigner

    Class ReportDesigner.

    Inheritance
    System.Object
    CommonDataBoundControl
    ReportDesigner
    Implements
    System.Web.UI.IPostBackDataHandler
    System.Web.UI.IUrlResolutionService
    System.Web.UI.INamingContainer
    System.Web.UI.IPostBackEventHandler
    Inherited Members
    CommonDataBoundControl.PerformDataBinding(IEnumerable)
    CommonDataBoundControl.FetchData(IEnumerable)
    CommonDataBoundControl.PostBackEventHandler(String, Dictionary<String, Object>)
    CommonDataBoundControl.RenderContents(HtmlTextWriter)
    Namespace: Syncfusion.JavaScript.Web
    Assembly: Syncfusion.EJ.Web.dll
    Syntax
    public class ReportDesigner : CommonDataBoundControl, IPostBackDataHandler, IUrlResolutionService, INamingContainer, IPostBackEventHandler

    Constructors

    ReportDesigner()

    Declaration
    public ReportDesigner()

    Fields

    model

    Declaration
    public ReportDesignerProperties model
    Field Value
    Type Description
    ReportDesignerProperties

    Properties

    ConfigurePaneSettings

    Gets or sets the ConfigurePane settings.

    Declaration
    [JsonConverter(typeof(DataManagerConverter))]
    [JsonProperty("ConfigurePaneSettings")]
    public ConfigurePaneSettings ConfigurePaneSettings { get; set; }
    Property Value
    Type Description
    ConfigurePaneSettings

    Gets the ConfigurePane settings.

    Locale

    Gets or sets the locale for report designer.

    Declaration
    [JsonProperty("locale")]
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    Gets the current locale as string value.

    Model

    Gets or sets the ReportDesigner model.

    Declaration
    public ReportDesignerProperties Model { get; set; }
    Property Value
    Type Description
    ReportDesignerProperties

    The model.

    OnClientAjaxBeforeLoad

    Fires before AJAX loads.If you want to perform any operation before AJAX event,you can make use of the ajaxBeforeLoad event.

    Declaration
    [JsonProperty("ajaxBeforeLoad")]
    public string OnClientAjaxBeforeLoad { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the ajaxBeforeLoad event.

    OnClientAjaxError

    Fires when AJAX result is failed.

    Declaration
    [JsonProperty("ajaxError")]
    public string OnClientAjaxError { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the ajaxError event.

    OnClientAjaxSuccess

    Fires when AJAX result is succeeded.

    Declaration
    [JsonProperty("ajaxSuccess")]
    public string OnClientAjaxSuccess { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the ajaxSuccess event.

    OnClientCreate

    Fires when the Report Designer widget is created.

    Declaration
    [JsonProperty("create")]
    public string OnClientCreate { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the create event.

    OnClientDestroy

    Fires when the report designer is destroyed successfully.If you want to perform any operation after destroying the reportdesigner control,you can make use of the destroy event.

    Declaration
    [JsonProperty("destroy")]
    public string OnClientDestroy { get; set; }
    Property Value
    Type Description
    System.String

    Gets the destroy event.

    OnClientExtensionLocaleChanged

    Fires when the specified locale key was not present in report designer locale.

    Declaration
    [JsonProperty("extensionLocaleChanged")]
    public string OnClientExtensionLocaleChanged { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the extensionLocaleChanged event.

    OnClientOpenReportClick

    Fires while clicking open menu items.

    Declaration
    [JsonProperty("openReportClick")]
    public string OnClientOpenReportClick { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the openReportClick event.

    OnClientReportModified

    Fires when the report is modified.

    Declaration
    [JsonProperty("reportModified")]
    public string OnClientReportModified { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the reportModified event.

    OnClientReportOpened

    Fires when the report is opened.

    Declaration
    [JsonProperty("reportOpened")]
    public string OnClientReportOpened { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the reportOpened event.

    OnClientReportSaved

    Fires when the report is saved.

    Declaration
    [JsonProperty("reportSaved")]
    public string OnClientReportSaved { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the reportSaved event.

    OnClientSaveReportClick

    Fires when the save menu items are clicked.

    Declaration
    [JsonProperty("saveReportClick")]
    public string OnClientSaveReportClick { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the saveReportClick event.

    OnClientToolbarClick

    Fires while clicking the toolbar items.

    Declaration
    [JsonProperty("toolbarClick")]
    public string OnClientToolbarClick { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the toolbarClick event.

    OnClientToolbarRendering

    Fires while rendering the Report Designer toolbar.

    Declaration
    [JsonProperty("toolbarRendering")]
    public string OnClientToolbarRendering { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the toolbarRendering event.

    PermissionSettings

    Gets or sets the permission.

    Declaration
    [JsonConverter(typeof(DataManagerConverter))]
    [JsonProperty("permissionSettings")]
    public PermissionSettings PermissionSettings { get; set; }
    Property Value
    Type Description
    PermissionSettings

    Gets the permission.

    ReportDataExtensions

    Gets or sets the list of datasource extensions.

    Declaration
    [JsonProperty("reportDataExtensions")]
    public List<ReportDataExtensionsModule> ReportDataExtensions { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<ReportDataExtensionsModule>

    Gets the list of datasource extensions.

    ReportItemExtensions

    Gets or sets the list of report item extensions.

    Declaration
    [JsonProperty("reportItemExtensions")]
    public List<ReportItemExtensionsModule> ReportItemExtensions { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<ReportItemExtensionsModule>

    Gets the list of custom report items.

    ReportPath

    Gets or sets the path of report.

    Declaration
    [JsonProperty("reportPath")]
    [JsonConverter(typeof(DataManagerConverter))]
    public string ReportPath { get; set; }
    Property Value
    Type Description
    System.String

    Gets the path of the report.

    ReportServerUrl

    Gets or sets the reports server URL.

    Declaration
    [JsonProperty("reportServerUrl")]
    public string ReportServerUrl { get; set; }
    Property Value
    Type Description
    System.String

    Gets the report server URL.

    ReportType

    Gets or sets the report type.

    Declaration
    [JsonProperty("reportType")]
    public ReportType ReportType { get; set; }
    Property Value
    Type Description
    ReportType

    Gets the report type.

    ServiceAuthorizationToken

    Gets or sets the token to access the Report Server API services.

    Declaration
    [JsonProperty("serviceAuthorizationToken")]
    [JsonConverter(typeof(DataManagerConverter))]
    public string ServiceAuthorizationToken { get; set; }
    Property Value
    Type Description
    System.String

    Gets the token for report designer control to access the report server API.

    ServiceUrl

    Specifies the report Web API service url.

    Declaration
    [JsonConverter(typeof(DataManagerConverter))]
    [JsonProperty("serviceUrl")]
    public string ServiceUrl { get; set; }
    Property Value
    Type Description
    System.String

    Gets or sets the report service URL.

    ToolbarSettings

    Gets or sets the toolbar settings.

    Declaration
    [JsonConverter(typeof(DataManagerConverter))]
    [JsonProperty("toolbarSettings")]
    public ToolbarSettings ToolbarSettings { get; set; }
    Property Value
    Type Description
    ToolbarSettings

    Gets the toolbar settings.

    Methods

    DependentScripts()

    Declaration
    public List<string> DependentScripts()
    Returns
    Type Description
    System.Collections.Generic.List<System.String>

    GetDependentFiles()

    Adding dependent scripts.

    Declaration
    public override List<string> GetDependentFiles()
    Returns
    Type Description
    System.Collections.Generic.List<System.String>

    Script files.

    Overrides
    CommonDataBoundControl.GetDependentFiles()

    LoadViewState(Object)

    Loads the state of the view state.

    Declaration
    protected override void LoadViewState(object state)
    Parameters
    Type Name Description
    System.Object state

    The state.

    Overrides
    CommonDataBoundControl.LoadViewState(Object)

    OnInit(EventArgs)

    Declaration
    protected override void OnInit(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnLoad(EventArgs)

    Declaration
    protected override void OnLoad(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e
    Overrides
    CommonDataBoundControl.OnLoad(EventArgs)

    OnPreRender(EventArgs)

    Declaration
    protected override void OnPreRender(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e
    Overrides
    CommonDataBoundControl.OnPreRender(EventArgs)

    RaisePostBackEvent(String)

    Declaration
    public void RaisePostBackEvent(string EventArgument)
    Parameters
    Type Name Description
    System.String EventArgument

    Render()

    Renders the instance of ReportDesigner.

    Declaration
    public string Render()
    Returns
    Type Description
    System.String

    System.String.

    Render(HtmlTextWriter)

    Renders the control to the specified HTML writer.

    Declaration
    protected override void Render(HtmlTextWriter writer)
    Parameters
    Type Name Description
    System.Web.UI.HtmlTextWriter writer

    The System.Web.UI.HtmlTextWriter object that receives the control content.

    Overrides
    CommonDataBoundControl.Render(HtmlTextWriter)

    SaveViewState()

    Saves any view-state changes that have occurred since the time the page was posted back to the server.

    Declaration
    protected override object SaveViewState()
    Returns
    Type Description
    System.Object

    The control's current view state. If there is no view state associated with the control, this method returns null.

    ShouldSerializeLocale()

    Gets or sets a value that indicates whether the Locale should serialize.

    Declaration
    public bool ShouldSerializeLocale()
    Returns
    Type Description
    System.Boolean

    The method returns a Boolean value.

    ShouldSerializeReportDataExtensions()

    Gets or sets a value that indicates whether the report data extensions should serialize.

    Declaration
    public bool ShouldSerializeReportDataExtensions()
    Returns
    Type Description
    System.Boolean

    The method returns a Boolean value.

    ShouldSerializeReportItemExtensions()

    Gets or sets a value that indicates whether the report item extensions should serialize.

    Declaration
    public bool ShouldSerializeReportItemExtensions()
    Returns
    Type Description
    System.Boolean

    The method returns a Boolean.

    ShouldSerializeReportPath()

    Gets or sets a value that indicates whether the ReportPath should serialize.

    Declaration
    public bool ShouldSerializeReportPath()
    Returns
    Type Description
    System.Boolean

    The method returns a Boolean value.

    ShouldSerializeReportServerUrl()

    Gets or sets a value that indicates whether the ReportServerUrl should serialize.

    Declaration
    public bool ShouldSerializeReportServerUrl()
    Returns
    Type Description
    System.Boolean

    The method returns a Boolean value.

    ShouldSerializeServiceAuthorizationToken()

    Gets or sets a value that indicates whether the ServiceAuthorizationToken should serialize.

    Declaration
    public bool ShouldSerializeServiceAuthorizationToken()
    Returns
    Type Description
    System.Boolean

    The method returns a Boolean value.

    ShouldSerializeServiceUrl()

    Gets or sets a value that indicates whether the ServiceUrl should serialize.

    Declaration
    public bool ShouldSerializeServiceUrl()
    Returns
    Type Description
    System.Boolean

    The method returns a Boolean value.

    ShouldSerializeToolbar()

    Gets or sets a value that indicates whether the toolbar should serialize.

    Declaration
    public bool ShouldSerializeToolbar()
    Returns
    Type Description
    System.Boolean

    The method returns a Boolean value.

    UpdateServerModel(Dictionary<String, Object>)

    Updates the server model.

    Declaration
    public override void UpdateServerModel(Dictionary<string, object> ClientModel)
    Parameters
    Type Name Description
    System.Collections.Generic.Dictionary<System.String, System.Object> ClientModel

    Gets the client model.

    Overrides
    CommonDataBoundControl.UpdateServerModel(Dictionary<String, Object>)

    Implements

    System.Web.UI.IPostBackDataHandler
    System.Web.UI.IUrlResolutionService
    System.Web.UI.INamingContainer
    System.Web.UI.IPostBackEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved