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

PrintSettings Class

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

Represents the default implementation of an object that supports printing the contents of a SyntaxEditor.

public class PrintSettings : IPrintSettings
Inheritance:
object object
Implements:
IPrintSettings

Constructors

PrintSettings()

Initializes a new instance of the PrintSettings class.

public PrintSettings()

Properties

AreCollapsedOutliningNodesAllowed

Gets or sets whether collapsed outlining nodes are allowed.

public 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.

AreColumnGuidesVisible

Gets or sets whether column guides are visible.

public bool AreColumnGuidesVisible { get; set; }

Property Value

bool:

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

AreIndentationGuidesVisible

Gets or sets whether indentation guides are visible.

public bool AreIndentationGuidesVisible { get; set; }

Property Value

bool:

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

AreSquiggleLinesVisible

Gets or sets whether squiggle lines are visible.

public bool AreSquiggleLinesVisible { get; set; }

Property Value

bool:

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

DocumentTitle

Gets or sets the document title that should appear at the top of every page.

public 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.

HighlightingStyleRegistry

Gets or sets the IHighlightingStyleRegistry to use for printouts, if different than the active registry in the editor.

public 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.

IsDocumentTitleMarginVisible

Gets or sets whether the document title margin is visible.

public bool IsDocumentTitleMarginVisible { get; set; }

Property Value

bool:

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

IsLineNumberMarginVisible

Gets or sets whether the line number margin is visible.

public bool IsLineNumberMarginVisible { get; set; }

Property Value

bool:

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

IsPageNumberMarginVisible

Gets or sets whether the page number margin is visible.

public bool IsPageNumberMarginVisible { get; set; }

Property Value

bool:

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

IsSyntaxHighlightingEnabled

Gets or sets whether syntax highlighting is enabled.

public bool IsSyntaxHighlightingEnabled { get; set; }

Property Value

bool:

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

IsWhitespaceVisible

Gets or sets whether whitespace (spaces and tabs) is visible.

public bool IsWhitespaceVisible { get; set; }

Property Value

bool:

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

IsWordWrapGlyphMarginVisible

Gets or sets whether the word wrap glyph margin is visible.

public bool IsWordWrapGlyphMarginVisible { get; set; }

Property Value

bool:

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

ViewMarginFactories

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

public IPrinterViewMarginFactoryCollection ViewMarginFactories { get; }

Property Value

IPrinterViewMarginFactoryCollection:

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

Methods

CreatePrintDocument(SyntaxEditor)

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

public PrintDocument CreatePrintDocument(SyntaxEditor syntaxEditor)
Parameter Type Description
syntaxEditor SyntaxEditor

The SyntaxEditor for which to create a PrintDocument.

Returns

PrintDocument:

The PrintDocument that was created.

ResetAreCollapsedOutliningNodesAllowed()

Resets the AreCollapsedOutliningNodesAllowed property to its default value.

public void ResetAreCollapsedOutliningNodesAllowed()

ResetAreColumnGuidesVisible()

Resets the AreColumnGuidesVisible property to its default value.

public void ResetAreColumnGuidesVisible()

ResetAreIndentationGuidesVisible()

Resets the AreIndentationGuidesVisible property to its default value.

public void ResetAreIndentationGuidesVisible()

ResetAreSquiggleLinesVisible()

Resets the AreSquiggleLinesVisible property to its default value.

public void ResetAreSquiggleLinesVisible()

ResetDocumentTitle()

Resets the DocumentTitle property to its default value.

public void ResetDocumentTitle()

ResetHighlightingStyleRegistry()

Resets the HighlightingStyleRegistry property to its default value.

public void ResetHighlightingStyleRegistry()

ResetIsDocumentTitleMarginVisible()

Resets the IsDocumentTitleMarginVisible property to its default value.

public void ResetIsDocumentTitleMarginVisible()

ResetIsLineNumberMarginVisible()

Resets the IsLineNumberMarginVisible property to its default value.

public void ResetIsLineNumberMarginVisible()

ResetIsPageNumberMarginVisible()

Resets the IsPageNumberMarginVisible property to its default value.

public void ResetIsPageNumberMarginVisible()

ResetIsSyntaxHighlightingEnabled()

Resets the IsSyntaxHighlightingEnabled property to its default value.

public void ResetIsSyntaxHighlightingEnabled()

ResetIsWhitespaceVisible()

Resets the IsWhitespaceVisible property to its default value.

public void ResetIsWhitespaceVisible()

ResetIsWordWrapGlyphMarginVisible()

Resets the IsWordWrapGlyphMarginVisible property to its default value.

public void ResetIsWordWrapGlyphMarginVisible()

ShouldSerializeAreCollapsedOutliningNodesAllowed()

Indicates whether the AreCollapsedOutliningNodesAllowed property should be persisted.

public bool ShouldSerializeAreCollapsedOutliningNodesAllowed()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeAreColumnGuidesVisible()

Indicates whether the AreColumnGuidesVisible property should be persisted.

public bool ShouldSerializeAreColumnGuidesVisible()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeAreIndentationGuidesVisible()

Indicates whether the AreIndentationGuidesVisible property should be persisted.

public bool ShouldSerializeAreIndentationGuidesVisible()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeAreSquiggleLinesVisible()

Indicates whether the AreSquiggleLinesVisible property should be persisted.

public bool ShouldSerializeAreSquiggleLinesVisible()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeDocumentTitle()

Indicates whether the DocumentTitle property should be persisted.

public bool ShouldSerializeDocumentTitle()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeHighlightingStyleRegistry()

Indicates whether the HighlightingStyleRegistry property should be persisted.

public bool ShouldSerializeHighlightingStyleRegistry()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeIsDocumentTitleMarginVisible()

Indicates whether the IsDocumentTitleMarginVisible property should be persisted.

public bool ShouldSerializeIsDocumentTitleMarginVisible()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeIsLineNumberMarginVisible()

Indicates whether the IsLineNumberMarginVisible property should be persisted.

public bool ShouldSerializeIsLineNumberMarginVisible()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeIsPageNumberMarginVisible()

Indicates whether the IsPageNumberMarginVisible property should be persisted.

public bool ShouldSerializeIsPageNumberMarginVisible()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeIsSyntaxHighlightingEnabled()

Indicates whether the IsSyntaxHighlightingEnabled property should be persisted.

public bool ShouldSerializeIsSyntaxHighlightingEnabled()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeIsWhitespaceVisible()

Indicates whether the IsWhitespaceVisible property should be persisted.

public bool ShouldSerializeIsWhitespaceVisible()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

ShouldSerializeIsWordWrapGlyphMarginVisible()

Indicates whether the IsWordWrapGlyphMarginVisible property should be persisted.

public bool ShouldSerializeIsWordWrapGlyphMarginVisible()

Returns

bool:

true if the property value has changed from its default; otherwise, false.

Inherited Members