Xceed DataGrid for WPF v7.3 Documentation
Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid.Views Namespace / TableViewScrollViewer Class
Members Example


In This Topic
    TableViewScrollViewer Class
    In This Topic
    Represents a scrollable area that can contain other visible elements laid out in a tableview.
    Syntax
    'Declaration
     
    <TemplatePartAttribute(Name="PART_RowSelectorPane", Type=Xceed.Wpf.DataGrid.RowSelectorPane)>
    <DefaultEventAttribute("ScrollChangedEvent")>
    <LocalizabilityAttribute(LocalizationCategory.Ignore)>
    <DefaultPropertyAttribute("Content")>
    <ContentPropertyAttribute("Content")>
    <StyleTypedPropertyAttribute(Property="FocusVisualStyle", StyleTargetType=System.Windows.Controls.Control)>
    <XmlLangPropertyAttribute("Language")>
    <UsableDuringInitializationAttribute(True)>
    <RuntimeNamePropertyAttribute("Name")>
    <UidPropertyAttribute("Uid")>
    <TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
    <NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
    Public Class TableViewScrollViewer 
       Inherits DataGridScrollViewer
    'Usage
     
    Dim instance As TableViewScrollViewer
    [TemplatePart(Name="PART_RowSelectorPane", Type=Xceed.Wpf.DataGrid.RowSelectorPane)]
    [DefaultEvent("ScrollChangedEvent")]
    [Localizability(LocalizationCategory.Ignore)]
    [DefaultProperty("Content")]
    [ContentProperty("Content")]
    [StyleTypedProperty(Property="FocusVisualStyle", StyleTargetType=System.Windows.Controls.Control)]
    [XmlLangProperty("Language")]
    [UsableDuringInitialization(true)]
    [RuntimeNameProperty("Name")]
    [UidProperty("Uid")]
    [TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
    [NameScopeProperty("NameScope", System.Windows.NameScope)]
    public class TableViewScrollViewer : DataGridScrollViewer 
    Remarks

    Fixed Columns vs. Templates  

    In order to support fixed columns when creating a new row template for a table-view layout, the following criteria must be met:

    1. The PART_CellsHost template part must be a FixedCellPanel.
    2. The FixedCellCount property of the FixedCellPanel must be bound to the table view's FixedColumnCount property using a TwoWay ViewBinding.

    The fixed-cell-panel properties listed below are also usually bound when provided a new row template for a table-view layout:

    1. SplitterStyle (TemplateBinding xcdg:TableView.FixedColumnSplitterStyle)
    2. SplitterWidth (xcdg:ViewBinding FixedColumnSplitterWidth)
    3. ShowSplitter (xcdg:ViewBinding ShowFixedColumnSplitter)
    4. FixedColumnDropMarkPen (xcdg:ViewBinding FixedColumnDropMarkPen)

    If a new template is provided for a DataGridControl and fixed columns are to be supported, it is essential that a TableViewScrollViewer be used. This scroll viewer is responsible for preserving the TranslateTransforms that fix and scroll elements, as well as executing the PageLeft and PageRight actions according to the reduced viewport.  It is also recommended that an AdornerDecorator be located above the TableViewScrollViewer of the templated DataGridControl to support drag and dropping of the fixed-column splitter correctly.

    Example
    All examples in this topic assume that the grid is bound to the Orders table of the Northwind database, unless stated otherwise.
    The following example demonstrates how to prevent scroll bars from being displayed by providing an implicit style for the TableViewScrollViewer that sets the HorizontalScollBarVisibility and VerticalScrollBarVisibility properties to Hidden.
    <Grid xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid">
      <Grid.Resources>
        <xcdg:DataGridCollectionViewSource x:Key="cvs_persons"
                                        Source="{Binding Source={x:Static Application.Current}, 
                                                         Path=Persons}"/>
    
        <Style TargetType="{x:Type xcdg:TableViewScrollViewer}">
          <Setter Property="HorizontalScrollBarVisibility"
                  Value="Hidden"/>
    
          <Setter Property="VerticalScrollBarVisibility"
                  Value="Hidden"/>
        </Style>
      </Grid.Resources>
      <xcdg:DataGridControl x:Name="PersonGrid"
                            ItemsSource="{Binding Source={StaticResource cvs_persons}}"/>
    </Grid>
    Inheritance Hierarchy

    System.Object
       System.Windows.Threading.DispatcherObject
          System.Windows.DependencyObject
             System.Windows.Media.Visual
                System.Windows.UIElement
                   System.Windows.FrameworkElement
                      System.Windows.Controls.Control
                         System.Windows.Controls.ContentControl
                            System.Windows.Controls.ScrollViewer
                               Xceed.Wpf.DataGrid.Views.DataGridScrollViewer
                                  Xceed.Wpf.DataGrid.Views.TableViewScrollViewer

    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also