Skip to main content

Motion Standalone Preprocessor C# library 2024 R2

Class ProjectDocument

Last update: 16.07.2025

Namespace: VM.Models
Assembly: VM.Models.Project.dll

public sealed class ProjectDocument : ProjectObjectBase, IObservableObject, IProjectDocument, IProjectObject, IHasID, IHasName, IDisposableObject

Inheritance

object ← ObservableObject ← ProjectObjectBase ← ProjectDocument

Implements

IObservableObject, IProjectDocument, IProjectObject, IHasID, IHasName, IDisposableObject

Inherited Members

ProjectObjectBase.OnDeserialization(object), ProjectObjectBase.DisplayName, ProjectObjectBase.ID, ProjectObjectBase.Name, ObservableObject.Dispose(), ObservableObject.RaisePropertyChanged(string), ObservableObject.RaisePropertyChanged(string, object, object), ObservableObject.IsDisposed, ObservableObject.TryDisposing, ObservableObject.Disposed, ObservableObject.Disposing, ObservableObject.PropertyChanged

Extension Methods

LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)

Constructors

ProjectDocument(string)

public ProjectDocument(string name)

Parameters

name string

Properties

ID

public override Identifier ID { get; }

Property Value

Identifier

Items

public IEnumerable<IScenario> Items { get; }

Property Value

IEnumerable<IScenario>

RootPath

[Browsable(false)]
public string RootPath { get; set; }

Property Value

string

ScenarioCount

[Browsable(false)]
public int ScenarioCount { get; }

Property Value

int

this[Identifier]

public IScenario this[Identifier identifier] { get; }

Property Value

IScenario

this[int]

public IScenario this[int index] { get; }

Property Value

IScenario

this[string]

public IScenario this[string name] { get; }

Property Value

IScenario

Methods

Add(IScenario)

public void Add(IScenario item)

Parameters

item IScenario

CanRegisterID(Identifier)

public bool CanRegisterID(Identifier identifier)

Parameters

identifier Identifier

Returns

bool

CanRegisterName(string)

public bool CanRegisterName(string name)

Parameters

name string

Returns

bool

Contains(IScenario)

public bool Contains(IScenario item)

Parameters

item IScenario

Returns

bool

ContainsID(Identifier)

public bool ContainsID(Identifier identifier)

Parameters

identifier Identifier

Returns

bool

ContainsName(IProjectObject)

public bool ContainsName(IProjectObject item)

Parameters

item IProjectObject

Returns

bool

DisposeManagedResources()

protected override void DisposeManagedResources()

Open(string)

public static ProjectDocument Open(string path)

Parameters

path string

Returns

ProjectDocument

Remove(IScenario)

public void Remove(IScenario item)

Parameters

item IScenario

Save()

public void Save()

TryGetValue(Identifier, out IScenario)

public bool TryGetValue(Identifier identifier, out IScenario scenario)

Parameters

identifier Identifier

scenario IScenario

Returns

bool

TryGetValue(string, out IScenario)

public bool TryGetValue(string name, out IScenario scenario)

Parameters

name string

scenario IScenario

Returns

bool

UnregisterID(IProjectObject)

public void UnregisterID(IProjectObject item)

Parameters

item IProjectObject

UnregisterName(IProjectObject)

public void UnregisterName(IProjectObject item)

Parameters

item IProjectObject

Connect with Ansys