## On this page

  

 

 # Class Api

 Last update: 16.07.2025 

Namespace: [VM.Managed.DAFUL.Pre](VM.Managed.DAFUL.Pre.md)  
Assembly: dfpreAPI.dll

This class is to represent API for DAFUL.

```csharp
public class Api : IPre, IMainWindow

```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ← [Api](VM.Managed.DAFUL.Pre.Api.md)

#### Implements

IPre, IMainWindow

#### Extension Methods

[LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkProperties_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkPropertiesAndValues_System_Object_VM_Models_Pre_LinkPropertyType_), [LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)](VM.Models.Pre.Cache.LinkPropertyItemCache.md#VM_Models_Pre_Cache_LinkPropertyItemCache_GetLinkedObjects__1_System_Object_VM_Models_Pre_LinkPropertyType_)

## Properties

### ActiveDocument

Gets the active document. \[Not Implementation\]

```csharp
public IDocument ActiveDocument { get; set; }

```

#### Property Value

IDocument

### ActiveDocumentViewModel

Gets the active DocumentViewModel

```csharp
public IDocumentViewModel ActiveDocumentViewModel { get; }

```

#### Property Value

IDocumentViewModel

### ActiveModel

Gets the active model.

```csharp
public Model ActiveModel { get; }

```

#### Property Value

Model

### ActiveWork

Gets the active work.

```csharp
public Work ActiveWork { get; }

```

#### Property Value

Work

### ApplicationCore

Gets the application core.

```csharp
public Application ApplicationCore { get; }

```

#### Property Value

Application

### DialogManager

Gets the dialog manager.

```csharp
public IDlgManager DialogManager { get; }

```

#### Property Value

IDlgManager

### GlobalJournal

Gets the global journal.

```csharp
public JournalRecorder GlobalJournal { get; }

```

#### Property Value

JournalRecorder

### LocalJournal

Gets the local journal.

```csharp
public JournalRecorder LocalJournal { get; }

```

#### Property Value

JournalRecorder

### MainWindow

Gets the main window. \[Not Implementation\]

```csharp
public IMainWindow MainWindow { get; }

```

#### Property Value

IMainWindow

### UnUseMRU

Gets or sets a value indicating whether \[un use MRU\].

```csharp
public bool UnUseMRU { get; set; }

```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### Version

Gets the version.

```csharp
public string Version { get; }

```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### WriteDFG

Gets or sets the WriteDFG flag. \[Not Implementation\]

```csharp
public bool WriteDFG { get; set; }

```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

## Methods

### ActiveDocChanged()

Activate changed document.

```csharp
public void ActiveDocChanged()

```

### AutoSave()

Auto save. \[Not Implementation\]

```csharp
public void AutoSave()

```

### CanSimulation(bool)

Determines whether this instance can simulation the specified can. \[Not Implementation\]

```csharp
public void CanSimulation(bool bCan)

```

#### Parameters

`bCan` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[can\].

### ClearMessage(string)

Clear Message. \[Not Implementation\]

```csharp
public void ClearMessage(string strName)

```

#### Parameters

`strName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name.

### CloseAllFile()

Closes all file.

```csharp
public void CloseAllFile()

```

### CloseAllFileExceptWork()

Closes all file except work.

```csharp
public void CloseAllFileExceptWork()

```

### CloseDocument(Document)

Closes the file.

```csharp
public bool CloseDocument(Document doc)

```

#### Parameters

`doc` Document

The  to close.

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### CloseFile(string)

Closes the file.

```csharp
public bool CloseFile(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

`true` if success; otherwise, `false`.

### CloseFile(string, bool)

Closes the file.

```csharp
public bool CloseFile(string strFileName, bool bUseWork)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the STR file.

`bUseWork` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b use work\].

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### CloseFile(string, bool, bool)

Closes the file.

```csharp
public bool CloseFile(string strFileName, bool bUseWork, bool bActivate)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the string file.

`bUseWork` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b use work\].

`bActivate` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b activate\].

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### CloseHiddenFile(string)

Closes the hidden file.

```csharp
public bool CloseHiddenFile(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the string file.

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### CloseWork()

Close work.

```csharp
public void CloseWork()

```

### CreateDocument(string)

Creates the document.

```csharp
public Document CreateDocument(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

#### Returns

Document

The document.

### CreateDocument(string, bool)

Creates the document.

```csharp
public Document CreateDocument(string strFileName, bool bActivate)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

`bActivate` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b activate\].

#### Returns

Document

The document.

### CreateDocument(string, bool, string)

Creates the document.

```csharp
public Document CreateDocument(string strFileName, bool bActivate, string strDocCreateInfo)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the STR file.

`bActivate` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b activate\].

`strDocCreateInfo` [string](https://learn.microsoft.com/dotnet/api/system.string)

The STR doc create info.

#### Returns

Document

### CreateDocument(string, bool, string, bool)

Creates the document.

```csharp
public Document CreateDocument(string strFileName, bool bActivate, string strDocCreateInfo, bool bDesigner)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the string file.

`bActivate` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b activate\].

`strDocCreateInfo` [string](https://learn.microsoft.com/dotnet/api/system.string)

The string document create information.

`bDesigner` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b designer\].

#### Returns

Document

### Dispose(bool)

```csharp
protected virtual void Dispose(bool disposing)

```

#### Parameters

`disposing` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### Dispose()

```csharp
public void Dispose()

```

### EndOutput(string)

Ends the output. \[Not Implementation\]

```csharp
public void EndOutput(string strName)

```

#### Parameters

`strName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name.

### ~Api()

Releases unmanaged resources and performs other cleanup operations before the  is reclaimed by garbage collection.

```csharp
protected ~Api()

```

### Fit(string)

Fits this instance.

```csharp
public void Fit(string strPathName)

```

#### Parameters

`strPathName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the string path.

### GetAllOpenDocument()

Gets all opend document.

```csharp
public List<Document> GetAllOpenDocument()

```

#### Returns

[List](https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1)&lt;Document&gt;

### GetDocumentFromOpenedDocument(string)

Gets the document from opened document.

```csharp
public Document GetDocumentFromOpenedDocument(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

#### Returns

Document

### GetMode()

Gets the mode.

```csharp
public string GetMode()

```

#### Returns

[string](https://learn.microsoft.com/dotnet/api/system.string)

The mode type

### IsOpenDocument(string)

Determines whether \[is open document\] \[the specified STR file name\].

```csharp
public bool IsOpenDocument(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

`true` if \[is open document\] \[the specified STR file name\]; otherwise, `false`.

### IsRunningSimulation()

Determines whether \[is running simulation\].

```csharp
public bool IsRunningSimulation()

```

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### NewFile(NewFile)

New file.

```csharp
public void NewFile(NewFile nf)

```

#### Parameters

`nf` NewFile

The new file information.

### NewModel(NewModel)

New model.

```csharp
public void NewModel(NewModel nM)

```

#### Parameters

`nM` NewModel

The new model information.

### OpenDocument(string)

Opens the document.

```csharp
public Document OpenDocument(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

#### Returns

Document

The document.

### OpenDocument(string, bool)

Opens the document.

```csharp
public Document OpenDocument(string strFileName, bool bActivate)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

`bActivate` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b activate\].

#### Returns

Document

The document.

### OpenDocument(string, string, bool)

Opens the document.

```csharp
public Document OpenDocument(string strFileName, string strRelatedPath, bool bActivate)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the STR file.

`strRelatedPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The STR related path.

`bActivate` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b activate\].

#### Returns

Document

### OpenDocumentFile(string)

Opens the document file.

```csharp
public Document OpenDocumentFile(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the STR file.

#### Returns

Document

### OpenFile(string, string)

Opens the file.

```csharp
public GroupItem OpenFile(string strFileName, string strRefDir)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

`strRefDir` [string](https://learn.microsoft.com/dotnet/api/system.string)

The reference directory.

#### Returns

GroupItem

The file informaton class.

### OpenFileDialogAsMainWindow(OpenFileDialogInfo)

Opens the file dialog as main window. \[Not Implementation\]

```csharp
public string OpenFileDialogAsMainWindow(OpenFileDialogInfo info)

```

#### Parameters

`info` OpenFileDialogInfo

The info.

#### Returns

[string](https://learn.microsoft.com/dotnet/api/system.string)

the file name

### OpenHiddenDocument(object)

Opens the hidden document.

```csharp
public Document OpenHiddenDocument(object obj)

```

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)

The object.

#### Returns

Document

### OpenModel(string)

Opens the model.

```csharp
public Model OpenModel(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

#### Returns

Model

The model.

### OpenWork(string)

Opens the work.

```csharp
public Work OpenWork(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the STR file.

#### Returns

Work

### PrepareSimulation()

Prepares the simulation. \[Not Implementation\]

```csharp
public bool PrepareSimulation()

```

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

`true` if success; otherwise, `false`.

### ReadAllText(string, string)

Reads all text. \[Not Implementation\]

```csharp
public void ReadAllText(string strPath, string strName)

```

#### Parameters

`strPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The path.

`strName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name.

### ReadAllText(string, string, bool)

Reads all text.

```csharp
public void ReadAllText(string strPath, string strName, bool bDeleteFIle)

```

#### Parameters

`strPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The STR path.

`strName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the STR.

`bDeleteFIle` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b delete F ile\].

### SaveAllFile()

Saves all file.

```csharp
public SaveAllResult SaveAllFile()

```

#### Returns

SaveAllResult

### SaveFile()

Save the file.

```csharp
public void SaveFile()

```

### SaveFile(string)

Saves the file.

```csharp
public void SaveFile(string strPath)

```

#### Parameters

`strPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The path.

### SaveFile(Document, string)

Saves the file.

```csharp
public void SaveFile(Document doc, string strFileName)

```

#### Parameters

`doc` Document

The doc.

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the STR file.

### SaveFile(Document, string, bool)

Saves the file.

```csharp
public void SaveFile(Document doc, string strFileName, bool bIgnoreExternChange)

```

#### Parameters

`doc` Document

The doc.

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the STR file.

`bIgnoreExternChange` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[b ignore extern change\].

### SaveFileDialogAsMainWindow(SaveFileDialogInfo)

Saves the file dialog as main window. \[Not Implementation\]

```csharp
public string SaveFileDialogAsMainWindow(SaveFileDialogInfo info)

```

#### Parameters

`info` SaveFileDialogInfo

The info.

#### Returns

[string](https://learn.microsoft.com/dotnet/api/system.string)

the file name

### SaveModel(string)

Saves the model.

```csharp
public void SaveModel(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

### SaveWork(string)

Saves the work.

```csharp
public void SaveWork(string strFileName)

```

#### Parameters

`strFileName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name of the file.

### SetEnableOfTabCtrl(object, bool)

Sets enable or disable of Tab..

```csharp
public void SetEnableOfTabCtrl(object obj, bool bEnable)

```

#### Parameters

`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)

The current document.

`bEnable` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

if set to `true` \[is enable\].

### SetIntervalForAutoSize()

Sets the size of the interval for auto. \[Not Implementation\]

```csharp
public void SetIntervalForAutoSize()

```

### SetPathName(string, string)

Set path name.

```csharp
public void SetPathName(string strOldPath, string strNewPath)

```

#### Parameters

`strOldPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The old path.

`strNewPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The new path.

### SetProgressState(int)

Set taskbar progress state.

```csharp
public void SetProgressState(int nStats)

```

#### Parameters

`nStats` [int](https://learn.microsoft.com/dotnet/api/system.int32)

0x0 : NOPROGRESS, 0x1 : INDETERMINATE, 0x2 : NORMAL, 0x4 : ERROR, 0x8 : PAUSED

### SetProgressValue(ulong, ulong)

Set taskbar progress value.

```csharp
public void SetProgressValue(ulong nCompleted, ulong nTotal)

```

#### Parameters

`nCompleted` [ulong](https://learn.microsoft.com/dotnet/api/system.uint64)

The completed value.

`nTotal` [ulong](https://learn.microsoft.com/dotnet/api/system.uint64)

The total value.

### SetSimulationParameters(string, string)

Sets the simulation parameters. \[Not Implementation\]

```csharp
public bool SetSimulationParameters(string strEndTime, string strStepSize)

```

#### Parameters

`strEndTime` [string](https://learn.microsoft.com/dotnet/api/system.string)

The end time.

`strStepSize` [string](https://learn.microsoft.com/dotnet/api/system.string)

Size of the step.

#### Returns

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

`true` if success; otherwise, `false`.

### SetStatusBar(string)

Set status bar.

```csharp
public void SetStatusBar(string strMessage)

```

#### Parameters

`strMessage` [string](https://learn.microsoft.com/dotnet/api/system.string)

The message.

### Start()

Start Api instance

```csharp
public static Api Start()

```

#### Returns

[Api](VM.Managed.DAFUL.Pre.Api.md)

new Api instancce

### Start(string)

Start Api instance.

```csharp
public static Api Start(string strKernelPath)

```

#### Parameters

`strKernelPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The kernel path.

#### Returns

[Api](VM.Managed.DAFUL.Pre.Api.md)

new Api instancce

### Start(string, string)

Start Api instance.

```csharp
public static Api Start(string strKernelPath, string strTranslatorDir)

```

#### Parameters

`strKernelPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The kernel path.

`strTranslatorDir` [string](https://learn.microsoft.com/dotnet/api/system.string)

The translator directory.

#### Returns

[Api](VM.Managed.DAFUL.Pre.Api.md)

new Api instancce

### Start(ApiStartOptions)

Start Api instance with given

```csharp
public static Api Start(ApiStartOptions options)

```

#### Parameters

`options` [ApiStartOptions](VM.Managed.DAFUL.Pre.ApiStartOptions.md)

The .

#### Returns

[Api](VM.Managed.DAFUL.Pre.Api.md)

new Api instance

### StartOperationStatus()

Starts the operation status.

```csharp
public void StartOperationStatus()

```

### StartOutput(string, string)

Starts the output. \[Not Implementation\]

```csharp
public void StartOutput(string strPath, string strName)

```

#### Parameters

`strPath` [string](https://learn.microsoft.com/dotnet/api/system.string)

The path.

`strName` [string](https://learn.microsoft.com/dotnet/api/system.string)

Name.

### UseSession(string)

Get session object to menage operation session

```csharp
public ISession UseSession(string strSessionName)

```

#### Parameters

`strSessionName` [string](https://learn.microsoft.com/dotnet/api/system.string)

The name of the session

#### Returns

ISession

The  object

### UseSession(IOperation)

Get session object to menage operation session

```csharp
public ISession UseSession(IOperation operation)

```

#### Parameters

`operation` IOperation

The  will be executed.

#### Returns

ISession

The  object

### OnActiveDocumentChanged

Occurs when \[on active document changed\]. \[Not Implementation\]

```csharp
public event EventHandler OnActiveDocumentChanged

```

#### Event Type

[EventHandler](https://learn.microsoft.com/dotnet/api/system.eventhandler)

### OnActiveViewChanged

Occurs when \[on active view changed\]. \[Not Implementation\]

```csharp
public event EventHandler OnActiveViewChanged

```

#### Event Type

[EventHandler](https://learn.microsoft.com/dotnet/api/system.eventhandler)