Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/13382 findtextblocks datatypes docs #74

Merged
merged 12 commits into from
Nov 8, 2023
Merged

Feature/13382 findtextblocks datatypes docs #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9b32ca4
Text property type changed to input
cortex-av Nov 8, 2023
4950ef5
occurrence default value change
cortex-av Nov 8, 2023
8e3324d
match datatype + external links
cortex-av Nov 8, 2023
23091de
correct default values
cortex-av Nov 8, 2023
d36e4e7
group added, match typos + links fixed
cortex-av Nov 8, 2023
91959bc
rewrite properties to better fit code XML docs
cortex-av Nov 8, 2023
183c1e8
typo
cortex-av Nov 8, 2023
313e8a5
typos
cortex-av Nov 8, 2023
b9ea1e5
capture details, fix links
cortex-av Nov 8, 2023
8f5cc15
missing link
cortex-av Nov 8, 2023
8fdac44
remove WIP image
cortex-av Nov 8, 2023
c0c4d29
correct property default values to match elsewhere
cortex-av Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/2023.11/Reference/Blocks/Text/find-text/find-all-text-block.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ The [Text][Text Property] to find all occurrences of [Text To Find][TextToFind P
| | |
|--------------------|---------------------------|
| Data Type | [String][] |
| Property Type | [InputOutput][] |
| Property Type | [Input][] |
| Is [Advanced][] | `false` |
| Default Editor | [Variable][] |
| Default Value | `($)Text` with no value |
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/2023.11/Reference/Blocks/Text/find-text/find-text-block.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ The [Text][Text Property] to find the specified occurrence of [Text To Find][Tex
| | |
|--------------------|---------------------------|
| Data Type | [String][] |
| Property Type | [InputOutput][] |
| Property Type | [Input][] |
| Is [Advanced][] | `false` |
| Default Editor | [Variable][] |
| Default Value | `($)Text` with no value |
Expand Down Expand Up @@ -475,7 +475,7 @@ For information about [supported values][Occurrences] for the [Occurrence][Occur
| Property Type | [Input][] |
| Is [Advanced][] | `false` |
| Default Editor | [Literal][] |
| Default Value | `0` |
| Default Value | `1` |


### Search Options
Expand Down
87 changes: 84 additions & 3 deletions content/en/docs/2023.11/Reference/data-types/text/regex/capturedetails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,111 @@ description: "Used to represent a single capture for a given group"

<p class="namespace">(Cortex.DataTypes.Text.Regex.CaptureDetails)</p>

{{< workinprogress >}}

## Summary

The `CaptureDetails` data type is used to represent a single capture for a given [Group][].

| | |
|-|-|
| **Category:** | Regex |
| **Name:** | `CaptureDetails` |
| **Full Name:** | `Cortex.DataTypes.Text.Regex.CaptureDetails` |
| **Alias:** | N/A |
| **Description:** | A single capture for a given group. |
| **Default Value:** | null |
| **Can be used as:** | `CaptureDetails`, `Object`, `dynamic` |
| **Can be cast to:** | N/A |

## Properties

### Value

The value of this capture.

| | |
|--------------------|---------------------------|
| Data Type | [String][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [String][] with no value |

### Index

### Value
The starting index of this capture in the input text.

| | |
|--------------------|---------------------------|
| Data Type | [Int32][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [Int32][] with value `0` |

### Length

The length of the capture.

| | |
|--------------------|---------------------------|
| Data Type | [Int32][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [Int32][] with value `0` |

## Remarks

### Create a CaptureDetails

The following table shows some of the ways that a `CaptureDetails` can be created.

| Method | Example | Result | Editor&nbsp;Support | Notes |
|-|-|-|-|-|
| Construct `CaptureDetails` | `new CaptureDetails{Value = "", Index = 0, Length = 0}` | `{"Value": "","Index": 0,"Length": 0}` | Expression | No proper constructor exists for this data type. |

### Convert a Group to Text

| Method | Example | Result | Editor&nbsp;Support | Notes |
|-|-|-|-|-|
| Use `Convert Object to Json` block | where `Object` property has a value of `{"Value": "","Index": 0,"Length": 0}` | `"{\r\n \"Value\": \"\",\r\n \"Index\": 0,\r\n \"Length\": 0\r\n}"` | N/A | See [Convert Object to Json][] |

### Property Editor Support

- The Expression Editor is available for [Input][] properties where the data type is `CaptureDetails`.
- The Literal Editor is available for [Input][] properties where the data type is `CaptureDetails`.
- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `CaptureDetails`.

### Known Limitations

None

## See Also

### Related Data Types

* [Group][]
* [Int32][]
* [String][]

### Related Concepts

* [Working with Text][]

### External Documentation

* [System.Text.RegularExpressions.Capture][]

[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}
[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}}
[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}}
[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}}
[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}}

[System.Text.RegularExpressions.Capture]: {{< url path="MSDocs.DotNet.Api.System.Text.RegularExpressions.Capture" >}}

[Group]: {{<url path="Cortex.Reference.DataTypes.Text.Regex.Group.MainDoc">}}
[Int32]: {{<url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc">}}
[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}

[Convert Object To Json]: {{< url path="Cortex.Reference.Blocks.Json.ConvertJson.ConvertObjectToJson.MainDoc" >}}

[Working with Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}}
98 changes: 96 additions & 2 deletions content/en/docs/2023.11/Reference/data-types/text/regex/group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,126 @@ description: "Used to represent a regex match group. It contains all of the capt

<p class="namespace">(Cortex.DataTypes.Text.Regex.Group)</p>

{{< workinprogress >}}

## Summary

The `Group` data type is used to represent a [regex match][Match] group. It contains all of the [Captures][CaptureDetails] for a given group pattern.

| | |
|-|-|
| **Category:** | Regex |
| **Name:** | `Group` |
| **Full Name:** | `Cortex.DataTypes.Text.Regex.Group` |
| **Alias:** | N/A |
| **Description:** | A regex match group. |
| **Default Value:** | null |
| **Can be used as:** | `Group`, `Object`, `dynamic` |
| **Can be cast to:** | N/A |

## Properties

### Value

The Value is the value of the last [capture][CaptureDetails] for this group.

| | |
|--------------------|---------------------------|
| Data Type | [String][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [String][] with no value. |

### Index

The starting index of the first [capture][CaptureDetails] for this group in the input text.

| | |
|--------------------|---------------------------|
| Data Type | [Int32][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [Int32][] with value `0` |

### Length

The length of the matched group text.

| | |
|--------------------|---------------------------|
| Data Type | [Int32][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [Int32][] with value `0` |

### Captures

The list of [captures][CaptureDetails] found for this regex match group. If there were no captures, this is an empty list.

| | |
|--------------------|---------------------------|
| Data Type | IReadOnlyList<[CaptureDetails][]> |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | IReadOnlyList<[CaptureDetails][]> with no value |

## Remarks

### Create a Group

The following table shows some of the ways that a `Group` can be created.

| Method | Example | Result | Editor&nbsp;Support | Notes |
|-|-|-|-|-|
| Construct `Group` | `new Group{Value = "", Index = 0, Length = 0, Captures = new List<CaptureDetails>()}` | `{"Value": "","Index": 0,"Length": 0,"Captures": []}` | Expression | No proper constructor exists for this data type. |

### Convert a Group to Text

| Method | Example | Result | Editor&nbsp;Support | Notes |
|-|-|-|-|-|
| Use `Convert Object to Json` block | where `Object` property has a value of `{"Value": "","Index": 0,"Length": 0,"Captures": []}` | `"{\r\n \"Value\": \"\",\r\n \"Index\": 0,\r\n \"Length\": 0,\r\n \"Captures\": []\r\n}"` | N/A | See [Convert Object to Json][] |

### Property Editor Support

- The Expression Editor is available for [Input][] properties where the data type is `Group`.
- The Literal Editor is available for [Input][] properties where the data type is `Group`.
- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Group`.

### Known Limitations

None

## See Also

### Related Data Types

* [CaptureDetails][]
* IReadOnlyList
* [Int32][]
* [Match][]
* [String][]

### Related Concepts

* [Working with Text][]

### External Documentation

* [System.Text.RegularExpressions.Group][]

[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}
[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}}
[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}}
[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}}
[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}}

[System.Text.RegularExpressions.Group]: {{< url path="MSDocs.DotNet.Api.System.Text.RegularExpressions.Group" >}}

[CaptureDetails]: {{<url path="Cortex.Reference.DataTypes.Text.Regex.CaptureDetails.MainDoc">}}
[Dictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.Dictionary.MainDoc">}}
[Int32]: {{<url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc">}}
[Match]: {{<url path="Cortex.Reference.DataTypes.Text.Regex.Match.MainDoc">}}
[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}

[Convert Object To Json]: {{< url path="Cortex.Reference.Blocks.Json.ConvertJson.ConvertObjectToJson.MainDoc" >}}

[Working with Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}}
98 changes: 96 additions & 2 deletions content/en/docs/2023.11/Reference/data-types/text/regex/match.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,126 @@ description: "Used to represent a regex match. It contains all of the groups fou

<p class="namespace">(Cortex.DataTypes.Text.Regex.Match)</p>

{{< workinprogress >}}

## Summary

The `Match` data type is used to represent a regex match. It contains all of the [Groups][Group] found in the regex pattern.

| | |
|-|-|
| **Category:** | Regex |
| **Name:** | `Match` |
| **Full Name:** | `Cortex.DataTypes.Text.Regex.Match` |
| **Alias:** | N/A |
| **Description:** | A regex match. |
| **Default Value:** | null |
| **Can be used as:** | `Match`, `Object`, `dynamic` |
| **Can be cast to:** | N/A |

## Properties

### Value

The value of the full match.

| | |
|--------------------|---------------------------|
| Data Type | [String][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [String][] with no value |

### Index

The starting index of the regex match in the input text.

| | |
|--------------------|---------------------------|
| Data Type | [Int32][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [Int32][] with value `0` |

### Length

The length of this regex match.

| | |
|--------------------|---------------------------|
| Data Type | [Int32][] |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [Int32][] with value `0` |

### Groups

The dictionary of [Groups][Group] in this match. The key [String][] is the [Group][] name. The default group `0` is always included for a valid match, and contains the whole [Value][Value Property] as its value. Unnamed groups will have keys starting from `"1"`, `"2"`, etc.

| | |
|--------------------|---------------------------|
| Data Type | [Dictionary][]<[String][], [Group][]> |
| Is [Advanced][] | `false` |
| Default Editor | [Expression][] |
| Default Value | [Dictionary][]<[String][], [Group][]> with value `{}` |

## Remarks

### Create a Match

The following table shows some of the ways that a `Match` can be created.

| Method | Example | Result | Editor&nbsp;Support | Notes |
|-|-|-|-|-|
| Construct `Match` | `new Match{Value = "", Index = 0, Length = 0, Groups = {}}` | `{"Value": "","Index": 0,"Length": 0,"Groups": {}}` | Expression | |

### Convert Match to Text

| Method | Example | Result | Editor&nbsp;Support | Notes |
|-|-|-|-|-|
| Use `Convert Object to Json` block | where `Object` property has a value of `{"Value": "","Index": 0,"Length": 0,"Groups": {}}` | `"{\r\n \"Value\": \"\",\r\n \"Index\": 0,\r\n \"Length\": 0,\r\n \"Groups\": {}\r\n}"` | N/A | See [Convert Object to Json][] |

### Property Editor Support

- The Expression Editor is available for [Input][] properties where the data type is `Match`.
- The Literal Editor is available for [Input][] properties where the data type is `Match`.
- The Variable Editor is available for [Input][], [InputOutput][] and [Output][] properties where the data type is `Match`.

### Known Limitations

None

## See Also

### Related Data Types

* [Dictionary][]
* [Group][]
* [Int32][]
* [String][]

### Related Concepts

* [Working with Text][]

### External Documentation

* [System.Text.RegularExpressions.Match][]

[Value Property]: {{<ref "#value">}}

[Input]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Input" >}}
[Output]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.Output" >}}
[InputOutput]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.WhatIsABlockProperty.InputOutput" >}}
[Expression]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.ExpressionEditor.MainDoc" >}}
[Literal]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.PropertyEditors.LiteralEditor.MainDoc" >}}
[Advanced]: {{< url path="Cortex.Reference.Concepts.Fundamentals.Blocks.BlockProperties.AdvancedProperties.MainDoc" >}}

[System.Text.RegularExpressions.Match]: {{< url path="MSDocs.DotNet.Api.System.Text.RegularExpressions.Match" >}}

[Dictionary]: {{<url path="Cortex.Reference.DataTypes.Collections.Dictionary.MainDoc">}}
[Int32]: {{<url path="Cortex.Reference.DataTypes.Numbers.Int32.MainDoc">}}
[String]: {{< url path="Cortex.Reference.DataTypes.Text.String.MainDoc" >}}
[Group]: {{<url path="Cortex.Reference.DataTypes.Text.Regex.Group.MainDoc">}}

[Convert Object To Json]: {{< url path="Cortex.Reference.Blocks.Json.ConvertJson.ConvertObjectToJson.MainDoc" >}}

[Working with Text]: {{< url path="Cortex.Reference.Concepts.WorkingWith.Text.MainDoc" >}}
Loading
Loading