Class ViewHeaderBase

Represents a class which holds view header cell information.

Inheritance

System.Object

ViewHeaderBase

DayViewHeader

MonthViewHeader

TimelineViewHeader

Implements

System.ComponentModel.INotifyPropertyChanged

Namespace: Syncfusion.UI.Xaml.Scheduler

Assembly: Syncfusion.SfScheduler.WPF.dll

Syntax

public class ViewHeaderBase : ContentControl, INotifyPropertyChanged

Constructors

ViewHeaderBase()

Initializes a new instance of the ViewHeaderBase class.

Declaration

public ViewHeaderBase()

Fields

AllowViewNavigationProperty

Identifies the AllowViewNavigation dependency property.

Declaration

public static readonly DependencyProperty AllowViewNavigationProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for AllowViewNavigation dependency property.

IsTodayProperty

Identifies the IsToday dependency property.

Declaration

public static readonly DependencyProperty IsTodayProperty

Field Value

Type	Description
System.Windows.DependencyProperty	The identifier for IsToday dependency property.

Properties

AllowViewNavigation

Gets a value indicating whether the current view should navigate to the respective Day or TimelineDay view when clicking on a date in the view header of the following views: Week, WorkWeek, TimelineWeek, TimelineWorkWeek and TimelineMonth views.

Declaration

public bool AllowViewNavigation { get; }

Property Value

Type	Description
System.Boolean	The default value is false.

Remarks

This property's value will be considered based on AllowViewNavigation

ColumnIndex

Gets or sets the column index.

Declaration

public int ColumnIndex { get; set; }

Property Value

Type
System.Int32

DateText

Gets or sets the month view header text.

Declaration

public string DateText { get; set; }

Property Value

Type
System.String

DayText

Gets or sets the month view header text.

Declaration

public string DayText { get; set; }

Property Value

Type
System.String

IsDayView

Gets a value indicating whether the view is Day view or TimelineDay view.

Declaration

public bool IsDayView { get; }

Property Value

Type	Description
System.Boolean	The default value is false.

Remarks

This property is used for restricting the mouse hovering effect on the view header dates in Day view and TimelineDay view. It is not applicable for Month view.

IsEnsured

Gets or sets a value indicating whether ensured.

Declaration

public bool IsEnsured { get; set; }

Property Value

Type
System.Boolean

IsToday

Gets or sets a value indicating whether the date is current date or not. This is a bondable property.

Declaration

public bool IsToday { get; set; }

Property Value

Type
System.Boolean

Methods

OnCreateAutomationPeer()

Methods to create automation peer for ViewHeaderControl class.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type	Description
System.Windows.Automation.Peers.AutomationPeer	Automation peer.

OnDragLeave(DragEventArgs)

Invoked when an unhandled System.Windows.DragDrop.DragLeave attached event reaches an element in its route that is derived from this class.

Declaration

protected override void OnDragLeave(DragEventArgs e)

Parameters

Type	Name	Description
System.Windows.DragEventArgs	e	The drop event arguments.

OnDragOver(DragEventArgs)

Invoked when an unhandled System.Windows.DragDrop.DragOver attached event reaches an element in its route that is derived from this class.

Declaration

protected override void OnDragOver(DragEventArgs e)

Parameters

Type	Name	Description
System.Windows.DragEventArgs	e	The drag event arguments.

OnDrop(DragEventArgs)

Invoked when an unhandled System.Windows.DragDrop.DragEnter attached event reaches an element in its route that is derived from this class.

Declaration

protected override void OnDrop(DragEventArgs e)

Parameters

Type	Name	Description
System.Windows.DragEventArgs	e	The drop event arguments.

OnMouseDoubleClick(MouseButtonEventArgs)

Invoked when an unhandled System.Windows.UIElement.OnMouseDoubleClick routed event reaches an element in its route that is derived from this class.

Declaration

protected override void OnMouseDoubleClick(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The mouse button event args.

OnMouseLeftButtonUp(MouseButtonEventArgs)

Occurs when the left mouse button is released.

Declaration

protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.MouseButtonEventArgs	e	The arguments.

OnPreviewStylusUp(StylusEventArgs)

Occurs on preview stylus up.

Declaration

protected override void OnPreviewStylusUp(StylusEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.StylusEventArgs	e	The stylus event args.

Events

PropertyChanged

Occurs when property changed.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged