Description of properties used in *.cshtml templates
This section contains a detailed description of the properties and data types used in *.cshtml templates to create reports and documentation.
1. ProjectInfo type
This type describes general project data, such as its components, tags, resources, etc.
| Property | Type | Description |
|---|---|---|
| ArgumentCount | int | Total number of arguments |
| Assets | HashSet<string> | Total list of resources |
| ComponentCount | int | Total number of components |
| Descr | string | Project description from the Itp file |
| GitRepo | string | Path to the GIT repository |
| GroupUsage | Dictionary<string, int> | Groups of elements (name, quantity) |
| HtmlKeywords | string | Keywords for the page metadata |
| Libraries | HashSet<string> | Total list of libraries |
| Name | string | Project name from the Itp file |
| ProcessCount | int | Total number of processes |
| Queues | HashSet<string> | Total list of queues |
| Tags | HashSet<string> | Total list of tags (tags.csv) |
| Toc | List<ToCItem> | Table of Contents — list of project elements |
| VariableCount | int | Total number of variables |
2. ProcessInfo type
This type describes information about each process, including variables, components, arguments, and other process-specific properties.
| Property | Type | Description |
|---|---|---|
| Activities | List<ActivityInfo> | List of top-level process elements |
| Arguments | List<ScriptVariable> | Arguments |
| ArgumentsGroups | List<string> | List of argument groups |
| Assets | HashSet<string> | Resources |
| BackPath | string | Relative path from the process folder to the project folder (”../..”) |
| Components | List<SerializationComponent> | Top-level process components |
| Description | string | Project description from the Itw file |
| GetTotalActivitiesCount | int | Get the total number of elements |
| GlobalVariables | List<ScriptVariable> | Variables |
| GlobalVariablesGroups | List<string> | List of variable groups |
| HtmlKeywords | string | Keywords for the report |
| DefaultValue | string | Default value |
| DefaultValueText | string | Default value in text format |
| ToHtml() | string | String description of the variable for insertion into HTML |
| IsGlobal | bool | Global variable flag |
| Comment | string | Comment |
| DataTypeString | string | Variable type in string format |
| Direction | string | Purpose |
| subsheetid | string | Identifier on the sheet |
| IsCode | bool | Field computability flag |
| Language | string | Language |
| Name | string | Property name |
| Value | string | Property value |
| ValueText | string | Property value in text format |
| HasChildren | bool | Presence of nested elements (There are records in the Activities property) |
| Header | string | Element header |
| HtmlBorderColor | string | Color of the element borders in the report. Depends on the element type |
| IsFirstLevel | bool | Root level element flag |
| Link | string | Link to a separate file describing the element |
| Num | int | Serial number in the list of activities |
| PngFile | string | Path to the screenshot file displayed in the element |
| Props | List<ActivityProp> | Element properties |
| ShortClass | string | Short name of the element type |
| BlockCatch | ActivityInfo | BlockCatch element and activities within it |
| BlockElse | ActivityInfo | BlockElse element and activities within it |
| BlockFinally | ActivityInfo | BlockFinally element and activities within it |
| BlockThen | ActivityInfo | BlockThen element and activities within it |
| BlockTry | ActivityInfo | BlockTry element and activities within it |
| Descr | string | Element description |
| Guid | string | Element identifier |
3. SerializationComponent type
The SerializationComponent type describes process components, including name, assembly version, and component properties.
| Property | Type | Description |
|---|---|---|
| AssemblyName | string | Assembly name and version |
| ClassName | string | Component class name |
| ClassRu | string | Class name for documentation from elements.csv |
| Components | Components | Child components |
| NextElements | HashSet<string> | List of identifiers of subsequent components executing after the current component |
| Properties | Properties | Component properties |
4. Components type
The Components type is used to store a list of process components.
| Property | Type | Description |
|---|---|---|
| SerializationComponent | List<SerializationComponent> | List of components |
5. Properties type
The Properties type describes component properties and includes a list of SerializationItem elements.
| Property | Type | Description |
|---|---|---|
| SerializationItem | List<SerializationItem> | List of properties |
6. SerializationItem type
The SerializationItem type describes serialization elements, their values, and text representation.
| Property | Type | Description |
|---|---|---|
| IsListValue | string | Flag indicating the presence of multiple values “false” or “true” |
| ListValue | List<SerializationItem> | List of values |
| Name | string | Element name |
| Value | Value | Element value |
| ValueText | string | Text value of the element |
7. ActivityInfo type
The ActivityInfo type describes nested activity elements, their identifiers, properties, and other characteristics.
| Property | Type | Description |
|---|
8. ActivityProp type
The ActivityProp type describes activity properties, such as name, language, and text value.
| Property | Type | Description |
|---|---|---|
| IsListValue | string | Flag indicating the presence of multiple values “false” or “true” |
| ListValue | List<SerializationItem> | List of values |
| Name | string | Element name |
| Value | Value | Element value |
| ValueText | string | Text value of the element |
Last updated on