Class RTF::HeaderNode
In: lib/rtf/node.rb
Parent: CommandNode

This class represents a document header.

Methods

footnote   new  

Constants

UNIVERSAL = :header   A definition for a header type.
LEFT_PAGE = :headerl   A definition for a header type.
RIGHT_PAGE = :headerr   A definition for a header type.
FIRST_PAGE = :headerf   A definition for a header type.

Attributes

type  [R]  Attribute accessor.
type  [W]  Attribute mutator.

Public Class methods

This is the constructor for the HeaderNode class.

Parameters

document:A reference to the Document object that will own the new header.
type:The style type for the new header. Defaults to a value of HeaderNode::UNIVERSAL.

Public Instance methods

This method overloads the footnote method inherited from the CommandNode class to prevent footnotes being added to headers.

Parameters

text:Not used.

Exceptions

RTFError:Always generated whenever this method is called.

[Validate]