Click or drag to resize

Banner Class

A banner is a document header or a document footer. This class handling banner objects.
Inheritance Hierarchy
SystemObject
  SOWIDocument.WordBanner

Namespace:  SOWIDocument.Word
Assembly:  SOWIDocument.Word (in SOWIDocument.Word.dll) Version: 22.2.10.1 (22.2.10.450)
Syntax
Copy
public class Banner

The Banner type exposes the following members.

Constructors
  NameDescription
Public methodBanner
Initializes a new instance of the Banner class. Constructor without parameter
Public methodBanner(Document, BannerPositions)
Initializes a new instance of the Banner class. Constructor with parameter
Top
Properties
  NameDescription
Public propertyPosition
Representation a header or a footer
Top
Methods
  NameDescription
Public methodAddBanner(BannerPages, String, String)
Adds a header or footer of this document
Private methodAddBanner(MainDocumentPart, SectionProperties, BannerPositions, BannerPages, String, String)
Add a header or footer
Protected methodAddElement
Add a Open XML element to header or footer (see property Position)
Public methodCreate
Create header and footer including default, first and even. If they don't exist.
Public methodExist
Check exists the banner (header or footer: default, first or even)
Protected methodGet
Gives a Open XML part or header or footer
Protected methodGetPartID
Gives part ID of parameter pPage
Protected methodGetReferences
Gives body header references or body footer references
Public methodGetSections
Gives a list of sections of header or footer
Public methodRemove
Remove paragraph or table of banner (default, first, even or odd) by list of elements
Public methodTest_Get
Test case about method Get(BannerPages) because method is internal declaration
Public methodCode exampleTest_GetSections
Test case about method Get(BannerPages) because method is internal declaration
Top
Extension Methods
  NameDescription
Public Extension MethodCode exampleConvertDateFromSQL
Convert SQL date include value null
(Defined by Extension.)
Public Extension MethodConvertDateToSQL
Convert C# date type to SQL date type
(Defined by Extension.)
Top
Remarks
As a sub object from Document

An open XML code header references example <w:sectPr> … <w:headerReference r:id="rId3" w:type="first" /> <w:headerReference r:id="rId5" w:type="default" /> <w:headerReference r:id="rId2" w:type="even" /> … </w:sectPr>

See Also