Data |
The DataTable type exposes the following members.
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) |
 | AppendAllColumnsWithSpace | Appends data columns from DataTable src to the data in this table leaving some rows free inbetween. |
| AppendAllDataColumns | Appends data columns from DataTable src to the data in this table. |
| AppendAllDataColumnsToPosition | Appends data columns from DataTable src to the data in this table by copying the new data to a specified row. |
| ChangeColumnPosition | Moves the selected columns along with their corresponding property values to a new position. |
| 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) |
| Clone | Clones the table. |
| ContainsColumn | Tests if the table contains a data column with the provided name. |
| ContainsDataColumn | Tests if the table contains a data column with the provided name. |
| ContainsPropertyColumn | Tests if the table contains a property column with the provided name. |
| CopyDataAndPropertyColumnsFrom(DataTable) | Deletes all data and property columns in the table, and then copy all data and property columns from the source table. |
| CopyDataAndPropertyColumnsFrom(DataTable, Boolean, Boolean) | Deletes all data and property columns in the table, and then copy all data and property columns, from the source table. As you can specify, this can be done with or without the data. |
| CopyDataColumnsFrom | Deletes all data columns in the table, and then copy all data columns from the source table. |
| CopyOrReplaceOrAdd | Copies data to the data column with the provided index if both columns are of the same type. If they are not of the same type, the column is replaced by the provided column. If the index is beyoind the limit, the provided column is added. |
| 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 SuspendableDocumentNode) |
| 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) |
| Finalize |
Finalizes an instance of the SuspendableDocumentNodeBase class.
(Inherited from SuspendableDocumentNodeBase) |
| GetChildObjectNamed |
Retrieves the child node of this instance with the name C# name (Inherited from SuspendableDocumentNode) |
| GetDocumentNodeChildrenWithName | (Overrides SuspendableDocumentNodeGetDocumentNodeChildrenWithName) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetNameOfChildObject |
Gets the name of child node.
(Inherited from SuspendableDocumentNode) |
 | GetParentDataTableOf(DataColumn) | Gets the parent data table of the DataColumn column. |
| GetParentDataTableOf(DataColumnCollection) | Get the parent data table of a DataColumnCollection. |
| GetParentDataTableOf(IDocumentLeafNode) | Gets the parent data table of a child object. |
| GetTableProperty | Gets an arbitrary object that was stored as table property by SetTableProperty(String, Object). |
| 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) |
| 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 | (Overrides SuspendableDocumentNodeOnAboutToBeResumed(Int32)) |
| OnChanged |
Fires the change event with the EventArgs provided in the argument.
(Overrides SuspendableDocumentNodeBaseOnChanged(EventArgs)) |
| OnNameChanged | Fires both a Changed and a TunnelingEvent when the name has changed. The event arg of the Changed event is an instance of NamedObjectCollectionChangedEventArgs. The event arg of the Tunneling event is an instance of DocumentPathChangedEventArgs. |
| 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) |
| RemoveColumns(IAscendingIntegerCollection) | Remove the selected data columns and the corresponding property rows. |
| RemoveColumns(Int32, Int32) | Remove the data columns and the corresponding property rows beginning at index nFirstColumn. |
| RemoveTableProperty | Remove a table property, key is a string |
| 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) |
| SetTableProperty | The table properties, key is a string, val is a object you want to store here. |
| SuspendGetToken |
Suspend will increase the SuspendLevel.
(Inherited from SuspendableDocumentNode) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetName |
Tests if this item already has a name.
(Overrides SuspendableDocumentNodeBaseTryGetName(String)) |
| UpdateTableFromTableDataSource | Updates the data in the table from the table data source. If the options specify that the worksheet script should be exectuted after this, it is executed then. The table is locked during the operation, and the exceptions will be catched. Use the return result to see if an error has occured. |
| UpdateTableFromTableDataSourceAsUserCancellable | Updates the data in the table from the table data source. If the options specify that the worksheet script should be exectuted after this, it is executed then. The table is locked during the operation, and the exceptions will be catched. Use the return result to see if an error has occured. |
| VisitDocumentReferences | Has to enumerate all references to other items in the project (DocNodeProxy) which are used in this project item and in all childs of this project item. The references has to be reported to the ProxyProcessing function. This function is responsible for processing of the proxies, for instance to relocated the path. |
Extension Methods| Name | Description | |
|---|---|---|
 | AddDataColumnsWithPropertiesFrom |
Adds to the destination table selected columns from another table. Additionally, the properties of those columns will be added to the destination table.
(Defined by MergeTables) |
| AddStandardColumns | (Defined by DataTableCommands) |
| ChangeRowsToPropertyColumns |
Copies selected rows into newly created property columns and deletes the rows afterwards.
(Defined by RowCommands) |
| CreateHistogramOnColumns |
Calculates statistics of selected columns. Returns a new table where the statistical data will be written to.
(Defined by HistogramCreation) |
| DoMakeActionWithoutDialog |
Creates a matrix from three selected columns. This must be a x-column, a y-column, and a value column.
(Defined by ConvertXYVToMatrixActions) |
| DoStatisticsOnColumns |
Calculates statistics of selected columns. Returns a new table where the statistical data will be written to.
(Defined by Statistics) |
| DoStatisticsOnRows |
Calculates statistics of selected columns. Creates a new table where the statistical data will be written to.
(Defined by Statistics) |
| GetProjectFolderPropertyDocuments |
Gets the project folder property documents down the project folder hierarchie.
(Defined by PropertyExtensions) |
| GetPropertyBags |
Gets the property bags in the hierarchy. The first bag in the enumeration is the bag that owns the owner. Then the bags of the folders
in which the owner is located, its parent folders, and then UserSettings, ApplicationSettings, and BuiltinSettings follow.
(Defined by PropertyExtensions) |
| 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) |
| GetPropertyHierarchy |
Gets the property bags in the hierarchal order. The first bag in the enumeration is the bag that owns the owner. Then the bags of the folders
in which the owner is located, its parent folders, and then UserSettings, ApplicationSettings, and BuiltinSettings follow.
(Defined by PropertyExtensions) |
| GetPropertyValueT |
Gets the property value. The property is searched in the provided owner, then in the containing folder, and then the hierarchy down to the built-in property bag.
(Defined by PropertyExtensions) |
| GetPropertyValueT |
Gets the property value. The property is searched in the provided owner, then in the containing folder, and then the hierarchy down to the built-in property bag.
(Defined by PropertyExtensions) |
| ImportAscii |
Imports Ascii data from a stream into the data table.
(Defined by FileCommands) |
| ImportAsciiToSingleWorksheetHorizontally |
Imports multiple Ascii files into a single data table, horizontally, i.e. in subsequent columns.
(Defined by FileCommands) |
| ImportAsciiToSingleWorksheetVertically |
Imports multiple Ascii files into a single data table, vertically, i.e. in subsequent rows.
(Defined by FileCommands) |
| ImportFromAsciiFile |
Imports from an ASCII file into an existing table.
(Defined by AsciiImporter) |
| ImportFromAsciiFile |
Imports from an ASCII file into an existing table. The import options have to be known already.
(Defined by AsciiImporter) |
| ImportFromAsciiFile |
Imports from an ASCII file into an existing table.
(Defined by AsciiImporter) |
| ImportFromAsciiStream |
Imports Ascii data from a stream into the data table.
(Defined by AsciiImporter) |
| ImportFromAsciiStream |
Imports an Ascii stream into a table. The import options have to be known already.
(Defined by AsciiImporter) |
| ImportFromAsciiStream |
Imports Ascii data from a stream into the data table.
(Defined by AsciiImporter) |
| ImportFromAsciiText |
Imports from an ASCII text provided as string into an existing table.
(Defined by AsciiImporter) |
| ImportFromAsciiText |
Imports from an ASCII text provided as string into an existing table. The import options have to be known already.
(Defined by AsciiImporter) |
| ImportFromAsciiText |
Imports from an ASCII text provided as string into an existing table.
(Defined by AsciiImporter) |
| MergeTable |
Merges two tables by fractional index.
(Defined by MergeTables) |
| MergeTable |
Merges two tables by corresponding x-columns.
(Defined by MergeTables) |
| SetColumnGroupNumber | (Defined by ColumnCommands) |
| ShowActionDialog | (Defined by ConvertXYVToMatrixActions) |
| ShowDecomposeByColumnContentDialog | (Defined by DecomposeByColumnContentActions) |
| ShowExpandCyclingVariableColumnDialog | (Defined by ExpandCyclingVariableColumnActions) |
| ShowExportAsciiDialog |
Asks for a file name and exports the table data into that file as Ascii.
(Defined by FileCommands) |
| ShowExportGalacticSPCDialog |
Shows the dialog for Galactic SPC file export, and exports the data of the table using the options provided in that dialog.
(Defined by FileCommands) |
| ShowImportAsciiDialog |
Asks for file name(s) and imports the file(s) into multiple worksheets.
(Defined by FileCommands) |
| ShowImportAsciiDialog |
Asks for file name(s) and imports the file(s) into one or multiple worksheets.
(Defined by FileCommands) |
| ShowImportAsciiDialogAndOptions |
Asks for file name(s) and imports the file(s) into multiple worksheets.
(Defined by FileCommands) |
| ShowImportAsciiDialogAndOptions |
Asks for file name(s) and imports the file(s) into one or multiple worksheets. After the user chooses one or multiple files, one of the chosen files is used for analysis.
The result of the structure analysis of this file is then presented to the user. The user may change some of the options and starts a re-analysis. Finally, the import options
are confirmed by the user and the import process can start.
(Defined by FileCommands) |
| ShowImportDatabaseDialog | (Defined by DatabaseCommands) |
| ShowImportGalacticSPCDialog |
Asks for file names, and imports one or more Galactic SPC files into a single data table.
(Defined by FileCommands) |
| ShowImportImageDialog |
Asks for a file name of an image file, and imports the image data into a data table.
(Defined by FileCommands) |
| ShowImportJcampDialog |
Asks for file names, and imports one or more Jcamp files into a single data table.
(Defined by FileCommands) |
| ShowImportRenishawWdfDialog |
Asks for file names, and imports one or more Renishaw .wdf files (Raman spectroscopy) into a single data table.
(Defined by FileCommands) |
| ShowPropertyDialog |
Shows the property dialog for this data table.
(Defined by WorksheetCommands) |
| ShowRenameDialog |
Shows a dialog to rename the table.
(Defined by DataTableOtherActions) |
| ShowSetColumnGroupNumberDialog |
Sets the group number of the selected column
(Defined by ColumnCommands) |
| SortDataColumnsByPropertyColumn |
Sort the order of the data columns (not rows!) of a table based on a specified property column. The relationship of property data to data columns is maintained.
(Defined by Sorting) |
| SortDataColumnsByPropertyColumn |
Sort the order of the data columns (not rows!) of a table based on a specified property column. The relationship of property data to data columns is maintained.
(Defined by Sorting) |
| SortDataRows |
Sorts the data rows of a table (more accurate: of all columns belonging to a column group, see below), using the data of column col to determine the order.
(Defined by Sorting) |
| SortDataRows |
Sorts the data rows of a table (more accurate: of all columns belonging to a column group, see below), using multiple specified column.
(Defined by Sorting) |
| Transpose |
Transpose transpose the table, i.e. exchange columns and rows
this can only work if all columns in the table are of the same type
(Defined by Transposing) |
| TransposeIsPossible |
Tests if the transpose of a table is possible.
(Defined by Transposing) |
| TryImportFromMultipleAsciiFilesHorizontally |
Imports multiple Ascii files into the provided table in horizontal order, i.e. in new columns. The provided importOptions are used to import the files.
The first column of each file is considered to be the x-column, and if they match another x-column, the newly imported columns will get the same column group.
(Defined by AsciiImporter) |
| TryImportFromMultipleAsciiFilesHorizontally |
Imports multiple Ascii files into the provided table in horizontal order, i.e. in new columns. The import options are determined from the first file, and then used to import all other files.
The first column of each file is considered to be the x-column, and if they match another x-column, the newly imported columns will get the same column group.
(Defined by AsciiImporter) |
| TryImportFromMultipleAsciiFilesHorizontally |
Imports multiple Ascii files into the provided table in horizontal order, i.e. in new columns. Depending on the value of determineImportOptionsSeparatelyForEachFile, the import options are either deterimined from the first file and then used for all other files, or determined separately for each file.
The first column of each file is considered to be the x-column, and if they match another x-column, the newly imported columns will get the same column group.
(Defined by AsciiImporter) |
| TryImportFromMultipleAsciiFilesVertically |
Imports multiple Ascii files into the provided table in vertical order, i.e. in new rows. The provided importOptions are used to import the files.
If the names of the subsequently imported table columns match, the data will be written in the matching column. Otherwise new columns with the unmatched column names were created.
Property columns will only be imported from the first table.
(Defined by AsciiImporter) |
| TryImportFromMultipleAsciiFilesVertically |
Imports multiple Ascii files into the provided table in vertical order, i.e. in new rows.. The import options are determined from the first file, and then used to import all other files.
If the names of the subsequently imported table columns match, the data will be written in the matching column. Otherwise new columns with the unmatched column names were created.
Property columns will only be imported from the first table.
(Defined by AsciiImporter) |
| TryImportFromMultipleAsciiFilesVertically |
Imports multiple Ascii files into the provided table in vertical order, i.e. in new rows.. Depending on the value of determineImportOptionsSeparatelyForEachFile, the import options are either deterimined from the first file and then used for all other files, or determined separately for each file.
If the names of the subsequently imported table columns match, the data will be written in the matching column. Otherwise new columns with the unmatched column names were created.
Property columns will only be imported from the first table.
(Defined by AsciiImporter) |
See Also