HeaderFooter

HeaderFooter class

Bir bölümün başlık veya altbilgi metni için bir kapsayıcıyı temsil eder.

Daha fazla bilgi edinmek için şu adresi ziyaret edin:Üstbilgiler ve Altbilgilerle Çalışma belgeleme makalesi.

public class HeaderFooter : Story

yapıcılar

İsimTanım
HeaderFooter(DocumentBaseHeaderFooterType)Belirtilen türde yeni bir üstbilgi veya altbilgi oluşturur.

Özellikleri

İsimTanım
Count { get; }Bu düğümün hemen alt düğümlerinin sayısını alır.
CustomNodeId { get; set; }Özel düğüm tanımlayıcısını belirtir.
virtual Document { get; }Bu düğümün ait olduğu belgeyi alır.
FirstChild { get; }Düğümün ilk çocuğunu alır.
FirstParagraph { get; }Hikayedeki ilk paragrafı alır.
HasChildNodes { get; }Geri Döndürürdoğru eğer bu düğümün herhangi bir alt düğümü varsa.
HeaderFooterType { get; }Bu başlık/altbilginin türünü alır.
override IsComposite { get; }Geri Döndürürdoğru çünkü bu düğümün alt düğümleri olabilir.
IsHeader { get; }Bu doğruysaHeaderFooter nesne bir başlıktır.
IsLinkedToPrevious { get; set; }Bu başlık veya altbilgi önceki bölümdeki ilgili başlık veya altbilgiye bağlıysa doğrudur.
LastChild { get; }Düğümün son çocuğunu alır.
LastParagraph { get; }Hikayedeki son paragrafı alır.
NextSibling { get; }Bu düğümü hemen takip eden düğümü alır.
override NodeType { get; }Geri DöndürürHeaderFooter .
Paragraphs { get; }Hikayenin doğrudan alt öğeleri olan paragrafların bir koleksiyonunu alır.
ParentNode { get; }Bu düğümün en yakın üst düğümünü alır.
ParentSection { get; }Bu hikayenin üst bölümünü alır.
PreviousSibling { get; }Bu düğümden hemen önceki düğümü alır.
Range { get; }BirRangebu düğümde bulunan bir belgenin bölümünü temsil eden nesne.
StoryType { get; }Bu hikayenin türünü alır.
Tables { get; }Hikayenin doğrudan alt öğeleri olan tabloların bir koleksiyonunu alır.

yöntemler

İsimTanım
override Accept(DocumentVisitor)Bir ziyaretçiyi kabul eder.
override AcceptEnd(DocumentVisitor)Başlığın sonunu ziyaret eden bir ziyaretçiyi kabul eder.
override AcceptStart(DocumentVisitor)Başlığın başlangıcını ziyaret eden bir ziyaretçiyi kabul eder.
AppendChild<T>(T)Belirtilen düğümü bu düğüm için alt düğümler listesinin sonuna ekler.
AppendParagraph(string)Bir kısayol yöntemi oluşturanParagraph isteğe bağlı metin içeren nesne ve bu nesnenin sonuna ekler.
Clone(bool)Düğümün bir kopyasını oluşturur.
CreateNavigator()Düğümleri gezmek ve okumak için kullanılabilen gezgini oluşturur.
DeleteShapes()Bu hikayenin metninden tüm şekilleri siler.
GetAncestor(NodeType)Belirtilenin ilk atasını alırNodeType .
GetAncestor(Type)Belirtilen nesne türünün ilk atasını alır.
GetChild(NodeType, int, bool)Belirtilen türle eşleşen N’inci alt düğümü döndürür.
GetChildNodes(NodeType, bool)Belirtilen türle eşleşen alt düğümlerin canlı bir koleksiyonunu döndürür.
GetEnumerator()Bu düğümün alt düğümleri üzerindeki her stil yinelemesi için destek sağlar.
override GetText()Bu düğümün ve tüm alt düğümlerinin metnini alır.
IndexOf(Node)Alt düğüm dizisindeki belirtilen alt düğümün dizinini döndürür.
InsertAfter<T>(T, Node)Belirtilen düğümü belirtilen referans düğümünden hemen sonra ekler.
InsertBefore<T>(T, Node)Belirtilen düğümü belirtilen referans düğümünden hemen önce ekler.
NextPreOrder(Node)Ön sipariş ağacı geçiş algoritmasına göre bir sonraki düğümü alır.
PrependChild<T>(T)Belirtilen düğümü bu düğüm için alt düğümler listesinin başına ekler.
PreviousPreOrder(Node)Ön sipariş ağacı geçiş algoritmasına göre önceki düğümü alır.
Remove()Kendini ana öğeden kaldırır.
RemoveAllChildren()Geçerli düğümün tüm alt düğümlerini kaldırır.
RemoveChild<T>(T)Belirtilen alt düğümü kaldırır.
RemoveSmartTags()Tümünü kaldırırSmartTag geçerli düğümün alt düğümleri.
SelectNodes(string)XPath ifadesiyle eşleşen düğümlerin bir listesini seçer.
SelectSingleNode(string)İlkini seçerNode XPath ifadesiyle eşleşen.
ToString(SaveFormat)Düğümün içeriğini belirtilen biçimde bir dizeye aktarır.
ToString(SaveOptions)Belirtilen kaydetme seçeneklerini kullanarak düğümün içeriğini bir dizeye aktarır.

Notlar

HeaderFooter içerebilirParagraph VeMasa çocuk düğümleri.

HeaderFooter bölüm düzeyinde bir düğümdür ve yalnızca bir alt düğüm olabilirSection . Sadece bir tane olabilirHeaderFooter her birininHeaderFooterType birSection.

EğerSection sahip değilHeaderFooter belirli bir türün veya HeaderFooter alt düğümleri olmadığından, bu başlık/alt bilgi Microsoft Word’deki önceki bölümün aynı türünün başlığı/alt bilgisine bağlı olarak kabul edilir.

Ne zamanHeaderFooter en az bir tane içerirParagraph, artık Microsoft Word’de öncekiyle bağlantılı olarak kabul edilmiyor.

Örnekler

Bir belgenin altbilgisindeki metnin nasıl değiştirileceğini gösterir.

Document doc = new Document(MyDir + "Footer.docx");

HeaderFooterCollection headersFooters = doc.FirstSection.HeadersFooters;
HeaderFooter footer = headersFooters[HeaderFooterType.FooterPrimary];

FindReplaceOptions options = new FindReplaceOptions
{
    MatchCase = false,
    FindWholeWordsOnly = false
};

int currentYear = DateTime.Now.Year;
footer.Range.Replace("(C) 2006 Aspose Pty Ltd.", $"Copyright (C) {currentYear} by Aspose Pty Ltd.", options);

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

Bir belgeden tüm altbilgilerin nasıl silineceğini gösterir.

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

// Her bölümü inceleyin ve her türlü altbilgiyi kaldırın.
foreach (Section section in doc.OfType<Section>())
{
    // Üç çeşit altbilgi ve üstbilgi türü vardır.
    // 1 - Bir bölümün yalnızca ilk sayfasında görünen "İlk" üstbilgi/altbilgi.
    HeaderFooter footer = section.HeadersFooters[HeaderFooterType.FooterFirst];
    footer?.Remove();

    // 2 - Tek sayfalarda görünen "Birincil" üstbilgi/altbilgi.
    footer = section.HeadersFooters[HeaderFooterType.FooterPrimary];
    footer?.Remove();

     // 3 - Çift sayfalarda görünen "Çift" üstbilgisi/altbilgisi.
    footer = section.HeadersFooters[HeaderFooterType.FooterEven];
    footer?.Remove();

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

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

Üstbilgi ve altbilginin nasıl oluşturulacağını gösterir.

Document doc = new Document();

// Bir başlık oluşturun ve ona bir paragraf ekleyin. Bu paragraftaki metin
// bu bölümün her sayfasının en üstünde, ana gövde metninin üstünde görünecektir.
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);

// Bir altbilgi oluşturun ve ona bir paragraf ekleyin. Bu paragraftaki metin
// Bu bölümün her sayfasının en altında, ana gövde metninin altında görünecektir.
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");

Ayrıca bakınız