WPF

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface IOlapDataManager

    Show / Hide Table of Contents

    Interface IOlapDataManager

    Represents the interface for OlapDataManager class.

    Namespace: Syncfusion.Olap.Manager
    Assembly: Syncfusion.Olap.Base.dll
    Syntax
    public interface IOlapDataManager

    Properties

    ConnectionString

    Gets or sets the connection string.

    Declaration
    string ConnectionString { get; set; }
    Property Value
    Type Description
    System.String

    The connection string.

    Culture

    Gets or sets the culture.

    Declaration
    CultureInfo Culture { get; set; }
    Property Value
    Type Description
    System.Globalization.CultureInfo

    The culture.

    CurrentCellSet

    Gets the current cell set.

    Declaration
    CellSet CurrentCellSet { get; }
    Property Value
    Type Description
    CellSet

    The current cell set.

    CurrentCubeName

    Gets or sets the name of the current cube.

    Declaration
    string CurrentCubeName { get; set; }
    Property Value
    Type Description
    System.String

    The name of the current cube.

    CurrentCubeSchema

    Gets or sets the current cube schema.

    Declaration
    CubeSchema CurrentCubeSchema { get; set; }
    Property Value
    Type Description
    CubeSchema

    The current cube schema.

    CurrentReport

    Gets or sets the current report.

    Declaration
    OlapReport CurrentReport { get; set; }
    Property Value
    Type Description
    OlapReport

    The current report.

    DataProvider

    Gets the data provider.

    Declaration
    IDataProvider DataProvider { get; }
    Property Value
    Type Description
    IDataProvider

    The data provider.

    EnableExceptionHandling

    Gets or sets a value to indicate whether the exceptions in OlapDataManager are handled.

    Declaration
    bool EnableExceptionHandling { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsCurrentReportModified

    Gets a value indicating whether this instance is modifying the current report.

    Declaration
    bool IsCurrentReportModified { get; }
    Property Value
    Type Description
    System.Boolean

    IsProcessing

    Gets or sets a value to indicate whether the OlapDataManager is doing any action.

    Declaration
    bool IsProcessing { get; set; }
    Property Value
    Type Description
    System.Boolean

    ItemSource

    Gets or sets the items source.

    Declaration
    object ItemSource { get; set; }
    Property Value
    Type Description
    System.Object

    The items source.

    MdxQuery

    Gets or sets the MDX query.

    Declaration
    string MdxQuery { get; set; }
    Property Value
    Type Description
    System.String

    The MDX query.

    PivotEngine

    Gets the pivot engine.

    Declaration
    PivotEngine PivotEngine { get; }
    Property Value
    Type Description
    PivotEngine

    The pivot engine.

    Properties

    Gets the collection of properties.

    Declaration
    PropertyCollection Properties { get; }
    Property Value
    Type Description
    PropertyCollection

    The collection of properties.

    ReportPath

    Gets the report path.

    Declaration
    string ReportPath { get; }
    Property Value
    Type Description
    System.String

    The report path.

    Reports

    Gets or sets the collection of reports.

    Declaration
    OlapReportCollection Reports { get; set; }
    Property Value
    Type Description
    OlapReportCollection

    The collection of reports.

    Methods

    AddReport(OlapReport)

    Adds the specified OLAP report.

    Declaration
    void AddReport(OlapReport olapReport)
    Parameters
    Type Name Description
    OlapReport olapReport

    The OLAP report to be added.

    AddReport(String)

    Adds the report with specified name.

    Declaration
    void AddReport(string reportName)
    Parameters
    Type Name Description
    System.String reportName

    The name of the report.

    CloneOlapDataManagerElements()

    Clones the elements of OLAP data manager.

    Declaration
    OlapDataManager CloneOlapDataManagerElements()
    Returns
    Type Description
    OlapDataManager

    A OlapDataManager object.

    CloseConnection()

    Closes the connection.

    Declaration
    void CloseConnection()

    ExecuteCellSet()

    Returns the cell set based on the current report or MDX query.

    Declaration
    CellSet ExecuteCellSet()
    Returns
    Type Description
    CellSet

    The cell set after running the MDX query or query specifications.

    ExecuteCellSet(MDXQuerySpecification)

    Executes the cell set.

    Declaration
    CellSet ExecuteCellSet(MDXQuerySpecification querySpecification)
    Parameters
    Type Name Description
    MDXQuerySpecification querySpecification

    The query specification.

    Returns
    Type Description
    CellSet

    The cell set.

    ExecuteCellSet(String)

    Executes the cell set.

    Declaration
    CellSet ExecuteCellSet(string commandText)
    Parameters
    Type Name Description
    System.String commandText

    The command text.

    Returns
    Type Description
    CellSet

    The cell set.

    ExecuteOlapTable()

    Generates a two dimensional representation of pivot engine that is created from the cell set based on the current report.

    Declaration
    PivotEngine ExecuteOlapTable()
    Returns
    Type Description
    PivotEngine

    The pivot engine i.e., a two dimensional representation of the cell set.

    ExecuteOlapTable(CellSet)

    Generates a two dimensional representation of pivot engine that is created from the cell set based on the cell set.

    Declaration
    PivotEngine ExecuteOlapTable(CellSet cellSet)
    Parameters
    Type Name Description
    CellSet cellSet

    The cell set.

    Returns
    Type Description
    PivotEngine

    The pivot engine i.e., a two dimensional representation of the cell set.

    ExecuteOlapTable(CellSet, GridLayout)

    Generates a two dimensional representation of pivot engine that is created from the cell set based on the cell set and the grid layout.

    Declaration
    PivotEngine ExecuteOlapTable(CellSet cellSet, GridLayout layout)
    Parameters
    Type Name Description
    CellSet cellSet

    The cell set.

    GridLayout layout

    The grid layout.

    Returns
    Type Description
    PivotEngine

    The pivot engine i.e., a two dimensional representation of the cell set.

    ExecuteOlapTable(GridLayout)

    Generates a two dimensional representation of pivot engine that is created from the cell set based on the grid layout.

    Declaration
    PivotEngine ExecuteOlapTable(GridLayout layout)
    Parameters
    Type Name Description
    GridLayout layout

    The grid layout.

    Returns
    Type Description
    PivotEngine

    The pivot engine i.e., a two dimensional representation of the cell set.

    ExecuteOlapTable(String)

    Generates a two dimensional representation of pivot engine that is created from the cell set based on the MDX query.

    Declaration
    PivotEngine ExecuteOlapTable(string commandText)
    Parameters
    Type Name Description
    System.String commandText

    The MDX query.

    Returns
    Type Description
    PivotEngine

    The pivot engine i.e., a two dimensional representation of the cell set.

    GetExpandedRows(PivotCellDescriptor)

    Returns the OLAP table with expanded rows only.

    Declaration
    PivotEngine GetExpandedRows(PivotCellDescriptor cellDescriptor)
    Parameters
    Type Name Description
    PivotCellDescriptor cellDescriptor

    Descriptor to get expanded rows.

    Returns
    Type Description
    PivotEngine

    The pivot engine with expanded rows.

    GetReport(String)

    Gets the OLAP report.

    Declaration
    OlapReportCollection GetReport(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    The name of the file.

    Returns
    Type Description
    OlapReportCollection

    The collection of OLAP reports.

    GetReportAsStream()

    Gets the OLAP report as stream.

    Declaration
    Stream GetReportAsStream()
    Returns
    Type Description
    System.IO.Stream

    The report as stream

    LoadOlapDataManager(OlapReport)

    Loads the OLAP data manager.

    Declaration
    void LoadOlapDataManager(OlapReport report)
    Parameters
    Type Name Description
    OlapReport report

    The OLAP report.

    LoadReport(String)

    Loads the OLAP report.

    Declaration
    void LoadReport(string reportName)
    Parameters
    Type Name Description
    System.String reportName

    The name of the report.

    LoadReportDefinitionFile(String)

    Loads the report definition file.

    Declaration
    void LoadReportDefinitionFile(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    The name of the file.

    LoadReportDefinitionFromStream(Stream)

    Loads the report definition from stream.

    Declaration
    void LoadReportDefinitionFromStream(Stream reportStream)
    Parameters
    Type Name Description
    System.IO.Stream reportStream

    The report as stream.

    NotifyElementModified()

    Notifies that the axis element gets modified.

    Declaration
    void NotifyElementModified()

    NotifyElementModified(AxisPosition)

    Notifies that the specified axis element gets modified.

    Declaration
    void NotifyElementModified(AxisPosition axisPosition)
    Parameters
    Type Name Description
    AxisPosition axisPosition

    The axis position.

    NotifyException(Exception)

    Notifies that the specified exception gets thrown.

    Declaration
    void NotifyException(Exception exception)
    Parameters
    Type Name Description
    System.Exception exception

    NotifyReportChanged()

    Notifies that the current report gets changed.

    Declaration
    void NotifyReportChanged()

    NotifyReportChanged(OlapReport)

    Notifies that the specified report get changed.

    Declaration
    void NotifyReportChanged(OlapReport currentReport)
    Parameters
    Type Name Description
    OlapReport currentReport

    The current report.

    RaiseAxisElementModified()

    Raises the event which denotes the modification of axis element.

    Declaration
    void RaiseAxisElementModified()

    RemoveReport(String)

    Removes the OLAP report.

    Declaration
    void RemoveReport(string reportName)
    Parameters
    Type Name Description
    System.String reportName

    The name of the report.

    RenameReport(Int32, String)

    Renames the OLAP report.

    Declaration
    void RenameReport(int index, string newReportName)
    Parameters
    Type Name Description
    System.Int32 index

    The index of the report to be renamed.

    System.String newReportName

    The new name of the report.

    RenameReport(String, String)

    Renames the OLAP report.

    Declaration
    void RenameReport(string oldReportName, string newReportName)
    Parameters
    Type Name Description
    System.String oldReportName

    The old name of the report.

    System.String newReportName

    The new name of the report.

    SaveReport(String)

    Saves the OLAP report.

    Declaration
    void SaveReport(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    The name of the file.

    SetCurrentReport(OlapReport)

    Sets the current report with the specified report.

    Declaration
    void SetCurrentReport(OlapReport report)
    Parameters
    Type Name Description
    OlapReport report

    The OLAP report.

    ToggleAxis(OlapReport)

    Transpose the data between the axis.

    Declaration
    void ToggleAxis(OlapReport olapReport)
    Parameters
    Type Name Description
    OlapReport olapReport

    The current report.

    ToggleExpandableState(PivotCellDescriptor)

    Toggles the expandable state.

    Declaration
    void ToggleExpandableState(PivotCellDescriptor cellDescriptor)
    Parameters
    Type Name Description
    PivotCellDescriptor cellDescriptor

    The cell descriptor.

    ToggleExpandableState(PivotCellDescriptor, GridLayout)

    Toggles the expandable state.

    Declaration
    void ToggleExpandableState(PivotCellDescriptor cellDescriptor, GridLayout gridLayout)
    Parameters
    Type Name Description
    PivotCellDescriptor cellDescriptor

    The cell descriptor.

    GridLayout gridLayout

    The grid layout.

    ToggleExpandableState(PivotCellDescriptorType, Member)

    Toggles the expandable state.

    Declaration
    void ToggleExpandableState(PivotCellDescriptorType cellType, Member member)
    Parameters
    Type Name Description
    PivotCellDescriptorType cellType

    The type of the pivot cell descriptor.

    Member member

    The member.

    ToggleExpandableState(PivotCellDescriptorType, Member, GridLayout)

    Toggles the expandable state.

    Declaration
    void ToggleExpandableState(PivotCellDescriptorType pivotCellDescriptorType, Member member, GridLayout gridLayout)
    Parameters
    Type Name Description
    PivotCellDescriptorType pivotCellDescriptorType

    The type of the pivot cell descriptor.

    Member member

    The member.

    GridLayout gridLayout

    The grid layout.

    ToggleExpandableState(PivotCellDescriptorType, Member, GridLayout, Boolean)

    Toggles the expandable state.

    Declaration
    void ToggleExpandableState(PivotCellDescriptorType cellType, Member member, GridLayout gridLayout, bool triggerEvents)
    Parameters
    Type Name Description
    PivotCellDescriptorType cellType

    Type of the cell.

    Member member

    The member.

    GridLayout gridLayout

    The grid layout.

    System.Boolean triggerEvents

    Indicates whether to trigger events.

    ToggleExpandableState(PivotCellDescriptorType, Member, Boolean)

    Toggles the expandable state.

    Declaration
    void ToggleExpandableState(PivotCellDescriptorType cellType, Member member, bool triggerEvents)
    Parameters
    Type Name Description
    PivotCellDescriptorType cellType

    The type of the pivot cell descriptor.

    Member member

    The member.

    System.Boolean triggerEvents

    Indicates whether to trigger events.

    Events

    ActiveReportChanged

    Occurs when the active report gets changed.

    Declaration
    event ActiveReportChangedEventHandler ActiveReportChanged
    Event Type
    Type Description
    ActiveReportChangedEventHandler

    AxisElementChanged

    Occurs when the axis element gets changed.

    Declaration
    event AxisElementChangedEventHandler AxisElementChanged
    Event Type
    Type Description
    AxisElementChangedEventHandler

    AxisElementModified

    Occurs when the axis element gets modified.

    Declaration
    event AxisElementModifiedEventHandler AxisElementModified
    Event Type
    Type Description
    AxisElementModifiedEventHandler

    CubeChanged

    Occurs when the cube gets changed.

    Declaration
    event CubeChangedEventHandler CubeChanged
    Event Type
    Type Description
    CubeChangedEventHandler

    ReportChanged

    Occurs when the current report gets changed.

    Declaration
    event ReportChangedEventHandler ReportChanged
    Event Type
    Type Description
    ReportChangedEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved