TimeSpanStringConvertEventArgs.TimeSpanValue Property

Gets or sets the TimeSpan value used when converting a TimeSpan value to a string or vice versa.

Namespace: DevExpress.XtraScheduler.Native

Assembly: DevExpress.XtraScheduler.v19.2.Core.dll

Declaration

public TimeSpan TimeSpanValue { get; set; }
Public Property TimeSpanValue As TimeSpan

Property Value

Type Description
TimeSpan

A TimeSpan which represents the string value to be converted from or to.

Remarks

The TimeSpanValue property value is used when converting a TimeSpan value to a string or vice versa with the HumanReadableTimeSpanHelper.ParseString and HumanReadableTimeSpanHelper.ConvertToString events.

Note that the corresponding string value used for conversion can be accessed via the TimeSpanStringConvertEventArgs.StringValue property.

Examples

This example demonstrates how to use the HumanReadableTimeSpanHelper instance to implement the custom conversion of a TimeSpan value to a string and vice versa. To do this handle the HumanReadableTimeSpanHelper.ParseString and HumanReadableTimeSpanHelper.ConvertToString events and use the members of the corresponding TimeSpanStringConvertEventArgs object.

using DevExpress.XtraScheduler.Native;
// ...

// Handle the ParseString and ConvertToString events of the HumanReadableTimeSpanHelper.
HumanReadableTimeSpanHelper.ParseString += new TimeSpanStringConvertEventHandler(OnParse);
HumanReadableTimeSpanHelper.ConvertToString += new TimeSpanStringConvertEventHandler(OnToString);

// Custom parsing of a string to a TimeSpan value.
void OnParse(object sender, TimeSpanStringConvertEventArgs e) {
   double val;
   try {
         string number = e.StringValue.Substring(0, e.StringValue.IndexOf(" milliseconds"));
         val = Convert.ToDouble(number);
   }
   catch {
         val = 0;
   }

   e.TimeSpanValue = TimeSpan.FromMilliseconds(val);
   e.Handled = true;
}

// Custom conversion of a TimeSpan value to a string.
void OnToString(object sender, TimeSpanStringConvertEventArgs e) {
   e.StringValue = e.TimeSpanValue.TotalMilliseconds.ToString() + " milliseconds";
   e.Handled = true;
}
See Also