HeaderFooterCollection

HeaderFooterCollection class

Proporciona acceso escrito aHeaderFooter nodos de unSection .

Para obtener más información, visite elTrabajar con encabezados y pies de página artículo de documentación.

public class HeaderFooterCollection : NodeCollection

Propiedades

NombreDescripción
Count { get; }Obtiene el número de nodos de la colección.
Item { get; }Recupera unHeaderFooter en el índice dado. (3 indexers)

Métodos

NombreDescripción
Add(Node)Agrega un nodo al final de la colección.
Clear()Elimina todos los nodos de esta colección y del documento.
Contains(Node)Determina si un nodo está en la colección.
GetEnumerator()Proporciona una iteración de estilo “foreach” simple sobre la colección de nodos.
IndexOf(Node)Devuelve el índice de base cero del nodo especificado.
Insert(int, Node)Inserta un nodo en la colección en el índice especificado.
LinkToPrevious(bool)Vincula o desvincula todos los encabezados y pies de página a los encabezados y pies de página correspondientes en la sección anterior.
LinkToPrevious(HeaderFooterType, bool)Vincula o desvincula el encabezado o pie de página especificado al encabezado o pie de página correspondiente en la sección anterior.
Remove(Node)Elimina el nodo de la colección y del documento.
RemoveAt(int)Elimina el nodo en el índice especificado de la colección y del documento.
ToArray()Copia todoEncabezado y pie de página s de la colección a una nueva gama deEncabezado y pie de página s. (2 methods)

Observaciones

Puede haber como máximo unoHeaderFooter

de cadaHeaderFooterType por Section .

HeaderFooter Los objetos pueden aparecer en cualquier orden en la colección.

Ejemplos

Muestra cómo eliminar todos los pies de página de un documento.

Document doc = new Document(MyDir + "Header and footer types.docx");

// Recorre cada sección y elimina pies de página de todo tipo.
foreach (Section section in doc.OfType<Section>())
{
    // Hay tres tipos de pie de página y encabezado.
    // 1 - El "primer" encabezado/pie de página, que solo aparece en la primera página de una sección.
    HeaderFooter footer = section.HeadersFooters[HeaderFooterType.FooterFirst];
    footer?.Remove();

    // 2 - El encabezado/pie de página "Principal", que aparece en las páginas impares.
    footer = section.HeadersFooters[HeaderFooterType.FooterPrimary];
    footer?.Remove();

     // 3 - El encabezado/pie de página "Par", que aparece en páginas pares.
    footer = section.HeadersFooters[HeaderFooterType.FooterEven];
    footer?.Remove();

    Assert.AreEqual(0, section.HeadersFooters.Count(hf => !((HeaderFooter)hf).IsHeader));
}

doc.Save(ArtifactsDir + "HeaderFooter.RemoveFooters.docx");

Muestra cómo crear un encabezado y un pie de página.

Document doc = new Document();

// Crea un encabezado y añádele un párrafo. El texto de ese párrafo
// aparecerá en la parte superior de cada página de esta sección, encima del texto del cuerpo principal.
HeaderFooter header = new HeaderFooter(doc, HeaderFooterType.HeaderPrimary);
doc.FirstSection.HeadersFooters.Add(header);

Paragraph para = header.AppendParagraph("My header.");

Assert.True(header.IsHeader);
Assert.True(para.IsEndOfHeaderFooter);

// Crea un pie de página y añádele un párrafo. El texto de ese párrafo
// aparecerá en la parte inferior de cada página de esta sección, debajo del texto del cuerpo principal.
HeaderFooter footer = new HeaderFooter(doc, HeaderFooterType.FooterPrimary);
doc.FirstSection.HeadersFooters.Add(footer);

para = footer.AppendParagraph("My footer.");

Assert.False(footer.IsHeader);
Assert.True(para.IsEndOfHeaderFooter);

Assert.AreEqual(footer, para.ParentStory);
Assert.AreEqual(footer.ParentSection, para.ParentSection);
Assert.AreEqual(footer.ParentSection, header.ParentSection);

doc.Save(ArtifactsDir + "HeaderFooter.Create.docx");

Ver también

HeaderFooter Class HeaderFooterType Enum