DateNavigatorLegend API 

 

The DateNavigatorLegend is deprecated. Instead, insert a Legend element and use the legendId property of the DateNavigator element to assign it.

Definition

The DateNavigatorLegend element (IWDDateNavigatorLegend) allows you to add a legend to the DateNavigator. You can use this view element with the DateNavigatorMarking view element to highlight calendar entries and to associate them with the legend entries. A maximum of four legend entries can be used according to the categories described below. Legend entries are stored as elements of a context node. Each highlighting of a date is stored in a separate context node. If the value of the category attribute equals the value of the legend entry category, the category refers to the corresponding legend entry.

Description of the View Element Properties

●      category

Specifies the path to the context attribute which stores the category of the legend entry. When doing this, you must make sure that two legend entries cannot be assigned to the same category. The categoryproperty must be bound to a context attribute, to whose multiple superordinate context nodes the dataSource property is bound.
The category property can take the following values and is represented by the list type WDDateMarkingCategory:

Four	Color of category four. *)
One	Color of category one. *)
Three	Color of category three. *)
Two	Color of category two. *)

*) The color for each highlighting depends on the respective design theme used – the documentation refers to the SAP Standard Design 2002.

●      dataSource

Specifies the path to the context node which stores the categories and texts of the legend entries. Each node element represents one entry in the legend. The legend entries are displayed in the order of the node elements.

●      text

Specifies the path to the context attribute which stores the texts of the legend entries. This property is used to describe a category.

●      textDirection

Specifies the text direction and allows you to use PatternSequenceStep elements for texts in languages which require a specific text direction. The textDirectionproperty can be filled with the following values and is represented by the enumeration type WDTextDirection.

inherit	The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element.
ltr	The text runs from left to right.
rtl	The text runs from right to left.

The default value for this property is inherit.

Properties Overview

Name	Interface	Type	Initial Value	Bindable
category	IWDDateNavigatorLegend	WDDateMarkingCategory	One	bindable_mandatory
dataSource	IWDDateNavigatorLegend	Object		bindable_mandatory
text	IWDDateNavigatorLegend	String (TranslatableText)		bindable
textDirection	IWDDateNavigatorLegend	WDTextDirection	inherit	bindable