New to Telerik UI for WinForms? Start a free 30-day trial

A dialog for previwing and setting before printing.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadPrintPreviewDialog : RadForm, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IComponentTreeHandler, ILayoutHandler, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged, IAnalyticsProvider, ISupportRootUIAutomation

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlFormRadFormControlBaseRadFormRadPrintPreviewDialog...

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIContainerControlIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISupportRootUIAutomationISynchronizeInvokeIWin32Window...

Inherited Members RadForm.ScrollToControl(Control)RadForm.EndInit()RadForm.WndProc(ref Message)RadForm.ProcessCaptureChangeRequested(RadElement, bool)RadForm.InitializeFormBehavior()RadForm.SetIconPrimitiveVisibility(bool)RadForm.EnableUIAutomationRadForm.TextRadForm.ThemeClassNameRadForm.FormElementRadForm.IconScalingRadForm.AllowThemingRadForm.ShowIconRadFormControlBase.newBoundsRadFormControlBase.oldDpiRadFormControlBase.currentDpiRadFormControlBase.isBehaviorPreparedRadFormControlBase.controlIsInitializingRootComponentRadFormControlBase.isPaintingRadFormControlBase.Construct()RadFormControlBase.OnCreateControl()RadFormControlBase.LoadElementTree()RadFormControlBase.LoadElementTree(Size)RadFormControlBase.OnLoad(Size)RadFormControlBase.OnPaint(PaintEventArgs)RadFormControlBase.OnPaintBackground(PaintEventArgs)RadFormControlBase.ProcessDialogKey(Keys)RadFormControlBase.UpdateDefaultButton()RadFormControlBase.OnBackColorChanged(EventArgs)RadFormControlBase.OnForeColorChanged(EventArgs)RadFormControlBase.OnFontChanged(EventArgs)RadFormControlBase.OnParentChanged(EventArgs)RadFormControlBase.ShouldSerializeProperty(RadProperty)RadFormControlBase.ResetFormBehavior(bool)RadFormControlBase.PerformDesignModeLocationCorrection(ref Message)RadFormControlBase.CallBaseWndProc(ref Message)RadFormControlBase.ProcessFocusRequested(RadElement)RadFormControlBase.OnNotifyPropertyChanged(string)RadFormControlBase.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadFormControlBase.CreateChildItems(RadElement)RadFormControlBase.CreateRootElement()RadFormControlBase.OnThemeNameChanged(ThemeNameChangedEventArgs)RadFormControlBase.OnThemeChanged()RadFormControlBase.OnDisplayPropertyChanged(RadPropertyChangedEventArgs)RadFormControlBase.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadFormControlBase.OnHandleCreated(EventArgs)RadFormControlBase.OnVisibleChanged(EventArgs)RadFormControlBase.OnAutoSizeChanged(EventArgs)RadFormControlBase.OnLayout(LayoutEventArgs)RadFormControlBase.CreateHandle()RadFormControlBase.SetClientSizeCore(int, int)RadFormControlBase.SetBoundsCore(int, int, int, int, BoundsSpecified)RadFormControlBase.GetPreferredSize(Size)RadFormControlBase.InvalidateIfNotSuspended()RadFormControlBase.InvalidateElement(RadElement)RadFormControlBase.InvalidateElement(RadElement, Rectangle)RadFormControlBase.AddInvalidatedRect(Rectangle)RadFormControlBase.SuspendUpdate()RadFormControlBase.ResumeUpdate()RadFormControlBase.ResumeUpdate(bool)RadFormControlBase.RegisterHostedControl(RadHostItem)RadFormControlBase.UnregisterHostedControl(RadHostItem, bool)RadFormControlBase.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadFormControlBase.ControlThemeChangedCallback()RadFormControlBase.InvokeLayoutCallback(LayoutCallback)RadFormControlBase.BeginInit()RadFormControlBase.HandleDpiChanged()RadFormControlBase.ScaleControl(SizeF, BoundsSpecified)RadFormControlBase.SuspendDpiScaling()RadFormControlBase.ResumeDpiScaling()RadFormControlBase.OnWm_SettingChange(Message)RadFormControlBase.SiteRadFormControlBase.EnableAnalyticsRadFormControlBase.IsLoadedRadFormControlBase.MaximumSizeRadFormControlBase.MinimumSizeRadFormControlBase.FormBorderStyleRadFormControlBase.FormBehaviorRadFormControlBase.BehaviorRadFormControlBase.SmallImageListRadFormControlBase.FocusedElementRadFormControlBase.AllowShowFocusCuesRadFormControlBase.ShowItemToolTipsRadFormControlBase.CommandBindingsRadFormControlBase.EnableKeyMapRadFormControlBase.WindowsSettingsRadFormControlBase.BackColorRadFormControlBase.ForeColorRadFormControlBase.FontRadFormControlBase.CreateParamsRadFormControlBase.IsDesignModeRadFormControlBase.ElementTreeRadFormControlBase.ThemeNameRadFormControlBase.RootElementRadFormControlBase.IsUpdateSuspendedRadFormControlBase.ImageListRadFormControlBase.SmallImageScalingSizeRadFormControlBase.ImageScalingSizeRadFormControlBase.IsInitializedRadFormControlBase.IsPerformingScaleRadFormControlBase.HasOwnToolbarRadFormControlBase.IsDpiScalingSuspendedRadFormControlBase.ThemeNameChangedRadFormControlBase.ToolTipTextNeededRadFormControlBase.ScreenTipNeededRadFormControlBase.InitializedRadFormControlBase.PropertyChangedRadFormControlBase.WindowsThemeChangedForm.SetVisibleCore(bool)Form.Activate()Form.ActivateMdiChild(Form)Form.AddOwnedForm(Form)Form.AdjustFormScrollbars(bool)Form.Close()Form.CreateControlsInstance()Form.DefWndProc(ref Message)Form.ProcessMnemonic(char)Form.CenterToParent()Form.CenterToScreen()Form.LayoutMdi(MdiLayout)Form.OnActivated(EventArgs)Form.OnBackgroundImageChanged(EventArgs)Form.OnBackgroundImageLayoutChanged(EventArgs)Form.OnClosing(CancelEventArgs)Form.OnClosed(EventArgs)Form.OnFormClosing(FormClosingEventArgs)Form.OnFormClosed(FormClosedEventArgs)Form.OnDeactivate(EventArgs)Form.OnEnabledChanged(EventArgs)Form.OnEnter(EventArgs)Form.OnHandleDestroyed(EventArgs)Form.OnHelpButtonClicked(CancelEventArgs)Form.OnMaximizedBoundsChanged(EventArgs)Form.OnMaximumSizeChanged(EventArgs)Form.OnMinimumSizeChanged(EventArgs)Form.OnInputLanguageChanged(InputLanguageChangedEventArgs)Form.OnInputLanguageChanging(InputLanguageChangingEventArgs)Form.OnMdiChildActivate(EventArgs)Form.OnMenuStart(EventArgs)Form.OnMenuComplete(EventArgs)Form.OnResize(EventArgs)Form.OnDpiChanged(DpiChangedEventArgs)Form.OnGetDpiScaledSize(int, int, ref Size)Form.OnRightToLeftLayoutChanged(EventArgs)Form.OnTextChanged(EventArgs)Form.ProcessDialogChar(char)Form.ProcessKeyPreview(ref Message)Form.ProcessTabKey(bool)Form.RemoveOwnedForm(Form)Form.Select(bool, bool)Form.GetScaledBounds(Rectangle, SizeF, BoundsSpecified)Form.SetDesktopBounds(int, int, int, int)Form.SetDesktopLocation(int, int)Form.Show(IWin32Window)Form.ShowDialog()Form.ShowDialog(IWin32Window)Form.ToString()Form.OnResizeBegin(EventArgs)Form.OnResizeEnd(EventArgs)Form.OnStyleChanged(EventArgs)Form.ValidateChildren()Form.ValidateChildren(ValidationConstraints)Form.AcceptButtonForm.ActiveFormForm.ActiveMdiChildForm.AllowTransparencyForm.AutoScrollForm.AutoSizeForm.AutoSizeModeForm.AutoValidateForm.CancelButtonForm.ClientSizeForm.ControlBoxForm.DefaultImeModeForm.DefaultSizeForm.DesktopBoundsForm.DesktopLocationForm.DialogResultForm.HelpButtonForm.IconForm.IsMdiChildForm.IsMdiContainerForm.IsRestrictedWindowForm.KeyPreviewForm.LocationForm.MaximizedBoundsForm.MainMenuStripForm.MenuForm.MaximizeBoxForm.MdiChildrenForm.MdiParentForm.MergedMenuForm.MinimizeBoxForm.ModalForm.OpacityForm.OwnedFormsForm.OwnerForm.RestoreBoundsForm.RightToLeftLayoutForm.ShowInTaskbarForm.ShowWithoutActivationForm.SizeForm.SizeGripStyleForm.StartPositionForm.TopLevelForm.TopMostForm.TransparencyKeyForm.WindowStateForm.AutoSizeChangedForm.AutoValidateChangedForm.HelpButtonClickedForm.MaximizedBoundsChangedForm.MaximumSizeChangedForm.MinimumSizeChangedForm.ActivatedForm.DeactivateForm.FormClosingForm.FormClosedForm.LoadForm.MdiChildActivateForm.MenuCompleteForm.MenuStartForm.InputLanguageChangedForm.InputLanguageChangingForm.RightToLeftLayoutChangedForm.ShownForm.DpiChangedForm.ResizeBeginForm.ResizeEnd...

Constructors

Creates a preview dialog with no document assigned.

C#
public RadPrintPreviewDialog()

Creates a preview dialog for the specified print document.

C#
public RadPrintPreviewDialog(RadPrintDocument document)
Parameters:documentRadPrintDocument

The document to display in the preview.

Fields

Moves the preview to the following page.

C#
protected CommandBarButton buttonNextPage

Moves the preview to the preceding page.

C#
protected CommandBarButton buttonPrevPage

Opens the system print dialog for the current document.

C#
protected CommandBarButton buttonPrint

Opens the associated object's print-settings dialog.

C#
protected CommandBarButton buttonSettings

Increases the preview zoom.

C#
protected CommandBarButton buttonZoomIn

Reduces the preview zoom.

C#
protected CommandBarButton buttonZoomOut

Opens the watermark editor for the current document.

C#
protected CommandBarButton commandBarButtonWatermark

Opens the page-layout picker for choosing preview rows and columns.

C#
protected CommandBarDropDownButton dropDownButtonLayout

Provides predefined zoom levels and automatic zoom for the preview.

C#
protected CommandBarDropDownList dropDownZoom

Displays the total number of pages in the document.

C#
protected CommandBarLabel labelTotalPages

The zoom editor hosted in the dialog's View menu.

C#
protected ZoomMenuItem menuItemZoom

Displays the document pages in the preview area.

C#
protected RadPrintPreviewControl printPreviewControl

Displays and accepts a page number to navigate to in the preview.

C#
protected CommandBarTextBox textBoxCurrentPage

Properties

Gets or sets the that should be previewed.

C#
[Browsable(false)]
public RadPrintDocument Document { get; set; }

Gets the PrintDialog that is shown by this dialog.

C#
[Browsable(false)]
public PrintDialog PrintDialog { get; }

Gets the RadCommandBar instance of the form.

C#
[Browsable(false)]
public RadCommandBar ToolCommandBar { get; }

Gets the RadMenu instance of the form.

C#
[Browsable(false)]
public RadMenu ToolMenu { get; }

Gets the WatermarkPreviewDialog that is shown by this dialog.

C#
[Browsable(false)]
public WatermarkPreviewDialog WatermarkDialog { get; }

Methods

Creates the system print dialog used by the preview dialog.

C#
protected virtual PrintDialog CreatePrintDialog()
Returns:

PrintDialog

A print dialog configured to support printing to a file, the current page, a selection, or specified pages.

Creates a watermark editor for the dialog's current document.

C#
protected virtual WatermarkPreviewDialog CreateWatermarkDialog()
Returns:

WatermarkPreviewDialog

The watermark editor that is displayed by this dialog.

Clean up any resources being used.

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

true if managed resources should be disposed; otherwise, false.

Overrides: RadForm.Dispose(bool)

Localizes the strings in the dialog with strings from the current PrintDialogsLocalizationProvider.

C#
protected virtual void LocalizeStrings()

Applies Material-theme sizing adjustments to the zoom selector and command bar after the dialog loads.

C#
protected override void OnLoad(EventArgs e)
Parameters:eEventArgs

Overrides: RadForm.OnLoad(EventArgs)

Resets the document's print range to all pages when the dialog is shown.

C#
protected override void OnShown(EventArgs e)
Parameters:eEventArgs

Overrides: RadFormControlBase.OnShown(EventArgs)

Shows the print dialog and prints the pages currently represented by the preview when printing is accepted.

C#
protected virtual void OnShowPrintDialog()

The document's current page and selection length are set from the preview's starting page and page layout. The print range is reset to all pages after the dialog closes.

Shows the associated object's print-settings dialog.

C#
protected virtual void OnShowPrintSettingsDialog()

Accepting the settings resets the document's print range to all pages and refreshes the preview.

Shows the watermark editor for the current document.

C#
protected virtual void OnShowWatermarkDialog()

The preview is refreshed when the watermark dialog is accepted.

Closes the preview dialog when Escape is pressed and delegates other keys to the base form.

C#
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters:msgMessage

The keyboard message being processed.

keyDataKeys

The key and modifier data for the message.

Returns:

bool

true when Escape is handled; otherwise, the base form's result.

Overrides: Form.ProcessCmdKey(ref Message, Keys)

Scrolls the preview with a specified offset.

C#
public void ScrollWith(Point offset)
Parameters:offsetPoint

The offset.

Sets the zoom factor of the preview.

C#
public void SetZoom(double factor)
Parameters:factordouble

The zoom factor.

Unsubscribes the dialog from localization-provider change notifications.

C#
protected virtual void UnwireEvents()