IRepository interface

Library: TFORMer9Lib

Opens or creates a Repository, opens a stand-alone FormLayout.

Usage and notes

Overview

A Repository is represented by a master file (extension *.tfr) and a subfolder structure on the file system. It references an arbitrary number of user-defined Project objects. These user-defined Projects are used to divide a Repository into logical areas. Each Project is a container which holds DataField definitions, DataSource definitions and references an arbitrary number of FormLayout objects.

The so-called GlobalProject is allocated by default and is used to define DataFields and DataSources which are available for all FormLayouts regardless of their actual Project membership.

Note

In contrast to a stand-alone FormLayout, the GlobalProject of a Repository can not store references to a FormLayout.

Examples

To open a stand-alone FormLayout do the following: 

  ' Create TFORMer SDK instance '
  Set tformer = CreateObject("TFORMer9Lib.TFORMer")

  ' Create a new Repository instance using a stand-alone FormLayout (extension *.tff) '
  ' Examples are usually installed in '
  ' - Windows Vista or later: C:/Program Data/TEC-IT/TFORMer/9/Examples '
  ' - Older Microsoft Windows versions: C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/9/Examples '
  Set repository = tformer.LoadRepository("C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/9/Examples/Command Line/ODBCReportPDF/ODBCReportPDF.tff", True)

To open a Repository do the following:

  ' Create TFORMer SDK instance '
  Set tformer = CreateObject("TFORMer9Lib.TFORMer")

  ' Create a new Repository instance using a Repository (extension *.tfr) '
  ' Examples are usually installed in '
  ' - Windows Vista: C:/Program Data/TEC-IT/TFORMer/9/Examples '
  ' - Older Microsoft Windows versions: C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/9/Examples '
  Set repository = tformer.LoadRepository("C:/Documents and Settings/All Users/Application Data/TEC-IT/TFORMer/9/Examples/Demo Repository/Demos.tfr", True)

Note

This class writes only changes to Repository-files (extension *.tfr) to disk. A stand-alone FormLayout cannot be created, saved or permanently modified on disk via this class.

Note

Thread-safety: A single instance of this class must not be used by different threads.

Base types: IDispatch

Properties

MemberDescription
AutoSaveBoolean { get; set; }

Gets/Sets a flag indicating whether to save changes to the Repository automatically.

BuildNumberLONG { get; }

Gets the build number of the Repository.

CommentString { get; set; }

Gets/Sets the comment for the Repository.

DefaultJobTrayControlIJobTrayControl { get; }

Gets the default JobTrayControl in the Repository.

DescriptionString { get; set; }

Gets/Sets the description of the Repository.

FirstJobTrayControlIJobTrayControl { get; }

Gets the first JobTrayControl in the Repository.

FirstProjectIProject { get; }

Gets the first Project stored in the Repository.

FullPathString { get; }

Gets the full pathname of the Repository.

GlobalProjectIProject { get; }

Gets the global Project of the Repository.

IsModifiedBoolean { get; set; }

Gets/Sets a flag indicating whether this Repository has been modified.

IsReadOnlyBoolean { get; }

Gets a flag indicating whether this Repository is read-only.

NumberOfJobTrayControlsLONG { get; }

Gets the number of JobTrayControl-objects stored in the Repository.

NumberOfProjectsLONG { get; }

Gets the number of Project-objects stored in the Repository.

VersionMajorLONG { get; }

Gets the major version number of the Repository.

VersionMinorLONG { get; }

Gets the minor version number of the Repository.

Methods

MemberDescription
AddJobTrayControl(String)Returns: IJobTrayControl

Creates and adds a new JobTrayControl to the Repository.

AddProject(String)Returns: IProject

Creates and adds the Project in the Repository.

Close(Boolean)

Close this Repository.

GetJobTrayControl(String)Returns: IJobTrayControl

Gets a JobTrayControl defined in the Repository.

GetProject(String)Returns: IProject

Gets the Project defined in the Repository.

RemoveJobTrayControl(IJobTrayControl)

Removes the JobTrayControl from the Repository.

RemoveProject(IProject)

Removes the Project from the Repository.

Save()

Saves this Repository.

SaveAs(String)

Saves a copy of this Repository.

Search documentation

Search in
More scopes
Additional scopes

All contents