`SolutionConfiguration`

A solution configuration.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Add new standard configuration

standardConfiguration = project.Contents.SolutionConfigurations:AddStandardConfiguration()

    -- Move the new standard configuration above the default standard configuration

project.Contents.SolutionConfigurations:MoveUp(standardConfiguration)

Inheritance

The SolutionConfiguration object is derived from the Object object.

The following objects are derived (specialisations) from the SolutionConfiguration object:

Usage locations

The SolutionConfiguration object can be accessed from the following locations:

Methods
- SolutionConfigurationCollection collection has method Item(number).
- SolutionConfigurationCollection collection has method Item(string).

Property List

Frequency: The configuration solution frequency. (Read only Frequency)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Collection List

Loads: The collection of loads in the configuration. (LoadCollection of Load.)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Frequency

The configuration solution frequency.

Type: Frequency
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Collection Details

Loads

The collection of loads in the configuration.

Type: LoadCollection

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.