Class SavedConnections

Access information about connection preferences that has been persisted to disk

Inheritance
System.Object
SavedConnections
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Innovator.Client
Assembly: Innovator.Client.dll
Syntax
public class SavedConnections : IEnumerable<ConnectionPreferences>, IEnumerable
Examples

Create a new connection using the default stored connection

var pref = SavedConnections.Load().Default;
var conn = Factory.GetConnection(pref);

Constructors

| Improve this Doc View Source

SavedConnections()

Initializes a new instance of the SavedConnections class.

Declaration
public SavedConnections()

Properties

| Improve this Doc View Source

Default

Gets or sets the default preference.

Declaration
public ConnectionPreferences Default { get; set; }
Property Value
Type Description
ConnectionPreferences

The default preference.
| Improve this Doc View Source

Item[String]

Gets or sets the ConnectionPreferences with the specified name.

Declaration
public ConnectionPreferences this[string name] { get; set; }
Parameters
Type Name Description
System.String name

The name.
Property Value
Type Description
ConnectionPreferences

The ConnectionPreferences.
| Improve this Doc View Source

Keys

Gets the names of all applicable preferences.

Declaration
public IEnumerable<string> Keys { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

The names of all applicable preferences.

Methods

| Improve this Doc View Source

Add(ConnectionPreferences)

Adds the specified ConnectionPreferences.

Declaration
public void Add(ConnectionPreferences value)
Parameters
Type Name Description
ConnectionPreferences value

The ConnectionPreferences to store.
| Improve this Doc View Source

CreateReader()

Creates a System.Xml.XmlReader for reading the preference data.

Declaration
public XmlReader CreateReader()
Returns
Type Description
System.Xml.XmlReader

An System.Xml.XmlReader for reading the preference data
| Improve this Doc View Source

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
public IEnumerator<ConnectionPreferences> GetEnumerator()
Returns
Type Description
System.Collections.Generic.IEnumerator<ConnectionPreferences>

A System.Collections.Generic.IEnumerator<T> that can be used to iterate through the collection.
Implements
System.Collections.Generic.IEnumerable<T>.GetEnumerator()
| Improve this Doc View Source

Load(Stream)

Initializes a new SavedConnections instance from the stream data.

Declaration
public static SavedConnections Load(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

The System.IO.Stream to load data from.
Returns
Type Description
SavedConnections

A new SavedConnections instance
| Improve this Doc View Source

Load(TextReader)

Initializes a new SavedConnections instance from the textReader data.

Declaration
public static SavedConnections Load(TextReader textReader)
Parameters
Type Name Description
System.IO.TextReader textReader

The System.IO.TextReader to load data from.
Returns
Type Description
SavedConnections

A new SavedConnections instance
| Improve this Doc View Source

Load(String)

Initializes a new SavedConnections instance from the uri.

Declaration
public static SavedConnections Load(string uri)
Parameters
Type Name Description
System.String uri

The URI to load data from.
Returns
Type Description
SavedConnections

A new SavedConnections instance
| Improve this Doc View Source

Parse(String)

Initializes a new SavedConnections instance from the xml.

Declaration
public static SavedConnections Parse(string xml)
Parameters
Type Name Description
System.String xml

The XML data to parse.
Returns
Type Description
SavedConnections

A new SavedConnections instance
| Improve this Doc View Source

Save(Stream)

Saves the preferences to the specified System.IO.Stream.

Declaration
public void Save(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

The System.IO.Stream to save the preferences to.
| Improve this Doc View Source

Save(TextWriter)

Saves the preferences to the specified System.IO.TextWriter.

Declaration
public void Save(TextWriter textWriter)
Parameters
Type Name Description
System.IO.TextWriter textWriter

The System.IO.TextWriter to save the preferences to.
| Improve this Doc View Source

Save(XmlWriter)

Saves the preferences to the specified System.Xml.XmlWriter.

Declaration
public void Save(XmlWriter writer)
Parameters
Type Name Description
System.Xml.XmlWriter writer

The System.Xml.XmlWriter to save the preferences to.
| Improve this Doc View Source

ToString()

Returns an XML System.String that represents serialized data.

Declaration
public override string ToString()
Returns
Type Description
System.String

A XML System.String that represents serialized data.
Overrides
System.Object.ToString()
| Improve this Doc View Source

TryGetValue(String, out ConnectionPreferences)

Tries the get a ConnectionPreferences by name.

Declaration
public bool TryGetValue(string name, out ConnectionPreferences value)
Parameters
Type Name Description
System.String name

The name of the ConnectionPreferences.
ConnectionPreferences value

The value.
Returns
Type Description
System.Boolean

true if the ConnectionPreferences was found, false otherwise

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
System.Collections.IEnumerator

An System.Collections.IEnumerator object that can be used to iterate through the collection.
Implements
System.Collections.IEnumerable.GetEnumerator()

Extension Methods