API Reference
Class
WordHeader
Represents a single header instance within a section.
Inheritance
- WordHeaderFooter
- WordHeader
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.GetHeaderForSection
- Method WordDocument.GetHeaderForSection
- Property WordDocument.HeaderDefaultOrCreate
- Property WordDocument.HeaderEvenOrCreate
- Property WordDocument.HeaderFirstOrCreate
- Property WordHeaders.Default
- Property WordHeaders.Even
- Property WordHeaders.First
- Method WordSection.GetHeader
- Method WordSection.GetHeader
- Method WordSection.GetOrCreateHeader
Accepted by parameters
- Constructor WordPageNumber.WordPageNumber
- Constructor WordWatermark.WordWatermark
Methods
public WordImage AddImageVml(String filePathImage, Nullable<Double> width = null, Nullable<Double> height = null) #Returns:
WordImageAdds a VML image to the header.
Parameters
- filePathImage System.String
- width System.Nullable{System.Double} = null
- height System.Nullable{System.Double} = null
public WordPageNumber AddPageNumber(WordPageNumberStyle wordPageNumberStyle) #Returns:
WordPageNumberAdds a page number field to the header.
Parameters
- wordPageNumberStyle OfficeIMO.Word.WordPageNumberStyle
- The numbering style to apply.
Returns
The created WordPageNumber.
AddShape 2 overloads
public WordShape AddShape(WordShapeType shapeType, Double widthPt, Double heightPt, String fillColor = "#FFFFFF", String strokeColor = "#000000", Double strokeWeightPt = 1, Double arcSize = 0.25) #Returns:
WordShapeAdds a VML shape to the header.
Parameters
- shapeType OfficeIMO.Word.WordShapeType
- Type of shape to create.
- widthPt System.Double
- Width in points or line end X.
- heightPt System.Double
- Height in points or line end Y.
- fillColor System.String = "#FFFFFF"
- Fill color in hex format.
- strokeColor System.String = "#000000"
- Stroke color in hex format.
- strokeWeightPt System.Double = 1
- Stroke weight in points.
- arcSize System.Double = 0.25
- Corner roundness fraction for rounded rectangles.
public WordShape AddShape(WordShapeType shapeType, Double widthPt, Double heightPt, OfficeColor fillColor, OfficeColor strokeColor, Double strokeWeightPt = 1, Double arcSize = 0.25) #Returns:
WordShapeAdds a VML shape to the header using OfficeColor values.
Parameters
- arg1 OfficeIMO.Word.WordShapeType
- arg2 System.Double
- arg3 System.Double
- arg4 OfficeIMO.Drawing.OfficeColor
- arg5 OfficeIMO.Drawing.OfficeColor
- arg6 System.Double = 1
- arg7 System.Double = 0.25
public WordShape AddShapeDrawing(WordShapeType shapeType, Double widthPt, Double heightPt) #Returns:
WordShapeAdds a DrawingML shape to the header.
Parameters
- shapeType OfficeIMO.Word.WordShapeType
- Type of shape to create.
- widthPt System.Double
- Width in points.
- heightPt System.Double
- Height in points.
public WordTextBox AddTextBox(String text, WordImageTextWrapping wrapTextImage = Square) #Returns:
WordTextBoxAdds a text box to the header.
Parameters
- text System.String
- Text contained in the text box.
- wrapTextImage OfficeIMO.Word.WordImageTextWrapping = Square
- Wrapping style.
Returns
The created WordTextBox.
public WordTextBox AddTextBoxVml(String text) #Returns:
WordTextBoxAdds a VML text box to the header.
Parameters
- text System.String
public WordWatermark AddWatermark(WordWatermarkStyle watermarkStyle, String textOrFilePath, Nullable<Double> horizontalOffset = null, Nullable<Double> verticalOffset = null, Double scale = 1) #Returns:
WordWatermarkAdds a watermark to the header.
Parameters
- watermarkStyle OfficeIMO.Word.WordWatermarkStyle
- Watermark style.
- textOrFilePath System.String
- Text or image path for the watermark.
- horizontalOffset System.Nullable{System.Double} = null
- Horizontal offset in points.
- verticalOffset System.Nullable{System.Double} = null
- Vertical offset in points.
- scale System.Double = 1
- Scale factor for width and height.
Returns
The created WordWatermark.
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