[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand].NET Core 3 Support
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Expand]Controls and Libraries
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Data
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Expand]DevExpress.Xpf.Core.FilteringUI
  [Expand]DevExpress.Xpf.Core.Native
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Expand]DevExpress.Xpf.Dialogs
  [Expand]DevExpress.Xpf.Docking
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.DXBinding
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DataPager
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor.Native
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Native
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.ExpressionEditor
  [Expand]DevExpress.Xpf.Gantt
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Expand]DevExpress.Xpf.PivotGrid
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.RichEdit.Menu
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.Scheduling
  [Expand]DevExpress.Xpf.Scheduling.Common
  [Expand]DevExpress.Xpf.Scheduling.Editors
  [Expand]DevExpress.Xpf.Scheduling.iCalendar
  [Expand]DevExpress.Xpf.Scheduling.Reporting
  [Expand]DevExpress.Xpf.Scheduling.Visual
  [Expand]DevExpress.Xpf.Scheduling.VisualData
  [Expand]DevExpress.Xpf.SpellChecker
  [Collapse]DevExpress.Xpf.Spreadsheet
   [Expand]CellData Class
    CommandBarStyle Enumeration
    NameBoxItemDisplayMode Enumeration
    ShowCellToolTipMode Enumeration
   [Expand]SpreadsheetAxisLabelOverlappingOptions Class
   [Expand]SpreadsheetBehaviorOptions Class
   [Expand]SpreadsheetCapabilitiesOptions Class
   [Expand]SpreadsheetCellOptions Class
   [Expand]SpreadsheetClipboardOptions Class
   [Expand]SpreadsheetColumnBehaviorOptions Class
   [Expand]SpreadsheetCommentBehaviorOptions Class
   [Collapse]SpreadsheetControl Class
     SpreadsheetControl Members
     SpreadsheetControl Constructor
    [Collapse]SpreadsheetControl Properties
      AcceptsEscape Property
      AcceptsReturn Property
      AcceptsTab Property
      ActiveCell Property
      ActiveChartSheet Property
      ActiveSheet Property
      ActiveSheetIndex Property
      ActiveSheetName Property
      ActiveView Property
      ActiveViewZoom Property
      ActiveWorksheet Property
      BarManager Property
      CellTemplate Property
      CellTemplateSelector Property
      CellToolTip Property
      ChartLayoutGalleryGroups Property
      ChartStyleGalleryGroups Property
      ChartStylePopupGalleryGroups Property
      Clipboard Property
      CommandBarStyle Property
      CommandProvider Property
      Document Property
      DocumentSource Property
      DpiX Property
      DpiY Property
      FormulaBarExpanded Property
      FormulaBarNameBoxItemDisplayMode Property
      FormulaBarShowButtons Property
      FormulaBarShowEditor Property
      FormulaBarShowNameBox Property
      GridLinesColor Property
      HorizontalScrollBar Property
      HorizontalScrollbarVisibility Property
      IsCellEditorActive Property
      IsPrintingAvailable Property
      IsPrintPreviewAvailable Property
      IsUpdateLocked Property
      LayoutUnit Property
      LayoutViewBounds Property
      MenuCustomizations Property
      Modified Property
      Options Property
      PivotTableStyleGalleryGroups Property
      PivotTableStylePopupGalleryGroups Property
      ReadOnly Property
      Ribbon Property
      RibbonActions Property
      SelectedCell Property
      SelectedComment Property
      SelectedPicture Property
      SelectedShape Property
      Selection Property
      SheetCount Property
      ShowCellToolTipMode Property
      ShowFormulaBar Property
      ShowStatusBar Property
      ShowTabSelector Property
      Spreadsheet Attached Property
      StatusBarActions Property
      StatusBarShowAverage Property
      StatusBarShowCount Property
      StatusBarShowMax Property
      StatusBarShowMin Property
      StatusBarShowNumericalCount Property
      StatusBarShowPopupMenu Property
      StatusBarShowSum Property
      StatusBarShowZoom Property
      StatusBarShowZoomSlider Property
      TableStyleGalleryGroups Property
      TableStylePopupGalleryGroups Property
      Unit Property
      UseDefaultSvgImages Attached Property
      VerticalScrollBar Property
      VerticalScrollbarVisibility Property
      ViewBounds Property
      VisibleRange Property
      VisibleSheetNames Property
      VisibleUnfrozenRange Property
      WorksheetDisplayArea Property
    [Expand]SpreadsheetControl Events
    [Expand]SpreadsheetControl Methods
   [Expand]SpreadsheetControlOptions Class
   [Expand]SpreadsheetCopyOptions Class
   [Expand]SpreadsheetCsvExportOptions Class
   [Expand]SpreadsheetCsvImportOptions Class
   [Expand]SpreadsheetCustomCellEditEventArgs Class
    SpreadsheetCustomCellEditEventHandler Delegate
   [Expand]SpreadsheetDataValidationBehaviorOptions Class
   [Expand]SpreadsheetDocumentSource Class
   [Expand]SpreadsheetDrawingBehaviorOptions Class
    SpreadsheetElementVisibility Enumeration
   [Expand]SpreadsheetExportOptions Class
   [Expand]SpreadsheetFormulaAutoCompleteOptions Class
    SpreadsheetFormulaAutoCompleteSearchMode Enumeration
   [Expand]SpreadsheetFormulaBarControl Class
   [Expand]SpreadsheetGroupBehaviorOptions Class
   [Expand]SpreadsheetImportOptions Class
    SpreadsheetMenuType Enumeration
   [Expand]SpreadsheetOpenXmlImportOptions Class
   [Expand]SpreadsheetPivotTableFieldListOptions Class
    SpreadsheetPivotTableFieldListStartPosition Enumeration
   [Expand]SpreadsheetProtectionBehaviorOptions Class
   [Expand]SpreadsheetRealTimeDataOptions Class
   [Expand]SpreadsheetRowBehaviorOptions Class
   [Expand]SpreadsheetSaveOptions Class
   [Expand]SpreadsheetSelectionBehaviorOptions Class
   [Expand]SpreadsheetTxtExportOptions Class
   [Expand]SpreadsheetTxtImportOptions Class
   [Expand]SpreadsheetViewOptions Class
   [Expand]SpreadsheetWorksheetBehaviorOptions Class
   [Expand]SpreadsheetXlsImportOptions Class
   [Expand]SpreadsheetXlsmImportOptions Class
   [Expand]WorksheetDisplayArea Class
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Internal
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Printing
[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]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

SpreadsheetControl.DocumentSource Property

Gets or sets a document supplier for a SpreadsheetControl. This is a dependency property.

Namespace:DevExpress.Xpf.Spreadsheet
Assembly:DevExpress.Xpf.Spreadsheet.v19.2.dll

Expanded Syntax

Property value

Type: Object
An object specifying the document to bind to the SpreadsheetControl.

Expanded Remarks

When the DocumentSource property is set, the SpreadsheetControl attempts to load a document specified by the property value.

You can use the following data sources:

  • System.IO.Stream (both seekable and non-seekable);
  • System.String (recognized as the file path);
  • System.Byte[] array;
  • System.Uri;
  • SpreadsheetDocumentSource instance.

The format of documents loaded from a System.IO.Stream, System.Uri or System.Byte[] instance is detected automatically by the built-in DevExpress.XtraSpreadsheet.Services.IFormatDetectorService implementation.

The following formats can be detected on the fly:

  • XLSX, XLSB, XLSM, XLTX, XLTM (non encrypted files only);
  • XLS, XLT;
  • CSV, TXT (only if loaded from a System.IO.FileStream instance).

If a SpreadsheetDocumentSource value is supplied, a document is loaded from the stream specified by the SpreadsheetDocumentSource.Stream property. The document format is determined by the SpreadsheetDocumentSource.Format property.

Tip

Set the DocumentSource property to null to create a new document.

The code sample below binds an XLSX file as the document source:

Expanded See Also

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