Class SyndicationResourceLoadSettings

Specifies a set of features to support on a ISyndicationResource object loaded by the Load(IXPathNavigable, SyndicationResourceLoadSettings) method.

Inheritance

System.Object

SyndicationResourceLoadSettings

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 sealed class SyndicationResourceLoadSettings : IComparable

Constructors

| Improve this Doc View Source

SyndicationResourceLoadSettings()

Initializes a new instance of the SyndicationResourceLoadSettings class.

Declaration

public SyndicationResourceLoadSettings()

Properties

| Improve this Doc View Source

AutoDetectExtensions

Gets or sets a value indicating if auto-detection of supported syndication extensions is enabled.

Declaration

public bool AutoDetectExtensions { get; set; }

Property Value

Type	Description
System.Boolean	true if the syndication extensions supported by the load operation are automatically determined based on the XML namespaces declared on a syndication resource; otherwise false. The default value is true.

Remarks

Automatic detection of supported syndication extensions will not remove any syndication extensions already added to the SupportedExtensions collection prior to the load operation execution.

| Improve this Doc View Source

CharacterEncoding

Gets or sets the character encoding to use when parsing a syndication resource.

Declaration

public Encoding CharacterEncoding { get; set; }

Property Value

Type	Description
System.Text.Encoding	A System.Text.Encoding object that indicates the character encoding to use when parsing a syndication resource. The default value is System.Text.Encoding.UTF8.

Exceptions

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

| Improve this Doc View Source

RetrievalLimit

Gets or sets the maximum number of resource entities to retrieve from a syndication resource.

Declaration

public int RetrievalLimit { get; set; }

Property Value

Type	Description
System.Int32	The maximum number of entities to retrieve from a syndication resource. The default value is 0, which indicates there is no limit.

Remarks

This setting is typically used to optimize processing by reducing the number of resource entities that must be parsed. Some syndication resources may not utilize this setting if they do not represent a list of retrievable entities.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	The `value` is less than zero.

| Improve this Doc View Source

SupportedExtensions

Gets the syndication extensions to attempt to load from a syndication resource.

Declaration

public Collection<Type> SupportedExtensions { get; }

Property Value

Type	Description
System.Collections.ObjectModel.Collection<System.Type>	A System.Collections.ObjectModel.Collection<T> collection of System.Type objects that represent syndication extension instances to attempt to instantiate during the load operation. The default value is an empty collection.

Remarks

If AutoDetectExtensions is true, this collection will be automatically filled during the load operation based on the XML namespaces declared on the syndication resource. Automatic detection will not remove any syndication extensions already added to this collection prior to the load operation execution.

| Improve this Doc View Source

Timeout

Gets or sets a value that specifies the amount of time after which asynchronous load operations will time out.

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
System.TimeSpan	An System.TimeSpan that specifies the time-out period. The default value is 15 seconds.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	The time-out period is less than zero.
System.ArgumentOutOfRangeException	The time-out period is greater than a year.

Methods

| Improve this Doc View Source

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.

| Improve this Doc View Source

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)

| Improve this Doc View Source

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()

| Improve this Doc View Source

ToString()

Returns a System.String that represents the current SyndicationResourceLoadSettings.

Declaration

public override string ToString()

Returns

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

Overrides

System.Object.ToString()

Remarks

This method returns a human-readable string for the current instance.

Operators

| Improve this Doc View Source

Equality(SyndicationResourceLoadSettings, SyndicationResourceLoadSettings)

Determines if operands are equal.

Declaration

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

Parameters

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

Returns

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

| Improve this Doc View Source

GreaterThan(SyndicationResourceLoadSettings, SyndicationResourceLoadSettings)

Determines if first operand is greater than second operand.

Declaration

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

Parameters

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

Returns

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

| Improve this Doc View Source

Inequality(SyndicationResourceLoadSettings, SyndicationResourceLoadSettings)

Determines if operands are not equal.

Declaration

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

Parameters

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

Returns

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

| Improve this Doc View Source

LessThan(SyndicationResourceLoadSettings, SyndicationResourceLoadSettings)

Determines if first operand is less than second operand.

Declaration

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

Parameters

Type	Name	Description
SyndicationResourceLoadSettings	first	Operand to be compared.
SyndicationResourceLoadSettings	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