-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improved some more data types documentation
- Loading branch information
Showing
41 changed files
with
1,382 additions
and
189 deletions.
There are no files selected for viewing
63 changes: 61 additions & 2 deletions
63
content/en/docs/2024.1/Reference/data-types/collections/ireadonlylist-1.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,66 @@ | ||
| --- | ||
| title: "IReadOnlyList<TItem>" | ||
| linkTitle: "IReadOnlyList<TItem>" | ||
| description: "" | ||
| description: "Any data type representing a list of items that can iterated or looped over, where the number and order of items is read-only. `TItem` indicates the data type of the items contained in the list. Each `TItem` can be individually accessed by an index." | ||
| --- | ||
| # {{% param title %}} | ||
|
|
||
| {{<workinprogress>}} | ||
| <p class="namespace">(System.Collections.Generic.IReadOnlyList<TItem>)</p> | ||
|
|
||
| ## Summary | ||
|
|
||
| Any data type representing a list of items that can iterated or looped over, where the number and order of items is read-only. | ||
|
|
||
| `TItem` indicates the data type of the items contained in the list. Each `TItem` can be individually accessed by an index. | ||
|
|
||
| | | | | ||
| |-|-| | ||
| | **Category:** | Collections | | ||
| | **Name:** | `IReadOnlyList<TItem>` | | ||
| | **Full Name:** | `System.Collections.Generic.IReadOnlyList<TItem>` | | ||
| | **Alias:** | N/A | | ||
| | **Description:** | Any data type representing a list of items that can iterated or looped over, where the number and order of items is read-only. `TItem` indicates the data type of the items contained in the list. Each `TItem` can be individually accessed by an index. | | ||
| | **Default Value:** | `null` | | ||
| | **Can be used as:** | `IReadOnlyList<TItem>`, `IReadOnlyCollection<TItem>`, `IEnumerable<TItem>`, `IEnumerable`, `Object`, `dynamic` | | ||
| | | `IEnumerable<TItemBaseType>` (e.g. where `IReadOnlyList<TItem>` is `IReadOnlyList<Int32>` and `IEnumerable<TItemBaseType>` is `IEnumerable<Object>` as `Object` is a base type of `Int32`; this is called covariance) | | ||
| | **Can be cast to:** | N/A | | ||
|
|
||
| ### Property Editor Support | ||
|
|
||
| * The Expression Editor is available for [Input][] properties where the data type is `IReadOnlyList<TItem>`. | ||
| * The Literal Editor is not available for [Input][] properties where the data type is `IReadOnlyList<TItem>`. | ||
| * The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `IReadOnlyList<TItem>`. | ||
|
|
||
| ### Known Limitations | ||
|
|
||
| None | ||
|
|
||
| ## See Also | ||
|
|
||
| ### Related Data Types | ||
|
|
||
| * [IEnumerable][] | ||
| * [IEnumerable<TItem>][] | ||
| * [List<TItem>][] | ||
|
|
||
| ### Related Concepts | ||
|
|
||
| * [Working with Collections][] | ||
|
|
||
| ### External Documentation | ||
|
|
||
| * [System.Collections.Generic.IReadOnlyList<TItem>][] | ||
| * [System.Collections.Generic.IReadOnlyCollection<TItem>][] | ||
|
|
||
| [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} | ||
| [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} | ||
| [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} | ||
|
|
||
| [System.Collections.Generic.IReadOnlyList<TItem>]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.IReadOnlyList" >}} | ||
| [System.Collections.Generic.IReadOnlyCollection<TItem>]: {{< url path="MSDocs.DotNet.Api.System.Collections.Generic.IReadOnlyCollection" >}} | ||
|
|
||
| [IEnumerable]: {{< url path="Cortex.Reference.DataTypes.Collections.IEnumerable.MainDoc" >}} | ||
| [IEnumerable<TItem>]: {{< url path="Cortex.Reference.DataTypes.Collections.IEnumerable_TItem.MainDoc" >}} | ||
| [List<TItem>]: {{< url path="Cortex.Reference.DataTypes.Collections.List.MainDoc" >}} | ||
|
|
||
| [Working with Collections]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Collections.MainDoc" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 34 additions & 5 deletions
39
content/en/docs/2024.1/Reference/data-types/exceptions/exception.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,60 @@ | ||
| --- | ||
| title: "Exception" | ||
| linkTitle: "Exception" | ||
| description: "The data type that all exceptions inherit from." | ||
| description: "Any data type used to represent an exception." | ||
| --- | ||
|
|
||
| # {{% param title %}} | ||
|
|
||
| <p class="namespace">(System.Exception)</p> | ||
|
|
||
| {{< workinprogress >}} | ||
| {{% alert type="information" title="Information" %}} Improvements to this page are planned for the future. {{% /alert %}} | ||
|
|
||
| ## Summary | ||
|
|
||
| ## Remarks | ||
| Any data type used to represent an exception. | ||
|
|
||
| ### Create an Exception | ||
| | | | | ||
| |-|-| | ||
| | **Category:** | Exception | | ||
| | **Name:** | `Exception` | | ||
| | **Full Name:** | `System.Exception` | | ||
| | **Alias:** | N/A | | ||
| | **Description:** | Any data type used to represent an exception. | | ||
| | **Default Value:** | `null` | | ||
| | **Can be used as:** | `Exception`, `object`, `dynamic` | | ||
| | **Can be cast to:** | N/A | | ||
|
|
||
| ### Convert Exception to Text | ||
| ## Remarks | ||
|
|
||
| ### Property Editor Support | ||
|
|
||
| - The Expression Editor is available for [Input][] properties where the data type is `Exception`. | ||
| - The Literal Editor is available for [Input][] properties where the data type is `Exception`. | ||
| - The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Exception`. | ||
|
|
||
| ### Known Limitations | ||
|
|
||
| None | ||
|
|
||
| ## See Also | ||
|
|
||
| ### Related Data Types | ||
|
|
||
| None | ||
|
|
||
| ### Related Concepts | ||
|
|
||
| - [Exceptions][] | ||
|
|
||
| ### External Documentation | ||
|
|
||
| - [System.Exception] | ||
|
|
||
| [Exceptions]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Exceptions.MainDoc" >}} | ||
|
|
||
| [Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}} | ||
| [InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}} | ||
| [Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}} | ||
|
|
||
| [System.Exception]: {{< url path="MSDocs.DotNet.Api.System.Exception" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.