IProjectItemCollection Interface

Interface that all collections that store Altaxo project items must support.

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

Syntax

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

The IProjectItemCollection type exposes the following members.

Properties

	Name	Description
	ChildNodes	Gets the child nodes. (Inherited from ITreeNodeT)
	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)
	Item	Gets the IProjectItem with the specified project item name.
	ItemBaseName	Gets the base name of a project item. The base name will be combined with a number to find a unique name.
	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)
	ProjectItems	Enumerates all project items in the collection.

Top

Methods

	Name	Description
	Add	Adds the specified project item to the collection.
	Contains	Determines whether the collection contains a project item with the specified name and with the type that this collection stores.
	ContainsAnyName	Determines whether the collection contains any project item with the specified name. This must not neccessarily a item of the type that this collection stores (some collections can have a shared name dictionary). In constrast, use Contains(String) to determine if the collection contains an item with the specified name and the native type that the collection stores.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable)
	EhChild_CanBeRenamed	Determines whether the name of the child item can be changed to the provided new name. If the parent implementing this interface is not able to change the child's name, it must return false. (Inherited from IParentOfINameOwnerChildNodes)
	EhChild_HasBeenRenamed	Called if the child has been renamed. (Inherited from IParentOfINameOwnerChildNodes)
	EhChild_ParentChanged	Called if the child's parent changed. (Inherited from IParentOfINameOwnerChildNodes)
	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)
	FindNewItemName	Looks for the next free standard project item name in the root folder.
	FindNewItemName(String)	Looks for the next unique project item name base on a basic name.
	FindNewItemNameInFolder	Looks for the next free standard project item name in the specified folder.
	GetChildObjectNamed	retrieves the object with the name C# Copy name . (Inherited from INamedObjectCollection)
	GetNameOfChildObject	Retrieves the name of the provided object. (Inherited from INamedObjectCollection)
	Remove(IProjectItem)	Removes the specified project item.
	Remove(String)	Removes the project item with the specified name.
	RenameChild	Helper function called by a child of this collection to handle renaming of this child. (Inherited from IParentOfINameOwnerChildNodes)
	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)
	TryGetName	Test if this item already has a name. (Inherited from INamedObject)
	TryGetValue	Try to get a project item by name

Top

Events

	Name	Description
	Changed	Fired when something in the object has changed. (Inherited from IChangedEventSource)
	CollectionChanged	Fired when one or more project items are added, deleted or renamed. Not fired when content in the project item has changed. Arguments are the type of change, the item that changed, the old name (if renamed), and the new name (if renamed). This event can not be suspended.
	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