Version: 13.0

    Show / Hide Table of Contents

    Class UserSpecifiedData

    Inheritance
    System.Object
    System.MarshalByRefObject
    SMT.MastaAPIUtility.MarshalByRefObjectPermanent
    APIBase
    UserSpecifiedData
    Implements
    System.IEquatable<APIBase>
    Inherited Members
    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.Scripting
    Assembly: SMT.MastaAPI.13.0.dll
    Syntax
    public class UserSpecifiedData : APIBase, IEquatable<APIBase>

    Fields

    _parent

    Declaration
    protected readonly APIBase _parent
    Field Value
    Type Description
    APIBase

    Properties

    ReportNames

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

    Methods

    Clear()

    Declaration
    public void Clear()

    GetActiveReportWithEncodedImages()

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

    GetBool(String)

    Declaration
    public bool GetBool(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Boolean

    GetDefaultReportWithEncodedImages()

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

    GetDouble(String)

    Declaration
    public double GetDouble(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Double

    GetNamedReportWithEncodedImages(String)

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

    GetString(String)

    Declaration
    public string GetString(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.String

    HasBool(String)

    Declaration
    public bool HasBool(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Boolean

    HasDouble(String)

    Declaration
    public bool HasDouble(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Boolean

    HasString(String)

    Declaration
    public bool HasString(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Boolean

    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

    SetBool(String, Boolean)

    Declaration
    public void SetBool(string key, bool value)
    Parameters
    Type Name Description
    System.String key
    System.Boolean value

    SetDouble(String, Double)

    Declaration
    public void SetDouble(string key, double value)
    Parameters
    Type Name Description
    System.String key
    System.Double value

    SetString(String, String)

    Declaration
    public void SetString(string key, string value)
    Parameters
    Type Name Description
    System.String key
    System.String value

    TryGetDouble(String, out Double)

    Declaration
    public bool TryGetDouble(string key, out double value)
    Parameters
    Type Name Description
    System.String key
    System.Double value
    Returns
    Type Description
    System.Boolean

    TryGetString(String, out String)

    Declaration
    public bool TryGetString(string key, out string value)
    Parameters
    Type Name Description
    System.String key
    System.String value
    Returns
    Type Description
    System.Boolean

    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