C# Class StringFormatEx.Plugins.TimestringPlugin

Inheritance: IStringFormatterPlugin
Exibir arquivo Open project: qstarin/StringFormatEx Class Usage Examples

Public Methods

Method Description
CreateDefaultFormattingOptions ( ) : FormattingOptions
GetFormatExtensions ( ) : IEnumerable>
GetSourceExtensions ( ) : IEnumerable>
TimestringPlugin ( ) : System
TimestringPlugin ( FormattingOptions formattingOptions ) : System
ToTimeString ( System.TimeSpan FromTime ) : string
ToTimeString ( System.TimeSpan FromTime, FormattingOptions formattingOptions ) : string

Turns a TimeSpan into a human-readable text. For example: "31.23:59:00.555" = "31 days 23 hours 59 minutes 0 seconds 555 milliseconds"
ToTimeString ( System.TimeSpan FromTime, string formatOptions ) : string
ToTimeString ( System.TimeSpan FromTime, string formatOptions, FormattingOptions defaultFormattingOptions ) : string

Converts the Timespan into a string, using the format options as a shortcut. Example: ts$ = TimeString(Now.TimeOfDay, "[(smallest)w|d|h|m|s|ms] [(largest)w|d|h|m|s|ms] [auto|short|fill|full] [abbr|noabbr]")

The format options are case insensitive.

Private Methods

Method Description
DoTimeStringFormat ( object sender, ExtendFormatEventArgs e ) : void

Method Details

CreateDefaultFormattingOptions() public static method

public static CreateDefaultFormattingOptions ( ) : FormattingOptions
return FormattingOptions

GetFormatExtensions() public method

public GetFormatExtensions ( ) : IEnumerable>
return IEnumerable>

GetSourceExtensions() public method

public GetSourceExtensions ( ) : IEnumerable>
return IEnumerable>

TimestringPlugin() public method

public TimestringPlugin ( ) : System
return System

TimestringPlugin() public method

public TimestringPlugin ( FormattingOptions formattingOptions ) : System
formattingOptions FormattingOptions
return System

ToTimeString() public static method

public static ToTimeString ( System.TimeSpan FromTime ) : string
FromTime System.TimeSpan
return string

ToTimeString() public static method

Turns a TimeSpan into a human-readable text. For example: "31.23:59:00.555" = "31 days 23 hours 59 minutes 0 seconds 555 milliseconds"
public static ToTimeString ( System.TimeSpan FromTime, FormattingOptions formattingOptions ) : string
FromTime System.TimeSpan
formattingOptions FormattingOptions
return string

ToTimeString() public static method

public static ToTimeString ( System.TimeSpan FromTime, string formatOptions ) : string
FromTime System.TimeSpan
formatOptions string
return string

ToTimeString() public static method

Converts the Timespan into a string, using the format options as a shortcut. Example: ts$ = TimeString(Now.TimeOfDay, "[(smallest)w|d|h|m|s|ms] [(largest)w|d|h|m|s|ms] [auto|short|fill|full] [abbr|noabbr]")
The format options are case insensitive.
public static ToTimeString ( System.TimeSpan FromTime, string formatOptions, FormattingOptions defaultFormattingOptions ) : string
FromTime System.TimeSpan
formatOptions string A list of flags options. /// Syntax: /// [(smallest)w|d|h|m|s|ms] [(largest)w|d|h|m|s|ms] [auto|short|fill|full] [abbr|noabbr] [less|noless] ///
defaultFormattingOptions FormattingOptions
return string