Difference between revisions of "Interface Tools Library"
(Created page with "The UBIK.Interface.Tools library provides various objects and methods related to interface operations: * Initialisation of {{UBIK}} interface objects * File management for imp...") |
|||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | The UBIK.Interface.Tools library provides | + | The UBIK.Interface.Tools library provides features related to interface operations, like |
* Initialisation of {{UBIK}} interface objects | * Initialisation of {{UBIK}} interface objects | ||
* File management for import / export processes | * File management for import / export processes | ||
* Logging mechanisms | * Logging mechanisms | ||
* Methods for accessing {{UBIK}} objects and properties | * Methods for accessing {{UBIK}} objects and properties | ||
| + | |||
| + | {{Hint|Assembly name for interface components must start with '''UBIK.Interface''' as {{UBIK}} studio only accepts components obeying this naming rule as valid interfaces. The assembly name can be extended by any further characters.}} | ||
== Classes == | == Classes == | ||
=== UBIKStandardInterface === | === UBIKStandardInterface === | ||
| − | * {{UBIK}} interface | + | * Standard {{UBIK}} interface class for import and export |
| − | * | + | * Customizing is initialized via call of InitCustomizing(false) |
| − | * | + | * A new customized interface should derive from this class and additionally must implement the interfaces IUBIKImport and IUBIKExport, respectively |
<source lang="csharp"> | <source lang="csharp"> | ||
namespace UBIK.Interface.Tools | namespace UBIK.Interface.Tools | ||
public abstract class UBIKStandardInterface : UBIKInterfaceBase | public abstract class UBIKStandardInterface : UBIKInterfaceBase | ||
| + | |||
| + | public class CustomInterface : UBIKStandardInterface, IUBIKImport, IUBIKExport | ||
</source> | </source> | ||
| + | |||
| + | === InterfaceFileManager === | ||
| + | * Provide basic methods for file handling | ||
| + | <source lang="csharp"> | ||
| + | namespace UBIK.Interface.Tools | ||
| + | public abstract class InterfaceFileManager | ||
| + | </source> | ||
| + | |||
| + | ==== ImportFileManager ==== | ||
| + | * Specialized file handling methods for import | ||
| + | <source lang="csharp"> | ||
| + | namespace UBIK.Interface.Tools | ||
| + | public class ImportFileManager : InterfaceFileManager | ||
| + | </source> | ||
| + | |||
| + | ==== ExportFileManager ==== | ||
| + | * Specialized file handling methods for export | ||
| + | <source lang="csharp"> | ||
| + | namespace UBIK.Interface.Tools | ||
| + | public class ExportFileManager : InterfaceFileManager | ||
| + | </source> | ||
| + | |||
| + | === LogManager === | ||
| + | * Provide methods for creating logging data | ||
| + | <source lang="csharp"> | ||
| + | namespace UBIK.Interface.Tools | ||
| + | public static class LogManager | ||
| + | </source> | ||
| + | |||
| + | === DataFactory === | ||
| + | * Provides methods to access {{UBIK}} objects and its properties | ||
| + | <source lang="csharp"> | ||
| + | namespace UBIK.Interface.Tools | ||
| + | public static class DataFactory | ||
| + | </source> | ||
| + | |||
| + | === ToolsConstants=== | ||
| + | * Constants used in interface components | ||
| + | <source lang="csharp"> | ||
| + | namespace UBIK.Interface.Tools | ||
| + | public static class ToolsConstants | ||
| + | </source> | ||
| + | |||
| + | == See also == | ||
| + | * [[XML Interface Toolkit]] | ||
| + | |||
| + | [[Category:XML]] | ||
Latest revision as of 16:29, 2 February 2015
The UBIK.Interface.Tools library provides features related to interface operations, like
- Initialisation of UBIK® interface objects
- File management for import / export processes
- Logging mechanisms
- Methods for accessing UBIK® objects and properties
 | Assembly name for interface components must start with UBIK.Interface as UBIK® studio only accepts components obeying this naming rule as valid interfaces. The assembly name can be extended by any further characters. |
Contents
Classes
UBIKStandardInterface
- Standard UBIK® interface class for import and export
- Customizing is initialized via call of InitCustomizing(false)
- A new customized interface should derive from this class and additionally must implement the interfaces IUBIKImport and IUBIKExport, respectively
namespace UBIK.Interface.Tools
public abstract class UBIKStandardInterface : UBIKInterfaceBase
public class CustomInterface : UBIKStandardInterface, IUBIKImport, IUBIKExport
public abstract class UBIKStandardInterface : UBIKInterfaceBase
public class CustomInterface : UBIKStandardInterface, IUBIKImport, IUBIKExport
InterfaceFileManager
- Provide basic methods for file handling
namespace UBIK.Interface.Tools
public abstract class InterfaceFileManager
public abstract class InterfaceFileManager
ImportFileManager
- Specialized file handling methods for import
namespace UBIK.Interface.Tools
public class ImportFileManager : InterfaceFileManager
public class ImportFileManager : InterfaceFileManager
ExportFileManager
- Specialized file handling methods for export
namespace UBIK.Interface.Tools
public class ExportFileManager : InterfaceFileManager
public class ExportFileManager : InterfaceFileManager
LogManager
- Provide methods for creating logging data
namespace UBIK.Interface.Tools
public static class LogManager
public static class LogManager
DataFactory
- Provides methods to access UBIK® objects and its properties
namespace UBIK.Interface.Tools
public static class DataFactory
public static class DataFactory
ToolsConstants
- Constants used in interface components
namespace UBIK.Interface.Tools
public static class ToolsConstants
public static class ToolsConstants
