• Home
  • User Guide
  • Automation
  • API
  • Calculation
  • Validation
  • Contact Us
Search Results for

    Show / Hide Table of Contents
    • Scripting
      • AcWiring
      • AddableCollection<T>
      • AddCentralInverterAndAssignStringsParameters
      • Angle
      • AngularModelEnum
      • AnnualEnergyYieldResults
      • AreaLimitation
      • AreaLimitationType
      • Azimuth
      • AzimuthVsAltitude
      • BackgroundImage
      • BuildingBoundaryType
      • BuildingRegion
      • CalculationSettings
      • CellTempModelParameters
      • CentralInverterLocationParameters
      • CircumsolarType
      • Climate
      • ComponentLibrary
      • ComponentStatistic
      • CustomDateTimeTrackerPositionAlgorithmBase
      • DiffuseMultipliers
      • DiffuseShadingScheme
      • DiffuseTranspositionModel
      • DigitalTerrainResultsSummary
      • DiodeModel
      • DisabledModels
      • DistanceType
      • DistributionType
      • Domain
      • Efficiency
      • EfficiencyBase
      • EfficiencyCurve
      • EfficiencyCurveType
      • ElectricalLimitation
      • ElectricalLimitationType
      • ElectricalPower
      • Elevation
      • ElevationContours
      • ElevationGrid
      • ElevationProfileSamplePoint
      • ElevationProfileStatistics
      • EnergyYieldCalculationScenario
      • EnergyYieldCalculationType
      • EnergyYieldEffects
      • EnumTechnology
      • ExceedanceLevel
      • ExclusionRegion
      • Export
      • FillOptionComponentOptions
      • FillOptionIndividualComponentsOptions
      • FillOptionInverterBlockOptions
      • FillOptionRackLayoutOptions
      • FillOptionsSpacingType
      • FillOptionsType
      • FillOptionTrackerLayoutOptions
      • FillOptionUseExistingLayoutOptions
      • FlatTerrainParameters
      • GenericLayout
      • GenericLayoutFillOption
      • GenericLayoutSettings
      • Geography
      • HorizonData
      • I2DLocation
      • I3DLocation
      • IAddableEnumerable<T>
      • IAddableKeyedEnumerable<TKey, TValue>
      • IClearableCollection<T>
      • IEditableKeyedCollection<tKeyType, tContainedType>
      • IEditableKeyedEnumerable<TKeyType, TContainedType>
      • IElevationSource
      • Import
      • INamedItem
      • InstantaneousCondition
      • InverterBlockSpecification
      • InverterEfficiencyType
      • InverterInputInstance
      • InverterInputSpecification
      • InverterInstance
      • InverterSpecification
      • InverterSpecificationDocumentType
      • InverterTemperatureCurveEntry
      • InverterType
      • IReadable2DLocation
      • IReadable3DLocation
      • IReadableKeyedCollection<tKeyType, tContainedType>
      • IReadableKeyedEnumerable<TKey, TValue>
      • IRemovableKeyedEnumerable<TKey, TValue>
      • IResolution
      • Irradiance
      • ISpeed
      • IvCurve
      • KeyedCollection<TKeyType, TContainedType>
      • LayoutBoundary
      • LayoutBoundaryMarginParameter
      • LayoutBoundaryMarginParameters
      • LayoutChoiceType
      • LayoutParamsPitchModel
      • LayoutStatistic
      • Location
      • Location3D
      • LogLevel
      • MarginType
      • ModuleCellLayoutType
      • ModuleIndex
      • ModuleOrientation
      • ModuleSpecification
      • ModuleSpecificationDocumentType
      • ModuleString
      • MonteCarloSettings
      • MonthlyAlbedo
      • MonthlyEnergyYieldEffects
      • MonthlyEnergyYieldResults
      • MonthlySoilingValue
      • PerformanceStatistics
      • PowerOptimiserElectricalData
      • PowerOptimiserInputSpecification
      • PowerOptimiserMechanicalData
      • PowerOptimiserOperationType
      • PowerOptimiserOutputSpecification
      • PowerOptimiserSpecification
      • Projection
      • ProjectionInformation
      • PvsystCellTempModelParameters
      • PvsystInputIrradianceType
      • PVsystModelParameters
      • Quad
      • RackInstanceInfo
      • RackLayoutDefinition
      • RackLayoutParameters
      • RackSpecification
      • RackSystemSpecification
      • ReadOnly3DLocation
      • ReadOnlyLocation
      • Rectangle
      • Region
      • ReportCategory
      • Reporting
      • Resolution
      • RoadLocationParameters
      • RoughnessContours
      • RowPositionParameters
      • ScenarioAlbedoData
      • ScenarioMonthlyAlbedo
      • ScriptingException
      • ShadingBoundaryType
      • ShadingRegion
      • ShadingTargetPointPattern
      • SiteLayout
      • SiteLayoutStatistics
      • SiteLayoutType
      • SiteReferencePoint
      • SoilingEffectData
      • SolarResource
      • SpacingZone
      • SpecifySiteConfiguration
      • SpecifySiteDefinition
      • SpecifySiteLayoutRegionFillChoice
      • Speed
      • StringPatternType
      • SubArray
      • SunGeography
      • SunPosition
      • SunriseSunset
      • Temperature
      • TimeStepCalculation
      • Toolbox
      • TrackerGroup
      • TrackerImport
      • TrackerInfo
      • TrackerLayoutDefinition
      • TrackerLayoutParameters
      • TrackerPlacementModeType
      • TrackerPositionAlgorithmBase
      • TrackerRotations
      • TrackerRotationsTimeStep
      • TrackerSystemSpecification
      • TrackerTemplateSpecification
      • TransformerInstance
      • TransformerModelType
      • TransformerSpecification
      • TransformerSpecificationDocumentType
      • TwoDiodeParameters
      • Uncertainty
      • UncertaintyAnnualVariabilities
      • Workbook
      • WorkbookSettings
      • WorkbookSpecificModuleSpecification
      • YearRange
      • YieldResult
      • YieldResults

    Class WorkbookSettings

    Namespace: Scripting
    Syntax
    public class WorkbookSettings

    Constructors

    WorkbookSettings()

    Creates an instance of the WorkbookSettings class.

    Declaration
    public WorkbookSettings()

    Properties

    CloudEnergyCalculationInputFolderPath

    Declaration
    public string CloudEnergyCalculationInputFolderPath { get; set; }
    Property Value
    Type Description
    System.String

    ForceCloudCalculationToUseAsyncEndPoint

    Declaration
    public bool ForceCloudCalculationToUseAsyncEndPoint { get; set; }
    Property Value
    Type Description
    System.Boolean

    ForceCloudCalculationToUseSyncEndPoint

    Declaration
    public bool ForceCloudCalculationToUseSyncEndPoint { get; set; }
    Property Value
    Type Description
    System.Boolean

    GenericLayoutSettings

    Declaration
    public GenericLayoutSettings GenericLayoutSettings { get; set; }
    Property Value
    Type Description
    GenericLayoutSettings

    MasterKey1

    Declaration
    public string MasterKey1 { get; set; }
    Property Value
    Type Description
    System.String

    ProjectIdForApi

    Declaration
    public string ProjectIdForApi { get; set; }
    Property Value
    Type Description
    System.String

    ReturnDetailedTimeSeriesResults

    Declaration
    public bool ReturnDetailedTimeSeriesResults { get; set; }
    Property Value
    Type Description
    System.Boolean

    ReturnLossTreeTimeSeriesResults

    Declaration
    public bool ReturnLossTreeTimeSeriesResults { get; set; }
    Property Value
    Type Description
    System.Boolean

    ReturnPvSystFormatTimeSeriesResults

    Declaration
    public bool ReturnPvSystFormatTimeSeriesResults { get; set; }
    Property Value
    Type Description
    System.Boolean

    RunCalculationLocally

    Declaration
    public bool RunCalculationLocally { get; set; }
    Property Value
    Type Description
    System.Boolean

    SaveMetDataForCloudToJson

    Declaration
    public bool SaveMetDataForCloudToJson { get; set; }
    Property Value
    Type Description
    System.Boolean

    SpecifySiteDefinition

    Declaration
    public SpecifySiteDefinition SpecifySiteDefinition { get; set; }
    Property Value
    Type Description
    SpecifySiteDefinition

    UseCloudEnergyCalculationInputFolderPath

    Declaration
    public bool UseCloudEnergyCalculationInputFolderPath { get; set; }
    Property Value
    Type Description
    System.Boolean

    UseSpecifySiteDialogVersion2

    Declaration
    public bool UseSpecifySiteDialogVersion2 { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    Equals(WorkbookSettings)

    Tests a WorkbookSettings against this current WorkbookSettings for equality.

    Declaration
    public bool Equals(WorkbookSettings val)
    Parameters
    Type Name Description
    WorkbookSettings val
    Returns
    Type Description
    System.Boolean

    True if equal otherwise false is returned.

    Equals(Object)

    Tests a System.Object against this current WorkbookSettings for equality.

    Declaration
    public override bool Equals(object toCompare)
    Parameters
    Type Name Description
    System.Object toCompare
    Returns
    Type Description
    System.Boolean

    True if object is equal otherwise false is returned.

    Overrides
    System.Object.Equals(System.Object)

    GetHashCode()

    Gets the hash code for this object.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32

    The hash code for this object.

    Overrides
    System.Object.GetHashCode()

    Operators

    Equality(WorkbookSettings, WorkbookSettings)

    Tests a WorkbookSettings against this current WorkbookSettings for equality.

    Declaration
    public static bool operator ==(WorkbookSettings a, WorkbookSettings b)
    Parameters
    Type Name Description
    WorkbookSettings a
    WorkbookSettings b
    Returns
    Type Description
    System.Boolean

    True if equal otherwise false is returned.

    Inequality(WorkbookSettings, WorkbookSettings)

    Tests a WorkbookSettings against this current WorkbookSettings for inequality.

    Declaration
    public static bool operator !=(WorkbookSettings a, WorkbookSettings b)
    Parameters
    Type Name Description
    WorkbookSettings a
    WorkbookSettings b
    Returns
    Type Description
    System.Boolean

    True if not equal otherwise false is returned.

    In This Article
    Back to top DNV SolarFarmer Home