Class DurationPattern
Represents a pattern for parsing and formatting Duration values.
Since 1.2.x
Availability net35-Client, PCL
Inheritance
Object
DurationPattern
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: NodaTime.Text
Assembly: NodaTime.dll
Syntax
public sealed class DurationPattern : IPattern<Duration>Properties
PatternText
Returns the pattern text for this pattern, as supplied on creation.
Since 1.2.x
Availability net35-Client, PCL
Declaration
public string PatternText { get; }Property Value
| Type | Description |
|---|---|
| String |
RoundtripPattern
General pattern for durations using the invariant culture, with a format string of "-D:hh:mm:ss.FFFFFFF".
This pattern round-trips.
Since 1.2.x
Availability net35-Client, PCL
Declaration
public static DurationPattern RoundtripPattern { get; }Property Value
| Type | Description |
|---|---|
| DurationPattern |
Methods
Create(String, CultureInfo)
Creates a pattern for the given pattern text and culture.
Since 1.2.x
Availability net35-Client, PCL
Declaration
public static DurationPattern Create(string patternText, CultureInfo cultureInfo)Parameters
| Type | Name | Description |
|---|---|---|
| String | patternText | Pattern text to create the pattern for |
| CultureInfo | cultureInfo | The culture to use in the pattern |
Returns
| Type | Description |
|---|---|
| DurationPattern | A pattern for parsing and formatting offsets. |
Remarks
See the user guide for the available pattern text options.
Exceptions
| Type | Condition |
|---|---|
| InvalidPatternException | The pattern text was invalid. |
CreateWithCurrentCulture(String)
Creates a pattern for the given pattern text in the current thread's current culture.
Since 1.2.x
Availability net35-Client, PCL
Declaration
public static DurationPattern CreateWithCurrentCulture(string patternText)Parameters
| Type | Name | Description |
|---|---|---|
| String | patternText | Pattern text to create the pattern for |
Returns
| Type | Description |
|---|---|
| DurationPattern | A pattern for parsing and formatting offsets. |
Remarks
See the user guide for the available pattern text options. Note that the current culture
is captured at the time this method is called - it is not captured at the point of parsing
or formatting values.
Exceptions
| Type | Condition |
|---|---|
| InvalidPatternException | The pattern text was invalid. |
CreateWithInvariantCulture(String)
Creates a pattern for the given pattern text in the invariant culture.
Since 1.2.x
Availability net35-Client, PCL
Declaration
public static DurationPattern CreateWithInvariantCulture(string patternText)Parameters
| Type | Name | Description |
|---|---|---|
| String | patternText | Pattern text to create the pattern for |
Returns
| Type | Description |
|---|---|
| DurationPattern | A pattern for parsing and formatting offsets. |
Remarks
See the user guide for the available pattern text options. Note that the current culture
is captured at the time this method is called - it is not captured at the point of parsing
or formatting values.
Exceptions
| Type | Condition |
|---|---|
| InvalidPatternException | The pattern text was invalid. |
Format(Duration)
Formats the given duration as text according to the rules of this pattern.
Since 1.2.x
Availability net35-Client, PCL
Declaration
public string Format(Duration value)Parameters
| Type | Name | Description |
|---|---|---|
| Duration | value | The duration to format. |
Returns
| Type | Description |
|---|---|
| String | The duration formatted according to this pattern. |
Parse(String)
Parses the given text value according to the rules of this pattern.
Since 1.2.x
Availability net35-Client, PCL
Declaration
public ParseResult<Duration> Parse(string text)Parameters
| Type | Name | Description |
|---|---|---|
| String | text | The text value to parse. |
Returns
| Type | Description |
|---|---|
| ParseResult<Duration> | The result of parsing, which may be successful or unsuccessful. |
Remarks
This method never throws an exception (barring a bug in Noda Time itself). Even errors such as
the argument being null are wrapped in a parse result.
WithCulture(CultureInfo)
Creates a pattern for the same original pattern text as this pattern, but with the specified
culture.
Since 1.2.x
Availability net35-Client, PCL
Declaration
public DurationPattern WithCulture(CultureInfo cultureInfo)Parameters
| Type | Name | Description |
|---|---|---|
| CultureInfo | cultureInfo | The culture to use in the new pattern. |
Returns
| Type | Description |
|---|---|
| DurationPattern | A new pattern with the given culture. |