Lavorare con intestazioni e piè di pagina

Aspose.Words consente agli utenti di lavorare con intestazioni e piè di pagina in un documento. Un’intestazione è un testo posizionato nella parte superiore di una pagina e un piè di pagina è testo nella parte inferiore di una pagina. In genere, queste aree vengono utilizzate per inserire informazioni che devono essere ripetute su tutte o alcune pagine del documento, ad esempio numeri di pagina, data di creazione, informazioni sulla società e così via.

Creare intestazioni o piè di pagina usando DocumentBuilder

Se si desidera aggiungere un’intestazione o un piè di pagina del documento a livello di codice, il modo più semplice è utilizzare la classe DocumentBuilder per farlo.

L’esempio di codice seguente mostra come aggiungere un’intestazione e un piè di pagina per le pagine del documento:

// 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);

// Use HeaderPrimary and FooterPrimary
// if you want to set header/footer for all document.
// This header/footer type also responsible for odd pages.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("Header for page.");

builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.write("Footer for page.");

doc.save(getArtifactsDir() + "WorkingWithHeadersAndFooters.CreateHeaderFooter.docx");

Specificare le opzioni di intestazione o piè di pagina

Quando si aggiunge un’intestazione o un piè di pagina a un documento, è possibile impostare alcune proprietà avanzate. Aspose.Words fornisce agli utenti le classi HeaderFooter e HeaderFooterCollection, nonché l’enumerazione HeaderFooterType che offre un maggiore controllo sul processo di personalizzazione dell’intestazione e del piè di pagina.

Specificare il tipo di intestazione o piè di pagina

È possibile specificare tre diversi tipi di intestazione e tre diversi tipi di piè di pagina per un documento:

1. Intestazione e / o piè di pagina della prima pagina
2. Intestazione e / o piè di pagina per pagine pari
3. Intestazione e / o piè di pagina per le pagine dispari

Il seguente esempio di codice mostra come aggiungere un’intestazione per le pagine del documento dispari:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java.git.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("Header for page.");

Specificare se visualizzare intestazioni o piè di pagina diversi per la prima pagina

Come detto sopra, puoi anche impostare un’intestazione o un piè di pagina diverso per la prima pagina. Per fare ciò, è necessario impostare il flag DifferentFirstPageHeaderFooter su true e quindi specificare il valore HeaderFirst o FooterFirst.

Il seguente esempio di codice mostra come impostare l’intestazione solo per la prima pagina:

// 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");

Specificare se visualizzare intestazioni o piè di pagina diversi per le pagine pari o dispari

Successivamente, dovrai impostare intestazioni o piè di pagina diversi per le pagine pari e dispari in un documento. Per fare ciò, è necessario impostare il flag OddAndEvenPagesHeaderFooter su true e quindi specificare i valori HeaderPrimary e HeaderEven o FooterPrimary e FooterEven.

// 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");

Inserire un’immagine assolutamente posizionata nell’intestazione

Per inserire un’immagine in un’intestazione o in un piè di pagina, utilizzare il tipo di intestazione HeaderPrimary o il tipo di piè di pagina FooterPrimary e il metodo InsertImage.

L’esempio di codice seguente mostra come aggiungere un’immagine a un’intestazione:

// 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");

Imposta le proprietà del carattere e del paragrafo per il testo dell’intestazione o del piè di pagina

Con Aspose.Words è possibile impostare le proprietà font e paragrafo, utilizzare il tipo di intestazione HeaderPrimary o il tipo di piè di pagina FooterPrimary, nonché i metodi e le proprietà per lavorare con i font e i paragrafi utilizzati per il corpo del documento.

L’esempio di codice seguente mostra come impostare il testo nell’intestazione su Arial, grassetto, dimensione 14 e allineamento centrale:

// 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");

Inserire i numeri di pagina nell’intestazione o nel piè di pagina

Se necessario, è possibile aggiungere numeri di pagina all’intestazione o al piè di pagina. A tale scopo, utilizzare il tipo di intestazione HeaderPrimary o il tipo di piè di pagina FooterPrimary e il metodo InsertField per aggiungere il campo richiesto.

Il seguente esempio di codice mostra come aggiungere numeri di pagina al piè di pagina a destra:

// 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");

Utilizzare Intestazioni o piè di pagina definiti nella sezione precedente

Se hai bisogno di copiare l’intestazione o il piè di pagina dalla sezione precedente, puoi farlo anche tu.

Il seguente esempio di codice mostra come copiare l’intestazione o il piè di pagina dalla sezione precedente:

// 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));
}

Garantire l’aspetto dell’intestazione o del piè di pagina quando si utilizzano orientamenti e dimensioni della pagina diversi

Aspose.Words consente di fornire l’aspetto di un’intestazione o di un piè di pagina quando si utilizzano orientamenti e dimensioni di pagina diverse.

L’esempio seguente mostra come eseguire questa operazione:

// 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.getPageSetup().setDifferentFirstPageHeaderFooter(true);

builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.getFont().setName("Arial");
builder.getFont().setBold(true);
builder.getFont().setSize(14);
builder.write("Header for the first page.");

builder.moveToDocumentEnd();
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);

Section currentSection = builder.getCurrentSection();
PageSetup pageSetup = currentSection.getPageSetup();
pageSetup.setOrientation(Orientation.LANDSCAPE);
// This section does not need a different first-page header/footer we need only one title page in the document,
// and the header/footer for this page has already been defined in the previous section.
pageSetup.setDifferentFirstPageHeaderFooter(false);

// This section displays headers/footers from the previous section
// by default call currentSection.HeadersFooters.LinkToPrevious(false) to cancel this page width
// is different for the new section.
currentSection.getHeadersFooters().linkToPrevious(false);
currentSection.getHeadersFooters().clear();

builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.getFont().setName("Arial");
builder.getFont().setSize(12);
builder.write("New Header for the first page.");

doc.save(getArtifactsDir() + "WorkingWithHeadersAndFooters.LinkToPreviousHeaderFooter.docx");

Come rimuovere solo intestazioni o solo piè di pagina

Ogni sezione di un documento può avere fino a tre intestazioni e fino a tre piè di pagina (per le pagine prime, pari e dispari). Se si desidera rimuovere tutte le intestazioni o tutti i piè di pagina in un documento, è necessario scorrere tutte le sezioni e rimuovere ogni nodo di intestazione o piè di pagina corrispondente.

L’esempio di codice seguente mostra come rimuovere tutti i piè di pagina da tutte le sezioni ma lasciare intatte le intestazioni. È possibile rimuovere solo le intestazioni in modo simile:

// 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");

È possibile scaricare il file di esempio di questo esempio da Aspose.Words GitHub.