IProject Interface

Interface to an Altaxo project. A project here is the topmost element of documents and contains all documents.

Namespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)

Syntax

public interface IProject : IDocumentNode, 
	IDocumentLeafNode, INamedObject, IChangedEventSource, ISuspendableByToken, ITunnelingEventSource, 
	IDisposable, ITreeNodeWithParent<IDocumentLeafNode>, ITreeNode<IDocumentLeafNode>, 
	INodeWithParentNode<IDocumentLeafNode>, IChildChangedEventSink, INamedObjectCollection, ICanBeDirty

The IProject type exposes the following members.

Properties

	Name	Description
	ChildNodes	Gets the child nodes. (Inherited from ITreeNodeT)
	Folders	Get information about the folders in this project.
	IsDirty
	IsDisposed	Gets a value indicating whether this instance is disposed. (Inherited from IDocumentLeafNode)
	IsDisposeInProgress	Gets a value indicating whether this instance is dispose in progress, or the instance is already disposed. (Inherited from IDocumentLeafNode)
	IsSuspended	Gets a value indicating whether this instance is suspended. (Inherited from ISuspendableByToken)
	Name	Gets the name of this instance. An InvalidOperationException will be thrown if the name is not yet set or can not be retrieved. (Inherited from INamedObject)
	ParentNode	Gets the parent node of this node. (Inherited from INodeWithParentNodeT)
	ParentObject	Retrieves the parent object. (Inherited from IDocumentLeafNode)
	ProjectFolderProperties	The properties associated with the project folders. Please note that the properties of the project are also stored inside this collection, with the name being an empty string (root folder node).
	ProjectItemCollections	Enumerates the collections of all project items.
	ProjectItemTypes	Gets the types of project items currently supported in the project.

Top

Methods

	Name	Description
	AddItem	Adds the provided project item to the Altaxo project, for instance a table or a graph, to the project. For ProjectFolderPropertyDocuments, if a document with the same name is already present, the properties are merged.
	AddItemWithThisOrModifiedName	Adds the provided project item to the Altaxo project, for instance a table or a graph, to the project. If another project item with the same name already exists, a new unique name for the item is found, based on the given name. For ProjectFolderPropertyDocuments, if a document with the same name is already present, the properties are merged.
	ClearIsDirty	Clears the IsDirty flag in a more advanced manner, supporting the needs for late loading of data etc. It should update the data needed for deferred data loading before clearing the flag.
	ContainsItem	Tests if the project item given in the argument is already contained in this document.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable)
	EhChildChanged	This function is used by the childs of an object to signal an parent object that they have changed. If the function returns true, the child have to suspend it's change notifications (if this is supported by the child). (Inherited from IChildChangedEventSink)
	EhParentTunnelingEventHappened	(Inherited from IDocumentLeafNode)
	GetChildObjectNamed	retrieves the object with the name C# Copy name . (Inherited from INamedObjectCollection)
	GetCollectionForProjectItemType	Gets the collection for a certain project item type.
	GetDocumentPathForProjectItem	Gets the document path for project item, using its type and name. It is not neccessary that the item is part of the project yet.
	GetNameOfChildObject	Retrieves the name of the provided object. (Inherited from INamedObjectCollection)
	GetRootPathForProjectItemType	Gets the root path for a given project item type.
	RemoveItem	Removes the provided project item to the Altaxo project, for instance a table or a graph, to the project.
	SetDisposeInProgress	Sets the flag that dispose is in progress for this node and all child nodes recursively. (Inherited from IDocumentLeafNode)
	SuspendGetToken	Suspends the event handling of the object by getting a suspend token. The event handling of the object is resumed when the suspend token is disposed. (Inherited from ISuspendableByToken)
	TryGetExistingItemWithSameTypeAndName	Tries to get an existing project item with the same type and name as the provided item.
	TryGetName	Test if this item already has a name. (Inherited from INamedObject)

Top

Events

	Name	Description
	Changed	Fired when something in the object has changed. (Inherited from IChangedEventSource)
	IsDirtyChanged	Is called when the content is changed after a save/load operation and this signals that changes could be saved. (Inherited from ICanBeDirty)
	TunneledEvent	The event that is fired when the object is disposed. First argument is the sender, second argument is the original source, and third argument is the event arg. (Inherited from ITunnelingEventSource)

Top

Extension Methods

	Name	Description
	GetPropertyContext	Gets the property context of the document node. If the provided node is not implementing IPropertyBagOwner, the parent nodes of this node are searched, until a node which implements IPropertyBagOwner is found. (Defined by PropertyExtensions)

Top

Reference

Altaxo.Main Namespace