The Datasheet Element
An element representing a tabular data set within a Datafeed.
Attributes and Elements
Attributes
Attribute | Description | Required |
---|---|---|
name | The name of the Datasheet | Yes |
displayName | An description for the Datasheet | No |
className | An .Net class name for the Datasheet | No |
classAssembly | An .Net class assembly for the Datasheet | No |
isSingleRow | Indicates that the Datasheet can never contain more than one row | No |
valueMember | If a Datasheet is Project Scoped, it can act as a validation source for columns in other Project or Scenario scoped Datasheets. The valueMember column is normally the Primary Key column for the Datasheet. | No |
displayMember | If a datasheet has a valueMember column then it must also have a displayMember column containing strings that correspond to the ID values in the valueMember column. | No |
defaultRecords | A Datasheet can have any number of default records automatically added to it when it is created for a Library, Project, or Scenario. Within the defaultRecords element you can define as many record child elements as you require. Each record element must specify columns and their corresponding values. Multiple column/value pairs can be separated by the pipe ("|"") character. | No |
filterColumns | A datasheet can specify any number of columns to be "filter" columns using this attribute. Column names must be separated by the pipe character. If a datasheet has filter columns, the default multi-row view will show menus and other controls to let you sort and filter by these columns. | No |
noRowLimit | Indicates that a multi-row datasheet should not have row limits. If a row limit exists, the datasheet will initially load only the number of rows specified by the system row limit value. Datasheets with very large, rarely edited datasets often benefit from this feature, so row limits are applied by default. However, certain datasheets cannot function with a row limit and so this attribute can be used to disable them for a specific datasheet. | No |
shortName | Excel worksheet names must have 31 characters or fewer so SyncroSim truncates datasheet names with more than 31 characters when exporting to Excel. The truncated names are often not desirable, however, and so an alternate short name can be specified with this attribute. | No |
spatialMultiprocessing | When multi-processing in a non-standard way (e.g. using a tiling raster), the resulting tabular and raster data can be duplicated across iterations. Set this attribute to True to indicate that SyncroSim should sum the duplicated data. | No |
sumColumnNames | If a datasheet that supports spatial multi-processing contains tabular data, you must indicate the name of the column to "sum" when resolving data that has been duplicated across iterations. | No |
filter | This attribute will cause the default multi-row datafeed view to filter a datasheet's records based on the specified .Net DataTable filter criteria. | No |
Important
The value for the name attribute must contain only alpha-numeric characters.
Child Elements
Element |
---|
columns |
defaultRecords |
Parent Elements
Element |
---|
datasheets |
Remarks
If you specify a className then instances of that .Net class will be created as necessary. In this case, the classAssembly must also be specified and the class must derive from SyncroSim.Core.DataSheet.