DocumentDependencies

References
public sealed class DocumentDependencies
A class for maintaining and harvesting data from document dependencies. For example when this document imports data from another document.

Properties

Document

#
public Document Document { get; }
Gets the document this instance is associated with.

HasDependencies

#
public bool HasDependencies { get; }
Gets whether the document has dependencies on other documents.

Methods

CreateGraph

#
public DependencyGraph CreateGraph(CancellationToken token)
Create a graph of the entire dependency hierarchy starting from this document. This will load but not solve any of the files.
Parameters:
token (CancellationToken)

DataFileSources

#
public static string[] DataFileSources(string file)
Parse a potential file dependency and return an array of strings representing the available data.
Parameters:
file (string)File to parse.
Returns: Array of available data names.

PickDataFile

#
public static string PickDataFile(string title = null, Window parent = null, string initialFolder = null)
Ask the user to pick either a *.ghz or a *.ghdata file.
Parameters:
title (string = null)
parent (Window = null)
initialFolder (string = null)
Returns: Source file or null.

PickSourceFilter

#
public static string PickSourceFilter(string file)
Given a file, ask the user to pick a source filter. Depending on the file format, this may or may not show modal UI on the screen.
Parameters:
file (string)

ResolveDependency

#
public DependencyData ResolveDependency(IDocumentObject origin, Solution solution, string file, string name)
Resolve a specific dependency. If the implicated file hasn't been cached yet, it will be loaded, solved and cached. Hence, this method may take a long time.
Parameters:
origin (IDocumentObject)Object which is the origin of this request.
solution (Solution)
file (string)File dependency.
name (string)Name of data within file to harvest.
Returns: The found resolution.