Difference between revisions of "ExtensionsPlus.CorePlus.ListIndexOf"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category:CorePlus]] | + | {{DISPLAYTITLE:'''ListIndexOf '''}}[[Category:CorePlus]] |
== Classification == | == Classification == | ||
| − | {{ClassificationActivity | ListIndexOf | Returns the index of an item | [[Term]] | [[CorePlus|OTX CorePlus Extension]] | - | [[InvalidReferenceException]]<br/>[[TypeMismatchException]] | - | StandardCompliant=No}} | + | {{ClassificationActivity | ListIndexOf | Returns the index of an item | [[Term]] | [[ExtensionsPlus.CorePlus|OTX CorePlus Extension]] | - | [[Core.Actions.Throw.Exception.InvalidReferenceException|InvalidReferenceException]]<br/>[[Core.Actions.Throw.Exception.TypeMismatchException|TypeMismatchException]] | - | StandardCompliant=No}} |
== Description == | == Description == | ||
The '''ListIndexOf''' term searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element, if found; otherwise, –1. | The '''ListIndexOf''' term searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element, if found; otherwise, –1. | ||
| − | {{TermReturnValue|[[Integer]]|The index of an item}} | + | {{TermReturnValue|[[Core.DataTypes.SimpleDataType.Integer|Integer]]|The index of an item}} |
== Properties == | == Properties == | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{TableRowPropertie1| List | [[List]] | [[Term]] | - | [1] | List that will be searched.}} | + | {{TableRowPropertie1| List | [[Core.DataTypes.ComplexDataType.ContainerDataType.List|List]] | [[Term]] | - | [1] | List that will be searched.}} |
{{TableRowPropertie2| Item | - | [[Term]] | - | [1] | The object to locate in the List. The data type of the value shall be matched with the datatype of the list.}} | {{TableRowPropertie2| Item | - | [[Term]] | - | [1] | The object to locate in the List. The data type of the value shall be matched with the datatype of the list.}} | ||
| − | {{TableRowPropertie1| Index | [[Integer]] | [[Term]] | - | [1] | The zero-based starting index of the search. 0 (zero) is valid in an empty list. Default value is 0 (zero).}} | + | {{TableRowPropertie1| Index | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | The zero-based starting index of the search. 0 (zero) is valid in an empty list. Default value is 0 (zero).}} |
|} | |} | ||
== See also == | == See also == | ||
| − | [[TermIsEmpty]] | + | [[ExtensionsPlus.CorePlus.TermIsEmpty|TermIsEmpty]] |
Latest revision as of 09:37, 16 February 2016
Classification
| Name | ListIndexOf |
| Short Description | Returns the index of an item |
| Class | Term |
| Extension | OTX CorePlus Extension |
| Group | - |
| Exceptions | InvalidReferenceException TypeMismatchException |
| Checker Rules | - |
| Standard Compliant | No |
Description
The ListIndexOf term searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element, if found; otherwise, –1.
Return Value
The Term returns the value, see table below.
In OTX, Terms are categorized according to its return data type!
| Data Type | Description |
| Integer | The index of an item |
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| List | List | Term | - | [1] | List that will be searched. |
| Item | - | Term | - | [1] | The object to locate in the List. The data type of the value shall be matched with the datatype of the list. |
| Index | Integer | Term | - | [1] | The zero-based starting index of the search. 0 (zero) is valid in an empty list. Default value is 0 (zero). |
