IPrintSettings Interface

public interface IPrintSettings

bool AreCollapsedOutliningNodesAllowed { get; set; }

Property Value

Boolean:

true if collapsed outlining nodes are allowed; otherwise, false. The default value is false.

Remarks

When false, all collapsed outlining nodes will be expanded within the printout.

bool AreColumnGuidesVisible { get; set; }

Property Value

Boolean:

true if column guides are visible; otherwise, false. The default value is false.

bool AreIndentationGuidesVisible { get; set; }

Property Value

Boolean:

true if indentation guides are visible; otherwise, false. The default value is false.

bool AreSquiggleLinesVisible { get; set; }

Property Value

Boolean:

true if squiggle lines are visible; otherwise, false. The default value is false.

string DocumentTitle { get; set; }

Property Value

String:

The document title that should appear at the top of every page.

Remarks

This is often set to the filename of the document.

IHighlightingStyleRegistry HighlightingStyleRegistry { get; set; }

Property Value

IHighlightingStyleRegistry:

The IHighlightingStyleRegistry to use for printouts, if different than the active registry in the editor.

Remarks

If this property is null, the active registry in the editor will be used. This property should generally be set when the editor is using a dark theme, since printouts require a light theme.

bool IsDocumentTitleMarginVisible { get; set; }

Property Value

Boolean:

true if the document title margin is visible; otherwise, false. The default value is true.

bool IsLineNumberMarginVisible { get; set; }

Property Value

Boolean:

true if the line number margin is visible; otherwise, false. The default value is false.

bool IsPageNumberMarginVisible { get; set; }

Property Value

Boolean:

true if the page number margin is visible; otherwise, false. The default value is true.

bool IsSyntaxHighlightingEnabled { get; set; }

Property Value

Boolean:

true if syntax highlighting is enabled; otherwise, false. The default value is true.

bool IsWhitespaceVisible { get; set; }

Property Value

Boolean:

true if whitespace (spaces and tabs) is visible; otherwise, false. The default value is false.

bool IsWordWrapGlyphMarginVisible { get; set; }

Property Value

Boolean:

true if the word wrap glyph margin is visible; otherwise, false. The default value is true.

Thickness PageMargin { get; set; }

Property Value

Thickness:

The Thickness of the page margin.

Remarks

The default value is 96 * 0.75, where 1 inch = 96px in default resolution. This means the default margin is 0.75in.

Size PageSize { get; set; }

Property Value

Size:

The Size of each page.

Remarks

A standard 8.5" x 11" page would have values 96 * 8.5, 96 * 11, where 1 inch = 96px in default resolution.

IPrinterViewMarginFactoryCollection ViewMarginFactories { get; }

Property Value

IPrinterViewMarginFactoryCollection:

A IPrinterViewMarginFactoryCollection that contains the factories. The default collection contains a DefaultPrinterViewMarginFactory.

FixedDocument CreateFixedDocument(SyntaxEditor syntaxEditor)

Parameter	Type	Description
syntaxEditor	SyntaxEditor	The SyntaxEditor for which to create a FixedDocument.

Returns

FixedDocument:

The FixedDocument that was created.

FixedDocument CreateFixedDocument(SyntaxEditor syntaxEditor, IPrinterViewOptions options)

Parameter	Type	Description
syntaxEditor	SyntaxEditor	The SyntaxEditor for which to create a FixedDocument.
options	IPrinterViewOptions	An IPrinterViewOptions that contains IPrinterView-related options.

Returns

FixedDocument:

The FixedDocument that was created.