# CurrentsCollection

A collection of solution currents for this solution configuration.

## Example

app = cf.GetApplication()
project = app:NewProject()

-- Add a currents request to the currents collection

currentsCollection = project.SolutionConfigurations[1].Currents

-- Remove the currents request from the currents collection

currentsCollection:Item(currentsRequest.Label):Delete()

## Usage locations (collections)

The following objects contain the CurrentsCollection collection:

## Property List

Count
The number of Currents items in the collection. (Read only number)
Type
The object type string. (Read only string)

## Method List

Request a currents calculation. (Returns a Currents object.)
Create a currents calculation using the table of properties. (Returns a Currents object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the Currents at the given index. (Returns a Currents object.)
Item (label string)
Returns the Currents with the given label. (Returns a Currents object.)
Items ()
Returns a table of Currents. (Returns a List of Currents object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

## Index List

[number]
Returns the Currents at the given index in the collection. (Read Currents)
[string]
Returns the Currents with the given name in the collection. (Read Currents)

## Property Details

Count
The number of Currents items in the collection.
Type
number
Access
Type
The object type string.
Type
string
Access

## Method Details

Request a currents calculation.
Return
Currents
The currents request.
Create a currents calculation using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
Currents
The currents request.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the Currents.
Return
boolean
The success of the check.
Item (index number)
Returns the Currents at the given index.
Input Parameters
index(number)
The index of the Currents.
Return
Currents
The Currents at the given index.
Item (label string)
Returns the Currents with the given label.
Input Parameters
label(string)
The label of the Currents.
Return
Currents
The Currents with the given label.
Items ()
Returns a table of Currents.
Return
List of Currents
A table of Currents.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for Currents.