Version: 13.0

    Show / Hide Table of Contents

    Class ProgramSettings

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    PersistentSingleton
    PerMachineSettings
    ProgramSettings
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    PerMachineSettings.ResetToDefaults()
    PersistentSingleton._parent
    PersistentSingleton.Save()
    PersistentSingleton.ReportNames
    PersistentSingleton.OutputDefaultReportTo(String)
    PersistentSingleton.GetDefaultReportWithEncodedImages()
    PersistentSingleton.OutputActiveReportTo(String)
    PersistentSingleton.OutputActiveReportAsTextTo(String)
    PersistentSingleton.GetActiveReportWithEncodedImages()
    PersistentSingleton.OutputNamedReportTo(String, String)
    PersistentSingleton.OutputNamedReportAsMastaReport(String, String)
    PersistentSingleton.OutputNamedReportAsTextTo(String, String)
    PersistentSingleton.GetNamedReportWithEncodedImages(String)
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.cacheRpds
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, (T1, T2)<Type, Object>[])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T>(String, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, (T1, T2)<Type, Object>, T)
    APIBase.callPartialMethod<T1, T2>(String, (T1, T2)<Type, Object>, T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    APIBase.isInvalid
    APIBase.DocumentationUrl()
    APIBase.ToString()
    APIBase.RunPython<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String, String, Object)
    APIBase.RunPythonCode<T>(String)
    APIBase.RunPython<T>(String, String)
    APIBase.CreateObjRef(Type)
    APIBase.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent.InitializeLifetimeService()
    Namespace: SMT.MastaAPI.Utility
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class ProgramSettings : PerMachineSettings, IEquatable<APIBase>

    Properties

    AllowMultithreading

    If selected, MASTA will attempt to use multiple CPU threads to perform analyses

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

    AskForPartNamesInThe2DView

    Ask for part names when adding parts in the 2D View.

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

    AutoReturnLicencesInactivityIntervalMinutes

    After MASTA is inactive for a specified period of time, network licences will automatically be returned to the server.

    Declaration
    public Overridable<int> AutoReturnLicencesInactivityIntervalMinutes { get; set; }
    Property Value
    Type Description
    Overridable<System.Int32>

    AutosaveDirectory

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

    AutosaveIntervalMinutes

    Declaration
    public Overridable<int> AutosaveIntervalMinutes { get; set; }
    Property Value
    Type Description
    Overridable<System.Int32>

    CheckForNewVersionOnStartup

    MASTA can check that it is the most up-to-date version when starting up. Checking for a new version sends only the following data to SMT:

    • MASTA Build information
    • Operating system version
    • Licence information
    Declaration
    public ProgramSettings.CheckForNewerVersionOption CheckForNewVersionOnStartup { get; set; }
    Property Value
    Type Description
    ProgramSettings.CheckForNewerVersionOption

    ConfirmExit

    If this option is selected, MASTA will prompt for confirmation when closing.

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

    FontSize

    This requires a restart of MASTA to take effect

    Declaration
    public double FontSize { get; set; }
    Property Value
    Type Description
    System.Double

    IncludeOverridablePropertySourceInformation

    If this option is selected, additional information will be shown on overridable properties indicating, for instance, whether they are user-specified, calculated, etc.

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

    MaximumNumberOfFilesToStoreInHistory

    Declaration
    public int MaximumNumberOfFilesToStoreInHistory { get; set; }
    Property Value
    Type Description
    System.Int32

    MaximumNumberOfThreadsForLargeOperations

    The suggested value is the number of CPU threads

    Declaration
    public Overridable<int> MaximumNumberOfThreadsForLargeOperations { get; set; }
    Property Value
    Type Description
    Overridable<System.Int32>

    MaximumNumberOfThreadsForMathematicallyIntensiveOperations

    The suggested value is the number of CPU cores.

    Declaration
    public Overridable<int> MaximumNumberOfThreadsForMathematicallyIntensiveOperations { get; set; }
    Property Value
    Type Description
    Overridable<System.Int32>

    MaximumNumberOfUndoItems

    A large number of items in the undo list will increase the file size.

    Declaration
    public int MaximumNumberOfUndoItems { get; set; }
    Property Value
    Type Description
    System.Int32

    NumberOfConnectionsToShowWhenMultiSelecting

    Maximum Number of Connections to Show When Multi-Selecting

    Declaration
    public int NumberOfConnectionsToShowWhenMultiSelecting { get; set; }
    Property Value
    Type Description
    System.Int32

    NumberOfCPUCores

    This is the number of physical cores that the CPU has.

    Declaration
    public int NumberOfCPUCores { get; }
    Property Value
    Type Description
    System.Int32

    NumberOfCPUThreads

    This is the number of virtual cores (or logical processors) that the CPU can access. For CPUs with hyper-threading this is typically twice the number of physical cores.

    Declaration
    public int NumberOfCPUThreads { get; }
    Property Value
    Type Description
    System.Int32

    NumberOfDaysOfAdvanceWarningForExpiringFeatures

    MASTA will warn about features which are soon to expire - this setting controls how far in advance a feature's expiry should be reported.

    Declaration
    public int NumberOfDaysOfAdvanceWarningForExpiringFeatures { get; set; }
    Property Value
    Type Description
    System.Int32

    OverrideFont

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

    ShowDrawingNumbersInTreeView

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

    ShowNumberOfTeethWithGearSetNames

    This only applies to the Macro Geometry tree view

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

    ShowUserInterfaceHints

    Show pop-up messages to inform about user interface features that might be useful

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

    TwoDCADGuideModelAutosaveSizeLimit

    Measurement: DataSize

    Declaration
    public double TwoDCADGuideModelAutosaveSizeLimit { get; set; }
    Property Value
    Type Description
    System.Double

    UseBackgroundSaving

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

    UseCompressionForMASTAFiles

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

    UseDefaultAutosaveDirectory

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

    UserDefinedAutosaveDirectory

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

    UserName

    The 'User Name' field in the dialog for saving designs will be automatically populated with this value. This will also be the 'User Name' for the entry added to the history when changing database items.

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

    UseStandardDialogForFileOpen

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

    UseStandardDialogForFileSave

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

    Methods

    ClearMRUEntries()

    Declaration
    public void ClearMRUEntries()

    SelectAutosaveDirectory()

    Declaration
    public void SelectAutosaveDirectory()

    Implements

    System.IEquatable<T>

    Extension Methods

    UtilityMethods.IsReadOnly<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsValid<T>(T, Expression<Func<T, Object>>)
    UtilityMethods.IsMethodValid<T>(T, Expression<Func<T, Action>>)
    UtilityMethods.IsMethodReadOnly<T>(T, Expression<Func<T, Action>>)
    Back to top