Class PrintOptionsControl

Represents a control that provides set of options while printing the page control.

Inheritance

System.Object

PrintOptionsControl

Implements

System.IDisposable

System.ComponentModel.INotifyPropertyChanged

Namespace: Syncfusion.Windows.Shared.Printing

Assembly: Syncfusion.Shared.WPF.dll

Syntax

public class PrintOptionsControl : Control, IDisposable, INotifyPropertyChanged

Constructors

PrintOptionsControl()

Initializes a new instance of PrintOptionsControl class.

Declaration

public PrintOptionsControl()

Fields

PrintOrientationProperty

Identifies the Syncfusion.Windows.Shared.Printing.PrintOptionsControl.PrintOrientation dependency property.

Declaration

public static readonly DependencyProperty PrintOrientationProperty

Field Value

Type
System.Windows.DependencyProperty

Remarks

The identifier for the Syncfusion.Windows.Shared.Printing.PrintOptionsControl.PrintOrientation dependency property.

SelectedScaleIndexProperty

Identifies the Syncfusion.Windows.Shared.Printing.SelectedScaleIndex dependency property.

Declaration

public static readonly DependencyProperty SelectedScaleIndexProperty

Field Value

Type
System.Windows.DependencyProperty

Remarks

The identifier for the Syncfusion.Windows.Shared.Printing.SelectedScaleIndex dependency property.

Properties

CopiesCount

Gets or sets the CopiesCount of the printing element.

Declaration

public int CopiesCount { get; set; }

Property Value

Type
System.Int32

FromPage

Gets or sets the FromPage of the printing element.

Declaration

public int FromPage { get; set; }

Property Value

Type
System.Int32

MarginOptions

Gets or set the value to the PageMargin options.

Declaration

public List<PrintPageMargin> MarginOptions { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<PrintPageMargin>	The value is PrintPageMargin.

OrientationOptions

Gets the value to the Orientation options.

Declaration

public List<PrintPageOrientation> OrientationOptions { get; }

Property Value

Type
System.Collections.Generic.List<PrintPageOrientation>

PageSizeOptions

Gets or set the value to the PrintPageSize options.

Declaration

public List<PrintPageSize> PageSizeOptions { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<PrintPageSize>	The value is PrintPageSize.

PrintCommand

Gets the command to invoke the print process for page control.

Declaration

public ICommand PrintCommand { get; }

Property Value

Type
System.Windows.Input.ICommand

Printers

Gets the printers list from the System.

Declaration

public List<PrintQueueOption> Printers { get; }

Property Value

Type
System.Collections.Generic.List<PrintQueueOption>

PrintOrientation

Gets or sets the PrintOrientation that indicates whether the documents are printed in portrait or landscape mode.

Declaration

public PrintOrientation PrintOrientation { get; set; }

Property Value

Type	Description
PrintOrientation	One of the PrintOrientation enumeration that specifies the orientation for printing. The default value is .

PrintPageCollationOptions

Gets the value to the PrintPageCollation options.

Declaration

public List<PrintPageCollation> PrintPageCollationOptions { get; }

Property Value

Type
System.Collections.Generic.List<PrintPageCollation>

PrintPageRangeSelectionOptions

Gets the value to the PageRangeSelection options.

Declaration

public List<PrintPageRangeSelection> PrintPageRangeSelectionOptions { get; }

Property Value

Type
System.Collections.Generic.List<PrintPageRangeSelection>

QuickPrintCommand

Gets the command to invoke the quick print process for page control.

Declaration

public ICommand QuickPrintCommand { get; }

Property Value

Type
System.Windows.Input.ICommand

ScaleOptions

Gets the print scale option values.

Declaration

public List<PrintScaleInfo> ScaleOptions { get; }

Property Value

Type
System.Collections.Generic.List<PrintScaleInfo>

SelectedCollation

Gets or sets the SelectedCollation State.

Declaration

public Collation SelectedCollation { get; set; }

Property Value

Type
System.Printing.Collation

SelectedPageSize

Gets or sets the selected pagesize.

Declaration

public PrintPageSize SelectedPageSize { get; set; }

Property Value

Type
PrintPageSize

SelectedPrinter

Gets or sets the selected printer.

Declaration

public PrintQueueOption SelectedPrinter { get; set; }

Property Value

Type
PrintQueueOption

SelectedPrintPageRange

Gets or sets the PageRangeSelection state.

Declaration

public PageRangeSelection SelectedPrintPageRange { get; set; }

Property Value

Type
System.Windows.Controls.PageRangeSelection

SelectedScaleIndex

Gets or sets the selected index of scaling options selected Item.

Declaration

public int SelectedScaleIndex { get; set; }

Property Value

Type	Description
System.Int32	The index of the scaling options selected Item.The default value is 0.

ToPage

Gets or sets the ToPage of the printing element.

Declaration

public int ToPage { get; set; }

Property Value

Type
System.Int32

Methods

Dispose()

Releases all the resources used by the PrintOptionsControl class.

Declaration

public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the PrintOptionsControl class.

Declaration

protected virtual void Dispose(bool isDisposing)

Parameters

Type	Name	Description
System.Boolean	isDisposing	Indicates whether the call is from Dispose method or from a finalizer.

OnApplyTemplate()

Builds the visual tree for the print options control when a new template is applied.

Declaration

public override void OnApplyTemplate()

OnPropertyChanged(String)

Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data.

Declaration

protected void OnPropertyChanged(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	The Dependency Property Name.

Events

PropertyChanged

Occurs when a property value changes in PrintOptionsControl class.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.IDisposable

System.ComponentModel.INotifyPropertyChanged