Version: 15.0

    Show / Hide Table of Contents

    Class NetworkDatabaseConnectionSettingsItem

    Inheritance
    System.Object
    APIBase
    NetworkDatabaseConnectionSettingsItem
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    APIBase.DisconnectFromMASTA()
    APIBase.GetProperty<T>(String)
    APIBase.SetProperty(String, Object)
    APIBase.clearCachedRpds()
    APIBase.getNamedObjectList<TElementType>(String)
    APIBase.getExpandableProperty<TReturnType>(String)
    APIBase.callPartialMethod(String, [])
    APIBase.callPartialMethod<T>(String, T)
    APIBase.callPartialMethod<T>(String, , T)
    APIBase.callPartialMethod<T>(String, , , T)
    APIBase.callPartialMethod<T>(String, , , , T)
    APIBase.callPartialMethod<T1, T2>(String, , T1, T2)
    APIBase.getPartialProperty(String)
    APIBase.setPartialProperty(String, Object)
    APIBase.IsValid(String)
    APIBase.IsReadOnly(String)
    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.RunPython(String, String, Object)
    APIBase.createWrappedRange(Double, Double)
    APIBase.createWrappedVector2D(Double, Double)
    APIBase.createWrappedPosition3D(Double, Double, Double)
    APIBase.ToListWithSelectedItem<T>(IEnumerable<T>)
    APIBase.ToListWithSelectedItem<T>(T, IEnumerable<T>)
    APIBase.Equals(APIBase)
    APIBase.GetHashCode()
    APIBase.Equals(Object)
    APIBase.InvalidProperties
    APIBase.ReadOnlyProperties
    APIBase.AllPropertiesAreReadOnly
    APIBase.AllPropertiesAreInvalid
    APIBase.cacheRpds
    APIBase.isInvalid
    Namespace: SMT.MastaAPI.Utility.Databases
    Assembly: SMT.MastaAPI.15.0.dll
    Syntax
    public sealed class NetworkDatabaseConnectionSettingsItem : APIBase, IEquatable<APIBase>

    Properties

    ConnectionString

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

    ConnectionTimeout

    Measurement: TimeShort

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

    DatabaseName

    Declaration
    public ListWithSelectedItem<string> DatabaseName { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<System.String>

    DatabaseNameReportable

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

    DatabaseNameSpecified

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

    Enabled

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

    IsOriginDatabase

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

    Password

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

    ReportNames

    Declaration
    public IReadOnlyList<string> ReportNames { get; }
    Property Value
    Type Description
    System.Collections.Generic.IReadOnlyList<System.String>

    ServerName

    Declaration
    public ListWithSelectedItem<string> ServerName { get; set; }
    Property Value
    Type Description
    ListWithSelectedItem<System.String>

    ServerNameReportable

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

    ServerNameSpecified

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

    SpecifyServerName

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

    State

    Declaration
    public ConnectionState State { get; }
    Property Value
    Type Description
    ConnectionState

    Username

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

    UseWindowsCredentialsForAuthentication

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

    Methods

    GetActiveReportWithEncodedImages()

    Declaration
    public string GetActiveReportWithEncodedImages()
    Returns
    Type Description
    System.String

    GetDefaultReportWithEncodedImages()

    Declaration
    public string GetDefaultReportWithEncodedImages()
    Returns
    Type Description
    System.String

    GetNamedReportWithEncodedImages(String)

    Declaration
    public string GetNamedReportWithEncodedImages(string reportName)
    Parameters
    Type Name Description
    System.String reportName
    Returns
    Type Description
    System.String

    OutputActiveReportAsTextTo(String)

    Declaration
    public void OutputActiveReportAsTextTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputActiveReportTo(String)

    Declaration
    public void OutputActiveReportTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputDefaultReportTo(String)

    Declaration
    public void OutputDefaultReportTo(string filePath)
    Parameters
    Type Name Description
    System.String filePath

    OutputNamedReportAsMastaReport(String, String)

    Declaration
    public void OutputNamedReportAsMastaReport(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    OutputNamedReportAsTextTo(String, String)

    Declaration
    public void OutputNamedReportAsTextTo(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    OutputNamedReportTo(String, String)

    Declaration
    public void OutputNamedReportTo(string reportName, string filePath)
    Parameters
    Type Name Description
    System.String reportName
    System.String filePath

    UpdateDatabaseList()

    Requires an available Server

    Declaration
    public void UpdateDatabaseList()

    UpdateServerList()

    Subject to firewall rules (TCP/IP 1433 and UDP 1434)

    Declaration
    public void UpdateServerList()

    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