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

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

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

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

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

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

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

ヘッダーまたはフッターの種類を指定する

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-Java.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Specify that we want different headers and footers for first page.
builder.getPageSetup().setDifferentFirstPageHeaderFooter(true);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.write("Header for the first page.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_FIRST);
builder.write("Footer for the first page.");
builder.moveToSection(0);
builder.writeln("Page 1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2");
doc.save(getArtifactsDir() + "WorkingWithHeadersAndFooters.DifferentFirstPage.docx");

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

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

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Specify that we want different headers and footers for even and odd pages.
builder.getPageSetup().setOddAndEvenPagesHeaderFooter(true);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
builder.write("Header for even pages.");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("Header for odd pages.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_EVEN);
builder.write("Footer for even pages.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.write("Footer for odd pages.");
builder.moveToSection(0);
builder.writeln("Page 1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2");
doc.save(getArtifactsDir() + "WorkingWithHeadersAndFooters.OddEvenPages.docx");

絶対に配置された画像をヘッダーに挿入します

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

次のコード例は、ヘッダーにイメージを追加する方法を示しています:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.insertImage(getImagesDir() + "Logo.jpg", RelativeHorizontalPosition.RIGHT_MARGIN, 10,
RelativeVerticalPosition.PAGE, 10, 50, 50, WrapType.THROUGH);
doc.save(getArtifactsDir() + "WorkingWithHeadersAndFooters.InsertImage.docx");

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

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

次のコード例は、ヘッダー内のテキストをArial、bold、size14、およびcenter alignmentに設定する方法を示しています:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.getFont().setName("Arial");
builder.getFont().setBold(true);
builder.getFont().setSize(14);
builder.write("Header for page.");
doc.save(getArtifactsDir() + "WorkingWithHeadersAndFooters.HeaderFooterFontProps.docx");
view raw font-props.java hosted with ❤ by GitHub

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

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

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

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java.git.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.RIGHT);
builder.write("Page ");
builder.insertField("PAGE", "");
builder.write(" of ");
builder.insertField("NUMPAGES", "");
doc.save(getArtifactsDir() + "WorkingWithHeadersAndFooters.PageNumbers.docx");

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

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

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

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java.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.getPreviousSibling();
if (previousSection == null)
return;
section.getHeadersFooters().clear();
for (HeaderFooter headerFooter : previousSection.getHeadersFooters())
section.getHeadersFooters().add(headerFooter.deepClone(true));
}

異なるページの向きとページサイズを使用する場合は、ヘッダーまたはフッタの外観を確認してください

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

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

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

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

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

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java.git.
Document doc = new Document(getMyDir() + "Header and footer types.docx");
for (Section section : doc.getSections())
{
// 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.getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_FIRST);
footer.remove();
// Primary footer is the footer used for odd pages.
footer = section.getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY);
footer.remove();
footer = section.getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_EVEN);
footer.remove();
}
doc.save(getArtifactsDir() + "RemoveContent.RemoveFooters.docx");