Class: Table

Defines a Table.

Implemented types

Methods

Name Description
Activate() Activate the current object.
Add(IDataSeries) Add a new column to the data table.
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
AddImage(String) Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window.
Clear() Drops all columns from the data table.
Contains(String) Returns whether the data table contains a column with the specified name.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Duplicate() Creates a copy of the current DataModelObject.
GetDataURI() Gets the data URI from which the tabular data was imported.
GetImportSettings() Get the settings used for an import operation. `null` will be returned if an import operation has not yet been performed.
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GetRow(Int32)
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
Import(String, ImportFormat, ImportSettingsBase) Import data from the provided resource into the table as specified by and . All existing data will be overwritten upon import. If “settings” is `None` then the default settings class, as provided by ImportSettingsHelper.GetSettingsForFormat(), will be used. All imported data in textual/string format will depend on the .NET `double.TryParse()` method to convert items into a suitable value for variable storage in the table. An “undefined” value (as specified in the `IDataTable` API spec) will be used if a suitable double representation cannot be parsed.
Insert(Int32, IDataSeries) Insert a column at the specified index.
PropertyByAPIName(String) Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned.
PropertyByName(String) Get a property by its unique name.
Remove(Object) Removes the specified column. If is an , it will be interpreted as an index. If is a , it will be interpreted as a column name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
TryInsertRow(Int32, IEnumerable) Try to insert the values at the specified row index.
TryRemoveRow(Int32) Try to remove the specified row.

Properties

Name Description
ColumnNames
Columns Explicitly get or set the columns of the data table.
Comments Gets the list of associated comments.
Count Gets the number of columns in the table.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
Figures Gets the list of associated figures.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
IsFixedColumnCount Get whether additional columns can be added or removed from the contained .
IsFixedRowCount Get whether additional rows can be added or removed from the contained .
IsReadOnly Gets whether the data table is read-only.
Item
Metadata Gets or set a dictionary with additional information that may be useful to understanding the context of data in the table.
Name Gets the name of the object.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
Parent Gets the parent object.
Properties Gets the list of properties for this object.
RowCount
VisibleProperties Gets the list of properties that are visible for this object.