Class OlapDataManager

Manages all data related operations and communicate the Client (UI controls) and Server (WCF Service).

Inheritance

System.Object

OlapDataManager

Implements

System.IDisposable

Namespace: Syncfusion.Olap.UWP.Manager

Assembly: Syncfusion.Olap.UWP.dll

Syntax

public class OlapDataManager : DependencyObject, IDisposable

Constructors

OlapDataManager()

Initializes a new instance of the OlapDataManager class.

Declaration

public OlapDataManager()

Properties

AllowMdxToOlapReportParsing

Gets or sets a value indicating whether the MDX query must be parsed as OLAP Report.

Declaration

public bool AllowMdxToOlapReportParsing { get; set; }

Property Value

Type	Description
System.Boolean	true if the MDX query is parsed as OLAP report; otherwise, false.

ConnectionString

Gets or sets the connection string.

Declaration

public string ConnectionString { get; set; }

Property Value

Type	Description
System.String	The connection string.

Counts

Gets or sets the counts.

Declaration

public SerializableDictionary<string, int> Counts { get; set; }

Property Value

Type
SerializableDictionary<System.String, System.Int32>

Cubes

Gets or sets the collection of cube information.

Declaration

public CubeInfoCollection Cubes { get; set; }

Property Value

Type	Description
CubeInfoCollection	The collection of cube information.

CurrentCellSet

Gets or sets the current cell set.

Declaration

public CellSet CurrentCellSet { get; set; }

Property Value

Type
CellSet

CurrentCubeName

Gets or sets the name of the current cube.

Declaration

public string CurrentCubeName { get; set; }

Property Value

Type
System.String

CurrentCubeSchema

Gets or sets the current cube schema.

Declaration

public CubeSchema CurrentCubeSchema { get; set; }

Property Value

Type	Description
CubeSchema	The current cube schema.

CurrentReport

Gets or sets the current OLAP report.

Declaration

public OlapReport CurrentReport { get; set; }

Property Value

Type
OlapReport

DragDropManager

Gets or sets the drag drop manager.

Declaration

public DragDropManager DragDropManager { get; set; }

Property Value

Type	Description
DragDropManager	The drag drop manager.

IsCurrentReportModified

Gets or sets a value indicating whether the current report is modified.

Declaration

public bool IsCurrentReportModified { get; set; }

Property Value

Type	Description
System.Boolean	true if the current report is modified; otherwise, false.

IsProcessing

Gets or sets a value indicating whether this instance is processing.

Declaration

public bool IsProcessing { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is processing; otherwise, false.

ItemSource

Gets or sets the items source.

Declaration

public object ItemSource { get; set; }

Property Value

Type
System.Object

JSONData

Gets or sets the JSON serialized cell set.

Declaration

public string JSONData { get; set; }

Property Value

Type
System.String

Layout

Gets the layout that is used to generate the pivot engine.

Declaration

public GridLayout Layout { get; }

Property Value

Type
GridLayout

MdxQuery

Gets or sets the MDX query.

Declaration

public string MdxQuery { get; set; }

Property Value

Type	Description
System.String	The MDX query.

PivotEngine

Gets or sets the pivot engine.

Declaration

public PivotEngine PivotEngine { get; set; }

Property Value

Type
PivotEngine

Properties

Gets or sets the collection of properties.

Declaration

public PropertyCollection Properties { get; set; }

Property Value

Type	Description
PropertyCollection	The collection of properties.

ProviderName

Gets or sets the name of the provider.

Declaration

public Providers ProviderName { get; set; }

Property Value

Type	Description
Providers	The name of the provider.

RelationalDataSortOrder

Gets or sets the sorting order of relational data.

Declaration

public SortType RelationalDataSortOrder { get; set; }

Property Value

Type	Description
SortType	The sorting order of relational data.

ReportList

Gets or sets the collection of OLAP reports.

Declaration

public OlapReportCollection ReportList { get; set; }

Property Value

Type	Description
OlapReportCollection	The collection of OLAP reports.

ShowLevelTypeAll

Gets or sets a value indicating whether to show level type "All".

Declaration

public bool ShowLevelTypeAll { get; set; }

Property Value

Type
System.Boolean

UseWhereClauseForSlicing

Gets or sets indicating whether to slice data using "Where" and "Select" clauses.

Declaration

public bool UseWhereClauseForSlicing { get; set; }

Property Value

Type
System.Boolean

VirtualKpiElements

Gets or sets the collection of virtual KPI elements.

Declaration

public Items VirtualKpiElements { get; set; }

Property Value

Type
Items

Methods

add_AxisElementChanged(AxisElementChangedEventHandler)

Declaration

public void add_AxisElementChanged(AxisElementChangedEventHandler value)

Parameters

Type	Name	Description
AxisElementChangedEventHandler	value

add_CellSetChanged(CellSetChangedEventHandler)

Declaration

public void add_CellSetChanged(CellSetChangedEventHandler value)

Parameters

Type	Name	Description
CellSetChangedEventHandler	value

add_CellSetChanging(CellSetChangingEventHandler)

Declaration

public void add_CellSetChanging(CellSetChangingEventHandler value)

Parameters

Type	Name	Description
CellSetChangingEventHandler	value

add_ChildMembersObtained(ChildMembersObtainedHandler)

Declaration

public void add_ChildMembersObtained(ChildMembersObtainedHandler value)

Parameters

Type	Name	Description
ChildMembersObtainedHandler	value

add_CubeChanged(CubeChangedEventHandler)

Declaration

public void add_CubeChanged(CubeChangedEventHandler value)

Parameters

Type	Name	Description
CubeChangedEventHandler	value

add_CubeInfoCollectionChanged(CubeInfoCollectionChangedEventHandler)

Declaration

public void add_CubeInfoCollectionChanged(CubeInfoCollectionChangedEventHandler value)

Parameters

Type	Name	Description
CubeInfoCollectionChangedEventHandler	value

add_CubeSchemaChanged(CubeSchemaChangedEventHandler)

Declaration

public void add_CubeSchemaChanged(CubeSchemaChangedEventHandler value)

Parameters

Type	Name	Description
CubeSchemaChangedEventHandler	value

add_ExecuteDrillThroughQuery(ExecuteDrillThroughQueryEventHandler)

Declaration

public void add_ExecuteDrillThroughQuery(ExecuteDrillThroughQueryEventHandler value)

Parameters

Type	Name	Description
ExecuteDrillThroughQueryEventHandler	value

add_GetChildMembers(GetChildMembersEventHandler)

Declaration

public void add_GetChildMembers(GetChildMembersEventHandler value)

Parameters

Type	Name	Description
GetChildMembersEventHandler	value

add_GetChildrenByMDX(GetChildrenByMDXEventHandler)

Declaration

public void add_GetChildrenByMDX(GetChildrenByMDXEventHandler value)

Parameters

Type	Name	Description
GetChildrenByMDXEventHandler	value

add_GetCubeInfoCollection(GetCubeInfoCollectionEventHandler)

Declaration

public void add_GetCubeInfoCollection(GetCubeInfoCollectionEventHandler value)

Parameters

Type	Name	Description
GetCubeInfoCollectionEventHandler	value

add_GetCubeSchema(GetCubeSchemaEventHandler)

Declaration

public void add_GetCubeSchema(GetCubeSchemaEventHandler value)

Parameters

Type	Name	Description
GetCubeSchemaEventHandler	value

add_GetExecuteMemberCount(GetExecuteMemberCountEventHandler)

Declaration

public void add_GetExecuteMemberCount(GetExecuteMemberCountEventHandler value)

Parameters

Type	Name	Description
GetExecuteMemberCountEventHandler	value

add_GetLevelMembersUsingMdx(GetLevelMembersUsingMdxEventHandler)

Declaration

public void add_GetLevelMembersUsingMdx(GetLevelMembersUsingMdxEventHandler value)

Parameters

Type	Name	Description
GetLevelMembersUsingMdxEventHandler	value

add_GetMeasureGroupsDimensions(GetMeasureGroupsDimensionsEventHandler)

Declaration

public void add_GetMeasureGroupsDimensions(GetMeasureGroupsDimensionsEventHandler value)

Parameters

Type	Name	Description
GetMeasureGroupsDimensionsEventHandler	value

add_GetOlapDataWithTotalCount(GetOlapReportWithTotalCountEventHandler)

Declaration

public void add_GetOlapDataWithTotalCount(GetOlapReportWithTotalCountEventHandler value)

Parameters

Type	Name	Description
GetOlapReportWithTotalCountEventHandler	value

add_GetParentMember(ParentMemberEventHandler)

Declaration

public void add_GetParentMember(ParentMemberEventHandler value)

Parameters

Type	Name	Description
ParentMemberEventHandler	value

add_LevelMembersObtained(LevelMembersObtainedHandler)

Declaration

public void add_LevelMembersObtained(LevelMembersObtainedHandler value)

Parameters

Type	Name	Description
LevelMembersObtainedHandler	value

add_MdxQueryObtained(MdxQueryObtainedEventHandler)

Declaration

public void add_MdxQueryObtained(MdxQueryObtainedEventHandler value)

Parameters

Type	Name	Description
MdxQueryObtainedEventHandler	value

add_OlapDataChanged(OlapDataChangedEventHandler)

Declaration

public void add_OlapDataChanged(OlapDataChangedEventHandler value)

Parameters

Type	Name	Description
OlapDataChangedEventHandler	value

add_ReportChanged(ReportChangedEventHandler)

Declaration

public void add_ReportChanged(ReportChangedEventHandler value)

Parameters

Type	Name	Description
ReportChangedEventHandler	value

AddReport(OlapReport)

Adds the specified OLAP report.

Declaration

public void AddReport(OlapReport olapReport)

Parameters

Type	Name	Description
OlapReport	olapReport	The OLAP Report.

BuildDrillThroughQuery(PivotCellDescriptor, String)

Builds the drill through query.

Declaration

public string BuildDrillThroughQuery(PivotCellDescriptor cellDescriptor, string drillThroughHierarchies)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	The cell descriptor.
System.String	drillThroughHierarchies	Hierarchies which have to included in drill through query.

Returns

Type	Description
System.String	The drill through query.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

ExecuteOlapTable(CellSet)

Generates the pivot engine for the given cell set.

Declaration

public PivotEngine ExecuteOlapTable(CellSet cellSet)

Parameters

Type	Name	Description
CellSet	cellSet	The cell set.

Returns

Type	Description
PivotEngine	The pivot engine.

ExecuteOlapTable(CellSet, GridLayout)

Generates the pivot engine for SASS Data by passing the cell set and layout.

Declaration

public virtual PivotEngine ExecuteOlapTable(CellSet cellSet, GridLayout layout)

Parameters

Type	Name	Description
CellSet	cellSet	The cell set.
GridLayout	layout	The layout.

Returns

Type	Description
PivotEngine	The pivot engine.

ExecuteOlapTable(GridLayout)

Executes the OLAP table.

Declaration

public virtual PivotEngine ExecuteOlapTable(GridLayout layout)

Parameters

Type	Name	Description
GridLayout	layout	The layout.

Returns

Type	Description
PivotEngine	The pivot engine.

GetMdxQuery()

Gets the MDX query for current report of data manager.

Declaration

public string GetMdxQuery()

Returns

Type
System.String

GetMdxQuery(OlapReport)

Gets the MDX query for specified report.

Declaration

public string GetMdxQuery(OlapReport report)

Parameters

Type	Name	Description
OlapReport	report	The OLAP report.

Returns

Type
System.String

GetPositionsInfo(PivotCellDescriptor)

Gets the position information.

Declaration

public List<PositionInfo> GetPositionsInfo(PivotCellDescriptor cellDescriptor)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	The cell descriptor.

Returns

Type	Description
System.Collections.Generic.List<PositionInfo>	A collection of PositionInfo.

LoadReportFromStream(Stream)

Loads the OLAP report from the specified stream.

Declaration

public void LoadReportFromStream(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream.

NotifyCellSetChanged()

Notifies the cell set changed event.

Declaration

public void NotifyCellSetChanged()

NotifyElementChanged()

Notifies the element changed event.

Declaration

public void NotifyElementChanged()

NotifyElementChanged(AxisPosition)

Notifies the element changed event in particular axis.

Declaration

public void NotifyElementChanged(AxisPosition axis)

Parameters

Type	Name	Description
AxisPosition	axis	The axis position.

NotifyOlapDataChanged()

Notifies the OLAP data changed event.

Declaration

public void NotifyOlapDataChanged()

NotifyReportChanged()

Notifies the current report changed event.

Declaration

public void NotifyReportChanged()

NotifyReportChanged(OlapReport)

Notifies when the specified report gets changed.

Declaration

public void NotifyReportChanged(OlapReport currentReport)

Parameters

Type	Name	Description
OlapReport	currentReport	The current report.

OnAxisElementChanged(Object, AxisElementChangedEventArgs)

Called when the axis element gets changed.

Declaration

protected virtual void OnAxisElementChanged(object sender, AxisElementChangedEventArgs e)

Parameters

Type	Name	Description
System.Object	sender	The sender.
AxisElementChangedEventArgs	e	The AxisElementChangedEventArgs instance containing the event data.

RaiseChildMembersObtained(ChildMembersObtainedEventArgs)

Raises the ChildMembersObtained event.

Declaration

public void RaiseChildMembersObtained(ChildMembersObtainedEventArgs args)

Parameters

Type	Name	Description
ChildMembersObtainedEventArgs	args	The data for the event.

RaiseExecuteCount(GetOlapDataWithTotalCountEventArgs)

Raises the GetOlapDataWithTotalCount event to get the valid elements counts for paging.

Declaration

public void RaiseExecuteCount(GetOlapDataWithTotalCountEventArgs args)

Parameters

Type	Name	Description
GetOlapDataWithTotalCountEventArgs	args	The GetOlapDataWithTotalCountEventArgs contains the event data.

RaiseExecuteDrillThroughQuery(ExecuteDrillThroughQueryEventArgs)

Raises the ExecuteDrillThroughQuery event.

Declaration

public Dictionary<string, string> RaiseExecuteDrillThroughQuery(ExecuteDrillThroughQueryEventArgs args)

Parameters

Type	Name	Description
ExecuteDrillThroughQueryEventArgs	args	The data for the event.

Returns

Type
System.Collections.Generic.Dictionary<System.String, System.String>

RaiseExecuteMemberCount(GetExecuteMemberCountEventArgs)

Raises the GetExecuteMemberCount event.

Declaration

public int RaiseExecuteMemberCount(GetExecuteMemberCountEventArgs args)

Parameters

Type	Name	Description
GetExecuteMemberCountEventArgs	args	The data for the event.

Returns

Type
System.Int32

RaiseGetChildMembers(GetChildMembersEventArgs)

Raises the GetChildMembers event.

Declaration

public MemberCollection RaiseGetChildMembers(GetChildMembersEventArgs args)

Parameters

Type	Name	Description
GetChildMembersEventArgs	args	The data for the event.

Returns

Type
MemberCollection

RaiseGetChildrenByMDX(GetChildrenByMDXEventArgs)

Raises the GetChildrenByMDX event.

Declaration

public MemberCollection RaiseGetChildrenByMDX(GetChildrenByMDXEventArgs args)

Parameters

Type	Name	Description
GetChildrenByMDXEventArgs	args	The data for the event.

Returns

Type
MemberCollection

RaiseGetCubeInfoCollectionChanged(GetCubeInfoCollectionEventArgs)

Raises the GetCubeInfoCollection event.

Declaration

public void RaiseGetCubeInfoCollectionChanged(GetCubeInfoCollectionEventArgs args)

Parameters

Type	Name	Description
GetCubeInfoCollectionEventArgs	args	The data for the event.

RaiseGetCubeSchema(GetCubeSchemaEventArgs)

Raises the GetCubeSchema event.

Declaration

public CubeSchema RaiseGetCubeSchema(GetCubeSchemaEventArgs args)

Parameters

Type	Name	Description
GetCubeSchemaEventArgs	args	The data for the event.

Returns

Type
CubeSchema

RaiseGetLevelMembersUsingMdx(GetLevelMembersUsingMdxEventArgs)

Raises the GetLevelMembersUsingMdx event.

Declaration

public MemberCollection RaiseGetLevelMembersUsingMdx(GetLevelMembersUsingMdxEventArgs args)

Parameters

Type	Name	Description
GetLevelMembersUsingMdxEventArgs	args	The data for the event.

Returns

Type
MemberCollection

RaiseGetMeasureGroupsDimensions(GetMeasureGroupsDimensionsEventArgs)

Triggered when the specific dimension names of selected measure group is needed.

Declaration

public List<string> RaiseGetMeasureGroupsDimensions(GetMeasureGroupsDimensionsEventArgs args)

Parameters

Type	Name	Description
GetMeasureGroupsDimensionsEventArgs	args	The GetMeasureGroupsDimensionsEventArgs contains the event data.

Returns

Type	Description
System.Collections.Generic.List<System.String>	A list of dimension element names.

RaiseGetOlapDataWithTotalCount(GetOlapDataWithTotalCountEventArgs)

Raises the ChildMembersObtained event.

Declaration

public void RaiseGetOlapDataWithTotalCount(GetOlapDataWithTotalCountEventArgs args)

Parameters

Type	Name	Description
GetOlapDataWithTotalCountEventArgs	args

RaiseGetParentMember(Object, ParentMemberEventArgs)

Raises the event GetParentMember event.

Declaration

public Member RaiseGetParentMember(object sender, ParentMemberEventArgs args)

Parameters

Type	Name	Description
System.Object	sender	The OlapDataManager instance.
ParentMemberEventArgs	args	The ParentMemberEventArgs contains the event data.

Returns

Type	Description
Member	The parent member.

RaiseLevelMembersObtained(LevelMembersObtainedEventArgs)

Raises the LevelMembersObtained event.

Declaration

public void RaiseLevelMembersObtained(LevelMembersObtainedEventArgs args)

Parameters

Type	Name	Description
LevelMembersObtainedEventArgs	args	The data for the event.

RaiseOlapDataChanged(OlapDataChangedEventArgs)

Raises the OlapDataChanged event.

Declaration

public void RaiseOlapDataChanged(OlapDataChangedEventArgs args)

Parameters

Type	Name	Description
OlapDataChangedEventArgs	args	The data for the event.

RefreshAxisElementBuilder()

Refreshes the axis element builder.

Declaration

public void RefreshAxisElementBuilder()

remove_AxisElementChanged(AxisElementChangedEventHandler)

Declaration

public void remove_AxisElementChanged(AxisElementChangedEventHandler value)

Parameters

Type	Name	Description
AxisElementChangedEventHandler	value

remove_CellSetChanged(CellSetChangedEventHandler)

Declaration

public void remove_CellSetChanged(CellSetChangedEventHandler value)

Parameters

Type	Name	Description
CellSetChangedEventHandler	value

remove_CellSetChanging(CellSetChangingEventHandler)

Declaration

public void remove_CellSetChanging(CellSetChangingEventHandler value)

Parameters

Type	Name	Description
CellSetChangingEventHandler	value

remove_ChildMembersObtained(ChildMembersObtainedHandler)

Declaration

public void remove_ChildMembersObtained(ChildMembersObtainedHandler value)

Parameters

Type	Name	Description
ChildMembersObtainedHandler	value

remove_CubeChanged(CubeChangedEventHandler)

Declaration

public void remove_CubeChanged(CubeChangedEventHandler value)

Parameters

Type	Name	Description
CubeChangedEventHandler	value

remove_CubeInfoCollectionChanged(CubeInfoCollectionChangedEventHandler)

Declaration

public void remove_CubeInfoCollectionChanged(CubeInfoCollectionChangedEventHandler value)

Parameters

Type	Name	Description
CubeInfoCollectionChangedEventHandler	value

remove_CubeSchemaChanged(CubeSchemaChangedEventHandler)

Declaration

public void remove_CubeSchemaChanged(CubeSchemaChangedEventHandler value)

Parameters

Type	Name	Description
CubeSchemaChangedEventHandler	value

remove_ExecuteDrillThroughQuery(ExecuteDrillThroughQueryEventHandler)

Declaration

public void remove_ExecuteDrillThroughQuery(ExecuteDrillThroughQueryEventHandler value)

Parameters

Type	Name	Description
ExecuteDrillThroughQueryEventHandler	value

remove_GetChildMembers(GetChildMembersEventHandler)

Declaration

public void remove_GetChildMembers(GetChildMembersEventHandler value)

Parameters

Type	Name	Description
GetChildMembersEventHandler	value

remove_GetChildrenByMDX(GetChildrenByMDXEventHandler)

Declaration

public void remove_GetChildrenByMDX(GetChildrenByMDXEventHandler value)

Parameters

Type	Name	Description
GetChildrenByMDXEventHandler	value

remove_GetCubeInfoCollection(GetCubeInfoCollectionEventHandler)

Declaration

public void remove_GetCubeInfoCollection(GetCubeInfoCollectionEventHandler value)

Parameters

Type	Name	Description
GetCubeInfoCollectionEventHandler	value

remove_GetCubeSchema(GetCubeSchemaEventHandler)

Declaration

public void remove_GetCubeSchema(GetCubeSchemaEventHandler value)

Parameters

Type	Name	Description
GetCubeSchemaEventHandler	value

remove_GetExecuteMemberCount(GetExecuteMemberCountEventHandler)

Declaration

public void remove_GetExecuteMemberCount(GetExecuteMemberCountEventHandler value)

Parameters

Type	Name	Description
GetExecuteMemberCountEventHandler	value

remove_GetLevelMembersUsingMdx(GetLevelMembersUsingMdxEventHandler)

Declaration

public void remove_GetLevelMembersUsingMdx(GetLevelMembersUsingMdxEventHandler value)

Parameters

Type	Name	Description
GetLevelMembersUsingMdxEventHandler	value

remove_GetMeasureGroupsDimensions(GetMeasureGroupsDimensionsEventHandler)

Declaration

public void remove_GetMeasureGroupsDimensions(GetMeasureGroupsDimensionsEventHandler value)

Parameters

Type	Name	Description
GetMeasureGroupsDimensionsEventHandler	value

remove_GetOlapDataWithTotalCount(GetOlapReportWithTotalCountEventHandler)

Declaration

public void remove_GetOlapDataWithTotalCount(GetOlapReportWithTotalCountEventHandler value)

Parameters

Type	Name	Description
GetOlapReportWithTotalCountEventHandler	value

remove_GetParentMember(ParentMemberEventHandler)

Declaration

public void remove_GetParentMember(ParentMemberEventHandler value)

Parameters

Type	Name	Description
ParentMemberEventHandler	value

remove_LevelMembersObtained(LevelMembersObtainedHandler)

Declaration

public void remove_LevelMembersObtained(LevelMembersObtainedHandler value)

Parameters

Type	Name	Description
LevelMembersObtainedHandler	value

remove_MdxQueryObtained(MdxQueryObtainedEventHandler)

Declaration

public void remove_MdxQueryObtained(MdxQueryObtainedEventHandler value)

Parameters

Type	Name	Description
MdxQueryObtainedEventHandler	value

remove_OlapDataChanged(OlapDataChangedEventHandler)

Declaration

public void remove_OlapDataChanged(OlapDataChangedEventHandler value)

Parameters

Type	Name	Description
OlapDataChangedEventHandler	value

remove_ReportChanged(ReportChangedEventHandler)

Declaration

public void remove_ReportChanged(ReportChangedEventHandler value)

Parameters

Type	Name	Description
ReportChangedEventHandler	value

SaveReport(Stream)

Saves the current report in the specified file path.

Declaration

public void SaveReport(Stream filePath)

Parameters

Type	Name	Description
System.IO.Stream	filePath	The file path.

SetCurrentReport(OlapReport)

Sets the current OLAP report with the given OLAP report.

Declaration

public void SetCurrentReport(OlapReport report)

Parameters

Type	Name	Description
OlapReport	report	The OLAP report.

ToggleExpandableState(PivotCellDescriptor)

Toggles the expandable state.

Declaration

public bool ToggleExpandableState(PivotCellDescriptor cellDescriptor)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	The cell descriptor.

Returns

Type	Description
System.Boolean	The expanded state as the type of boolean.

ToggleExpandableState(PivotCellDescriptor, GridLayout)

Toggles the expandable state.

Declaration

public PivotEngine ToggleExpandableState(PivotCellDescriptor cellDescriptor, GridLayout gridLayout)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	The cell descriptor.
GridLayout	gridLayout	The grid layout.

Returns

Type	Description
PivotEngine	The pivot engine.

ToggleExpandableState(PivotCellDescriptorType, Member)

Toggles the expandable state.

Declaration

public bool ToggleExpandableState(PivotCellDescriptorType cellType, Member member)

Parameters

Type	Name	Description
PivotCellDescriptorType	cellType	The cell type.
Member	member	The member.

Returns

Type	Description
System.Boolean	The expanded state as the type of boolean.

ToggleExpandableState(PivotCellDescriptorType, Member, Boolean)

Toggles the expandable state.

Declaration

public bool ToggleExpandableState(PivotCellDescriptorType cellType, Member member, bool triggerEvents)

Parameters

Type	Name	Description
PivotCellDescriptorType	cellType	The cell type.
Member	member	The member.
System.Boolean	triggerEvents	Indicates whether to trigger events.

Returns

Type	Description
System.Boolean	The expanded state as the type of boolean.

ToggleExpandableStateOnDrillPosition(Member, PivotCellDescriptorType, List<PositionInfo>, ExpandableState)

Toggles the expandable state on drill position.

Declaration

public bool ToggleExpandableStateOnDrillPosition(Member member, PivotCellDescriptorType type, List<PositionInfo> positionInfo, ExpandableState state)

Parameters

Type	Name	Description
Member	member	The member.
PivotCellDescriptorType	type	The cell type.
System.Collections.Generic.List<PositionInfo>	positionInfo	The position information.
ExpandableState	state	The expandable state.

Returns

Type	Description
System.Boolean	The expanded state as the type of boolean.

ToggleExpandableStateOnDrillPosition(Member, PivotCellDescriptorType, List<PositionInfo>, ExpandableState, Boolean)

Toggles the expandable state on drill position.

Declaration

public bool ToggleExpandableStateOnDrillPosition(Member member, PivotCellDescriptorType type, List<PositionInfo> positionInfo, ExpandableState state, bool triggerEvents)

Parameters

Type	Name	Description
Member	member	The member.
PivotCellDescriptorType	type	The cell type.
System.Collections.Generic.List<PositionInfo>	positionInfo	The position information.
ExpandableState	state	The expandable state.
System.Boolean	triggerEvents	Indicates whether to trigger events.

Returns

Type	Description
System.Boolean	The expanded state as the type of boolean.

ToggleExpandableStateOnDrillPosition(PivotCellDescriptor)

Toggles the expandable state on drill position.

Declaration

public bool ToggleExpandableStateOnDrillPosition(PivotCellDescriptor cellDescriptor)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	The cell descriptor.

Returns

Type	Description
System.Boolean	The expanded state as the type of boolean.

ToggleExpandableStateOnDrillPosition(PivotCellDescriptor, Member)

Toggles the expandable state on drill position.

Declaration

public bool ToggleExpandableStateOnDrillPosition(PivotCellDescriptor cellDescriptor, Member member)

Parameters

Type	Name	Description
PivotCellDescriptor	cellDescriptor	The cell descriptor.
Member	member	The member.

Returns

Type	Description
System.Boolean	The expanded state as the type of boolean.

Events

AxisElementChanged

Occurs when the axis element gets changed.

Declaration

public event AxisElementChangedEventHandler AxisElementChanged

Event Type

Type
AxisElementChangedEventHandler

CellSetChanged

Occurs when the cell set gets changed.

Declaration

public event CellSetChangedEventHandler CellSetChanged

Event Type

Type
CellSetChangedEventHandler

CellSetChanging

Occurs when the cell set is changing.

Declaration

public event CellSetChangingEventHandler CellSetChanging

Event Type

Type
CellSetChangingEventHandler

ChildMembersObtained

Occurs when the child members are obtained.

Declaration

public event ChildMembersObtainedHandler ChildMembersObtained

Event Type

Type
ChildMembersObtainedHandler

CubeChanged

Occurs when the current cube gets changed.

Declaration

public event CubeChangedEventHandler CubeChanged

Event Type

Type
CubeChangedEventHandler

CubeInfoCollectionChanged

Occurs when the collection of cube information gets changed.

Declaration

public event CubeInfoCollectionChangedEventHandler CubeInfoCollectionChanged

Event Type

Type
CubeInfoCollectionChangedEventHandler

CubeSchemaChanged

Occurs when the cube schema gets changed.

Declaration

public event CubeSchemaChangedEventHandler CubeSchemaChanged

Event Type

Type
CubeSchemaChangedEventHandler

ExecuteDrillThroughQuery

Occurs for getting the drill through data.

Declaration

public event ExecuteDrillThroughQueryEventHandler ExecuteDrillThroughQuery

Event Type

Type
ExecuteDrillThroughQueryEventHandler

GetChildMembers

Occurs for getting the collection of child members.

Declaration

public event GetChildMembersEventHandler GetChildMembers

Event Type

Type
GetChildMembersEventHandler

GetChildrenByMDX

Occurs for getting the collection of child members by using MDX query.

Declaration

public event GetChildrenByMDXEventHandler GetChildrenByMDX

Event Type

Type
GetChildrenByMDXEventHandler

GetCubeInfoCollection

Occurs for getting the collection of cube information.

Declaration

public event GetCubeInfoCollectionEventHandler GetCubeInfoCollection

Event Type

Type
GetCubeInfoCollectionEventHandler

GetCubeSchema

Occurs for getting the cube schema.

Declaration

public event GetCubeSchemaEventHandler GetCubeSchema

Event Type

Type
GetCubeSchemaEventHandler

GetExecuteMemberCount

Occurs for getting the members count of particular level element.

Declaration

public event GetExecuteMemberCountEventHandler GetExecuteMemberCount

Event Type

Type
GetExecuteMemberCountEventHandler

GetLevelMembersUsingMdx

Occurs for getting the level members using Mdx query.

Declaration

public event GetLevelMembersUsingMdxEventHandler GetLevelMembersUsingMdx

Event Type

Type
GetLevelMembersUsingMdxEventHandler

GetMeasureGroupsDimensions

Occurs when specific dimensional elements of a measure group is needed.

Declaration

public event GetMeasureGroupsDimensionsEventHandler GetMeasureGroupsDimensions

Event Type

Type
GetMeasureGroupsDimensionsEventHandler

GetOlapDataWithTotalCount

Occurs for getting the cell set with total count of rows and columns.

Declaration

public event GetOlapReportWithTotalCountEventHandler GetOlapDataWithTotalCount

Event Type

Type
GetOlapReportWithTotalCountEventHandler

GetParentMember

Gets the parent member of a member.

Declaration

public event ParentMemberEventHandler GetParentMember

Event Type

Type
ParentMemberEventHandler

LevelMembersObtained

Occurs when the level members are obtained.

Declaration

public event LevelMembersObtainedHandler LevelMembersObtained

Event Type

Type
LevelMembersObtainedHandler

MdxQueryObtained

Occurs when the MDX query is obtained.

Declaration

public event MdxQueryObtainedEventHandler MdxQueryObtained

Event Type

Type
MdxQueryObtainedEventHandler

OlapDataChanged

Occurs for getting the cell set.

Declaration

public event OlapDataChangedEventHandler OlapDataChanged

Event Type

Type
OlapDataChangedEventHandler

ReportChanged

Occurs when the current report gets changed.

Declaration

public event ReportChangedEventHandler ReportChanged

Event Type

Type
ReportChangedEventHandler

Implements

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)