ヘッダーとフッターの操作

Aspose.Words を使用すると、ユーザーはドキュメント内のヘッダーとフッターを操作できます。ヘッダーはページの上部に配置されるテキストであり、フッターはページの下部に配置されるテキストです。通常、これらの領域は、ページ番号、作成日、会社情報など、文書のすべてまたは一部のページで繰り返す必要がある情報を挿入するために使用されます。

DocumentBuilder を使用してヘッダーまたはフッターを作成する

ドキュメントのヘッダーまたはフッターをプログラムで追加する場合、最も簡単な方法は、DocumentBuilder クラスを使用してそれを行うことです。

次のコード例は、ドキュメント ページにヘッダーとフッターを追加する方法を示しています。

ヘッダーまたはフッターのオプションを指定する

ドキュメントにヘッダーまたはフッターを追加するときに、いくつかの詳細プロパティを設定できます。 Aspose.Words は、HeaderFooter クラスと HeaderFooterCollection クラスに加えて、ヘッダーとフッターのカスタマイズ プロセスをより詳細に制御できる HeaderFooterType 列挙をユーザーに提供します。

ヘッダーまたはフッターのタイプを指定する

1 つのドキュメントに 3 つの異なるヘッダー タイプと 3 つの異なるフッター タイプを指定できます。

  1. 最初のページのヘッダーおよび/またはフッター
  2. 偶数ページのヘッダーおよび/またはフッター
  3. 奇数ページのヘッダーおよび/またはフッター

次のコード例は、奇数のドキュメント ページにヘッダーを追加する方法を示しています。

最初のページに異なるヘッダーまたはフッターを表示するかどうかを指定する

上で述べたように、最初のページに別のヘッダーまたはフッターを設定することもできます。これを行うには、DifferentFirstPageHeaderFooter フラグを true に設定し、HeaderFirst または FooterFirst 値を指定する必要があります。

次のコード例は、最初のページのみのヘッダーを設定する方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Specify that we want different headers and footers for first page.
builder.PageSetup.DifferentFirstPageHeaderFooter = true;
builder.MoveToHeaderFooter(HeaderFooterType.HeaderFirst);
builder.Write("Header for the first page.");
builder.MoveToHeaderFooter(HeaderFooterType.FooterFirst);
builder.Write("Footer for the first page.");
builder.MoveToSection(0);
builder.Writeln("Page 1");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Page 2");
doc.Save(ArtifactsDir + "WorkingWithHeadersAndFooters.DifferentFirstPage.docx");

奇数ページまたは偶数ページに異なるヘッダーまたはフッターを表示するかどうかを指定する

次に、ドキュメント内の奇数ページと偶数ページに異なるヘッダーまたはフッターを設定する必要があります。これを行うには、OddAndEvenPagesHeaderFooter フラグを true に設定し、値として HeaderPrimaryHeaderEven、または FooterPrimaryFooterEven を指定する必要があります。

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Specify that we want different headers and footers for even and odd pages.
builder.PageSetup.OddAndEvenPagesHeaderFooter = true;
builder.MoveToHeaderFooter(HeaderFooterType.HeaderEven);
builder.Write("Header for even pages.");
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.Write("Header for odd pages.");
builder.MoveToHeaderFooter(HeaderFooterType.FooterEven);
builder.Write("Footer for even pages.");
builder.MoveToHeaderFooter(HeaderFooterType.FooterPrimary);
builder.Write("Footer for odd pages.");
builder.MoveToSection(0);
builder.Writeln("Page 1");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Page 2");
doc.Save(ArtifactsDir + "WorkingWithHeadersAndFooters.OddEvenPages.docx");

ヘッダーに絶対位置の画像を挿入する

ヘッダーまたはフッターに画像を配置するには、HeaderPrimary ヘッダー タイプまたは FooterPrimary フッター タイプと InsertImage メソッドを使用します。

次のコード例は、ヘッダーに画像を追加する方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.InsertImage(ImagesDir + "Logo.jpg", RelativeHorizontalPosition.RightMargin, 10,
RelativeVerticalPosition.Page, 10, 50, 50, WrapType.Through);
doc.Save(ArtifactsDir + "WorkingWithHeadersAndFooters.InsertImage.docx");
view raw insert-image.cs hosted with ❤ by GitHub

ヘッダーまたはフッターのテキストのフォントと段落のプロパティを設定する

Aspose.Words を使用すると、フォントと段落のプロパティを設定したり、HeaderPrimary ヘッダー タイプや FooterPrimary フッター タイプを使用したり、文書本文に使用するフォントや段落を操作するためのメソッドやプロパティを設定したりできます。

次のコード例は、ヘッダーのテキストを Arial、太字、サイズ 14、中央揃えに設定する方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.ParagraphFormat.Alignment = ParagraphAlignment.Center;
builder.Font.Name = "Arial";
builder.Font.Bold = true;
builder.Font.Size = 14;
builder.Write("Header for page.");
doc.Save(ArtifactsDir + "WorkingWithHeadersAndFooters.FontProps.docx");
view raw font-props.cs hosted with ❤ by GitHub

ヘッダーまたはフッターにページ番号を挿入する

必要に応じて、ヘッダーまたはフッターにページ番号を追加できます。これを行うには、HeaderPrimary ヘッダー タイプまたは FooterPrimary フッター タイプと InsertField メソッドを使用して、必要なフィールドを追加します。

次のコード例は、右側のフッターにページ番号を追加する方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.MoveToHeaderFooter(HeaderFooterType.FooterPrimary);
builder.ParagraphFormat.Alignment = ParagraphAlignment.Right;
builder.Write("Page ");
builder.InsertField("PAGE", "");
builder.Write(" of ");
builder.InsertField("NUMPAGES", "");
doc.Save(ArtifactsDir + "WorkingWithHeadersAndFooters.PageNumbers.docx");
view raw page-numbers.cs hosted with ❤ by GitHub

前のセクションで定義したヘッダーまたはフッターを使用する

前のセクションからヘッダーまたはフッターをコピーする必要がある場合は、それも行うことができます。

次のコード例は、前のセクションからヘッダーまたはフッターをコピーする方法を示しています。

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET.git.
/// <summary>
/// Clones and copies headers/footers form the previous section to the specified section.
/// </summary>
private void CopyHeadersFootersFromPreviousSection(Section section)
{
Section previousSection = (Section)section.PreviousSibling;
if (previousSection == null)
return;
section.HeadersFooters.Clear();
foreach (HeaderFooter headerFooter in previousSection.HeadersFooters)
section.HeadersFooters.Add(headerFooter.Clone(true));
}

異なるページの向きとページ サイズを使用するときにヘッダーまたはフッターの外観を確認する

Aspose.Words を使用すると、さまざまな向きやページ サイズを使用するときにヘッダーまたはフッターの外観を提供できます。

次の例は、これを行う方法を示しています。

ヘッダーのみまたはフッターのみを削除する方法

ドキュメントの各セクションには、最大 3 つのヘッダーと最大 3 つのフッターを含めることができます (最初のページ、偶数ページ、奇数ページの場合)。ドキュメント内のすべてのヘッダーまたはすべてのフッターを削除する場合は、すべてのセクションをループして、対応する各ヘッダー ノードまたはフッター ノードを削除する必要があります。

次のコード例は、すべてのセクションからすべてのフッターを削除し、ヘッダーはそのままにする方法を示しています。同様の方法でヘッダーのみを削除できます。

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET.git.
Document doc = new Document(MyDir + "Header and footer types.docx");
foreach (Section section in doc)
{
// Up to three different footers are possible in a section (for first, even and odd pages)
// we check and delete all of them.
HeaderFooter footer = section.HeadersFooters[HeaderFooterType.FooterFirst];
footer?.Remove();
// Primary footer is the footer used for odd pages.
footer = section.HeadersFooters[HeaderFooterType.FooterPrimary];
footer?.Remove();
footer = section.HeadersFooters[HeaderFooterType.FooterEven];
footer?.Remove();
}
doc.Save(ArtifactsDir + "RemoveContent.RemoveFooters.docx");