Project |
The ProjectFolders type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AccumulateChangeData | (Inherited from SuspendableDocumentLeafNodeWithSetOfEventArgs) |
| AccumulatedChangeData_SetBackAfterResumeAndSuspend | (Inherited from SuspendableDocumentLeafNodeWithSetOfEventArgs) |
| AccumulatedEventData_Clear |
Clears the accumulated event data.
(Inherited from SuspendableDocumentLeafNodeWithSetOfEventArgs) |
| 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 SuspendableDocumentLeafNodeWithSetOfEventArgs) |
  | AddFolderNodeRecursively(String, DictionaryString, NGTreeNode) | Add a NGTreeNodes corresponding to the folder name recursively for all parts of the folder name so that a hierarchy of those nodes is built-up. If the folder name is already represented by a tree node (i.e. is present in the folderDictionary), this node is returned. If not, the node is created and added to the folder dictionary as well as to the nodes collection of the parent tree node. If the parent tree node is not found in the folderDictionary, this function is called recursively to add the parent tree node. |
| AddFolderNodeRecursivelyT(String, DictionaryString, NGTreeNode) | Add a NGTreeNodes corresponding to the folder name recursively for all parts of the folder name so that a hierarchy of those nodes is built-up. If the folder name is already represented by a tree node (i.e. is present in the folderDictionary), this node is returned. If not, the node is created and added to the folder dictionary as well as to the nodes collection of the parent tree node. If the parent tree node is not found in the folderDictionary, this function is called recursively to add the parent tree node. |
| AddItemsAndSubFoldersInFolder | Add the project items and the subfolders (of type ProjectFolder) that are in the provided folder (but not the items of the subfolders) to the list. |
| AddItemsInFolder | Add the items of the provided folder (but not of the subfolders) to the list. |
| AddItemsInFolderAndSubfolders(String, ICollectionIProjectItem) | Add the items of the provided folder and of the subfolders to the list. |
| AddItemsInFolderAndSubfolders(String, ICollectionIProjectItem, Boolean) | Add the items of the provided folder and of the subfolders to the list. |
| AddItemsInSubfolders | Add the items of the subfolders of the provided folder to the list. The items in the provided folder itself are not added to the list. |
| CanRenameFolder | Determines if a folder can be renamed. |
| 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) |
| ContainsFolder | Determines if a given folder name is present. |
| CopyItemsFromFolderToFolder | Copies project items from a source folder to a destination folder. |
| CopyItemsToFolder | Copies the items given in the list (tables, graphs and folders) to another folder, which is given by newFolderName. The copying is done by cloning the items. |
| CopyItemToFolder | Copyies one item to another folder by cloning the item. |
| DeleteDocuments(IEnumerableIProjectItem) | Delete the items given in the list (tables and graphs), with a confirmation dialog. |
| DeleteDocuments(IEnumerableIProjectItem, Boolean) | Delete the items given in the list (tables and graphs), with a confirmation dialog. |
| DeleteFolder | Deletes the folder, that means, this operation deletes the project items in the given folder and in all subfolders. |
| DeleteItemsInFolder | Deletes all project items in a folder. |
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from SuspendableDocumentNodeBase) |
| Dispose(Boolean) | (Overrides SuspendableDocumentNodeBaseDispose(Boolean)) |
| EhParentTunnelingEventHappened |
Is called by the parent when a tunneling event happened into the parent.
(Inherited from SuspendableDocumentNodeBase) |
| EhSelfChanged |
Called if some member of this instance itself has changed.
(Inherited from SuspendableDocumentLeafNode) |
| 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 SuspendableDocumentNodeBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Finalizes an instance of the SuspendableDocumentNodeBase class.
(Inherited from SuspendableDocumentNodeBase) |
| GetExpandedProjectItemSet | Transforms an enumeration that contains both project items and project folders to another set that contains the project items of the enumeration plus all project items in the project folders and its subfolders. It is guaranteed that each project item is contained only once. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetItemsAndSubfoldersInFolder | Get the items and the subfolders (as objects of type ProjectFolder) of the provided folder. The items in the subfolders are not included. |
| GetItemsInFolder | Get the items (but not the subfolders) of the provided folder. |
| GetItemsInFolderAndSubfolders | Get the items (but not the subfolders) of the provided folder. |
| GetItemsInSubfolders | Get the items (but not the subfolders) of the subfolders of the provided folder. Note that the items contained in the provided folder are not included. |
| GetSubfoldersAsDisplayFolderNameStringListSorted | Get a list of subfolders of the provided folder (as string list). |
| GetSubfoldersAsProjectFolderList | Get a list of subfolders of the provided folder (as ProjectFolder list). |
| GetSubfoldersAsStringList | Get a list of subfolders of the provided folder (as string list). |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HandleLowPriorityChildChangeCases |
Handles the cases when a child changes, but a reaction is neccessary only if the table is not suspended currently.
(Inherited from SuspendableDocumentLeafNode) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MoveItemsFromFolderToFolder | Moves project items from a source folder to a destination folder. |
| MoveItemsToFolder | Move items in a list to another folder. |
| MoveItemsToNewFolder | Move the provided items from the old folder to a new folder. This is done by renaming all items in the given list by starting with the new folder name. |
| 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. This function is not called before OnResumeSilently!
(Inherited from SuspendableDocumentLeafNode) |
| OnChanged | (Overrides SuspendableDocumentNodeBaseOnChanged(EventArgs)) |
| OnCollectionChanged | |
| OnResume |
Is called when the suspend level falls down from 1 to zero by a call to Resume or a call to [M:Altaxo.Main.ISuspendToken.Dispose()].
(Inherited from SuspendableDocumentLeafNode) |
| OnResumeSilently |
Is called when the suspend level falls down from 1 to zero by a call to ResumeSilently.
The implementation should delete any accumulated events, should also disarm the suspendTokens of the childs of this object, and should not fire any Changed events nor set the change state of the object to dirty.
(Inherited from SuspendableDocumentLeafNode) |
| OnSuspended |
Called when the suspend level has just gone from 0 to 1, i.e. the object was suspended.
(Inherited from SuspendableDocumentLeafNode) |
| OnTunnelingEvent |
Fires the TunneledEvent event.
(Inherited from SuspendableDocumentNodeBase) |
| RenameFolder | Rename a folder to a new name. This is done by renaming all items contained in the folder and its subfolders to a new name starting with the new folder name. |
| 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 SuspendableDocumentLeafNode) |
| 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 SuspendableDocumentLeafNode) |
| 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 SuspendableDocumentNodeBase) |
| 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) |
| ShowFolderRenameDialog(ProjectFolder) | Shows a dialog to rename a folder. Note that if the root folder is specified, the function returns without showing a dialog. |
| ShowFolderRenameDialog(String) | Shows a dialog to rename a folder. Note that if the root folder is specified, the function returns without showing a dialog. |
| SortItemsByDependencies | Sorts the project items by dependencies. On return, the item with which has no dependencies is located at the beginning of the list. The item with the most dependencies on other items in the list is the last item in the list. |
| SuspendGetToken |
Suspend will increase the SuspendLevel.
(Inherited from SuspendableDocumentLeafNode) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetName |
Test if this item already has a name.
(Inherited from SuspendableDocumentNodeBase) |
See Also