GraphPathSerializationDictionary Class

Article
07/26/2013

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

The CommonPaths lets you remap certain attribute values in the DGML.

For example, it is nice to have a file path be relative to the solution so the file can be found when that solution is moved. To solve this you can define a path called "SolutionDir" with the value of the full path. Then the GraphSerializer will substitute this path wherever it is found in the DGML with the syntax "$(name)" where name is the Id of the path you provided and it will write out the definition of the paths that are used in a Paths block at the end of the file. When this DGML document is loaded the paths will be substituted with the values in the current CommonPaths and then all the variable references will be expanded with these new values.

So a solution folder on your computer might be on drive C someplace, and on drive D on another computer and everything will still just work as expected.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.GraphModel.GraphPathSerializationDictionary

Namespace: Microsoft.VisualStudio.GraphModel
Assembly: Microsoft.VisualStudio.GraphModel (in Microsoft.VisualStudio.GraphModel.dll)

Syntax

'Declaration
Public Class GraphPathSerializationDictionary _
    Implements IDictionary(Of String, String),  _
    ICollection(Of KeyValuePair(Of String, String)), IEnumerable(Of KeyValuePair(Of String, String)),  _
    IEnumerable

public class GraphPathSerializationDictionary : IDictionary<string, string>, 
    ICollection<KeyValuePair<string, string>>, IEnumerable<KeyValuePair<string, string>>, 
    IEnumerable

public ref class GraphPathSerializationDictionary : IDictionary<String^, String^>, 
    ICollection<KeyValuePair<String^, String^>>, IEnumerable<KeyValuePair<String^, String^>>, 
    IEnumerable

type GraphPathSerializationDictionary =  
    class 
        interface IDictionary<string, string>
        interface ICollection<KeyValuePair<string, string>>
        interface IEnumerable<KeyValuePair<string, string>>
        interface IEnumerable 
    end

public class GraphPathSerializationDictionary implements IDictionary<String, String>, ICollection<KeyValuePair<String, String>>, IEnumerable<KeyValuePair<String, String>>, IEnumerable

The GraphPathSerializationDictionary type exposes the following members.

Constructors

	Name	Description
	GraphPathSerializationDictionary()	Create empty list of common paths.
	GraphPathSerializationDictionary(GraphPathSerializationDictionary)	Create a copy of the CommonPaths from another object.

Top

Properties

	Name	Description
	Count	Get the number of paths in the collection
	IsReadOnly	Gets a value indicating whether the System.Collections.Generic.ICollection is read-only.
	Item	Gets or sets the element that has the specified key.
	Keys	Gets an System.Collections.Generic.ICollection that contains the keys of the System.Collections.Generic.IDictionary.
	Names	Return a snapshot of the current path names
	Values	Gets an System.Collections.Generic.ICollection that contains the values of the System.Collections.Generic.IDictionary.

Top

Methods

	Name	Description
	Add(KeyValuePair<String, String>)	Add a path with the given name and value. An empty path is ignored. Trailing slash is removed.
	Add(String, String)	Add a path with the given name and value. An empty path is ignored. Trailing slash is removed.
	AddDefaultPaths	Add the default paths that we can find using the current process Environment.
	Clear	Removes all items from the System.Collections.Generic.ICollection.
	Contains	Determines if the given link is in this collection.
	ContainsKey	Determines whether the System.Collections.Generic.IDictionary contains an element that has the specified key.
	CopyTo	Copies the elements of the System.Collections.Generic.ICollection to an System.Array, starting at a particular System.Array index.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetPath	Get the value of the path with the given name.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LookupName	Find the name of the path with the specified value
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove(KeyValuePair<String, String>)	Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection.
	Remove(String)	Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Gets the value associated with the specified key.

Top

Events

	Name	Description
	CommonPathsAdded	This event can be used to insert custom common paths after AddCommonPaths is called.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerable.GetEnumerator	Returns an enumerator that iterates through the collection.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via