TextDocumentCollection Class

Stores the TextDocuments of the project.

Inheritance Hierarchy

SystemObject
  Altaxo.MainSuspendableDocumentNodeBase
    Altaxo.MainSuspendableDocumentNode
      Altaxo.MainSuspendableDocumentNodeWithSetOfEventArgs
        Altaxo.MainProjectItemCollectionBaseTextDocument
          Altaxo.TextTextDocumentCollection

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

Syntax

Copy

public class TextDocumentCollection : ProjectItemCollectionBase<TextDocument>, 
	IEnumerable<TextDocument>, IEnumerable

The TextDocumentCollection type exposes the following members.

Constructors

	Name	Description
	TextDocumentCollection	Initializes a new instance of the TextDocumentCollection class

Top

Properties

	Name	Description
	AccumulatedEventData	Gets the accumulated event data. (Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	Count	(Inherited from ProjectItemCollectionBaseTItem)
	Debug_AbsolutePath	Gets the absolute path of the node for debugging purposes. (Inherited from SuspendableDocumentNodeBase)
	IsDirty	(Inherited from ProjectItemCollectionBaseTItem)
	IsDisposed	Gets a value indicating whether this instance is disposed. (Inherited from SuspendableDocumentNodeBase)
	IsDisposeInProgress	Gets a value indicating whether for this instance dispose is in progress, or the instance is already disposed. (Inherited from SuspendableDocumentNodeBase)
	IsReadOnly	(Inherited from ProjectItemCollectionBaseTItem)
	IsResumeInProgress	Gets a value indicating whether this instance is currently resuming the events. (Inherited from SuspendableDocumentNode)
	IsSomeoneListeningToChanges	Gets a value indicating whether someone is listening to changes. For this, either the ParentObject or the Changed event must be set. (Inherited from SuspendableDocumentNodeBase)
	IsSuspended	Gets a value indicating whether this instance is suspended. (Inherited from SuspendableDocumentNode)
	IsSuspendedOrResumeInProgress	Gets a value indicating whether this instance is suspended or resume is currently in progress. (Inherited from SuspendableDocumentNode)
	Item	(Inherited from ProjectItemCollectionBaseTItem)
	ItemBaseName	Gets the base name of a project item. The base name will be combined with a number to find a unique name. (Overrides ProjectItemCollectionBaseTItemItemBaseName)
	Name	Gets the name of this document node. Null is returned if the name is not set or unknown. The set accessor will for most nodes throw a InvalidOperationException, since the name can only be set on IProjectItems. (Inherited from SuspendableDocumentNodeBase)
	Names	(Inherited from ProjectItemCollectionBaseTItem)
	ParentObject	Gets/sets the parent object this instance belongs to. (Overrides SuspendableDocumentNodeBaseParentObject)

Top

Methods

	Name	Description
	AccumulateChangeData	(Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	AccumulatedChangeData_SetBackAfterResumeAndSuspend	(Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	AccumulatedEventData_Clear	Clears the accumulated event data. (Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	AccumulatedEventData_HasZeroOrOneEventArg	Determines whether there is no or only one single event arg accumulated. If this is the case, the return value is true. If there is one event arg accumulated, it is returned in the argument singleEventArg. The return value is false if there is more than one event arg accumulated. In this case the singleEventArg is null on return, and the calling function should use AccumulatedEventData to enumerate all accumulated event args. (Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	Add	(Inherited from ProjectItemCollectionBaseTItem)
	ChildCloneFromT	Clones a node that is intended to use as child node of this instance (e.g. in collections). Consider using ChildCloneToMemberT(T, T) instead if the child node is stored in a member of this instance. (Inherited from SuspendableDocumentNode)
	ChildCloneToMemberT	Sets a member variable that holds a child with a cloned instance of another variable. If an old instance member (provided in myChild exists and can not be used, it is disposed first. The node is then cloned using System.ICloneable. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildCloneToMemberAltT	Set a member variable that holds a child node of this instance. The child node may or may not implement IDocumentLeafNode. The value to set may or may not implement ICloneable. If it implements ICloneable, then the member variable is set to a clone of the value. Otherwise, the member variable is set directly with the value. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	ChildCopyToMemberT	Copies a document node from another source into a member of this instance. If an old instance member (provided in myChild exists and can not be used, it is disposed first. The node is then copied using either Main.ICopyFrom or System.ICloneable. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildCopyToMemberOrCreateNewT	Copies a document node from another source into a member of this instance. If an old instance member (provided in myChild exists and can not be used, it is disposed first. If the node is not null, the node is then copied using either Main.ICopyFrom or System.ICloneable. If the node is null, a new node is created using the provided generation function. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship. (Inherited from SuspendableDocumentNode)
	ChildDisposeMemberT	Helper function to dispose a child node of this instance. It helps to ensure the correct order: first, the child node is set to null and only then the child node is disposed. (Inherited from SuspendableDocumentNodeBase)
	ChildSetMemberT	Set a member variable that holds a child node of this instance. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	ChildSetMemberAltT	Set a member variable that holds a child node of this instance. The child node may or may not implement IDocumentLeafNode. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed. (Inherited from SuspendableDocumentNode)
	Clear	(Inherited from ProjectItemCollectionBaseTItem)
	Contains(TItem)	(Inherited from ProjectItemCollectionBaseTItem)
	Contains(String)	Determines whether the collection contains a project item with the specified name and with the type that this collection stores. (Inherited from ProjectItemCollectionBaseTItem)
	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. (Inherited from ProjectItemCollectionBaseTItem)
	CopyTo	(Inherited from ProjectItemCollectionBaseTItem)
	CountEvent	Counts the number of events during the suspend state. Every call to this function will increment the event counter by 1 (but only in the suspended state). The event counter will be reset to zero when the object is resumed. (Inherited from SuspendableDocumentNode)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from SuspendableDocumentNodeBase)
	Dispose(Boolean)	(Inherited from ProjectItemCollectionBaseTItem)
	EhChildChanged	Used by childs of this object to inform us about a change in their state. (Inherited from SuspendableDocumentNode)
	EhParentTunnelingEventHappened	Is called by the parent when a tunneling event happened in the parent. (Inherited from SuspendableDocumentNode)
	EhSelfChanged	Called if some (simple) member or property of this instance itself has changed. (Inherited from SuspendableDocumentNode)
	EhSelfTunnelingEventHappened(TunnelingEventArgs)	Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is additionally distributed to all childs of this instance. (Inherited from SuspendableDocumentNodeBase)
	EhSelfTunnelingEventHappened(TunnelingEventArgs, Boolean)	Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is - depending on the provided parameter - also distributed to all childs of this instance. (Inherited from SuspendableDocumentNode)
	EnumerateFromHereToLeaves	Enumerates all document node including this node, its child nodes, its child-child nodes up to the leaf nodes. (Inherited from SuspendableDocumentNode)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Exchange	Replaces the old item with a new item while keeping the item's index. (Inherited from ProjectItemCollectionBaseTItem)
	Finalize	Finalizes an instance of the SuspendableDocumentNodeBase class. (Inherited from SuspendableDocumentNodeBase)
	FindNewItemName	Looks for the next free standard project item name in the root folder. (Inherited from ProjectItemCollectionBaseTItem)
	FindNewItemName(String)	Looks for the next unique project item name base on a basic name. (Inherited from ProjectItemCollectionBaseTItem)
	FindNewItemNameInFolder	Looks for the next free standard project item name in the specified folder. (Inherited from ProjectItemCollectionBaseTItem)
	GetChildObjectNamed	(Inherited from ProjectItemCollectionBaseTItem)
	GetDocumentNodeChildrenWithName	(Inherited from ProjectItemCollectionBaseTItem)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetNameOfChildObject	(Inherited from ProjectItemCollectionBaseTItem)
	GetParentTextDocumentCollectionOf	Gets the parent NotesDocumentCollection of a child NotesDocument.
	GetSortedItemNames	(Inherited from ProjectItemCollectionBaseTItem)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	HandleHighPriorityChildChangeCases	Handles the case when a child changes, and a reaction is neccessary independently on the suspend state of the table. (Inherited from SuspendableDocumentNode)
	HandleLowPriorityChildChangeCases	Processes the event args e when this object is not suspended. This function serves two purposes: i) updating some cached data of this object by processing the event args of the child, and ii) optional transforming the event args, for instance to a new type, which afterwards is send to the parent and is used as event args in the [E:Changed] event of this object. The transformed event args is not used if this object is suspended (in this case the original event args is used). (Inherited from SuspendableDocumentNode)
	InternalAdd	(Inherited from ProjectItemCollectionBaseTItem)
	InternalClear	(Inherited from ProjectItemCollectionBaseTItem)
	InternalExchange	(Inherited from ProjectItemCollectionBaseTItem)
	InternalRemove	Removes the item from the collection. This function should only work on the internal structures, but do nothing else. (Inherited from ProjectItemCollectionBaseTItem)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	NotifyChildrenTunnelingEventHappened	Notifies the child nodes of this instance that a tunneling event has happened. (Inherited from SuspendableDocumentNode)
	OnAboutToBeResumed	Is called when the suspend level is still 1 (one), but is about to fall to zero, i.e. shortly before the call to OnResume(Int32). This function is not called before OnResumeSilently(Int32)! (Inherited from SuspendableDocumentNode)
	OnChanged	(Inherited from ProjectItemCollectionBaseTItem)
	OnResume	Is called when the object is resumed, i.e. change notifications are allowed again. During the execution of this function, the [P:IsResumeInProgress] property will return true to indicate that the resume is currently in progress. (Inherited from SuspendableDocumentNode)
	OnResumeSilently	Is called when the suspend level falls down from 1 to zero by a call to ResumeSilently. This implementation disarma the suspendTokens of the childs of this object, deletes any accumulated events, and does not send any change event to the parent or the listeners of the Change event. (Inherited from SuspendableDocumentNode)
	OnSuspended	Called when the suspend level has just gone from 0 to 1, i.e. the object was suspended. (Inherited from SuspendableDocumentNode)
	OnTunnelingEvent	Fires the TunneledEvent event. (Inherited from SuspendableDocumentNodeBase)
	Remove(TItem)	Removes the item from the collection and disposes it. Only items that belong to this collection will be removed and disposed. (Inherited from ProjectItemCollectionBaseTItem)
	Remove(String)	Removes the item, referenced by its name, from the collection and disposes it. Only items that belong to this collection will be removed and disposed. (Inherited from ProjectItemCollectionBaseTItem)
	RenameChild	Helper function called by a child of this collection to handle renaming of this child. (Inherited from ProjectItemCollectionBaseTItem)
	Resume(ISuspendToken)	Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. If Event data were accumulated during the suspended state, a changed event is triggered for each event data. (Inherited from SuspendableDocumentNodeBase)
	Resume(ISuspendToken, EventFiring)	Resumes changed events, either with taking the accumulated event data into account (see Resume(ISuspendToken)) or discarding the accumulated event data (see ResumeSilently(ISuspendToken), depending on the provided argument eventFiring. (Inherited from SuspendableDocumentNodeBase)
	ResumeCompleteTemporarily	Resumes the object completely for only a short time. Thus, if object was suspended before, it will be suspended again when the function returns. (Inherited from SuspendableDocumentNode)
	ResumeCompleteTemporarilyGetToken	Resumes the object completely for the time the returned token is referenced and not disposed. The return value is a token that had 'absorbed' the suspend count of the object, resulting in the suspend count of the object dropped to 0 (zero). When the returned token is finally disposed, the suspend count of the object is increased again by the 'absorbed' suspend count. (Inherited from SuspendableDocumentNode)
	ResumeSilently	Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. All event data accumulated during the suspended state are discarded, and thus no change event is triggered even if the instance has changed during the suspended state. (Inherited from SuspendableDocumentNodeBase)
	SetDisposeInProgress	Sets the flag that dispose is in progress for this node and all child nodes recursively. (Inherited from SuspendableDocumentNode)
	SetMemberAndRaiseSelfChangedT(NullableT, NullableT)	Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SetMemberAndRaiseSelfChangedT(T, T)	Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SetMemberEnumAndRaiseSelfChangedT	Sets a member variable (which is an Enum) of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions. (Inherited from SuspendableDocumentNodeBase)
	SuspendGetToken	Suspend will increase the SuspendLevel. (Inherited from SuspendableDocumentNode)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryGetName	Test if this item already has a name. (Inherited from SuspendableDocumentNodeBase)
	TryGetValue	(Inherited from ProjectItemCollectionBaseTItem)
	UnwireItem	(Inherited from ProjectItemCollectionBaseTItem)
	WireItem	(Inherited from ProjectItemCollectionBaseTItem)

Top

Events

	Name	Description
	Changed	Fired when something in the object has changed, and the object is not suspended. (Inherited from SuspendableDocumentNodeBase)
	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. (Inherited from ProjectItemCollectionBaseTItem)
	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 SuspendableDocumentNodeBase)

Top

Fields

	Name	Description
	_accumulatedEventData	The accumulated event data. (Inherited from SuspendableDocumentNodeWithSetOfEventArgs)
	_itemsByName	(Inherited from ProjectItemCollectionBaseTItem)
	_parent	The parent object this instance belongs to. (Inherited from SuspendableDocumentNodeBase)
	_suspendTokensOfChilds	Stores the suspend tokens of the suspended childs of this object. (Inherited from SuspendableDocumentNode)

Top

Extension Methods

	Name	Description
	AreAllNodesFromSameLevelTextDocument	Determines whether all nodes in the provided enumeration have the same level (see LevelT(T) for an explanation of level). (Defined by TreeNodeExtensions)
	FirstOrTextDocument	Returns the first value of the enumeration, or, if the enumeration is empty, the other value provided in the arguments. (Defined by EnumerableExtensions)
	FlattenFromRootToLeavesTextDocument	Converts a recursive data structure into a flat list. The root element is enumerated before its corresponding child element(s). (Defined by EnumerableExtensions)
	ForEachDoTextDocument	Executes an action for each element of the sequence. (Defined by EnumerableExtensions)
	HasSingleElementTextDocument	Determines whether the specified enumeration has exactly one element. (Defined by EnumerableExtensions)
	IndexOfTextDocument	Gets the index of an item in a enumeration or list. (Defined by ListExtensions)
	IndexOfFirstTextDocument	Gets the index the of first item in list that fulfills the predicate predicate (Defined by ListExtensions)
	IndexOfFirstTextDocument	Gets the index the of first item in list that fulfills the predicate predicate (Defined by ListExtensions)
	IndexOfMaxTextDocument	Return the index of the element with the maximum value in an enumerable. If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned. (Defined by EnumerableExtensions)
	IndexOfMinTextDocument	Return the index of the element with the minimum value in an enumerable. If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned. (Defined by EnumerableExtensions)
	IndicesInt32AndValuesWhereTextDocument	Returns tuples of index and element of all elements in an enumeration which fullfill a given condition, given by the element's value. (Defined by EnumerableExtensions)
	IndicesInt32AndValuesWhereTextDocument	Returns tuples of index and element of all elements in an enumeration which fullfill a given condition, given by the element's value and its index. (Defined by EnumerableExtensions)
	IndicesInt32WhereTextDocument	Returns the indices of the elements which fullfill a given condition, given by the element's value. (Defined by EnumerableExtensions)
	IndicesInt32WhereTextDocument	Returns the indices of the elements which fullfill a given condition, given by the element's value and its index. (Defined by EnumerableExtensions)
	IndicesOfMinMaxTextDocument	Return the index of the element with the minimum value in an enumerable. If multiple elements with the same minimal value exist, the index of the first element in the sequence is returned. (Defined by EnumerableExtensions)
	IsEmptyTextDocument	Determines whether the specified enumeration is empty. (Defined by EnumerableExtensions)
	JoinConditionalTextDocument, T2	Takes a join of two sequences, but only takes into account those pair, which fulfill a given condition. (Defined by EnumerableExtensions)
	JoinConditionalTextDocument, T2, TResult	Takes a join of two sequences, but only takes into account those pair, which fulfill a given condition. (Defined by EnumerableExtensions)
	LastOrTextDocument	Returns the last value of the enumeration, or, if the enumeration is empty, the other value provided in the arguments. (Defined by EnumerableExtensions)
	MaxElementTextDocument, M	Gets the element of a IEnumerabe that evaluates by means of a conversion function to the maximal value. This is different from Select(x => conversion(x)).Max() insofar as it not returns the maximum value, but the original element x which converts to the maximum value. (Defined by EnumerableExtensions)
	MaxOrDefaultTextDocument, M	Evaluates the maximum of a enumeration of elements, or returns a default value if the series is empty. (Defined by EnumerableExtensions)
	SelectCombinationTextDocument	Select a random combination, without repetition, from a data sequence by selecting k elements in original order. (Defined by Combinatorics)
	SelectCombinationWithRepetitionTextDocument	Select a random combination, with repetition, from a data sequence by selecting k elements in original order. (Defined by Combinatorics)
	SelectPermutationTextDocument	Select a random permutation from a data sequence by returning the provided data in random order. Implemented using Fisher-Yates Shuffling. (Defined by Combinatorics)
	SelectVariationTextDocument	Select a random variation, without repetition, from a data sequence by randomly selecting k elements in random order. Implemented using partial Fisher-Yates Shuffling. (Defined by Combinatorics)
	SelectVariationWithRepetitionTextDocument	Select a random variation, with repetition, from a data sequence by randomly selecting k elements in random order. (Defined by Combinatorics)
	TakeAllButLastTextDocument	Takes all elements of the enumeration except the last element. (Defined by EnumerableExtensions)
	ThisOrEmptyTextDocument	Returns either the provided enumeration, or if it is null, an empty enumeration. (Defined by EnumerableExtensions)
	TryGetFirstAndLastTextDocument	Returns true and the first and last value of the enumeration, or, if the enumeration is empty, returns false. (Defined by EnumerableExtensions)
	TryGetSingleElementTextDocument	Try to get the one and only element of the collection. (Defined by EnumerableExtensions)

Top

Reference

Altaxo.Text Namespace