Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

IPrintSettings Interface

Namespace:
ActiproSoftware.UI.WinForms.Controls.SyntaxEditor
Assembly:
ActiproSoftware.SyntaxEditor.WinForms.dll

Provides the base requirements for an object that supports printing the contents of a SyntaxEditor.

public interface IPrintSettings

Properties

AreCollapsedOutliningNodesAllowed

Indicates whether collapsed outlining nodes are allowed.

bool AreCollapsedOutliningNodesAllowed { get; set; }

Property Value

bool:

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.

See Also

AreColumnGuidesVisible

Indicates whether column guides are visible.

bool AreColumnGuidesVisible { get; set; }

Property Value

bool:

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

See Also

AreIndentationGuidesVisible

Indicates whether indentation guides are visible.

bool AreIndentationGuidesVisible { get; set; }

Property Value

bool:

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

See Also

AreSquiggleLinesVisible

Indicates whether squiggle lines are visible.

bool AreSquiggleLinesVisible { get; set; }

Property Value

bool:

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

See Also

DocumentTitle

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

string? DocumentTitle { get; set; }

Property Value

string

Remarks

This is often set to the filename of the document.

See Also

HighlightingStyleRegistry

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

IHighlightingStyleRegistry? HighlightingStyleRegistry { get; set; }

Property Value

IHighlightingStyleRegistry

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.

See Also

IsDocumentTitleMarginVisible

Indicates whether the document title margin is visible.

bool IsDocumentTitleMarginVisible { get; set; }

Property Value

bool:

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

See Also

IsLineNumberMarginVisible

Indicates whether the line number margin is visible.

bool IsLineNumberMarginVisible { get; set; }

Property Value

bool:

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

See Also

IsPageNumberMarginVisible

Indicates whether the page number margin is visible.

bool IsPageNumberMarginVisible { get; set; }

Property Value

bool:

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

See Also

IsSyntaxHighlightingEnabled

Indicates whether syntax highlighting is enabled.

bool IsSyntaxHighlightingEnabled { get; set; }

Property Value

bool:

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

See Also

IsWhitespaceVisible

Indicates whether whitespace (spaces and tabs) is visible.

bool IsWhitespaceVisible { get; set; }

Property Value

bool:

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

See Also

IsWordWrapGlyphMarginVisible

Indicates whether the word wrap glyph margin is visible.

bool IsWordWrapGlyphMarginVisible { get; set; }

Property Value

bool:

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

See Also

ViewMarginFactories

The collection that contains the IPrinterViewMarginFactory objects used to generate the margins for an IPrinterView.

IPrinterViewMarginFactoryCollection ViewMarginFactories { get; }

Property Value

IPrinterViewMarginFactoryCollection:

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

See Also

Methods

CreatePrintDocument(SyntaxEditor)

Creates a PrintDocument that is prepared to create a representation of the editor contents, allowing for printing.

PrintDocument CreatePrintDocument(SyntaxEditor syntaxEditor)
Parameter Type Description
syntaxEditor SyntaxEditor

The SyntaxEditor for which to create a PrintDocument.

Returns

PrintDocument

See Also

Extension Methods

See Also