TFORMer SDK - DLL/Library  8
Functions
Miscellaneous

Special purpose functions for System Integrators. More...

Functions

BOOL TFormer_IsDesignerAvailable ()
 Determines if the TFORMer Designer is available on the local machine and can be invoked by the method TFormer_OpenDesigner.
ERRCODE TFormer_OpenDesigner (HTFORM pInstance, LPCSTR pszDesignExe, BOOL bShowSplash, BOOL bMaximize, BOOL bUseExistingInstance, LPCSTR pszExtraParameters)
 Opens the currently selected FormLayout with TFORMer Designer.

Detailed Description

Special purpose functions for System Integrators.


Function Documentation

Determines if the TFORMer Designer is available on the local machine and can be invoked by the method TFormer_OpenDesigner.

The function tests if TFORMer Designer TFormer.exe is available on the system. If the TFORMer Designer is installed, FormLayouts can be edited with TFORMer Designer.

Returns:
TRUE in case of an existing TFORMer Designer installation
- FALSE if TFORMer Designer is not available
See also:
TFormer_OpenDesigner
ERRCODE TFormer_OpenDesigner ( HTFORM  pInstance,
LPCSTR  pszDesignExe,
BOOL  bShowSplash,
BOOL  bMaximize,
BOOL  bUseExistingInstance,
LPCSTR  pszExtraParameters 
)

Opens the currently selected FormLayout with TFORMer Designer.

Returns:
ErrOk (0) in case of success, non-zero if an error occurred
Parameters:
pInstanceThe TFORMer instance provided by a previous call to TFormer_Init
pszDesignExeIf NULL the function tries to locate TFORMer Designer by itself
bShowSplashShow the splash screen of TFORMer Designer?
bMaximizeOpen TFORMer Designer maximized?
bUseExistingInstanceTry to use an existing TFORMer Designer instance? This parameter avoids multiple TFORMer Designer windows. A new instance of TFORMer Designer is opened if no existing instance is found or no existing instance can be used.
pszExtraParametersParameters which should be sent to TFORMer Designer (Default: NULL). These parameters are used for branding of TFORMer Designer via the command-line (see below).
Remarks:
TFORMer SDK on its own cannot be used for editing a FormLayout. Use this method to invoke TFORMer Designer.
  • If there is no given EXE file (parameter pszDesignExe), then this function uses a value in the System Registry ([HKCU|HKLM]\TEC-IT\TEC-IT Datenverarbeitung GmbH\8\TFormerApp) to determine the location of TFORMer.exe.
  • If this key is not found or the file does not exist, then TFORMer.exe will be searched in the directory where TFORMer SDK is installed.
  • If TFORMer.exe is not found here too, then it will search TFORMer.exe in the current directory.
  • Finally - if TFORMer.exe was still not found it checks the complete path (environment variable PATH).
Note:
Make sure that your purchased license model fits your requirements. If you are creating applications which are distributed to 3rd party you may need to redistribute TFORMer Designer as well.
TFormer_SetFormName has to be called prior to calling this function.
For branding TFORMer Designer there are two different possibilities:
  • Provide Splash-Screen and About Box bitmaps in the same directory as TFORMer Designer is installed. The required filenames are TFSS.mbp (Splash-Screen) and TFAb.mbp (About Box)
  • Via command-line parameters (these parameters overrule the file-system):
    /Splash [SplashPicture.bmp]
    /AboutBox [AboutboxPicture.bmp]
See also:
TFormer_IsDesignerAvailable

© 2006-2021 - all rights reserved by TEC-IT Datenverarbeitung GmbH
Generated on Wed Nov 17 2021 12:13:03 for TFORMer SDK - DLL/Library with doxygen 1.7.6.1