Description Property (Note)

Gets or sets the description/contents of the Note object

Syntax

Visual Basic

'Declaration
 
Public Property Description As String

C#

public string Description {get; set;}

Remarks

The Description property determines the text that will be displayed in the Note.

Example

This example demonstrates how the use the Note object.

Visual Basic

Imports System.Diagnostics
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinSchedule

    Private Sub SetupNote()

        '	Add a new Note object to the component's Notes collection
        '	for the current date
        Dim note As Note = Me.ultraCalendarInfo1.Notes.Add(DateTime.Today)

        '	Make sure we have the right starting date
        Debug.Assert((note.Date = DateTime.Today.Date), "Error creating the note.")

        '	Set the description
        note.Description = "My Note"

        '	Hide the note if the day with which it is associated is disabled
        If (Not note.Day.EnabledResolved) Then
            note.Visible = False
        End If

        '	Lock the note so the end user cannot modify its description
        '	or change the day with which it is associated
        note.Locked = True

        '	If the note is selected, deselect it
        If (note.IsSelected) Then
            note.Selected = False
        End If

    End Sub

C#

using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinSchedule;

		private void SetupNote()
		{

			//	Add a new Note object to the component's Notes collection
			//	for the current date
			Note note = this.ultraCalendarInfo1.Notes.Add( DateTime.Today );

			//	Make sure we have the right starting date
			Debug.Assert( (note.Date == DateTime.Today.Date), "Error creating the note." );

			//	Set the description
			note.Description = "My Note";

			//	Hide the note if the day with which it is associated is disabled
			if ( ! note.Day.EnabledResolved )
				note.Visible = false;

			//	Lock the note so the end user cannot modify its description
			//	or change the day with which it is associated
			note.Locked = true;

			//	If the note is selected, deselect it
			if ( note.IsSelected )
				note.Selected = false;
			
		}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2