Models.Tools

Reference for the StoryCADLib.Models.Tools namespace.

ConflictCategoryModel

Class: StoryCADLib.Models.Tools.ConflictCategoryModel

public class ConflictCategoryModel

Constructors

ConflictCategoryModel(string)

public ConflictCategoryModel(string topic)

Parameters

• topic (string)

Fields

Examples

public SortedDictionary<string, List<string>> Examples

Type SortedDictionary<string, List<string>>

SubCategories

public List<string> SubCategories

Type List<string>

TopicName

public string TopicName

Type string

---

DramaticSituationModel

Class: StoryCADLib.Models.Tools.DramaticSituationModel

public class DramaticSituationModel

Constructors

DramaticSituationModel(string)

public DramaticSituationModel(string situationName)

Parameters

• situationName (string)

Properties

SituationName

public string SituationName { get; set; }

Type string

Role1

public string Role1 { get; set; }

Type string

Role2

public string Role2 { get; set; }

Type string

Role3

public string Role3 { get; set; }

Type string

Role4

public string Role4 { get; set; }

Type string

Description1

public string Description1 { get; set; }

Type string

Description2

public string Description2 { get; set; }

Type string

Description3

public string Description3 { get; set; }

Type string

Description4

public string Description4 { get; set; }

Type string

Notes

public string Notes { get; set; }

Type string

---

KeyQuestionModel

Class: StoryCADLib.Models.Tools.KeyQuestionModel

public class KeyQuestionModel : ObservableObject

Constructors

KeyQuestionModel()

public KeyQuestionModel()

Properties

Key

public string Key { get; set; }

Type string

Element

public string Element { get; set; }

Type string

Topic

public string Topic { get; set; }

Type string

Question

public string Question { get; set; }

Type string

---

PlotPatternModel

Class: StoryCADLib.Models.Tools.PlotPatternModel

public class PlotPatternModel

Constructors

PlotPatternModel(string)

public PlotPatternModel(string name)

Parameters

• name (string)

Fields

PlotPatternName

public string PlotPatternName

Type string

PlotPatternNotes

public string PlotPatternNotes

Type string

PlotPatternScenes

public List<PlotPatternScene> PlotPatternScenes

Type List<PlotPatternScene>

---

PlotPatternScene

Class: StoryCADLib.Models.Tools.PlotPatternScene

public class PlotPatternScene

Constructors

PlotPatternScene(string)

public PlotPatternScene(string title)

Parameters

• title (string)

Fields

Notes

public string Notes

Type string

SceneTitle

public string SceneTitle

Type string

---

PreferencesModel

Class: StoryCADLib.Models.Tools.PreferencesModel

PreferencesModel contains StoryCAD User preferences. The model is maintained from a Shell Preferences() method which is launched from a Command tied to a View button, and by PreferencesViewModel using a ContentDialog as the view. The StoryCAD user preferences are stored as Preferences.json within AppState.RootDirectory. If Preferences.json doesn’t exist, it will be created once the user hits done within the preferences initialisation screen.

public class PreferencesModel : ObservableObject

Constructors

PreferencesModel()

public PreferencesModel()

Properties

FirstName

This is the user’s first name

[JsonInclude]
[JsonPropertyName("FirstName")]
public string FirstName { get; set; }

Type string

LastName

This is the user’s surname

[JsonInclude]
[JsonPropertyName("LastName")]
public string LastName { get; set; }

Type string

Email

This is the user’s email (Used to get in contact for errors and newsletter if enabled)

[JsonInclude]
[JsonPropertyName("Email")]
public string Email { get; set; }

Type string

ErrorCollectionConsent

Disables Elmah.io integration if false

[JsonInclude]
[JsonPropertyName("ElmahConsent")]
public bool ErrorCollectionConsent { get; set; }

Type bool

Newsletter

If set to true user email will be added to the newsletter list

[JsonInclude]
[JsonPropertyName("NewsletterConsent")]
public bool Newsletter { get; set; }

Type bool

PreferencesInitialized

This switch tracks whether this is the first time StoryCAD is opened

[JsonInclude]
[JsonPropertyName("Initialized")]
public bool PreferencesInitialized { get; set; }

Type bool

LastSelectedTemplate

Tracks the last used template, for new outline creation

[JsonInclude]
[JsonPropertyName("LastTemplate")]
public int LastSelectedTemplate { get; set; }

Type int

ThemePreference

This is the user’s theme preference

[JsonInclude]
[JsonPropertyName("Theme")]
public ElementTheme ThemePreference { get; set; }

Type ElementTheme

WrapNodeNames

If set to wrap, node names will wrap in the tree. If set to disabled, node names will cut off.

[JsonInclude]
[JsonPropertyName("NodeWrap")]
public TextWrapping WrapNodeNames { get; set; }

Type TextWrapping

AutoSave

StoryCAD will automatically save the outline if true

[JsonInclude]
[JsonPropertyName("Autosave")]
public bool AutoSave { get; set; }

Type bool

AutoSaveInterval

Controls how often autosave is run (Ignored if AutoSave is off)

[JsonInclude]
[JsonPropertyName("AutosaveInterval")]
public int AutoSaveInterval { get; set; }

Type int

BackupOnOpen

StoryCAD will create a backup of the outline when opened if true

[JsonInclude]
[JsonPropertyName("BackupOnOpen")]
public bool BackupOnOpen { get; set; }

Type bool

TimedBackup

StoryCAD will create a backup of the currently opened outline if true.

[JsonInclude]
[JsonPropertyName("TimedBackup")]
public bool TimedBackup { get; set; }

Type bool

TimedBackupInterval

Controls timed backup frequency.

[JsonInclude]
[JsonPropertyName("TimedBackupInterval")]
public int TimedBackupInterval { get; set; }

Type int

ProjectDirectory

Default location where outlines are stored.

[JsonInclude]
[JsonPropertyName("OutlineDirectory")]
public string ProjectDirectory { get; set; }

Type string

BackupDirectory

Location where backups are stored if enabled

[JsonInclude]
[JsonPropertyName("BackupDirectory")]
public string BackupDirectory { get; set; }

Type string

RecentFiles

Recently opened files (Capped at 25)

[JsonInclude]
[JsonPropertyName("RecentFiles")]
public List<string> RecentFiles { get; set; }

Type List<string>

Version

Tracks last version of StoryCAD that was opened

[JsonInclude]
[JsonPropertyName("Version")]
public string Version { get; set; }

Type string

RecordPreferencesStatus

[JsonInclude]
[JsonPropertyName("RecordPreferencesStatus")]
public bool RecordPreferencesStatus { get; set; }

Type bool

RecordVersionStatus

[JsonInclude]
[JsonPropertyName("RecordVersionStatus")]
public bool RecordVersionStatus { get; set; }

Type bool

PreferredSearchEngine

[JsonInclude]
[JsonPropertyName("PreferredSearchEngine")]
public BrowserType PreferredSearchEngine { get; set; }

Type BrowserType

SearchEngineIndex

Search engine to use.

[JsonInclude]
[JsonPropertyName("SearchEngineIndex")]
public int SearchEngineIndex { get; set; }

Type int

HideRatingPrompt

Hides the rating prompt until the next update

[JsonInclude]
[JsonPropertyName("ShowRatings")]
public bool HideRatingPrompt { get; set; }

Type bool

CumulativeTimeUsed

Total amount of time StoryCAD has been used/open on the system

[JsonInclude]
[JsonPropertyName("TimeUsed")]
public long CumulativeTimeUsed { get; set; }

Type long

LastReviewDate

DateTime of last review

[JsonInclude]
[JsonPropertyName("LastReview")]
public DateTime LastReviewDate { get; set; }

Type DateTime

ShowStartupDialog

Should the startup dialog (HelpPage) be shown

[JsonInclude]
[JsonPropertyName("ShowStartupDialog")]
public bool ShowStartupDialog { get; set; }

Type bool

AdvancedLogging

Do we want to log more in depth

[JsonInclude]
[JsonPropertyName("AdvancedLogging")]
public bool AdvancedLogging { get; set; }

Type bool

HideKeyFileWarning

Hide the key file missing warning dialog.

[JsonInclude]
[JsonPropertyName("HideKeyFileWarning")]
public bool HideKeyFileWarning { get; set; }

Type bool

ShowFilePickerOnStartup

Should the file picker be shown on startup

[JsonInclude]
[JsonPropertyName("ShowFilePickerOnStartup")]
public bool ShowFilePickerOnStartup { get; set; }

Type bool

---

SubTopicModel

Class: StoryCADLib.Models.Tools.SubTopicModel

public class SubTopicModel

Constructors

SubTopicModel(string)

public SubTopicModel(string name)

Parameters

• name (string)

Fields

SubTopicName

public string SubTopicName

Type string

SubTopicNotes

public string SubTopicNotes

Type string

---

ToolsData

Class: StoryCADLib.Models.Tools.ToolsData

This stores the tools for StoryCAD’s Tools.json. Previously tools were stored in GlobalData.

public class ToolsData

Constructors

ToolsData(ILogService, JSONResourceLoader)

public ToolsData(ILogService log, JSONResourceLoader resourceLoader)

Parameters

• log (ILogService)
• resourceLoader (JSONResourceLoader)

Fields

BeatSheetSource

public List<PlotPatternModel> BeatSheetSource

Type List<PlotPatternModel>

DramaticSituationsSource

public SortedDictionary<string, DramaticSituationModel> DramaticSituationsSource

Type SortedDictionary<string, DramaticSituationModel>

FemaleFirstNamesSource

public ObservableCollection<string> FemaleFirstNamesSource

Type ObservableCollection<string>

KeyQuestionsSource

public Dictionary<string, List<KeyQuestionModel>> KeyQuestionsSource

Type Dictionary<string, List<KeyQuestionModel>>

LastNamesSource

public ObservableCollection<string> LastNamesSource

Type ObservableCollection<string>

MaleFirstNamesSource

public ObservableCollection<string> MaleFirstNamesSource

Type ObservableCollection<string>

MasterPlotsSource

public List<PlotPatternModel> MasterPlotsSource

Type List<PlotPatternModel>

RelationshipsSource

public ObservableCollection<string> RelationshipsSource

Type ObservableCollection<string>

StockScenesSource

public SortedDictionary<string, ObservableCollection<string>> StockScenesSource

Type SortedDictionary<string, ObservableCollection<string>>

TopicsSource

public SortedDictionary<string, TopicModel> TopicsSource

Type SortedDictionary<string, TopicModel>

---

TopicModel

Class: StoryCADLib.Models.Tools.TopicModel

public class TopicModel

Constructors

TopicModel(string, string)

public TopicModel(string topic, string filename)

Parameters

• topic (string)
• filename (string)

TopicModel(string)

public TopicModel(string topic)

Parameters

• topic (string)

Fields

Filename

public string Filename

Type string

SubTopics

public List<SubTopicModel> SubTopics

Type List<SubTopicModel>

TopicName

public string TopicName

Type string

TopicType

public TopicTypeEnum TopicType

Type TopicTypeEnum

---

TopicTypeEnum

Enum: StoryCADLib.Models.Tools.TopicTypeEnum

public enum TopicTypeEnum

Values

Value	Description
Notepad
Inline