Artemis Artemis
Artemis Artemis

Search Results for

    Class ScriptConfiguration

    Represents the configuration of a script

    Inheritance
    object
    CorePropertyChanged
    ScriptConfiguration
    Implements
    IStorageModel
    Namespace: Artemis.Core.ScriptingProviders
    Assembly: Artemis.Core.dll
    Syntax
    public class ScriptConfiguration : CorePropertyChanged, IStorageModel

    Constructors

    ScriptConfiguration(ScriptingProvider, string, ScriptType)

    Creates a new instance of the ScriptConfiguration class

    Declaration
    public ScriptConfiguration(ScriptingProvider provider, string name, ScriptType scriptType)
    Parameters
    Type Name Description
    ScriptingProvider provider
    string name
    ScriptType scriptType

    Properties

    HasChanges

    Gets or sets a boolean indicating whether this configuration has pending changes to it's ScriptContent

    Declaration
    public bool HasChanges { get; set; }
    Property Value
    Type Description
    bool

    IsSuspended

    [NYI] Gets or sets a boolean indicating whether this configuration is suspended

    Declaration
    public bool IsSuspended { get; set; }
    Property Value
    Type Description
    bool

    Name

    Gets or sets the name of the script

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    string

    PendingScriptContent

    Gets or sets the pending changes to the script's content

    Declaration
    public string? PendingScriptContent { get; set; }
    Property Value
    Type Description
    string

    Script

    If active, gets the script

    Declaration
    public Script? Script { get; }
    Property Value
    Type Description
    Script

    ScriptContent

    Gets or sets the script's content

    Declaration
    public string? ScriptContent { get; }
    Property Value
    Type Description
    string

    ScriptingProviderId

    Gets or sets the ID of the scripting provider

    Declaration
    public string ScriptingProviderId { get; set; }
    Property Value
    Type Description
    string

    Methods

    ApplyPendingChanges()

    Applies the PendingScriptContent to the ScriptContent

    Declaration
    public void ApplyPendingChanges()

    DiscardPendingChanges()

    Discards the PendingScriptContent

    Declaration
    public void DiscardPendingChanges()

    Load()

    Loads the model from its associated entity

    Declaration
    public void Load()

    OnScriptContentChanged()

    Invokes the ScriptContentChanged event

    Declaration
    protected virtual void OnScriptContentChanged()

    Save()

    Saves the model to its associated entity

    Declaration
    public void Save()

    Events

    ScriptContentChanged

    Occurs whenever the contents of the script have changed

    Declaration
    public event EventHandler? ScriptContentChanged
    Event Type
    Type Description
    EventHandler

    Implements

    IStorageModel
    Content is available under the PolyForm Noncommercial License, by Artemis RGB.