Class PixelScrollAxis

PixelScrollAxis implements scrolling logic for both horizontal and vertical scrolling in a Distances. Logical units in the ScrollAxisBase are called "Lines". With the Distances a line represents rows in a grid and with Distances a line represents columns in a grid.

PixelScrollAxis supports pixel scrolling and calculates the total height or width of all lines.

Inheritance

System.Object

ScrollAxisBase

PixelScrollAxis

Implements

System.IDisposable

Inherited Members

ScrollAxisBase.add_Changed(ScrollChangedEventHandler)

ScrollAxisBase.AnyVisibleLines(Int32, Int32)

ScrollAxisBase.Changed

ScrollAxisBase.Clip

ScrollAxisBase.Dispose()

ScrollAxisBase.FirstFooterLineIndex

ScrollAxisBase.FooterLineCount

ScrollAxisBase.FreezeVisibleLines()

ScrollAxisBase.GetBorderRangeClipPoints(VisibleLineInfo, VisibleLineInfo)

ScrollAxisBase.GetClipPoints(ScrollAxisRegion, Boolean)

ScrollAxisBase.GetLineNearCorner(Double, Double, Boolean)

ScrollAxisBase.GetLineNearCorner(Double, Double, CornerSide, Boolean)

ScrollAxisBase.GetLinesAndVisibility(Int32, Int32, Boolean, Boolean, Boolean, VisibleLineInfo, VisibleLineInfo)

ScrollAxisBase.GetLineSize(Int32)

ScrollAxisBase.GetLineSize(Int32, Int32)

ScrollAxisBase.GetNextPage(Int32)

ScrollAxisBase.GetOriginAndCornerOfBodyRegion(Double, Double)

ScrollAxisBase.GetPreviousPage(Int32)

ScrollAxisBase.GetScrollLinesHostSize(Int32, Int32)

ScrollAxisBase.GetVisibleLineAtLineIndex(Int32)

ScrollAxisBase.GetVisibleLineAtLineIndex(Int32, Boolean)

ScrollAxisBase.GetVisibleLineAtPoint(Double, Boolean, Boolean)

ScrollAxisBase.GetVisibleLines(Boolean)

ScrollAxisBase.GetVisibleLinesClipPoints(Int32, Int32)

ScrollAxisBase.GetVisibleLinesRange(Int32)

ScrollAxisBase.GetVisibleSection(Int32, Int32, Int32)

ScrollAxisBase.GetVisibleSection(ScrollAxisRegion, Int32, Int32)

ScrollAxisBase.HeaderLineCount

ScrollAxisBase.IsFooterVisible

ScrollAxisBase.IsLineVisible(Int32)

ScrollAxisBase.LastBodyVisibleLine

ScrollAxisBase.LastBodyVisibleLineIndex

ScrollAxisBase.MarkDirty()

ScrollAxisBase.Name

ScrollAxisBase.RaiseChanged(ScrollChangedAction)

ScrollAxisBase.remove_Changed(ScrollChangedEventHandler)

ScrollAxisBase.RenderSize

ScrollAxisBase.ResetVisibleLines()

ScrollAxisBase.ScrollBar

ScrollAxisBase.ScrollInView(Int32, Boolean)

ScrollAxisBase.ScrollLinesHost

ScrollAxisBase.ScrollPageSize

ScrollAxisBase.StartLineIndex

ScrollAxisBase.UnfreezeVisibleLines()

ScrollAxisBase.UpdateScrollBar(Boolean)

ScrollAxisBase.ViewCorner

ScrollAxisBase.VisiblePointToLineIndex(Double)

ScrollAxisBase.VisiblePointToLineIndex(Double, Boolean)

Namespace: Syncfusion.GridCommon.ScrollAxis

Assembly: Syncfusion.GridCommon.Portable.dll

Syntax

public class PixelScrollAxis : ScrollAxisBase, IDisposable

Constructors

PixelScrollAxis(IScrollBar, ILineSizeHost, IDistancesHost)

Initializes a new instance of the PixelScrollAxis class.

Declaration

public PixelScrollAxis(IScrollBar scrollBar, ILineSizeHost scrollLinesHost, IDistancesHost distancesHost)

Parameters

Type	Name	Description
IScrollBar	scrollBar	The scrollbar state.
ILineSizeHost	scrollLinesHost	The scroll lines host.
IDistancesHost	distancesHost	The distances host.

PixelScrollAxis(ScrollAxisBase, IScrollBar, ILineSizeHost, IDistancesHost)

Initializes a new instance of the PixelScrollAxis class which is nested as a single line in a parent scroll axis.

Declaration

public PixelScrollAxis(ScrollAxisBase parentScrollAxis, IScrollBar scrollBar, ILineSizeHost scrollLinesHost, IDistancesHost distancesHost)

Parameters

Type	Name	Description
ScrollAxisBase	parentScrollAxis	The parent scroll axis.
IScrollBar	scrollBar	The scrollbar state.
ILineSizeHost	scrollLinesHost	The scroll lines host.
IDistancesHost	distancesHost	The distances host.

Properties

DefaultLineSize

Gets or sets the default size of lines.

Declaration

public override double DefaultLineSize { get; set; }

Property Value

Type	Description
System.Double	The default size of lines.

Overrides

ScrollAxisBase.DefaultLineSize

Distances

Gets the distances collection which is used internally for mapping from a point position to a line index and vice versa.

Declaration

public IDistanceCounterCollection Distances { get; }

Property Value

Type	Description
IDistanceCounterCollection	The distances collection which is used internally for mapping from a point position to a line index and vice versa.

FooterExtent

Gets the footer extent. This is total height (or width) of the footer lines.

Declaration

public override double FooterExtent { get; }

Property Value

Type	Description
System.Double	The footer extent.

Overrides

ScrollAxisBase.FooterExtent

HeaderExtent

Gets the header extent. This is total height (or width) of the header lines.

Declaration

public override double HeaderExtent { get; }

Property Value

Type	Description
System.Double	The header extent.

Overrides

ScrollAxisBase.HeaderExtent

IsPixelScroll

Gets a value indicating whether this axis supports pixel scrolling.

Declaration

public override bool IsPixelScroll { get; }

Property Value

Type	Description
System.Boolean	true if this instance supports pixel scrolling, otherwise false.

Overrides

ScrollAxisBase.IsPixelScroll

LineCount

Gets or sets the line count.

Declaration

public override int LineCount { get; set; }

Property Value

Type	Description
System.Int32	The line count.

Overrides

ScrollAxisBase.LineCount

ScrollLineIndex

Gets or sets the index of the first visible Line in the Body region.

Declaration

public override int ScrollLineIndex { get; set; }

Property Value

Type	Description
System.Int32	The index of the scroll line.

Overrides

ScrollAxisBase.ScrollLineIndex

TotalExtent

Gets the total extent of all line sizes.

Declaration

public double TotalExtent { get; }

Property Value

Type	Description
System.Double	The total extent of all line sizes.

ViewSize

Gets the view size of the (either height or width) of the parent control. Normally the ViewSize is the same as RenderSize. Only if the parent control has more space then needed to display all lines, the ViewSize will be less. In such case the ViewSize is the total height for all lines.

Declaration

public override double ViewSize { get; }

Property Value

Type	Description
System.Double	The size of the view.

Overrides

ScrollAxisBase.ViewSize

Methods

AlignScrollLine()

Aligns the scroll line.

Declaration

public override void AlignScrollLine()

Overrides

ScrollAxisBase.AlignScrollLine()

Dispose(Boolean)

Releases the unmanaged resources used by the component and optionally releases the managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	if true - release both managed and unmanaged resources; if false - release only unmanaged resources.

Overrides

ScrollAxisBase.Dispose(Boolean)

GetNextScrollLineIndex(Int32)

Gets the index of the next scroll line.

Declaration

public override int GetNextScrollLineIndex(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Returns

Type	Description
System.Int32	The index of the next scroll line.

Overrides

ScrollAxisBase.GetNextScrollLineIndex(Int32)

GetPreviousScrollLineIndex(Int32)

Gets the index of the previous scroll line.

Declaration

public override int GetPreviousScrollLineIndex(int index)

Parameters

Type	Name	Description
System.Int32	index	The index.

Returns

Type	Description
System.Int32	The index of the previous scroll line.

Overrides

ScrollAxisBase.GetPreviousScrollLineIndex(Int32)

GetScrollLineIndex(out Int32, out Double, Boolean)

Gets the index of the scroll line.

Declaration

public override void GetScrollLineIndex(out int scrollLineIndex, out double scrollLineDelta, bool isRightToLeft)

Parameters

Type	Name	Description
System.Int32	scrollLineIndex	Index of the scroll line.
System.Double	scrollLineDelta	The scroll line offset.
System.Boolean	isRightToLeft	The boolean value used to calculate visible columns in right to left mode.

Overrides

ScrollAxisBase.GetScrollLineIndex(out Int32, out Double, Boolean)

MouseWheel(Int32)

This method is called in response to a MouseWheel event.

Declaration

public override void MouseWheel(int delta)

Parameters

Type	Name	Description
System.Int32	delta	The delta.

Overrides

ScrollAxisBase.MouseWheel(Int32)

OnLinesInserted(Int32, Int32)

Called when lines were inserted in ScrollLinesHost.

Declaration

protected override void OnLinesInserted(int insertAt, int count)

Parameters

Type	Name	Description
System.Int32	insertAt	Index of the first inserted line.
System.Int32	count	The count.

Overrides

ScrollAxisBase.OnLinesInserted(Int32, Int32)

OnLinesRemoved(Int32, Int32)

Called when lines were removed in ScrollLinesHost.

Declaration

protected override void OnLinesRemoved(int removeAt, int count)

Parameters

Type	Name	Description
System.Int32	removeAt	Index of the first removed line.
System.Int32	count	The count.

Overrides

ScrollAxisBase.OnLinesRemoved(Int32, Int32)

RangeToPoints(ScrollAxisRegion, Int32, Int32, Boolean)

Returns the first and last point for the given lines in a region.

Declaration

public override DoubleSpan RangeToPoints(ScrollAxisRegion region, int first, int last, bool allowEstimatesForOutOfViewLines)

Parameters

Type	Name	Description
ScrollAxisRegion	region	The region.
System.Int32	first	The index of the first line.
System.Int32	last	The index of the last line.
System.Boolean	allowEstimatesForOutOfViewLines	if set to true allow estimates for out of view lines.

Returns

Type	Description
Syncfusion.GridCommon.Utility.DoubleSpan	The first and last point for the given lines in a region.

Overrides

ScrollAxisBase.RangeToPoints(ScrollAxisRegion, Int32, Int32, Boolean)

RangeToRegionPoints(Int32, Int32, Boolean)

Returns an array with 3 ranges indicating the first and last point for the given lines in each region.

Declaration

public override DoubleSpan[] RangeToRegionPoints(int first, int last, bool allowEstimatesForOutOfViewLines)

Parameters

Type	Name	Description
System.Int32	first	The index of the first line.
System.Int32	last	The index of the last line.
System.Boolean	allowEstimatesForOutOfViewLines	if set to true allow estimates for out of view lines.

Returns

Type	Description
Syncfusion.GridCommon.Utility.DoubleSpan[]	An array with 3 ranges indicating the first and last point for the given lines in each region.

Overrides

ScrollAxisBase.RangeToRegionPoints(Int32, Int32, Boolean)

ResetLineResize()

Resets temporary value for line size after a resize operation.

Declaration

public override void ResetLineResize()

Overrides

ScrollAxisBase.ResetLineResize()

ScrollInView(Int32, Double, Boolean)

Scrolls the line into viewable area.

Declaration

public override void ScrollInView(int lineIndex, double lineSize, bool isRightToLeft)

Parameters

Type	Name	Description
System.Int32	lineIndex	Index of the line.
System.Double	lineSize	Size of the line.
System.Boolean	isRightToLeft	The boolean value used to calculate visible columns in right to left mode.

Overrides

ScrollAxisBase.ScrollInView(Int32, Double, Boolean)

ScrollToNextLine()

Scrolls to next line.

Declaration

public override void ScrollToNextLine()

Overrides

ScrollAxisBase.ScrollToNextLine()

ScrollToNextPage()

Scrolls to next page.

Declaration

public override void ScrollToNextPage()

Overrides

ScrollAxisBase.ScrollToNextPage()

ScrollToPreviousLine()

Scrolls to previous line.

Declaration

public override void ScrollToPreviousLine()

Overrides

ScrollAxisBase.ScrollToPreviousLine()

ScrollToPreviousPage()

Scrolls to previous page.

Declaration

public override void ScrollToPreviousPage()

Overrides

ScrollAxisBase.ScrollToPreviousPage()

SetFooterLineCount(Int32)

Sets the footer line count.

Declaration

protected override void SetFooterLineCount(int value)

Parameters

Type	Name	Description
System.Int32	value	The value.

Overrides

ScrollAxisBase.SetFooterLineCount(Int32)

SetHeaderLineCount(Int32)

Sets the header line count.

Declaration

protected override void SetHeaderLineCount(int value)

Parameters

Type	Name	Description
System.Int32	value	The value.

Overrides

ScrollAxisBase.SetHeaderLineCount(Int32)

SetLineHiddenState(Int32, Int32, Boolean)

Sets the hidden state of the lines.

Declaration

public override void SetLineHiddenState(int from, int to, bool hide)

Parameters

Type	Name	Description
System.Int32	from	The start index of the line.
System.Int32	to	The end index of the line.
System.Boolean	hide	A boolean value indicating whether to hide the lines. if set to true - [hide].

Overrides

ScrollAxisBase.SetLineHiddenState(Int32, Int32, Boolean)

SetLineResize(Int32, Double)

Set temporary value for a line size during a resize operation without committing value to ScrollLinesHost.

Declaration

public override void SetLineResize(int index, double size)

Parameters

Type	Name	Description
System.Int32	index	The index of the line.
System.Double	size	The size of the line.

Overrides

ScrollAxisBase.SetLineResize(Int32, Double)

SetLineSize(Int32, Int32, Double)

Sets the size of the lines for the given range of lines. Will do nothing for a LineScrollAxis.

Declaration

public override void SetLineSize(int from, int to, double size)

Parameters

Type	Name	Description
System.Int32	from	The start index of the line.
System.Int32	to	The end index of the line.
System.Double	size	The line size.

Overrides

ScrollAxisBase.SetLineSize(Int32, Int32, Double)

SetNestedLines(Int32, IDistanceCounterCollection)

Associates a collection of nested lines with a line in this axis.

Declaration

public void SetNestedLines(int index, IDistanceCounterCollection nestedLines)

Parameters

Type	Name	Description
System.Int32	index	The index.
IDistanceCounterCollection	nestedLines	The nested lines.

SetScrollLineIndex(Int32, Double)

Sets the index of the scroll line.

Declaration

public override void SetScrollLineIndex(int scrollLineIndex, double scrollLineDelta)

Parameters

Type	Name	Description
System.Int32	scrollLineIndex	Index of the scroll line.
System.Double	scrollLineDelta	The scroll line delta.

Overrides

ScrollAxisBase.SetScrollLineIndex(Int32, Double)

UpdateScrollBar()

Initialize scrollbar properties from header and footer size and total size of lines in body.

Declaration

public override void UpdateScrollBar()

Overrides

ScrollAxisBase.UpdateScrollBar()

Implements

System.IDisposable