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

Represents an UI dialog for editing print settings.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

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

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlFormRadFormControlBaseRadFormPrintSettingsDialog...

Derived Classes: GanttViewPrintSettingsDialogGridViewPrintSettingsDialogPdfPrintSettingsDialogPivotGridPrintSettingsDialogSchedulerPrintSettingsDialog

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.OnShown(EventArgs)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

Initializes the print-settings pages and subscribes to localization and theme changes.

C#
public PrintSettingsDialog()

Initializes the dialog and loads settings from the supplied print document.

C#
public PrintSettingsDialog(RadPrintDocument document)
Parameters:documentRadPrintDocument

The print document to configure.

Fields

Closes the dialog with a canceled result without applying the edited settings.

C#
protected RadButton buttonCancel

Inserts the current-date token into the last-focused header or footer text box.

C#
protected CommandBarButton buttonCurDate

Inserts the current-time token into the last-focused header or footer text box.

C#
protected CommandBarButton buttonCurTime

Inserts the logo token into the last-focused header or footer text box.

C#
protected CommandBarButton buttonLogo

Applies the edited settings and closes the dialog; its caption changes to Preview when preview is enabled.

C#
protected RadButton buttonOK

Inserts the page-number token into the last-focused header or footer text box.

C#
protected CommandBarButton buttonPageNum

Opens the system print dialog and prints the document with the edited settings when accepted.

C#
protected RadButton buttonPrint

Inserts the total-page-count token into the last-focused header or footer text box.

C#
protected CommandBarButton buttonTotalPages

Inserts the Windows user-name token into the last-focused header or footer text box.

C#
protected CommandBarButton buttonUser

Controls whether the footer is reversed on even-numbered pages.

C#
protected RadCheckBox checkBoxReverseFooter

Controls whether the header is reversed on even-numbered pages.

C#
protected RadCheckBox checkBoxReverseHeader

Hosts the strip of header/footer token-insertion commands.

C#
protected CommandBarRowElement commandBarRowElement1

Contains commands that insert print-document tokens into the last-focused header or footer text box.

C#
protected RadCommandBar commandBarSnippets

Contains the buttons for inserting page, date, time, user, and logo tokens.

C#
protected CommandBarStripElement commandBarStripElement1

Selects a paper source available from the document's printer settings.

C#
protected RadDropDownList dropDownPageSource

Groups the four page-margin fields; values use inches or centimeters based on the current region.

C#
protected RadGroupBox groupBoxMargins

Groups the portrait and landscape orientation options.

C#
protected RadGroupBox groupBoxOrientation

Groups the paper type and source controls.

C#
protected RadGroupBox groupBoxPage

Labels the bottom-margin field.

C#
protected RadLabel labelBottomMargin

Labels the footer font control.

C#
protected RadLabel labelFooter

Labels the header font control.

C#
protected RadLabel labelHeader

Labels the left-margin field.

C#
protected RadLabel labelLeftMargin

Labels the paper-source selector.

C#
protected RadLabel labelPageSource

Labels the right-margin field.

C#
protected RadLabel labelRightMargin

Labels the top-margin field.

C#
protected RadLabel labelTopMargin

Labels the paper-size selector.

C#
protected RadLabel labelType

Lists available paper sizes from the document's printer settings, with dimensions in regional units.

C#
protected RadListControl listBoxPaperType

Edits the bottom page margin in the current region's units.

C#
protected RadMaskedEditBox maskBoxBottomMargin

Edits the left page margin in the current region's units.

C#
protected RadMaskedEditBox maskBoxLeftMargin

Edits the right page margin in the current region's units.

C#
protected RadMaskedEditBox maskBoxRightMargin

Edits the top page margin in the current region's units.

C#
protected RadMaskedEditBox maskBoxTopMargin

Hosts the control-specific settings added by CreateFormatControl().

C#
protected RadPageViewPage pageFormat

Contains the header and footer text, font, and even-page options.

C#
protected RadPageViewPage pageHeaderFooter

Contains paper-size, paper-source, margin, and orientation settings.

C#
protected RadPageViewPage pagePaper

Displays an orientation illustration that updates when the selected page orientation changes.

C#
protected PictureBox pictureBoxOrientation

Selects landscape page orientation.

C#
protected RadRadioButton radioButtonLandscape

Selects portrait page orientation.

C#
protected RadRadioButton radioButtonPortrait

Hosts the format, paper, and header/footer settings pages.

C#
protected RadPageView radPageView1

Edits the centered footer text.

C#
protected RadTextBox textBoxFooterCenterText

Edits the left-aligned footer text.

C#
protected RadTextBox textBoxFooterLeftText

Edits the right-aligned footer text.

C#
protected RadTextBox textBoxFooterRightText

Edits the centered header text.

C#
protected RadTextBox textBoxHeaderCenterText

Edits the left-aligned header text.

C#
protected RadTextBox textBoxHeaderLeftText

Edits the right-aligned header text.

C#
protected RadTextBox textBoxHeaderRightText

Properties

Gets the page view control of the dialog.

C#
public RadPageView PageView { get; }
Property Value:

The page view.

Gets the RadPrintDocument shown in this dialog.

C#
public RadPrintDocument PrintDocument { get; set; }

If [true] a Preview button is shown, otherwise an OK button is shown.

C#
public bool ShowPreviewButton { get; set; }

Methods

Saves all settings from the dialog into the RadPrintDocument.

C#
protected virtual void ApplySettings()

Creates the specific control for editing the settings of the printed control.

C#
protected virtual Control CreateFormatControl()
Returns:

Control

The that will be displayed on the first page of 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)

Loads the settings when the dialog is shown.

C#
protected virtual void LoadSettings()

Applies the current printing-dialog localization provider to the dialog's labels and buttons.

C#
protected virtual void LocalizeStrings()

Loads the document settings when available and selects the format page when that page is present.

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

The load event data.

Overrides: RadForm.OnLoad(EventArgs)

Treats Escape as cancellation and closes the dialog; other keys use base processing.

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

The message to process.

keyDataKeys

The key combination to process.

Returns:

bool

true when Escape is handled; otherwise, the result of base key processing.

Overrides: Form.ProcessCmdKey(ref Message, Keys)

Detaches the dialog from notifications that the current printing-dialog localization provider changed.

C#
protected virtual void UnwireEvents()