Class SyndicationResourceLoadedEventArgs

Provides data for the Loaded event.

Inheritance

System.Object

System.EventArgs

SyndicationResourceLoadedEventArgs

Implements

System.IComparable

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Argotic.Common

Assembly: Argotic.Common.dll

Syntax

[Serializable]
public class SyndicationResourceLoadedEventArgs : EventArgs, IComparable

Remarks

A Loaded event occurs whenever the Load(XmlReader) or Load(IXPathNavigable) methods are called.

Constructors

SyndicationResourceLoadedEventArgs()

Initializes a new instance of the SyndicationResourceLoadedEventArgs class.

Declaration

public SyndicationResourceLoadedEventArgs()

SyndicationResourceLoadedEventArgs(IXPathNavigable)

Initializes a new instance of the SyndicationResourceLoadedEventArgs class using the supplied System.Xml.XPath.IXPathNavigable.

Declaration

public SyndicationResourceLoadedEventArgs(IXPathNavigable data)

Parameters

Type	Name	Description
System.Xml.XPath.IXPathNavigable	data	A System.Xml.XPath.IXPathNavigable object that represents the XML data that was used to load the syndication resource.

Exceptions

Type	Condition
System.ArgumentNullException	The data is a null reference (Nothing in Visual Basic).

SyndicationResourceLoadedEventArgs(IXPathNavigable, Uri, WebRequestOptions)

Initializes a new instance of the SyndicationResourceLoadedEventArgs class using the supplied System.Xml.XPath.IXPathNavigable, System.Net.ICredentials and System.Net.IWebProxy.

Declaration

public SyndicationResourceLoadedEventArgs(IXPathNavigable data, Uri source, WebRequestOptions options)

Parameters

Type	Name	Description
System.Xml.XPath.IXPathNavigable	data	A System.Xml.XPath.IXPathNavigable object that represents the XML data that was used to load the syndication resource.
System.Uri	source	The System.Uri of the Internet resource that the syndication resource was loaded from. Can be null if syndication resource was not loaded using an Internet resource.
WebRequestOptions	options	A WebRequestOptions that holds options that should be applied to web requests.

Exceptions

Type	Condition
System.ArgumentNullException	The data is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).

SyndicationResourceLoadedEventArgs(IXPathNavigable, Uri, WebRequestOptions, Object)

Initializes a new instance of the SyndicationResourceLoadedEventArgs class using the supplied System.Xml.XPath.IXPathNavigable, System.Net.ICredentials, System.Net.IWebProxy and user token.

Declaration

public SyndicationResourceLoadedEventArgs(IXPathNavigable data, Uri source, WebRequestOptions options, object state)

Parameters

Type	Name	Description
System.Xml.XPath.IXPathNavigable	data	A System.Xml.XPath.IXPathNavigable object that represents the XML data that was used to load the syndication resource.
System.Uri	source	The System.Uri of the Internet resource that the syndication resource was loaded from. Can be null if syndication resource was not loaded using an Internet resource.
WebRequestOptions	options	A WebRequestOptions that holds options that should be applied to web requests.
System.Object	state	The user-defined object that was passed to the asynchronous operation.

Exceptions

Type	Condition
System.ArgumentNullException	The data is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).

SyndicationResourceLoadedEventArgs(IXPathNavigable, Uri, ICredentials, IWebProxy)

Initializes a new instance of the SyndicationResourceLoadedEventArgs class using the supplied System.Xml.XPath.IXPathNavigable, System.Net.ICredentials and System.Net.IWebProxy.

Declaration

public SyndicationResourceLoadedEventArgs(IXPathNavigable data, Uri source, ICredentials credentials, IWebProxy proxy)

Parameters

Type	Name	Description
System.Xml.XPath.IXPathNavigable	data	A System.Xml.XPath.IXPathNavigable object that represents the XML data that was used to load the syndication resource.
System.Uri	source	The System.Uri of the Internet resource that the syndication resource was loaded from. Can be null if syndication resource was not loaded using an Internet resource.
System.Net.ICredentials	credentials	The System.Net.ICredentials that were used to authenticate the request to an Internet resource. Can be null if syndication resource was not loaded using an Internet resource.
System.Net.IWebProxy	proxy	The System.Net.IWebProxy used to access the Internet resource. Can be null if syndication resource was not loaded using an Internet resource.

Exceptions

Type	Condition
System.ArgumentNullException	The data is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).

SyndicationResourceLoadedEventArgs(IXPathNavigable, Uri, ICredentials, IWebProxy, Object)

Initializes a new instance of the SyndicationResourceLoadedEventArgs class using the supplied System.Xml.XPath.IXPathNavigable, System.Net.ICredentials, System.Net.IWebProxy and user token.

Declaration

public SyndicationResourceLoadedEventArgs(IXPathNavigable data, Uri source, ICredentials credentials, IWebProxy proxy, object state)

Parameters

Type	Name	Description
System.Xml.XPath.IXPathNavigable	data	A System.Xml.XPath.IXPathNavigable object that represents the XML data that was used to load the syndication resource.
System.Uri	source	The System.Uri of the Internet resource that the syndication resource was loaded from. Can be null if syndication resource was not loaded using an Internet resource.
System.Net.ICredentials	credentials	The System.Net.ICredentials that were used to authenticate the request to an Internet resource. Can be null if syndication resource was not loaded using an Internet resource.
System.Net.IWebProxy	proxy	The System.Net.IWebProxy used to access the Internet resource. Can be null if syndication resource was not loaded using an Internet resource.
System.Object	state	The user-defined object that was passed to the asynchronous operation.

Exceptions

Type	Condition
System.ArgumentNullException	The data is a null reference (Nothing in Visual Basic).
System.ArgumentNullException	The source is a null reference (Nothing in Visual Basic).

Properties

Credentials

Gets the network credentials used for authenticating the request to the Internet resource that the syndication resource was loaded from.

Declaration

public ICredentials Credentials { get; }

Property Value

Type	Description
System.Net.ICredentials	The System.Net.ICredentials that were used to authenticate the request to an Internet resource. If the ISyndicationResource was not loaded by an Internet resource or no credentials were provided, returns null.

See Also

Load(System.Uri, System.Net.ICredentials, System.Net.IWebProxy)

Data

Gets a read-only System.Xml.XPath.XPathNavigator object for navigating the XML data that was used to load the syndication resource.

Declaration

public XPathNavigator Data { get; }

Property Value

Type	Description
System.Xml.XPath.XPathNavigator	A read-only System.Xml.XPath.XPathNavigator object for navigating the XML data that was used to load the syndication resource.

Empty

Represents an syndication resource loaded event with no event data.

Declaration

public static SyndicationResourceLoadedEventArgs Empty { get; }

Property Value

Type	Description
SyndicationResourceLoadedEventArgs	An uninitialized instance of the SyndicationResourceLoadedEventArgs class.

Remarks

The value of Empty is a read-only instance of SyndicationResourceLoadedEventArgs equivalent to the result of calling the SyndicationResourceLoadedEventArgs() constructor.

Proxy

Gets the network proxy used to access the Internet resource that the syndication resource was loaded from.

Declaration

public IWebProxy Proxy { get; }

Property Value

Type	Description
System.Net.IWebProxy	The System.Net.IWebProxy used to access the Internet resource. If the ISyndicationResource was not loaded by an Internet resource or no proxy was specified, returns null.

See Also

Load(System.Uri, System.Net.ICredentials, System.Net.IWebProxy)

Source

Gets the System.Uri of the Internet resource that the syndication resource was loaded from.

Declaration

public Uri Source { get; }

Property Value

Type	Description
System.Uri	The System.Uri of the Internet resource that the syndication resource was loaded from. If the ISyndicationResource was not loaded by an Internet resource, returns null.

See Also

Load(System.Uri, System.Net.ICredentials, System.Net.IWebProxy)

State

Gets an System.Object containing state information that was passed to the asynchronous load operation.

Declaration

public object State { get; }

Property Value

Type	Description
System.Object	A System.Object containing state information that was passed to the asynchronous load operation. If the ISyndicationResource was not loaded by an Internet resource or no user token provided, returns null.

See Also

LoadAsync(System.Uri, System.Object)

Methods

CompareTo(Object)

Compares the current instance with another object of the same type.

Declaration

public int CompareTo(object obj)

Parameters

Type	Name	Description
System.Object	obj	An object to compare with this instance.

Returns

Type	Description
System.Int32	A 32-bit signed integer that indicates the relative order of the objects being compared.

Exceptions

Type	Condition
System.ArgumentException	The obj is not the expected System.Type.

Equals(Object)

Determines whether the specified System.Object is equal to the current instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The System.Object to compare with the current instance.

Returns

Type	Description
System.Boolean	true if the specified System.Object is equal to the current instance; otherwise, false.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for the current instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A 32-bit signed integer hash code.

Overrides

System.Object.GetHashCode()

ToString()

Returns a System.String that represents the current SyndicationResourceLoadedEventArgs.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current SyndicationResourceLoadedEventArgs.

Overrides

System.Object.ToString()

Remarks

This method returns a human-readable string for the current instance. Hash code values are displayed for applicable properties.

Operators

Equality(SyndicationResourceLoadedEventArgs, SyndicationResourceLoadedEventArgs)

Determines if operands are equal.

Declaration

public static bool operator ==(SyndicationResourceLoadedEventArgs first, SyndicationResourceLoadedEventArgs second)

Parameters

Type	Name	Description
SyndicationResourceLoadedEventArgs	first	Operand to be compared.
SyndicationResourceLoadedEventArgs	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the values of its operands are equal, otherwise; false.

GreaterThan(SyndicationResourceLoadedEventArgs, SyndicationResourceLoadedEventArgs)

Determines if first operand is greater than second operand.

Declaration

public static bool operator>(SyndicationResourceLoadedEventArgs first, SyndicationResourceLoadedEventArgs second)

Parameters

Type	Name	Description
SyndicationResourceLoadedEventArgs	first	Operand to be compared.
SyndicationResourceLoadedEventArgs	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is greater than the second, otherwise; false.

Inequality(SyndicationResourceLoadedEventArgs, SyndicationResourceLoadedEventArgs)

Determines if operands are not equal.

Declaration

public static bool operator !=(SyndicationResourceLoadedEventArgs first, SyndicationResourceLoadedEventArgs second)

Parameters

Type	Name	Description
SyndicationResourceLoadedEventArgs	first	Operand to be compared.
SyndicationResourceLoadedEventArgs	second	Operand to compare to.

Returns

Type	Description
System.Boolean	false if its operands are equal, otherwise; true.

LessThan(SyndicationResourceLoadedEventArgs, SyndicationResourceLoadedEventArgs)

Determines if first operand is less than second operand.

Declaration

public static bool operator <(SyndicationResourceLoadedEventArgs first, SyndicationResourceLoadedEventArgs second)

Parameters

Type	Name	Description
SyndicationResourceLoadedEventArgs	first	Operand to be compared.
SyndicationResourceLoadedEventArgs	second	Operand to compare to.

Returns

Type	Description
System.Boolean	true if the first operand is less than the second, otherwise; false.

Implements

System.IComparable

See Also

ISyndicationResource

Load(System.Xml.XPath.IXPathNavigable)

Load(System.Xml.XmlReader)