FormIt Plugin API v25.0.0 (2025.0.0)
Loading...
Searching...
No Matches
FormIt API

Description

Modules

 FormIt.Analysis API
 
 FormIt.AutoSave API
 
 FormIt.Cameras API
 
 FormIt.Clipboard API
 
 FormIt.Collaboration API
 
 FormIt.Configuration API
 
 FormIt.Dynamo API
 
 FormIt.Edit API
 
 FormIt.Events API
 
 FormIt.Files API
 
 FormIt.FileSystem API
 
 FormIt.Forge API
 
 FormIt.Graphics API
 
 FormIt.GroupEdit API
 
 FormIt.HUDManager API
 
 FormIt.ImageManager API
 
 FormIt.Layers API
 
 FormIt.Levels API
 
 FormIt.MaterialProvider API
 
 FormIt.Messaging API
 
 FormIt.Model API
 
 FormIt.Scenes API
 
 FormIt.Materials API
 
 FormIt.UndoManagement API
 
 FormIt.SectionPlanes API
 
 FormIt.Selection API
 
 FormIt.Commands API
 
 FormIt.Shortcuts API
 
 FormIt.SketchMaterials API
 
 FormIt.Statistics API
 
 FormIt.StringConversion API
 
 FormIt.SunAndLocation API
 
 FormIt.Tools API
 
 FormIt.UI API
 
 FormIt.Utils API
 
 FormIt.View API
 
 FormIt.VisualStyles API
 

Namespaces

namespace  FormIt.Analysis
 FormIt.Analysis namespace.
 
namespace  FormIt.AutoSave
 FormIt.AutoSave namespace.
 
namespace  FormIt.Cameras
 FormIt.Cameras namespace.
 
namespace  FormIt.Clipboard
 FormIt.Clipboard namespace.
 
namespace  FormIt.Collaboration
 FormIt.Collaboration namespace.
 
namespace  FormIt.Configuration
 FormIt.Configuration namespace.
 
namespace  FormIt.Dynamo
 FormIt.Dynamo namespace.
 
namespace  FormIt.Edit
 FormIt.Edit namespace.
 
namespace  FormIt.Events
 FormIt.Events namespace.
 
namespace  FormIt.Files
 FormIt.Files namespace.
 
namespace  FormIt.FileSystem
 FormIt.FileSystem namespace.
 
namespace  FormIt.Forge
 FormIt.Forge namespace.
 
namespace  FormIt.Graphics
 FormIt.Graphics namespace.
 
namespace  FormIt.GroupEdit
 FormIt.GroupEdit namespace.
 
namespace  FormIt.HUDManager
 FormIt.HUDManager namespace.
 
namespace  FormIt.ImageManager
 FormIt.ImageManager namespace.
 
namespace  FormIt.Layers
 FormIt.Layers namespace.
 
namespace  FormIt.Levels
 FormIt.Levels namespace.
 
namespace  FormIt.MaterialProvider
 FormIt.MaterialProvider namespace.
 
namespace  FormIt.Messaging
 FormIt.Messaging namespace.
 
namespace  FormIt.Model
 FormIt.Model namespace.
 
namespace  FormIt.Scenes
 FormIt.Scenes namespace.
 
namespace  FormIt.Materials
 FormIt.Materials namespace.
 
namespace  FormIt.UndoManagement
 FormIt.UndoManagement namespace.
 
namespace  FormIt.SectionPlanes
 FormIt.SectionPlanes namespace.
 
namespace  FormIt.Selection
 FormIt.Selection namespace.
 
namespace  FormIt.Commands
 FormIt.Commands namespace.
 
namespace  FormIt.Shortcuts
 FormIt.Shortcuts namespace.
 
namespace  FormIt.SketchMaterials
 FormIt.SketchMaterials namespace.
 
namespace  FormIt.Statistics
 FormIt.Statistics namespace.
 
namespace  FormIt.StringConversion
 FormIt.StringConversion namespace.
 
namespace  FormIt.SunAndLocation
 FormIt.SunAndLocation namespace.
 
namespace  FormIt.Tools
 FormIt.Tools namespace.
 
namespace  FormIt.UI
 FormIt.UI namespace.
 
namespace  FormIt.Utils
 FormIt.Utils namespace.
 
namespace  FormIt.View
 FormIt.View namespace.
 
namespace  FormIt.VisualStyles
 FormIt.VisualStyles namespace.
 

Functions

json FormIt.SetFeatureFlag (featureName, enabled)
 Set a tool feature flag
 
json FormIt.HaveFeatureFlag (flag)
 Check if a feature flag exists
 
json FormIt.GetSnap ()
 Get snapping state.
 
json FormIt.SetSnap (bSnap)
 Set snapping state.
 
json FormIt.GetTouchEnabled ()
 Are touch interactions enabled?
 
json FormIt.SetTouchEnabled (bTouchEnabled)
 Enable touch interactions
 
json FormIt.ImportFile (sFileName, bGroupImport, nHistoryID, bKeepLevelsWhenGrouping)
 Imports the content of the given file.
 
json FormIt.OpenFile (sFileName)
 Open the given file.
 
json FormIt.LoadPreviewImage (sFileName)
 Load preview image of the given file.
 
json FormIt.SaveFile (sFileName, saveOptions, previewImage, forSave)
 Save the current model to the given file name.
 
json FormIt.SaveFileForEnergyAnalysis (sFileName)
 Save the current model to the given file name for energy analysis.
 
json FormIt.SetGeoLocationData (geodata)
 SetGeoLocationData() function.
 
json FormIt.SetRenderData (renderdata)
 SetRenderData() function.
 
json FormIt.GetTimeNow ()
 Get the time
 
json FormIt.NewFile (forced)
 Run the new file method
 
json FormIt.Version ()
 Get the version of FormIt.
 
json FormIt.SetCurveAccuracyOrCountDefault (accuracyORcount)
 Set the curve accuracy for the application.
 
json FormIt.GetCurveAccuracyOrCountDefault ()
 Get the curve accuracy for the application.
 
json FormIt.SetSurfaceAccuracyOrCountDefault (accuracyORcount)
 Set the surface accuracy for the application.
 
json FormIt.GetSurfaceAccuracyOrCountDefault ()
 Get the surface accuracy for the application.
 
json FormIt.GetAccuracyForQuarterCircle (accuracy)
 Get the accuracy for a quarter circle to be used to call SetCurveAccuracyOrCountDefault/SetSurfaceAccuracyOrCountDefault.
 
json FormIt.GetUnitTypeDefault ()
 Get the Application (as opposed to Model) UnitType.
 
json FormIt.SetUnitTypeDefault (unitType)
 Set the Application (as opposed to Model) UnitType.
 
json FormIt.IsWSRAvailable ()
 IsWSRAvailable() function.
 
json FormIt.SuspendMessaging (bSuppress, nTopLevelHistory, bFullUpdate)
 SuspendMessaging suspends all update messages from WSM until ResumeMessaging is called.
 
json FormIt.ResumeMessaging ()
 Resumes messaging that was suspended by a call to SuspendMessaging.
 
json FormIt.ChangeTargetBuildableArea (value)
 ChangeTargetBuildableArea() function.
 
json FormIt.GetBuildingType ()
 GetBuildingType() function.
 
json FormIt.SetBuildingType (value)
 SetBuildingType() function.
 
json FormIt.WriteAppDefaultContentToFile (id, path)
 WriteAppDefaultContentToFile() function.
 
json FormIt.DeleteImage (nHistoryID, imageID)
 DeleteImage() function.
 
json FormIt.HandleHUDTextInput (dimensionID, inputText)
 HandleHUDTextInput will handle the HUD input values Parameters: In: dimensionID Out: Boolean
 
json FormIt.GetAppDefaultContentsWithoutAXM ()
 GetAppDefaultContentsWithoutAXM() function.
 
json FormIt.SetKeyboardShortcutsEnabled (enabled)
 SetKeyboardShortcutsEnabled Enables/Disables Keyboard Shortcuts Parameters: In: enabled Out: JSON_UNDEFINED
 
json FormIt.GetShowEditableDimensions ()
 GetShowEditableDimensions returns true if editable dimensions are being displayed.
 
json FormIt.SetShowEditableDimensions (show)
 SetShowEditableDimensions sets if editable dimensions are being displayed.
 
json FormIt.GetVersion ()
 Retrieve the FormIt version number Parameters Out: FormIt.Version
 
json FormIt.FindLatestVersion (versionJsonString, testVersion)
 Retrieve the latest version string from a plugin versions.json file passed as a string Parameters In: versionJsonString Out: The version json obj of the plugin to load
 
json FormIt.ImportToGroup (sFileType, sFilePath)
 Import to a Group Parameters: In: string In: string Out: HistoryID
 
json FormIt.CallJS (funcName, paramsJSON)
 Execute the given function with the given params Parameters function, params (json) Out: string
 
json FormIt.SetLocaleForWeb (nameCode)
 Set the Locale for web client given locale type Parameters In string localType Out: undefined
 
json FormIt.CreateTextureFromPath (nHistoryID, sPath, bUseBitmapAlpha)
 
json FormIt.ConsoleLog (msg)
 Log the given msg to the FormIt console.
 
json FormIt.HandleTimerTick (fTime)
 Run a timer tick Out: JSON_UNDEFINED
 
json FormIt.HandleTimerTickSimple ()
 Run a timer tick Out: JSON_UNDEFINED
 
json FormIt.SetSendToRevitPreview (enabled)
 Set the Send to Revit preview mode state
 
json FormIt.GetSendToRevitPreview ()
 Get the Send to Revit preview mode state
 
json FormIt.SetNoInferenceSmoothEdgesAndPoints (enabled)
 Set the "No inferencing smooth edges and vertices" mode
 
json FormIt.GetNoInferenceSmoothEdgesAndPoints ()
 Get the "No inferencing smooth edges and vertices" mode
 
json FormIt.GetAsyncAPI ()
 Get the FormItAsync API
 
json FormIt.RegisterAsyncAPI (NameSpace, APIName, Params)
 Register the given function for the async API For example: FormIt.RegisterAsyncAPI("HelloBlockAsync", "CreateBlock", "l, w, h"); This will expose an async API on the web side that can be called like: var result = await HelloBlockAsync.CreateBlock(l, w, h);
 
json FormIt.SetPickrayApertureScale (scaleFactor)
 Set the pickray aperture scale factor.
 
json FormIt.GetPickrayApertureScale ()
 Get the pickray aperture scale factor.
 

Function Documentation

◆ CallJS()

json FormIt.CallJS ( funcName  ,
paramsJSON   
)

Execute the given function with the given params Parameters function, params (json) Out: string

Parameters
[in]funcNameString
[in]paramsJSONjson
Returns
scriptInstance->Evaluate(cmd)

◆ ChangeTargetBuildableArea()

json FormIt.ChangeTargetBuildableArea ( value  )

ChangeTargetBuildableArea() function.

Parameters
[in]valuedouble
Returns
JSON_UNDEFINED, i.e. {}

◆ ConsoleLog()

json FormIt.ConsoleLog ( msg  )

Log the given msg to the FormIt console.

Parameters msg Out: JSON_UNDEFINED

Parameters
[in]msgString
Returns
JSON_UNDEFINED, i.e. {}

◆ CreateTextureFromPath()

json FormIt.CreateTextureFromPath ( nHistoryID  ,
sPath  ,
bUseBitmapAlpha   
)

◆ DeleteImage()

json FormIt.DeleteImage ( nHistoryID  ,
imageID   
)

DeleteImage() function.

Parameters
[in]nHistoryIDint
[in]imageIDint
Returns
JSON_UNDEFINED, i.e. {}

◆ FindLatestVersion()

json FormIt.FindLatestVersion ( versionJsonString  ,
testVersion   
)

Retrieve the latest version string from a plugin versions.json file passed as a string Parameters In: versionJsonString Out: The version json obj of the plugin to load

Parameters
[in]versionJsonStringjson
[in]testVersion(OPTIONAL) FormIt.Version
Returns
FormIt.FindLatestVersion(versionJsonString, testVersion);

◆ GetAccuracyForQuarterCircle()

json FormIt.GetAccuracyForQuarterCircle ( accuracy  )

Get the accuracy for a quarter circle to be used to call SetCurveAccuracyOrCountDefault/SetSurfaceAccuracyOrCountDefault.

Parameters
[in]accuracy
  • The accuracy for a quarter circle that can be used to call
  • SetCurveAccuracyOrCountDefault/SetSurfaceAccuracyOrCountDefault
  • Should have a range of [3, 100]
[in]accuracydouble
Returns
accuracy

◆ GetAppDefaultContentsWithoutAXM()

json FormIt.GetAppDefaultContentsWithoutAXM ( )

GetAppDefaultContentsWithoutAXM() function.

Returns
{...}

◆ GetAsyncAPI()

json FormIt.GetAsyncAPI ( )

Get the FormItAsync API

Returns
string

◆ GetBuildingType()

json FormIt.GetBuildingType ( )

GetBuildingType() function.

Returns
{...}

◆ GetCurveAccuracyOrCountDefault()

json FormIt.GetCurveAccuracyOrCountDefault ( )

Get the curve accuracy for the application.

File->New will use this value.

Returns
Curve accuracy

◆ GetNoInferenceSmoothEdgesAndPoints()

json FormIt.GetNoInferenceSmoothEdgesAndPoints ( )

Get the "No inferencing smooth edges and vertices" mode

Returns
bool

◆ GetPickrayApertureScale()

json FormIt.GetPickrayApertureScale ( )

Get the pickray aperture scale factor.

Returns
number (pickray aperture scale factor)

◆ GetSendToRevitPreview()

json FormIt.GetSendToRevitPreview ( )

Get the Send to Revit preview mode state

Returns
bool

◆ GetShowEditableDimensions()

json FormIt.GetShowEditableDimensions ( )

GetShowEditableDimensions returns true if editable dimensions are being displayed.

Parameters: Out: bool

Returns
{...}

◆ GetSnap()

json FormIt.GetSnap ( )

Get snapping state.

Returns
true if snapping is on.

◆ GetSurfaceAccuracyOrCountDefault()

json FormIt.GetSurfaceAccuracyOrCountDefault ( )

Get the surface accuracy for the application.

File->New will use this value.

Returns
Surface accuracy

◆ GetTimeNow()

json FormIt.GetTimeNow ( )

Get the time

Returns
The current time

◆ GetTouchEnabled()

json FormIt.GetTouchEnabled ( )

Are touch interactions enabled?

Returns
Returns true if touch interactions are enabled

◆ GetUnitTypeDefault()

json FormIt.GetUnitTypeDefault ( )

Get the Application (as opposed to Model) UnitType.

This is the UnitType used when creating a new Model.

Returns
UnitType

◆ GetVersion()

json FormIt.GetVersion ( )

Retrieve the FormIt version number Parameters Out: FormIt.Version

Returns
{...}

◆ HandleHUDTextInput()

json FormIt.HandleHUDTextInput ( dimensionID  ,
inputText   
)

HandleHUDTextInput will handle the HUD input values Parameters: In: dimensionID Out: Boolean

Parameters
[in]dimensionIDint
[in]inputTextString
Returns
{...}

◆ HandleTimerTick()

json FormIt.HandleTimerTick ( fTime  )

Run a timer tick Out: JSON_UNDEFINED

Parameters
[in]fTimefloat
Returns
JSON_UNDEFINED, i.e. {}

◆ HandleTimerTickSimple()

json FormIt.HandleTimerTickSimple ( )

Run a timer tick Out: JSON_UNDEFINED

Returns
JSON_UNDEFINED, i.e. {}

◆ HaveFeatureFlag()

json FormIt.HaveFeatureFlag ( flag  )

Check if a feature flag exists

Parameters: In: string Out: bool

Parameters
[in]flagString
Returns
FormIt.HaveFeatureFlag(flag);

◆ ImportFile()

json FormIt.ImportFile ( sFileName  ,
bGroupImport  ,
nHistoryID  ,
bKeepLevelsWhenGrouping   
)

Imports the content of the given file.

If nHistoryID is provided import into that History, otherwise use the editing History. If bGroupImport is true, all top level objects are used to create a group and an instance of that group is placed in the history. Section planes, images, unused layers, unused materials and unused textures are not kept. Levels are not kept, unless bKeepLevelsWhenGrouping is also true. If bGroupImport is false, all top level objects are placed directly in the history and all object types from the imported file are kept.

Parameters
[in]sFileNameString
[in]bGroupImportbool Group imported file (OPTIONAL)
[in]nHistoryIDHistory to import into (OPTIONAL)
[in]bKeepLevelsbool if true levels are imported as well when bGroupImport is true. (OPTIONAL)
[in]bKeepLevelsWhenGrouping(OPTIONAL, default = false) bool
Returns
bool Success

◆ ImportToGroup()

json FormIt.ImportToGroup ( sFileType  ,
sFilePath   
)

Import to a Group Parameters: In: string In: string Out: HistoryID

Parameters
[in]sFileTypeString
[in]sFilePathString
Returns
{...}

◆ IsWSRAvailable()

json FormIt.IsWSRAvailable ( )

IsWSRAvailable() function.

Returns
false

◆ LoadPreviewImage()

json FormIt.LoadPreviewImage ( sFileName  )

Load preview image of the given file.

Parameters
[in]sFileNameString
Returns
vector<char> Image
Parameters
[in]sFileNameString
Returns
{ { "Image" , to_json(img) }};

◆ NewFile()

json FormIt.NewFile ( forced  )

Run the new file method

Parameters
[in]forcedIf its forced (OPTIONAL)
Returns
JSON_UNDEFINED

◆ OpenFile()

json FormIt.OpenFile ( sFileName  )

Open the given file.

Parameters
[in]sFileNameString
Returns
bool Success

◆ RegisterAsyncAPI()

json FormIt.RegisterAsyncAPI ( NameSpace  ,
APIName  ,
Params   
)

Register the given function for the async API For example: FormIt.RegisterAsyncAPI("HelloBlockAsync", "CreateBlock", "l, w, h"); This will expose an async API on the web side that can be called like: var result = await HelloBlockAsync.CreateBlock(l, w, h);

Parameters
[in]NameSpaceString
[in]APINameString
[in]ParamsString
Returns
JSON_UNDEFINED

◆ ResumeMessaging()

json FormIt.ResumeMessaging ( )

Resumes messaging that was suspended by a call to SuspendMessaging.

Returns
JSON_UNDEFINED, i.e. {}

◆ SaveFile()

json FormIt.SaveFile ( sFileName  ,
saveOptions  ,
previewImage  ,
forSave   
)

Save the current model to the given file name.

Parameters
[in]sFileNameString
[in]saveOptions(OPTIONAL) FormIt.SaveOptions.AllObjectsWithHistory (default)
[in]previewImage(OPTIONAL) The preview image.
[in]forSave(OPTIONAL) set to true if doing a real save (not Export or Save A Copy As)
FormIt.SaveOptions-
FormIt.SaveOptions.AllObjects
FormIt.SaveOptions.AllObjectsWithHistory
FormIt.SaveOptions.VisibleOnly
FormIt.SaveOptions.SelectedOnly
FormIt.SaveOptions.SelectedOnlyWorldCoords
Returns
bool Success

◆ SaveFileForEnergyAnalysis()

json FormIt.SaveFileForEnergyAnalysis ( sFileName  )

Save the current model to the given file name for energy analysis.

The saved model will include only visible objects, all bodies will be merged, and no materials will be saved. This is not a "real" save, so the modified project flag will not be reset.

Parameters
[in]sFileNameString
Returns
bool Success

◆ SetBuildingType()

json FormIt.SetBuildingType ( value  )

SetBuildingType() function.

Parameters
[in]valueint
Returns
JSON_UNDEFINED, i.e. {}

◆ SetCurveAccuracyOrCountDefault()

json FormIt.SetCurveAccuracyOrCountDefault ( accuracyORcount  )

Set the curve accuracy for the application.

File->New will use this value.

Parameters
[in]accuracyORcount
  • MAX distance between base circle and segment as portion of R, if < .75
  • number of divisions (double rounded to int) over 90 degree arc, if >= .75
[in]accuracyORcountdouble
Returns
JSON_UNDEFINED

◆ SetFeatureFlag()

json FormIt.SetFeatureFlag ( featureName  ,
enabled   
)

Set a tool feature flag

Parameters: In: featureName (string), enabled (bool) Out: JSON_UNDEFINED

Parameters
[in]featureNameString
[in]enabled(OPTIONAL, default = true) bool
Returns
JSON_UNDEFINED, i.e. {}

◆ SetGeoLocationData()

json FormIt.SetGeoLocationData ( geodata  )

SetGeoLocationData() function.

Parameters
[in]geodataWSM.GeoLocationData
Returns
false

◆ SetKeyboardShortcutsEnabled()

json FormIt.SetKeyboardShortcutsEnabled ( enabled  )

SetKeyboardShortcutsEnabled Enables/Disables Keyboard Shortcuts Parameters: In: enabled Out: JSON_UNDEFINED

Parameters
[in]enabledbool
Returns
JSON_UNDEFINED, i.e. {}

◆ SetLocaleForWeb()

json FormIt.SetLocaleForWeb ( nameCode  )

Set the Locale for web client given locale type Parameters In string localType Out: undefined

Parameters
[in]nameCodeString
Returns
JSON_UNDEFINED, i.e. {}

◆ SetNoInferenceSmoothEdgesAndPoints()

json FormIt.SetNoInferenceSmoothEdgesAndPoints ( enabled  )

Set the "No inferencing smooth edges and vertices" mode

Parameters
[in]enabled

n

Parameters
[in]enabledbool
Returns
JSON_UNDEFINED

◆ SetPickrayApertureScale()

json FormIt.SetPickrayApertureScale ( scaleFactor  )

Set the pickray aperture scale factor.

Parameters
[in]scaleFactordouble
Returns
JSON_UNDEFINED

◆ SetRenderData()

json FormIt.SetRenderData ( renderdata  )

SetRenderData() function.

Parameters
[in]renderdataWSM.RenderData
Returns
false ;

◆ SetSendToRevitPreview()

json FormIt.SetSendToRevitPreview ( enabled  )

Set the Send to Revit preview mode state

Parameters
[in]enabled

n

Parameters
[in]enabledbool
Returns
JSON_UNDEFINED

◆ SetShowEditableDimensions()

json FormIt.SetShowEditableDimensions ( show  )

SetShowEditableDimensions sets if editable dimensions are being displayed.

Parameters: In: show Out: JSON_UNDEFINED

Parameters
[in]showbool
Returns
JSON_UNDEFINED, i.e. {}

◆ SetSnap()

json FormIt.SetSnap ( bSnap  )

Set snapping state.

Parameters
[in]bSnapbool
Returns
JSON_UNDEFINED

◆ SetSurfaceAccuracyOrCountDefault()

json FormIt.SetSurfaceAccuracyOrCountDefault ( accuracyORcount  )

Set the surface accuracy for the application.

File->New will use this value.

Parameters
[in]accuracyORcount
  • MAX distance between sphere and planar face as portion of R, if < .75
  • number of divisions (rounded double) over 90 degree arc, if >= .75
[in]accuracyORcountdouble
Returns
JSON_UNDEFINED

◆ SetTouchEnabled()

json FormIt.SetTouchEnabled ( bTouchEnabled  )

Enable touch interactions

Parameters
[in]bTouchEnabledbool
Returns
JSON_UNDEFINED

◆ SetUnitTypeDefault()

json FormIt.SetUnitTypeDefault ( unitType  )

Set the Application (as opposed to Model) UnitType.

This is the UnitType used when creating a new Model.

Parameters
[in]FormIt.UnitType

n FormIt.UnitType.kImperial
FormIt.UnitType.kMetric

Parameters
[in]unitTypeFormIt.UnitType
Returns
JSON_UNDEFINED

◆ SuspendMessaging()

json FormIt.SuspendMessaging ( bSuppress  ,
nTopLevelHistory  ,
bFullUpdate   
)

SuspendMessaging suspends all update messages from WSM until ResumeMessaging is called.

The top level history ID provided is included in the kLoadComplete message sent upon resume. This tells the receiver of the message into which history the load was done. The bSuppress parameter can be set to false to indicate that the object should not take effect. This is used to allow run-time determination. Parameters: In: bSuppress In: nTopLevelHistory (OPTIONAL) In: bFullUpdate Default to true to update everthing otherwise only the delta might be updated (OPTIONAL) Out: JSON_UNDEFINED

Parameters
[in]bSuppressbool
[in]nTopLevelHistory(OPTIONAL, default = WSM.INVALID_ID) int
[in]bFullUpdate(OPTIONAL, default = true) bool
Returns
JSON_UNDEFINED, i.e. {}

◆ Version()

json FormIt.Version ( )

Get the version of FormIt.

Returns
Version DEPRECTATED. USE FormIt.GetVersion instead, which will translate the "version object" directly.

◆ WriteAppDefaultContentToFile()

json FormIt.WriteAppDefaultContentToFile ( id  ,
path   
)

WriteAppDefaultContentToFile() function.

Parameters
[in]idString
[in]pathString
Returns
{...}