System.Runtime.Remoting.Metadata.W3cXsd2001.SoapYearMonth Class

Assembly: Mscorlib.dll
Namespace: System.Runtime.Remoting.Metadata.W3cXsd2001
Summary
Wraps an XML gYearMonth type.
C# Syntax:
[Serializable]
public sealed class SoapYearMonth : ISoapXsd
See also:
System.Runtime.Remoting.Metadata.W3cXsd2001 Namespace

System.Runtime.Remoting.Metadata.W3cXsd2001.SoapYearMonth Member List:

Public Constructors
ctor #1 Overloaded:
.ctor()

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
Initializes a new instance of the SoapYearMonth class.
ctor #2 Overloaded:
.ctor(DateTime value)

Initializes a new instance of the SoapYearMonth class with a specified DateTime object.
ctor #3 Overloaded:
.ctor(DateTime value, int sign)

Initializes a new instance of the SoapYearMonth class with a specified DateTime object and an integer indicating whether SoapYearMonth.Value is a positive or negative value.
Public Properties
Sign Read-write

Gets or sets whether the date and time of the current instance is positive or negative.
Value Read-write

Gets or sets the date and time of the current instance.
XsdType Read-only

Gets the XML Schema definition language (XSD) of the current SOAP type.
Public Methods
Equals
(inherited from System.Object)
See base class member description: System.Object.Equals

Derived from System.Object, the primary base class for all objects.
GetHashCode
(inherited from System.Object)
See base class member description: System.Object.GetHashCode

Derived from System.Object, the primary base class for all objects.
GetType
(inherited from System.Object)
See base class member description: System.Object.GetType

Derived from System.Object, the primary base class for all objects.
GetXsdType Returns the XML Schema definition language (XSD) of the current SOAP type.
Parse Converts the specified String into a SoapYearMonth object.
ToString Overridden:
Returns a SoapYearMonth.Value as a String.
Protected Methods
Finalize
(inherited from System.Object)
See base class member description: System.Object.Finalize

Derived from System.Object, the primary base class for all objects.
MemberwiseClone
(inherited from System.Object)
See base class member description: System.Object.MemberwiseClone

Derived from System.Object, the primary base class for all objects.

Hierarchy:


System.Runtime.Remoting.Metadata.W3cXsd2001.SoapYearMonth Member Details

Overloaded ctor #1
Summary
Initializes a new instance of the SoapYearMonth class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
C# Syntax:
public SoapYearMonth();

Return to top


Overloaded ctor #2
Summary
Initializes a new instance of the SoapYearMonth class with a specified DateTime object.
C# Syntax:
public SoapYearMonth(
   DateTime value
);
Parameters:

value

A DateTime object to initialize the current instance.

Return to top


Overloaded ctor #3
Summary
Initializes a new instance of the SoapYearMonth class with a specified DateTime object and an integer indicating whether SoapYearMonth.Value is a positive or negative value.
C# Syntax:
public SoapYearMonth(
   DateTime value,
   int sign
);
Parameters:

value

A DateTime object to initialize the current instance.

sign

An integer indicating whether value is positive.

Remarks
An integer of less than 0 indicates a negative sign.

Return to top


Property: Sign (read-write)
Summary
Gets or sets whether the date and time of the current instance is positive or negative.
C# Syntax:
public int Sign {get; set;}
Remarks
An integer of less than 0 indicates a negative Sign.

Return to top


Property: Value (read-write)
Summary
Gets or sets the date and time of the current instance.
C# Syntax:
public DateTime Value {get; set;}

Return to top


Property: XsdType (read-only)
Summary
Gets the XML Schema definition language (XSD) of the current SOAP type.
C# Syntax:
public static string XsdType {get;}

Return to top


Method: Equals(
   object obj
)
Inherited
See base class member description: System.Object.Equals
C# Syntax:
public virtual bool Equals(
   object obj
);

For more information on members inherited from System.Object click on the link above.

Return to top


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~SoapYearMonth();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetHashCode()
Inherited
See base class member description: System.Object.GetHashCode
C# Syntax:
public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetType()
Inherited
See base class member description: System.Object.GetType
C# Syntax:
public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetXsdType()
Summary
Returns the XML Schema definition language (XSD) of the current SOAP type.
C# Syntax:
public string GetXsdType();
Return Value:
A String indicating the XSD of the current SOAP type.
Implements:
ISoapXsd.GetXsdType

Return to top


Method: MemberwiseClone()
Inherited
See base class member description: System.Object.MemberwiseClone
C# Syntax:
protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: Parse(
   string value
)
Summary
Converts the specified String into a SoapYearMonth object.
C# Syntax:
public static SoapYearMonth Parse(
   string value
);
Parameters:

value

The String to convert

Return Value:
A SoapYearMonth object obtained from value.
Exceptions
Exception Type Condition
RemotingException value does not contain a date and time that corresponds to any of the recognized format patterns.
Remarks
The Parse method is capable of parsing strings in various formats. The recognizable string formats are composed out of the following format patterns.

Format Pattern Description Examples
yyyy The year in four digit format. 1999, 1812
MM The numeric month. Single-digit months have a leading zero. 11, 05
zzz The full time zone offset (hour and minutes) from the Universal Time Coordinate (Greenwich Mean Time). Single-digit hours have a leading zero. -07:00, 08:00

Return to top


Overridden Method: ToString()
Summary
Returns a SoapYearMonth.Value as a String.
C# Syntax:
public override string ToString();
Return Value:
A String obtained from Value in the format "yyyy-MM" or "'-'yyyy-MM" if SoapYearMonth.Sign is negative.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.