headersfooters-ag凯发旗舰厅

overview

package

class

tree

deprecated

index

help

prev class next class

frames no frames

summary: nested | field | constr | method

detail: field | constr | method

com.spire.doc
class headersfooters

java.lang.object
  com.spire.doc.ownerholder
      com.spire.doc.documents.xml.documentserializable
          com.spire.doc.headersfooters

all implemented interfaces:: java.lang.iterable

public class headersfooters
extends documentserializable
implements java.lang.iterable
extends documentserializable
implements java.lang.iterable

method summary
`headerfooter`	`get(int index)` gets textbody at specified index.
`headerfooter`	`getbyheaderfootertype(headerfootertype hftype)` gets textbody by specified headerfooter type.
`headerfooter`	`getevenfooter()` gets even footer
`headerfooter`	`getevenheader()` gets even header.
`headerfooter`	`getfirstpagefooter()` gets first page footer.
`headerfooter`	`getfirstpageheader()` gets first page header.
`headerfooter`	`getfooter()` gets default footer.
`headerfooter`	`getheader()` gets default header.
`boolean`	`getlinktoprevious()`
`headerfooter`	`getoddfooter()` gets odd footer ( this is also the default footer ).
`headerfooter`	`getoddheader()` gets odd header ( this is also the default header ).
`boolean`	`isempty()` detects whether all headers/footers are empty.
`java.util.iterator`	`iterator()` returns an enumerator that iterates through a collection.
`void`	`setlinktoprevious(boolean value)` if set to true if this header or footer is linked in the previous section.

methods inherited from class com.spire.doc.ownerholder
`getdocument`

method detail

getheader

public headerfooter getheader()

gets default header.

returns:: headerfooter

getfooter

public headerfooter getfooter()

gets default footer.

returns:: headerfooter

getevenheader

public headerfooter getevenheader()

gets even header.

returns:: headerfooter

getoddheader

public headerfooter getoddheader()

gets odd header ( this is also the default header ).

returns:: headerfooter

getevenfooter

public headerfooter getevenfooter()

gets even footer

returns:: headerfooter

getoddfooter

public headerfooter getoddfooter()

gets odd footer ( this is also the default footer ).

returns:: headerfooter

getfirstpageheader

public headerfooter getfirstpageheader()

gets first page header.

returns:: headerfooter

getfirstpagefooter

public headerfooter getfirstpagefooter()

gets first page footer.

returns:: headerfooter

isempty

public boolean isempty()

detects whether all headers/footers are empty.

returns:: headerfooter

get

public headerfooter get(int index)

gets textbody at specified index.

parameters:: index - int
returns:: headerfooter

getbyheaderfootertype

public headerfooter getbyheaderfootertype(headerfootertype hftype)

gets textbody by specified headerfooter type.

parameters:: hftype - headerfootertype
returns:: headerfooter

getlinktoprevious

public boolean getlinktoprevious()

setlinktoprevious

public void setlinktoprevious(boolean value)

if set to true if this header or footer is linked in the previous section.

parameters:: value - boolean

iterator

public java.util.iterator iterator()

returns an enumerator that iterates through a collection.

returns:: an iterator object that can be used to iterate through the collection.