Class OlapGridBase

OlapGrid Renderer

Inheritance
System.Object
VisualContainer
ScrollControl
ScrollAxisControl
VirtualizingCellsControl
GridControlBase
OlapGridBase
Implements
System.Windows.Controls.Primitives.IScrollInfo
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.Grid.Olap
Assembly: Syncfusion.OlapGrid.WPF.dll
Syntax
public class OlapGridBase : GridControlBase, IScrollBarProvider, IScrollInfo, IDisposable, IGridPrintPaginator

Constructors

OlapGridBase()

Initializes a new instance of the OlapGridBase class.

Declaration
public OlapGridBase()

Fields

EngineProperty

Using a DependencyProperty as the backing store for Engine. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty EngineProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

AllowSelection

Gets or sets a value indicating whether [allow selection].

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

true if [allow selection]; otherwise, false.

ColumnHeaderStyle

Gets or sets the column header style.

Declaration
public OlapGridCellStyle ColumnHeaderStyle { get; set; }
Property Value
Type Description
OlapGridCellStyle

The column header style.

DataManager

Gets or sets the data manager.

Declaration
public OlapDataManager DataManager { get; set; }
Property Value
Type Description
OlapDataManager

The data manager.

Engine

Gets or sets the Engine for OlapGridBase.

Declaration
public PivotEngine Engine { get; set; }
Property Value
Type Description
PivotEngine

The engine.

FreezeHeaders

Gets or sets a value indicating whether header cells are freezed

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

true if ; otherwise, false.
Remarks

This property enable you to freeze or unfreeze the header cells

GridLineStroke

Gets or sets the GridLineStroke.

Declaration
public Brush GridLineStroke { get; set; }
Property Value
Type Description
System.Windows.Media.Brush

The GridLineStroke.

GridLineThickness

Gets or sets the border thickness of a control.

Declaration
public double GridLineThickness { get; set; }
Property Value
Type
System.Double

Layout

Gets or sets the layout of the OlapGrid.

Declaration
public GridLayout Layout { get; set; }
Property Value
Type Description
GridLayout

The layout.

Model

Gets or sets the model.

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

The model.

PagingInfo

Gets or sets the paging info.

Declaration
public PagingInfo PagingInfo { get; set; }
Property Value
Type Description
PagingInfo

The paging info.

ResizeColumnsToFit

Gets or sets a value indicating whether to Resize columns to fit.

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

true if [resize columns to fit]; otherwise, false.

ResizeRowsToFit

Gets or sets a value indicating whether to Resize rows to fit.

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

true if [resize rows to fit]; otherwise, false.

RowHeaderStyle

Gets or sets the row header style.

Declaration
public OlapGridCellStyle RowHeaderStyle { get; set; }
Property Value
Type Description
OlapGridCellStyle

The row header style.

ShowGrandTotals

Gets or sets a value indicating whether to show or hide the grand total values.

Declaration
public bool ShowGrandTotals { get; set; }
Property Value
Type
System.Boolean

ShowHeaderCellsToolTip

Gets or sets a value indicating whether [show header cells tool tip].

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

true if [show header cells tool tip]; otherwise, false.

ShowHeadersOnEachPage

Gets or sets a value indicating whether [show headers on each page].

Declaration
public bool ShowHeadersOnEachPage { set; }
Property Value
Type Description
System.Boolean

true if [show headers on each page]; otherwise, false.

ShowMemberPropertiesToolTip

Gets or sets a value indicating whether [show member properties tool tip].

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

true if [show member properties tool tip]; otherwise, false.

ShowValueCellToolTip

Gets or sets a value indicating whether [show value cells tool tip].

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

true if [show value cells tool tip]; otherwise, false.

SummaryColumnStyle

Gets or sets the summary column style.

Declaration
public OlapGridCellStyle SummaryColumnStyle { get; set; }
Property Value
Type Description
OlapGridCellStyle

The summary column style.

SummaryRowStyle

Gets or sets the summary row style.

Declaration
public OlapGridCellStyle SummaryRowStyle { get; set; }
Property Value
Type Description
OlapGridCellStyle

The summary row style.

TotalNumberOfPages

Gets or sets the total number of pages.

Declaration
public int TotalNumberOfPages { get; set; }
Property Value
Type Description
System.Int32

The total number of pages.

ValueCellStyle

Gets or sets the value cells style.

Declaration
public OlapGridCellStyle ValueCellStyle { get; set; }
Property Value
Type Description
OlapGridCellStyle

The value cells style.

ValueCellTextAlignment

Gets or sets the value cell text alignment.

Declaration
public HorizontalAlignment ValueCellTextAlignment { get; set; }
Property Value
Type Description
System.Windows.HorizontalAlignment

The value cell text alignment.

Methods

DataBind()

Binds the data and renders the OlapGrid

Declaration
public void DataBind()

DataBind(PivotEngine)

Binds the data to Engine of OlapGridBase.

Declaration
public void DataBind(PivotEngine engine)
Parameters
Type Name Description
PivotEngine engine

The engine.

MoveTo(Int32)

Moves to the specific page.

Declaration
public void MoveTo(int pageNumber)
Parameters
Type Name Description
System.Int32 pageNumber

The page number.

OnEngineChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Calling method when [Engine changed]

Declaration
public static void OnEngineChanged(DependencyObject dependencyObject, DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyObject dependencyObject

OlapGridBase
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnRenderBorder(DrawingContext, Rect, Rect, CellBorderSide, Pen)

Override the OnRenderBorder call to add a border to the panel.

Declaration
protected override void OnRenderBorder(DrawingContext dc, Rect cellRect, Rect clipRect, CellBorderSide borderSide, Pen pen)
Parameters
Type Name Description
System.Windows.Media.DrawingContext dc

The drawing instructions for a specific element.
System.Windows.Rect cellRect

The width, height and location to render.
System.Windows.Rect clipRect

The width, height and location to clip.
CellBorderSide borderSide

The border side.
System.Windows.Media.Pen pen

The pen
Overrides

OnResizingColumns(GridResizingColumnsEventArgs)

Raises the ResizingColumns event.

Declaration
protected override void OnResizingColumns(GridResizingColumnsEventArgs args)
Parameters
Type Name Description
GridResizingColumnsEventArgs args

The GridResizingColumnsEventArgs instance containing the event data.
Overrides

OnResizingRows(GridResizingRowsEventArgs)

Raises the ResizingRows event.

Declaration
protected override void OnResizingRows(GridResizingRowsEventArgs args)
Parameters
Type Name Description
GridResizingRowsEventArgs args

The GridResizingRowsEventArgs instance containing the event data.
Overrides

Events

AfterRefresh

Event triggers before refreshing the data

Declaration
public event OlapGridDrillDownEventHander AfterRefresh
Event Type
Type
OlapGridDrillDownEventHander

BeforeRefresh

Event triggers after refreshing the data

Declaration
public event OlapGridDrillDownEventHander BeforeRefresh
Event Type
Type
OlapGridDrillDownEventHander

LinkClick

Event triggers when the hyperlink cell is been clicked

Declaration
public event LinkLabelClickEventHander LinkClick
Event Type
Type
LinkLabelClickEventHander

RefreshCompleted

Event triggers after refreshing the grid.

Declaration
public event RefreshCompletedEventHandler RefreshCompleted
Event Type
Type
RefreshCompletedEventHandler

Implements

System.Windows.Controls.Primitives.IScrollInfo
System.IDisposable

Extension Methods