[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Base
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.FluentDesignSystem
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Collapse]DevExpress.XtraDiagram
   [Expand]CustomDrawBackgroundEventArgs Class
   [Expand]CustomDrawItemEventArgs Class
    CustomDrawItemMode Enumeration
   [Expand]CustomHitTestEventArgs Class
   [Expand]DiagramAppearanceOptions Class
   [Expand]DiagramBeforeItemsMovingEventArgs Class
   [Expand]DiagramBeforeItemsResizingEventArgs Class
   [Expand]DiagramBeforeItemsRotatingEventArgs Class
   [Expand]DiagramClosedEditorEventArgs Class
   [Expand]DiagramConnectionChangedEventArgs Class
   [Expand]DiagramConnectionChangingEventArgs Class
   [Expand]DiagramConnector Class
   [Expand]DiagramContainer Class
   [Expand]DiagramContainerBase Class
   [Collapse]DiagramControl Class
     DiagramControl Members
     DiagramControl Constructor
    [Expand]DiagramControl Properties
    [Collapse]DiagramControl Events
      AddingNewItem Event
      BackColorChanged Event
      BeforeItemsMoving Event
      BeforeItemsResizing Event
      BeforeItemsRotating Event
      CanRedoChanged Event
      CanUndoChanged Event
      CanvasBoundsChanged Event
      ClosedEditor Event
      ConnectionChanged Event
      ConnectionChanging Event
      CustomCursor Event
      CustomDrawBackground Event
      CustomDrawItem Event
      CustomGetEditableItemProperties Event
      CustomGetEditableItemPropertiesCacheKey Event
      CustomGetSerializableItemProperties Event
      CustomHitTest Event
      CustomItemDrag Event
      CustomItemDragResult Event
      CustomItemGiveFeedback Event
      CustomItemQueryContinueDrag Event
      CustomLoadDocument Event
      CustomLoadImage Event
      CustomSaveDocument Event
      DeletingItems Event
      DocumentLoaded Event
      ExceptionMessage Event
      FontChanged Event
      ForeColorChanged Event
      HasChangesChanged Event
      IsTextEditModeChanged Event
      ItemBoundsChanged Event
      ItemContentChanged Event
      ItemCreating Event
      ItemDrawing Event
      ItemInitializing Event
      ItemsChanged Event
      ItemsDeleting Event
      ItemsMoving Event
      ItemsPasting Event
      ItemsResizing Event
      ItemsRotating Event
      QueryConnectionPoints Event
      QueryItemDrawAction Event
      QueryItemEditAction Event
      QueryItemsAction Event
      QueryItemSnapping Event
      RelayoutItemsCompleted Event
      SelectionChanged Event
      ShowingEditor Event
      ShowingOpenDialog Event
      ShowingOpenImageDialog Event
      ShowingSaveDialog Event
      SubordinatesHidden Event
      SubordinatesHiding Event
      SubordinatesShowing Event
      SubordinatesShown Event
      TitleChanged Event
      ZoomFactorChanged Event
    [Expand]DiagramControl Methods
   [Expand]DiagramDataBindingController Class
   [Expand]DiagramDataBindingControllerBase Class
    DiagramDrawingContext Enumeration
   [Expand]DiagramImage Class
   [Expand]DiagramItem Class
   [Expand]DiagramItemBoundsChangedEventArgs Class
   [Expand]DiagramItemCollection Class
   [Expand]DiagramItemContentChangedEventArgs Class
   [Expand]DiagramItemCreatingEventArgs Class
   [Expand]DiagramItemDrawingEventArgs Class
   [Expand]DiagramItemInitializingEventArgs Class
   [Expand]DiagramItemsChangedEventArgs Class
   [Expand]DiagramItemsDeletingEventArgs Class
   [Expand]DiagramItemsGeneratedEventArgs Class
   [Expand]DiagramItemsMovingEventArgs Class
   [Expand]DiagramItemsPastingEventArgs Class
   [Expand]DiagramItemsResizingEventArgs Class
   [Expand]DiagramItemsRotatingEventArgs Class
   [Expand]DiagramOrgChartController Class
   [Expand]DiagramQueryConnectionPointsEventArgs Class
   [Expand]DiagramQueryItemDrawActionEventArgs Class
   [Expand]DiagramQueryItemEditActionEventArgs Class
   [Expand]DiagramQueryItemsActionEventArgs Class
   [Expand]DiagramQueryItemSnappingEventArgs Class
   [Expand]DiagramShape Class
   [Expand]DiagramShowingOpenDialogEventArgs Class
   [Expand]DiagramShowingOpenImageDialogEventArgs Class
   [Expand]DiagramShowingSaveDialogEventArgs Class
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

DiagramControl.CustomDrawBackground Event

Occurs before the Canvas background is rendered.

Namespace:DevExpress.XtraDiagram
Assembly:DevExpress.XtraDiagram.v18.1.dll

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type CustomDrawBackgroundEventArgs containing data related to this event.

The following CustomDrawBackgroundEventArgs properties provide information specific to this event.
Property Description
ContentBounds Gets the rectangle which encompasses the background area excluding margins.
Context Gets whether the item is to be drawn on the canvas, toolbox, in the print or export output or as the drag preview.
Graphics Returns an object that provides painting facilities.
PagesInfo Gets the list of diagram pages.
PrintBounds Gets the rectangle which encompasses the total background area when printing the diagram.
PrintClientBounds Gets the rectangle which encompasses the background area excluding margins when printing the diagram.
PrintIndex Gets the zero-based index of the page that is currently being rendered when printing the diagram.
TotalBounds Gets the rectangle which encompasses the total background area.
ViewportBounds Gets the rectangle which encompasses the viewport area.

Expanded Remarks

Use the CustomDrawBackground event to draw a custom Canvas background.

The following code snippet illustrates how to set an image as the diagram background:

Note

If the font's Unit property is not set to GraphicsUnit.Pixel, the font size of the text drawn by the Graphics.DrawString method is scaled based on the DPI settings.

Expanded See Also

Is this topic helpful?​​​​​​​