SchedulerPrintAdapter.SetSourceObject(Object) Method

Specifies the object used to get the scheduling data - the SchedulerStorage or the SchedulerControl object.

Namespace: DevExpress.XtraScheduler.Reporting

Assembly: DevExpress.XtraScheduler.v19.1.Core.dll

Declaration

C#

public abstract void SetSourceObject(
    object sourceObject
)

VB.NET

Public MustOverride Sub SetSourceObject(
    sourceObject As Object
)

Parameters

Name	Type	Description
sourceObject	Object	A SchedulerStorage or the SchedulerControl object.

Remarks

This method is used to specify the correct scheduling source for the SchedulerPrintAdapter, despite the likely ambiguity caused by the fact that both the SchedulerStorage and the SchedulerControl can play the role of scheduling source.

The SetSourceObject method is abstract, and is overridden in the SchedulerPrintAdapter descendants.

It is intended for use when the report layout is loaded from the .repx file or a stream, and the type of the print adapter contained in the loaded layout is unknown. The following code snippet illustrates this situation.

C#

using DevExpress.XtraScheduler.Reporting;
using DevExpress.XtraScheduler;
// ...
string reportFileName = "DailyStyle.repx";
// Creates a scheduler adapter for the Scheduler Control on the form
SchedulerControlPrintAdapter PrintAdapter = 
    new SchedulerControlPrintAdapter(this.schedulerControl1);
// Customize the print adapter...
// ...
// Create a new report 
XtraSchedulerReport report = new XtraSchedulerReport();
// Loads the .repx file (only layout, no data)
report.LoadLayout(reportFileName);
// Specifies the correct scheduling source even if the type of the scheduler adapter
// in the loaded report is unknown
if(report.SchedulerAdapter != null)
    report.SchedulerAdapter.SetSourceObject(PrintAdapter.SchedulerControl);
else
    report.SchedulerAdapter = PrintAdapter;
// Invokes the Report Designer
report.ShowDesigner();

VB.NET

Imports DevExpress.XtraScheduler.Reporting
Imports DevExpress.XtraScheduler
' ...
Private reportFileName As String = "DailyStyle.repx"
' Creates a scheduler adapter for the Scheduler Control on the form
Private PrintAdapter As SchedulerControlPrintAdapter =  _
    New SchedulerControlPrintAdapter(Me.schedulerControl1)
' Customize the print adapter...
' ...
' Create a new report 
Private report As XtraSchedulerReport = New XtraSchedulerReport()
' Loads the .repx file (only layout, no data)
report.LoadLayout(reportFileName)
' Specifies the correct scheduling source even if the type of the scheduler adapter
' in the loaded report is unknown
If Not report.SchedulerAdapter Is Nothing Then
    report.SchedulerAdapter.SetSourceObject(PrintAdapter.SchedulerControl)
Else
    report.SchedulerAdapter = PrintAdapter
End If
' Invokes the Report Designer
report.ShowDesigner()

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetSourceObject(Object) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-display-resource-captions-horizontally-when-a-verticalresourceheaders-control-is-used-e1545/CS/HorizontalResourceHeaderCaption/Form1.cs#L48

WeeklyReport rpt = new WeeklyReport();
rpt.SchedulerAdapter.SetSourceObject(this.schedulerControl1);
return rpt;

how-to-load-an-xtraschedulerreport-from-template-e1389/CS/ReportLoad/Form1.cs#L31

if(report.SchedulerAdapter != null)
    report.SchedulerAdapter.SetSourceObject(storage);
else

scheduler-reporting-custom-painting-using-customdraw-events-e2758/CS/SchedulerReportCustomDraw/Form1.cs#L29

XtraSchedulerReport1 rep = new XtraSchedulerReport1();
rep.SchedulerAdapter.SetSourceObject(schedulerStorage1);
rep.SchedulerAdapter.TimeInterval = schedulerControl1.ActiveView.GetVisibleIntervals().Interval;

VB.NET

how-to-display-resource-captions-horizontally-when-a-verticalresourceheaders-control-is-used-e1545/VB/HorizontalResourceHeaderCaption/Form1.vb#L50

Dim rpt As New WeeklyReport()
rpt.SchedulerAdapter.SetSourceObject(Me.schedulerControl1)
Return rpt

scheduler-reporting-custom-painting-using-customdraw-events-e2758/VB/SchedulerReportCustomDraw/Form1.vb#L27

Dim rep As New XtraSchedulerReport1()
rep.SchedulerAdapter.SetSourceObject(schedulerStorage1)
rep.SchedulerAdapter.TimeInterval = schedulerControl1.ActiveView.GetVisibleIntervals().Interval