Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class NodaTime.Text.OffsetPattern
Assembly: NodaTime
Inheritance: object → OffsetPattern
Implemented Interfaces
Represents a pattern for parsing and formatting <see cref="T:NodaTime.Offset" /> values.
Properties
public static
OffsetPattern
GeneralInvariant
The "general" offset pattern (e.g. +HH, +HH:mm, +HH:mm:ss, +HH:mm:ss.fff) for the invariant culture.
public static
OffsetPattern
GeneralInvariantWithZ
The "general" offset pattern (e.g. +HH, +HH:mm, +HH:mm:ss, +HH:mm:ss.fff) for the invariant culture,
but producing (and allowing) Z as a value for a zero offset.
public
string
PatternText
Gets the pattern text for this pattern, as supplied on creation.
Methods
public
ParseResult<Offset>
Parse(string text)
Parses the given text value according to the rules of this pattern.
Returns The result of parsing, which may be successful or unsuccessful.
text
The text value to parse.
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.
public
string
Format(Offset value)
Formats the given offset as text according to the rules of this pattern.
Returns The offset formatted according to this pattern.
value
The offset to format.
public
System.Text.StringBuilder
AppendFormat(Offset value,
System.Text.StringBuilder builder)
Formats the given value as text according to the rules of this pattern,
appending to the given <see cref="T:System.Text.StringBuilder" /> .
Returns The builder passed in as <paramref name="builder" /> .
value
The value to format.
builder
The <c>StringBuilder</c> to append to.
public static
OffsetPattern
Create(string patternText,
System.Globalization.CultureInfo cultureInfo)
Creates a pattern for the given pattern text and culture.
Returns A pattern for parsing and formatting offsets.
patternText
Pattern text to create the pattern for
cultureInfo
The culture to use in the pattern
Remarks
See the user guide for the available pattern text options.
public static
OffsetPattern
CreateWithCurrentCulture(string patternText)
Creates a pattern for the given pattern text in the current thread's current culture.
Returns A pattern for parsing and formatting offsets.
patternText
Pattern text to create the pattern for
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.
public static
OffsetPattern
CreateWithInvariantCulture(string patternText)
Creates a pattern for the given pattern text in the invariant culture.
Returns A pattern for parsing and formatting offsets.
patternText
Pattern text to create the pattern for
Remarks
See the user guide for the available pattern text options.
public
OffsetPattern
WithCulture(System.Globalization.CultureInfo cultureInfo)
Creates a pattern for the same original pattern text as this pattern, but with the specified
culture.
Returns A new pattern with the given culture.
cultureInfo
The culture to use in the new pattern.
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object