Class VisualContainer

Inheritance
System.Object
VisualContainer
Implements
System.Windows.Controls.Primitives.IScrollInfo
System.IDisposable
Namespace: Syncfusion.UI.Xaml.Grid
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
[ClassReference(IsReviewed = false)]
public class VisualContainer : Panel, IScrollableInfo, IScrollInfo, IDisposable

Constructors

VisualContainer()

Declaration
public VisualContainer()

Fields

WantsMouseInputProperty

Declaration
public static readonly DependencyProperty WantsMouseInputProperty
Field Value
Type Description
System.Windows.DependencyProperty

Properties

AllowFixedGroupCaptions

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

CanHorizontallyScroll

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

CanVerticallyScroll

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

ColumnCount

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

ColumnWidths

Declaration
public IPaddedEditableLineSizeHost ColumnWidths { get; }
Property Value
Type Description
IPaddedEditableLineSizeHost

ExtentHeight

Declaration
public double ExtentHeight { get; }
Property Value
Type Description
System.Double

ExtentWidth

Declaration
public double ExtentWidth { get; }
Property Value
Type Description
System.Double

FooterColumns

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

FooterRows

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

FrozenColumns

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

FrozenRows

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

HorizontalOffset

Declaration
public double HorizontalOffset { get; }
Property Value
Type Description
System.Double

HorizontalPadding

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

HorizontalPixelScroll

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

HScrollBar

Declaration
public ScrollInfo HScrollBar { get; }
Property Value
Type Description
ScrollInfo

RowCount

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

RowHeightManager

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

RowHeights

Declaration
public IPaddedEditableLineSizeHost RowHeights { get; }
Property Value
Type Description
IPaddedEditableLineSizeHost

RowsGenerator

Declaration
public IRowGenerator RowsGenerator { get; set; }
Property Value
Type Description
IRowGenerator

ScrollableOwner

Declaration
public ScrollableContentViewer ScrollableOwner { get; set; }
Property Value
Type Description
ScrollableContentViewer

ScrollColumns

Declaration
public ScrollAxisBase ScrollColumns { get; }
Property Value
Type Description
ScrollAxisBase

ScrollOwner

Declaration
public ScrollViewer ScrollOwner { get; set; }
Property Value
Type Description
System.Windows.Controls.ScrollViewer

ScrollRows

Declaration
public ScrollAxisBase ScrollRows { get; }
Property Value
Type Description
ScrollAxisBase

VerticalOffset

Declaration
public double VerticalOffset { get; }
Property Value
Type Description
System.Double

VerticalPadding

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

VerticalPixelScroll

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

ViewportHeight

Declaration
public double ViewportHeight { get; }
Property Value
Type Description
System.Double

ViewportWidth

Declaration
public double ViewportWidth { get; }
Property Value
Type Description
System.Double

VScrollBar

Declaration
public ScrollInfo VScrollBar { get; }
Property Value
Type Description
ScrollInfo

Methods

ArrangeOverride(Size)

Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
Type Name Description
System.Windows.Size finalSize
Returns
Type Description
System.Windows.Size

CreateScrollAxis(Orientation, Boolean, IScrollBar, ILineSizeHost)

Declaration
protected virtual ScrollAxisBase CreateScrollAxis(Orientation orientation, bool pixelScroll, IScrollBar scrollBar, ILineSizeHost lineSizes)
Parameters
Type Name Description
System.Windows.Controls.Orientation orientation
System.Boolean pixelScroll
IScrollBar scrollBar
ILineSizeHost lineSizes
Returns
Type Description
ScrollAxisBase

Dispose()

Disposes all the resources used by the VisualContainer class.

Declaration
public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the VisualContainer class.

Declaration
protected virtual void Dispose(bool isDisposing)
Parameters
Type Name Description
System.Boolean isDisposing

Indicates whether the call is from Dispose method or from a finalizer.

GetClipRect(ScrollAxisRegion, ScrollAxisRegion)

Gets the clipping bounds for the specified row and column region.

Declaration
public Rect GetClipRect(ScrollAxisRegion rowRegion, ScrollAxisRegion columnRegion)
Parameters
Type Name Description
ScrollAxisRegion rowRegion

The row region.
ScrollAxisRegion columnRegion

The column region.
Returns
Type Description
System.Windows.Rect

A System.Windows.Rect with clipping bounds.

GetParent(DependencyObject)

Declaration
public static DependencyObject GetParent(DependencyObject current)
Parameters
Type Name Description
System.Windows.DependencyObject current
Returns
Type Description
System.Windows.DependencyObject

GetWantsMouseInput(DependencyObject, UIElement)

Declaration
public static bool? GetWantsMouseInput(DependencyObject dpo, UIElement falseIfParent)
Parameters
Type Name Description
System.Windows.DependencyObject dpo
System.Windows.UIElement falseIfParent
Returns
Type Description
System.Nullable<System.Boolean>

InsertColumns(Int32, Int32)

Declaration
public void InsertColumns(int insertAtColumnIndex, int count)
Parameters
Type Name Description
System.Int32 insertAtColumnIndex
System.Int32 count

InsertRows(Int32, Int32)

Declaration
public void InsertRows(int insertAtRowIndex, int count)
Parameters
Type Name Description
System.Int32 insertAtRowIndex
System.Int32 count

InvalidateMeasureInfo()

Declaration
public void InvalidateMeasureInfo()

LineDown()

Declaration
public void LineDown()

LineLeft()

Declaration
public void LineLeft()

LineRight()

Declaration
public void LineRight()

LineUp()

Declaration
public void LineUp()

MakeVisible(Visual, Rect)

Declaration
public Rect MakeVisible(Visual visual, Rect rectangle)
Parameters
Type Name Description
System.Windows.Media.Visual visual
System.Windows.Rect rectangle
Returns
Type Description
System.Windows.Rect

MakeVisible(UIElement, Rect)

Declaration
public Rect MakeVisible(UIElement visual, Rect rectangle)
Parameters
Type Name Description
System.Windows.UIElement visual
System.Windows.Rect rectangle
Returns
Type Description
System.Windows.Rect

MeasureOverride(Size)

Declaration
protected override Size MeasureOverride(Size constraint)
Parameters
Type Name Description
System.Windows.Size constraint
Returns
Type Description
System.Windows.Size

MouseWheelDown()

Declaration
public void MouseWheelDown()

MouseWheelLeft()

Declaration
public void MouseWheelLeft()

MouseWheelRight()

Declaration
public void MouseWheelRight()

MouseWheelUp()

Declaration
public void MouseWheelUp()

OnCreateColumnWidths()

Declaration
protected virtual IPaddedEditableLineSizeHost OnCreateColumnWidths()
Returns
Type Description
IPaddedEditableLineSizeHost

OnCreateRowHeights()

Declaration
protected virtual IPaddedEditableLineSizeHost OnCreateRowHeights()
Returns
Type Description
IPaddedEditableLineSizeHost

OnManipulationBoundaryFeedback(ManipulationBoundaryFeedbackEventArgs)

Called when the System.Windows.UIElement.ManipulationBoundaryFeedback event occurs.

Declaration
protected override void OnManipulationBoundaryFeedback(ManipulationBoundaryFeedbackEventArgs e)
Parameters
Type Name Description
System.Windows.Input.ManipulationBoundaryFeedbackEventArgs e

The data for the event.

PageDown()

Declaration
public void PageDown()

PageLeft()

Declaration
public void PageLeft()

PageRight()

Declaration
public void PageRight()

PageUp()

Declaration
public void PageUp()

PointToCellRowColumnIndex(Point, Boolean)

Determines the cell under the mouse location.

Declaration
public RowColumnIndex PointToCellRowColumnIndex(Point p, bool allowOutSideLines = false)
Parameters
Type Name Description
System.Windows.Point p

The point in client coordinates.
System.Boolean allowOutSideLines
Returns
Type Description
RowColumnIndex

The cells row and column index under the mouse location.

RangeToRect(ScrollAxisRegion, ScrollAxisRegion, RowColumnIndex, Boolean, Boolean)

For internal use.

Declaration
public Rect RangeToRect(ScrollAxisRegion rowRegion, ScrollAxisRegion columnRegion, RowColumnIndex rowcolumn, bool allowEstimatesForOutOfViewRows, bool allowEstimatesForOutOfViewColumns)
Parameters
Type Name Description
ScrollAxisRegion rowRegion

Scroll axis region for row.
ScrollAxisRegion columnRegion

Scroll axis region for column.
RowColumnIndex rowcolumn
System.Boolean allowEstimatesForOutOfViewRows

If set to true, allows estimate for out of view rows.
System.Boolean allowEstimatesForOutOfViewColumns

If set to true, allows estimate for out of view columns.
Returns
Type Description
System.Windows.Rect

Visible rectangle for the given range.

RemoveColumns(Int32, Int32)

Declaration
public void RemoveColumns(int removeAtColumnIndex, int count)
Parameters
Type Name Description
System.Int32 removeAtColumnIndex
System.Int32 count

RemoveRows(Int32, Int32)

Declaration
public void RemoveRows(int removeAtRowIndex, int count)
Parameters
Type Name Description
System.Int32 removeAtRowIndex
System.Int32 count

SetHorizontalOffset(Double)

Declaration
public void SetHorizontalOffset(double offset)
Parameters
Type Name Description
System.Double offset

SetVerticalOffset(Double)

Declaration
public void SetVerticalOffset(double offset)
Parameters
Type Name Description
System.Double offset

SetWantsMouseInput(DependencyObject, Nullable<Boolean>)

Declaration
public static void SetWantsMouseInput(DependencyObject dpo, bool? value)
Parameters
Type Name Description
System.Windows.DependencyObject dpo
System.Nullable<System.Boolean> value

UpdateAxis(Size)

Updates available size to Renderer

Declaration
public void UpdateAxis(Size availableSize)
Parameters
Type Name Description
System.Windows.Size availableSize

available size

Implements

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

Extension Methods