Table of Contents

Class PageHeader

Namespace
Alternet.Editor
Assembly
Alternet.Editor.v10.dll

Represents header/footer parts of the Editor page.

public class PageHeader : IEditPageHeader, IUpdate, IDisposable
Inheritance
PageHeader
Implements

Constructors

PageHeader()

Initializes a new instance of PageHeader class with default settings.

PageHeader(IEditPage, ISyntaxEdit)

Initializes a new instance of PageHeader class with a specified owner.

Properties

CenterText

Gets or sets a string that appears at the center of the header/footer area.

Font

Gets or sets font used to draw header/footer text.

FontColor

Gets or sets font color used to draw header/footer text.

LeftText

Gets or sets a string that appears at the left part of the header/footer area.

Offset

Gets or sets indentation of the primary text edge.

Pages
ReverseOnEvenPages

Gets or sets a value indicating whether the LeftText and RightText interchanging on even page.

RightText

Gets or sets a string that appears at the right part of the header/footer area.

TextRegex
UpdateCount

Keeps track of calls to BeginUpdate and EndUpdate so that they can be nested.

Visible

Gets or sets a value indicating whether the PageHeader is visible.

Methods

Assign(IEditPageHeader)

Copies the contents of another IEditPageHeader object.

BeginUpdate()

Prevents PageHeader updating until calling PageHeader.EndUpdate method.

DisableUpdate()

Prevents PageHeader updating until calling PageHeader.EndUpdate method.

Dispose()

Disposes this PageHeader and frees resources associated with it.

Dispose(bool)
EnableUpdate()

Re-enables PageHeader updating, that was turn of by calling PageHeader.BeginUpdate method.

EndUpdate()

Re-enables page updating, that was turn of by calling PageHeader.BeginUpdate method.

~PageHeader()

Destroys the instance of the PageHeader class.

GetTextToPaint(string, int, int)

Replaces all tags in the given text by their values.

OnCenterTextChanged()
OnDrawHeader(ref string)
OnFontChanged()
OnFontColorChanged()
OnLeftTextChanged()
OnOffsetChanged()
OnReverseOnEvenPagesChanged()
OnRightTextChanged()
OnVisibleChanged()
Paint(IPainter, RectD, int, int, bool)
Paint(IPainter, Rectangle, int, int, bool)

Draws page header/footer on the specified graphic surface.

ResetFont()

Resets the PageHeader.Font to the default value.

ResetFontColor()

Resets the PageHeader.FontColor to the default value.

ResetOffset()

Resets the PageHeader.Offset to the default value.

ResetReverseOnEvenPages()

Resets the PageHeader.ReverseOnEvenPages to the default value.

ShouldSerializeFont()

Indicates whether the Font property should be persisted.

ShouldSerializeFontColor()

Indicates whether the FontColor property should be persisted.

ShouldSerializeOffset()

Indicates whether the Offset property should be persisted.

Update()

Invalidates the header.

Events

DrawHeader

Occurs when header or footer part of each page is drawing.