Loading...

Class SchedulerPrintStyle

Represents a base class for different print styles of RadScheduler.

Inheritance
System.Object
SchedulerPrintStyle
SchedulerBaseWeeklyPrintStyle
SchedulerDailyPrintStyle
SchedulerDetailsPrintStyle
SchedulerMonthlyPrintStyle
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.Scheduler.dll

Syntax

public abstract class SchedulerPrintStyle : ICloneable

Constructors

SchedulerPrintStyle()

Creates a new instance of the class.

Declaration
public SchedulerPrintStyle()

SchedulerPrintStyle(DateTime, DateTime)

Creates a new instance of the class.

Declaration
public SchedulerPrintStyle(DateTime startRange, DateTime endRange)
Parameters
System.DateTime startRange

The start date of the printing range.
System.DateTime endRange

The end date of the printing range.

Properties

AppointmentFont

Gets or sets the font of the appointments.

Declaration
public Font AppointmentFont { get; set; }
Property Value
System.Drawing.Font

DateEndRange

Gets or sets the end date of the date range which describes which appointments should be printed.

Declaration
public virtual DateTime DateEndRange { get; set; }
Property Value
System.DateTime

DateHeadingFont

Gets or sets the font of the date headers.

Declaration
public Font DateHeadingFont { get; set; }
Property Value
System.Drawing.Font

DateStartRange

Gets or sets the start date of the date range which describes which appointments should be printed.

Declaration
public virtual DateTime DateStartRange { get; set; }
Property Value
System.DateTime

DrawPageTitle

Gets or sets whether a page title should be printed.

Declaration
public bool DrawPageTitle { get; set; }
Property Value
System.Boolean

DrawPageTitleCalendar

Gets or sets whether a calendar should be printed inside the title area.

Declaration
public bool DrawPageTitleCalendar { get; set; }
Property Value
System.Boolean

GroupType

Gets or sets the groping mode of the printed document.

Declaration
public SchedulerPrintGroupType GroupType { get; set; }
Property Value
SchedulerPrintGroupType

HeadingAreaHeight

Gets or sets the height of the heading area.

Declaration
public int HeadingAreaHeight { get; set; }
Property Value
System.Int32

IsGrouped

Declaration
protected bool IsGrouped { get; }
Property Value
System.Boolean

NotesAreaWidth

Gets or sets the width of the notes area.

Declaration
public int NotesAreaWidth { get; set; }
Property Value
System.Int32

PageHeadingFont

Gets or sets the font of the page heading.

Declaration
public Font PageHeadingFont { get; set; }
Property Value
System.Drawing.Font

Scheduler

Gets the RadScheduler that is being printed.

Declaration
public RadScheduler Scheduler { get; }
Property Value
RadScheduler

ShowLinedNotesArea

Gets or sets whether a lined area for handwritten notes should be printed.

Declaration
public bool ShowLinedNotesArea { get; set; }
Property Value
System.Boolean

ShowNotesArea

Gets or sets whether an area for handwritten notes should be printed.

Declaration
public bool ShowNotesArea { get; set; }
Property Value
System.Boolean

ShowTimezone

Gets or sets a value indicating whether the current timezone should be printed inside page title area.

Declaration
public bool ShowTimezone { get; set; }
Property Value
System.Boolean

TimeEndRange

Gets or sets the end time of the time interval which describes which appointments should be printer for every single date.

Declaration
public virtual TimeSpan TimeEndRange { get; set; }
Property Value
System.TimeSpan

TimeStartRange

Gets or sets the start time of the time interval which describes which appointments should be printer for every single date.

Declaration
public virtual TimeSpan TimeStartRange { get; set; }
Property Value
System.TimeSpan

TotalDays

Declaration
protected int TotalDays { get; }
Property Value
System.Int32

Methods

Clone()

Declaration
public object Clone()
Returns
System.Object

Implements
System.ICloneable.Clone()

CompareAppointments(IEvent, IEvent)

Declaration
protected int CompareAppointments(IEvent x, IEvent y)
Parameters
IEvent x

IEvent y

Returns
System.Int32

CompareAppointmentsByResource(IEvent, IEvent)

Declaration
protected int CompareAppointmentsByResource(IEvent x, IEvent y)
Parameters
IEvent x

IEvent y

Returns
System.Int32

CopyProperties(SchedulerPrintStyle)

Declaration
public virtual void CopyProperties(SchedulerPrintStyle destination)
Parameters
SchedulerPrintStyle destination

DateCeiling(DateTime)

Declaration
protected virtual DateTime DateCeiling(DateTime dateTime)
Parameters
System.DateTime dateTime

Returns
System.DateTime

DateFloor(DateTime)

Declaration
protected virtual DateTime DateFloor(DateTime dateTime)
Parameters
System.DateTime dateTime

Returns
System.DateTime

DrawAppointment(AppointmentPrintElement, Graphics, Rectangle)

Draws a AppointmentPrintElement.

Declaration
protected void DrawAppointment(AppointmentPrintElement element, Graphics graphics, Rectangle bounds)
Parameters
AppointmentPrintElement element

The element.
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Drawing.Rectangle bounds

The bounds of the element.

DrawAppointment(AppointmentPrintElement, Graphics, RectangleF)

Draws a AppointmentPrintElement.

Declaration
protected void DrawAppointment(AppointmentPrintElement element, Graphics graphics, RectangleF bounds)
Parameters
AppointmentPrintElement element

The element.
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Drawing.RectangleF bounds

The bounds of the element.

DrawAppointmentsArea(Rectangle, Graphics, Int32)

Draws the content area of the page.

Declaration
protected abstract void DrawAppointmentsArea(Rectangle appArea, Graphics graphics, int pageNumber)
Parameters
System.Drawing.Rectangle appArea

The bounds of the area.
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Int32 pageNumber

One-based number of the current page.

DrawCell(SchedulerPrintCellElement, Graphics, Rectangle)

Draws a SchedulerPrintCellElement.

Declaration
protected void DrawCell(SchedulerPrintCellElement element, Graphics graphics, Rectangle bounds)
Parameters
SchedulerPrintCellElement element

The element.
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Drawing.Rectangle bounds

The bounds of the element.

DrawCell(SchedulerPrintCellElement, Graphics, RectangleF)

Draws a SchedulerPrintCellElement.

Declaration
protected void DrawCell(SchedulerPrintCellElement element, Graphics graphics, RectangleF bounds)
Parameters
SchedulerPrintCellElement element

The element.
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Drawing.RectangleF bounds

The bounds of the element.

DrawElement(RadPrintElement, Graphics, Rectangle)

Draws a RadPrintElement.

Declaration
protected void DrawElement(RadPrintElement element, Graphics graphics, Rectangle bounds)
Parameters
RadPrintElement element

The element.
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Drawing.Rectangle bounds

The bounds of the element.

DrawElement(RadPrintElement, Graphics, RectangleF)

Draws a RadPrintElement.

Declaration
protected void DrawElement(RadPrintElement element, Graphics graphics, RectangleF bounds)
Parameters
RadPrintElement element

The element.
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Drawing.RectangleF bounds

The bounds of the element.

DrawNotesArea(Graphics, Rectangle, Int32)

Draws an area for handwritten notes.

Declaration
protected virtual Rectangle DrawNotesArea(Graphics graphics, Rectangle drawingArea, int pageNumber)
Parameters
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Drawing.Rectangle drawingArea

The area in which the notes should be drawn.
System.Int32 pageNumber

1-based consecutive number of the page to be drawn in.
Returns
System.Drawing.Rectangle

The bounds of the notes area.

DrawPage(Graphics, Rectangle, Int32)

Draws the page inside a given graphics area.

Declaration
public virtual void DrawPage(Graphics graphics, Rectangle drawingArea, int pageNumber)
Parameters
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Drawing.Rectangle drawingArea

The area in which the page should be drawn.
System.Int32 pageNumber

One-based consecutive number of the page to be drawn.

DrawTopArea(Rectangle, Graphics, Int32)

Draws the page heading.

Declaration
protected virtual Rectangle DrawTopArea(Rectangle drawingArea, Graphics graphics, int pageNumber)
Parameters
System.Drawing.Rectangle drawingArea

The area in which the heading should be drawn.
System.Drawing.Graphics graphics

The graphics used for drawing.
System.Int32 pageNumber

The number of the page.
Returns
System.Drawing.Rectangle

The bounds of the top area.

EndPrint()

Declaration
public virtual void EndPrint()

GetAppointments()

Gets the appointments of the current source that are inside the time interval specified by the DateStartRange and DateEndRange properties.

Declaration
protected List<IEvent> GetAppointments()
Returns
System.Collections.Generic.List<IEvent>

A list of appointments.

GetAppointments(DateTime)

Gets the appointments of the current source that a given date contains.

Declaration
protected List<IEvent> GetAppointments(DateTime date)
Parameters
System.DateTime date

The date.
Returns
System.Collections.Generic.List<IEvent>

A list of appointments.

GetAppointments(DateTime, Boolean)

Gets the appointments of the current source that a given date contains.

Declaration
protected List<IEvent> GetAppointments(DateTime date, bool includeAllday)
Parameters
System.DateTime date

The date.
System.Boolean includeAllday

Indicate whether all-day appointments should be included.
Returns
System.Collections.Generic.List<IEvent>

A list of appointments.

GetAppointments(DateTime, Boolean, IResource)

Declaration
protected List<IEvent> GetAppointments(DateTime date, bool includeAllday, IResource resource)
Parameters
System.DateTime date

System.Boolean includeAllday

IResource resource

Returns
System.Collections.Generic.List<IEvent>

GetAppointments(DateTime, DateTime)

Gets the appointments of the current source that are inside a specified time interval.

Declaration
protected List<IEvent> GetAppointments(DateTime startDate, DateTime endDate)
Parameters
System.DateTime startDate

The start date of the interval.
System.DateTime endDate

The end date of the interval.
Returns
System.Collections.Generic.List<IEvent>

A list of appointments.

GetAppointments(DateTime, DateTime, IResource)

Declaration
protected List<IEvent> GetAppointments(DateTime startDate, DateTime endDate, IResource resource)
Parameters
System.DateTime startDate

System.DateTime endDate

IResource resource

Returns
System.Collections.Generic.List<IEvent>

GetAppointments(DateTime, DateTime, SchedulerPrintGroupType)

Declaration
protected List<IEvent> GetAppointments(DateTime startDate, DateTime endDate, SchedulerPrintGroupType sortType)
Parameters
System.DateTime startDate

System.DateTime endDate

SchedulerPrintGroupType sortType

Returns
System.Collections.Generic.List<IEvent>

GetNumberOfPages(Rectangle, Graphics)

Returns the potential number of pages.

Declaration
public virtual int GetNumberOfPages(Rectangle pageBounds, Graphics g)
Parameters
System.Drawing.Rectangle pageBounds

The bounds of the page.
System.Drawing.Graphics g

The graphics object. Only used for measurement purposes.
Returns
System.Int32

GetPageDate(Int32)

Gets the date that corresponds to a given page.

Declaration
protected virtual DateTime GetPageDate(int pageNumber)
Parameters
System.Int32 pageNumber

The page number.
Returns
System.DateTime

The date.

GetPageResource(Int32)

Gets the resource that corresponds to a given page.

Declaration
protected virtual IResource GetPageResource(int pageNumber)
Parameters
System.Int32 pageNumber

The page number.
Returns
IResource

The resource.

GetRoundedDateTime(DateTime, Boolean)

Gets a time rounded to the cells of the day view table.

Declaration
protected virtual DateTime GetRoundedDateTime(DateTime time, bool roundUp)
Parameters
System.DateTime time

The time to round.
System.Boolean roundUp

If true time will rounded up, otherwise it will be rounded down.
Returns
System.DateTime

LoadImage(String)

Declaration
protected Image LoadImage(string name)
Parameters
System.String name

Returns
System.Drawing.Image

OnAppointmentElementFormatting(PrintAppointmentEventArgs)

Declaration
protected virtual void OnAppointmentElementFormatting(PrintAppointmentEventArgs args)
Parameters
PrintAppointmentEventArgs args

OnAppointmentElementPaint(PrintAppointmentPaintEventArgs)

Declaration
protected virtual void OnAppointmentElementPaint(PrintAppointmentPaintEventArgs args)
Parameters
PrintAppointmentPaintEventArgs args

OnCellElementFormatting(PrintSchedulerCellEventArgs)

Declaration
protected virtual void OnCellElementFormatting(PrintSchedulerCellEventArgs args)
Parameters
PrintSchedulerCellEventArgs args

OnCellElementPaint(PrintSchedulerCellPaintEventArgs)

Declaration
protected virtual void OnCellElementPaint(PrintSchedulerCellPaintEventArgs args)
Parameters
PrintSchedulerCellPaintEventArgs args

OnPrintElementFormatting(PrintElementEventArgs)

Declaration
protected virtual void OnPrintElementFormatting(PrintElementEventArgs args)
Parameters
PrintElementEventArgs args

OnPrintElementPaint(PrintElementPaintEventArgs)

Declaration
protected virtual void OnPrintElementPaint(PrintElementPaintEventArgs args)
Parameters
PrintElementPaintEventArgs args

Events

AppointmentElementFormatting

Fires when an appointment element is being formatted before it is painted.

Declaration
public event PrintAppointmentEventHandler AppointmentElementFormatting
Event Type
PrintAppointmentEventHandler

AppointmentElementPaint

Fires when an appointment element is painted.

Declaration
public event PrintAppointmentPaintEventHandler AppointmentElementPaint
Event Type
PrintAppointmentPaintEventHandler

CellElementFormatting

Fires when a cell element is being formatted before it is painted.

Declaration
public event PrintSchedulerCellEventHandler CellElementFormatting
Event Type
PrintSchedulerCellEventHandler

CellElementPaint

Fires when a cell element is painted.

Declaration
public event PrintSchedulerCellPaintEventHandler CellElementPaint
Event Type
PrintSchedulerCellPaintEventHandler

PrintElementFormatting

Fires when a print element is being formatted before it is painted.

Declaration
public event PrintElementEventHandler PrintElementFormatting
Event Type
PrintElementEventHandler

PrintElementPaint

Fires when a print element is painted.

Declaration
public event PrintElementPaintEventHandler PrintElementPaint
Event Type
PrintElementPaintEventHandler

Extension Methods