Table of Contents

Class ScreenView

Namespace
DocWright.Layout
Assembly
DocWright.Layout.dll

A screen view of a document: its text as one continuous flow instead of its pages (View, View).

public sealed class ScreenView
Inheritance
ScreenView
Inherited Members

Remarks

The flow is laid out in bands: pages without margins, headers, footers, columns, page borders or line numbers, each as tall as what it holds. Stacked one under the other they are the flow, line for line and gap for gap, as one band of unbounded height would hold it: nothing is kept together, held back or repeated because a band ends, and a manual page or column break only ends its line. Bands exist so that a consumer which draws, compares or sends pages has pages of bounded size.

Footnotes are not laid out in a view (their reference marks are); endnotes flow where they do on pages. Text keeps its source references, lines and regions, so positions found in a view name the same document text as positions found on a page.

Constructors

ScreenView(ScreenViewKind)

Initializes a view.

Fields

AllLevels

ShowLevel for everything: every heading and the body text.

MaxBandHeightTwips

The tallest BandHeight: what layout's sub-twip arithmetic can address.

MaxWidthTwips

The widest Width.

MinBandHeightTwips

The shortest BandHeight: an inch.

MinWidthTwips

The narrowest Width: an inch.

OutlineIndentTwips

How far Outline view sets a level in from the level above it: half an inch, as Word does (WQ-0128).

OutlineMarkerWidthTwips

The room Outline view leaves left of a paragraph's text for its marker: the marker stands at the level's indent and the text starts this much further in (a quarter of an inch).

Properties

BandHeight

Gets or sets how much a band holds before the flow goes on in the next one, MinBandHeightTwips to MaxBandHeightTwips. Defaults to 11 inches. A band takes whole lines and whole table rows, so it ends a little short of this or, where a paragraph's spacing closes it, a little past it; a row taller than this is split. Where a band ends changes nothing in the flow.

CollapsedHeadings

Gets or sets the headings whose branches Outline leaves out, as paragraph node keys (DomNode.NodeId values; resolution must run with EmitSourceReferences for a paragraph to be known by its key), or null for none. A collapsed heading is laid out; what is under it, down to the next heading of its level or above, is not.

Kind

Gets which view this is.

ShowLevel

Gets or sets how much of the outline Outline lays out: 1 to 9 for the headings down to that level and no body text, or AllLevels (the default) for everything.

Width

Gets or sets the width the text wraps to in Web, MinWidthTwips to MaxWidthTwips. Defaults to 8.5 inches. Draft does not use it: a section's width there is its first text column's.