Class LocalTimePattern
Represents a pattern for parsing and formatting LocalTime values.
Since 1.0.x
Availability net35-Client, PCL
Inheritance
Object
LocalTimePattern
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 LocalTimePattern : IPattern<LocalTime>Properties
ExtendedIso
Returns an invariant local time pattern which is ISO-8601 compatible, providing up to 7 decimal places.
(These digits are omitted when unnecessary.)
This corresponds to the text pattern "HH':'mm':'ss;FFFFFFF".
Since 1.4.x
Availability net35-Client, PCL
Declaration
public static LocalTimePattern ExtendedIso { get; }Property Value
| Type | Description |
|---|---|
| LocalTimePattern |
ExtendedIsoPattern
Returns an invariant local time pattern which is ISO-8601 compatible, providing up to 7 decimal places.
(These digits are omitted when unnecessary.)
This corresponds to the text pattern "HH':'mm':'ss;FFFFFFF".
Since 1.0.x
Availability net35-Client, PCL
Declaration
[Obsolete("Use ExtendedIso for compatibility with 2.0")]
public static LocalTimePattern ExtendedIsoPattern { get; }Property Value
| Type | Description |
|---|---|
| LocalTimePattern |
PatternText
Returns the pattern text for this pattern, as supplied on creation.
Since 1.0.x
Availability net35-Client, PCL
Declaration
public string PatternText { get; }Property Value
| Type | Description |
|---|---|
| String |
TemplateValue
Returns the value used as a template for parsing: any field values unspecified
in the pattern are taken from the template.
Since 1.0.x
Availability net35-Client, PCL
Declaration
public LocalTime TemplateValue { get; }Property Value
| Type | Description |
|---|---|
| LocalTime |
Methods
Create(String, CultureInfo)
Creates a pattern for the given pattern text and culture, with a template value of midnight.
Since 1.0.x
Availability net35-Client, PCL
Declaration
public static LocalTimePattern 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 |
|---|---|
| LocalTimePattern | A pattern for parsing and formatting local times. |
Remarks
See the user guide for the available pattern text options.
Exceptions
| Type | Condition |
|---|---|
| InvalidPatternException | The pattern text was invalid. |
Create(String, CultureInfo, LocalTime)
Creates a pattern for the given pattern text, culture, and template value.
Since 1.0.x
Availability net35-Client, PCL
Declaration
public static LocalTimePattern Create(string patternText, CultureInfo cultureInfo, LocalTime templateValue)Parameters
| Type | Name | Description |
|---|---|---|
| String | patternText | Pattern text to create the pattern for |
| CultureInfo | cultureInfo | The culture to use in the pattern |
| LocalTime | templateValue | Template value to use for unspecified fields |
Returns
| Type | Description |
|---|---|
| LocalTimePattern | A pattern for parsing and formatting local times. |
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.0.x
Availability net35-Client, PCL
Declaration
public static LocalTimePattern CreateWithCurrentCulture(string patternText)Parameters
| Type | Name | Description |
|---|---|---|
| String | patternText | Pattern text to create the pattern for |
Returns
| Type | Description |
|---|---|
| LocalTimePattern | A pattern for parsing and formatting local times. |
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.0.x
Availability net35-Client, PCL
Declaration
public static LocalTimePattern CreateWithInvariantCulture(string patternText)Parameters
| Type | Name | Description |
|---|---|---|
| String | patternText | Pattern text to create the pattern for |
Returns
| Type | Description |
|---|---|
| LocalTimePattern | A pattern for parsing and formatting local times. |
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(LocalTime)
Formats the given local time as text according to the rules of this pattern.
Since 1.0.x
Availability net35-Client, PCL
Declaration
public string Format(LocalTime value)Parameters
| Type | Name | Description |
|---|---|---|
| LocalTime | value | The local time to format. |
Returns
| Type | Description |
|---|---|
| String | The local time formatted according to this pattern. |
Parse(String)
Parses the given text value according to the rules of this pattern.
Since 1.0.x
Availability net35-Client, PCL
Declaration
public ParseResult<LocalTime> Parse(string text)Parameters
| Type | Name | Description |
|---|---|---|
| String | text | The text value to parse. |
Returns
| Type | Description |
|---|---|
| ParseResult<LocalTime> | 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.0.x
Availability net35-Client, PCL
Declaration
public LocalTimePattern WithCulture(CultureInfo cultureInfo)Parameters
| Type | Name | Description |
|---|---|---|
| CultureInfo | cultureInfo | The culture to use in the new pattern. |
Returns
| Type | Description |
|---|---|
| LocalTimePattern | A new pattern with the given culture. |
WithTemplateValue(LocalTime)
Creates a pattern like this one, but with the specified template value.
Since 1.0.x
Availability net35-Client, PCL
Declaration
public LocalTimePattern WithTemplateValue(LocalTime newTemplateValue)Parameters
| Type | Name | Description |
|---|---|---|
| LocalTime | newTemplateValue | The template value for the new pattern, used to fill in unspecified fields. |
Returns
| Type | Description |
|---|---|
| LocalTimePattern | A new pattern with the given template value. |