API Reference
Class
WordFooter
Represents a footer in a Word document and allows manipulation of its contents.
Inheritance
- WordHeaderFooter
- WordFooter
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method WordDocument.GetFooterForSection
- Method WordDocument.GetFooterForSection
- Property WordDocument.FooterDefaultOrCreate
- Property WordDocument.FooterEvenOrCreate
- Property WordDocument.FooterFirstOrCreate
- Property WordFooters.Default
- Property WordFooters.Even
- Property WordFooters.First
- Method WordSection.GetFooter
- Method WordSection.GetFooter
- Method WordSection.GetOrCreateFooter
Accepted by parameters
- Constructor WordPageNumber.WordPageNumber
Methods
public WordPageNumber AddPageNumber(WordPageNumberStyle wordPageNumberStyle) #Returns:
WordPageNumberAdds a page number to this footer using the specified style.
Parameters
- wordPageNumberStyle OfficeIMO.Word.WordPageNumberStyle
- Style of the page number to insert.
Returns
The created WordPageNumber instance.
Inherited Methods
public WordParagraph AddBookmark(String bookmarkName) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- bookmarkName String
AddField 3 overloads
public WordParagraph AddField(WordFieldType wordFieldType, Nullable<WordFieldFormat> wordFieldFormat = null, String customFormat = null, Boolean advanced = false) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- wordFieldType WordFieldType
- wordFieldFormat Nullable<WordFieldFormat> = null
- customFormat String = null
- advanced Boolean = false
public WordParagraph AddField(WordFieldCode fieldCode, Nullable<WordFieldFormat> wordFieldFormat = null, String customFormat = null, Boolean advanced = false) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- fieldCode WordFieldCode
- wordFieldFormat Nullable<WordFieldFormat> = null
- customFormat String = null
- advanced Boolean = false
public WordParagraph AddField(WordFieldBuilder builder, Boolean advanced = false) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- builder WordFieldBuilder
- advanced Boolean = false
public WordParagraph AddHorizontalLine(Nullable<WordBorderStyle> lineType = null, Nullable<OfficeColor> color = null, UInt32 size = 12, UInt32 space = 1) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- lineType Nullable<WordBorderStyle> = null
- color Nullable<OfficeColor> = null
- size UInt32 = 12
- space UInt32 = 1
AddHyperLink 2 overloads
public WordParagraph AddHyperLink(String text, Uri uri, Boolean addStyle = false, String tooltip = "", Boolean history = true) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- text String
- uri Uri
- addStyle Boolean = false
- tooltip String = ""
- history Boolean = true
public WordParagraph AddHyperLink(String text, String anchor, Boolean addStyle = false, String tooltip = "", Boolean history = true) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- text String
- anchor String
- addStyle Boolean = false
- tooltip String = ""
- history Boolean = true
public WordList AddList(WordListStyle style) #Returns:
WordListInherited from WordHeaderFooter
Parameters
- style WordListStyle
public WordParagraph AddPageNumber(Boolean includeTotalPages = false, Nullable<WordFieldFormat> format = null, String separator = " of ") #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- includeTotalPages Boolean = false
- format Nullable<WordFieldFormat> = null
- separator String = " of "
AddParagraph 2 overloads
public WordParagraph AddParagraph(String text) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- text String
public WordParagraph AddParagraph(Boolean newRun = false) #Returns:
WordParagraphInherited from WordHeaderFooter
Parameters
- newRun Boolean = false
public WordTable AddTable(Int32 rows, Int32 columns, WordTableStyle tableStyle = TableGrid) #Returns:
WordTableInherited from WordHeaderFooter
Parameters
- rows Int32
- columns Int32
- tableStyle WordTableStyle = TableGrid
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Inherited Properties
public List<WordParagraph> Paragraphs { get; } #Inherited from WordHeaderFooter
public List<WordElement> Elements { get; } #Inherited from WordHeaderFooter
public List<WordTable> Tables { get; } #Inherited from WordHeaderFooter
public List<WordTextBox> TextBoxes { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsPageBreaks { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsHyperLinks { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsFields { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsBookmarks { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsEquations { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsStructuredDocumentTags { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsCheckBoxes { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsDatePickers { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsDropDownLists { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsRepeatingSections { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsImages { get; } #Inherited from WordHeaderFooter
public List<WordParagraph> ParagraphsSmartArts { get; } #Inherited from WordHeaderFooter
public List<WordBreak> PageBreaks { get; } #Inherited from WordHeaderFooter
public List<WordImage> Images { get; } #Inherited from WordHeaderFooter
public List<WordSmartArt> SmartArts { get; } #Inherited from WordHeaderFooter
public List<WordBookmark> Bookmarks { get; } #Inherited from WordHeaderFooter
public List<WordField> Fields { get; } #Inherited from WordHeaderFooter
public List<WordHyperLink> HyperLinks { get; } #Inherited from WordHeaderFooter
public List<WordEquation> Equations { get; } #Inherited from WordHeaderFooter
public List<WordStructuredDocumentTag> StructuredDocumentTags { get; } #Inherited from WordHeaderFooter
public List<WordCheckBox> CheckBoxes { get; } #Inherited from WordHeaderFooter
public List<WordDatePicker> DatePickers { get; } #Inherited from WordHeaderFooter
public List<WordDropDownList> DropDownLists { get; } #Inherited from WordHeaderFooter
public List<WordRepeatingSection> RepeatingSections { get; } #Inherited from WordHeaderFooter
public List<WordWatermark> Watermarks { get; } #Inherited from WordHeaderFooter