Class SyndicationResourceSaveSettings

Specifies a set of features to support on a ISyndicationResource object persisted by the Save(Stream, SyndicationResourceSaveSettings) method.

Inheritance

System.Object

SyndicationResourceSaveSettings

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 SyndicationResourceSaveSettings : IComparable

Constructors

| Improve this Doc View Source

SyndicationResourceSaveSettings()

Initializes a new instance of the SyndicationResourceSaveSettings class.

Declaration

public SyndicationResourceSaveSettings()

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 save operation are automatically determined based on the syndication extensions added to the syndication resource and its child entities; 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 save operation execution.

| Improve this Doc View Source

CharacterEncoding

Gets or sets the character encoding to use when persisting 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 persisting 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

MinimizeOutputSize

Gets or sets a value indicating if syndication resource persist operations should attempt to minimize the physical size of the resulting output.

Declaration

public bool MinimizeOutputSize { get; set; }

Property Value

Type	Description
System.Boolean	true if output size should be as small as possible; otherwise false. The default value is false.

| Improve this Doc View Source

SupportedExtensions

Gets the syndication extensions that extend the 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 used during the save operation. The default value is an empty collection.

Remarks

During a save operation, each of these syndication extension types is instantiated and used to write the prefixed XML namespace declarations on the root syndication resource entity.

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 SyndicationResourceSaveSettings.

Declaration

public override string ToString()

Returns

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

Overrides

System.Object.ToString()

Remarks

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

Operators

| Improve this Doc View Source

Equality(SyndicationResourceSaveSettings, SyndicationResourceSaveSettings)

Determines if operands are equal.

Declaration

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

Parameters

Type	Name	Description
SyndicationResourceSaveSettings	first	Operand to be compared.
SyndicationResourceSaveSettings	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(SyndicationResourceSaveSettings, SyndicationResourceSaveSettings)

Determines if first operand is greater than second operand.

Declaration

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

Parameters

Type	Name	Description
SyndicationResourceSaveSettings	first	Operand to be compared.
SyndicationResourceSaveSettings	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(SyndicationResourceSaveSettings, SyndicationResourceSaveSettings)

Determines if operands are not equal.

Declaration

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

Parameters

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

Returns

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

| Improve this Doc View Source

LessThan(SyndicationResourceSaveSettings, SyndicationResourceSaveSettings)

Determines if first operand is less than second operand.

Declaration

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

Parameters

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