Table of Contents

Class EditPages

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

Represents a collection of pages in the Edit control.

public class EditPages : IEditPages, IUpdate, IDisposable, IEnumerable<IEditPage>, IEnumerable
Inheritance
EditPages
Implements
Extension Methods

Constructors

EditPages()

Initializes a new instance of the EditPages class with default settings.

EditPages(ISyntaxEdit)

Initializes a new instance of the EditPages class with the specified owner.

Properties

ApplyRulerToAllPages

Gets or sets a boolean value that indicates that changing of rulers indentation applies to all pages rather than to current page.

BackColor

Gets or sets a background color of each page in the collection.

BorderColor

Gets or sets a border color of each page in the collection.

Caps

Gets size in pixels per logical inch of entire screen.

Count

Represents a number of pages in the collection.

DefaultLandscape

Represents default page landscape.

DefaultMargins

Represents default page margins.

DefaultPage

Gets or sets properties for default IEditPage object in the pages collection.

DefaultPageKind

Represents default page kind.

DefaultPageSize

Represents default page size.

DisplayWhiteSpace

Gets or sets a boolean value that indicates whether Edit control should draw whitespace area between pages.

Height

Represents total height of all pages in the collection.

HorzRuler

Represents IEditRuler object used as a horizontal page ruler.

this[int]

Provides an indexed access to individual IEditPage stored in the collection.

List

Provides an indexed access to individual pages within IEditPages collection.

Owner

Gets Edit control owns this pages.

PageKind

Gets or sets kind of the pages specifying standard paper size.

PageType

Gets or sets value specifying the way of viewing Edit control's content.

RulerBackColor

Gets or sets background color of the pages rulers.

RulerIndentBackColor

Gets or sets background color of the indentations parts of the pages rulers.

RulerOptions

Gets or sets options of the pages rulers.

RulerUnits

Gets or sets measurement units of the pages rulers.

Rulers

Gets or sets the rulers displayed within Edit control.

Transparent

Gets or sets a boolean value that indicates whether Edit control should draw background around the pages.

UpdateCount

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

VertRuler

Represents IEditRuler object used as a vertical page ruler.

Width

Represents pages width.

Methods

Add()

Adds a new IEditPage to the collection.

Assign(IEditPages)

Assigns most relevant properties from another IEditPages object.

BeginUpdate()

Prevents pages updating until calling EditPages.EndUpdate method.

CancelDragging()

Cancels dragging operation of the page ruler.

Clear()

Removes all items from the pages collection.

DisableUpdate()

Prevents object state updating until calling EnableUpdate method.

DisplayRulers(bool)

Displays rulers if needed.

Dispose()

Disposes this EditPages and frees resources associated with it.

Dispose(bool)
EnableUpdate()

Re-enables object state updating, that was turn of by calling DisableUpdate method. Using DisableUpdate/EnableUpdate to prevent notifying about updating the object state.

EndUpdate()

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

~EditPages()

Destroys the instance of the EditPages class.

GetPage(int)
GetPageAt(Point)

Finds page at specified display position.

GetPageAt(int, int)

Finds page at specified display position.

GetPageAtCursor()

Finds page at caret position.

GetPageAtPoint(PointD)
GetPageAtPoint(double, double)
GetPageAtPoint(Point)

Finds page at specified screen position.

GetPageAtPoint(int, int)

Finds page at specified screen position.

GetPageIndexAt(Point)

Finds page at specified display position.

GetPageIndexAt(int, int)

Finds page at specified display position.

GetPageIndexAtCursor()

Finds page at caret position.

GetPageIndexAtPoint(PointD)
GetPageIndexAtPoint(double, double)
GetPageIndexAtPoint(Point)

Finds page at specified screen position.

GetPageIndexAtPoint(int, int)

Finds page at specified screen position.

IndexOf(IEditPage)

Returns index of page within page collection.

InitDefaultPageSettings()
InitDefaultPageSettings(PageSettings)
InitDefaultPageSettings(PageSettings, bool)
InitDefaultPageSettings(PageSettings)

Initializes page setting with default values.

InitDefaultPageSettings(PageSettings, bool)
InitDefaultPrinterSettings()
InitPages()
Invalidate(IEditPage)

Invalidates specified page.

IsTransparent(bool)

Indicates whether pages are transparent.

OnApplyRulerToAllPagesChanged()
OnBackColorChanged()
OnBorderColorChanged()
OnDefaultPageChanged()
OnDisplayWhiteSpaceChanged()
OnDrawHeader(ref string)

Raises DrawHeader event.

OnPageTypeChanged()
OnRulerBackColorChanged()
OnRulerIndentBackColorChanged()
OnRulerOptionsChanged()
OnRulerUnitsChanged()
OnRulersChanged()
OnTransparentChanged()
Paint(IPainter, RectD)
Paint(IPainter, Rectangle)

Draws pages collection on the graphic surface.

RecalculatePages()
ResetBackColor()

Resets BackColor to the default value.

ResetBorderColor()

Resets BorderColor to the default value.

ResetDisplayWhiteSpace()

Resets DisplayWhiteSpace to the default value.

ResetPageType()

Resets PageType to the default value.

ResetRulerBackColor()

Resets RulerBackColor to the default value.

ResetRulerIndentBackColor()

Resets RulerIndentBackColor to the default value.

ResetRulerOptions()

Resets RulerOptions to the default value.

ResetRulerUnits()

Resets RulerUnits to the default value.

ResetRulers()

Resets Rulers to the default value.

RulerChanged(object, EventArgs)
ShouldSerializeBackColor()

Indicates whether the BackColor property should be persisted.

ShouldSerializeBorderColor()

Indicates whether the BorderColor property should be persisted.

ShouldSerializePageKind()

Indicates whether the PageKind property should be persisted.

ShouldSerializeRulerBackColor()

Indicates whether the RulerBackColor property should be persisted.

ShouldSerializeRulerIndentBackColor()

Indicates whether the RulerIndentBackColor property should be persisted.

ShouldSerializeRulerOptions()

Indicates whether the RulerOptions property should be persisted.

Update()

Recalculates bounds of all pages in the collection.

Update(IEditPage)

Recalculates bounds of the specified page.

Update(IEditPage, bool)

Recalculates bounds and updates content of specified page.

UpdatePageSize()
UpdatePageSize(bool)
UpdatePages(int)

Recalculates bounds and updates content of specified page.

UpdatePages(int, int, bool)
UpdateRulerAllowDrag()
UpdateRulerSize()

Events

DrawHeader

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