ScopeSettings
Limits the field calculation to only use the sources on the specified elements.
Example
application = cf.Application.GetInstance() project = application:NewProject() farFieldRequest = project.Contents.SolutionConfigurations[1].FarFields:Add(0,0,90,180,30,60) -- Get the 'ScopeSettings' of the farFiledRequest scopeSettings = farFieldRequest.ScopeSettings -- Get the CalculationScope of the farField, should be All calculationScope = scopeSettings.CalculationScope
Inheritance
The ScopeSettings object is derived from the CompositeValue object.
Usage locations
The ScopeSettings object can be accessed from the following locations:
- Properties
- FarField object has property ScopeSettings.
- NearField object has property ScopeSettings.
- Methods
- ScopeSettingsList object has method Append().
- ScopeSettingsList object has method Get(number).
Property List
- CalculationScope
- Control which type of elements should be considered for the field calculation. (Read/Write FieldCalculationScopeTypeEnum)
- ScopedEntities
- he field calculation will only use sources on the specified entities. (Read/Write ObjectReferenceList)
Property Details
- CalculationScope
- Control which type of elements should be considered for the field calculation.
- Type
- FieldCalculationScopeTypeEnum
- Access
- Read/Write
- ScopedEntities
- he field calculation will only use sources on the specified entities.
- Type
- ObjectReferenceList
- Access
- Read/Write