Xceed Logo
Shop
Xceed DataGrid for WPF v7.3 Documentation
Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid.Print Namespace / DataGridPageControl Class / GetIsDataGridHost Method
The panel identified as the host that will contain the DataGridControl.
Example


In This Topic
    GetIsDataGridHost Method
    In This Topic
    Gets a value that, when set by a panel, identifies that panel as the host that will contain the DataGridControl.
    Syntax
    'Declaration
 
Public Shared Function GetIsDataGridHost( _
   ByVal obj As DependencyObject _
) As Boolean
    'Usage
 
Dim obj As DependencyObject
Dim value As Boolean
 
value = DataGridPageControl.GetIsDataGridHost(obj)
    public static bool GetIsDataGridHost( 
   DependencyObject obj
)

    Parameters

    obj
    The panel identified as the host that will contain the DataGridControl.

    Return Value

    true if a panel is used as a grid host; false otherwise.
    Remarks
    This method represents the "get" portion of the IsDataGridHost attached property.
    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 create a style to change the layout of the printed pages by providing a new ControlTemplate that will place the page headers and footers at the top of each page and display an orange border around the area where the grid is printed.
    <Grid xmlns:xcdg="http://schemas.xceed.com/wpf/xaml/datagrid"
      xmlns:local="clr-namespace:Xceed.Wpf.Documentation">
  <Grid.Resources>
    <xcdg:DataGridCollectionViewSource x:Key="cvs_employees"
                                     Source="{Binding Source={x:Static Application.Current},
                                                        Path=Employees}"/>

    <Style x:Key="page_style" TargetType="{x:Type xcdg:DataGridPageControl}">
      <Setter Property="Template">
        <Setter.Value>
          <ControlTemplate TargetType="{x:Type xcdg:DataGridPageControl}">
            <DockPanel>
              <StackPanel xcdg:DataGridPageControl.IsPageHeadersHost="True"
                          DockPanel.Dock="Top"/>
              <StackPanel xcdg:DataGridPageControl.IsPageFootersHost="True"
                          DockPanel.Dock="Top"/>
              <Border BorderThickness="2"
                      BorderBrush="Orange"
                      xcdg:DataGridPageControl.IsDataGridHost="True"
                      DockPanel.Dock="Bottom"/>
            </DockPanel>
          </ControlTemplate>
        </Setter.Value>
      </Setter>
    </Style>
  </Grid.Resources>
  <DockPanel>
    <Button Content="Print Grid"
            Click="PrintGrid"
            DockPanel.Dock="Top"/>
    <xcdg:DataGridControl x:Name="EmployeesGrid"
                          ItemsSource="{Binding Source={StaticResource cvs_employees}}">
      <xcdg:DataGridControl.PrintView>

       <xcdg:PrintTableView PageStyle="{StaticResource page_style}">
          <xcdg:PrintTableView.PageHeaders>
            <DataTemplate>
              <TextBlock Text="Xceed WPF Documentation"
                         HorizontalAlignment="Center"
                         FontWeight="Bold"
                         FontSize="20"/>
            </DataTemplate>
            <DataTemplate>
              <TextBlock Text="Printing Example"
                         HorizontalAlignment="Center"
                         FontSize="16"/>
            </DataTemplate>
          </xcdg:PrintTableView.PageHeaders>
          <xcdg:PrintTableView.PageFooters>
            <DataTemplate>
              <StackPanel HorizontalAlignment="Right"
                          Orientation="Horizontal">
                <TextBlock Text="Page "/>
                <TextBlock Text="{xcdg:ViewBinding CurrentPageNumber}"/>
              </StackPanel>   
            </DataTemplate>
          </xcdg:PrintTableView.PageFooters>
        </xcdg:PrintTableView>
      </xcdg:DataGridControl.PrintView>
    </xcdg:DataGridControl>
  </DockPanel>
</Grid>
    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

    Reference

    DataGridPageControl Class
    DataGridPageControl Members

    Send Feedback