Class OlapPagedCollectionView

Represents the page view for OlapPager.

Inheritance

System.Object

OlapPagedCollectionView

Implements

System.ComponentModel.ICollectionView

System.Collections.IEnumerable

System.Collections.Specialized.INotifyCollectionChanged

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Shared.Olap

Assembly: Syncfusion.OlapShared.WPF.dll

Syntax

public class OlapPagedCollectionView : ICollectionView, IEnumerable, INotifyCollectionChanged

Constructors

OlapPagedCollectionView()

Initializes a new instance of the OlapPagedCollectionView class.

Declaration

public OlapPagedCollectionView()

OlapPagedCollectionView(Int32, Int32)

Initializes a new instance of the OlapPagedCollectionView class.

Declaration

public OlapPagedCollectionView(int totalItemCount, int pageIndex)

Parameters

Type	Name	Description
System.Int32	totalItemCount	Total item count.
System.Int32	pageIndex	Index of the page.

Properties

CanFilter

Gets a value that indicates whether this view supports filtering via the Filter property.

Declaration

public bool CanFilter { get; }

Property Value

Type
System.Boolean

CanGroup

Gets a value that indicates whether this view supports grouping via the GroupDescriptions property.

Declaration

public bool CanGroup { get; }

Property Value

Type
System.Boolean

CanSort

Gets a value that indicates whether this view supports sorting via the SortDescriptions property.

Declaration

public bool CanSort { get; }

Property Value

Type
System.Boolean

Culture

Gets or sets the cultural info for any operations of the view that may differ by culture, such as sorting.

Declaration

public CultureInfo Culture { get; set; }

Property Value

Type
System.Globalization.CultureInfo

CurrentItem

Gets the current item in the view.

Declaration

public object CurrentItem { get; }

Property Value

Type
System.Object

CurrentPosition

Gets the ordinal position of the CurrentItem within the view.

Declaration

public int CurrentPosition { get; }

Property Value

Type
System.Int32

Filter

Gets or sets a callback used to determine if an item is suitable for inclusion in the view.

Declaration

public Predicate<object> Filter { get; set; }

Property Value

Type
System.Predicate<System.Object>

GroupDescriptions

Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view.

Declaration

public ObservableCollection<GroupDescription> GroupDescriptions { get; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<System.ComponentModel.GroupDescription>

Groups

Gets the top-level groups.

Declaration

public ReadOnlyObservableCollection<object> Groups { get; }

Property Value

Type
System.Collections.ObjectModel.ReadOnlyObservableCollection<System.Object>

IsCurrentAfterLast

Gets a value that indicates whether the CurrentItem of the view is beyond the end of the collection.

Declaration

public bool IsCurrentAfterLast { get; }

Property Value

Type
System.Boolean

IsCurrentBeforeFirst

Gets a value that indicates whether the CurrentItem of the view is beyond the beginning of the collection.

Declaration

public bool IsCurrentBeforeFirst { get; }

Property Value

Type
System.Boolean

IsEmpty

Returns a value that indicates whether the resulting view is empty.

Declaration

public bool IsEmpty { get; }

Property Value

Type
System.Boolean

PageCount

Gets the number of pages dividing total number of records by page size.

Declaration

public int PageCount { get; }

Property Value

Type
System.Int32

PageIndex

Gets or sets index to the page.

Declaration

public int PageIndex { get; set; }

Property Value

Type
System.Int32

PageSize

Gets or sets page size.

Declaration

public int PageSize { get; set; }

Property Value

Type
System.Int32

SortDescriptions

Gets a collection of SortDescription objects that describe how the items in the collection are sorted in the view.

Declaration

public SortDescriptionCollection SortDescriptions { get; }

Property Value

Type
System.ComponentModel.SortDescriptionCollection

SourceCollection

Returns the underlying collection.

Declaration

public IEnumerable SourceCollection { get; }

Property Value

Type
System.Collections.IEnumerable

TotalItemCount

Gets or sets total item count.

Declaration

public int TotalItemCount { get; set; }

Property Value

Type
System.Int32

Methods

Contains(Object)

Returns a value that indicates whether a given item belongs to this collection view.

Declaration

public bool Contains(object item)

Parameters

Type	Name	Description
System.Object	item

Returns

Type
System.Boolean

DeferRefresh()

Enters a defer cycle that you can use to merge changes to the view and delay automatic refresh.

Declaration

public IDisposable DeferRefresh()

Returns

Type
System.IDisposable

GetEnumerator()

Returns an enumerator that iterates through a collection. (Inherited from IEnumerable.)

Declaration

public IEnumerator GetEnumerator()

Returns

Type
System.Collections.IEnumerator

MoveCurrentTo(Object)

Sets the specified item to be the CurrentItem in the view.

Declaration

public bool MoveCurrentTo(object item)

Parameters

Type	Name	Description
System.Object	item

Returns

Type
System.Boolean

MoveCurrentToFirst()

Move from current page to first page.

Declaration

public bool MoveCurrentToFirst()

Returns

Type
System.Boolean

MoveCurrentToLast()

Move from current page to last page.

Declaration

public bool MoveCurrentToLast()

Returns

Type
System.Boolean

MoveCurrentToNext()

Move from current page to next page.

Declaration

public bool MoveCurrentToNext()

Returns

Type
System.Boolean

MoveCurrentToPosition(Int32)

Move from current page to index position page.

Declaration

public bool MoveCurrentToPosition(int pageIndex)

Parameters

Type	Name	Description
System.Int32	pageIndex	The page index.

Returns

Type
System.Boolean

MoveCurrentToPrevious()

Move from current page to previous page.

Declaration

public bool MoveCurrentToPrevious()

Returns

Type
System.Boolean

RaisePageChangedEvent()

Raises the event after page number is changed.

Declaration

protected void RaisePageChangedEvent()

RaisePageChangingEvent(Int32)

Raises the event while changing page number.

Declaration

protected bool RaisePageChangingEvent(int newPageIndex)

Parameters

Type	Name	Description
System.Int32	newPageIndex	New index of the page.

Returns

Type
System.Boolean

Refresh()

Re-creates the view.

Declaration

public void Refresh()

SetPageIndex(Int32)

Sets index of the page.

Declaration

public void SetPageIndex(int pageIndex)

Parameters

Type	Name	Description
System.Int32	pageIndex	Page index.

SetTotalItemCount(Int32)

Sets total item count.

Declaration

public void SetTotalItemCount(int totalItemCount)

Parameters

Type	Name	Description
System.Int32	totalItemCount	Total item count.

Events

CollectionChanged

When implementing this interface, raise this event after the current item has been changed.

Declaration

public event NotifyCollectionChangedEventHandler CollectionChanged

Event Type

Type
System.Collections.Specialized.NotifyCollectionChangedEventHandler

CurrentChanged

When implementing this interface, raise this event after the current item has been changed.

Declaration

public event EventHandler CurrentChanged

Event Type

Type
System.EventHandler

CurrentChanging

When implementing this interface, raise this event before changing the current item. Event handler can cancel this event.

Declaration

public event CurrentChangingEventHandler CurrentChanging

Event Type

Type
System.ComponentModel.CurrentChangingEventHandler

Implements

System.ComponentModel.ICollectionView

System.Collections.IEnumerable

System.Collections.Specialized.INotifyCollectionChanged