Class

VirtualGridTableViewState

Initializes a new instance of the VirtualGridTableViewState class.

Declaration

public VirtualGridTableViewState(int itemCount, int defaultItemSize, int itemSpacing, bool supportsPaging)

Parameters

Gets a read only collection of all the items pinned at the bottom of the view.

Declaration

public ReadOnlyCollection<int> BottomPinnedItems { get; }

Property Value

Gets or sets the default size of items which have never been resized.

Declaration

public int DefaultItemSize { get; set; }

Property Value

Gets the current DPI scale factor.

Declaration

public SizeF DpiScale { get; }

Property Value

Gets or sets a value indicating whether data is presented in chunks (pages) to the user.

Declaration

public bool EnablePaging { get; set; }

Property Value

Gets or sets the total number of items to be displayed.

Declaration

public int ItemCount { get; set; }

Property Value

Gets or sets the spacing between adjucent items.

Declaration

public int ItemSpacing { get; set; }

Property Value

Gets or sets the index of the page currently presented in the grid.

Declaration

public int PageIndex { get; set; }

Property Value

Gets or sets the number of rows shown per page when paging is enabled.

Declaration

public int PageSize { get; set; }

Property Value

Gets a value indicating whether paging is supported by this instance.

Declaration

public bool SupportsPaging { get; }

Property Value

Gets a read only collection of all the items pinned at the top of the view.

Declaration

public ReadOnlyCollection<int> TopPinnedItems { get; }

Property Value

Gets the total number of pages when paging is enabled.

Declaration

public int TotalPages { get; }

Property Value

Suspends calling UpdateOnItemSizeChanged()

Declaration

public void BeginUpdate()

Fires when the DPI scaling is changed.

Declaration

public virtual void DpiScaleChanged(SizeF scale)

Parameters

Resumes calling UpdateOnItemSizeChanged(), forces an update.

Declaration

public void EndUpdate()

Gets the total offset from the beginning of the items to the top edge of the specified item. The method does not consider if paging is enabled.

Declaration

public int GetItemOffset(int itemIndex)

Parameters

Returns

Gets the scroll offset from the beginning of the items in the current view to the top edge of the specified item. The method considers if paging is enabled.

Declaration

public int GetItemScrollOffset(int itemIndex)

Parameters

Returns

Gets the currently set size of an item with a given index. Checks if the item is pinned or expanded. Return 0 for pinned items and the total expanded size for expanded items.

Declaration

public int GetItemSize(int itemIndex)

Parameters

Returns

Gets the currently set size of an item with a given index. Checks if the item is pinned or expanded. Return 0 for pinned items and the total expanded size for expanded items.

Declaration

public int GetItemSize(int itemIndex, bool checkPinned)

Parameters

Returns

Gets the currently set size of an item with a given index. Checks if the item is pinned or expanded. Return 0 for pinned items and the total expanded size for expanded items.

Declaration

public int GetItemSize(int itemIndex, bool checkPinned, bool checkExpanded)

Parameters

Returns

Returns a read-only collection of the sizes of the item.

Declaration

public ReadOnlyCollection<KeyValuePair<int, int>> GetItemSizes()

Returns

Gets the pin position of the specified item.

Declaration

public PinnedRowPosition GetPinPosition(int itemIndex)

Parameters

Returns

Calculates and returns the scroller position and offset if scrolled down from the bottom of item [startIndex] with [scrollOffset].

Declaration

public int GetScrollDownTarget(int startIndex, int scrollOffset, out int targetIndex)

Parameters

Returns

Calculates and returns the scroller position and offset if scrolled up from the bottom of item [startIndex] with [scrollOffset].

Declaration

public int GetScrollUpTarget(int startIndex, int scrollOffset, out int targetIndex)

Parameters

Returns

Calculates the total size of all items, using the ItemCount, DefaultItemSize, ItemSpacing, and considering the resized items. Used to calculate the maximum for the scrollbar.

Declaration

public int GetTotalItemSize()

Returns

Determines whether the item at the specified index is pinned.

Declaration

public bool IsPinned(int itemIndex)

Parameters

Returns

Fires the event.

Declaration

protected virtual void OnPageIndexChanged()

Fires the event.

Declaration

protected virtual bool OnPageIndexChanging(int oldValue, int newValue)

Parameters

Returns

Declaration

protected virtual void OnPropertyChanged(string propertyName)

Parameters

Resets the collections with sized items.

Declaration

public void Reset()

Resets the size of the item when it is expanded.

Declaration

public void ResetExpandedSize(int itemIndex)

Parameters

Sets the size of the item when it is expanded.

Declaration

public void SetExpandedSize(int itemIndex, int size)

Parameters

Sets a custom size to the item with a given index.

Declaration

public void SetItemSize(int itemIndex, int size)

Parameters

Sets the pin position of the specified item.

Declaration

public void SetPinPosition(int itemIndex, PinnedRowPosition position)

Parameters

Updates the internal structures when the size of an item changes. Needed for proper calculations of scroll offsets. See the description of [partialItemSizes] and [itemSizes] for more info.

Declaration

public void UpdateOnItemSizeChanged()

Occurs after the page index changes.

Declaration

public event EventHandler PageIndexChanged

Event Value

Occurs before the page index changes.

Declaration

public event VirtualGridPageChangingEventHandler PageIndexChanging

Event Value

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Value

Implements INotifyPropertyChanged.PropertyChanged