HeaderFooter

HeaderFooter class

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

public class HeaderFooter : Story

yapıcılar

İsim Tanım
HeaderFooter(DocumentBase, HeaderFooterType) Belirtilen türde yeni bir üstbilgi veya altbilgi oluşturur.

Özellikleri

İsim Tanım
ChildNodes { get; } Bu düğümün tüm acil alt düğümlerini alır.
Count { get; } Bu düğümün acil alt öğelerinin 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 alt öğesini alır.
FirstParagraph { get; } Öyküdeki ilk paragrafı alır.
HasChildNodes { get; } Bu düğümün herhangi bir alt düğümü varsa doğru döndürür.
HeaderFooterType { get; } Bu üstbilgi/altbilginin türünü alır.
override IsComposite { get; } Bu düğümün alt düğümleri olabileceğinden true değerini döndürür.
IsHeader { get; } Bu doğruysa Üstbilgi Altbilgi nesne bir başlıktır.
IsLinkedToPrevious { get; set; } Bu üstbilgi veya altbilgi, önceki bölümdeki ilgili üstbilgi veya altbilgi ile bağlantılıysa doğrudur.
LastChild { get; } Düğümün son alt öğesini alır.
LastParagraph { get; } Öyküdeki son paragrafı alır.
NextSibling { get; } Bu düğümden hemen sonraki düğümü alır.
override NodeType { get; } İade NodeType.HeaderFooter .
Paragraphs { get; } Öykünün doğrudan alt öğeleri olan bir paragraf koleksiyonu alır.
ParentNode { get; } Bu düğümün hemen üst öğesini 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; } Bir döndürür Menzil belgenin bu düğümde bulunan bölümünü temsil eden nesne.
StoryType { get; } Bu hikayenin türünü alır.
Tables { get; } Öykünün doğrudan alt öğeleri olan tabloların bir koleksiyonunu alır.

yöntemler

İsim Tanım
override Accept(DocumentVisitor) Bir ziyaretçiyi kabul eder.
AppendChild(Node) Belirtilen düğümü, bu düğüm için alt düğümler listesinin sonuna ekler.
AppendParagraph(string) BirParagraph isteğe bağlı metin içeren nesne ve onu bu nesnenin sonuna ekler.
Clone(bool) Düğümün bir kopyasını oluşturur.
CreateNavigator() Sistem kullanımı için ayrılmıştır. IXPathNavigable.
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 üst öğesini alır.
GetChild(NodeType, int, bool) Belirtilen türle eşleşen N. alt düğümü döndürür.
GetChildNodes(NodeType, bool) Belirtilen türle eşleşen canlı bir alt düğüm koleksiyonu döndürür.
GetEnumerator() Bu düğümün alt düğümleri üzerinde her stil yinelemesi için destek sağlar.
override GetText() Bu düğümün ve tüm alt öğelerinin metnini alır.
IndexOf(Node) Alt düğüm dizisindeki belirtilen alt düğümün dizinini döndürür.
InsertAfter(Node, Node) Belirtilen referans düğümünden hemen sonra belirtilen düğümü ekler.
InsertBefore(Node, Node) Belirtilen düğümü, belirtilen referans düğümünden hemen önce ekler.
NextPreOrder(Node) Ön sipariş ağaç geçiş algoritmasına göre sonraki düğümü alır.
PrependChild(Node) 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 üst öğeden kaldırır.
RemoveAllChildren() Geçerli düğümün tüm alt düğümlerini kaldırır.
RemoveChild(Node) 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 listesini seçer.
SelectSingleNode(string) XPath ifadesiyle eşleşen ilk Düğümü seçer.
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

Üstbilgi Altbilgi içerebilir Paragraf ve Masa alt düğümler.

Üstbilgi Altbilgi bölüm düzeyinde bir düğümdür ve yalnızca alt öğesi olabilir Bölüm . Yalnızca bir tane olabilir Üstbilgi Altbilgi veya her biriHeaderFooterType içinde Bölüm.

Eğer Bölüm sahip değil Üstbilgi Altbilgi belirli bir türün or Üstbilgi Altbilgi alt düğümü yok, bu üstbilgi/altbilgi, Microsoft Word’deki önceki bölümün aynı türdeki üstbilgi/altbilgisine bağlı olarak kabul edilir.

Ne zaman Üstbilgi Altbilgi en az bir tane içerir Paragraf, artık Microsoft Word’de öncekiyle bağlantılı olarak kabul edilmez.

Örnekler

Belgenin alt bilgisindeki 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 alt bilgilerin nasıl silineceğini gösterir.

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

// Her bölümü yineleyin ve her türden 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 "Eşit" üstbilgi/altbilgi.
    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. O paragraftaki metin
// bu bölümün her sayfasının başında, 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 alt bilgi oluşturun ve ona bir paragraf ekleyin. O paragraftaki metin
// bu bölümün her sayfasının 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