Class AppointmentForm

Displays a form allowing a user to edit information in a IScheduleAppointment.

Inheritance

System.Object

AppointmentForm

Namespace: Syncfusion.Windows.Forms.Schedule

Assembly: Syncfusion.Schedule.Windows.dll

Syntax

public class AppointmentForm : Form

Constructors

AppointmentForm()

Initializes a new instance of the AppointmentForm.

Declaration

public AppointmentForm()

Fields

DisplayStrings

Gets or sets the various strings used in the AppointmentForm.

Declaration

public static string[] DisplayStrings

Field Value

Type
System.String[]

Remarks

Modifying the strings in this array will affect the display of the AppointmentForm. You can use these strings to localize the labels that appear on the form.

Examples

Here are the default values of this string array.

public static string[] DisplayStrings = new string[]
{    
     "Subject:",        // 0                       
     "Location:",       // 1                       
     "Show time as:",   // 2                       
     "Reminder:",       // 3                       
     "All Day Event",    // 4                       
     "End Time:",       // 5                       
     "Start Time:",     // 6                       
     "Label:",          // 7                       
     "subject",          // 8                       
     "Cancel",           // 9                       
     "Save and Close",   // 10                       
     "Enter Appointment", // 11                       
     "Delete this appointment that spans more than one day?", // 12
     "Delete a Span",    // 13                       
     "Delete Span",      // 14                       
     "Edit Recurring",   // 15                       
     "Make Recurring"    // 16                       
 };                       

ShowRecurDialog

Gets the button that is used to display the default recurrence dialog if needed by the data provider.

Declaration

public Button ShowRecurDialog

Field Value

Type
System.Windows.Forms.Button

Remarks

If you want a custom dialog display, you can call UnhookDefaultRecurrenceDialog(), and then subscribe to this member's Click event to display your own dialog.

Properties

CreateParams

Gets the required creation parameters when the control handle is created.

Declaration

protected override CreateParams CreateParams { get; }

Property Value

Type
System.Windows.Forms.CreateParams

Font

Gets or sets the System.Drawing.Font value for Form.

Declaration

public override Font Font { get; set; }

Property Value

Type
System.Drawing.Font

IgnoreScheduleRTLSettings

Gets or sets whether this form will use the RTL settings from the ScheduleControl to decide whether to mirror the form.

Declaration

public static bool IgnoreScheduleRTLSettings { get; set; }

Property Value

Type
System.Boolean

Methods

Dispose(Boolean)

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnLoad(EventArgs)

Overridden to conditionally display the recurring event button.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The System.EventArgs that contains the event data.

SaveChangesToItem()

Moves values displayed in the form's Controls to the Item object.

Declaration

public void SaveChangesToItem()

SetDataProvider(IScheduleDataProvider, IScheduleAppointment)

Initializes the form using the IScheduleDataProvider that provides the data for the ScheduleControl.

Declaration

public void SetDataProvider(IScheduleDataProvider provider, IScheduleAppointment item)

Parameters

Type	Name	Description
IScheduleDataProvider	provider	The IScheduleDataProvider object.
IScheduleAppointment	item	The current item to be displayed on this form.

Remarks

IScheduleDataProvider is the object that provides the data to the ScheduleControl. This includes items like the DropLists that provide the options for many of the properties you see in IScheduleAppointments in addition to the IScheduleAppointments themselves. This method uses the information from the IScheduleDataProvider to populate the controls on this form.

SetDataProvider(IScheduleDataProvider, IScheduleAppointment, Int32, String)

Initializes the form using the IScheduleDataProvider that provides the data for the ScheduleControl.

Declaration

public void SetDataProvider(IScheduleDataProvider provider, IScheduleAppointment item, int minimumTimeSlot, string format)

Parameters

Type	Name	Description
IScheduleDataProvider	provider	The IScheduleDataProvider object.
IScheduleAppointment	item	The current item to be displayed on this form.
System.Int32	minimumTimeSlot	The time increment used in the time dropdowns.
System.String	format	The time format used in the time dropdowns.

Remarks

IScheduleDataProvider is the object that provides the data to the ScheduleControl. This includes items like the DropLists that provide the options for many of the properties you see in IScheduleAppointments inaddition to the IScheduleAppointments themselves. This method uses the information from the IScheduleDataProvider to populate the controls on this form.

SetDataProvider(IScheduleDataProvider, IScheduleAppointment, Int32, String, ScheduleControl)

Sets the data provider to the scheduler.

Declaration

public void SetDataProvider(IScheduleDataProvider provider, IScheduleAppointment item, int minimumTimeSlot, string format, ScheduleControl schedule)

Parameters

Type	Name	Description
IScheduleDataProvider	provider	providing the schedule item data to the ScheduleControl.
IScheduleAppointment	item	Defines the individual schedule items.
System.Int32	minimumTimeSlot	Specifies the timeslot.
System.String	format	Set the format.
ScheduleControl	schedule	Provides the schedule functionality.

UnhookDefaultRecurrenceDialog()

Use this method unsubscribe to the click event that opens the default recurrence dialog.

Declaration

public void UnhookDefaultRecurrenceDialog()