PageHeader プロパティ

各ページの上部に印刷するテキストを取得または設定します。

シンタックス

Visual Basic

'宣言
 
Public Property PageHeader As String

C#

public string PageHeader {get; set;}

解説

ページ ヘッダーに指定したテキストは各物理ページの上部に表示されます。ヘッダーのテキストを変更する場合は、InitializeLogicalPrintPage イベントを使用します。これは論理ページのヘッダーだけを変更します。 論理ページと物理ページの相違の説明については、UltraGrid.InitializeLogicalPrintPage イベントのトピックを参照してください。

置換コードを使用すれば、ページ ヘッダーのテキストにページ番号を挿入できます。置換コードは、印刷されるページの物理ページ番号に置き換えられます。物理ページ番号をページ ヘッダーに挿入するには、PageHeader プロパティに設定するテキスト文字列に次の置換コードを追加します: <#><#>

各ページには物理ページ番号、論理ページ番号、または両者の組み合わせを含めることができます。物理ページ番号を各ページに挿入するには、単にページヘッダーのテキストに置換コードを含めます。論理ページ番号を挿入するには、IntializePrint イベントで論理ページ カウンタ変数を初期化し、InitializeLogicalPrintPage イベントでカウンタ変数を増やして、ページ ヘッダーのテキストに新しい論理ページ カウント値を含めます。

ページ ヘッダーの各セクションの位置を揃えるには、PageHeader プロパティにタブ区切りの文字列を指定します。最初のタブ文字より前のテキストは左揃えになります。最初のタブ文字から２番目のタブ文字までのテキストは中央揃えになります。２番目のタブ文字より後のテキストは右揃えになります。たとえば、ページ ヘッダー全体を右揃えにする場合は、テキスト文字列の最初のタブ文字を 2 つ指定します。

ヘッダー テキストにタブ文字を含めると、ヘッダーに対して指定された位置揃えは無効になります。テキストにタブ文字が含まれていない場合は、デフォルトの位置揃えが使用されます (デフォルトの位置揃えは、PageHeaderAppearance によって返される Appearance オブジェクトの設定によって決まります)。

使用例

Visual Basic

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub UltraGrid1_InitializePrint(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.CancelablePrintEventArgs) Handles ultraGrid1.InitializePrint

      ' One could conditionally set Cancel to true to cancel the printing.
      If Me.CheckBox1.Checked Then
          e.Cancel = True
          Return
      End If

      ' Horizontally fit everything in a signle page.
      e.DefaultLogicalPageLayoutInfo.FitWidthToPages = 1

      ' Set up the header and the footer.
      e.DefaultLogicalPageLayoutInfo.PageHeader = "Title"
      e.DefaultLogicalPageLayoutInfo.PageHeaderHeight = 40
      e.DefaultLogicalPageLayoutInfo.PageHeaderAppearance.FontData.SizeInPoints = 14
      e.DefaultLogicalPageLayoutInfo.PageHeaderAppearance.TextHAlign = HAlign.Center
      e.DefaultLogicalPageLayoutInfo.PageHeaderBorderStyle = UIElementBorderStyle.Solid

      ' Use <#> token in the string to designate page numbers.
      e.DefaultLogicalPageLayoutInfo.PageFooter = "Page <#>."
      e.DefaultLogicalPageLayoutInfo.PageFooterHeight = 40
      e.DefaultLogicalPageLayoutInfo.PageFooterAppearance.TextHAlign = HAlign.Right
      e.DefaultLogicalPageLayoutInfo.PageFooterAppearance.FontData.Italic = DefaultableBoolean.True
      e.DefaultLogicalPageLayoutInfo.PageFooterBorderStyle = UIElementBorderStyle.Solid

      ' Set the ClippingOverride to Yes.
      e.DefaultLogicalPageLayoutInfo.ClippingOverride = ClippingOverride.Yes

      ' Set the document name through the PrintDocument which returns a PrintDocument object.
      e.PrintDocument.DocumentName = "Document Name"

  End Sub

C#

using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void ultraGrid1_InitializePrint(object sender, Infragistics.Win.UltraWinGrid.CancelablePrintEventArgs e)
{

	// One could conditionally set Cancel to true to cancel the printing.
	if ( this.checkBox1.Checked )
	{
		e.Cancel = true;
		return;
	}

	// Horizontally fit everything in a signle page.
	e.DefaultLogicalPageLayoutInfo.FitWidthToPages = 1;

	// Set up the header and the footer.
	e.DefaultLogicalPageLayoutInfo.PageHeader = "Title";
	e.DefaultLogicalPageLayoutInfo.PageHeaderHeight = 40;
	e.DefaultLogicalPageLayoutInfo.PageHeaderAppearance.FontData.SizeInPoints = 14;
	e.DefaultLogicalPageLayoutInfo.PageHeaderAppearance.TextHAlign = HAlign.Center;
	e.DefaultLogicalPageLayoutInfo.PageHeaderBorderStyle = UIElementBorderStyle.Solid;
	
	// Use <#> token in the string to designate page numbers.
	e.DefaultLogicalPageLayoutInfo.PageFooter = "Page <#>.";
	e.DefaultLogicalPageLayoutInfo.PageFooterHeight= 40;
	e.DefaultLogicalPageLayoutInfo.PageFooterAppearance.TextHAlign = HAlign.Right;
	e.DefaultLogicalPageLayoutInfo.PageFooterAppearance.FontData.Italic = DefaultableBoolean.True;
	e.DefaultLogicalPageLayoutInfo.PageFooterBorderStyle = UIElementBorderStyle.Solid;

	// Set the ClippingOverride to Yes.
	e.DefaultLogicalPageLayoutInfo.ClippingOverride = ClippingOverride.Yes;

	// Set the document name through the PrintDocument which returns a PrintDocument object.
	e.PrintDocument.DocumentName = "Document Name";

}